federal_register 0.7.7 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29108ec013bfbdf370e3ac4b2c5f2de8312ee5ed0d42fa4314a4ec67349ddaa7
-  data.tar.gz: 81773b6cedce1060dd60b0bc811f81e47db875e9e2feb0eefd39b8ce707687ce
+  metadata.gz: 9fa85057a2a29eaca05e6e24cbab933a2cb5da88eaae7e9e2a2bb99d94aea521
+  data.tar.gz: aba8ed95d1962cd872556da2f51b2a9024f8c9b430223a2d46779690dd943269
 SHA512:
-  metadata.gz: cfaafa77066a18b25c3fb8168e677b9d5cf332da4cde50112a2e945adc8d0eedbaca0045d96617b20fc0e28eacbf5e3d26cf0425fc9629af1f257236aa260db2
-  data.tar.gz: 71f6cab320067badb01768221dec911e9bf57d777594a28b2f658489ac2bcf4e1162b74ceeb5dd3a549a116748d07a953903be776c20f9212342770672ca04b7
+  metadata.gz: 216eeb36c4e2f5e55ba14e83bc019d30b12e65551aad4b5b8a6064e7d3cc10ff06b481f403296cbdf9e1c0849edc56c98352f96af22b0b67b098e754a4438fc4
+  data.tar.gz: 01bc4a1455537a710ceb0572cda84b57c834574b3e1cc62e7b70785fa042729ac9b7a69b06801fdb7f4709ba43965ab7d01b01d84d5724124c5974ce2f137455

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     federal_register (0.7.7)
-      httparty (>= 0.14.0)
+      faraday (>= 1.8)
 
 GEM
   remote: https://rubygems.org/
@@ -10,27 +10,40 @@ GEM
     activesupport (3.2.22.5)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.3.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    coderay (1.1.3)
     concurrent-ruby (1.0.5)
+    crack (1.0.0)
+      bigdecimal
+      rexml
     diff-lcs (1.2.5)
     fakeweb (1.3.0)
-    httparty (0.18.1)
-      mime-types (~> 3.0)
-      multi_xml (>= 0.5.2)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.1.1)
     i18n (0.9.1)
       concurrent-ruby (~> 1.0)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.1104)
+    method_source (1.1.0)
     multi_json (1.12.2)
-    multi_xml (0.6.0)
     parallel (1.12.0)
     parser (2.4.0.2)
       ast (~> 2.3)
     powerpack (0.1.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.1.1)
     rainbow (2.2.2)
       rake
     rake (12.3.0)
+    rexml (3.3.8)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
       rspec-expectations (~> 2.99.0)
@@ -49,6 +62,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
+    ruby2_keywords (0.0.5)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (>= 1.4.1, < 3.0)
@@ -56,6 +70,10 @@ GEM
     shoulda-matchers (2.7.0)
       activesupport (>= 3.0.0)
     unicode-display_width (1.3.0)
+    webmock (3.24.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -65,10 +83,12 @@ DEPENDENCIES
   bundler
   fakeweb (~> 1.3.0)
   federal_register!
+  pry
   rspec (~> 2.6)
   rspec_junit_formatter
   rubocop
   shoulda
+  webmock
 
 BUNDLED WITH
-   2.1.4
+   2.3.6

data/VERSION

@@ -1 +1 @@
-0.7.7
+0.8.0

data/federal_register.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "federal_register"
-  s.version = "0.7.7"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Carpenter", "Bob Burbach"]
@@ -87,15 +87,17 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, [">= 0.14.0"])
+      s.add_runtime_dependency(%q<faraday>, [">= 1.8"])
 
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 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<webmock>, [">= 0"])
       s.add_development_dependency(%q<rubocop>, [">= 0"])
       s.add_development_dependency(%q<rspec_junit_formatter>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
     else
       s.add_dependency(%q<httparty>, [">= 0.7.0"])
       s.add_dependency(%q<shoulda>, [">= 0"])

data/lib/federal_register/agency.rb

@@ -18,7 +18,7 @@ class FederalRegister::Agency < FederalRegister::Base
     get_options = {}
     get_options.merge!(:query => {:fields => options[:fields]}) if options[:fields]
 
-    response = get('/agencies.json', get_options).parsed_response
+    response = get('agencies.json', get_options).parsed_response
 
     response.map do |hsh|
       new(hsh, :full => true)
@@ -29,7 +29,7 @@ class FederalRegister::Agency < FederalRegister::Base
     slug = URI.encode(id_or_slug.to_s)
 
     if options[:fields].present?
-      response = get("/agencies/#{slug}.json", :query => {:fields => options[:fields]}).parsed_response
+      response = get("agencies/#{slug}.json", :query => {:fields => options[:fields]}).parsed_response
 
       if response.is_a?(Hash)
         new(response)
@@ -39,7 +39,7 @@ class FederalRegister::Agency < FederalRegister::Base
         end
       end
     else
-      response = get("/agencies/#{slug}.json").parsed_response
+      response = get("agencies/#{slug}.json").parsed_response
 
       if response.is_a?(Hash)
         new(response, :full => true)
@@ -52,7 +52,7 @@ class FederalRegister::Agency < FederalRegister::Base
   end
 
   def self.suggestions(args={})
-    response = get("/agencies/suggestions", query: args).parsed_response
+    response = get("agencies/suggestions", query: args).parsed_response
 
     response.map do |hsh|
       new(hsh, :full => true)

data/lib/federal_register/base.rb

@@ -103,7 +103,13 @@ class FederalRegister::Base < FederalRegister::Client
       FederalRegister::PublicInspectionIssueResultSet,
       FederalRegister::FacetResultSet,
     ].each do |klass|
