purl_fetcher-client 1.5.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 297afb191a996a944ca1a0f40e1b4c2cb311efe96ac16e2fa419ad85fbab044a
-  data.tar.gz: 1e09cba32a3f22b75f001641f56c430fabc2db993349dea9f6b6f516dbdd0440
+  metadata.gz: 8017e254342b99f9124349f201e4208be5f770266cea433a8dace94af780b880
+  data.tar.gz: 1ca31e0176e72973c32ceb02e0e44c29db4dab7a99b067eb7521a7e1ee6d70b1
 SHA512:
-  metadata.gz: 4f1e38d68ab409f3f45f0f5b1dbff9de27f156541ba8efa5b7eade1c5b99ca474e3743dc22c3b093194f6c6ca3791bc02cc20016777db2e4a429129485353e8b
-  data.tar.gz: 1476ef3bbc608f55888b7386ce91deb289e8495ac6044f88265769fa666a3e7f6b48acb0377f575f673018f565c8d0732078b480de7fdf87a6f96002136df73b
+  metadata.gz: 026716e6518e2240863859fc6e7142eb3110d5fed36d951ee5232b1579697e0202ad2413bc0e92b85b86b3ca44bc36773a6dba447159f0e4a73ead3f1d648f0a
+  data.tar.gz: c3a4d72a5dbd0052190a719507ef5ea80082b2719d5f6eb1dc66e9f4884744f3967be904ddc0d26d49b93efd5210b4acb9445b9bf2450609195e2e4c443832ca

data/README.md

@@ -20,28 +20,6 @@ Or install it yourself as:
 
     $ gem install purl_fetcher-client
 
