federal_register 0.3.0 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/federal_register.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{federal_register}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Carpenter"]
-  s.date = %q{2011-08-22}
+  s.date = %q{2011-10-29}
   s.description = %q{Ruby API Client for FederalRegister.gov that handles searching articles and getting information about agencies}
   s.email = %q{andrew@criticaljuncture.org}
   s.extra_rdoc_files = [
@@ -31,17 +31,19 @@ Gem::Specification.new do |s|
     "lib/federal_register/article.rb",
     "lib/federal_register/base.rb",
     "lib/federal_register/client.rb",
+    "lib/federal_register/public_inspection_document.rb",
     "lib/federal_register/result_set.rb",
     "spec/agency_spec.rb",
     "spec/article_spec.rb",
     "spec/base_spec.rb",
+    "spec/public_inspection_document_spec.rb",
     "spec/result_set_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/criticaljuncture/federal_register}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.7.2}
+  s.rubygems_version = %q{1.5.2}
   s.summary = %q{Ruby API Client for FederalRegister.gov}
 
   if s.respond_to? :specification_version then

data/lib/federal_register.rb

@@ -8,4 +8,5 @@ require "federal_register/client.rb"
 require "federal_register/base.rb"
 require "federal_register/result_set.rb"
 require "federal_register/agency.rb"
-require "federal_register/article.rb"
+require "federal_register/article.rb"
+require "federal_register/public_inspection_document.rb"

data/lib/federal_register/article.rb

@@ -7,6 +7,7 @@ class FederalRegister::Article < FederalRegister::Base
                 :cfr_references,
                 :dates,
                 :docket_id,
+                :docket_ids,
                 :document_number,
                 :end_page,
                 :full_text_xml_url,

data/lib/federal_register/base.rb

@@ -11,8 +11,17 @@ class FederalRegister::Base < FederalRegister::Client
     attributes.each do |attr|
       define_method attr do
         val = @attributes[attr.to_s]
-        if val && options[:type] == :date
-          val = Date.strptime(val.to_s)
+        if val
+          case options[:type]
+          when :date
+            if ! val.is_a?(Date)
+              val = Date.strptime(val.to_s)
+            end
+          when :datetime
+            if ! val.is_a?(DateTime)
+              val = DateTime.parse(val.to_s)
+            end
+          end
         end
 
         if ! val && ! full? && respond_to?(:json_url) && @attributes['json_url']

data/lib/federal_register/public_inspection_document.rb

@@ -0,0 +1,47 @@
+class FederalRegister::PublicInspectionDocument < FederalRegister::Base
+  add_attribute :agencies,
+                :docket_numbers,
+                :document_number,
+                :editorial_note,
+                :html_url,
+                :filing_type,
+                :pdf_url,
+                :pdf_file_size,
+                :num_pages,
+                :title,
+                :toc_subject,
+                :type
+
+  add_attribute :publication_date,
+                :type => :date
+  add_attribute :filed_at,
+                :pdf_update_at,
+                :type => :datetime
+  
+  def self.search(args)
+    FederalRegister::ResultSet.fetch("/public-inspection-documents.json", :query => args, :result_class => self)
+  end
+
+  def self.find(document_number)
+    attributes = get("/public-inspection-documents/#{document_number}.json")
+    new(attributes, :full => true)
+  end
+
+  def self.available_on(date)
+    FederalRegister::ResultSet.fetch("/public-inspection-documents.json", :query => {:conditions => {:available_on => date}}, :result_class => self)
+  end
+
+  def self.current
+    FederalRegister::ResultSet.fetch("/public-inspection-documents/current.json", :result_class => self)
+  end
+
+  def self.find_all(*document_numbers)
+    result_set = FederalRegister::ResultSet.fetch("/public-inspection-documents/#{document_numbers.join(',')}.json", :result_class => self)
+  end
+  
+  def agencies
+    attributes["agencies"].map do |attr|
+      FederalRegister::Agency.new(attr)
+    end
+  end
+end

data/spec/agency_spec.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/spec_helper'
 describe FederalRegister::Agency do
   describe ".all" do
     before(:each) do
-      FakeWeb.register_uri(:get, "http://www.federalregister.gov/api/v1/agencies.json", :body => [{},{}].to_json, :content_type =>"text/json")
+      FakeWeb.register_uri(:get, "http://api.federalregister.gov/v1/agencies.json", :body => [{},{}].to_json, :content_type =>"text/json")
     end
 
     it "returns Agency objects" do
@@ -21,7 +21,7 @@ describe FederalRegister::Agency do
 
   describe "attribute loading" do
     before(:each) do
-      @agency = FederalRegister::Agency.new({'name' => "Commerce Department", 'json_url' => "http://www.federalregister.gov/api/v1/agencies/1.json"})
+      @agency = FederalRegister::Agency.new({'name' => "Commerce Department", 'json_url' => "http://api.federalregister.gov/v1/agencies/1.json"})
     end
 
     describe "existing attribute" do
@@ -37,7 +37,7 @@ describe FederalRegister::Agency do
     end
 
     describe "missing attribute" do
-      FakeWeb.register_uri(:get, "http://www.federalregister.gov/api/v1/agencies/1.json", :body => {:description => "Lorem ipsum"}.to_json, :content_type =>"text/json")
+      FakeWeb.register_uri(:get, "http://api.federalregister.gov/v1/agencies/1.json", :body => {:description => "Lorem ipsum"}.to_json, :content_type =>"text/json")
       it "should lazy-load from the json_url" do
         @agency.send(:attributes)['description'].should be_nil
         @agency.description.should == "Lorem ipsum"

data/spec/article_spec.rb

@@ -6,7 +6,7 @@ describe FederalRegister::Article do
       document_number = "2010-213"
       FakeWeb.register_uri(
         :get,
-        "http://www.federalregister.gov/api/v1/articles/#{document_number}.json", 
+        "http://api.federalregister.gov/v1/articles/#{document_number}.json", 
         :content_type =>"text/json",
         :body => {:title => "Important Notice"}.to_json
       )
@@ -18,7 +18,7 @@ describe FederalRegister::Article do
       document_number = "some-random-document"
       FakeWeb.register_uri(
         :get,
-        "http://www.federalregister.gov/api/v1/articles/#{document_number}.json", 
+        "http://api.federalregister.gov/v1/articles/#{document_number}.json", 
         :content_type =>"text/json",
         :status => 404
       )
@@ -30,7 +30,7 @@ describe FederalRegister::Article do
     it "fetches multiple matching documents" do
       FakeWeb.register_uri(
         :get,
-        "http://www.federalregister.gov/api/v1/articles/abc,def.json", 
+        "http://api.federalregister.gov/v1/articles/abc,def.json", 
         :content_type =>"text/json",
         :body => {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json
       )
@@ -43,7 +43,7 @@ describe FederalRegister::Article do
     before(:each) do
       FakeWeb.register_uri(
         :get,
-        "http://www.federalregister.gov/api/v1/articles.json?conditions[term]=Fish", 
+        "http://api.federalregister.gov/v1/articles.json?conditions[term]=Fish", 
         :content_type =>"text/json",
         :body => {:count => 3}.to_json
       )
@@ -74,4 +74,18 @@ describe FederalRegister::Article do
       article.publication_date.should == Date.strptime("2011-07-22") 
     end
   end
+
+  describe "#docket_ids" do
+    it "returns an array" do
+      document_number = "2010-213"
+      FakeWeb.register_uri(
+        :get,
+        "http://api.federalregister.gov/v1/articles/#{document_number}.json", 
+        :content_type =>"text/json",
+        :body => {:title => "Important Notice", :docket_ids => ['ABC','123']}.to_json
+      )
+
+      FederalRegister::Article.find(document_number).docket_ids.should == ['ABC','123']
+    end
+  end
 end

data/spec/base_spec.rb

@@ -21,6 +21,90 @@ describe FederalRegister::Base do
       )
       instance.foo.should == 'bar'
     end
+
+    context "when attribute is of type date" do
+      before(:each) do
+        @klass = Class.new(FederalRegister::Base)
+        @klass.add_attribute(:panda, :type => :date)
+      end
+
+      context "when value is nil" do
+        it "should return nil" do
+          instance = @klass.new('panda' => nil)
+          instance.panda.should be_nil
+        end
+      end
+
+      context "when value is a Date" do
+        it "returns a date" do
+          date = Date.today
+          instance = @klass.new('panda' => Date.today)
+          instance.panda.should == Date.today
+        end
+      end
+
+      context "when value is not a date" do
+        context "when value is a valid date string" do
+          it "returns the date" do
+            date_string = Date.today.to_s
+            instance = @klass.new('panda' => date_string)
+            instance.panda.should == Date.strptime(date_string)
+          end
+        end
+
+        context "when value is not a valid date string" do
+          it "throws" do
+            date_string = "PANDA"
+            instance = @klass.new('panda' => date_string)
+            lambda {
+              instance.panda.should == "never going to get here"
+            }.should raise_error
+          end
+        end
+      end
+    end
+
+    context "when attribute is of type datetime" do
+      before(:each) do
+        @klass = Class.new(FederalRegister::Base)
+        @klass.add_attribute(:updated_at, :type => :datetime)
+      end
+
+      context "when value is nil" do
+        it "should return nil" do
+          instance = @klass.new('updated_at' => nil)
+          instance.updated_at.should be_nil
+        end
+      end
+
+      context "when value is a DateTime" do
+        it "returns a datetime" do
+          datetime = DateTime.current
+          instance = @klass.new('updated_at' => datetime)
+          instance.updated_at.should == datetime
+        end
+      end
+
+      context "when value is not a datetime" do
+        context "when value is a valid datetime string" do
+          it "returns the datetime" do
+            time_string = "2011-10-21T08:45:00-04:00" #"2011-09-29T08:45:00-04:00"
+            instance = @klass.new('updated_at' => time_string)
+            instance.updated_at.should == DateTime.parse(time_string)
+          end
+        end
+
+        context "when value is not a valid date string" do
+          it "throws" do
+            date_string = "foo"
+            instance = @klass.new(:updated_at => date_string)
+            lambda {
+              instance.updated_at.should == '?'
+            }.should raise_error
+          end
+        end
+      end
+    end
   end
 
   describe '.override_base_uri' do
@@ -33,5 +117,9 @@ describe FederalRegister::Base do
         klass.default_options[:base_uri].should == 'http://fr2.local/api/v1'
       end
     end
+
+    after(:all) do
+      FederalRegister::Base.override_base_uri('http://api.federalregister.gov/v1')
+    end
   end
 end

data/spec/public_inspection_document_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe FederalRegister::PublicInspectionDocument do
+  describe ".find" do
+    it "fetches the document by its document number" do
+      document_number = "2010-213"
+      FakeWeb.register_uri(
+        :get,
+        "http://api.federalregister.gov/v1/public-inspection-documents/#{document_number}.json", 
+        :content_type =>"text/json",
+        :body => {:title => "Important Notice"}.to_json
+      )
+
+      FederalRegister::PublicInspectionDocument.find(document_number).title.should == 'Important Notice'
+    end
+
+    it "throws an error when a document doesn't exist" do
+      document_number = "some-random-document"
+      FakeWeb.register_uri(
+        :get,
+        "http://api.federalregister.gov/v1/public-inspection-documents/#{document_number}.json", 
+        :content_type =>"text/json",
+        :status => 404
+      )
+      lambda{ FederalRegister::PublicInspectionDocument.find(document_number) }.should raise_error FederalRegister::Client::RecordNotFound
+    end
+  end
+
+  describe ".find_all" do
+    it "fetches multiple matching documents" do
+      FakeWeb.register_uri(
+        :get,
+        "http://api.federalregister.gov/v1/public-inspection-documents/abc,def.json", 
+        :content_type =>"text/json",
+        :body => {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json
+      )
+      result_set = FederalRegister::PublicInspectionDocument.find_all('abc','def')
+      result_set.results.map(&:document_number).sort.should === ['abc','def']
+    end
+  end
+
+  describe ".available_on" do
+    it "fetches the document on PI on a given date" do
+      FakeWeb.register_uri(
+        :get,
+        "http://api.federalregister.gov/v1/public-inspection-documents.json?conditions[available_on]=2011-10-15", 
+        :content_type =>"text/json",
+        :body => {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json
+      )
+      result_set = FederalRegister::PublicInspectionDocument.available_on(Date.parse('2011-10-15'))
+      result_set.results.map(&:document_number).sort.should === ['abc','def']
+    end
+  end
+
+  describe ".current" do
+    it "fetches the PI documents from the current issue" do
+      FakeWeb.register_uri(
+        :get,
+        "http://api.federalregister.gov/v1/public-inspection-documents/current.json", 
+        :content_type =>"text/json",
+        :body => {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json
+      )
+      result_set = FederalRegister::PublicInspectionDocument.current
+      result_set.results.map(&:document_number).sort.should === ['abc','def']
+    end
+  end
+
+end

data/spec/result_set_spec.rb

@@ -3,8 +3,8 @@ require File.dirname(__FILE__) + '/spec_helper'
 describe FederalRegister::ResultSet do
   describe "#next" do
     it "loads the next_page_url" do
-      FakeWeb.register_uri(:get, "http://www.federalregister.gov/api/v1/fishes?page=2", :body => {:count => 24}.to_json, :content_type =>"text/json")
-      FederalRegister::ResultSet.new({'next_page_url' => 'http://www.federalregister.gov/api/v1/fishes?page=2'}, FederalRegister::Article).next.count.should == 24
+      FakeWeb.register_uri(:get, "http://api.federalregister.gov/v1/fishes?page=2", :body => {:count => 24}.to_json, :content_type =>"text/json")
+      FederalRegister::ResultSet.new({'next_page_url' => 'http://api.federalregister.gov/v1/fishes?page=2'}, FederalRegister::Article).next.count.should == 24
     end
   end
 

metadata

@@ -1,124 +1,169 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: federal_register
-version: !ruby/object:Gem::Version
-  version: 0.3.0
+version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
-authors:
+authors: 
 - Andrew Carpenter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-22 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: &70199854862940 !ruby/object:Gem::Requirement
+
+date: 2011-10-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 7
+        - 0
         version: 0.7.0
-  type: :runtime
+  name: httparty
+  version_requirements: *id001
   prerelease: false
-  version_requirements: *70199854862940
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &70199854862460 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+- !ruby/object:Gem::Dependency 
   type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id002
   prerelease: false
-  version_requirements: *70199854862460
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &70199854861960 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-  type: :development
+  name: bundler
+  version_requirements: *id003
   prerelease: false
-  version_requirements: *70199854861960
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &70199854861480 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
         version: 1.6.0
-  type: :development
+  name: jeweler
+  version_requirements: *id004
   prerelease: false
-  version_requirements: *70199854861480
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &70199854861000 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+- !ruby/object:Gem::Dependency 
   type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id005
   prerelease: false
-  version_requirements: *70199854861000
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70199854860520 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
-  prerelease: false
-  version_requirements: *70199854860520
-- !ruby/object:Gem::Dependency
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
   name: rspec
-  requirement: &70199854860040 !ruby/object:Gem::Requirement
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  name: rspec
+  version_requirements: *id007
   prerelease: false
-  version_requirements: *70199854860040
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &70199854859540 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  name: activesupport
+  version_requirements: *id008
   prerelease: false
-  version_requirements: *70199854859540
-- !ruby/object:Gem::Dependency
-  name: fakeweb
-  requirement: &70199854859020 !ruby/object:Gem::Requirement
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
         version: 1.3.0
-  type: :development
+  name: fakeweb
+  version_requirements: *id009
   prerelease: false
-  version_requirements: *70199854859020
-description: Ruby API Client for FederalRegister.gov that handles searching articles
-  and getting information about agencies
+description: Ruby API Client for FederalRegister.gov that handles searching articles and getting information about agencies
 email: andrew@criticaljuncture.org
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
-files:
+files: 
 - .document
 - .watchr
 - Gemfile
@@ -133,38 +178,47 @@ files:
 - lib/federal_register/article.rb
 - lib/federal_register/base.rb
 - lib/federal_register/client.rb
+- lib/federal_register/public_inspection_document.rb
 - lib/federal_register/result_set.rb
 - spec/agency_spec.rb
 - spec/article_spec.rb
 - spec/base_spec.rb
+- spec/public_inspection_document_spec.rb
 - spec/result_set_spec.rb
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: http://github.com/criticaljuncture/federal_register
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 4415661570330803763
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Ruby API Client for FederalRegister.gov
 test_files: []
+