datacatalog 0.1.0 → 0.2.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: datacatalog
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors: 
 - Luigi Montanez
@@ -10,9 +10,49 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-05 00:00:00 -04:00
+date: 2009-10-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mash
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   type: :development
@@ -21,7 +61,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.2.8
     version: 
 description: Ruby library that wraps the National Data Catalog API
 email: luigi@sunlightfoundation.com
@@ -40,17 +80,18 @@ files:
 - Rakefile
 - VERSION
 - datacatalog.gemspec
-- doc/api_key_spec_for_rest_api.txt
-- doc/api_key_spec_for_ruby_api.rb
-- doc/mocking_options.md
+- lib/base.rb
 - lib/datacatalog.rb
-- lib/datacatalog/api_key.rb
-- lib/datacatalog/base.rb
-- lib/datacatalog/source.rb
-- lib/datacatalog/user.rb
+- lib/main.rb
+- lib/resources/about.rb
+- lib/resources/api_key.rb
+- lib/resources/source.rb
+- lib/resources/user.rb
 - sandbox_api.yml.example
+- spec/about_spec.rb
 - spec/api_key_spec.rb
 - spec/base_spec.rb
+- spec/datacatalog_spec.rb
 - spec/source_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -78,14 +119,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: datacatalog
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Wrapper for the National Data Catalog API
 test_files: 
+- spec/about_spec.rb
 - spec/api_key_spec.rb
 - spec/base_spec.rb
+- spec/datacatalog_spec.rb
 - spec/source_spec.rb
 - spec/spec_helper.rb
 - spec/user_spec.rb

data/doc/api_key_spec_for_rest_api.txt

@@ -1,54 +0,0 @@
-A user has a built-in, primary API key.
-A user also has secondary API keys.
-
-API keys fall into these categories:
-1. "primary" API key
-   - created and controlled by system
-   - cannot be deleted by users
-   - used by the Data Catalog Web Application
-   - can be rekeyed by user
-2. application keys
-   - created and controlled by users
-   - can be rekeyed by user
-   - do not provide user-specific credentials:
-     - favorites
-     - comments
-3. valet keys
-   - created and controlled by users
-   - can be rekeyed by user
-   - provide user-specific credentials
-     - favorites
-     - comments
-
-GET /users/1/api_keys
-# get all API keys
-:type => :primary
-:type => :application
-:type => :valet
-
-GET /users/1/api_keys?type=primary
-# just returns the primary key
-
-GET /users/1/api_keys?type=application
-# returns an array of application keys. [] if none.
-
-GET /users/1/api_keys?type=valet
-# returns an array of the valet keys. [] if none.
-
-POST /users/1/api_keys
-# create a new API key
-
-PUT /users/1/api_keys/12345
-# update an existing API key
-
-PUT /users/1/api_keys/12345?regenerate_api_key=true
-# rekey an API key
-
-DELETE /users/1/api_keys/12345
-# delete an existing API key
-# return 403 Forbidden if attempting to delete a primary key
-
-# -----
-
-POST /users
-A a primary key API should be generated automatically.

data/doc/api_key_spec_for_ruby_api.rb

@@ -1,26 +0,0 @@
-# I want to get a user's primary API key
-user = DataCatalog::User.find(user_id)
-user.primary_api_key
-user.application_api_keys
-user.valet_api_keys
-
-# I want to generate a new API key for a user
-user.generate_api_key!(:type => "application", :purpose => "To be awesome.") # sets user to the updated object
-
-# I want to update an API key
-user.update_api_key!("173f938237a93e9393b365c3", 
-                    :type => "application", 
-                    :purpose => "To be more awesome.") # sets user to the updated object
-
-# I want to delete an API key of a user
-user.delete_api_key!("173f938237a93e9393b365c3") # returns: true / exception
-
-# I want to get all API keys of a single user
-user.api_keys # returns: array of keys
-
-# ^^^^^^^^^^^^ DONE ^^^^^^^^^^^^^^^
-
-# vvvvvvvvvv NOT DONE vvvvvvvvvvvvv 
-
-# Given an API key, I want to see what user it corresponds to, if any.
-DataCatalog::User.find_by_api_key("7a93e93b365ca93e9393b365c3") # returns: User object

data/doc/mocking_options.md

@@ -1,20 +0,0 @@
-# Ruby wrapper API mocking options
-
-## 1. Machinist 
-
-* Use Machinist as an object factory for HTTParty::Response and DataCatalog::* objects.
-* Big question: Can HTTParty::Response object methods be appropriately mocked out by Machinist?
-* Will need to keep objects in sync with the live API
-
-## 2. FakeWeb
-
-* Use FakeWeb to fake out the HTTP responses
-* Will need to know the details of the JSON bodies, but HTTParty wraps all that for us.
-* Will need to keep the JSON output (and headers + status codes) in sync with the live API
-
-## 3. Local Sandbox API
-
-* Use a locally running sandbox API that mocks out the real API
-* Each spec will need to build up needed objects in the API, then tear them down at the end.
-* Much slower than in-memory solutions above.
-* To keep in sync with live API, just need to refresh API codebase. 

data/lib/datacatalog/api_key.rb

@@ -1,7 +0,0 @@
-module DataCatalog
-
-  class ApiKey < DataCatalog::Base
-    
-  end # class ApiKey
-  
-end # module DataCatalog

