federal_register 0.5.1 → 0.6.0

data/Rakefile

@@ -15,12 +15,12 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "federal_register"
-  gem.homepage = "http://github.com/criticaljuncture/federal_register"
+  gem.homepage = "http://github.com/usnationalarchives/federal_register"
   gem.license = "MIT"
   gem.summary = %Q{Ruby API Client for FederalRegister.gov}
-  gem.description = %Q{Ruby API Client for FederalRegister.gov that handles searching articles and getting information about agencies}
+  gem.description = %Q{Ruby API Client for FederalRegister.gov that handles searching documents and getting information about agencies}
   gem.email = "andrew@criticaljuncture.org"
-  gem.authors = ["Andrew Carpenter"]
+  gem.authors = ["Andrew Carpenter", "Bob Burbach"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
@@ -38,8 +38,8 @@ end
 
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/federal_register.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "federal_register"
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Andrew Carpenter"]
-  s.date = "2015-02-06"
-  s.description = "Ruby API Client for FederalRegister.gov that handles searching articles and getting information about agencies"
+  s.authors = ["Andrew Carpenter", "Bob Burbach"]
+  s.date = "2016-11-03"
+  s.description = "Ruby API Client for FederalRegister.gov that handles searching documents and getting information about agencies"
   s.email = "andrew@criticaljuncture.org"
   s.extra_rdoc_files = [
     "LICENSE.md",
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".rubocop.yml",
     ".watchr",
     "Gemfile",
     "Gemfile.lock",
@@ -31,20 +32,52 @@ Gem::Specification.new do |s|
     "lib/federal_register/article.rb",
     "lib/federal_register/base.rb",
     "lib/federal_register/client.rb",
+    "lib/federal_register/document.rb",
+    "lib/federal_register/document_image.rb",
+    "lib/federal_register/facet.rb",
+    "lib/federal_register/facet/agency.rb",
+    "lib/federal_register/facet/document.rb",
+    "lib/federal_register/facet/document/agency.rb",
+    "lib/federal_register/facet/document/daily.rb",
+    "lib/federal_register/facet/document/frequency.rb",
+    "lib/federal_register/facet/document/monthly.rb",
+    "lib/federal_register/facet/document/quarterly.rb",
+    "lib/federal_register/facet/document/section.rb",
+    "lib/federal_register/facet/document/topic.rb",
+    "lib/federal_register/facet/document/type.rb",
+    "lib/federal_register/facet/document/weekly.rb",
+    "lib/federal_register/facet/document/yearly.rb",
+    "lib/federal_register/facet/presidential_document_type.rb",
+    "lib/federal_register/facet/public_inspection_document.rb",
+    "lib/federal_register/facet/public_inspection_document/agencies.rb",
+    "lib/federal_register/facet/public_inspection_document/agency.rb",
+    "lib/federal_register/facet/public_inspection_document/type.rb",
+    "lib/federal_register/facet/public_inspection_issue.rb",
+    "lib/federal_register/facet/public_inspection_issue/daily.rb",
+    "lib/federal_register/facet/public_inspection_issue/daily_filing.rb",
+    "lib/federal_register/facet/public_inspection_issue/type.rb",
+    "lib/federal_register/facet/public_inspection_issue/type_filing.rb",
+    "lib/federal_register/facet/topic.rb",
+    "lib/federal_register/facet_result_set.rb",
+    "lib/federal_register/highlighted_document.rb",
     "lib/federal_register/public_inspection_document.rb",
+    "lib/federal_register/public_inspection_issue_result_set.rb",
     "lib/federal_register/result_set.rb",
+    "lib/federal_register/section.rb",
+    "lib/federal_register/suggested_search.rb",
+    "lib/federal_register/topic.rb",
     "lib/federal_register/utilities.rb",
     "spec/agency_spec.rb",
-    "spec/article_spec.rb",
     "spec/base_spec.rb",
+    "spec/document_spec.rb",
     "spec/public_inspection_document_spec.rb",
     "spec/result_set_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = "http://github.com/criticaljuncture/federal_register"
+  s.homepage = "http://github.com/usnationalarchives/federal_register"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
+  s.rubygems_version = "1.8.29"
   s.summary = "Ruby API Client for FederalRegister.gov"
 
   if s.respond_to? :specification_version then
@@ -53,34 +86,31 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= 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"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.6"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.6"])
       s.add_development_dependency(%q<activesupport>, ["~> 3"])
       s.add_development_dependency(%q<fakeweb>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<rubocop>, [">= 0"])
     else
       s.add_dependency(%q<httparty>, [">= 0.7.0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.6"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.6"])
       s.add_dependency(%q<activesupport>, ["~> 3"])
       s.add_dependency(%q<fakeweb>, ["~> 1.3.0"])
+      s.add_dependency(%q<rubocop>, [">= 0"])
     end
   else
     s.add_dependency(%q<httparty>, [">= 0.7.0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.6"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.6"])
     s.add_dependency(%q<activesupport>, ["~> 3"])
     s.add_dependency(%q<fakeweb>, ["~> 1.3.0"])
+    s.add_dependency(%q<rubocop>, [">= 0"])
   end
 end
 

data/lib/federal_register.rb

@@ -7,7 +7,48 @@ end
 require "federal_register/utilities.rb"
 require "federal_register/client.rb"
 require "federal_register/base.rb"
+
 require "federal_register/result_set.rb"
+require "federal_register/public_inspection_issue_result_set.rb"
+require "federal_register/facet_result_set.rb"
+
 require "federal_register/agency.rb"
+require "federal_register/document.rb"
 require "federal_register/article.rb"
+require "federal_register/document_image.rb"
+
+
+require "federal_register/facet.rb"
+require "federal_register/facet/agency.rb"
+require "federal_register/facet/presidential_document_type.rb"
+require "federal_register/facet/topic.rb"
+require "federal_register/facet/document.rb"
+
+require "federal_register/facet/document/frequency.rb"
+require "federal_register/facet/document/daily.rb"
+require "federal_register/facet/document/weekly.rb"
+require "federal_register/facet/document/monthly.rb"
+require "federal_register/facet/document/quarterly.rb"
+require "federal_register/facet/document/yearly.rb"
+
+require "federal_register/facet/document/agency.rb"
+require "federal_register/facet/document/section.rb"
+require "federal_register/facet/document/topic.rb"
+require "federal_register/facet/document/type.rb"
+
+require "federal_register/facet/public_inspection_document.rb"
+require "federal_register/facet/public_inspection_document/agencies.rb"
+require "federal_register/facet/public_inspection_document/agency.rb"
+require "federal_register/facet/public_inspection_document/type.rb"
+
+require "federal_register/facet/public_inspection_issue.rb"
+require "federal_register/facet/public_inspection_issue/daily.rb"
+require "federal_register/facet/public_inspection_issue/daily_filing.rb"
+require "federal_register/facet/public_inspection_issue/type.rb"
+require "federal_register/facet/public_inspection_issue/type_filing.rb"
+
+require "federal_register/highlighted_document.rb"
 require "federal_register/public_inspection_document.rb"
+require "federal_register/section.rb"
+require "federal_register/suggested_search.rb"
+require "federal_register/topic.rb"

data/lib/federal_register/agency.rb

@@ -1,26 +1,62 @@
 class FederalRegister::Agency < FederalRegister::Base
-  add_attribute :description,
+  add_attribute :agency_url,
+                :child_ids,
+                :description,
                 :json_url,
                 :logo,
                 :name,
+                :raw_name,
                 :recent_articles_url,
                 :short_name,
+                :slug,
                 :url
   add_attribute :id,
                 :parent_id,
                 :type => :integer
-  
-  def self.all
-    response = get('/agencies.json')
-    if response.success?
-      response.map do |hsh|
-        new(hsh, :full => true)
+
+  def self.all(options={})
+    get_options = {}
+    get_options.merge!(:query => {:fields => options[:fields]}) if options[:fields]
+
+    response = get('/agencies.json', get_options)
+
+    response.map do |hsh|
+      new(hsh, :full => true)
+    end
+  end
+
+  def self.find(id_or_slug, options={})
+    if options[:fields].present?
+      response = get("/agencies/#{id_or_slug}.json", :query => {:fields => options[:fields]})
+
+      if response.is_a?(Hash)
+        new(response)
+      else
+        response.map do |hsh|
+          new(hsh)
+        end
       end
     else
-      raise response.inspect
+      response = get("/agencies/#{id_or_slug}.json")
+
+      if response.is_a?(Hash)
+        new(response, :full => true)
+      else
+        response.map do |hsh|
+          new(hsh, :full => true)
+        end
+      end
+    end
+  end
+
+  def self.suggestions(args={})
+    response = get("/agencies/suggestions", query: args)
+
+    response.map do |hsh|
+      new(hsh, :full => true)
     end
   end
-  
+
   def logo_url(size)
     if attributes.has_key?("logo")
       attributes["logo"]["#{size}_url"] || raise("size '#{size}' not a valid image size")

data/lib/federal_register/article.rb

@@ -1,106 +1,2 @@
-class FederalRegister::Article < FederalRegister::Base
-  extend FederalRegister::Utilities
-  class InvalidDocumentNumber < ArgumentError; end
-
-  add_attribute :abstract,
-                :abstract_html_url,
-                :action,
-                :agencies,
-                :agency_names,
-                :body_html_url,
-                :cfr_references,
-                :citation,
-                :comment_url,
-                :corrections,
-                :correction_of,
-                :dates,
-                :docket_id,
-                :docket_ids,
-                :document_number,
-                :end_page,
-                :excerpts,
-                :executive_order_notes,
-                :executive_order_number,
-                :full_text_xml_url,
-                :html_url,
-                :json_url,
-                :mods_url,
-                :pdf_url,
-                :president,
-                :public_inspection_pdf_url,
-                :regulation_id_number_info,
-                :regulation_id_numbers,
-                :regulations_dot_gov_info,
-                :regulations_dot_gov_url,
-                :start_page,
-                :subtype,
-                :raw_text_url,
-                :title,
-                :toc_subject,
-                :toc_doc,
-                :type,
-                :volume
-
-  add_attribute :comments_close_on,
-                :effective_on,
-                :publication_date,
-                :signing_date,
-                :type => :date
- 
-  def self.search(args)
-    FederalRegister::ResultSet.fetch("/articles.json", :query => args, :result_class => self)
-  end
-
-  def self.search_metadata(args)
-    FederalRegister::ResultSet.fetch("/articles.json", :query => args.merge(:metadata_only => '1'), :result_class => self)
-  end
-  
-  def self.find(document_number, options={})
-    validate_document_number!(document_number)
-    if options[:fields].present?
-      attributes = get("/articles/#{document_number}.json", :query => {:fields => options[:fields]})
-      new(attributes)
-    else
-      attributes = get("/articles/#{document_number}.json")
-      new(attributes, :full => true)
-    end
-  end
-
-  def self.find_all(*args)
-    options, document_numbers = extract_options(args)
-
-    fetch_options = {:result_class => self}
-    fetch_options.merge!(:query => {:fields => options[:fields]}) if options[:fields]
-
-    document_numbers = document_numbers.flatten
-    document_numbers.each {|doc_num| validate_document_number!(doc_num)}
-
-    result_set = FederalRegister::ResultSet.fetch("/articles/#{document_numbers.join(',')}.json", fetch_options)
-  end
-  
-  def agencies
-    attributes["agencies"].map do |attr|
-      FederalRegister::Agency.new(attr)
-    end
-  end
-  
-  %w(full_text_xml abstract_html body_html raw_text mods).each do |file_type|
-    define_method file_type do
-      begin
-        self.class.get(send("#{file_type}_url")).body
-      rescue FederalRegister::Client::RecordNotFound
-        nil
-      rescue
-        raise send("#{file_type}_url").inspect
-       end
-    end
-  end
-
-  private
-
-  def self.validate_document_number!(document_number)
-    if document_number.blank? || document_number !~ /^[a-zA-Z0-9-]+$/
-      raise InvalidDocumentNumber.new("'#{document_number}' is not a valid FR Document Number")
-    end
-  end
-end
+# support old references
+FederalRegister::Article = FederalRegister::Document

data/lib/federal_register/base.rb

@@ -37,19 +37,68 @@ class FederalRegister::Base < FederalRegister::Client
     @attributes = attributes
     @full = options[:full] || false
   end
-  
+
   def full?
     @full
   end
-  
+
   def fetch_full
     @attributes = self.class.get(json_url)
     @full = true
     self
   end
 
+  # this has to be done because HTTParty uses a custom attr_inheritable
+  # which copies the setting for base uri into each class at inheritance
+  # time - which is before we can modify it in something like a Rails
+  # initializer
   def self.override_base_uri(uri)
-    [FederalRegister::Agency, FederalRegister::Article, FederalRegister::Base, FederalRegister::Client, FederalRegister:: ResultSet].each do |klass|
+    [
+      FederalRegister::Agency,
+      FederalRegister::Article,
+      FederalRegister::Base,
+      FederalRegister::Client,
+      FederalRegister::Document,
+      FederalRegister::DocumentImage,
+
+      FederalRegister::Facet,
+      FederalRegister::Facet::Agency,
+      FederalRegister::Facet::PresidentialDocumentType,
+      FederalRegister::Facet::Topic,
+
+      FederalRegister::Facet::Document::Frequency,
+      FederalRegister::Facet::Document::Daily,
+      FederalRegister::Facet::Document::Weekly,
+      FederalRegister::Facet::Document::Monthly,
+      FederalRegister::Facet::Document::Quarterly,
+      FederalRegister::Facet::Document::Yearly,
+
+      FederalRegister::Facet::Document::Agency,
+      FederalRegister::Facet::Document::Section,
+      FederalRegister::Facet::Document::Topic,
+      FederalRegister::Facet::Document::Type,
+
+      FederalRegister::Facet::PublicInspectionDocument,
+      FederalRegister::Facet::PublicInspectionDocument::Agencies,
+      FederalRegister::Facet::PublicInspectionDocument::Agency,
+      FederalRegister::Facet::PublicInspectionDocument::Type,
+
+      FederalRegister::Facet::PublicInspectionIssue,
+      FederalRegister::Facet::PublicInspectionIssue::Daily,
+      FederalRegister::Facet::PublicInspectionIssue::DailyFiling,
+      FederalRegister::Facet::PublicInspectionIssue::Type,
+      FederalRegister::Facet::PublicInspectionIssue::TypeFiling,
+
+      FederalRegister::HighlightedDocument,
+      FederalRegister::PublicInspectionDocument,
+      FederalRegister::Section,
+      FederalRegister::SuggestedSearch,
+      FederalRegister::Topic,
+
+      FederalRegister::ResultSet,
+      FederalRegister::PublicInspectionIssueResultSet,
+      FederalRegister::FacetResultSet,
+    ].each do |klass|
       klass.base_uri(uri)
     end
   end