sdr-client 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a995f725226eef2f793d8b0b45e487c37a6e34899b223a1f2c6864f32204325
-  data.tar.gz: dd947253f76fe8dcfd20565537e89fa86c4b6b13a4e6c68b2ecf285d30406c08
+  metadata.gz: 565e7d34958ad818fcc048440816b0a360fa723ea6e62dc9437c6832ba8877c1
+  data.tar.gz: 14dfae8ecef2b6d05a256a8bdc7aebebfe801a278546c98bd3066169f7c98899
 SHA512:
-  metadata.gz: f3f0c8d2c9994c4a0408438199105dfdcccb0901e4905220cbf99fd69b3d5e9a735752c3de638264c1397986985ecb2a9f992ab1f1fad2e3245025e78eed1dd0
-  data.tar.gz: 300591272660ad09e74bc992742c3c26c14251bd107252b441a2e2856ed981749dfd5ff298704b13c360a0b3dab0cc89fceb2282a9f301fe24909eaac0b8de0d
+  metadata.gz: bc629b8837567ee95b01ce673a1f1b49596c3665810ab8d59573012b3b9b6a674db12dde7d15461a279f87a4ef88ed23d65d2457bbc7c0479330f45b3f2c1649
+  data.tar.gz: fe176665dadd92ae291b7dbf5b461bb40606600383ad81c9824a8a4bad83344db5e74b6568a10eced02f4fa14894188122605ac2b7ecd5176d7b25b241963da4

data/.rubocop.yml

@@ -13,3 +13,5 @@ Layout/LineLength:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
+  ExcludedMethods:
+    - 'OptionParser.new'

data/README.md

@@ -8,6 +8,10 @@
 This is a CLI for interacting with the Stanford Digital Repository API.
 The code for the SDR API server is at https://github.com/sul-dlss/sdr-api
 
+## Install
+
+`gem install sdr-client`
+
 ## Usage
 
 Log in:

data/exe/sdr

@@ -3,6 +3,7 @@
 
 $LOAD_PATH.unshift 'lib'
 require 'optparse'
+require 'sdr_client'
 
 options = {}
 global = OptionParser.new do |opts|
@@ -60,6 +61,20 @@ subcommands = {
       options[:source_id] = source_id
     end
 
+    opts.on('--strategy STRATEGY',
+            'The strategy to use for distributing files into filesets. Either "default" or "filename"') do |strategy|
+      strategy_class = case strategy
+                       when 'filename'
+                         SdrClient::Deposit::MatchingFileGroupingStrategy
+                       when 'default'
+                         SdrClient::Deposit::SingleFileGroupingStrategy
+                       else
+                         warn "Unknown strategy #{strategy}"
+                         exit(1)
+                       end
+      options[:grouping_strategy] = strategy_class
+    end
+
     opts.on('-h', '--help', 'Display this screen') do
       puts opts
       exit
@@ -75,6 +90,5 @@ end
 
 subcommands[command].order!
 
-require 'sdr_client'
 options[:files] = ARGV unless ARGV.empty?
 SdrClient::CLI.start(command, options)

data/lib/sdr_client.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+require 'dry/monads'
+require 'faraday'
+
 require 'sdr_client/version'
 require 'sdr_client/deposit'
 require 'sdr_client/credentials'
 require 'sdr_client/login'
 require 'sdr_client/login_prompt'
 require 'sdr_client/cli'
-require 'faraday'
 
 module SdrClient
   class Error < StandardError; end

data/lib/sdr_client/cli.rb

@@ -8,7 +8,8 @@ module SdrClient
       when 'deposit'
         SdrClient::Deposit.run(options)
       when 'login'
-        SdrClient::Login.run(options)
+        status = SdrClient::Login.run(options)
+        puts status.value if status.failure?
       else
         raise "Unknown command #{command}"
       end

data/lib/sdr_client/credentials.rb

@@ -14,7 +14,7 @@ module SdrClient
     end
 
     def self.read
-      return IO.readlines(credentials_file, chomp: true).first if File.exist?(credentials_file)
+      return IO.readlines(credentials_file, chomp: true).first if ::File.exist?(credentials_file)
 
       puts 'Log in first'
       exit(1)

data/lib/sdr_client/deposit.rb

@@ -3,13 +3,16 @@
 module SdrClient
   # The namespace for the "deposit" command
   module Deposit
+    # rubocop:disable Metrics/ParameterLists
     def self.run(label: nil,
                  type: 'http://cocina.sul.stanford.edu/models/book.jsonld',
                  apo:,
                  collection:,
                  catkey: nil,
                  source_id:,
-                 url:, files: [])
+                 url:,
+                 files: [],
+                 grouping_strategy: SingleFileGroupingStrategy)
       token = Credentials.read
 
       metadata = Request.new(label: label,
@@ -18,12 +21,17 @@ module SdrClient
                              collection: collection,
                              source_id: source_id,
                              catkey: catkey)
-      Process.new(metadata: metadata, url: url, token: token, files: files).run
+      Process.new(metadata: metadata, url: url, token: token, files: files, grouping_strategy: grouping_strategy).run
     end
+    # rubocop:enable Metrics/ParameterLists
   end
 end
 require 'json'
+require 'sdr_client/deposit/single_file_grouping_strategy'
+require 'sdr_client/deposit/matching_file_grouping_strategy'
 require 'sdr_client/deposit/files/direct_upload_request'
 require 'sdr_client/deposit/files/direct_upload_response'
+require 'sdr_client/deposit/file'
+require 'sdr_client/deposit/file_set'
 require 'sdr_client/deposit/request'
 require 'sdr_client/deposit/process'

data/lib/sdr_client/deposit/file.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # This represents the File metadata that we send to the server for doing a deposit
+    class File
+      def initialize(external_identifier:, label:, filename:, access: 'dark', preserve: false, shelve: false,
+                     md5: nil, sha1: nil)
+        @external_identifier = external_identifier
+        @label = label
+        @filename = filename
+        @access = access
+        @preserve = preserve
+        @shelve = shelve
+        @md5 = md5
+        @sha1 = sha1
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def as_json
+        json = {
+          "type": 'http://cocina.sul.stanford.edu/models/file.jsonld',
+          label: @label,
+          filename: @filename,
+          externalIdentifier: @external_identifier,
+          access: {
+            access: @access
+          },
+          administrative: {
+            sdrPreserve: @preserve,
+            shelve: @shelve
+          }
+        }
+        json['hasMessageDigests'] = message_digests unless message_digests.empty?
+        json
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      private
+
+      def message_digests
+        @message_digests ||= [].tap do |message_digests|
+          message_digests << create_message_digest('md5', @md5) unless @md5.nil?
+          message_digests << create_message_digest('sha1', @sha1) unless @sha1.nil?
+        end
+      end
+
+      def create_message_digest(algorithm, digest)
+        {
+          "type": algorithm,
+          digest: digest
+        }
+      end
+    end
+  end
+end

data/lib/sdr_client/deposit/file_set.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # This represents the FileSet metadata that we send to the server for doing a deposit
+    class FileSet
+      def initialize(uploads: [], uploads_metadata: {}, files: [], label:)
+        @label = label
+        @files = if !uploads.empty?
+                   uploads.map do |upload|
+                     File.new(file_args(upload, uploads_metadata.fetch(upload.filename, {})))
+                   end
+                 else
+                   files
+                 end
+      end
+
+      def as_json
+        {
+          "type": 'http://cocina.sul.stanford.edu/models/fileset.jsonld',
+          "label": label,
+          structural: {
+            hasMember: files.map(&:as_json)
+          }
+        }
+      end
+
+      private
+
+      attr_reader :files, :label
+
+      def file_args(upload, upload_metadata)
+        args = {
+          external_identifier: upload.signed_id,
+          label: upload.filename,
+          filename: upload.filename
+        }
+        args.merge(upload_metadata)
+      end
+    end
+  end
+end

data/lib/sdr_client/deposit/files/direct_upload_request.rb

@@ -9,9 +9,9 @@ module SdrClient
         def self.from_file(filename)
           checksum = Digest::MD5.file(filename).base64digest
           new(checksum: checksum,
-              byte_size: File.size(filename),
+              byte_size: ::File.size(filename),
               content_type: 'text/html',
-              filename: File.basename(filename))
+              filename: ::File.basename(filename))
         end
 
         def as_json

data/lib/sdr_client/deposit/matching_file_grouping_strategy.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # This strategy is for building one file set per set of similarly prefixed uploaded files
+    class MatchingFileGroupingStrategy
+      # @param [Array<SdrClient::Deposit::Files::DirectUploadResponse>] uploads the uploaded files to attach.
+      # @return [Array<Array<SdrClient::Deposit::Files::DirectUploadResponse>>] uploads the grouped uploaded files.
+      def self.run(uploads: [])
+        uploads.group_by { |ul| ::File.basename(ul.filename, '.*') }
+      end
+    end
+  end
+end

data/lib/sdr_client/deposit/process.rb

@@ -9,16 +9,22 @@ module SdrClient
       BLOB_PATH = '/v1/direct_uploads'
       DRO_PATH = '/v1/resources'
       # @param [Request] metadata information about the object
+      # @param [Class] grouping_strategy class whose run method groups an array of uploads
       # @param [String] url the server to send to
       # @param [String] token the bearer auth token for the server
       # @param [Array<String>] files a list of file names to upload
+      # @param [Hash<String, Hash<String, String>>] files_metadata file name, hash of additional file metadata
+      # Additional metadata includes access, preserve, shelve, md5, sha1
       # @param [Logger] logger the logger to use
-      def initialize(metadata:, url:, token:, files: [], logger: Logger.new(STDOUT))
+      def initialize(metadata:, grouping_strategy: SingleFileGroupingStrategy, url:,
+                     token:, files: [], files_metadata: {}, logger: Logger.new(STDOUT))
         @files = files
         @url = url
         @token = token
         @metadata = metadata
         @logger = logger
+        @grouping_strategy = grouping_strategy
+        @files_metadata = files_metadata
       end
 
       def run
@@ -26,18 +32,19 @@ module SdrClient
         file_metadata = collect_file_metadata
         upload_responses = upload_file_metadata(file_metadata)
         upload_files(upload_responses)
-        request = metadata.with_uploads(upload_responses.values)
+        file_sets = build_filesets(uploads: upload_responses.values, files_metadata: files_metadata)
+        request = metadata.with_file_sets(file_sets)
         upload_metadata(request.as_json)
       end
 
       private
 
-      attr_reader :metadata, :files, :url, :token, :logger
+      attr_reader :metadata, :files, :url, :token, :logger, :grouping_strategy, :files_metadata
 
       def check_files_exist
         logger.info('checking to see if files exist')
         files.each do |file_name|
-          raise Errno::ENOENT, file_name unless File.exist?(file_name)
+          raise Errno::ENOENT, file_name unless ::File.exist?(file_name)
         end
       end
 
@@ -78,7 +85,7 @@ module SdrClient
         logger.info("Uploading `#{filename}' to #{url}")
 
         upload_response = connection.put(url) do |req|
-          req.body = File.open(filename)
+          req.body = ::File.open(filename)
           req.headers['Content-Type'] = content_type
           req.headers['Content-Length'] = content_length.to_s
         end
@@ -111,6 +118,18 @@ module SdrClient
           conn.adapter :net_http
         end
       end
+
+      # @param [Array<SdrClient::Deposit::Files::DirectUploadResponse>] uploads the uploaded files to attach.
+      # @param [Hash<String,Hash<String, String>>] files_metadata filename, hash of additional file metadata.
+      # @return [Array<SdrClient::Deposit::FileSet>] the uploads transformed to filesets
+      def build_filesets(uploads:, files_metadata:)
+        grouped_uploads = grouping_strategy.run(uploads: uploads)
+        grouped_uploads.each_with_index.map do |upload_group, i|
+          metadata_group = {}
+          upload_group.each { |upload| metadata_group[upload.filename] = files_metadata.fetch(upload.filename, {}) }
+          FileSet.new(uploads: upload_group, uploads_metadata: metadata_group, label: "Object #{i + 1}")
+        end
+      end
     end
   end
 end

data/lib/sdr_client/deposit/request.rb

@@ -6,21 +6,21 @@ module SdrClient
     class Request
       # @param [String] label the required object label
       # @param [String] type (http://cocina.sul.stanford.edu/models/object.jsonld) the required object type.
-      # @param [Array<SdrClient::Deposit::Files::DirectUploadResponse>] uploads the uploaded files to attach.
+      # @param [Array<FileSet>] file_sets the file sets to attach.
       def initialize(label: nil,
                      apo:,
                      collection:,
                      source_id:,
                      catkey: nil,
                      type: 'http://cocina.sul.stanford.edu/models/object.jsonld',
-                     uploads: [])
+                     file_sets: [])
         @label = label
         @type = type
         @source_id = source_id
         @collection = collection
         @catkey = catkey
         @apo = apo
