buzzdata 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+buzzdata.yml
+spec/fixtures/unreadable.yml
+*.gem
+.bundle
+.yardoc
+Gemfile.lock
+doc/*
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in buzzdata.gemspec
+gemspec

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 BuzzData, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,441 @@
+# BuzzData Ruby Client Library
+
+## Getting Started
+
+Create an instance of the Buzzdata client:
+
+    >> buzzdata = Buzzdata.new('YOUR_API_KEY')
+
+To make it even simpler, if you create a file, `config/buzzdata.yml` with your `api_key` in it, you can omit the key parameter:
+
+    >> buzzdata = Buzzdata.new
+
+
+## Downloading Data
+
+To download data from a dataset, just do this:
+
+    >> buzzdata.download_data 'eviltrout/b-list-celebrities'
+
+## Dataset Information
+
+Using `dataset_overview` you can get an overview of a Dataset's information. It returns a hash of attribute names and their values. See the *API Documentation* below for a list of the returned attributes.
+
+    >> ds = buzzdata.dataset_overview 'eviltrout/b-list-celebrities'
+    >> puts ds['name']  # outputs B-List Celebrities
+
+
+## Listing Datasets
+
+You can view a user's datasets by calling `datasets_list`. You'll get back an array with information on their datasets.
+
+    >> datasets = buzzdata.datasets_list 'eviltrout'
+    >> datasets.each {|ds| puts ds['id'] }
+
+
+## Upload History
+
+You can retrieve a list of uploaded versions of a dataset by calling `dataset_history`:
+
+    >> buzzdata.dataset_history.each {|v| puts "version #{v['version']}!" }
+
+
+## Creating a Dataset
+
+You can use the `create_dataset` method to create a new dataset. All fields are required:
+
+    >> ds = buzzdata.create_dataset(:username => 'eviltrout',
+                                    :name => "My Awesome Dataset!",
+                                    :public => false,
+                                    :readme => "This is my awesome dataset",
+                                    :license => 'cc0',
+                                    :topics => ['testing-buzzdata'])  
+
+    >> puts ds['id']     # outputs eviltrout/my-awesome-dataset
+
+## Uploading Data
+
+If your account has the ability to upload data to a dataset, you can do so like this:
+
+    >> upload = buzzdata.start_upload('eviltrout/b-list-celebrities', File.new('datasets/celebrities.csv')
+
+Uploads take some time to be processed. You can poll how the processing is going using `in_progress?`
+
+    >> upload.in_progress?   # true - upload is going on
+
+    # (wait for some time to pass..)
+
+    >> upload.in_progress?   # false - upload is done!
+
+For a more thourough example of this, look at the sample in *samples/upload_data.rb*
+
+
+## Publish a dataset
+
+    >> buzzdata.publish_dataset('eviltrout/b-list-celebrities')
+
+
+## Clone another user's dataset
+
+    >> buzzdata.clone_dataset('pete/pete-forde-s-genome')
+
+
+## Delete a dataset
+
+    >> buzzdata.delete_dataset('eviltrout/tasteless-dataset')    
+
+
+## Get a user's information
+
+    >> user = buzzdata.user_info('eviltrout')
+    >> puts user['name']   # Robin Ward
+
+
+## Search BuzzData
+
+    >> buzzdata.search("pets").each do |r|
+         puts r['label']    # Outputs each search result label
+       end
+
+
+## Get a list of usable Licenses 
+
+    >> buzzdata.licenses
+
+
+## Get a list of usable Topics 
+
+    >> buzzdata.topics
+  
+
+# BuzzData API 
+
+The BuzzData API returns results in JSON.
+
+You must attach your API key as either a query parameter or post variable in the form of `api_key=YOUR_KEY`.
+
+For example, to test if your API key works, try this url:
+
+    https://buzzdata.com/api/test?api_key=YOUR_KEY
+  
+You should get back a JSON object with your username in it, confirming that the key is yours and has authenticated properly.
+
+## Rate Limits
+
+The API currently limits the requests you can make against it hourly. If you need more requests than that, please contact us and we'll let you know.
+
+We have provided two response headers with each request to the API with Rate Limiting Information. They are returned from every API call.
+
+    X-RateLimit-Limit: 5000
+    X-RateLimit-Remaining: 4998
+
+`X-RateLimit-Limit` is your current limit per hour. `X-RateLimit-Remaining` is how many requests you have left.
+
+# Datasets
+
+## Dataset Details (Overview)
+
+To retrieve information about a dataset, simply make a GET:
+
+**GET https://buzzdata.com/api/:username/:dataset**
+
+**GET Parameters:**
+
+* `api_key` = your API Key  (optional - but necessary for viewing private or unpublished datasets.)
+
+**Returns JSON:**
+
+    {"dataset":
+      {"id":"eviltrout/b-list-celebrities",
+       "username":"eviltrout",
+       "shortname":"b-list-celebrities",
+       "name":"B-List Celebrities",
+       "readme":"Here's a list of B-List Celebrities that I've curated.",
+       "public":true,
+       "license":"cc0",
+       "published":true,
+       "url":"http://buzzdata.com/eviltrout/b-list-celebrities",
+       "avatar":"/images/avatars/b9/e987d17045c649da4de2a580e8109d655e6a12?1312292315",
+       "followers_count":10,
+       "clones_count":2,
+       "articles_count":5,
+       "visualizations_count":10,
+       "attachments_count":2,
+       "created_at":"2011-07-12T14:31:21-04:00",
+       "data_updated_at":"2011-07-12T14:41:52-04:00"}}
+
+
+## Listing Datasets
+
+You can view a list of any user's datasets. 
+
+**GET https://buzzdata.com/api/:username/datasets/list**
+
+**GET Parameters:**
+
+* `api_key` = your API Key  (optional - but necessary for viewing private or unpublished datasets.)
+
+**Returns JSON:**
+
+    [
+      {"id":"eviltrout/b-list-celebrities",
+        "url":"http://buzzdata.com/eviltrout/b-list-celebrities",
+        "name":"B-List Celebrities",
+        "public":true,
+        "published":true,
+        "readme":"Here's a list of B-List Celebrities that I've curated."},
+       {"id":"eviltrout/pets",
+        "url":"http://buzzdata.com/eviltrout/pets",
+        "name":"Pets",
+        "public":true,
+        "published":true,
+        "readme":"A list of pets by owner."}
+        ...
+    ]
+
+
+## Dataset History
+
+To retrieve a list of uploads and versions to a dataset:
+
+**GET https://buzzdata.com/api/:username/:dataset/history**
+
+**GET Paramters: **
+
+* `api_key` = your API Key  (optional - but necessary for viewing private or unpublished datasets.)
+
+**Returns JSON:**
+
+    [
+      {"version":1,"created_at":"2011-07-12T14:41:52-04:00","username":"eviltrout"},
+      {"version":2,"created_at":"2011-07-13T13:00:21-04:00","username":"eviltrout"}
+    ]
+
+
+## Downloading Data
+
+Before you can download data, you need to create a `download_request`. If successful you will be given a
+url to download the data from.
+
+**POST https://buzzdata.com/api/:username/:dataset/download_request**
+
+* `:username` is your username: ex: 'eviltrout'
+* `:dataset` is the short name (url name) of the dataset you are uploading to. For example: 'b-list-celebrities'
+
+**POST Parameters:**
+
+* `api_key` = your API key
+* `version` = the version of the dataset you wish to download
+
+**Returns JSON:**
+
+    {download_request: {path:'PATH_TO_DOWNLOAD_YOUR_DATA'}}
+  
+You can then perform a GET to download the data from the path you are given.
+
+
+## Creating a Dataset
+
+Before you can upload data to a dataset, you need to create a dataset object in our system with meta-data about the dataset. 
+
+**POST https://buzzdata.com/api/:username/datasets**
+
+* `:username` is your username: ex: 'eviltrout'
+
+**POST Parameters:**
+
+* `api_key` = your API Key
+* `dataset[name]` = the name of the dataset
+* `dataset[public]` = (true/false) whether the dataset is public or private
+* `dataset[readme]` = the content for "About this Dataset"
+* `dataset[license]` = the license the dataset is being offered with. See *Licenses* below
+* `dataset[topics]` = the ids of the topics associated with this dataset. See *Topics* below
+
+**Returns JSON:**
+
+It returns the same output from the *Dataset Details (Overview)* above of the completed dataset, or an error message if the dataset couldn't be created.
+
+
+## Upload Requests
+
+To upload data to the system, you need to create an `upload_request`. An upload request tells you the HTTP end point your upload should be going to, as well as an `upload_code` you should pass along with your upload to verify it.
+
+**POST https://buzzdata.com/api/:username/:dataset/upload_request**
+
+* `:username` = your username: ex: 'eviltrout'
+* `:dataset` = the short name (url name) of the dataset you are uploading to. For example: 'b-list-celebrities'
+
+
+**POST Parameters:**
+
+* `api_key` = your API key
+
+**Returns JSON:**
+
+    {upload_request: {upload_code: 'SOME_CODE_HERE', url: 'URL_TO_UPLOAD_TO'} }
+
+* `upload_code` = a unique token that authenticates your upload
+* `url` = the endpoint for where the file should be uploaded
+
+
+## Performing an Upload
+
+After creating an `upload_request`, you can then POST your data file to be ingested. To do this, send a POST request to the `url` you received in your `upload_request` JSON.
+
+*note: Make sure your POST is a multipart, otherwise the file upload will not work.*
+
+**POST Parameters:**
+
+* `api_key` = your API Key
+* `upload_code` = the `upload_code` returned in the `upload_request`
+* `file` = the file data you are uploading to be ingested
+
+**Returns JSON:**
+
+    [{"name"=>"kittens_born.csv", "size"=>187, "job_status_token"=>"a24b2155-e2ec-48d4-8bc0-f77e3758966f"}]
+
+* `name` = the filename of the upload.
+* `size` = the size of the upload in bytes
+* `job_status_token` = an important 
+
+
+## Checking your Upload Status
+
+After a file has been uploaded, you can check out the upload's status by making a GET to:
+
+**GET https://buzzdata.com/api/:username/:dataset/upload_request/status**
+
+* `:username` = your username: ex: 'eviltrout'
+* `:dataset` = the short name (url name) of the dataset you are uploading to. For example: 'b-list-celebrities'
+
+**GET Parameters:**
+
+* `api_key` = your API Key
+* `job_status_token` = The job status token you received when you performed your upload.
+
+**Returns JSON:**
+
+    {"message"=>"Ingest Job Created", "status_code"=>"created"}
+
+* `message` is a textual description of the current status, or an error message in the event of an error
+* `status_code` is the status of the current job. The job has finished when it is `complete` or `error`.
+
+Important! You should wait a little while between polls to the job status. We recommend sleeping for one second in most cases.
+
+Note: If you receive a status of 'Unknown' it means the file has not begun processing yet. If you continue to poll it will move to 'created'
+
+
+## Publishing a Dataset
+
+Once a dataset has an upload associated with it, you can publish it:
+
+**POST https://buzzdata.com/api/:username/:dataset/publish**
+
+**POST Parameters:**
+
+* `api_key` = your API Key
+
+**Returns JSON:**
+
+It returns the same output from the *Dataset Details (Overview)* above of the completed dataset, or an error message if the dataset couldn't be published.
+
+
+## Cloning a Dataset
+
+You can clone another's dataset by making a post. Note the username in this case is the user whose dataset you want to clone, not your own:
+
+**POST https://buzzdata.com/api/:username/:dataset/publish**
+
+**POST Parameters:**
+
+* `api_key` = your API Key
+
+**Returns JSON:**
+
+It returns the same output from the *Dataset Details (Overview)* above of the completed dataset, or an error message if the dataset couldn't be cloned.
+
+
+## Delete a Dataset
+
+To delete a dataset, make a DELETE call:
+
+**DELETE https://buzzdata.com/api/:username/:dataset**
+
+**POST Parameters:**
+
+* `api_key` = your API Key
+
+**Returns JSON:**
+
+    {"id"=>"eviltrout/tasteless-dataset", "deleted"=>true}
+
+# Users
+
+To retrieve information about a particular BuzzData user, perform the following GET:
+
+**GET https://buzzdata.com/api/:username**
+
+**Returns JSON:**
+
+    {"user":
+      {"id":"eviltrout",
+       "name":"Robin Ward",
+       "description":"The Evilest Trout of them all and BuzzData Developer",
+       "location":"Toronto, Canada",
+       "url":"http://buzzdata.com/eviltrout",
+       "avatar":"/images/avatars/b9/e987d17045c649da4de2a580e8109d655e6a12?1312292315",
+       "followers_count": 12}
+    }
+
+
+# Searching BuzzData
+
+To search BuzzData, make a GET call:
+
+**GET https://buzzdata.com/api/search**
+
+**GET Parameters:**
+
+* `query` = the string you'd like to search for
+
+**Returns JSON:**
+
+    [
+      {"label":"Pets","value":"Pets","id":"pets","url":"/eviltrout/pets","cloned":false,"type":"Dataset"},
+      {"label":"Business","value":"Business","id":"business","url":"/topics/business","type":"Topic"},
+      {"label":"Momoko Price","value":"Momoko Price","id":"momoko","url":"/momoko","type":"User","icon":"http://buzzdata.s3.amazonaws.com/avatars/fe/fe361ff01695aa4741840f4f8851a6da9e2ef64c"},
+      ...
+    ]
+
+Note that while in the sample output above there is one of each Dataset, Topic and Users, a search can return many more. The type of result is based on the `type` attribute.
+
+
+# Topics
+
+When creating a dataset, it is necessary to supply at least once topic. To retrieve a list of topics and their ids:
+
+**GET https://buzzdata.com/api/topics**
+
+**Returns JSON:**
+
+    [
+      {"id":"agriculture","name":"Agriculture"},
+      {"id":"animals","name":"Animals"},
+      {"id":"anthropology","name":"Anthropology"},
+      ...
+    ]
+
+# Licenses
+
+When creating a dataset, it is necessary to supply a valid license for the data. You can query the available licenses by:
+
+**GET https://buzzdata.com/api/licenses**
+
+**Returns JSON:**
+
+    [
+      {"id":"cc0"},
+      {"id":"pdm"},
+      {"id":"cc_by"},
+      ...
+    ]

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/buzzdata.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "buzzdata/version"
+
+Gem::Specification.new do |s|
+  s.name        = "buzzdata"
+  s.version     = Buzzdata::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["BuzzData"]
+  s.email       = ["support@buzzdata.com"]
+  s.homepage    = "http://buzzdata.com/"
+  s.summary     = %q{Ruby client for the BuzzData API}
+
+  s.rubyforge_project = "buzzdata"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency('rest-client', '~> 1.6.7')
+  s.add_development_dependency('rspec', '~> 2.6.0')
+end

data/lib/buzzdata.rb

@@ -0,0 +1,155 @@
+# Dependencies
+require 'rest-client'
+require 'json'
+require 'yaml'
+
+# Our code
+require_relative 'buzzdata/error'
+require_relative 'buzzdata/rest_helpers'
+require_relative 'buzzdata/upload'
+
+class Buzzdata
+  YAML_ERRORS = [ArgumentError]
+  if defined?(Psych) && defined?(Psych::SyntaxError)
+    YAML_ERRORS << Psych::SyntaxError
+  end
+
+  include RestHelpers
+  
+  def initialize(api_key=nil, opts={})
+    
+    @api_key = api_key
+    
+    # If the API Key is missing, try to load it from a yml
+    if @api_key.nil?
+      config_file = File.expand_path(opts[:config_file] || 'config/buzzdata.yml')
+
+      # If the user set the config file, we want to raise errors.
+      if opts[:config_file] || File.exist?(config_file)
+        begin
+          config = YAML.load_file config_file
+          if Hash === config
+            if config['api_key']
+              @api_key = config['api_key']
+              @base_url = config['base_url']
+            else
+              raise Buzzdata::Error, "API key missing from configuration file (#{config_file})"
+            end
+          else
+            raise Buzzdata::Error, "Configuration file improperly formatted (not a Hash: #{config_file})"
+          end
+        rescue *YAML_ERRORS
+          raise Buzzdata::Error, "Configuration file improperly formatted (invalid YAML: #{config_file})"
+        rescue Errno::EACCES
+          raise Buzzdata::Error, "Configuration file unreadable (Permission denied: #{config_file})"
+        rescue Errno::ENOENT
+          raise Buzzdata::Error, "Configuration file missing (No such file or directory: #{config_file})"
+        end
+      end
+
+      raise Buzzdata::Error.new('No API key provided') if @api_key.nil?
+    end
+  end
+
+  def new_upload_request(dataset)
+    result = post_json(url_for("#{dataset}/upload_request"))
+    result['upload_request']
+  end
+
+  def start_upload(dataset, file)
+    upload_request = new_upload_request(dataset)
+
+    # Prepare our request
+    post_url = upload_request.delete('url')
+    upload_request['file'] = file
+    
+    Buzzdata::Upload.new(self, dataset, post_json(post_url, upload_request))    
+  end 
+
+  def upload_status(dataset, job_status_token)
+    get_json(url_for("#{dataset}/upload_request/status"), :job_status_token => job_status_token)
+  end
+
+  def download_path(dataset)
+    result = post_json(url_for("#{dataset}/download_request"))
+    result['download_request']['url']
+  end
+  
+  def dataset_overview(dataset)
+    result = get_json(url_for(dataset))
+    result['dataset']
+  end
+
+  def dataset_history(dataset)
+    get_json(url_for("#{dataset}/history"))
+  end
+
+  def publish_dataset(dataset)
+    result = post_json(url_for("#{dataset}/publish"))
+    result['dataset']
+  end
+
+  def clone_dataset(dataset)
+    result = post_json(url_for("#{dataset}/clone"))
+    result['dataset']
+  end
+
+  def delete_dataset(dataset)
+    delete_json(url_for("#{dataset}"))
+  end
+
+  def licenses
+    get_json(url_for("licenses"))
+  end
+
+  def topics
+    get_json(url_for("topics"))
+  end
+
+  def search(query)
+    get_json(url_for("search"), :query => query)  
+  end
+
+  def datasets_list(username)
+    get_json(url_for("#{username}/datasets/list"))  
+  end
+
+  def download_data(dataset)
+    raw_get(download_path(dataset))
+  end
+
+  def user_info(username)
+    result = get_json(url_for(username))  
+    result['user']
+  end
+
+  def create_dataset(attributes)
+    
+    # Validate attributes
+    raise BuzzData::Error, "Missing attributes" if attributes.nil?    
+    raise Buzzdata::Error, "Username is required" if param_blank?(attributes, :username)
+    raise Buzzdata::Error, "Dataset name is required" if param_blank?(attributes, :name)
+    raise Buzzdata::Error, "Dataset readme is required" if param_blank?(attributes, :name)
+    raise Buzzdata::Error, "Dataset license is required" if param_blank?(attributes, :license)
+    raise Buzzdata::Error, "Dataset topics are required" if param_blank?(attributes, :topics)
+
+    username = attributes.delete(:username)
+
+    result = post_json(url_for("#{username}/datasets"), :dataset => attributes)    
+    result['dataset']
+  end
+
+  private
+    
+    def param_blank?(obj, param)      
+      return (obj.nil? or obj[param].nil? or obj[param].empty?)
+    end
+
+    def url_for(path)
+      base_path = @base_url || "https://buzzdata.com/api/"
+      "#{base_path}#{path}"
+    end
+  
+end
+
+

data/lib/buzzdata/error.rb

@@ -0,0 +1,9 @@
+class Buzzdata
+  class Error < StandardError
+    attr_reader :message
+
+    def initialize(message='Error!')
+      @message = message
+    end
+  end
+end

data/lib/buzzdata/rest_helpers.rb

@@ -0,0 +1,37 @@
+module RestHelpers
+
+  def handle_error(response)
+    raise Buzzdata::Error.new if response.nil?
+    parsed_error = JSON.parse(response.body)
+    raise Buzzdata::Error.new(parsed_error['message'])
+  end
+
+  # Define methods for our HTTP verbs
+  [:post, :put, :get, :delete].each do |method|
+    
+    define_method(method) do |url, params={}|
+      params['api_key'] = @api_key
+
+      RestClient.send(method, url, params) do |response, request, result, &block|        
+        case response.code
+        when 403, 404, 500
+          handle_error(response)
+        else
+          response.return!(request, result, &block)
+        end
+      end
+    end
+
+    # Define methods for our verbs with json handling
+    define_method("#{method}_json") do |path, params={}|
+      response = send(method, path, params)
+      JSON.parse(response.body)
+    end
+
+  end
+  
+  def raw_get(url)
+    RestClient.get(url)
+  end
+
+end

data/lib/buzzdata/upload.rb

@@ -0,0 +1,38 @@
+class Buzzdata
+  class Upload
+
+    attr_reader :filename, :size, :job_status_token, :dataset
+
+    def initialize(buzzdata_api, dataset, upload_response)
+      @api = buzzdata_api
+      @dataset = dataset
+      @filename = upload_response[0]['name']
+      @size = upload_response[0]['size']
+      @job_status_token = upload_response[0]['job_status_token']
+    end
+
+    def in_progress?
+      !is_complete?(current_status)
+    end
+
+    def success?
+      (current_status['status_code'] == "complete")
+    end
+
+    def status_message
+      current_status['message']
+    end
+
+    private
+
+      def is_complete?(status)
+        return false if status.nil?        
+        ['complete', 'error'].include?(status['status_code'])
+      end
+
+      def current_status
+        return @current_status if is_complete?(@current_status)
+        @current_status = @api.upload_status(@dataset, @job_status_token)
+      end
+  end
+end

data/lib/buzzdata/version.rb

@@ -0,0 +1,3 @@
+class Buzzdata
+  VERSION = "0.0.1"
+end

data/samples/config/buzzdata.yml.sample

@@ -0,0 +1 @@
+api_key: <YOUR_API_KEY>

data/samples/dataset_overview.rb

@@ -0,0 +1,22 @@
+require '../lib/buzzdata'
+
+if ARGV.size != 1
+  puts "Usage: ./dataset_overview.rb dataset"
+  puts "Example: ./dataset_overview.rb eviltrout/kittens-born-by-month"
+  exit(0)
+end
+
+# Retrieve a Dataset's Details
+buzzdata = Buzzdata.new
+overview = buzzdata.dataset_overview(ARGV[0])
+
+puts "Dataset Details:"
+overview.each do |k, v|
+  puts "#{k}: #{v}"
+end
+puts
+
+puts "Version History:"
+buzzdata.dataset_history(ARGV[0]).each do |h|
+  puts "=> #{h['version']} - Uploaded On: #{h['created_at']} by #{h['username']}"
+end

data/samples/datasets/kittens_born.csv

@@ -0,0 +1,23 @@
+Month,Kittens Born
+Jan,13
+Feb,234
+Mar,6243
+Apr,3
+May,1
+Jun,3
+Jul,4
+Aug,625
+Sep,24
+Oct,1
+Nov,34
+Dec,6
+Jan,5
+Feb,2
+Mar,23
+Apr,45
+May,6
+Jun,4
+Jul,5
+Aug,2
+Sep,34
+Oct,3

data/samples/download_data.rb

@@ -0,0 +1,11 @@
+require '../lib/buzzdata'
+
+if ARGV.size != 1
+  puts "Usage: ./download_data.rb dataset"
+  puts "Example: ./download_data.rb eviltrout/kittens-born-by-month"
+  exit(0)
+end
+
+# Download a Dataset
+buzzdata = Buzzdata.new
+puts buzzdata.download_data(ARGV[0])

data/samples/upload_data.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require '../lib/buzzdata'
+
+if ARGV.size != 2
+  puts "Usage: ./upload_data.rb dataset filename"
+  puts "Example: ./upload_data.rb eviltrout/kittens-born-by-month kittens_born.csv"
+  exit(0)
+end
+
+buzzdata = Buzzdata.new
+
+dataset_name, filename = *ARGV
+
+# Upload a file to a dataset
+print "Uploading #{filename}..."
+upload = buzzdata.start_upload(dataset_name, File.new(filename))
+puts "Done!"
+
+# Wait while it's being processed
+print "Waiting for processing to finish..."
+while upload.in_progress?
+  print "." 
+  sleep(1)    # Let's not poll too frequently
+end
+
+if upload.success?
+  puts "Done!"
+else
+  puts "ERROR! #{upload.status_message}"
+end

data/spec/buzzdata_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Buzzdata
+  describe Buzzdata do
+    describe '#initialize' do
+      def fixture_path(fixture)
+        File.expand_path File.dirname(__FILE__) + '/fixtures/' + fixture
+      end
+
+      it 'should use custom configuration file' do
+        client = Buzzdata.new nil, :config_file => fixture_path('custom.yml')
+        client.instance_variable_get('@api_key').should == 'dummy'
+      end
+
+      it "should not raise an error if the configuration file is default and missing" do
+        expect{Buzzdata.new nil}.not_to raise_error(Buzzdata::Error, /No such file or directory/)
+      end
+
+      it "should raise an error if the configuration file is custom and missing" do
+        expect{Buzzdata.new nil, :config_file => fixture_path('non_existent.yml')}.to raise_error(Buzzdata::Error, /No such file or directory/)
+      end
+
+      it "should raise an error if the configuration file is unreadable" do
+        File.open(fixture_path('unreadable.yml'), 'w').chmod(0000) unless File.exist? fixture_path('unreadable.yml')
+        expect{Buzzdata.new nil, :config_file => fixture_path('unreadable.yml')}.to raise_error(Buzzdata::Error, /Permission denied/)
+      end
+
+      it "should raise an error if the configuration file is invalid YAML" do
+        expect{Buzzdata.new nil, :config_file => fixture_path('invalid_yaml.yml')}.to raise_error(Buzzdata::Error, /invalid YAML/)
+      end
+
+      it "should raise an error if the configuration file is not a Hash" do
+        expect{Buzzdata.new nil, :config_file => fixture_path('not_a_hash.yml')}.to raise_error(Buzzdata::Error, /not a Hash/)
+      end
+
+      it "should raise an error if the API key is missing from the configuration file" do
+        expect{Buzzdata.new nil, :config_file => fixture_path('missing_api_key.yml')}.to raise_error(Buzzdata::Error, /API key missing/)
+        
+      end
+    end
+  end
+end

data/spec/fixtures/custom.yml

@@ -0,0 +1 @@
+api_key: dummy

data/spec/fixtures/invalid_yaml.yml

@@ -0,0 +1,2 @@
+-----
+foo: bar

data/spec/fixtures/missing_api_key.yml

@@ -0,0 +1 @@
+api_key: 

data/spec/fixtures/not_a_hash.yml

@@ -0,0 +1 @@
+true

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format nested
+--loadby mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'rspec'
+require File.dirname(__FILE__) + '/../lib/buzzdata'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: buzzdata
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- BuzzData
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+description: 
+email: 
+- support@buzzdata.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- buzzdata.gemspec
+- lib/buzzdata.rb
+- lib/buzzdata/error.rb
+- lib/buzzdata/rest_helpers.rb
+- lib/buzzdata/upload.rb
+- lib/buzzdata/version.rb
+- samples/config/buzzdata.yml.sample
+- samples/dataset_overview.rb
+- samples/datasets/kittens_born.csv
+- samples/download_data.rb
+- samples/upload_data.rb
+- spec/buzzdata_spec.rb
+- spec/fixtures/custom.yml
+- spec/fixtures/invalid_yaml.yml
+- spec/fixtures/missing_api_key.yml
+- spec/fixtures/not_a_hash.yml
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://buzzdata.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: buzzdata
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby client for the BuzzData API
+test_files: 
+- spec/buzzdata_spec.rb
+- spec/fixtures/custom.yml
+- spec/fixtures/invalid_yaml.yml
+- spec/fixtures/missing_api_key.yml
+- spec/fixtures/not_a_hash.yml
+- spec/spec.opts
+- spec/spec_helper.rb