datacatalog 0.4.8 → 0.4.9

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "datacatalog"
-    gem.version = '0.4.8'
+    gem.version = '0.4.9'
     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}

data/datacatalog.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{datacatalog}
-  s.version = "0.4.8"
+  s.version = "0.4.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Luigi Montanez", "David James"]
-  s.date = %q{2009-12-15}
+  s.date = %q{2010-02-01}
   s.description = %q{A Ruby client library for the National Data Catalog API}
   s.email = %q{luigi@sunlightfoundation.com}
   s.extra_rdoc_files = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "Rakefile",
      "datacatalog.gemspec",
      "lib/base.rb",
+     "lib/connection.rb",
      "lib/cursor.rb",
      "lib/datacatalog.rb",
      "lib/main.rb",
@@ -35,6 +36,7 @@ Gem::Specification.new do |s|
      "lib/resources/note.rb",
      "lib/resources/organization.rb",
      "lib/resources/rating.rb",
+     "lib/resources/report.rb",
      "lib/resources/source.rb",
      "lib/resources/user.rb",
      "sandbox_api.yml.example",
@@ -49,6 +51,7 @@ Gem::Specification.new do |s|
      "spec/note_spec.rb",
      "spec/organization_spec.rb",
      "spec/rating_spec.rb",
+     "spec/report_spec.rb",
      "spec/setup_api.rb",
      "spec/source_spec.rb",
      "spec/spec.opts",
@@ -76,6 +79,7 @@ Gem::Specification.new do |s|
      "spec/note_spec.rb",
      "spec/organization_spec.rb",
      "spec/rating_spec.rb",
+     "spec/report_spec.rb",
      "spec/setup_api.rb",
      "spec/source_spec.rb",
      "spec/spec_helper.rb",

data/lib/base.rb

@@ -1,40 +1,20 @@
 module DataCatalog
 
   class Base < Mash
-    
-    DEFAULT_BASE_URI = 'http://api.nationaldatacatalog.com'
-
-    include HTTParty
-
-    format :json
-    base_uri DEFAULT_BASE_URI
-    
-    class << self
-      alias_method :_delete, :delete
-      alias_method :_get,    :get
-      alias_method :_post,   :post
-      alias_method :_put,    :put
-      
-      undef_method :delete
-      undef_method :get
-      undef_method :post
-      undef_method :put
-    end
-    
     def self.http_delete(path, options={})
-      check_status(_delete(path, options))
+      check_status(Connection.delete(path, options))
     end
-    
+
     def self.http_get(path, options={})
-      check_status(_get(path, options))
+      check_status(Connection.get(path, options))
     end
 
     def self.http_post(path, options={})
-      check_status(_post(path, options))
+      check_status(Connection.post(path, options))
     end
 
     def self.http_put(path, options={})
-      check_status(_put(path, options))
+      check_status(Connection.put(path, options))
     end
 
     # == protected

data/lib/connection.rb

@@ -0,0 +1,14 @@
+module DataCatalog
+
+  module Connection
+    extend self
+    include HTTParty
+
+    DEFAULT_BASE_URI = 'http://api.nationaldatacatalog.com'
+
+    format :json
+    base_uri DEFAULT_BASE_URI
+    default_params :api_key => DataCatalog.api_key
+  end
+
+end

data/lib/datacatalog.rb

@@ -5,6 +5,7 @@ require 'httparty'
 require 'mash'
 
 require File.dirname(__FILE__) + '/main'
+require File.dirname(__FILE__) + '/connection'
 require File.dirname(__FILE__) + '/base'
 require File.dirname(__FILE__) + '/cursor'
 Dir.glob(File.dirname(__FILE__) + '/resources/*.rb').each { |f| require f }

data/lib/main.rb

@@ -15,19 +15,20 @@ module DataCatalog
   # == Accessors
   
   def self.api_key
-    Base.default_params[:api_key]
+    Connection.default_params[:api_key]
   end
   
   def self.api_key=(key)
-    Base.default_params :api_key => key
+    Connection.default_params[:api_key] = key
   end
   
   def self.base_uri
-    Base.base_uri
+    Connection.base_uri
   end
   
   def self.base_uri=(uri)
-    Base.base_uri(uri.blank? ? Base::DEFAULT_BASE_URI : uri)
+    u = uri.blank? ? Connection::DEFAULT_BASE_URI : uri
+    Connection.base_uri(u)
   end
   
   def self.with_key(temp_key)

data/lib/resources/report.rb

@@ -0,0 +1,33 @@
+module DataCatalog
+
+  class Report < 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)
+      "/reports/#{id}"
+    end
+
+  end
+
+end

data/spec/base_spec.rb

@@ -17,7 +17,7 @@ describe Base do
     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'