-      klass.base_uri(uri)
+
+      klass.class_eval do
+        define_singleton_method(:base_uri) do 
+          uri
+        end  
+      end
+
     end
   end
 

data/lib/federal_register/client.rb

@@ -1,7 +1,14 @@
 class FederalRegister::Client
-  include HTTParty
 
-  class ResponseError < HTTParty::ResponseError
+  class ResponseError < Faraday::Error
+
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+      super(message)
+    end
+
     def message
       response.body
     end
@@ -17,14 +24,26 @@ class FederalRegister::Client
   class ServerError < ResponseError; end
   class ServiceUnavailable < ResponseError; end
 
-  base_uri 'https://www.federalregister.gov/api/v1'
+  FaradayResponseWrapper = Struct.new(:parsed_response)
+
+  def self.base_uri
+    'https://www.federalregister.gov/api/v1'
+  end
+
+  def self.get(path, options={})
+    @connection = Faraday.new(url: base_uri) do |conn|
+      conn.request :url_encoded
+      conn.response :logger if ENV['DEBUG'] # Optional: Enable logging in debug mode
+      conn.adapter Faraday.default_adapter
+      conn.options.open_timeout = ENV['FARADAY_OPEN_TIMEOUT'].try(:to_i) || 2
+      conn.options.timeout = 10 
+    end
 
-  def self.get(url, *options)
-    response = super
+    response = @connection.get(strip_protocol_and_host(path), options[:query] || {})
 
-    case response.code
+    case response.status
     when 200
-      response
+      FaradayResponseWrapper.new(JSON.parse(response.body))
     when 400
       raise BadRequest.new(response)
     when 404
@@ -36,7 +55,19 @@ class FederalRegister::Client
     when 504
       raise GatewayTimeout.new(response)
     else
-      raise HTTParty::ResponseError.new(response)
+      raise Faraday::Error.new(nil, response)
+    end
+  end
+
+  def self.strip_protocol_and_host(path)
+    uri = URI.parse(path)
+    
+    path_without_protocol_and_host = uri.path
+    if uri.query
+      path_without_protocol_and_host << "?#{uri.query}"
     end
+
+    path_without_protocol_and_host
   end
+  private_class_method :strip_protocol_and_host
 end

data/lib/federal_register/document.rb

@@ -53,11 +53,11 @@ class FederalRegister::Document < FederalRegister::Base
                 :type => :date
 
   def self.search(args)
-    FederalRegister::ResultSet.fetch("/documents.json", :query => args, :result_class => self)
+    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)
+    FederalRegister::ResultSet.fetch("documents.json", :query => args.merge(:metadata_only => '1'), :result_class => self)
   end
 
   def self.find(document_number, options={})
@@ -65,7 +65,7 @@ class FederalRegister::Document < FederalRegister::Base
     
     if options[:publication_date].present?
       publication_date = options[:publication_date]
-      publication_date = publication_date.is_a?(Date) ? publication_date.to_s(:iso) : publication_date
+      publication_date = publication_date.is_a?(Date) ? publication_date.strftime("%Y-%m-%d") : publication_date
       
       query.merge!(:publication_date => publication_date)
     end
@@ -74,12 +74,12 @@ class FederalRegister::Document < FederalRegister::Base
       query.merge!(:fields => options[:fields])
     end
 
-    attributes = get("/documents/#{document_number}.json", :query => query).parsed_response
+    attributes = get("documents/#{document_number}.json", :query => query).parsed_response
     new(attributes, :full => true)
   end
 
   def self.find_all_base_path
-    '/documents'
+    'documents'
   end
 
   def agencies
@@ -90,13 +90,14 @@ class FederalRegister::Document < FederalRegister::Base
 
   %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
+      response = Faraday.get(send("#{file_type}_url"))
+      if response.success?
+        response.body
+      elsif response.status == 404
         nil
-      rescue
+      else
         raise send("#{file_type}_url").inspect
-       end
+      end
     end
   end
 

data/lib/federal_register/document_search_details.rb

@@ -5,7 +5,7 @@ class FederalRegister::DocumentSearchDetails < FederalRegister::Base
                 :suggestions
 
   def self.search(args)
-    response = get('/documents/search-details', query: args).parsed_response
+    response = get('documents/search-details', query: args).parsed_response
     new(response)
   end
 end

data/lib/federal_register/facet/agency.rb

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/federal_register/facet/presidential_document_type.rb

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

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

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

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

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

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

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

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

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

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

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

data/lib/federal_register/facet/topic.rb

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

data/lib/federal_register/public_inspection_document.rb

@@ -24,28 +24,28 @@ class FederalRegister::PublicInspectionDocument < FederalRegister::Base
                 :type => :datetime
 
   def self.search(args)
-    FederalRegister::ResultSet.fetch("/public-inspection-documents.json", :query => args, :result_class => self)
+    FederalRegister::ResultSet.fetch("public-inspection-documents.json", :query => args, :result_class => self)
   end
 
   def self.search_metadata(args)
-    FederalRegister::ResultSet.fetch("/public-inspection-documents.json", :query => args.merge(:metadata_only => '1'), :result_class => self)
+    FederalRegister::ResultSet.fetch("public-inspection-documents.json", :query => args.merge(:metadata_only => '1'), :result_class => self)
   end
 
   def self.find(document_number)
-    attributes = get("/public-inspection-documents/#{document_number}.json").parsed_response
+    attributes = get("public-inspection-documents/#{document_number}.json").parsed_response
     new(attributes, :full => true)
   end
 
   def self.available_on(date)
-    FederalRegister::PublicInspectionIssueResultSet.fetch("/public-inspection-documents.json", :query => {:conditions => {:available_on => date}}, :result_class => self)
+    FederalRegister::PublicInspectionIssueResultSet.fetch("public-inspection-documents.json", :query => {:conditions => {:available_on => date}}, :result_class => self)
   end
 
   def self.current
-    FederalRegister::PublicInspectionIssueResultSet.fetch("/public-inspection-documents/current.json", :result_class => self)
+    FederalRegister::PublicInspectionIssueResultSet.fetch("public-inspection-documents/current.json", :result_class => self)
   end
 
   def self.find_all_base_path
-    '/public-inspection-documents'
+    'public-inspection-documents'
   end
 
   def agencies

data/lib/federal_register/public_inspection_document_search_details.rb

@@ -5,7 +5,7 @@ class FederalRegister::PublicInspectionDocumentSearchDetails < FederalRegister::
                 :suggestions
 
   def self.search(args)
-    response = get('/public-inspection-documents/search-details', query: args).parsed_response
+    response = get('public-inspection-documents/search-details', query: args).parsed_response
     new(response)
   end
-end
+end

data/lib/federal_register/result_set.rb

@@ -1,11 +1,12 @@
 class FederalRegister::ResultSet < FederalRegister::Client
   include Enumerable
 
-  attr_reader :count, :total_pages, :results, :errors, :description
+  attr_reader :count, :total_pages, :results, :errors, :description, :is_neural
 
   def initialize(attributes, result_class)
     @result_class = result_class
     @count = attributes['count']
+    @is_neural = attributes['is_neural']
     @total_pages = attributes['total_pages']
     @results = (attributes['results'] || []).map{|result| @result_class.new(result) }
 

data/lib/federal_register/section.rb

@@ -2,7 +2,7 @@ class FederalRegister::Section < FederalRegister::Base
   add_attribute :name
 
   def self.search(args={})
-    response = get('/sections', query: args).parsed_response
+    response = get('sections', query: args).parsed_response
 
     responses = {}
     response.map do |section, attributes|

data/lib/federal_register/suggested_search.rb

@@ -9,7 +9,7 @@ class FederalRegister::SuggestedSearch < FederalRegister::Base
                 :title
 
   def self.search(args={})
