purl_fetcher-client 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cade5ac0289e6a39d9d9dca571bea47032391fa774d1356e56dbada402e6bb5e
-  data.tar.gz: 043a7f61d74b733bf2fd12bf26704ff25af6539f10c5731ae4843f11c2376c1a
+  metadata.gz: 989a8e0ff7bcb9f39c83e2d5656b759f8a265862e97c0f4964de9ca15ec63be7
+  data.tar.gz: 640c89a6ed21223385b8a07950da50b3e7d0dbad00f6b35a4b34707e6af6ad99
 SHA512:
-  metadata.gz: fa1bce8d7e6ef5090a19d8cf8ecf42eeeb24f2c5ef59345c77ded4b50752f01e1b18307dd65aafcd0aa8c4873210becf6fcdfacb5cdd6179034c023a609d3218
-  data.tar.gz: 8f76a7eecfff70435931364f827571733cc6f4d9e7cc90d8f65276580eab0dbcd5cd8eddd5a146b3e7fe016b2f4d69a3dff177e77e941ef7bbe47e49b975d3dc
+  metadata.gz: a4155c8e5dce02815e9b9993a6634f2226047ff0c302dc8412451baa4b280892a7539cf56fb64d4dfe45512aacf70497051ac8be5a9fe302d427da97ee932d8c
+  data.tar.gz: 7d0e48ee44aa4358a93bccae266190b287bbe4f948f017511696326c7d6a12ec661db38e2d328dcca17e78bee6b8d445e568cb10e299d94cba393568f308896f

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.2

data/Gemfile

@@ -1,6 +1,9 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in purl_fetcher-client.gemspec
 gemspec
+
+gem "rubocop-rails-omakase", require: false, group: [ :development ]
+gem "debug"

data/README.md

@@ -22,7 +22,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### 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
 

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "purl_fetcher/client"
+require 'bundler/setup'
+require 'purl_fetcher/client'
+require 'debug'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "purl_fetcher/client"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/purl_fetcher/client/direct_upload_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "digest"
+
+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

@@ -0,0 +1,13 @@
+# 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

@@ -0,0 +1,48 @@
+# 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/reader.rb

@@ -2,7 +2,7 @@ class PurlFetcher::Client::Reader
   include Enumerable
   attr_reader :host, :conn, :range
 
-  def initialize(host: 'https://purl-fetcher.stanford.edu', conn: nil)
+  def initialize(host: "https://purl-fetcher.stanford.edu", conn: nil)
     @host = host
     @conn = conn || Faraday.new(host) do |f|
               f.response :json
@@ -13,8 +13,8 @@ class PurlFetcher::Client::Reader
   def collection_members(druid)
     return to_enum(:collection_members, druid) unless block_given?
 
-    paginated_get("/collections/druid:#{druid.delete_prefix('druid:')}/purls", 'purls').each do |obj, _meta|
-      yield obj['druid'].delete_prefix('druid:')
+    paginated_get("/collections/druid:#{druid.delete_prefix('druid:')}/purls", "purls").each do |obj, _meta|
+      yield obj["druid"].delete_prefix("druid:")
     end
   end
 
@@ -55,7 +55,7 @@ class PurlFetcher::Client::Reader
 
       loop do
         data = fetch(path, { per_page: per_page, page: page }.merge(params))
-        @range = data['range']
+        @range = data["range"]
 
         total += data[accessor].length
 
@@ -63,7 +63,7 @@ class PurlFetcher::Client::Reader
           yielder.yield element, self
         end
 
-        page = data['pages']['next_page']
+        page = data["pages"]["next_page"]
 
         break if page.nil? || total >= max
       end

data/lib/purl_fetcher/client/release_tags.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module PurlFetcher
+  class Client
+    # Transfer release tags to purl-fetcher
+    class ReleaseTags
+      # @param [String] druid the identifier of the object
+      # @param [Array<String>] index ([]) list of properties to index to
+      # @param [Array<String>] delete ([]) list of properties to delete from
+      def self.release(druid:, index: [], delete: [])
+        new(index:, delete:).release
+      end
+
+      # @param [String] druid the identifier of the object
+      # @param [Array<String>] index ([]) list of properties to index to
+      # @param [Array<String>] delete ([]) list of properties to delete from
+      def initialize(druid:, index: [], delete: [])
+        @druid = druid
+        @index = index
+        @delete = delete
+      end
+
+      def release
+        logger.debug("Starting an release request for: #{druid}")
+        response = client.put(path:, body:)
+        logger.debug("Release request complete")
+      end
+
+      private
+
+      attr_reader :druid, :index, :delete
+
+      def body
+        { index:, delete: }.to_json
+      end
+
+      def logger
+        Client.config.logger
+      end
+
+      def client
+        Client.instance
+      end
+
+      def path
+        "/v1/released/#{druid}"
+      end
+    end
+  end
+end