data/lib/datacatalog/base.rb

@@ -1,68 +0,0 @@
-module DataCatalog
-
-  class Base < Mash
-  
-    include HTTParty
-    format :json
-    
-    def self.set_base_uri
-      default_options[:base_uri] = HTTParty.normalize_base_uri(DataCatalog.base_uri || 'api.nationaldatacatalog.com')
-    end
-    
-    def self.set_api_key
-      if DataCatalog.api_key.blank?
-        raise ApiKeyNotConfigured, "Use DataCatalog.api_key = '...'"
-      end
-      default_options[:default_params] = {} if default_options[:default_params].nil?
-      default_options[:default_params].merge!({ :api_key => DataCatalog.api_key })
-    end
-
-    def self.set_up!
-      set_base_uri
-      set_api_key
-    end
-
-    def self.check_status_code(response)
-      case response.code
-      when 400: raise BadRequest, error_message(response)
-      when 401: raise Unauthorized, error_message(response)
-      when 403: raise Forbidden, error_message(response)
-      when 404: raise NotFound, error_message(response)
-      when 409: raise Conflict, error_message(response)
-      when 500: raise InternalServerError, error_message(response)
-      end
-    end
-    
-    def self.error_message(response)
-      parsed_body = JSON.parse(response.body)
-      if parsed_body.empty?
-        "Response was empty"
-      elsif parsed_body["errors"]
-        parsed_body["errors"].inspect
-      else
-        response.body
-      end
-    rescue JSON::ParserError
-      "Unable to parse: #{response.body.inspect}"
-    end
-
-    def self.response_for
-      response = yield
-      check_status_code(response)
-      response
-    end
-
-    def self.build_object(response)
-      return nil if response.nil? || response.empty?
-      new(response)
-    end
-
-    def self.about
-      default_options[:default_params] = {}
-      set_base_uri
-      build_object(response_for { get('/') })
-    end
-
-  end # class Base
-
-end # module DataCatalog

data/lib/datacatalog/source.rb

@@ -1,30 +0,0 @@
-module DataCatalog
-
-  class Source < DataCatalog::Base
-    
-    def self.create(params={})
-      set_up!
-      build_object(response_for { post("/sources", :query => params) })
-    end
-    
-    def self.all
-      set_up!
-      response_for{ get("/sources") }.map do |source|
-        build_object(source)
-      end
-    end
-    
-    def self.update(source_id, params={})
-      set_up!
-      build_object(response_for { put("/sources/#{source_id}", :query => params) })
-    end
-  
-    def self.destroy(source_id)
-      set_up!
-      response = response_for { delete("/sources/#{source_id}") }
-      true
-    end
-    
-  end
-  
-end

data/lib/datacatalog/user.rb

@@ -1,94 +0,0 @@
-module DataCatalog
-
-  class User < DataCatalog::Base
-    
-    def self.all
-      set_up!
-      response_for{ get("/users") }.map do |user|
-        build_object(user)
-      end
-    end
-    
-    def self.find(id)
-      set_up!
-      user = build_object(response_for { get("/users/#{id}") })
-      user.api_keys = response_for { get("/users/#{id}/keys") }.map do |key|
-        DataCatalog::ApiKey.build_object(key)
-      end if user
-      user
-    end
-    
-    def self.find_by_api_key(api_key)
-      user = nil
-      DataCatalog.with_key(api_key) do
-        set_up!
-        checkup = build_object(response_for { get("/checkup") })
-        user = find(checkup.user_id)
-      end
-      user
-    end
-    
-    def self.create(params={})
-      set_up!
-      user = build_object(response_for { post("/users", :query => params) })
-      user.api_keys = response_for { get("/users/#{user.id}/keys") }.map do |key|
-        DataCatalog::ApiKey.build_object(key)
-      end if user
-      user
-    end
-
-    def self.update(user_id, params)
-      set_up!
-      build_object(response_for { put("/users/#{user_id}", :query => params) })
-    end
-    
-    def self.destroy(user_id)
-      set_up!
-      response = response_for { delete("/users/#{user_id}") }
-      true
-    end
-    
-    def generate_api_key!(params)
-      self.class.set_up!
-      
-      response = self.class.response_for do
-        self.class.post("/users/#{self.id}/keys", :query => params )
-      end
-      update_api_keys
-      true
-    end
-    
-    def delete_api_key!(api_key_id)
-      self.class.set_up!
-      
-      response = self.class.response_for do
-        self.class.delete("/users/#{self.id}/keys/#{api_key_id}")
-      end
-      update_api_keys
-      true
-    end
-    
-    def update_api_key!(api_key_id, params)
-      self.class.set_up!
-      
-      response = self.class.response_for do
-        self.class.put("/users/#{self.id}/keys/#{api_key_id}", :query => params)
-      end
-      update_api_keys
-      true
-    end
-    
-    private
-    
-    def update_api_keys
-      self.api_keys = self.class.response_for { self.class.get("/users/#{self.id}/keys") }.map do |key|
-        DataCatalog::ApiKey.build_object(key)
-      end
-      updated_user = DataCatalog::User.find(self.id)
-      self.application_api_keys = updated_user.application_api_keys
-      self.valet_api_keys = updated_user.valet_api_keys
-    end
-    
-  end # class User
-
-end # module DataCatalog