-    response = get('/suggested_searches', query: args).parsed_response
+    response = get('suggested_searches', query: args).parsed_response
 
     responses = {}
     response.map do |section, searches|
@@ -20,7 +20,7 @@ class FederalRegister::SuggestedSearch < FederalRegister::Base
   end
 
   def self.find(slug)
-    response = get("/suggested_searches/#{URI.encode(slug.to_s)}").parsed_response
+    response = get("suggested_searches/#{URI.encode(slug.to_s)}").parsed_response
     new(response)
   end
 end

data/lib/federal_register/topic.rb

@@ -4,7 +4,7 @@ class FederalRegister::Topic < FederalRegister::Base
                 :url
 
   def self.suggestions(args={})
-    response = get("/topics/suggestions", query: args).parsed_response
+    response = get("topics/suggestions", query: args).parsed_response
 
     response.map do |hsh|
       new(hsh, :full => true)

data/lib/federal_register.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'httparty'
+require 'faraday'
 
 module FederalRegister
 end

data/spec/agency_spec.rb

@@ -3,7 +3,16 @@ require File.dirname(__FILE__) + '/spec_helper'
 describe FederalRegister::Agency do
   describe ".all" do
     before(:each) do
-      FakeWeb.register_uri(:get, "https://www.federalregister.gov/api/v1/agencies.json", :body => [{},{}].to_json, :content_type =>"text/json")
+      stub_request(
+        :get,
+        "https://www.federalregister.gov/api/v1/agencies.json"
+      )
+      .to_return(
+        body: [{},{}].to_json,
+        headers: { 'Content-Type' => 'application/json' },
+        status: 200
+      )
+
     end
 
     it "returns Agency objects" do

data/spec/base_spec.rb

@@ -101,8 +101,8 @@ describe FederalRegister::Base do
     end
 
     [FederalRegister::Agency, FederalRegister::Article, FederalRegister::Base, FederalRegister::Client, FederalRegister::ResultSet].each do |klass|
-      it "should set default_options[:base_uri] for #{klass}" do
-        klass.default_options[:base_uri].should == 'http://fr2.local/api/v1'
+      it "should set base uri for #{klass}" do
+        klass.base_uri.should == 'http://fr2.local/api/v1'
       end
     end
 

data/spec/document_spec.rb

@@ -4,12 +4,15 @@ describe FederalRegister::Document do
   describe ".find" do
     it "fetches the document by its document number" do
       document_number = "2010-213"
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/documents/#{document_number}.json",
-        :content_type =>"text/json",
-        :body => {:title => "Important Notice"}.to_json
       )
+      .to_return(
+        body: {:title => "Important Notice"}.to_json,
+        headers: { 'Content-Type' => 'text/json' },
+      )
+
 
       FederalRegister::Document.find(document_number).title.should == 'Important Notice'
     end
@@ -18,11 +21,13 @@ describe FederalRegister::Document do
       document_number = "2010-213"
       params = URI.encode_www_form([["fields[]","title"],["fields[]", "start_page"]])
 
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/documents/#{document_number}.json?#{params}",
-        :content_type => "text/json",
-        :body => {:title => "Important Notice", :start_page => 12345}.to_json
+      )
+      .to_return(
+        body: {:title => "Important Notice", :start_page => 12345}.to_json,
+        headers: { 'Content-Type' => 'text/json' },
       )
 
       result = FederalRegister::Document.find(document_number, :fields => ["title", "start_page"])
@@ -35,13 +40,16 @@ describe FederalRegister::Document do
       document_number = "2010-213"
       publication_date = "2010-02-02"
       params = URI.encode_www_form([["publication_date", "#{publication_date}"]])
-      
-      FakeWeb.register_uri(
+
+      stub_request(
         :get,
-        "https://www.federalregister.gov/api/v1/documents/#{document_number}.json?#{params}",
-        :content_type => "text/json",
-        :body => {:title => "Important Notice", :publication_date => publication_date}.to_json
+        "https://www.federalregister.gov/api/v1/documents/#{document_number}.json?#{params}"
+      )
+      .to_return(
+        body: {:title => "Important Notice", :publication_date => publication_date}.to_json,
+        headers: { 'Content-Type' => 'text/json' }
       )
+      
 
       result = FederalRegister::Document.find(document_number, :publication_date => publication_date)
       result.title.should eql("Important Notice")
@@ -50,38 +58,46 @@ describe FederalRegister::Document do
 
     it "throws an error when a document doesn't exist" do
       document_number = "some-random-document"
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/documents/#{document_number}.json",
-        :content_type =>"text/json",
-        :status => 404
       )