data/lib/purl_fetcher/client/unpublish.rb

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

data/lib/purl_fetcher/client/upload_files.rb

@@ -0,0 +1,70 @@
+# 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 [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 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 |filepath, metadata|
+          direct_upload(metadata.to_json).tap do |response|
+            # ActiveStorage modifies the filename provided in response, so setting here with the relative filename
+            response = response.with_filename(filepath)
+            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

data/lib/purl_fetcher/client/version.rb

@@ -1,5 +1,5 @@
 module PurlFetcher
-  module Client
-    VERSION = "1.0.0"
+  class Client
+    VERSION = "1.2.0"
   end
 end

data/lib/purl_fetcher/client.rb

@@ -1,14 +1,108 @@
+require "active_support"
+require "active_support/core_ext"
+require "faraday"
+require "singleton"
+require "logger"
+
 require "purl_fetcher/client/version"
-require 'faraday'
+require "purl_fetcher/client/reader"
+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/release_tags"
+require "purl_fetcher/client/unpublish"
 
 module PurlFetcher
-  module Client
-    require 'purl_fetcher/client/reader'
-    
+  class Client
     # General error originating in PurlFetcher::Client
     class Error < StandardError; end
 
     # Raised when the response from the server is not successful
     class ResponseError < Error; end
+
+    include Singleton
+    class << self
+      def configure(url:, logger: default_logger, token: nil)
+        instance.config = Config.new(
+          url: url,
+          logger: logger,
+          token: token
+        )
+
+        instance
+      end
+
+      def default_logger
+        Logger.new($stdout)
+      end
+
+      delegate :config, to: :instance
+    end
+
+    attr_accessor :config
+
+    # Send an DELETE request
+    # @param path [String] the path for the API request
+    def delete(path:)
+      response = connection.delete(path)
+
+      raise "unexpected response: #{response.status} #{response.body}" unless response.success?
+
+      response.body
+    end
+
+    # Send an POST request
+    # @param path [String] the path for the API request
+    # @param body [String] the body of the POST request
+    def post(path:, body:)
+      response = connection.post(path) do |request|
+        request.body = body
+      end
+
+      raise "unexpected response: #{response.status} #{response.body}" unless response.success?
+
+      response.body
+    end
+
+    # Send an PUT request
+    # @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: {})
+      response = connection.put(path) do |request|
+        request.body = body
+        request.headers = default_headers.merge(headers)
+      end
+
+      raise "unexpected response: #{response.status} #{response.body}" unless response.success?
+
+      response.body
+    end
+
+    private
+
+    Config = Data.define(:url, :logger, :token)
+
+    def connection
+      Faraday.new(
+        url: config.url,
+        headers: default_headers
+      ) do |conn|
+        conn.response :json
+      end
+    end
+
+    def default_headers
+      {
+        accept: "application/json",
+        content_type: "application/json",
+        authorization: auth_header
+      }.compact
+    end
+
+    def auth_header
+      "Bearer #{config.token}" if config.token
+    end
   end
 end

data/purl_fetcher-client.gemspec

@@ -1,30 +1,30 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "purl_fetcher/client/version"
+require 'purl_fetcher/client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "purl_fetcher-client"
+  spec.name          = 'purl_fetcher-client'
   spec.version       = PurlFetcher::Client::VERSION
-  spec.authors       = ["Chris Beer"]
-  spec.email         = ["cabeer@stanford.edu"]
+  spec.authors       = [ "Chris Beer" ]
+  spec.email         = [ "cabeer@stanford.edu" ]
 
   spec.summary       = 'Traject-compatible reader implementation for streaming data from purl-fetcher'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = [ "lib" ]
 
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'faraday', '~> 2.1'
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "debug"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'debug'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: purl_fetcher-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +118,7 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
@@ -111,7 +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/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
 - purl_fetcher-client.gemspec
 homepage: