ecfr 1.1.4 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93cb578d4fc85f48e9d1d0ac423522886fa575a2425da6836547eb075d4e6cf5
-  data.tar.gz: b896739d0023e6398da9effbab99ed0b48323d6a61b9f21b94b2680f9ed74146
+  metadata.gz: 7a590084cfafab933fe619638898f62eeacb37aa183af6174cb47406df26d4c5
+  data.tar.gz: '095a4f5623deb58978f0c00941fa3c89d2f3bb2ef35bf9dff913e0648fb77af6'
 SHA512:
-  metadata.gz: cc03bfa1d18e5e202f4e3f069d4cf3f8ee3caf5aa3af26fdf0f9813a1c9c7756fe403764ac69f00268e3c96cbad85f1697e69eb8eab6f74b4d84351e74806e2e
-  data.tar.gz: 599a3c76236594b98fde583b801922b3bfb686071c9cbf2460610895d229580c428ba02026898b181dd0729dcfa18ccbecd8c1af5fde036edc17229c55ca739d
+  metadata.gz: 5fda252dfcbf05c0922c9c06167d2f6a99b833d60a251544a2e3cecacf990378e629b793f96da9744caddcb2819f7f417736c6ebe432174c25530bad452f3097
+  data.tar.gz: 44376ecbcfe743b0a105ae3d146a5c7abe01c304521bf140640dd0b7af67d723457df1a102f32d65f4596670d317ad1166d81130d1d456791d2e8b2d743bdd12

data/.rubocop.yml

@@ -18,9 +18,11 @@ inherit_mode:
   merge:
     - Exclude
 
-require:
+plugins:
   # Performance cops are bundled with Standard
   - rubocop-performance
+
+require:
   # Standard's config uses this custom cop,
   # so it must be loaded
   - standard/cop/block_single_line_braces

data/CHANGELOG.md

@@ -1,8 +1,17 @@
-## [Unreleased]
+## [1.1.6] - 2025-09-23
+### Fixes
+- Add missing Gemfile lock changes
+- See 1.1.5
+
+## [1.1.5] - 2025-09-23 - yanked
+### Additions
+- Add timeline endpoint (8490dbf1)
+- Removed puts from client to cleanup unwanted output (31846f86)
+- Add support for using 'delete' verb when attempting to clear varnish cache. (7d7a5870)
 
 ## [1.1.4] - 2025-03-27
 ### Additions
-- Add factory for Agency (38185411) 
+- Add factory for Agency (38185411)
 ### Dependencies
 - Removed lock to Rails 6 (f6c5024a)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecfr (1.1.3)
+    ecfr (1.1.6)
       activemodel
       activesupport
       faraday (~> 2.0)
@@ -24,120 +24,128 @@ GEM
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
-    ast (2.4.2)
+    ast (2.4.3)
     base64 (0.2.0)
-    bigdecimal (3.1.8)
+    bigdecimal (3.1.9)
     coderay (1.1.3)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
-    diff-lcs (1.5.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    diff-lcs (1.6.2)
     drb (2.2.1)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    factory_bot (6.5.0)
-      activesupport (>= 5.0.0)
-    faraday (2.12.0)
-      faraday-net_http (>= 2.0, < 3.4)
+    factory_bot (6.5.1)
+      activesupport (>= 6.1.0)
+    faraday (2.13.1)
+      faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.3.0)
-      net-http
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
     faraday-net_http_persistent (2.3.0)
       faraday (~> 2.5)
       net-http-persistent (>= 4.0.4, < 5)
     faraday-typhoeus (1.1.0)
       faraday (~> 2.0)
       typhoeus (~> 1.4)
-    ffi (1.17.0)
-    i18n (1.14.6)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
+    json (2.12.0)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
-    logger (1.6.1)
+    logger (1.7.0)
     method_source (1.1.0)
