ecfr 1.0.5 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac4f799a4cc68b3a71f156bf577a550203c72dd40b10a3f9ed5e51e670059a08
-  data.tar.gz: b5632a1b02852a341edd594d6a6e7aa999e24affe1a8e0b6f1aa2c77085f78b8
+  metadata.gz: 3982b2145a3ab849c7fbbe13699265d5d3c75ca19be019e8b3e57bad78f6c2ee
+  data.tar.gz: 2d4b94aa527179914dce1d89f6f781bde99af455abddccb8d1c409d199a811be
 SHA512:
-  metadata.gz: 0d39ecb6d87038d7a7675fb2b8b0a64949301a68a0dbe467dfb9292a55d6738748611afe274664fb610b4c4e68c1dfa98dd772e78e331f559e1ac82d77fe8cce
-  data.tar.gz: 2c91c3086b5f911a49dcd585290ac4f968d942731cd56c7787492b5d18856963a50c602b53889ba8baefe8aad75eea8d33a885cf5af77d8547529d5549a2f70d
+  metadata.gz: 964a37efcba4b38cbca2c9108f59ef9f972ab23f1b6904149b59bc3105370c351781f166397a9bb97fd9564e91cbc21f89ded0defcb64d678e57636b42db309b
+  data.tar.gz: 55fefed80cbf964968660b8c625cf35189d21c55611bbfa0143ce3394e3408d5d5253817f73c115f7f53d0844b8afaf04d5e828c6d563ee1b947325799157f00

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [1.0.8] - 2023-05-05
+### Updates
+- Update Ecfr::RenderService::Diff to rescue expected error types and raise more specific diff errors
+
+## [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

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/renderer_service/diff.rb

@@ -17,14 +17,21 @@ module Ecfr
         view_mode = options.delete(:view_mode) || :enhanced
         params = hierarchy.merge(options).merge(compare: old_date)
 
-        new(
-          {
-            html: get(
-              content_path(new_date, title, view_mode: view_mode),
-              params
-            ).body
-          }.stringify_keys
-        )
+        begin
+          new(
+            {
+              html: get(
+                content_path(new_date, title, view_mode: view_mode),
+                params
+              ).body
+            }.stringify_keys
+          )
+        rescue Ecfr::Client::ResponseError, Ecfr::Client::ServerError
+          # diff too large - diff service generated broken pipe error or 500 code
+          raise DiffTooLarge
+        rescue Ecfr::Client::UnknownStatusCode
+          raise Undiffable
+        end
       end
     end
   end

data/lib/ecfr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ecfr
-  VERSION = "1.0.5"
+  VERSION = "1.0.8"
 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.5
+  version: 1.0.8
 platform: ruby
 authors:
 - Peregrinator
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-24 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel