buzzdata 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,6 @@
 # BuzzData Ruby Client Library
 
-The BuzzData Ruby Client Library is a simple wrapper for the BuzzData HTTP API that allows you to easily interact with datasets on BuzzData. 
+The BuzzData Ruby Client Library is a simple wrapper for the [BuzzData HTTP API](http://buzzdata.com/faq/buzzdata-api) that allows you to easily interact with datasets on BuzzData. 
 
 ## Example
 
@@ -10,12 +10,12 @@ The BuzzData Ruby Client Library is a simple wrapper for the BuzzData HTTP API t
     buzzdata = Buzzdata.new('YOUR_API_KEY')
     
     # Create a Dataset
-    dataset = buzzdata.create_dataset(:username => 'eviltrout',
-                                      :name => "My Awesome Dataset!",
-                                      :public => false,
-                                      :readme => "This is my awesome dataset",
-                                      :license => 'cc0',
-                                      :topics => ['testing-buzzdata'])
+    dataset = buzzdata.create_dataset(username: 'eviltrout',
+                                      name: "My Awesome Dataset!",
+                                      public: false,
+                                      readme: "This is my awesome dataset",
+                                      license: 'cc0',
+                                      topics: ['testing-buzzdata'])
                                  
     # Upload some data
     buzzdata.upload(dataset['id'], File.new('datasets/celebrities.csv'), 'My first dataset!')
@@ -75,12 +75,12 @@ You can retrieve a list of uploaded versions of a dataset by calling `dataset_hi
 
 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'])  
+    >> 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
 
@@ -127,6 +127,16 @@ If your account has the ability to upload data to a dataset, you can do so like
 ### Get a list of usable Topics 
 
     >> buzzdata.topics
+
+
+## Admin Level Functions
+
+The following functions can only be used if your API key has been granted admin access:
+
+
+### Create a user
+
+    >> buzzdata.create_user(username: 'eviltrout_jr', email: 'eviltroutjr@buzzdata.com', password: 'aSECUREp4ssword')    
   
 
 Copyright © 2011 [BuzzData](http://buzzdata.com/), released under the MIT license 

data/buzzdata.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency('rest-client', '~> 1.6.7')
   s.add_development_dependency('rspec', '~> 2.6.0')
+  s.add_development_dependency('mocha', '~> 0.10.0')
 end

data/lib/buzzdata.rb

@@ -135,6 +135,16 @@ class Buzzdata
     result['dataset']
   end
 
+  def create_user(attributes)
+    raise Buzzdata::Error, "Missing attributes" if attributes.nil?
+    raise Buzzdata::Error, "Username is required" if param_blank?(attributes, :username)
+    raise Buzzdata::Error, "Email is required" if param_blank?(attributes, :email)
+    raise Buzzdata::Error, "Password is required" if param_blank?(attributes, :password)
+
+    result = post_json(url_for("users"), :user => attributes)
+    result['user']
+  end
+
   private
     
     def param_blank?(obj, param)      

data/lib/buzzdata/version.rb

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

data/spec/buzzdata_spec.rb

@@ -5,15 +5,6 @@ require 'securerandom'
 
 class Buzzdata
   describe Buzzdata do
-    GENERIC_USER = 'eviltrout'
-    NONEXISTENT_USER = 'missing'
-    USER_WITH_PRIVATE_DATASET = 'jpmckinney'
-    PUBLISH_SLEEP_INTERVAL = 5
-
-    CLONABLE_DATASET = 'eviltrout/pets'
-    NONEXISTENT_DATASET = 'missing/missing'
-    PRIVATE_DATASET_BELONGING_TO_ANOTHER_USER = 'jpmckinney/private'
-    UNPUBLISHED_DATASET_BELONGING_TO_ANOTHER_USER = 'jpmckinney/unpublished'
 
     def fixture_path(basename)
       File.expand_path File.dirname(__FILE__) + '/fixtures/' + basename
@@ -54,5 +45,44 @@ class Buzzdata
         expect{Buzzdata.new nil, :config_file => fixture_path('missing_api_key.yml')}.to raise_error(Buzzdata::Error, /API key missing/)
       end
     end
+
+    describe '#valid_credentials' do
+
+      before do
+        @buzzdata = Buzzdata.new nil, :config_file => fixture_path('custom.yml')
+      end
+
+      describe '#create_user' do
+
+        it 'posts the json when all params are present' do
+          @buzzdata.expects(:post_json).once.returns('user' => {})
+          @buzzdata.create_user(username: 'eviltrout', password: 'top_secret', email: 'eviltrout@buzzdata.com')
+        end
+
+        describe '#failing' do
+          before do
+            @buzzdata.expects(:post_json).never
+          end
+
+          it 'raises an exception when the username is missing' do            
+            expect { @buzzdata.create_user(password: 'top_secret', email: 'eviltrout@buzzdata.com') }.to 
+              raise_error(Buzzdata::Error, /Username is required/)
+          end
+
+          it 'raises an exception when the password is missing' do            
+            expect { @buzzdata.create_user(username: 'eviltrout', email: 'eviltrout@buzzdata.com') }.to 
+              raise_error(Buzzdata::Error, /Password is required/)
+          end
+          
+          it 'raises an exception when the email is missing' do            
+            expect { @buzzdata.create_user(username: 'eviltrout', password: 'top_secret') }.to 
+              raise_error(Buzzdata::Error, /Email is required/)
+          end
+        end
+        
+      end
+
+    end
+
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,9 @@
 require 'rubygems'
 require 'rspec'
 require File.dirname(__FILE__) + '/../lib/buzzdata'
+
+require 'mocha'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buzzdata
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-05 00:00:00.000000000 -05:00
+date: 2012-01-31 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2155951100 !ruby/object:Gem::Requirement
+  requirement: &2165160280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *2155951100
+  version_requirements: *2165160280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2155947540 !ruby/object:Gem::Requirement
+  requirement: &2165159640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +33,18 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2155947540
+  version_requirements: *2165159640
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2165159040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *2165159040
 description: 
 email:
 - support@buzzdata.com