-    mini_portile2 (2.8.7)
-    minitest (5.25.1)
-    net-http (0.4.1)
+    minitest (5.25.5)
+    net-http (0.6.0)
       uri
-    net-http-persistent (4.0.4)
+    net-http-persistent (4.0.5)
       connection_pool (~> 2.2)
-    nokogiri (1.16.7)
-      mini_portile2 (~> 2.8.2)
+    nokogiri (1.18.8-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
     ostruct (0.6.1)
-    parallel (1.26.3)
-    parallel_tests (4.7.2)
+    parallel (1.27.0)
+    parallel_tests (4.10.1)
       parallel
-    parser (3.3.5.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
-    pry (0.14.2)
+    prism (1.4.0)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     racc (1.8.1)
-    rack (3.1.7)
+    rack (3.1.14)
     rainbow (3.1.1)
-    regexp_parser (2.9.2)
+    regexp_parser (2.10.0)
     request_store (1.7.0)
       rack (>= 1.4)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.1)
+    rspec-core (3.13.3)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
+    rspec-support (3.13.3)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.66.1)
+    rubocop (1.75.6)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.3)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.22.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
     ruby-progressbar (1.13.0)
-    securerandom (0.3.1)
-    standard (1.41.0)
+    securerandom (0.4.1)
+    standard (1.50.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.66.0)
+      rubocop (~> 1.75.5)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.5)
+      standard-performance (~> 1.8)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.5.0)
+    standard-performance (1.8.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.22.0)
-    turbo_tests (2.2.4)
+      rubocop-performance (~> 1.25.0)
+    turbo_tests (2.2.5)
       parallel_tests (>= 3.3.0, < 5)
       rspec (>= 3.10)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.6.0)
-    uri (0.13.1)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
     yard (0.9.37)
 
 PLATFORMS
-  ruby
+  arm64-darwin
+  x86_64-linux-gnu
 
 DEPENDENCIES
   ecfr!
@@ -155,4 +163,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.6.5
+   2.6.7

data/lib/ecfr/attribute_method_definition.rb

@@ -43,10 +43,7 @@ module Ecfr
         end
 
         if options[:type] == :boolean
-          define_method :"#{attr}?" do
-            val = extract_value(attr, options)
-            Ecfr::AttributeCaster.cast_attr(val, options[:type], options[:options] || {})
-          end
+          alias_method :"#{attr}?", :"#{attr}"
         end
       end
     end

data/lib/ecfr/base.rb

@@ -35,9 +35,10 @@ module Ecfr
     delegate(*SUPPORTED_ARRAY_ACCESSORS, to: :results)
     alias_method :all, :results
 
+    DEFAULT_OPTIONS = {base: true}
+
     def initialize(attributes = {}, options = {})
-      default_options = {base: true}
-      options = default_options.merge(options)
+      options.reverse_merge!(DEFAULT_OPTIONS)
 
       @response_status = options.delete(:response_status)
       @request_data = options.delete(:request_data)

data/lib/ecfr/client.rb

@@ -142,7 +142,8 @@ module Ecfr
 
         response = instrument("Ecfr::Perform #{cache_key.to_s.tr("\"", "'")}") do
           RequestStore.fetch(cache_key) do
-            puts "Request not in eCFR gem cache, fetching..."
+            # TODO: replace this puts with a logger
+            # puts "Request not in eCFR gem cache, fetching..."
 
             response = fetch(method, path, params: params,
               client_options: client_options)
@@ -201,7 +202,6 @@ module Ecfr
     #
     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/configuration.rb

@@ -26,6 +26,7 @@ module Ecfr
       subscriptions_service_path: nil,
       varnish_cache_service_url: nil,
       varnish_cache_service_path: nil,
+      varnish_cache_service_clear_method: "purge",
       versioner_service_url: nil,
       versioner_service_path: nil,
       # basic auth - some endpoints require auth

data/lib/ecfr/search_service/base.rb

