ecfr 1.0.14 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e764bf9ef790d05735e7f4110d05dbdac69ec621785e911cfe43c8e1a55cb0e
-  data.tar.gz: bb06e18019a19805911423655419c50dd622b0f60f34360d1e60e04c7045b73f
+  metadata.gz: 72944625e1bcb85c29e2fff986ac16e0d6c207791abfcea2f7f10ac7ab12b298
+  data.tar.gz: 7171f1a6e17465201664a6eedd6fe0d8bbf085d9fec531948110f90ef381354c
 SHA512:
-  metadata.gz: 319d536cefbf939750cc3b5658075108b78908143b1e7a7812896214eecbb5d81809a14bf00e16dfe1494e7bc5107dc3d8175a281a756a9a544d1da382be6f25
-  data.tar.gz: a3f85da3ab39ce3ea01ca0c778fa9007da6cae80de7e341e6d0ccac707b2b31b3c1e5d6b7e1dbe0e7c736db99246f6194f894f1365c435d5c9917d8c504d0896
+  metadata.gz: 72f8d38d3bcc820235bc816d14fcd761ab522131c887b0e0f4733c3001bbc69ece5cb64d1d280d98df7176a4d90dc59d16d379948437a6666f1d18270e936ead
+  data.tar.gz: d3b64de1ab08d60ee5fca9117f35a9d74545117b8f6a3b89aaf18b2eae75a951249d11e0a1249df75b5d8c45e1d5bf5a3d3887e123c238bf928a38871c893f67

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [1.1.0] - 2024-06-28
+### Updates
+- Add classes to versioner service for SGML issue packages (e7743eeb)
+  - NOTE: this is an internal only endpoint
+
 ## [1.0.14] - 2024-02-13
 ### Updates
 - Update path to admin API endpoints (eb267f08)

data/lib/ecfr/client.rb

@@ -87,7 +87,6 @@ module Ecfr
           faraday.use Faraday::UserAgent::Middleware, Ecfr.config.user_agent
 
           if Ecfr.config.log_http_requests
-            # https://lostisland.github.io/faraday/middleware/instrumentation
             faraday.request :instrumentation
 
             faraday.response :logger, Ecfr.config.logger, Ecfr.config.logger_options

data/lib/ecfr/version.rb

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

data/lib/ecfr/versioner_service/base.rb

@@ -7,6 +7,7 @@ module Ecfr
       # note: structure must be required before ancestors
       require_relative "structure"
       require_relative "ancestors"
+      require_relative "issue_package"
       require_relative "title"
       require_relative "xml_content"
 

data/lib/ecfr/versioner_service/issue_package/issue_volume.rb

@@ -0,0 +1,48 @@
+module Ecfr
+  module VersionerService
+    class IssuePackage
+      # Represents a single volume of a title from a specific issue. Only
+      # volumes that have changes are sent over as part of the issue for
+      # publication. These changed volumes are combined to create a final XML
+      # file representing the title for that issue date.
+      class IssueVolume
+        require_relative "sha_comparison"
+        require_relative "title_version"
+
+        include AttributeMethodDefinition
+        extend Extensible
+
+        attribute :id,
+          type: :integer,
+          desc: "issue package database id"
+
+        attribute :converted_title_xml,
+          type: ShaComparison,
+          desc: ""
+
+        attribute :converted_xml,
+          type: ShaComparison,
+          desc: "sha after conversion to GPO bulk XML format"
+
+        attribute :extracted_xml,
+          type: ShaComparison,
+          desc: "base sha for the volume extracted from the GPO bulk data XML"
+
+        attribute :title,
+          type: :integer,
+          desc: "Title number"
+
+        attribute :title_version,
+          type: TitleVersion,
+          desc: "the version record for the title associated with this volume"
+
+        attribute :volume,
+          type: :integer,
+          desc: "volume number"
+
+        attribute :volume_file_sha,
+          desc: "file sha for this volume"
+      end
+    end
+  end
+end

data/lib/ecfr/versioner_service/issue_package/sha_comparison.rb

@@ -0,0 +1,19 @@
+module Ecfr
+  module VersionerService
+    class IssuePackage
+      # A wrapper for sha values after various types of processing
+      class ShaComparison
+        include AttributeMethodDefinition
+
+        attribute :sha,
+          desc: "base file sha"
+
+        attribute :some_blanks_sha,
+          desc: "file sha with some whitespace removed"
+
+        attribute :no_blanks_sha,
+          desc: "file sha with all whitespace removed"
+      end
+    end
+  end
+end

data/lib/ecfr/versioner_service/issue_package/title_version.rb

@@ -0,0 +1,18 @@
+module Ecfr
+  module VersionerService
+    class IssuePackage
+      # TitleVersion represents the full XML for a specific title for a single
+      # issue date.
+      class TitleVersion
+        include AttributeMethodDefinition
+
+        attribute :id,
+          type: :integer,
+          desc: "title version database id"
+
+        attribute :sgml_sourced_xml_sha,
+          desc: "sha of of xml file converted from SGML with tables converted from the GPO table format"
+      end
+    end
+  end
+end

data/lib/ecfr/versioner_service/issue_package.rb

@@ -0,0 +1,49 @@
+module Ecfr
+  module VersionerService
+    # NOTE: IssuePackages are an internal API and are not publicly accessible
+    #
+    # Issue packages represent the data we receive from our upstream datasource
+    # and we then process into XML for ingestion.
+    # Various SHAs are calculated to allow for error checking and discrepency
+    # identification against the GPO bulk data XML.
+    #
+    # Each issue package will contain a file for each volume in each title that
+    # are changing in that issue.
+    class IssuePackage < Base
+      require_relative "issue_package/issue_volume"
+
+      result_key :issue_packages
+
+      attribute :id,
+        type: :integer,
+        desc: "issue pacakge database id"
+
+      attribute :issue_date,
+        type: :date,
+        desc: "issue date this package represents"
+
+      attribute :issue_volumes,
+        type: Array(IssueVolume),
+        desc: "array of the volumes in this issue package"
+
+      attribute :received_at,
+        type: :datetime,
+        desc: "when this issue package was received"
+
+      ISSUE_PACKAGES_PATH = "v1/issue_packages"
+
+      #
+      # Retreives the list of Issue Packages from the last 30 days
+      #
+      # @return [<IssuePackage>] array of Issue Packages and associated
+      # Issue Volumes
+      #
+      def self.all
+        perform(
+          :get,
+          ISSUE_PACKAGES_PATH
+        )
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecfr
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.1.0
 platform: ruby
 authors:
 - Peregrinator
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -349,6 +349,10 @@ files:
 - lib/ecfr/versioner_service/ancestors/node_summary.rb
 - lib/ecfr/versioner_service/api_documentation.rb
 - lib/ecfr/versioner_service/base.rb
+- lib/ecfr/versioner_service/issue_package.rb
+- lib/ecfr/versioner_service/issue_package/issue_volume.rb
+- lib/ecfr/versioner_service/issue_package/sha_comparison.rb
+- lib/ecfr/versioner_service/issue_package/title_version.rb
 - lib/ecfr/versioner_service/status.rb
 - lib/ecfr/versioner_service/structure.rb
 - lib/ecfr/versioner_service/title.rb