datacatalog 0.4.15 → 0.4.16

data/README.md

@@ -20,7 +20,7 @@ For now, the gem will not be packaged. Instead, install it manually:
     require 'datacatalog'
 
     DataCatalog.api_key = 'c40505247a5e308a24d70a0118f76534b543795b'
-    
+
 ## Running Specs
 
 We're not mocking out any of the web API calls in the specs. Instead, we expect developers who wish to run the specs to download and run a local sandbox instance of the [Data Catalog API](http://github.com/sunlightlabs/datacatalog-api), a Sinatra app:

data/Rakefile

@@ -5,19 +5,19 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "datacatalog"
-    gem.version = '0.4.15'
+    gem.version = '0.4.16'
     gem.rubyforge_project = "datacatalog"
     gem.summary = %Q{Client for the National Data Catalog API}
     gem.description = %Q{A Ruby client library for the National Data Catalog API}
     gem.email = "luigi@sunlightfoundation.com"
     gem.homepage = "http://github.com/sunlightlabs/datacatalog"
     gem.authors = ["Luigi Montanez", "David James"]
-    gem.add_dependency('activesupport', ">= 2.3.5")
-    gem.add_dependency('httparty', ">= 0.5.2")
-    gem.add_dependency('mash', ">= 0.0.3")
+    gem.add_dependency('activesupport', ">= 2.3.8")
+    gem.add_dependency('httparty', ">= 0.6.1")
+    gem.add_dependency('mash', ">= 0.1.1")
     gem.add_dependency('version_string', ">= 0.1.0")
-    gem.add_development_dependency("jeweler", ">= 1.2.1")
-    gem.add_development_dependency("rspec", ">= 1.2.8")
+    gem.add_development_dependency("jeweler", ">= 1.4.0")
+    gem.add_development_dependency("rspec", ">= 1.3.0")
     # gem is a Gem::Specification...
     # see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/datacatalog.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{datacatalog}
-  s.version = "0.4.15"
+  s.version = "0.4.16"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Luigi Montanez", "David James"]
-  s.date = %q{2010-04-30}
+  s.date = %q{2010-08-10}
   s.description = %q{A Ruby client library for the National Data Catalog API}
   s.email = %q{luigi@sunlightfoundation.com}
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "lib/main.rb",
      "lib/resources/about.rb",
      "lib/resources/api_key.rb",
+     "lib/resources/broken_link.rb",
      "lib/resources/comment.rb",
      "lib/resources/document.rb",
      "lib/resources/download.rb",
@@ -49,6 +50,7 @@ Gem::Specification.new do |s|
      "spec/datacatalog_spec.rb",
      "spec/document_spec.rb",
      "spec/download_spec.rb",
+     "spec/empty_spec.rb",
      "spec/favorite_spec.rb",
      "spec/import_spec.rb",
      "spec/importer_spec.rb",
@@ -79,6 +81,7 @@ Gem::Specification.new do |s|
      "spec/datacatalog_spec.rb",
      "spec/document_spec.rb",
      "spec/download_spec.rb",
+     "spec/empty_spec.rb",
      "spec/favorite_spec.rb",
      "spec/import_spec.rb",
      "spec/importer_spec.rb",