-        @uploads = uploads
+        @file_sets = file_sets
       end
 
       def as_json
@@ -35,20 +35,20 @@ module SdrClient
         end
       end
 
-      # @return [Request] a clone of this request with the uploads added
-      def with_uploads(uploads)
+      # @return [Request] a clone of this request with the file_sets added
+      def with_file_sets(file_sets)
         Request.new(label: label,
                     apo: apo,
                     collection: collection,
                     source_id: source_id,
                     catkey: catkey,
                     type: type,
-                    uploads: uploads)
+                    file_sets: file_sets)
       end
 
       private
 
-      attr_reader :label, :uploads, :source_id, :catkey, :apo, :collection, :type
+      attr_reader :label, :file_sets, :source_id, :catkey, :apo, :collection, :type
 
       def administrative
         {
@@ -65,24 +65,9 @@ module SdrClient
       def structural
         {
           isMemberOf: collection,
-          hasMember: file_sets_as_json
+          hasMember: file_sets.map(&:as_json)
         }
       end
-
-      # In this case there is a 1-1 mapping between Files and FileSets,
-      # but this doesn't always have to be the case.  We could change this in the
-      # future so that we have one FileSet that has an Image and its OCR file.
-      def file_sets_as_json
-        uploads.map do |upload|
-          {
-            "type": 'http://cocina.sul.stanford.edu/models/fileset.jsonld',
-            label: upload.filename,
-            structural: {
-              hasMember: [upload.signed_id]
-            }
-          }
-        end
-      end
     end
   end
 end

data/lib/sdr_client/deposit/single_file_grouping_strategy.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # This strategy is for building one file set per uploaded file
+    class SingleFileGroupingStrategy
+      # @param [Array<SdrClient::Deposit::Files::DirectUploadResponse>] uploads the uploaded files to attach.
+      # @return [Array<Array<SdrClient::Deposit::Files::DirectUploadResponse>>] uploads the grouped uploaded files.
+      def self.run(uploads: [])
+        uploads.map { |upload| [upload] }
+      end
+    end
+  end
+end

data/lib/sdr_client/login.rb

@@ -4,19 +4,22 @@ module SdrClient
   # The namespace for the "login" command
   module Login
     LOGIN_PATH = '/v1/auth/login'
+    extend Dry::Monads[:result]
+
+    # @return [Result] the status of the call
     def self.run(url:, login_service: LoginPrompt)
       request_json = JSON.generate(login_service.run)
       response = Faraday.post(url + LOGIN_PATH, request_json, 'Content-Type' => 'application/json')
       case response.status
       when 200
         Credentials.write(response.body)
+        Success()
       when 400
-        puts 'Email address is not a valid email'
+        Failure('Email address is not a valid email')
       when 401
-        puts 'Invalid username or password'
+        Failure('Invalid username or password')
       else
-        puts "Status: #{response.status}"
-        puts response.body
+        Failure("Status: #{response.status}\n#{response.body}")
       end
     end
   end

data/lib/sdr_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SdrClient
-  VERSION = '0.2.0'
+  VERSION = '0.5.0'
 end

data/sdr-client.gemspec

@@ -27,7 +27,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', '~> 0.17.0'
+  spec.add_dependency 'dry-monads'
+  spec.add_dependency 'faraday', '>= 0.16'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-13 00:00:00.000000000 Z
+date: 2020-01-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -148,10 +162,14 @@ files:
 - lib/sdr_client/cli.rb
 - lib/sdr_client/credentials.rb
 - lib/sdr_client/deposit.rb
+- lib/sdr_client/deposit/file.rb
+- lib/sdr_client/deposit/file_set.rb
 - lib/sdr_client/deposit/files/direct_upload_request.rb
 - lib/sdr_client/deposit/files/direct_upload_response.rb
+- lib/sdr_client/deposit/matching_file_grouping_strategy.rb
 - lib/sdr_client/deposit/process.rb
 - lib/sdr_client/deposit/request.rb
+- lib/sdr_client/deposit/single_file_grouping_strategy.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
 - lib/sdr_client/version.rb