+      .to_return(
+        headers: { 'Content-Type' => 'text/json' },
+        status: 404
+      )
+
       lambda{ FederalRegister::Document.find(document_number) }.should raise_error FederalRegister::Client::RecordNotFound
     end
   end
 
   describe ".find_all" do
     it "fetches multiple matching documents" do
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/documents/abc,def.json",
-        :content_type =>"text/json",
-        :body => {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json
       )
+      .to_return(
+        body: {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json,
+        headers: { 'Content-Type' => 'text/json' },
+      )
+
       result_set = FederalRegister::Document.find_all('abc','def')
       result_set.results.map(&:document_number).sort.should === ['abc','def']
     end
 
     it "fetches multiple matching documents with only requested fields (when present)" do
       params = URI.encode_www_form([["fields[]","document_number"],["fields[]", "title"]])
-      
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/documents/abc,def.json?#{params}",
-        :content_type =>"text/json",
-        :body => {:results => [{:document_number => "abc", :title => "Important Notice"},
-                               {:document_number => "def", :title => "Important Rule"}]}.to_json
       )
+      .to_return(
+        body: {:results => [{:document_number => "abc", :title => "Important Notice"},
+                               {:document_number => "def", :title => "Important Rule"}]}.to_json,
+        headers: { 'Content-Type' => 'text/json' },
+      )
+      
       result_set = FederalRegister::Document.find_all('abc','def', :fields => ["document_number", "title"])
       result_set.results.map(&:document_number).sort.should === ['abc','def']
       result_set.results.map(&:title).sort.should === ['Important Notice','Important Rule']
@@ -90,11 +106,13 @@ describe FederalRegister::Document do
 
     it "handles results when no documents are returned" do
       params = URI.encode_www_form([["fields[]","document_number"],["fields[]", "title"]])
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/documents/bad_document_number,.json?#{params}",
-        :content_type =>"text/json",
-        :body => {"count":0,"results":[],"errors":{"not_found":["bad_docuemnt_number"]}}.to_json
+      )
+      .to_return(
+        body: {"count":0,"results":[],"errors":{"not_found":["bad_docuemnt_number"]}}.to_json,
+        headers: { 'Content-Type' => 'text/json' },
       )
 
       result_set = FederalRegister::Document.find_all('bad_document_number', :fields => ["document_number", "title"])
@@ -103,12 +121,14 @@ describe FederalRegister::Document do
 
     it "appends a trailing comma when a single document is provided to ensure API interface doesn't return a single document" do
       params = URI.encode_www_form([["fields[]","document_number"],["fields[]", "title"]])
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/documents/2016-26522,.json?#{params}",
-        :content_type =>"text/json",
-        :body => {:results => [{:document_number => "2016-26522", :title => "Important Notice"}],
-         }.to_json
+      )
+      .to_return(
+        body: {:results => [{:document_number => "2016-26522", :title => "Important Notice"}],
+         }.to_json,
+        headers: { 'Content-Type' => 'text/json' },
       )
 
       FederalRegister::Document.find_all('2016-26522', :fields => ["document_number", "title"])
@@ -117,36 +137,44 @@ describe FederalRegister::Document do
     it "ensures document or citation numbers provided are unique before making requests to API Core." do
       # Without calling unique, duplicate results could be returned since we're now batching up larger requests.
       params = URI.encode_www_form([["fields[]","document_number"],["fields[]", "title"]])
-      FakeWeb.register_uri(
+      stub_request(
         :get,
-        "https://www.federalregister.gov/api/v1/documents/2016-26522,.json?fields[]=#{params}",
-        :content_type =>"text/json",
+        "https://www.federalregister.gov/api/v1/documents/2016-26522,.json?#{params}",
+      )
+      .to_return(
         :body => {:results => [{:document_number => "2016-26522", :title => "Important Notice"}],
-         }.to_json
+         }.to_json,
+        headers: { 'Content-Type' => 'text/json' },
       )
+
       FederalRegister::Document.find_all('2016-26522', '2016-26522', :fields => ["document_number", "title"])
     end
 
     #TODO: Add specs aroudn API response
     it "batches up large requests when CGI parameters exceed the URL limit and returns the correct" do
       params = URI.encode_www_form([["fields[]","document_number"],["fields[]", "title"]])
-      FakeWeb.register_uri(
+      stub_request(
         :get,
-        "https://www.federalregister.gov/api/v1/documents/2016-26000,2016-26001,2016-26002,2016-26003,2016-26004,2016-26005,2016-26006,2016-26007,2016-26008,2016-26009,2016-26010,2016-26011,2016-26012,2016-26013,2016-26014,2016-26015,2016-26016,2016-26017,2016-26018,2016-26019,2016-26020,2016-26021,2016-26022,2016-26023,2016-26024,2016-26025,2016-26026,2016-26027,2016-26028,2016-26029,2016-26030,2016-26031,2016-26032,2016-26033,2016-26034,2016-26035,2016-26036,2016-26037,2016-26038,2016-26039,2016-26040,2016-26041,2016-26042,2016-26043,2016-26044,2016-26045,2016-26046,2016-26047,2016-26048,2016-26049,2016-26050,2016-26051,2016-26052,2016-26053,2016-26054,2016-26055,2016-26056,2016-26057,2016-26058,2016-26059,2016-26060,2016-26061,2016-26062,2016-26063,2016-26064,2016-26065,2016-26066,2016-26067,2016-26068,2016-26069,2016-26070,2016-26071,2016-26072,2016-26073,2016-26074,2016-26075,2016-26076,2016-26077,2016-26078,2016-26079,2016-26080,2016-26081,2016-26082,2016-26083,2016-26084,2016-26085,2016-26086,2016-26087,2016-26088,2016-26089,2016-26090,2016-26091,2016-26092,2016-26093,2016-26094,2016-26095,2016-26096,2016-26097,2016-26098,2016-26099,2016-26100.json?#{params}",
-        :content_type =>"text/json",
+        "https://www.federalregister.gov/api/v1/documents/2016-26000,2016-26001,2016-26002,2016-26003,2016-26004,2016-26005,2016-26006,2016-26007,2016-26008,2016-26009,2016-26010,2016-26011,2016-26012,2016-26013,2016-26014,2016-26015,2016-26016,2016-26017,2016-26018,2016-26019,2016-26020,2016-26021,2016-26022,2016-26023,2016-26024,2016-26025,2016-26026,2016-26027,2016-26028,2016-26029,2016-26030,2016-26031,2016-26032,2016-26033,2016-26034,2016-26035,2016-26036,2016-26037,2016-26038,2016-26039,2016-26040,2016-26041,2016-26042,2016-26043,2016-26044,2016-26045,2016-26046,2016-26047,2016-26048,2016-26049,2016-26050,2016-26051,2016-26052,2016-26053,2016-26054,2016-26055,2016-26056,2016-26057,2016-26058,2016-26059,2016-26060,2016-26061,2016-26062,2016-26063,2016-26064,2016-26065,2016-26066,2016-26067,2016-26068,2016-26069,2016-26070,2016-26071,2016-26072,2016-26073,2016-26074,2016-26075,2016-26076,2016-26077,2016-26078,2016-26079,2016-26080,2016-26081,2016-26082,2016-26083,2016-26084,2016-26085,2016-26086,2016-26087,2016-26088,2016-26089,2016-26090,2016-26091,2016-26092,2016-26093,2016-26094,2016-26095,2016-26096,2016-26097,2016-26098,2016-26099,2016-26100.json?#{params}"
+      )
+      .to_return(
         :body => {:results => [
           {:document_number => "2016-26000", :title => "Important Notice"},
           #...
-        ]}.to_json
+        ]}.to_json,
+        headers: { 'Content-Type' => 'text/json' }
       )
