datacatalog 0.3.0 → 0.3.1

data/spec/api_key_spec.rb

@@ -1,145 +1,145 @@
-require File.dirname(__FILE__) + '/spec_helper'
-include DataCatalog
-
-module ApiKeyHelpers
-  def create_user
-    User.create({
-      :name  => "Ted Smith",
-      :email => "ted@email.com"
-    })
-  end
-  
-  def create_user_with_2_keys
-    user = create_user
-    ApiKey.create(user.id, {
-      :purpose  => "Civic hacking",
-      :key_type => "application"
-    })
-    User.get(user.id)
-  end
-end
-
-describe ApiKey do
-  include ApiKeyHelpers
-
-  before do
-    setup_api
-    clean_slate
-  end
-
-  describe ".all" do
-    before do
-      @user = create_user_with_2_keys
-      @api_keys = ApiKey.all(@user.id)
-    end
-  
-    it "should return an enumeration of API keys" do
-      @api_keys.each do |api_key|
-        api_key.should be_an_instance_of(ApiKey)
-      end
-    end
-  
-    it "should return correct titles" do
-      @api_keys.map(&:key_type).should == %w(primary application)
-    end
-  end
-
-  describe ".all with conditions" do
-    before do
-      @user = create_user_with_2_keys
-      @api_keys = ApiKey.all(@user.id, :key_type => "application")
-    end
-    
-    it "should return an enumeration of API keys" do
-      @api_keys.each do |api_key|
-        api_key.should be_an_instance_of(ApiKey)
-      end
-    end
-    
-    it "should return correct titles" do
-      @api_keys.map(&:key_type).should == %w(application)
-    end
-  end
-
-  describe ".create" do
-    it "should create a new API key from basic params" do
-      user = create_user_with_2_keys
-      api_key = ApiKey.create(user.id, {
-        :purpose  => "Data wrangling",
-        :key_type => "valet"
-      })
-      api_key.should be_an_instance_of(ApiKey)
-      api_key.key_type.should == "valet"
-    end
-  end
-
-  describe ".first" do
-    before do
-      @user = create_user_with_2_keys
-    end
-  
-    it "should return an API key" do
-      api_key = ApiKey.first(@user.id, :purpose => "Civic hacking")
-      api_key.should be_an_instance_of(ApiKey)
-      api_key.purpose.should == "Civic hacking"
-    end
-    
-    it "should return nil if nothing found" do
-      api_key = ApiKey.first(@user.id, :purpose => "Evil")
-      api_key.should be_nil
-    end
-  end
-
-  describe ".get" do
-    before do
-      @user = create_user_with_2_keys
-      @api_key = @user.api_keys[1]
-    end
-  
-    it "should return an API key" do
-      api_key = ApiKey.get(@user.id, @api_key.id)
-      api_key.should be_an_instance_of(ApiKey)
-      api_key.purpose.should == "Civic hacking"
-    end
-    
-    it "should raise NotFound if no API key exists" do
-      executing do
-        ApiKey.get(@user.id, mangle(@api_key.id))
-      end.should raise_error(NotFound)
-    end
-  end
-
-  describe ".update" do
-    before do
-      @user = create_user_with_2_keys
-      @api_key = @user.api_keys[1]
-    end
-  
-    it "should update an existing source from valid params" do
-      api_key = ApiKey.update(@user.id, @api_key.id, {
-        :purpose => "Local Government Reporting"
-      })
-      api_key.should be_an_instance_of(ApiKey)
-      api_key.purpose.should == "Local Government Reporting"
-    end
-  end
-
-  describe ".destroy" do
-    before do
-      @user = create_user_with_2_keys
-      @api_key = @user.api_keys[1]
-    end
-  
-    it "should destroy an existing source" do
-      result = ApiKey.destroy(@user.id, @api_key.id)
-      result.should be_true
-    end
-    
-    it "should raise NotFound if API key does not exist" do
-      executing do
-        ApiKey.destroy(@user.id, mangle(@api_key.id))
-      end.should raise_error(NotFound)
-    end
-  end
-
-end
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+module ApiKeyHelpers
+  def create_user
+    User.create({
+      :name  => "Ted Smith",
+      :email => "ted@email.com"
+    })
+  end
+  
+  def create_user_with_2_keys
+    user = create_user
+    ApiKey.create(user.id, {
+      :purpose  => "Civic hacking",
+      :key_type => "application"
+    })
+    User.get(user.id)
+  end
+end
+
+describe ApiKey do
+  include ApiKeyHelpers
+
+  before do
+    setup_api
+    clean_slate
+  end
+
+  describe ".all" do
+    before do
+      @user = create_user_with_2_keys
+      @api_keys = ApiKey.all(@user.id)
+    end
+  
+    it "should return an enumeration of API keys" do
+      @api_keys.each do |api_key|
+        api_key.should be_an_instance_of(ApiKey)
+      end
+    end
+  
+    it "should return correct titles" do
+      @api_keys.map(&:key_type).should == %w(primary application)
+    end
+  end
+
+  describe ".all with conditions" do
+    before do
+      @user = create_user_with_2_keys
+      @api_keys = ApiKey.all(@user.id, :key_type => "application")
+    end
+    
+    it "should return an enumeration of API keys" do
+      @api_keys.each do |api_key|
+        api_key.should be_an_instance_of(ApiKey)
+      end
+    end
+    
+    it "should return correct titles" do
+      @api_keys.map(&:key_type).should == %w(application)
+    end
+  end
+
+  describe ".create" do
+    it "should create a new API key from basic params" do
+      user = create_user_with_2_keys
+      api_key = ApiKey.create(user.id, {
+        :purpose  => "Data wrangling",
+        :key_type => "valet"
+      })
+      api_key.should be_an_instance_of(ApiKey)
+      api_key.key_type.should == "valet"
+    end
+  end
+
+  describe ".first" do
+    before do
+      @user = create_user_with_2_keys
+    end
+  
+    it "should return an API key" do
+      api_key = ApiKey.first(@user.id, :purpose => "Civic hacking")
+      api_key.should be_an_instance_of(ApiKey)
+      api_key.purpose.should == "Civic hacking"
+    end
+    
+    it "should return nil if nothing found" do
+      api_key = ApiKey.first(@user.id, :purpose => "Evil")
+      api_key.should be_nil
+    end
+  end
+
+  describe ".get" do
+    before do
+      @user = create_user_with_2_keys
+      @api_key = @user.api_keys[1]
+    end
+  
+    it "should return an API key" do
+      api_key = ApiKey.get(@user.id, @api_key.id)
+      api_key.should be_an_instance_of(ApiKey)
+      api_key.purpose.should == "Civic hacking"
+    end
+    
+    it "should raise NotFound if no API key exists" do
+      executing do
+        ApiKey.get(@user.id, mangle(@api_key.id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".update" do
+    before do
+      @user = create_user_with_2_keys
+      @api_key = @user.api_keys[1]
+    end
+  
+    it "should update an existing source from valid params" do
+      api_key = ApiKey.update(@user.id, @api_key.id, {
+        :purpose => "Local Government Reporting"
+      })
+      api_key.should be_an_instance_of(ApiKey)
+      api_key.purpose.should == "Local Government Reporting"
+    end
+  end
+
+  describe ".destroy" do
+    before do
+      @user = create_user_with_2_keys
+      @api_key = @user.api_keys[1]
+    end
+  
+    it "should destroy an existing source" do
+      result = ApiKey.destroy(@user.id, @api_key.id)
+      result.should be_true
+    end
+    
+    it "should raise NotFound if API key does not exist" do
+      executing do
+        ApiKey.destroy(@user.id, mangle(@api_key.id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+end

data/spec/base_spec.rb

@@ -1,129 +1,129 @@
-require File.dirname(__FILE__) + '/spec_helper'
-include DataCatalog
-
-describe Base do
-
-  before do
-    setup_api
-  end
-
-  describe ".base_uri=" do
-    it "should set and normalize the base URI" do
-      setup_api
-      DataCatalog.base_uri = 'host.com'
-      DataCatalog.base_uri.should == 'http://host.com'
-    end
-    
-    it "should set the base URI to the default if it's not explicitly defined" do
-      DataCatalog.base_uri = ''
-      DataCatalog.base_uri.should == 'http://api.nationaldatacatalog.com'
-      Base.base_uri.should == 'http://api.nationaldatacatalog.com'
-    end
-  end
-
-  describe ".check_status" do
-    it "should return nil on 200 OK" do
-      response = HTTParty::Response.new(nil, '{"foo":"bar"}', 200, 'OK', {})
-      Base.check_status(response).should be_nil
-    end
-    
-    it "should raise BadRequest on 400 Bad Request" do
-      response = HTTParty::Response.new(nil, '[]', 400, 'Bad Request', {})
-      executing do
-        Base.check_status(response)
-      end.should raise_error(BadRequest)
-    end
-  
-    it "should raise Unauthorized on 401 Unauthorized" do
-      response = HTTParty::Response.new(nil, '', 401, 'Unauthorized', {})
-      executing do
-        Base.check_status(response)
-      end.should raise_error(Unauthorized)
-    end
-  
-    it "should raise NotFound on 404 Not Found" do
-      response = HTTParty::Response.new(nil, '[]', 404, 'Not Found', {})
-      executing do
-        Base.check_status(response)
-      end.should raise_error(NotFound)
-    end
-    
-    it "should raise InternalServerError on 500 Internal Server Error" do
-      response = HTTParty::Response.new(nil, '', 500, 'Internal Server Error', {})
-      executing do
-        Base.check_status(response)
-      end.should raise_error(InternalServerError)
-    end
-  end
-
-  describe ".error" do
-    it "should return an 'Unable to parse:' message when body is blank" do
-      response = HTTParty::Response.new(nil, '', 404, 'Not Found', {})
-      Base.error(response).should == %(Unable to parse: "")
-    end
-    
-    it "should return 'Response was empty' when body is an empty JSON object" do
-      response = HTTParty::Response.new(nil, '{}', 404, 'Not Found', {})
-      Base.error(response).should == "Response was empty"
-    end
-    
-    it "should return 'Response was empty' when body is an empty array" do
-      response = HTTParty::Response.new(nil, '[]', 404, 'Not Found', {})
-      Base.error(response).should == "Response was empty"
-    end
-    
-    it "should return the contents of the errors hash when it exists" do
-      errors = '{"errors":["bad_error"]}'
-      response = HTTParty::Response.new(nil, errors, 400, 'Bad Request', {})
-      Base.error(response).should == '["bad_error"]'
-    end
-    
-    it "should return the contents of the response body when no errors hash exists" do
-      errors = '{"foo":["bar"]}'
-      response = HTTParty::Response.new(nil, errors, 400, 'Bad Request', {})
-      Base.error(response).should == '{"foo":["bar"]}'
-    end
-  end
-
-  describe ".many" do
-    it "should create an object from a filled array" do
-      array = Base.many([
-        {
-          :name  => "Carl Malamud",
-          :email => "no-spam-carl@media.org"
-        },
-        {
-          :name  => "Ellen Miller",
-          :email => "no-spam-ellen@sunlightfoundation.com"
-        }
-      ])
-      array.map do |item|
-        item.should be_an_instance_of(Base)
-      end
-      array.map(&:name).should == ["Carl Malamud", "Ellen Miller"]
-    end    
-  end
-
-  describe ".one" do
-    it "should create an object from a filled hash" do
-      hash = Base.one({
-        :name  => "John Smith",
-        :email => "john@email.com"
-      })
-      hash.should be_an_instance_of(Base)
-      hash.name.should == "John Smith"
-      hash.email.should == "john@email.com"
-    end
-    
-    it "should return nil from an empty hash" do
-      hash = Base.one({})
-      hash.should be_nil
-    end
-    
-    it "should return nil from nil" do
-      hash = Base.one(nil)
-      hash.should be_nil
-    end
-  end
-
-end
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Base do
+
+  before do
+    setup_api
+  end
+
+  describe ".base_uri=" do
+    it "should set and normalize the base URI" do
+      setup_api
+      DataCatalog.base_uri = 'host.com'
+      DataCatalog.base_uri.should == 'http://host.com'
+    end
+    
+    it "should set the base URI to the default if it's not explicitly defined" do
+      DataCatalog.base_uri = ''
+      DataCatalog.base_uri.should == 'http://api.nationaldatacatalog.com'
+      Base.base_uri.should == 'http://api.nationaldatacatalog.com'
+    end
+  end
+
+  describe ".check_status" do
+    it "should return nil on 200 OK" do
+      response = HTTParty::Response.new(nil, '{"foo":"bar"}', 200, 'OK', {})
+      Base.check_status(response).should be_nil
+    end
+    
+    it "should raise BadRequest on 400 Bad Request" do
+      response = HTTParty::Response.new(nil, '[]', 400, 'Bad Request', {})
+      executing do
+        Base.check_status(response)
+      end.should raise_error(BadRequest)
+    end
+  
+    it "should raise Unauthorized on 401 Unauthorized" do
+      response = HTTParty::Response.new(nil, '', 401, 'Unauthorized', {})
+      executing do
+        Base.check_status(response)
+      end.should raise_error(Unauthorized)
+    end
+  
+    it "should raise NotFound on 404 Not Found" do
+      response = HTTParty::Response.new(nil, '[]', 404, 'Not Found', {})
+      executing do
+        Base.check_status(response)
+      end.should raise_error(NotFound)
+    end
+    
+    it "should raise InternalServerError on 500 Internal Server Error" do
+      response = HTTParty::Response.new(nil, '', 500, 'Internal Server Error', {})
+      executing do
+        Base.check_status(response)
+      end.should raise_error(InternalServerError)
+    end
+  end
+
+  describe ".error" do
+    it "should return an 'Unable to parse:' message when body is blank" do
+      response = HTTParty::Response.new(nil, '', 404, 'Not Found', {})
+      Base.error(response).should == %(Unable to parse: "")
+    end
+    
+    it "should return 'Response was empty' when body is an empty JSON object" do
+      response = HTTParty::Response.new(nil, '{}', 404, 'Not Found', {})
+      Base.error(response).should == "Response was empty"
+    end
+    
+    it "should return 'Response was empty' when body is an empty array" do
+      response = HTTParty::Response.new(nil, '[]', 404, 'Not Found', {})
+      Base.error(response).should == "Response was empty"
+    end
+    
+    it "should return the contents of the errors hash when it exists" do
+      errors = '{"errors":["bad_error"]}'
+      response = HTTParty::Response.new(nil, errors, 400, 'Bad Request', {})
+      Base.error(response).should == '["bad_error"]'
+    end
+    
+    it "should return the contents of the response body when no errors hash exists" do
+      errors = '{"foo":["bar"]}'
+      response = HTTParty::Response.new(nil, errors, 400, 'Bad Request', {})
+      Base.error(response).should == '{"foo":["bar"]}'
+    end
+  end
+
+  describe ".many" do
+    it "should create an object from a filled array" do
+      array = Base.many([
+        {
+          :name  => "Carl Malamud",
+          :email => "no-spam-carl@media.org"
+        },
+        {
+          :name  => "Ellen Miller",
+          :email => "no-spam-ellen@sunlightfoundation.com"
+        }
+      ])
+      array.map do |item|
+        item.should be_an_instance_of(Base)
+      end
+      array.map(&:name).should == ["Carl Malamud", "Ellen Miller"]
+    end    
+  end
+
+  describe ".one" do
+    it "should create an object from a filled hash" do
+      hash = Base.one({
+        :name  => "John Smith",
+        :email => "john@email.com"
+      })
+      hash.should be_an_instance_of(Base)
+      hash.name.should == "John Smith"
+      hash.email.should == "john@email.com"
+    end
+    
+    it "should return nil from an empty hash" do
+      hash = Base.one({})
+      hash.should be_nil
+    end
+    
+    it "should return nil from nil" do
+      hash = Base.one(nil)
+      hash.should be_nil
+    end
+  end
+
+end