ecfr 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3982b2145a3ab849c7fbbe13699265d5d3c75ca19be019e8b3e57bad78f6c2ee
-  data.tar.gz: 2d4b94aa527179914dce1d89f6f781bde99af455abddccb8d1c409d199a811be
+  metadata.gz: cadbb3387da1a9a32e94246031dd6330160ad2aa8891d6fee6a78fd334553b6b
+  data.tar.gz: 58d7b650c1e6406d1ce1a9b6faf76e649762c3bf90a0305a38a5f0dd63580a28
 SHA512:
-  metadata.gz: 964a37efcba4b38cbca2c9108f59ef9f972ab23f1b6904149b59bc3105370c351781f166397a9bb97fd9564e91cbc21f89ded0defcb64d678e57636b42db309b
-  data.tar.gz: 55fefed80cbf964968660b8c625cf35189d21c55611bbfa0143ce3394e3408d5d5253817f73c115f7f53d0844b8afaf04d5e828c6d563ee1b947325799157f00
+  metadata.gz: 7e8feba398bf9e8aac36468a6292682526a1d95b412a8ac46b898d7c7a71c144081b5aca4cca2d386f24e359399d1e13599ff95f219047257a038c176d063959
+  data.tar.gz: 1cd02d613ead3929fe1957bade79bac560f37ccdfc531c59a4710524ccb781ca23c0fff44f3bc0e42f58126e0da9265f23874d41db4847c20bb5a328de669714

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [1.0.9] - 2023-05-12
+### Additions
+- Add support for configuring the service path. This supports blue/green style deployments where the same service may be running but accessible at different subpaths.
+
 ## [1.0.8] - 2023-05-05
 ### Updates
 - Update Ecfr::RenderService::Diff to rescue expected error types and raise more specific diff errors

data/README.md

@@ -1,6 +1,6 @@
 # Ecfr
 
-Provides a Ruby API client for the eCFR.gov APIs.
+Provides a Ruby API client for the eCFR.gov APIs. Not all services and API endpoints in this gem are publically available. See https://www.ecfr.gov/developers/documentation/api/v1 for public endpoint documentation.
 
 ## Installation
 

data/lib/ecfr/admin_service/base.rb

@@ -12,12 +12,14 @@ module Ecfr
       require_relative "issue"
       require_relative "site_notification"
 
-      SERVICE_PATH = "/admin/api/admin"
-
       def self.base_url
         Ecfr.config.admin_service_url || Ecfr.config.base_url
       end
 
+      def self.service_path
+        Ecfr.config.admin_service_path || "/admin/api/admin"
+      end
+
       def self.service_name
         "Admin Service"
       end

data/lib/ecfr/client.rb

@@ -121,7 +121,7 @@ module Ecfr
     #   response_status set.
     #
     def self.perform(method, path, params: {}, client_options: {}, perform_options: {})
-      path = [self::SERVICE_PATH, path].compact.join("/")
+      path = [service_path, path].compact.join("/")
 
       default_perform_options = {parse_response: true}
       perform_options = default_perform_options.merge(perform_options)

data/lib/ecfr/configuration.rb

@@ -11,14 +11,23 @@ module Ecfr
       ofr_profile_service_base_url: "https://www.federalregister.gov/my/profile",
       # service url overrides
       admin_service_url: nil,
+      admin_service_path: nil,
       diff_service_url: nil,
+      diff_service_path: nil,
       ofr_profile_service_url: nil,
+      ofr_profile_service_path: nil,
       prince_xml_service_url: nil,
+      prince_xml_service_path: nil,
       renderer_service_url: nil,
+      renderer_service_path: nil,
       search_service_url: nil,
+      search_service_path: nil,
       subscriptions_service_url: nil,
+      subscriptions_service_path: nil,
       varnish_cache_service_url: nil,
+      varnish_cache_service_path: nil,
       versioner_service_url: nil,
+      versioner_service_path: nil,
       # basic auth - some endpoints require auth
       ecfr_basic_auth_username: nil,
       ecfr_basic_auth_password: nil,

data/lib/ecfr/default_documentation_setup.rb

@@ -19,7 +19,7 @@ module Ecfr
         {
           url: [
             base_url,
-            self::SERVICE_PATH,
+            service_path,
             "/#{DOCUMENTATION_PATH}"
           ].reject(&:blank?).join,
           method: :get

data/lib/ecfr/default_status_setup.rb

@@ -17,7 +17,7 @@ module Ecfr
       def status_config
         url = [
           base_url,
-          self::SERVICE_PATH,
+          service_path,
           STATUS_PATH
         ].reject(&:blank?)
           .join("/")

data/lib/ecfr/diff_service/base.rb

@@ -3,12 +3,14 @@ module Ecfr
     class Base < Ecfr::Base
       require_relative "status"
 
-      SERVICE_PATH = "/api/diff"
-
       def self.base_url
         Ecfr.config.diff_service_url || Ecfr.config.base_url
       end
 
+      def self.service_path
+        Ecfr.config.diff_service_path || "/api/diff"
+      end
+
       def self.service_name
         "Diff Service"
       end

data/lib/ecfr/diff_service/status.rb

@@ -20,7 +20,7 @@ module Ecfr
       # errors or run in parallel
       def self.status_config
         {
-          url: "#{base_url}/#{SERVICE_PATH}/#{STATUS_PATH}",
+          url: "#{base_url}/#{service_path}/#{STATUS_PATH}",
           method: :post,
           response_type: "html",
           options: {

data/lib/ecfr/ofr_profile_service/base.rb

@@ -3,13 +3,15 @@ module Ecfr
     class Base < Ecfr::Base
       require_relative "status"
 
+      def self.base_url
+        Ecfr.config.ofr_profile_service_url || Ecfr.config.ofr_profile_service_base_url
+      end
+
       # path is relative because we expect the ofr profile
       # api to be mounted at a subpath and an absolute url
       # here will cause the path in the config to be lost
-      SERVICE_PATH = "api/profile"
-
-      def self.base_url
-        Ecfr.config.ofr_profile_service_url || Ecfr.config.ofr_profile_service_base_url
+      def self.service_path
+        Ecfr.config.ofr_profile_service_path || "api/profile"
       end
 
       def self.service_name

data/lib/ecfr/prince_xml_service/base.rb

@@ -3,12 +3,14 @@ module Ecfr
     class Base < Ecfr::Base
       require_relative "pdf"
 
-      SERVICE_PATH = ""
-
       def self.base_url
         Ecfr.config.prince_xml_service_url || Ecfr.config.base_url
       end
 
+      def self.service_path
+        Ecfr.config.prince_xml_service_path || ""
+      end
+
       def self.service_name
         "Prince XML Service"
       end

data/lib/ecfr/prince_xml_service/status.rb.bak

@@ -0,0 +1,33 @@
+module Ecfr
+  module PrinceXmlService
+    class Status < Base
+      include DefaultStatusSetup
+
+      STATUS_PATH = "status"
+
+      def self.status
+        perform(
+          status_config[:method],
+          STATUS_PATH,
+          perform_options: {parse_response: false}
+        )
+      end
+
+      # .status_config is provided to support use cases
+      # in which the user wants to construct their own
+      # handling of status checks, e.g. to wrap in custom
+      # errors or run in parallel
+      def status_config
+        {
+          url: [
+              base_url,
+              service_path,
+              STATUS_PATH
+            ].reject(&:blank?).join("/"),
+          method: :get,
+          response_type: "html"
+        }
+      end
+    end
+  end
+end

data/lib/ecfr/renderer_service/base.rb

@@ -7,12 +7,14 @@ module Ecfr
       require_relative "diff"
       require_relative "origin"
 
-      SERVICE_PATH = "/api/renderer"
-
       def self.base_url
         Ecfr.config.renderer_service_url || Ecfr.config.base_url
       end
 
+      def self.service_path
+        Ecfr.config.renderer_service_path || "/api/renderer"
+      end
+
       def self.service_name
         "Renderer Service"
       end
@@ -23,7 +25,7 @@ module Ecfr
       # content retrieval doesn't make use of the .perform worflow
       # and so we need to add service path here.
       def self.content_path(date, title_number, view_mode: "enhanced")
-        "#{SERVICE_PATH}/#{HTML_PATH}/#{view_mode}/#{date}/title-#{title_number}"
+        "#{service_path}/#{HTML_PATH}/#{view_mode}/#{date}/title-#{title_number}"
       end
       private_class_method :content_path
     end

data/lib/ecfr/search_service/base.rb

@@ -9,12 +9,14 @@ module Ecfr
       require_relative "date_facet"
       require_relative "title_facet"
 
-      SERVICE_PATH = "/api/search"
-
       def self.base_url
         Ecfr.config.search_service_url || Ecfr.config.base_url
       end
 
+      def self.service_path
+        Ecfr.config.search_service_path || "/api/search"
+      end
+
       def self.service_name
         "Search Service"
       end

data/lib/ecfr/subscriptions_service/base.rb

@@ -5,12 +5,14 @@ module Ecfr
 
       require_relative "subscription"
 
-      SERVICE_PATH = "/api/subscriptions"
-
       def self.base_url
         Ecfr.config.subscriptions_service_url || Ecfr.config.base_url
       end
 
+      def self.service_path
+        Ecfr.config.subscriptions_service_path || "/api/subscriptions"
+      end
+
       def self.service_name
         "Subscriptions Service"
       end

data/lib/ecfr/version.rb

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

data/lib/ecfr/versioner_service/base.rb

@@ -10,12 +10,14 @@ module Ecfr
       require_relative "title"
       require_relative "xml_content"
 
-      SERVICE_PATH = "/api/versioner"
-
       def self.base_url
         Ecfr.config.versioner_service_url || Ecfr.config.base_url
       end
 
+      def self.service_path
+        Ecfr.config.versioner_service_path || "/api/versioner"
+      end
+
       def self.service_name
         "Versioner Service"
       end

data/lib/ecfr/versioner_service/structure.rb

@@ -45,7 +45,7 @@ module Ecfr
         options = default_options.merge(options.symbolize_keys)
 
         format = options.delete(:format)
-        path = [self::SERVICE_PATH, structure_path(date, title_number, format)].join("/")
+        path = [service_path, structure_path(date, title_number, format)].join("/")
 
         client.build_url(path, options).to_s
       end
@@ -109,7 +109,7 @@ module Ecfr
         date = split[-2]
         title_number = split[-1].split("-")[1]
 
-        path = "#{self.class::SERVICE_PATH}/#{self.class.send(:structure_path, date, title_number)}"
+        path = "#{self.class.service_path}/#{self.class.send(:structure_path, date, title_number)}"
 
         params = request_data[:params].except(:structure, :metadata)
 

data/lib/ecfr/versioner_service/xml_content.rb

@@ -51,7 +51,7 @@ module Ecfr
       end
 
       def self.xml_content_path(date, title_number)
-        "#{SERVICE_PATH}/#{XML_PATH}/#{date}/title-#{title_number}.xml"
+        "#{service_path}/#{XML_PATH}/#{date}/title-#{title_number}.xml"
       end
       private_class_method :xml_content_path
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecfr
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Peregrinator
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -292,6 +292,7 @@ files:
 - lib/ecfr/parallel_client.rb
 - lib/ecfr/prince_xml_service/base.rb
 - lib/ecfr/prince_xml_service/pdf.rb
+- lib/ecfr/prince_xml_service/status.rb.bak
 - lib/ecfr/renderer_service/base.rb
 - lib/ecfr/renderer_service/content.rb
 - lib/ecfr/renderer_service/diff.rb