datacatalog 0.1.0 → 0.2.3

data/spec/datacatalog_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe DataCatalog do
+
+  describe "module accessors" do
+    it "should access the API Key" do
+      DataCatalog.api_key = "4159179f32ff8fefd2c6d48b7e675e7736bf1357"
+      DataCatalog.api_key.should == "4159179f32ff8fefd2c6d48b7e675e7736bf1357"
+    end
+
+    it "should access the base URI" do
+      DataCatalog.base_uri = 'http://somehost.com'
+      DataCatalog.base_uri.should == 'http://somehost.com'
+    end
+  end
+
+  describe ".with_key" do
+    it "should set the API key within the block" do
+      regular_key = '4159179f32ff8fefd2c6d48b7e675e7736bf1357'
+      DataCatalog.api_key = regular_key
+      temporary_key = '0000123400001234000012340000123400001234'
+      DataCatalog.with_key(temporary_key) do
+        DataCatalog.api_key.should == temporary_key
+      end
+      DataCatalog.api_key.should == regular_key
+    end
+    
+    it "should return the last value in the block" do
+      DataCatalog.with_key("0000444400004444") do
+        42
+      end.should == 42
+    end
+  end
+
+end

data/spec/source_spec.rb

@@ -1,101 +1,162 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe DataCatalog::Source do
-
-  def create_source(params={})
-    valid_params = {
-      :title => "Some FCC Data",
-      :url   => "http://fcc.gov/somedata.csv"
-    }
-    DataCatalog::Source.create(valid_params.merge(params))
-  end
-  
-  before(:each) do
-    setup_api
-    clean_slate
-  end
-
-  describe ".all" do
-    before do
-      %w(FCC NASA DOE).each do |name|
-        DataCatalog::Source.create({
-          :title => "#{name} Data",
-          :url   => "http://#{name.downcase}.gov/data.xml"
-        })
-      end
-      @sources = DataCatalog::Source.all
-    end
-    
-    it "should return an enumeration of sources" do
-      @sources.each do |source|
-        source.should be_an_instance_of(DataCatalog::Source)
-      end
-    end
-    
-    it "should return correct titles" do
-      expected = ["FCC Data", "NASA Data", "DOE Data"]
-      @sources.map(&:title).sort.should == expected.sort
-    end
-  end # describe ".all"
-  
-  describe ".create" do
-    it "should create a new source from basic params" do
-      source = create_source
-      source.should be_an_instance_of(DataCatalog::Source)
-      source.url.should == "http://fcc.gov/somedata.csv"
-    end
-    
-    it "should create a new source from custom params" do
-      source = create_source({ :custom => {
-        "0" => {
-          :label       => "License",
-          :description => "License",
-          :type        => "string",
-          :value       => "Public Domain"
-        }
-      }})
-      source.should be_an_instance_of(DataCatalog::Source)
-      source.url.should == "http://fcc.gov/somedata.csv"
-      source.custom.should == {
-        "0" => {
-          "label"       => "License",
-          "description" => "License",
-          "type"        => "string",
-          "value"       => "Public Domain"
-        }
-      }
-    end
-  end # describe ".all"
-
-  describe ".update" do
-    before do
-      @source = create_source
-    end
-
-    it "should update an existing source from valid params" do
-      source = DataCatalog::Source.update(@source.id, {
-        :url => "http://fec.gov/newdata.csv"
-      })
-      source.should be_an_instance_of(DataCatalog::Source)
-      source.url.should == "http://fec.gov/newdata.csv"
-    end
-  end # describe ".all"  
-  
-  describe ".destroy" do
-    before do
-      @source = create_source
-    end
-
-    it "should destroy an existing source" do
-      result = DataCatalog::Source.destroy(@source.id)
-      result.should be_true
-    end
-    
-    it "should raise NotFound when attempting to destroy non-existing source" do
-      executing do
-        DataCatalog::Source.destroy(mangle(@source.id))
-      end.should raise_error(DataCatalog::NotFound)
-    end
-  end # describe ".destroy"
-  
-end
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+module SourceHelpers
+  def create_source(params={})
+    valid_params = {
+      :title => "Some FCC Data",
+      :url   => "http://fcc.gov/somedata.csv"
+    }
+    Source.create(valid_params.merge(params))
+  end
+
+  def create_3_sources
+    %w(FCC NASA DOE).each do |name|
+      Source.create({
+        :title => "#{name} Data",
+        :url   => "http://#{name.downcase}.gov/data.xml"
+      })
+    end
+  end
+end
+
+describe Source do
+  include SourceHelpers
+
+  before do
+    setup_api
+    clean_slate
+  end
+
+  describe ".all" do
+    before do
+      create_3_sources
+      @sources = Source.all
+    end
+  
+    it "should return an enumeration of sources" do
+      @sources.each do |source|
+        source.should be_an_instance_of(Source)
+      end
+    end
+  
+    it "should return correct titles" do
+      expected = ["FCC Data", "NASA Data", "DOE Data"]
+      @sources.map(&:title).sort.should == expected.sort
+    end
+  end
+
+  describe ".all with conditions" do
+    before do
+      create_3_sources
+      @sources = Source.all(:title => "NASA Data")
+    end
+    
+    it "should return an enumeration of sources" do
+      @sources.each do |source|
+        source.should be_an_instance_of(Source)
+      end
+    end
+    
+    it "should return correct titles" do
+      expected = ["NASA Data"]
+      @sources.map(&:title).sort.should == expected.sort
+    end
+  end
+
+  describe ".create" do
+    it "should create a new source from basic params" do
+      source = create_source
+      source.should be_an_instance_of(Source)
+      source.url.should == "http://fcc.gov/somedata.csv"
+    end
+    
+    it "should create a new source from custom params" do
+      source = create_source({ :custom => {
+        "0" => {
+          :label       => "License",
+          :description => "License",
+          :type        => "string",
+          :value       => "Public Domain"
+        }
+      }})
+      source.should be_an_instance_of(Source)
+      source.url.should == "http://fcc.gov/somedata.csv"
+      source.custom.should == {
+        "0" => {
+          "label"       => "License",
+          "description" => "License",
+          "type"        => "string",
+          "value"       => "Public Domain"
+        }
+      }
+    end
+  end
+  
+  describe ".first" do
+    before do
+      create_3_sources
+    end
+  
+    it "should return a source" do
+      source = Source.first(:title => "NASA Data")
+      source.should be_an_instance_of(Source)
+      source.title.should == "NASA Data"
+    end
+    
+    it "should return nil if nothing found" do
+      source = Source.first(:title => "UFO Data")
+      source.should be_nil
+    end
+  end
+  
+  describe ".get" do
+    before do
+      @source = create_source
+    end
+  
+    it "should return a source" do
+      source = Source.get(@source.id)
+      source.should be_an_instance_of(Source)
+      source.title.should == "Some FCC Data"
+    end
+    
+    it "should raise NotFound if no source exists" do
+      executing do
+        Source.get(mangle(@source.id))
+      end.should raise_error(NotFound)
+    end
+  end
+  
+  describe ".update" do
+    before do
+      @source = create_source
+    end
+  
+    it "should update an existing source from valid params" do
+      source = Source.update(@source.id, {
+        :url => "http://fec.gov/newdata.csv"
+      })
+      source.should be_an_instance_of(Source)
+      source.url.should == "http://fec.gov/newdata.csv"
+    end
+  end
+  
+  describe ".destroy" do
+    before do
+      @source = create_source
+    end
+  
+    it "should destroy an existing source" do
+      result = Source.destroy(@source.id)
+      result.should be_true
+    end
+    
+    it "should raise NotFound when attempting to destroy non-existing source" do
+      executing do
+        Source.destroy(mangle(@source.id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+end

data/spec/spec.opts

@@ -1,4 +1,4 @@
---color
---timeout
-20
---diff
+--color
+--timeout
+20
+--diff

data/spec/spec_helper.rb

@@ -1,48 +1,48 @@
-require File.dirname(__FILE__) + '/../lib/datacatalog'
-require 'yaml'
-
-Spec::Runner.configure do |config|
-  config.mock_with :rr
-end
-
-alias :executing :lambda
-
-def setup_api
-  config = YAML.load_file(File.dirname(__FILE__) + '/../sandbox_api.yml')
-  DataCatalog.api_key = config['api_key']
-  DataCatalog.base_uri = config['base_uri']
-end
-
-def clean_slate
-  DataCatalog::User.all.each do |u|
-    DataCatalog::User.destroy(u.id) unless u.name == "Primary Admin"
-  end
-  DataCatalog::Source.all.each do |s|
-    DataCatalog::Source.destroy(s.id)
-  end
-end
-
-if RUBY_VERSION >= "1.8.7"
-  # Converts a valid ID into a almost-but-not-quite valid one.
-  # Here is an example of what it does:
-  # From ... 4ac2520b25b7e7056600034e
-  # To   ... a42c25b0527b7e50660030e4
-  def mangle(string)
-    array = string.chars.to_a
-    sliced = []
-    array.each_slice(2) { |s| sliced << s.reverse }
-    result = sliced.flatten.join
-    raise "mangle failed" if result == string
-    result
-  end
-else
-  # Converts a valid ID into a almost-but-not-quite valid one.
-  # Here is an example of what it does:
-  # From ... 4ac2520b25b7e7056600034e
-  # To   ... e4300066507e7b52b0252ca4
-  def mangle(string)
-    result = string.reverse
-    raise "mangle failed" if result == string
-    result
-  end
-end
+require File.dirname(__FILE__) + '/../lib/datacatalog'
+require 'yaml'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end
+
+alias :executing :lambda
+
+def setup_api
+  config = YAML.load_file(File.dirname(__FILE__) + '/../sandbox_api.yml')
+  DataCatalog.api_key = config['api_key']
+  DataCatalog.base_uri = config['base_uri']
+end
+
+def clean_slate
+  DataCatalog::User.all.each do |u|
+    DataCatalog::User.destroy(u.id) unless u.name == "Primary Admin"
+  end
+  DataCatalog::Source.all.each do |s|
+    DataCatalog::Source.destroy(s.id)
+  end
+end
+
+if RUBY_VERSION >= "1.8.7"
+  # Converts a valid ID into a almost-but-not-quite valid one.
+  # Here is an example of what it does:
+  # From ... 4ac2520b25b7e7056600034e
+  # To   ... a42c25b0527b7e50660030e4
+  def mangle(string)
+    array = string.chars.to_a
+    sliced = []
+    array.each_slice(2) { |s| sliced << s.reverse }
+    result = sliced.flatten.join
+    raise "mangle failed" if result == string
+    result
+  end
+else
+  # Converts a valid ID into a almost-but-not-quite valid one.
+  # Here is an example of what it does:
+  # From ... 4ac2520b25b7e7056600034e
+  # To   ... e4300066507e7b52b0252ca4
+  def mangle(string)
+    result = string.reverse
+    raise "mangle failed" if result == string
+    result
+  end
+end

data/spec/user_spec.rb

@@ -1,208 +1,278 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe DataCatalog::User do
-
-  def create_user
-    DataCatalog::User.create({
-      :name  => "Ted Smith",
-      :email => "ted@email.com"
-    })
-  end  
-  
-  def create_user_with_2_keys
-    user = create_user
-    result = user.generate_api_key!(
-      :purpose  => "Civic hacking with my awesome app",
-      :key_type => "application"
-    )
-    raise "generate_api_key! failed" unless result
-    raise "incorrect number of keys" unless user.api_keys.length == 2
-    user
-  end
-  
-  before(:each) do
-    setup_api
-    clean_slate
-  end
-
-  describe ".all" do
-    before(:each) do
-      3.times do |n|
-        DataCatalog::User.create(
-          :name  => "User-#{n}",
-          :email => "user_#{n}@email.com"
-        )
-      end
-      @users = DataCatalog::User.all
-    end
-    
-    it "should return an enumeration of users" do
-      @users.each do |u|
-        u.should be_an_instance_of(DataCatalog::User)
-      end
-    end
-    
-    it "should include four users" do
-      names = @users.map(&:name)
-      names.should include("User-0")
-      names.should include("User-1")
-      names.should include("User-2")
-    end
-  end # describe ".all"
-
-  describe ".create" do
-    before do
-      @user = create_user
-    end
-
-    it "should create a new user when valid params are passed in" do
-      @user.should be_an_instance_of(DataCatalog::User)
-      @user.name.should == "Ted Smith"
-      @user.email.should == "ted@email.com"
-    end
-
-    it "should raise BadRequest when invalid params are passed in" do
-      executing do
-        DataCatalog::User.create({ :garbage_field => "junk" })
-      end.should raise_error(DataCatalog::BadRequest)
-    end
-  end # describe ".create"
-  
-  describe ".find" do
-    before do
-      @user = create_user
-    end
-
-    it "should return a user" do  
-      user = DataCatalog::User.find(@user.id)
-      user.should be_an_instance_of(DataCatalog::User)
-      user.email.should == "ted@email.com"
-    end
-    
-    it "should raise NotFound out if no user exists" do
-      executing do
-        DataCatalog::User.find(mangle(@user.id))
-      end.should raise_error(DataCatalog::NotFound)
-    end
-  end # describe ".find"
-  
-  describe ".find_by_api_key" do
-    before do
-      @user = create_user
-    end
-    
-    it "should return a user" do
-      user = DataCatalog::User.find_by_api_key(@user.primary_api_key)
-      user.should be_an_instance_of(DataCatalog::User)
-      user.email.should == "ted@email.com"
-    end
-  end # describe ".find_by_api_key"
-    
-  describe ".update" do
-    before do
-      @user = create_user
-    end
-    
-    it "should update a user when valid params are passed in" do
-      user = DataCatalog::User.update(@user.id, { :name => "Jane Smith" })
-      user.name.should == "Jane Smith"
-    end
-
-    it "should raise BadRequest when invalid params are passed in" do
-      executing do
-        DataCatalog::User.update(@user.id, { :garbage => "junk" })
-      end.should raise_error(DataCatalog::BadRequest)
-    end
-
-  end # describe ".update"
-  
-  describe ".destroy" do
-    before do
-      @user = create_user
-    end
-
-    it "should destroy an existing user" do
-      result = DataCatalog::User.destroy(@user.id)
-      result.should be_true
-    end
-    
-    it "should raise NotFound when non-existing user" do
-      executing do
-        DataCatalog::User.destroy(mangle(@user.id))
-      end.should raise_error(DataCatalog::NotFound)
-    end
-  end # describe ".destroy"
-
-  describe "#generate_api_key!" do
-    before do
-      @user = create_user
-    end
-
-    it "should generate a new key for the user" do
-      @user.api_keys.length.should == 1
-      @user.generate_api_key!({
-        :purpose  => "Civic hacking with my awesome app",
-        :key_type => "application"
-      }).should be_true
-      @user.api_keys.length.should == 2
-      @user.api_keys.last[:purpose].should == "Civic hacking with my awesome app"
-      @user.application_api_keys.length.should == 1
-    end
-    
-    it "should raise BadRequest when attempting to create a primary key" do
-      executing do
-        @user.generate_api_key!({
-          :purpose  => "Civic hacking with my awesome app",
-          :key_type => "primary"
-        })
-      end.should raise_error(DataCatalog::BadRequest)
-    end
-  end # describe "#generate_api_key!"
-  
-  describe "#update_api_key!" do
-    before do
-      @user = create_user_with_2_keys
-    end
-  
-    it "should update a key for the user" do      
-      @user.update_api_key!(@user.api_keys[1].id, {
-        :key_type => "valet",
-        :purpose  => "To be more awesome"
-      }).should be_true
-      @user.api_keys[1].purpose.should == "To be more awesome"
-    end
-    
-    it "should raise NotFound if updating a key that doesn't exist" do
-      executing do
-        @user.update_api_key!(mangle(@user.api_keys[1].id), {})
-      end.should raise_error(DataCatalog::NotFound)
-    end
-
-    it "should raise BadRequest if primary key's type is changed" do
-      executing do
-        @user.update_api_key!(@user.api_keys[0].id, {
-          :key_type => "valet"
-        })
-      end.should raise_error(DataCatalog::BadRequest)
-    end
-  end # describe "#update_api_key!"
-
-  describe "#delete_api_key!" do
-    before do
-      @user = create_user_with_2_keys
-    end
-    
-    it "should delete a key for the user" do
-      @user.delete_api_key!(@user.api_keys[1].id).should be_true
-      @user.api_keys.length.should == 1
-    end
-    
-    it "should raise Conflict if deleting the primary key" do
-      executing do
-        @user.delete_api_key!(@user.api_keys[0].id)
-      end.should raise_error(DataCatalog::Conflict)
-      @user.api_keys.length.should == 2
-    end
-  end # describe "#delete_api_key!"
-  
-end
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+module UserHelpers
+  def create_user
+    User.create({
+      :name  => "Ted Smith",
+      :email => "ted@email.com"
+    })
+  end  
+  
+  def create_user_with_2_keys
+    user = create_user
+    result = user.generate_api_key!(
+      :purpose  => "Civic hacking with my awesome app",
+      :key_type => "application"
+    )
+    raise "generate_api_key! failed" unless result
+    raise "incorrect number of keys" unless user.api_keys.length == 2
+    user
+  end
+  
+  def create_3_users
+    3.times do |n|
+      User.create(
+        :name  => "User-#{n}",
+        :email => "user_#{n}@email.com"
+      )
+    end
+  end
+end
+
+describe User do
+  include UserHelpers
+  
+  before do
+    setup_api
+    clean_slate
+  end
+
+  describe ".all" do
+    before do
+      create_3_users
+      @users = User.all
+    end
+    
+    it "should return an enumeration of users" do
+      @users.each do |u|
+        u.should be_an_instance_of(User)
+      end
+    end
+    
+    it "should include four users" do
+      names = @users.map(&:name)
+      names.should include("User-0")
+      names.should include("User-1")
+      names.should include("User-2")
+    end
+  end
+
+  describe ".create" do
+    before do
+      @user = create_user
+    end
+
+    it "should create a new user when valid params are passed in" do
+      @user.should be_an_instance_of(User)
+      @user.name.should == "Ted Smith"
+      @user.email.should == "ted@email.com"
+    end
+
+    it "should raise BadRequest when invalid params are passed in" do
+      executing do
+        User.create({ :garbage_field => "junk" })
+      end.should raise_error(BadRequest)
+    end
+  end
+  
+  describe ".first" do
+    before do
+      create_3_users
+    end
+
+    it "should return a user" do
+      user = User.first(:name => "User-1")
+      user.should be_an_instance_of(User)
+      user.name.should == "User-1"
+    end
+    
+    it "should return nil if nothing found" do
+      user = User.first(:name => "Elvis")
+      user.should be_nil
+    end
+  end
+  
+  describe ".get_by_api_key" do
+    before do
+      @user = create_user
+    end
+    
+    it "should return a user" do
+      user = User.get_by_api_key(@user.primary_api_key)
+      user.should be_an_instance_of(User)
+      user.email.should == "ted@email.com"
+    end
+  end
+
+  describe ".get" do
+    before do
+      @user = create_user_with_2_keys
+    end
+    
+    describe "user exists" do
+      before do
+        @u = User.get(@user.id)
+      end
+
+      it "should return a user" do
+        @u.should be_an_instance_of(User)
+        @u.name.should == "Ted Smith"
+        @u.email.should == "ted@email.com"
+      end
+
+      it "should include 2 api_keys" do
+        keys = @u.api_keys
+        keys.map(&:key_type).should == %w(primary application)
+        keys.each do |key|
+          key.should be_an_instance_of(ApiKey)
+        end
+      end
+    end
+    
+    it "should raise NotFound if no user exists" do
+      executing do
+        User.get(mangle(@user.id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".get_by_api_key" do
+    before do
+      @user = create_user_with_2_keys
+    end
+    
+    describe "API key exists" do
+      before do
+        @u = User.get_by_api_key(@user.primary_api_key)
+      end
+
+      it "should return a user" do
+        @u.should be_an_instance_of(User)
+        @u.name.should == "Ted Smith"
+        @u.email.should == "ted@email.com"
+      end
+
+      it "should include 2 api_keys" do
+        keys = @u.api_keys
+        keys.map(&:key_type).should == %w(primary application)
+        keys.each do |key|
+          key.should be_an_instance_of(ApiKey)
+        end
+      end
+    end
+
+    it "should raise NotFound if API key does not exist" do
+      executing do
+        User.get_by_api_key(mangle(@user.primary_api_key))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe ".update" do
+    before do
+      @user = create_user
+    end
+    
+    it "should update a user when valid params are passed in" do
+      user = User.update(@user.id, { :name => "Jane Smith" })
+      user.name.should == "Jane Smith"
+    end
+
+    it "should raise BadRequest when invalid params are passed in" do
+      executing do
+        User.update(@user.id, { :garbage => "junk" })
+      end.should raise_error(BadRequest)
+    end
+  end
+  
+  describe ".destroy" do
+    before do
+      @user = create_user
+    end
+
+    it "should destroy an existing user" do
+      result = User.destroy(@user.id)
+      result.should be_true
+    end
+    
+    it "should raise NotFound when non-existing user" do
+      executing do
+        User.destroy(mangle(@user.id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+  describe "#generate_api_key!" do
+    before do
+      @user = create_user
+    end
+
+    it "should generate a new key for the user" do
+      @user.api_keys.length.should == 1
+      @user.generate_api_key!({
+        :purpose  => "Civic hacking with my awesome app",
+        :key_type => "application"
+      }).should be_true
+      @user.api_keys.length.should == 2
+      @user.api_keys.last[:purpose].should == "Civic hacking with my awesome app"
+      @user.application_api_keys.length.should == 1
+    end
+    
+    it "should raise BadRequest when attempting to create a primary key" do
+      executing do
+        @user.generate_api_key!({
+          :purpose  => "Civic hacking with my awesome app",
+          :key_type => "primary"
+        })
+      end.should raise_error(BadRequest)
+    end
+  end
+  
+  describe "#update_api_key!" do
+    before do
+      @user = create_user_with_2_keys
+    end
+  
+    it "should update a key for the user" do
+      @user.update_api_key!(@user.api_keys[1].id, {
+        :key_type => "valet",
+        :purpose  => "To be more awesome"
+      }).should be_true
+      @user.api_keys[1].purpose.should == "To be more awesome"
+    end
+    
+    it "should raise NotFound if updating a key that doesn't exist" do
+      executing do
+        @user.update_api_key!(mangle(@user.api_keys[1].id), {})
+      end.should raise_error(NotFound)
+    end
+
+    it "should raise BadRequest if primary key's type is changed" do
+      executing do
+        @user.update_api_key!(@user.api_keys[0].id, {
+          :key_type => "valet"
+        })
+      end.should raise_error(BadRequest)
+    end
+  end
+
+  describe "#delete_api_key!" do
+    before do
+      @user = create_user_with_2_keys
+    end
+    
+    it "should delete a key for the user" do
+      @user.delete_api_key!(@user.api_keys[1].id).should be_true
+      @user.api_keys.length.should == 1
+    end
+    
+    it "should raise Conflict if deleting the primary key" do
+      executing do
+        @user.delete_api_key!(@user.api_keys[0].id)
+      end.should raise_error(Conflict)
+      @user.api_keys.length.should == 2
+    end
+  end
+  
+end