buzzdata 0.0.4 → 0.0.5

data/.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 buzzdata.yml
 spec/fixtures/unreadable.yml
+samples/create_and_insert.rb
 *.gem
 .bundle
 .yardoc

data/README.md

@@ -128,6 +128,56 @@ If your account has the ability to upload data to a dataset, you can do so like
 
     >> buzzdata.topics
 
+## Updating a Dataset
+
+In some cases, it makes more sense to update your data on a row by row basis rather than importing a whole dataset at once.
+For example, perhaps you made a GPS application and once an hour want to update it with your location. You could use the 
+row level API to insert only the new locations into the dataset.
+
+
+### Staging your Updates
+
+Before you get started with the Row-Level API you'll have to familiarize yourself with the concept of staging your update.
+Every time you upload a dataset to buzzdata, it creates a new version in the history. If you have an application that 
+updates the dataset frequently, you would end up with many, many versions that would pollute your dataset's history. To 
+get around this, we ask that you stage your updates before commiting them.
+
+You can think of staging as setting aside the data that you want to commit later. You start by creating a stage with a
+REST call. Then you add your updates to the stage whenever you want. Once you are ready to create a new version and 
+update the dataset, you call commit.
+
+In the GPS example above, a good idea might be to stage a day's worth of updates, and then commit them at the end of the
+day. It's up to you to decide when it makes sense for your dataset to be released as a new version!
+
+
+### Create a Stage
+
+    >> stage_id = buzzdata.create_stage('eviltrout/pets')
+
+### Stage an insertion
+
+    >> buzzdata.create_stage('eviltrout/pets', stage_id, ['col1', 'col2', 'col3'])
+
+### Stage an update
+
+    # where 1 is the row number we're updating.
+    >> buzzdata.create_stage('eviltrout/pets', stage_id, 1, ['col1', 'col2', 'col3'])
+
+### Stage a delete
+
+    # in this example, 2 is the row number we're removing
+    >> buzzdata.delete_row('eviltrout/pets', stage_id, 2)
+
+### Commit the Stage
+
+    # Create a new version of your dataset with the updates.
+    >> buzzdata.commit_stage('eviltrout/pets', stage_id)
+
+### Rollback the Stage
+
+    # In case you decide you don't want to create a new version
+    >> buzzdata.rollback_stage('eviltrout/pets', stage_id)
+
 
 ## Admin Level Functions
 

data/lib/buzzdata.rb

@@ -4,8 +4,8 @@ require 'json'
 require 'yaml'
 
 # Our code
-require 'buzzdata/error'
-require 'buzzdata/rest_helpers'
+require File.join(File.dirname(__FILE__), 'buzzdata/error')
+require File.join(File.dirname(__FILE__), 'buzzdata/rest_helpers')
 
 class Buzzdata
   YAML_ERRORS = [ArgumentError]
@@ -145,8 +145,37 @@ class Buzzdata
     result['user']
   end
 
+  def create_stage(dataset)
+    result = post_json(url_for("#{dataset}/stage"))
+    result['id']
+  end
+
+  def insert_rows(dataset, stage_id, rows)
+    check_success(post_json(url_for("#{dataset}/stage/#{stage_id}/rows"), rows: JSON.dump(rows)))
+  end
+
+  def update_row(dataset, stage_id, row_number, row)
+    check_success(put_json(url_for("#{dataset}/stage/#{stage_id}/rows/#{row_number}"), row: JSON.dump(row)))
+  end
+
+  def delete_row(dataset, stage_id, row_number)
+    check_success(delete_json(url_for("#{dataset}/stage/#{stage_id}/rows/#{row_number}")))
+  end
+
+  def commit_stage(dataset, stage_id)
+    check_success(post_json(url_for("#{dataset}/stage/#{stage_id}/commit")))
+  end
+
+  def rollback_stage(dataset, stage_id)
+    check_success(post_json(url_for("#{dataset}/stage/#{stage_id}/rollback")))
+  end
+
   private
     
+    def check_success(result)
+      raise Buzzdata::Error, "Error Updating row" if result['success'] != "OK"
+    end
+
     def param_blank?(obj, param)      
       return (obj.nil? or obj[param].nil? or obj[param].empty?)
     end

data/lib/buzzdata/rest_helpers.rb

@@ -11,7 +11,7 @@ module RestHelpers
     
     define_method(method) do |url, params={}|
       params['api_key'] = @api_key
-      params = {:params => params} unless method == :post
+      params = {:params => params} unless [:post, :put].include?(method)
 
       RestClient.send(method, url, params) do |response, request, result, &block|        
         case response.code

data/lib/buzzdata/version.rb

@@ -1,3 +1,3 @@
 class Buzzdata
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/samples/append_data.rb

@@ -0,0 +1,16 @@
+require '../lib/buzzdata'
+
+if ARGV.size < 2
+  puts "Usage: ./append_data.rb dataset"
+  puts "Example: ./append_data.rb eviltrout/kittens-born-by-month col1 col2 col3 ..."
+  exit(0)
+end
+
+# Retrieve a Dataset's Details
+buzzdata = Buzzdata.new
+dataset = ARGV[0]
+
+stage_id = buzzdata.create_stage(dataset)
+buzzdata.insert_rows(dataset, stage_id, ARGV[1..-1])
+buzzdata.commit_stage(dataset, stage_id)
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buzzdata
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-31 00:00:00.000000000 -05:00
+date: 2012-02-15 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2165160280 !ruby/object:Gem::Requirement
+  requirement: &2169934080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *2165160280
+  version_requirements: *2169934080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165159640 !ruby/object:Gem::Requirement
+  requirement: &2169933560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2165159640
+  version_requirements: *2169933560
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2165159040 !ruby/object:Gem::Requirement
+  requirement: &2169932960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,7 +44,7 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *2165159040
+  version_requirements: *2169932960
 description: 
 email:
 - support@buzzdata.com
@@ -62,6 +62,7 @@ files:
 - lib/buzzdata/error.rb
 - lib/buzzdata/rest_helpers.rb
 - lib/buzzdata/version.rb
+- samples/append_data.rb
 - samples/config/buzzdata.yml.sample
 - samples/dataset_overview.rb
 - samples/datasets/kittens_born.csv