ecfr 1.0.4 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a461ee470f942857af590c19d394480c9fae9120f34d350177c2cfcdde01afa
-  data.tar.gz: c5e33627c9a6de6cc626588dc5772c9e51276aab272293960f85672c7e2c30d4
+  metadata.gz: ad783e80fbc8dd7934378bb9b9afc6b98f3ba5a066c8ebe4408e037c4a247a4d
+  data.tar.gz: cff950a97ec12681c9228e42976d7d28d617f50c52fde48dd2aad835bc5cd564
 SHA512:
-  metadata.gz: 5f1289d6881ae12c16bf38d3f6f19b4d62690f8fd651273b2146a08a2c8e6c1e715f279f71dee059ff7304c5f2e4b092cc95b003fbfacd84c6bd712616ba7ce8
-  data.tar.gz: feb036c209435977e25198394deb3a814d76f821ee560d643bf5c4dcd1a0bf0f4abc649921d8fbd9dce11d467c07eb2660319149aa1343e8351d494348cbbf14
+  metadata.gz: 3033789d092b96abe406f93f73efe0f725a6dcd8b37cd3750035cf3e76463ff28bfdcec22e5448a38390cf1f771a7f2c0bf6e338e4875c7e029f519f220a9bc5
+  data.tar.gz: 79e512df9d7253e97e756a1d49f90a2fb3ea8983e3e4d643eb33ae569d6ab305053c29242412a9b9447a57286aa4d82036acff583e9efb67ba70882031c401d7

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [1.0.7] - 2023-05-04
+### Bugfixes
+- Remove change to .build method signature that was unnecessary and caused issues with the testing extensions we provide.
+- Includes bugfix from 1.0.6
+
+## [1.0.6] - 2023-05-04 (yanked)
+### Bugfixes
+- Properly cache ancestor base response (fbfdf1e6)
+
+## [1.0.5] - 2023-04-24
+### Bugfixes
+- Remove blank response body check in PDF generation that doesn't play well with all encodings
+
 ## [1.0.4] - 2023-04-24
 ### Additions
 - Add Ecfr::VarnishCacheService for clearing of cache

data/lib/ecfr/client.rb

@@ -135,9 +135,12 @@ module Ecfr
           RequestStore.fetch(cache_key) do
             puts "Request not in eCFR gem cache, fetching..."
 
-            response = fetch(method, path, params: params, client_options: client_options)
+            response = fetch(method, path, params: params,
+              client_options: client_options)
 
-            cache_base_response(response, path, params) if respond_to?(:cache_base_response)
+            if respond_to?(:cache_base_response, true)
+              cache_base_response(response, method, path, params)
+            end
 
             response
           end
@@ -187,7 +190,9 @@ module Ecfr
     #
     # See the .perform/.fetch method for argument signatures
     #
-    def self.build(response:, request_data: {}, build_options: {})
+    def self.build(response:,
+      request_data: {}, build_options: {})
+
       default_build_options = {parse_response: true}
       build_options = default_build_options.merge(build_options)
 

data/lib/ecfr/prince_xml_service/pdf.rb

@@ -13,7 +13,7 @@ module Ecfr
       def self.html_to_pdf(string, output_path, sha)
         response = post(PDF_PATH, {html: string})
 
-        if response.status != 200 || response.body.blank?
+        if response.status != 200
           raise PdfGenerationFailure.new(response.body)
         else
           directory = File.dirname(output_path)

data/lib/ecfr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ecfr
-  VERSION = "1.0.4"
+  VERSION = "1.0.7"
 end

data/lib/ecfr/versioner_service/ancestors.rb

@@ -86,7 +86,7 @@ module Ecfr
         perform(
           :get,
           ancestors_path(date, title_number),
-          params: options
+          params: options.compact
         )
       end
 
@@ -97,25 +97,47 @@ module Ecfr
 
       # these parameters add items to the base response but do not affect our
       # ability to cache that base response
-      PARAMETERS_NOT_AFFECTING_BASE_RESPONSE = %w[metadata structure descendant_depth]
+      PARAMETERS_NOT_AFFECTING_BASE_RESPONSE = %i[metadata]
+      SIDELOAD_PARAMETERS = %i[structure descendant_depth]
 
       # if the request only includes optional parameters that don't affect the
-      # basic part of the response, then we can catch a base form of that
+      # basic part of the response, then we can cache a base form of that
       # response by removing those optional return items (this keeps the cache
       # consistent across request by not including extra items).
-      def self.cache_base_response(response, path, params)
-        if only_safe_params?(params)
-          cache_key = cache_key(method, path, {})
+      def self.cache_base_response(response, method, path, params)
+        non_hierarchy_params = params.except(
+          *Ecfr::Constants::Hierarchy::HIERARCHY_LEVELS.map(&:to_sym)
+        )
+
+        if only_safe_params?(non_hierarchy_params)
+          cache_key = cache_key(method, path, params.except(*SIDELOAD_PARAMETERS))
+
+          # in the case the the response is the base response the cache keys
+          # will match - fetch will just return that and this will essentially
+          # be a no op
           RequestStore.fetch(cache_key) do
-            response.except(:metadata, :structure)
+            excluded_items = params.key?(:metadata) ?
+              [:structure] : [:metadata, :structure]
+
+            response_body = JSON.parse(response.body)
+              .except(*excluded_items.map(&:to_s))
+
+            # return a ducktyped object like the response object
+            OpenStruct.new(
+              body: response_body.to_json,
+              status: response.status
+            )
           end
         end
       end
-      private_class_method :cache_base_response
+      # private_class_method :cache_base_response
 
       def self.only_safe_params?(params)
-        # are all of the params keys included in the list?
-        params.keys.all? { |p| PARAMETERS_NOT_AFFECTING_BASE_RESPONSE.include?(p) }
+        # are all of the params keys included in the one of the lists?
+        params.keys.all? do |p|
+          (PARAMETERS_NOT_AFFECTING_BASE_RESPONSE +
+            SIDELOAD_PARAMETERS).include?(p)
+        end
       end
 
       # override enumerable setup because we don't have

data/lib/ecfr/versioner_service/structure.rb

@@ -22,7 +22,7 @@ module Ecfr
         perform(
           :get,
           structure_path(date, title_number, format),
-          params: options.except(:section, :appendix),
+          params: options.except(:section, :appendix).compact,
           perform_options: {
             init_data: {format: format},
             parse_response: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecfr
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.7
 platform: ruby
 authors:
 - Peregrinator
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel