federal_register 0.0.1 → 0.1.0

data/README.rdoc

@@ -8,6 +8,7 @@ For more information about the FederalRegister.gov API, see http://www.federalre
 
     FederalRegister::Article.find('2011-17721').title
     result_set = FederalRegister::Article.search(:conditions => {:term => "Accessibility"})
+    # or result_set = FederalRegister.find_all('2011-17721','2011-17722')
     result_set.count
     result_set.results.each do |article|
       puts "#{article.title} by #{article.agencies.map(&:name)}"

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.0

data/federal_register.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{federal_register}
-  s.version = "0.0.1"
+  s.version = "0.1.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-01}
+  s.date = %q{2011-08-15}
   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 = [
@@ -41,13 +41,14 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/criticaljuncture/federal_register}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Ruby API Client for FederalRegister.gov}
 
   if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httparty>, [">= 0.7.0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])

data/lib/federal_register/article.rb

@@ -33,6 +33,10 @@ class FederalRegister::Article < FederalRegister::Base
     attributes = get("/articles/#{document_number}.json")
     new(attributes, :full => true)
   end
+
+  def self.find_all(*document_numbers)
+    result_set = FederalRegister::ResultSet.fetch("/articles/#{document_numbers.join(',')}.json", :result_class => self)
+  end
   
   def agencies
     attributes["agencies"].map do |attr|
@@ -45,12 +49,4 @@ class FederalRegister::Article < FederalRegister::Base
       self.class.get(attributes["#{file_type}_url"]).body
     end
   end
-  
-  def full_text_xml
-    self.class.get(full_text_xml_url).body
-  end
-  
-  def full_text_xml
-    self.class.get(full_text_xml_url).body
-  end
-end
+end

data/lib/federal_register/result_set.rb

@@ -1,5 +1,5 @@
 class FederalRegister::ResultSet < FederalRegister::Client
-  attr_reader :count, :total_pages, :results
+  attr_reader :count, :total_pages, :results, :errors
   
   def initialize(attributes, result_class)
     @result_class = result_class
@@ -9,6 +9,7 @@ class FederalRegister::ResultSet < FederalRegister::Client
     
     @prev_url = attributes['previous_page_url']
     @next_url = attributes['next_page_url']
+    @errors   = attributes['errors']
   end
   
   def next
@@ -24,4 +25,4 @@ class FederalRegister::ResultSet < FederalRegister::Client
     response = get(url, options)
     new(response, result_class)
   end
-end
+end

data/spec/agency_spec.rb

@@ -5,37 +5,37 @@ describe FederalRegister::Agency do
     before(:each) do
       FakeWeb.register_uri(:get, "http://www.federalregister.gov/api/v1/agencies.json", :body => [{},{}].to_json, :content_type =>"text/json")
     end
-    
+
     it "returns Agency objects" do
       agencies = FederalRegister::Agency.all
       agencies.each do |agency|
         agency.should be_an_instance_of(FederalRegister::Agency)
       end
     end
-    
+
     it "returns multiple agencies" do
       agencies = FederalRegister::Agency.all
       agencies.count.should == 2
     end
   end
-  
+
   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"})
     end
-    
+
     describe "existing attribute" do
       it "reads the from the json hash if already there" do
         @agency.name.should == 'Commerce Department'
       end
     end
-  
+
     describe "non-existent attributes" do
       it "should trigger an error" do
         lambda {@agency.non_existent_attribute}.should raise_error NoMethodError
       end
     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")
       it "should lazy-load from the json_url" do
@@ -44,7 +44,7 @@ describe FederalRegister::Agency do
         @agency.send(:attributes)['description'].should == "Lorem ipsum"
       end
     end
-    
+
     describe "missing attribute when no full json" do
       it "should lazy-load from the json_url" do
         @agency = FederalRegister::Agency.new({'name' => "Commerce Department"})
@@ -52,4 +52,4 @@ describe FederalRegister::Agency do
       end
     end
   end
-end
+end

data/spec/article_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe FederalRegister::Article do
   describe ".find" do
-    it "should fetch the document by its document number" do
+    it "fetches the document by its document number" do
       document_number = "2010-213"
       FakeWeb.register_uri(
         :get,
@@ -10,11 +10,11 @@ describe FederalRegister::Article do
         :content_type =>"text/json",
         :body => {:title => "Important Notice"}.to_json
       )
-      
+
       FederalRegister::Article.find(document_number).title.should == 'Important Notice'
     end
-    
-    it "should throw an error when a document doesn't exist" do
+
+    it "throws an error when a document doesn't exist" do
       document_number = "some-random-document"
       FakeWeb.register_uri(
         :get,
@@ -25,7 +25,20 @@ describe FederalRegister::Article do
       lambda{ FederalRegister::Article.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://www.federalregister.gov/api/v1/articles/abc,def.json", 
+        :content_type =>"text/json",
+        :body => {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json
+      )
+      result_set = FederalRegister::Article.find_all('abc','def')
+      result_set.results.map(&:document_number).sort.should === ['abc','def']
+    end
+  end
+
   describe ".search" do
     before(:each) do
       FakeWeb.register_uri(
@@ -35,8 +48,8 @@ describe FederalRegister::Article do
         :body => {:count => 3}.to_json
       )
     end
-    
-    it "should return a resultset object" do
+
+    it "returns a resultset object" do
       FederalRegister::Article.search(:conditions => {:term => "Fish"}).should be_an_instance_of(FederalRegister::ResultSet)
     end
   end

data/spec/result_set_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe FederalRegister::ResultSet do
   describe "#next" do
-    it "should load the next_page_url" 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
     end

data/spec/spec_helper.rb

@@ -13,5 +13,5 @@ FakeWeb.allow_net_connect = false
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 # RSpec.configure do |config|
-#   
+#
 # end

metadata

@@ -1,125 +1,150 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: federal_register
-version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
-authors:
+authors: 
 - Andrew Carpenter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-01 00:00:00.000000000 %:z
+
+date: 2011-08-15 00:00:00 -07:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
   name: httparty
-  requirement: &2156251100 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 0
         version: 0.7.0
-  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2156251100
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &2156250540 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+  name: shoulda
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2156250540
-- !ruby/object:Gem::Dependency
+  type: :development
   name: bundler
-  requirement: &2156250000 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2156250000
-- !ruby/object:Gem::Dependency
+  type: :development
   name: jeweler
-  requirement: &2156249380 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 0
         version: 1.6.0
-  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2156249380
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &2156248820 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :development
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2156248820
-- !ruby/object:Gem::Dependency
+  type: :development
   name: rspec
-  requirement: &2156246240 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2156246240
-- !ruby/object:Gem::Dependency
+  type: :development
   name: rspec
-  requirement: &2156245560 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2156245560
-- !ruby/object:Gem::Dependency
+  type: :development
   name: activesupport
-  requirement: &2156243940 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        version: "3"
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: *2156243940
-- !ruby/object:Gem::Dependency
+  type: :development
   name: fakeweb
-  requirement: &2156243060 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
         version: 1.3.0
-  type: :development
-  prerelease: false
-  version_requirements: *2156243060
-description: Ruby API Client for FederalRegister.gov that handles searching articles
-  and getting information about agencies
+  requirement: *id009
+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
 - Gemfile
 - Gemfile.lock
@@ -142,31 +167,33 @@ files:
 - test/test_federal_register.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
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
       - 0
-      hash: 4374774013964272713
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby API Client for FederalRegister.gov
 test_files: []
+