+      DataCatalog.base_uri.should == 'http://api.nationaldatacatalog.com'
     end
   end
 

data/spec/report_spec.rb

@@ -0,0 +1,124 @@
+require File.dirname(__FILE__) + '/spec_helper'
+include DataCatalog
+
+describe Report do
+  
+  before do
+    setup_api
+    clean_slate
+    @john = User.create(
+      :name    => "John M. Porter",
+      :email   => "john.m.porter@email.com",
+      :curator => true
+    )
+  end
+  
+  describe ".create" do
+    it "should create a new report when valid params are passed in" do
+      DataCatalog.with_key(@john.primary_api_key) do
+        @report = Report.create(
+          :text   => "Report 1 by John",
+          :status => "new"
+        )
+      end
+      @report.should be_an_instance_of(Report)
+      refreshed_report = Report.get(@report.id)
+      refreshed_report.text.should == "Report 1 by John"
+      refreshed_report.status.should == "new"
+      refreshed_report.user_id.should == @john.id
+    end
+  end
+  
+  describe ".get" do
+    before do
+      DataCatalog.with_key(@john.primary_api_key) do
+        @report = Report.create(
+          :text   => "Report 1 by John",
+          :status => "new"
+        )
+      end
+    end
+  
+    it "should return a report" do
+      report = Report.get(@report.id)
+      report.should be_an_instance_of(Report)
+      report.text.should == "Report 1 by John"
+    end
+    
+    it "should raise NotFound if no report exists" do
+      executing do
+        Report.get(mangle(@report.id))
+      end.should raise_error(NotFound)
+    end
+  end
+  
+  describe ".all" do
+    before do
+      @jane = User.create(
+        :name    => "Jane M. Porter",
+        :email   => "jane@email.com",
+        :curator => true
+      )
+      DataCatalog.with_key(@jane.primary_api_key) do
+        Report.create(:text => "Report 1 by Jane", :status => "new")
+        Report.create(:text => "Report 2 by Jane", :status => "new")
+      end
+    end
+  
+    it "should return a set of all user's reports" do
+      reports = Report.all(:user_id => @jane.id)
+      reports.first.should be_an_instance_of(Report)
+      [1, 2].each_with_index do |n, i|
+        reports[i].text.should == "Report #{n} by Jane"
+      end
+    end
+  end
+  
+  describe ".update" do
+    before do
+      DataCatalog.with_key(@john.primary_api_key) do
+        @report = Report.create(
+          :text   => "Report 1 by John",
+          :status => "new"
+        )
+      end
+    end
+  
+    it "should update an existing report with valid params" do
+      DataCatalog.with_key(@john.primary_api_key) do
+        Report.update(@report.id, :status => "open")
+      end
+      refreshed_report = Report.get(@report.id)
+      refreshed_report.text.should == "Report 1 by John"
+      refreshed_report.status.should == "open"
+    end
+  end
+
+  describe ".destroy" do
+    before do
+      DataCatalog.with_key(@john.primary_api_key) do
+        @report = Report.create(
+          :text   => "Report 1 by John",
+          :status => "new"
+        )
+      end
+    end
+  
+    it "should destroy an existing report as an admin" do
+      Report.destroy(@report.id).should be_true
+    end
+    
+    it "should destroy an existing report as the user" do
+      DataCatalog.with_key(@john.primary_api_key) do
+        Report.destroy(@report.id).should be_true
+      end
+    end
+
+    it "should raise NotFound when attempting to destroy non-existing report" do
+      executing do
+        Report.destroy(mangle(@report.id))
+      end.should raise_error(NotFound)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: datacatalog
 version: !ruby/object:Gem::Version 
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors: 
 - Luigi Montanez
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-15 00:00:00 -05:00
+date: 2010-02-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,6 +89,7 @@ files:
 - Rakefile
 - datacatalog.gemspec
 - lib/base.rb
+- lib/connection.rb
 - lib/cursor.rb
 - lib/datacatalog.rb
 - lib/main.rb
@@ -101,6 +102,7 @@ files:
 - lib/resources/note.rb
 - lib/resources/organization.rb
 - lib/resources/rating.rb
+- lib/resources/report.rb
 - lib/resources/source.rb
 - lib/resources/user.rb
 - sandbox_api.yml.example
@@ -115,6 +117,7 @@ files:
 - spec/note_spec.rb
 - spec/organization_spec.rb
 - spec/rating_spec.rb
+- spec/report_spec.rb
 - spec/setup_api.rb
 - spec/source_spec.rb
 - spec/spec.opts
@@ -163,6 +166,7 @@ test_files:
 - spec/note_spec.rb
 - spec/organization_spec.rb
 - spec/rating_spec.rb
+- spec/report_spec.rb
 - spec/setup_api.rb
 - spec/source_spec.rb
 - spec/spec_helper.rb