-      FakeWeb.register_uri(
+
+      stub_request(
         :get,
-        "https://www.federalregister.gov/api/v1/documents/2016-26101,2016-26102,2016-26103,2016-26104,2016-26105,2016-26106,2016-26107,2016-26108,2016-26109,2016-26110,2016-26111,2016-26112,2016-26113,2016-26114,2016-26115,2016-26116,2016-26117,2016-26118,2016-26119,2016-26120,2016-26121,2016-26122,2016-26123,2016-26124,2016-26125,2016-26126,2016-26127,2016-26128,2016-26129,2016-26130,2016-26131,2016-26132,2016-26133,2016-26134,2016-26135,2016-26136,2016-26137,2016-26138,2016-26139,2016-26140,2016-26141,2016-26142,2016-26143,2016-26144,2016-26145,2016-26146,2016-26147,2016-26148,2016-26149,2016-26150,2016-26151,2016-26152,2016-26153,2016-26154,2016-26155,2016-26156,2016-26157,2016-26158,2016-26159,2016-26160,2016-26161,2016-26162,2016-26163,2016-26164,2016-26165,2016-26166,2016-26167,2016-26168,2016-26169,2016-26170,2016-26171,2016-26172,2016-26173,2016-26174,2016-26175,2016-26176,2016-26177,2016-26178,2016-26179,2016-26180,2016-26181,2016-26182,2016-26183,2016-26184,2016-26185,2016-26186,2016-26187,2016-26188,2016-26189,2016-26190,2016-26191,2016-26192,2016-26193,2016-26194,2016-26195,2016-26196,2016-26197,2016-26198,2016-26199,2016-26200.json?#{params}",
-        :content_type =>"text/json",
+        "https://www.federalregister.gov/api/v1/documents/2016-26101,2016-26102,2016-26103,2016-26104,2016-26105,2016-26106,2016-26107,2016-26108,2016-26109,2016-26110,2016-26111,2016-26112,2016-26113,2016-26114,2016-26115,2016-26116,2016-26117,2016-26118,2016-26119,2016-26120,2016-26121,2016-26122,2016-26123,2016-26124,2016-26125,2016-26126,2016-26127,2016-26128,2016-26129,2016-26130,2016-26131,2016-26132,2016-26133,2016-26134,2016-26135,2016-26136,2016-26137,2016-26138,2016-26139,2016-26140,2016-26141,2016-26142,2016-26143,2016-26144,2016-26145,2016-26146,2016-26147,2016-26148,2016-26149,2016-26150,2016-26151,2016-26152,2016-26153,2016-26154,2016-26155,2016-26156,2016-26157,2016-26158,2016-26159,2016-26160,2016-26161,2016-26162,2016-26163,2016-26164,2016-26165,2016-26166,2016-26167,2016-26168,2016-26169,2016-26170,2016-26171,2016-26172,2016-26173,2016-26174,2016-26175,2016-26176,2016-26177,2016-26178,2016-26179,2016-26180,2016-26181,2016-26182,2016-26183,2016-26184,2016-26185,2016-26186,2016-26187,2016-26188,2016-26189,2016-26190,2016-26191,2016-26192,2016-26193,2016-26194,2016-26195,2016-26196,2016-26197,2016-26198,2016-26199,2016-26200.json?#{params}"
+      )
+      .to_return(
         :body => {:results => [
           {:document_number => "2016-26000", :title => "Important Notice"},
           #...
-        ]}.to_json
+        ]}.to_json,
+        headers: { 'Content-Type' => 'text/json' }
       )
 
       document_numbers = []
@@ -165,11 +193,13 @@ describe FederalRegister::Document do
   describe ".search" do
     before(:each) do
       params = URI.encode_www_form([["conditions[term]","Fish"]])
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/documents.json?#{params}",
-        :content_type =>"text/json",
-        :body => {:count => 3}.to_json
+      )
+      .to_return(
+        :body => {:count => 3}.to_json,
+        headers: { 'Content-Type' => 'text/json' },
       )
     end
 
@@ -182,12 +212,15 @@ describe FederalRegister::Document do
     it "fetches the full_text_xml from the full_text_xml_url" do
       url = "http://example.com/full_text"
       document = FederalRegister::Document.new("full_text_xml_url" => url)
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         url,
-        :content_type =>"text/xml",
-        :body => "hello, world!"
       )
+      .to_return(
+        :body => "hello, world!",
+        headers: { 'Content-Type' => 'text/xml' },
+      )
+
       document.full_text_xml.should == 'hello, world!'
     end
   end
@@ -202,11 +235,13 @@ describe FederalRegister::Document do
   describe "#docket_ids" do
     it "returns an array" do
       document_number = "2010-213"
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/documents/#{document_number}.json",
-        :content_type =>"text/json",
-        :body => {:title => "Important Notice", :docket_ids => ['ABC','123']}.to_json
+      )
+      .to_return(
+        body: {:title => "Important Notice", :docket_ids => ['ABC','123']}.to_json,
+        headers: { 'Content-Type' => 'text/json' },
       )
 
       FederalRegister::Document.find(document_number).docket_ids.should == ['ABC','123']

data/spec/public_inspection_document_spec.rb

@@ -4,36 +4,40 @@ describe FederalRegister::PublicInspectionDocument do
   describe ".find" do
     it "fetches the document by its document number" do
       document_number = "2010-213"