@@ -7,6 +7,7 @@ module Ecfr
       require_relative "content_version"
       require_relative "facet_base"
       require_relative "date_facet"
+      require_relative "timeline"
       require_relative "title_facet"
 
       def self.base_url

data/lib/ecfr/search_service/timeline.rb

@@ -0,0 +1,29 @@
+module Ecfr
+  module SearchService
+    class Timeline < FacetBase
+      include AttributeMethodDefinition
+
+      class Entry < Base
+        include AttributeMethodDefinition
+
+        def initialize(attributes = {}, options = {})
+          date, attributes, _ = attributes
+          attributes["date"] = date
+          attributes["change_types"].compact!
+          super
+        end
+
+        attribute :change_types, type: Array(:symbol)
+        attribute :count, type: :integer
+        attribute :date, type: :date, as: :key
+      end
+
+      attribute :timeline, type: Array(Entry)
+
+      # @return [<Timeline::Entry>]
+      def self.search(options = {})
+        super(:timeline, options)
+      end
+    end
+  end
+end

data/lib/ecfr/testing/extensions/search_service/timeline_extensions.rb

@@ -0,0 +1,13 @@
+class Ecfr::SearchService::Timeline
+  extend ResponseHelper
+
+  def self.response_for(timeline)
+    results = {
+      timeline: timeline
+    }.to_json
+
+    build(
+      response: stubbed_response(results)
+    )
+  end
+end

data/lib/ecfr/testing/factories/search_service/timeline_factory.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :timeline, class: "Ecfr::SearchService::Timeline" do
+    skip_create
+
+    initialize_with {
+      new(attributes.deep_stringify_keys)
+    }
+  end
+end

data/lib/ecfr/varnish_cache_service/base.rb

@@ -14,7 +14,13 @@ module Ecfr
       end
 
       def self.expire(path)
-        purge(path)
+        # not all backends support the purge verb
+        # - the varnish purge proxy expects delete
+        if Ecfr.config.varnish_cache_service_clear_method.to_s == "delete"
+          delete(path)
+        else
+          purge(path)
+        end
       end
 
       def self.expire_everything

data/lib/ecfr/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ecfr
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.6
 platform: ruby
 authors:
 - Peregrinator
 bindir: exe
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 2025-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -325,6 +325,7 @@ files:
 - lib/ecfr/search_service/date_facet.rb
 - lib/ecfr/search_service/facet_base.rb
 - lib/ecfr/search_service/status.rb
+- lib/ecfr/search_service/timeline.rb
 - lib/ecfr/search_service/title_facet.rb
 - lib/ecfr/subscriptions_service/base.rb
 - lib/ecfr/subscriptions_service/status.rb
@@ -335,6 +336,7 @@ files:
 - lib/ecfr/testing/extensions/renderer_service/origin_extensions.rb
 - lib/ecfr/testing/extensions/search_service/content_version_result_extensions.rb
 - lib/ecfr/testing/extensions/search_service/date_facet_extensions.rb
+- lib/ecfr/testing/extensions/search_service/timeline_extensions.rb
 - lib/ecfr/testing/extensions/versioner_service/ancestors_extensions.rb
 - lib/ecfr/testing/extensions/versioner_service/title_extenstions.rb
 - lib/ecfr/testing/factories/admin_service/agency_factory.rb
@@ -347,6 +349,7 @@ files:
 - lib/ecfr/testing/factories/search_service/content_version_count_factory.rb
 - lib/ecfr/testing/factories/search_service/content_version_result_factory.rb
 - lib/ecfr/testing/factories/search_service/date_facet_factory.rb
+- lib/ecfr/testing/factories/search_service/timeline_factory.rb
 - lib/ecfr/testing/factories/versioner_service/ancestors_factory.rb
 - lib/ecfr/testing/factories/versioner_service/metadata_node_info_factory.rb
 - lib/ecfr/testing/factories/versioner_service/node_summary_factory.rb