Module: Swivel

Defined in:

lib/swivel.rb

Overview

Swivel

Overview

Create a new connection to swivel. Grabs options from ~/.swivelrc, creating it if necessary. (Get a Swivel API key)

swivel = Swivel::Connection.new

Get data from Swivel

# show a data_set's name
data_set = swivel.data_set 1000001
data_set.name # => "American Longevity"

# list data_sets' names
data_sets = swivel.data_sets
data_sets.collect do |data_set|
  data_set.name
end

# show a data_column's name
data_column = swivel.data_column 1000343
data_column.name # => "Average Per Capita Income"

# list data_columns' names
data_columns = swivel.data_columns
data_columns.collect do |data_column|
  data_column.name
end

# show a user's name
user = swivel.user 1000010
user.name # => "huned"

# list users' names
users = swivel.users
users.collect do |user|
  user.name
end

# show a graph's name
graph = swivel.graph 5119232
graph.name # => "Vinyl to Ipods"

# list graphs' names
graphs = swivel.graphs
graphs.collect do |graph|
  graph.name
end

Upload data

See Swivel::Connection#upload! for a detailed list of options

# upload a new data_set
data_set = swivel.upload! {...}

# append to an existing data_set
data_set = swivel.append! {...}.merge(:id => orig_data_set_id)

# replace data for an existing data_set
data_set = swivel.replace! {...}.merge(:id => orig_data_set_id)

TODO: constructing URLs for csvs, html pages, etc

Defined Under Namespace

Classes: Activity, Annotation, ApiError, Comment, Connection, DataSet, Error, Graph, Group, Invitation, List, Page, PageAsset, Permission, Prose, Response, User, Visual