-      FakeWeb.register_uri(
+      stub_request(
         :get,
-        "https://www.federalregister.gov/api/v1/public-inspection-documents/#{document_number}.json",
-        :content_type =>"text/json",
-        :body => {:title => "Important Notice"}.to_json
+        "https://www.federalregister.gov/api/v1/public-inspection-documents/#{document_number}.json"
       )
+      .to_return(
+        body: {:title => "Important Notice"}.to_json,
+        headers: { 'Content-Type' => 'application/json' },
+        status: 200
+      )
+
 
       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(
+      stub_request(
         :get,
-        "https://www.federalregister.gov/api/v1/public-inspection-documents/#{document_number}.json",
-        :content_type =>"text/json",
-        :status => 404
+        "https://www.federalregister.gov/api/v1/public-inspection-documents/#{document_number}.json"
+      )
+      .to_return(
+        headers: { '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,
-        "https://www.federalregister.gov/api/v1/public-inspection-documents/abc,def.json",
-        :content_type =>"text/json",
-        :body => {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json
-      )
+      stub_request(:get, "https://www.federalregister.gov/api/v1/public-inspection-documents/abc,def.json").
+        to_return(status: 200, body: {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json,         headers: { 'Content-Type' => 'text/json' })
+
       result_set = FederalRegister::PublicInspectionDocument.find_all('abc','def')
       result_set.results.map(&:document_number).sort.should === ['abc','def']
     end
@@ -42,12 +46,17 @@ describe FederalRegister::PublicInspectionDocument do
   describe ".available_on" do
     it "fetches the document on PI on a given date" do
       params = URI.encode_www_form([["conditions[available_on]", "2011-10-15"]])
-      FakeWeb.register_uri(
+
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/public-inspection-documents.json?#{params}",
-        :content_type =>"text/json",
-        :body => {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json
       )
+      .to_return(
+        body: {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json,
+        headers: { 'Content-Type' => 'text/json' },
+        # status: 200
+      )
+
       result_set = FederalRegister::PublicInspectionDocument.available_on(Date.parse('2011-10-15'))
       result_set.results.map(&:document_number).sort.should === ['abc','def']
     end
@@ -55,12 +64,16 @@ describe FederalRegister::PublicInspectionDocument do
 
   describe ".current" do
     it "fetches the PI documents from the current issue" do
-      FakeWeb.register_uri(
+      stub_request(
         :get,
         "https://www.federalregister.gov/api/v1/public-inspection-documents/current.json",
-        :content_type =>"text/json",
-        :body => {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json
       )
+      .to_return(
+        body: {:results => [{:document_number => "abc"}, {:document_number => "def"}]}.to_json,
+        headers: { 'Content-Type' => 'text/json' },
+        # status: 200
+      )
+
       result_set = FederalRegister::PublicInspectionDocument.current
       result_set.results.map(&:document_number).sort.should === ['abc','def']
     end

data/spec/result_set_spec.rb

@@ -3,7 +3,16 @@ require File.dirname(__FILE__) + '/spec_helper'
 describe FederalRegister::ResultSet do
   describe "#next" do
     it "loads the next_page_url" do
-      FakeWeb.register_uri(:get, "https://www.federalregister.gov/api/v1/fishes?page=2", :body => {:count => 24}.to_json, :content_type =>"text/json")
+      stub_request(
+        :get,
+        "https://www.federalregister.gov/api/v1/fishes?page=2"
+      )
+      .to_return(
+        body: {:count => 24}.to_json,
+        headers: { 'Content-Type' => 'application/json' },
+        status: 200
+      )
+
       FederalRegister::ResultSet.new({'next_page_url' => 'https://www.federalregister.gov/api/v1/fishes?page=2'}, FederalRegister::Document).next.count.should == 24
     end
   end

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
-require 'fakeweb'
+require 'webmock/rspec'
 require 'active_support/ordered_hash'
 require 'active_support/json'
 require 'active_support/time'
 require 'federal_register'
 
-FakeWeb.allow_net_connect = false
+WebMock.disable_net_connect!(allow_localhost: true) # Prevents real HTTP requests except to localhost
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
@@ -16,5 +16,3 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   config.expect_with(:rspec) { |c| c.syntax = :should }
 end
-
-

metadata

@@ -1,30 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: federal_register
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.8.0
 platform: ruby
 authors:
 - Andrew Carpenter
 - Bob Burbach
-autorequire: 
 bindir: bin
 cert_chain: []
 date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby API Client for FederalRegister.gov that handles searching documents
   and getting information about agencies
 email: andrew@criticaljuncture.org
@@ -195,7 +222,6 @@ homepage: http://github.com/usnationalarchives/federal_register
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -210,8 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 3
 summary: Ruby API Client for FederalRegister.gov
 test_files: []