@@ -97,27 +100,27 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
-      s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
-      s.add_runtime_dependency(%q<mash>, [">= 0.0.3"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.8"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_runtime_dependency(%q<mash>, [">= 0.1.1"])
       s.add_runtime_dependency(%q<version_string>, [">= 0.1.0"])
-      s.add_development_dependency(%q<jeweler>, [">= 1.2.1"])
-      s.add_development_dependency(%q<rspec>, [">= 1.2.8"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.4.0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
     else
-      s.add_dependency(%q<activesupport>, [">= 2.3.5"])
-      s.add_dependency(%q<httparty>, [">= 0.5.2"])
-      s.add_dependency(%q<mash>, [">= 0.0.3"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.8"])
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_dependency(%q<mash>, [">= 0.1.1"])
       s.add_dependency(%q<version_string>, [">= 0.1.0"])
-      s.add_dependency(%q<jeweler>, [">= 1.2.1"])
-      s.add_dependency(%q<rspec>, [">= 1.2.8"])
+      s.add_dependency(%q<jeweler>, [">= 1.4.0"])
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
     end
   else
-    s.add_dependency(%q<activesupport>, [">= 2.3.5"])
-    s.add_dependency(%q<httparty>, [">= 0.5.2"])
-    s.add_dependency(%q<mash>, [">= 0.0.3"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.8"])
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
+    s.add_dependency(%q<mash>, [">= 0.1.1"])
     s.add_dependency(%q<version_string>, [">= 0.1.0"])
-    s.add_dependency(%q<jeweler>, [">= 1.2.1"])
-    s.add_dependency(%q<rspec>, [">= 1.2.8"])
+    s.add_dependency(%q<jeweler>, [">= 1.4.0"])
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
   end
 end
 

data/lib/base.rb

@@ -18,7 +18,7 @@ module DataCatalog
     end
 
     # == protected
-    
+
     def self.check_status(response)
       case response.code
       when 400 then error(BadRequest,          response)
@@ -30,7 +30,7 @@ module DataCatalog
       end
       response
     end
-    
+
     def self.cursor(uri, query_hash)
       Cursor.new({
         :klass      => self,
@@ -39,7 +39,7 @@ module DataCatalog
         :uri        => uri,
       })
     end
-    
+
     def self.error(exception_class, response)
       e = exception_class.new
       e.response_body = response.body
@@ -56,7 +56,7 @@ module DataCatalog
       end
       raise e
     end
-    
+
     def self._first(response)
       item = response['members'][0]
       item.blank? ? nil : new(item)
@@ -69,11 +69,11 @@ module DataCatalog
       end
       response.blank? ? nil : new(response)
     end
-    
+
     def self.query_hash(conditions)
       conditions == {} ? {} : { :filter => filterize(conditions) }
     end
-    
+
     def self.filterize(arg)
       if arg.is_a?(Hash)
         filterize_hash(arg)
@@ -83,7 +83,7 @@ module DataCatalog
         raise ArgumentError
       end
     end
-    
+
     def self.filterize_hash(conditions)
       filtered_conditions = conditions.map do |k, v|
         "#{k}" + if v.is_a?(Regexp)
@@ -98,7 +98,7 @@ module DataCatalog
       end
       filtered_conditions.join(" and ")
     end
-    
+
     def method_missing(method_name, *args)
       if method_name.to_s.match(/.*_(on|at)\z/)
         return Time.parse(super)

data/lib/cursor.rb

@@ -1,13 +1,13 @@
 module DataCatalog
 
   class Cursor
-    
+
     attr_reader :document_count
     attr_reader :page_count
     attr_reader :page_size
-    
+
     include Enumerable
-    
+
     def initialize(options)
       @klass      = options[:klass]
       @query_hash = options[:query_hash]
@@ -19,7 +19,7 @@ module DataCatalog
       @members        = members(@response)
       @page_count     = @response['page_count']
     end
-    
+
     def [](i)
       member_at(i)
     end
@@ -27,11 +27,15 @@ module DataCatalog
     def each
       @document_count.times { |i| yield member_at(i) }
     end
-    
+
+    def empty?
+      @document_count == 0
+    end
+
     def first
       member_at(0)
     end
-    
+
     def last
       member_at(@document_count - 1)
     end
@@ -43,13 +47,13 @@ module DataCatalog
     def page(page_number)
       page_indices(page_number).map { |i| member_at(i) }
     end
-    
+
     def size
       @members.size
     end
-    
+
     protected
-    
+
     def fetch_members_near_index(index)
       page_number = page_for_index(index)
       response = response_for_page(page_number)
@@ -60,7 +64,7 @@ module DataCatalog
       end
       fetched.length
     end
-    
+
     def member_at(index)
       if index < 0
         raise "index (#{index}) must be >= 0"
@@ -77,7 +81,7 @@ module DataCatalog
     def members(response)
       response['members'].map { |x| @klass.new(x) }
     end
-    
+
     def page_for_index(index)
       (index / @page_size) + 1
     end
@@ -94,5 +98,5 @@ module DataCatalog
     end
 
   end
-  
+
 end

data/lib/main.rb

@@ -1,7 +1,7 @@
 module DataCatalog
-  
+
   # == Exceptions
-  
+
   class Error < RuntimeError
     attr_accessor :response_body        # String
     attr_accessor :parsed_response_body # Hash
@@ -16,26 +16,26 @@ module DataCatalog
   class InternalServerError       < Error; end # 500
   class ApiKeyNotConfigured       < Error; end
   class CannotDeletePrimaryApiKey < Error; end
-  
+
   # == Accessors
-  
+
   def self.api_key
     Connection.default_params[:api_key]
   end
-  
+
   def self.api_key=(key)
     Connection.default_params[:api_key] = key
   end
-  
+
   def self.base_uri
     Connection.base_uri
   end
-  
+
   def self.base_uri=(uri)
     u = uri.blank? ? Connection::DEFAULT_BASE_URI : uri
     Connection.base_uri(u)
   end
-  
+
   def self.with_key(temp_key)
     original_key = DataCatalog.api_key
     DataCatalog.api_key = temp_key

data/lib/resources/about.rb

@@ -3,17 +3,17 @@ require 'version_string'
 module DataCatalog
 
   class About < Base
-    
+
     def self.get()
       one(http_get("/"))
     end
-    
+
     def self.version_at_least?(minimum)
       actual = VersionString.new(get.version)
       floor = VersionString.new(minimum)
       actual >= floor
     end
-    
+
   end
-  
+
 end

data/lib/resources/api_key.rb

@@ -1,7 +1,7 @@
 module DataCatalog
 
   class ApiKey < Base
-    
+
     def self.all(user_id, conditions={})
       cursor(uri(user_id), query_hash(conditions))
     end
@@ -21,18 +21,18 @@ module DataCatalog
     def self.get(user_id, id)
       one(http_get(uri(user_id, id)))
     end
-    
+
     def self.update(user_id, id, params={})
       one(http_put(uri(user_id, id), :body => params))
     end
-    
+
     # == Helpers
-    
+
     def self.uri(user_id, id=nil)
       raise Error, "user_id cannot be blank" if user_id.blank?
       "/users/#{user_id}/keys/#{id}"
     end
-    
+
   end
 
 end

data/lib/resources/broken_link.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+
+  class BrokenLink < Base
+
+    def self.all(conditions={})
+      cursor(uri, query_hash(conditions))
+    end
+
+    def self.create(params={})
+      one(http_post(uri, :body => params))
+    end
+
+    def self.destroy(id)
+      one(http_delete(uri(id)))
+    end
+
+    def self.get(id)
+      one(http_get(uri(id)))
+    end
+
+    def self.update(id, params={})
+      one(http_put(uri(id), :body => params))
+    end
+
+    # == Helpers
+
+    def self.uri(id=nil)
+      "/broken_links/#{id}"
+    end
+
+  end
+
+end

data/lib/resources/comment.rb

@@ -1,7 +1,7 @@
 module DataCatalog
 
   class Comment < Base
-    
+
     def self.all(conditions={})
       cursor(uri, query_hash(conditions))
     end
@@ -13,17 +13,17 @@ module DataCatalog
     def self.destroy(id)
       one(http_delete(uri(id)))
     end
-    
+
     def self.get(id)
       one(http_get(uri(id)))
     end
-    
+
     def self.update(id, params={})
       one(http_put(uri(id), :body => params))
     end
 
     # == Helpers
-    
+
     def self.uri(id=nil)
       "/comments/#{id}"
     end

data/lib/resources/document.rb

@@ -1,7 +1,7 @@
 module DataCatalog
 
   class Document < Base
-    
+
     def self.all(conditions={})
       cursor(uri, query_hash(conditions))
     end
@@ -23,7 +23,7 @@ module DataCatalog
     end
 
     # == Helpers
-    
+
     def self.uri(id=nil)
       "/documents/#{id}"
     end