-## Usage
-
-### Uploading a file
-
-```ruby
-PurlFetcher::Client.configure(url:'http://127.0.0.1:3000', token: 'abc123')
-
-PurlFetcher::Client::UploadFiles.upload(
-  file_metadata: {
-    'file1.txt' => PurlFetcher::Client::DirectUploadRequest.new(
-      checksum: '123',
-      byte_size: 10_000,
-      content_type: 'image/tiff',
-      filename: 'image.tiff'
-    )
-  },
-  filepath_map: {
-    'file1.txt' => File.expand_path('Gemfile.lock')
-  }
-)
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/purl_fetcher/client/publish.rb

@@ -9,21 +9,27 @@ module PurlFetcher
       end
 
       # @param [Cocina::Models::DRO,Cocina::Models::Collection] cocina the Cocina data object
-      # @param [Hash<String,String>] file_uploads map of filenames to signed_ids
-      def initialize(cocina:, file_uploads:)
+      # @param [Hash<String,String>] file_uploads map of cocina filenames to staging filenames (UUIDs)
+      # @param [String] version the version of the item
+      # @param [DateTime] version_date the version date
+      # @param [Boolean] must_version whether the item must be versioned
+      def initialize(cocina:, file_uploads:, version:, version_date:, must_version:)
         @cocina = cocina
         @file_uploads = file_uploads
+        @version = version
+        @version_date = version_date
+        @must_version = must_version
       end
 
       def publish
         logger.debug("Starting a publish request for: #{druid}")
-        client.post(path:, body:)
+        client.put(path:, body:)
         logger.debug("Publish request complete")
       end
 
       private
 
-      attr_reader :cocina, :file_uploads
+      attr_reader :cocina, :file_uploads, :version, :version_date, :must_version
 
       def druid
         cocina.externalIdentifier
@@ -32,7 +38,10 @@ module PurlFetcher
       def body
         {
           object: cocina.to_h,
-          file_uploads: file_uploads
+          file_uploads: file_uploads,
+          version: version,
+          version_date: version_date.iso8601,
+          must_version: must_version
       }.to_json
       end
 
@@ -45,7 +54,7 @@ module PurlFetcher
       end
 
       def path
-        "/v1/resources"
+        "/v1/purls/#{druid}"
       end
     end
   end

data/lib/purl_fetcher/client/reader.rb

@@ -25,7 +25,7 @@ class PurlFetcher::Client::Reader
   # @raise [PurlFetcher::Client::NotFoundResponseError] if item is not found
   # @raise [PurlFetcher::Client::ResponseError] if the response is not successful
   def files_by_digest(druid)
-    retrieve_json("/purls/druid:#{druid.delete_prefix('druid:')}", {})
+    retrieve_json("/v1/purls/druid:#{druid.delete_prefix('druid:')}", {})
       .fetch("files_by_md5", [])
   end
 

data/lib/purl_fetcher/client/release_tags.rb

@@ -43,7 +43,7 @@ module PurlFetcher
       end
 
       def path
-        "/v1/released/#{druid}"
+        "/v1/purls/#{druid}/release_tags"
       end
     end
   end

data/lib/purl_fetcher/client/unpublish.rb

@@ -5,26 +5,29 @@ module PurlFetcher
     # Delete an item from the purl-fetcher cache
     class Unpublish
       # @param [String] druid the identifier of the item
+      # @param [String] version the version of the item
       # @raise [Purl::Fetcher::Client::AlreadyDeletedResponseError] if the item is already deleted
-      def self.unpublish(druid:)
-        new(druid:).unpublish
+      def self.unpublish(druid:, version:)
+        new(druid:, version:).unpublish
       end
 
       # @param [String] druid the identifier of the item
-      def initialize(druid:)
+      # @param [String] version the version of the item
+      def initialize(druid:, version:)
         @druid = druid
+        @version = version
       end
 
       def unpublish
-        logger.debug("Starting a unpublish request for: #{druid}")
-        response = client.delete(path:)
+        logger.debug("Starting a unpublish request for: #{druid} (#{version})")
+        response = client.delete(path:, params: { version: version })
         logger.debug("Unpublish request complete")
         response
       end
 
       private
 
-      attr_reader :druid
+      attr_reader :druid, :version
 
       def logger
         Client.config.logger
@@ -35,7 +38,7 @@ module PurlFetcher
       end
 
       def path
-        "/purls/#{druid}"
+        "/v1/purls/#{druid}"
       end
     end
   end

data/lib/purl_fetcher/client/version.rb

@@ -1,5 +1,5 @@
 module PurlFetcher
   class Client
-    VERSION = "1.5.4"
+    VERSION = "2.1.0"
   end
 end

data/lib/purl_fetcher/client/withdraw.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module PurlFetcher
+  class Client
+    # Withdraw / restore a version of an item from the purl-fetcher cache
+    class Withdraw
+      # @param [String] druid the identifier of the item
+      # @param [String] version the version of the item
+      def self.withdraw(druid:, version:)
+        new(druid:, version:).withdraw
+      end
+
+      # @param [String] druid the identifier of the item
+      # @param [String] version the version of the item
+      def self.restore(druid:, version:)
+        new(druid:, version:).restore
+      end
+
+      # @param [String] druid the identifier of the item
+      # @param [String] version the version of the item
+      def initialize(druid:, version:)
+        @druid = druid
+        @version = version
+      end
+
+      def withdraw
+        logger.debug("Starting a withdraw request for: #{druid} (#{version})")
+        response = client.put(path: path(:withdraw))
+        logger.debug("Withdraw request complete")
+        response
+      end
+
+      def restore
+        logger.debug("Starting a restore request for: #{druid} (#{version})")
+        response = client.put(path: path(:restore))
+        logger.debug("Withdraw request complete")
+        response
+      end
+
+      private
+
+      attr_reader :druid, :version
+
+      def logger
+        Client.config.logger
+      end
+
+      def client
+        Client.instance
+      end
+
+      def path(action)
+        "/v1/purls/#{druid}/versions/#{version}/#{action}"
+      end
+    end
+  end
+end

data/lib/purl_fetcher/client.rb

@@ -7,14 +7,10 @@ require "logger"
 require "purl_fetcher/client/version"
 require "purl_fetcher/client/reader"
 require "purl_fetcher/client/mods"
-require "purl_fetcher/client/upload_files"
-require "purl_fetcher/client/direct_upload_request"
-require "purl_fetcher/client/direct_upload_response"
-require "purl_fetcher/client/legacy_publish"
 require "purl_fetcher/client/publish"
 require "purl_fetcher/client/release_tags"
 require "purl_fetcher/client/unpublish"
-require "purl_fetcher/client/publish_shelve"
+require "purl_fetcher/client/withdraw"
 
 module PurlFetcher
   class Client
@@ -53,8 +49,9 @@ module PurlFetcher
 
     # Send an DELETE request
     # @param path [String] the path for the API request
-    def delete(path:)
-      response = connection.delete(path)
+    # @param params [Hash] the query parameters for the DELETE request
+    def delete(path:, params: {})
+      response = connection.delete(path, params)
 
       raise AlreadyDeletedResponseError, response.body if response.status == 409
       raise "unexpected response: #{response.status} #{response.body}" unless response.success?
@@ -79,9 +76,9 @@ module PurlFetcher
     # @param path [String] the path for the API request
     # @param body [String] the body of the POST request
     # @param headers [Hash] extra headers to add to the SDR API request
-    def put(path:, body:, headers: {})
+    def put(path:, body: nil, headers: {})
       response = connection.put(path) do |request|
-        request.body = body
+        request.body = body if body
         request.headers = default_headers.merge(headers)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purl_fetcher-client
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -126,17 +126,13 @@ files:
 - bin/console
 - bin/setup
 - lib/purl_fetcher/client.rb
-- lib/purl_fetcher/client/direct_upload_request.rb
-- lib/purl_fetcher/client/direct_upload_response.rb
-- lib/purl_fetcher/client/legacy_publish.rb
 - lib/purl_fetcher/client/mods.rb
 - lib/purl_fetcher/client/publish.rb
-- lib/purl_fetcher/client/publish_shelve.rb
 - lib/purl_fetcher/client/reader.rb
 - lib/purl_fetcher/client/release_tags.rb
 - lib/purl_fetcher/client/unpublish.rb
-- lib/purl_fetcher/client/upload_files.rb
 - lib/purl_fetcher/client/version.rb
+- lib/purl_fetcher/client/withdraw.rb
 - purl_fetcher-client.gemspec
 homepage:
 licenses: []
@@ -156,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Traject-compatible reader implementation for streaming data from purl-fetcher

data/lib/purl_fetcher/client/direct_upload_request.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module PurlFetcher
-  class Client
-    # This models the JSON that we send to the server.
-    DirectUploadRequest = Data.define(:checksum, :byte_size, :content_type, :filename) do
-      def self.from_file(hexdigest:, byte_size:, file_name:, content_type:)
-        new(checksum: hex_to_base64_digest(hexdigest),
-            byte_size: byte_size,
-            content_type: clean_content_type(content_type),
-            filename: file_name)
-      end
-
-      def to_h
-        {
-          blob: { filename: filename, byte_size: byte_size, checksum: checksum,
-                  content_type: self.class.clean_content_type(content_type) }
-        }
-      end
-
-      def to_json(*_args)
-        JSON.generate(to_h)
-      end
-
-      def self.clean_content_type(content_type)
-        return "application/octet-stream" if content_type.blank?
-
-        # ActiveStorage is expecting "application/x-stata-dta" not "application/x-stata-dta;version=14"
-        content_type.split(";").first
-      end
-
-      def self.hex_to_base64_digest(hexdigest)
-        [ [ hexdigest ].pack("H*") ].pack("m0")
-      end
-    end
-  end
-end

data/lib/purl_fetcher/client/direct_upload_response.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module PurlFetcher
-  class Client
-    DirectUploadResponse = Data.define(:id, :key, :checksum, :byte_size, :content_type,
-                                      :filename, :metadata, :created_at, :direct_upload,
-                                      :signed_id, :service_name) do
-                                        def with_filename(filename)
-                                          self.class.new(**deconstruct_keys(nil).merge(filename:))
-                                        end
-                                      end
-  end
-end

data/lib/purl_fetcher/client/legacy_publish.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module PurlFetcher
-  class Client
-    # Publish (metadata-only). This will be replaced with a single publish operation
-    class LegacyPublish
-      # @param [Cocina::Models::DRO,Cocina::Models::Collection] cocina the Cocina data object
-      def self.publish(cocina:)
-        new(cocina:).publish
-      end
-
-      # @param [Cocina::Models::DRO,Cocina::Models::Collection] cocina the Cocina data object
-      def initialize(cocina:)
-        @cocina = cocina
-      end
-
-      def publish
-        logger.debug("Starting a legacy publish request for: #{druid}")
-        response = client.post(path:, body:)
-        logger.debug("Legacy publish request complete")
-      end
-
-      private
-
-      attr_reader :cocina
-
-      def druid
-        cocina.externalIdentifier
-      end
-
-      def body
-        cocina.to_json
-      end
-
-      def logger
-        Client.config.logger
-      end
-
-      def client
-        Client.instance
-      end
-
-      def path
-        "/purls/#{druid}"
-      end
-    end
-  end
-end

data/lib/purl_fetcher/client/publish_shelve.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module PurlFetcher
-  class Client
-    # High-level client for publishing and shelving.
-    class PublishShelve
-      def self.publish_and_shelve(...)
-        new(...).publish_and_shelve
-      end
-
-      # @param [Cocina::Models::DRO,Cocina::Models::Collection] cocina the Cocina data object
-      # @param [Hash<String,String>] filepath_map map of relative filepaths to absolute filepaths
-      def initialize(cocina:, filepath_map:)
-        @cocina = cocina
-        @filepath_map = filepath_map
-      end
-
-      def publish_and_shelve
-        logger.debug("Starting publish and shelve for: #{cocina.externalIdentifier}")
-
-        direct_upload_responses = PurlFetcher::Client::UploadFiles.upload(file_metadata: file_metadata, filepath_map: filepath_map)
-        file_uploads = direct_upload_responses.map { |response| [ response.filename, response.signed_id ] }.to_h
-
-        PurlFetcher::Client::Publish.publish(cocina: cocina, file_uploads: file_uploads)
-        logger.debug("Publish and shelve complete")
-      end
-
-      private
-
-      attr_reader :cocina, :filepath_map
-
-      def file_metadata
-        return [] unless cocina.dro?
-
-        cocina.structural.contains.flat_map do |fileset|
-          fileset.structural.contains.select { |file| filepath_map.include?(file.filename) }.map do |file|
-            direct_upload_request_for(file)
-          end
-        end
-      end
-
-      def direct_upload_request_for(cocina_file)
-        PurlFetcher::Client::DirectUploadRequest.from_file(
-          hexdigest: md5_for(cocina_file),
-          byte_size: size_for(cocina_file),
-          content_type: "application/octet-stream",
-          file_name: cocina_file.filename
-        )
-      end
-
-      def md5_for(cocina_file)
-        cocina_file.hasMessageDigests.find { |digest| digest.type == "md5" }.digest
-      end
-
-      def size_for(cocina_file)
-        return cocina_file.size if cocina_file.size.present? && cocina_file.size.positive?
-
-        File.size(filepath_map[cocina_file.filename])
-      end
-
-      def logger
-        Client.config.logger
-      end
-    end
-  end
-end

data/lib/purl_fetcher/client/upload_files.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module PurlFetcher
-  class Client
-    # The file uploading part of a transfer
-    class UploadFiles
-      # @param [Hash<String,DirectUploadRequest>] file_metadata map of relative filepaths to file metadata
-      # @param [Hash<String,String>] filepath_map map of relative filepaths to absolute filepaths
-      def self.upload(file_metadata:, filepath_map:)
-        new(file_metadata: file_metadata, filepath_map: filepath_map).upload
-      end
-
-      # @param [Array<DirectUploadRequest>] file_metadata array of DirectUploadRequests for the files to be uploaded
-      # @param [Hash<String,String>] filepath_map map of relative filepaths to absolute filepaths
-      def initialize(file_metadata:, filepath_map:)
-        @file_metadata = file_metadata
-        @filepath_map = filepath_map
-      end
-
-      # @return [Array<DirectUploadResponse>] the responses from the server for the uploads
-      def upload
-        file_metadata.map do |metadata|
-          filepath = metadata.filename
-          # ActiveStorage modifies the filename provided in response, so setting here with the relative filename
-          direct_upload(metadata.to_json).with_filename(filepath).tap do |response|
-            upload_file(response)
-            logger.info("Upload of #{filepath} complete")
-          end
-        end
-      end
-
-      private
-
-      attr_reader :file_metadata, :filepath_map
-
-      def logger
-        Client.config.logger
-      end
-
-      def client
-        Client.instance
-      end
-
-      def path
-        "/v1/direct_uploads"
-      end
-
-      def direct_upload(metadata_json)
-        logger.info("Starting an upload request: #{metadata_json}")
-        response = client.post(path: path, body: metadata_json)
-
-        logger.info("Response from server: #{response}")
-        DirectUploadResponse.new(**response.symbolize_keys)
-      end
-
-      def upload_file(response)
-        logger.info("Uploading `#{response.filename}' to #{response.direct_upload.fetch('url')}")
-
-        client.put(
-          path: response.direct_upload.fetch("url"),
-          body: ::File.open(filepath_map[response.filename]),
-          headers: {
-            "content-type" => response.content_type,
-            "content-length" => response.byte_size.to_s
-          }
-        )
-      end
-    end
-  end
-end