federal_register 0.5.1 → 0.6.0

data/lib/federal_register/client.rb

@@ -1,6 +1,6 @@
 class FederalRegister::Client
   include HTTParty
-  
+
   class ResponseError < HTTParty::ResponseError
     def message
       response.body
@@ -16,10 +16,10 @@ class FederalRegister::Client
   class ServerError < ResponseError; end
   
   base_uri 'https://www.federalregister.gov/api/v1'
-  
+
   def self.get(url, *options)
     response = super
-    
+
     case response.code
     when 200
       response

data/lib/federal_register/document.rb

@@ -0,0 +1,113 @@
+class FederalRegister::Document < FederalRegister::Base
+  extend FederalRegister::Utilities
+
+  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,
+                :images,
+                :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,
+                :significant,
+                :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("/documents.json", :query => args, :result_class => self)
+  end
+
+  def self.search_metadata(args)
+    FederalRegister::ResultSet.fetch("/documents.json", :query => args.merge(:metadata_only => '1'), :result_class => self)
+  end
+
+  def self.find(document_number, options={})
+    if options[:fields].present?
+      attributes = get("/documents/#{document_number}.json", :query => {:fields => options[:fields]})
+      new(attributes)
+    else
+      attributes = get("/documents/#{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
+
+    #TODO: fix this gross hack to ensure that find_all with a single document number
+    # is returned in the same way multiple document numbers are
+    if document_numbers.size == 1
+      document_numbers << " "
+    end
+
+    result_set = FederalRegister::ResultSet.fetch("/documents/#{document_numbers.join(',').strip}.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
+
+  def images
+    if attributes["images"]
+      attributes["images"].map do |attributes|
+        FederalRegister::DocumentImage.new(attributes)
+      end
+    else
+      []
+    end
+  end
+end

data/lib/federal_register/document_image.rb

@@ -0,0 +1,17 @@
+class FederalRegister::DocumentImage < FederalRegister::Document
+  def identifier
+    attributes[0]
+  end
+
+  def sizes
+    attributes[1].keys
+  end
+
+  def url_for(size)
+    attributes[1][size]
+  end
+
+  def default_url
+    sizes.include?('original_png') ? url_for('original_png') : url_for('original')
+  end
+end

data/lib/federal_register/facet.rb

@@ -0,0 +1,21 @@
+class FederalRegister::Facet < FederalRegister::Base
+  extend FederalRegister::Utilities
+
+  attr_reader :result_set
+
+  add_attribute :count,
+    :name,
+    :slug
+
+  def self.search(args={})
+    FederalRegister::FacetResultSet.fetch(
+      url, :query => args, :result_class => self
+    )
+  end
+
+  def initialize(attributes={}, options={})
+    @result_set = options.delete(:result_set)
+
+    super(attributes, options)
+  end
+end

data/lib/federal_register/facet/agency.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Agency < FederalRegister::Facet
+  def self.url
+    '/documents/facets/agency'
+  end
+end

data/lib/federal_register/facet/document.rb

@@ -0,0 +1,2 @@
+class FederalRegister::Facet::Document < FederalRegister::Facet
+end

data/lib/federal_register/facet/document/agency.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Document::Agency < FederalRegister::Facet::Document
+  def self.url
+    '/documents/facets/agency'
+  end
+end

data/lib/federal_register/facet/document/daily.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Document::Daily < FederalRegister::Facet::Document::Frequency
+  def self.url
+    '/documents/facets/daily'
+  end
+end

data/lib/federal_register/facet/document/frequency.rb

@@ -0,0 +1,12 @@
+class FederalRegister::Facet::Document::Frequency < FederalRegister::Facet::Document
+  def self.chart_url(args={})
+    uri = [base_uri, url, '.png']
+
+    if args.present?
+      uri << '?'
+      uri << HTTParty::HashConversions.to_params(args)
+    end
+
+    uri.join('')
+  end
+end

data/lib/federal_register/facet/document/monthly.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Document::Monthly < FederalRegister::Facet::Document::Frequency
+  def self.url
+    '/documents/facets/monthly'
+  end
+end

data/lib/federal_register/facet/document/quarterly.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Document::Quarterly < FederalRegister::Facet::Document::Frequency
+  def self.url
+    '/documents/facets/quarterly'
+  end
+end

data/lib/federal_register/facet/document/section.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Document::Section < FederalRegister::Facet::Document
+  def self.url
+    '/documents/facets/section'
+  end
+end

data/lib/federal_register/facet/document/topic.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Document::Topic < FederalRegister::Facet::Document
+  def self.url
+    '/documents/facets/topic'
+  end
+end

data/lib/federal_register/facet/document/type.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Document::Type < FederalRegister::Facet::Document
+  def self.url
+    '/documents/facets/type'
+  end
+end

data/lib/federal_register/facet/document/weekly.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Document::Weekly < FederalRegister::Facet::Document::Frequency
+  def self.url
+    '/documents/facets/weekly'
+  end
+end

data/lib/federal_register/facet/document/yearly.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Document::Yearly < FederalRegister::Facet::Document::Frequency
+  def self.url
+    '/documents/facets/yearly'
+  end
+end

data/lib/federal_register/facet/presidential_document_type.rb

@@ -0,0 +1,6 @@
+class FederalRegister::Facet::PresidentialDocumentType < FederalRegister::Facet
+  def self.url
+    '/documents/facets/subtype'
+  end
+end
+

data/lib/federal_register/facet/public_inspection_document.rb

@@ -0,0 +1,2 @@
+class FederalRegister::Facet::PublicInspectionDocument < FederalRegister::Facet
+end

data/lib/federal_register/facet/public_inspection_document/agencies.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::PublicInspectionDocument::Agencies < FederalRegister::Facet::PublicInspectionDocument
+  def self.url
+    '/public-inspection-documents/facets/agencies'
+  end
+end

data/lib/federal_register/facet/public_inspection_document/agency.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::PublicInspectionDocument::Agency < FederalRegister::Facet::PublicInspectionDocument
+  def self.url
+    '/public-inspection-documents/facets/agency'
+  end
+end

data/lib/federal_register/facet/public_inspection_document/type.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::PublicInspectionDocument::Type < FederalRegister::Facet::PublicInspectionDocument
+  def self.url
+    '/public-inspection-documents/facets/type'
+  end
+end

data/lib/federal_register/facet/public_inspection_issue.rb

@@ -0,0 +1,36 @@
+class FederalRegister::Facet::PublicInspectionIssue < FederalRegister::Base
+  add_attribute :slug
+  attr_reader :conditions
+
+  def initialize(attributes, options = {})
+    @conditions = options[:query] || {}
+    super
+  end
+
+  def special_filings
+    @special_filings ||= filing_class.new(
+      attributes['special_filings'],
+      conditions.deep_merge({
+        conditions: {special_filing: 1}
+      })
+    )
+  end
+
+  def regular_filings
+    @regular_filings ||= filing_class.new(
+      attributes['regular_filings'],
+      conditions.deep_merge({
+        conditions: {special_filing: 0}
+      })
+    )
+  end
+
+  def self.search(args={})
+    response = get(url, query: args)
+
+    response.map do |slug, attributes|
+      attributes['slug'] = slug
+      new(attributes, query: args)
+    end
+  end
+end

data/lib/federal_register/facet/public_inspection_issue/daily.rb

@@ -0,0 +1,11 @@
+class FederalRegister::Facet::PublicInspectionIssue::Daily < FederalRegister::Facet::PublicInspectionIssue
+  def self.url
+    '/public-inspection-issues/facets/daily'
+  end
+
+  private
+
+  def filing_class
+    FederalRegister::Facet::PublicInspectionIssue::DailyFiling
+  end
+end

data/lib/federal_register/facet/public_inspection_issue/daily_filing.rb

@@ -0,0 +1,6 @@
+class FederalRegister::Facet::PublicInspectionIssue::DailyFiling < FederalRegister::Facet::PublicInspectionIssue
+  add_attribute :agencies, :documents
+
+  add_attribute :last_updated_at,
+                :type => :datetime
+end

data/lib/federal_register/facet/public_inspection_issue/type.rb

@@ -0,0 +1,11 @@
+class FederalRegister::Facet::PublicInspectionIssue::Type < FederalRegister::Facet::PublicInspectionIssue
+  def self.url
+    '/public-inspection-issues/facets/type'
+  end
+
+  private
+
+  def filing_class
+    FederalRegister::Facet::PublicInspectionIssue::TypeFiling
+  end
+end

data/lib/federal_register/facet/public_inspection_issue/type_filing.rb

@@ -0,0 +1,22 @@
+class FederalRegister::Facet::PublicInspectionIssue::TypeFiling < FederalRegister::Facet::PublicInspectionIssue
+  attr_reader :document_types, :search_conditions
+
+  def initialize(attributes, conditions, options={})
+    @search_conditions = conditions
+    @document_types = attributes.map{|k,v| DocumentTypeFacet.new(k, v, @search_conditions)}
+  end
+
+  private
+
+  class DocumentTypeFacet
+    attr_reader :count, :name, :search_conditions
+
+    def initialize(type, attributes, search_conditions)
+      @count = attributes['count']
+      @name = attributes['name']
+      @search_conditions = search_conditions.deep_merge({
+        conditions: {type: type}
+      })
+    end
+  end
+end

data/lib/federal_register/facet/topic.rb

@@ -0,0 +1,5 @@
+class FederalRegister::Facet::Topic < FederalRegister::Facet
+  def self.url
+    '/documents/facets/topic'
+  end
+end

data/lib/federal_register/facet_result_set.rb

@@ -0,0 +1,25 @@
+class FederalRegister::FacetResultSet < FederalRegister::Client
+  include Enumerable
+
+  attr_reader :conditions, :results
+
+  def initialize(attributes, result_class, options={})
+    @result_class = result_class
+    @conditions = options[:query] || {}
+
+    @results = (attributes || {}).map do |slug, attributes|
+      attributes["slug"] = slug
+      @result_class.new(attributes, options.merge(:result_set => self) )
+    end
+  end
+
+  def self.fetch(url, options = {})
+    result_class = options.delete(:result_class)
+    response = get(url, options)
+    new(response, result_class, options)
+  end
+
+  def each
+    @results.each {|result| yield result }
+  end
+end

data/lib/federal_register/highlighted_document.rb

@@ -0,0 +1,42 @@
+class FederalRegister::HighlightedDocument < FederalRegister::Base
+  class InvalidPhotoSize < StandardError; end
+
+  add_attribute :curated_abstract,
+                :curated_title,
+                :document_number,
+                :html_url,
+                :photo
+
+  VALID_PHOTO_SIZES = [
+    'full_size',
+    'homepage',
+    'large',
+    'medium',
+    'navigation',
+    'small'
+  ]
+
+  def photo_url(size)
+    unless VALID_PHOTO_SIZES.include?(size)
+      raise InvalidPhotoSize,
+        "valid photo sizes are #{VALID_PHOTO_SIZES.join(', ')}"
+    end
+
+    if attributes['photo']
+      attributes['photo']['urls'][size]
+    end
+  end
+
+  def photo_credit
+    @credit ||= PhotoCredit.new(attributes['photo']['credit']) if attributes['photo']
+  end
+
+  class PhotoCredit
+    attr_reader :name, :url
+
+    def initialize(attributes)
+      @name = attributes['name']
+      @url = attributes['url']
+    end
+  end
+end