sdr-client 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c716a01e8ec4c6fc081a8faa3be231bcd39c3da6481efaa43f7f04248aa717c
-  data.tar.gz: b69d8f2c2942abb198764eab8025250c0dbd018580e8a535ebafc4b2fc2f2634
+  metadata.gz: 80a6d11a266d546eb1e0763b99b13b18d9f64c558ef21db50f3f509623a4f4bf
+  data.tar.gz: 5ec2344617583af3322f0426e39328aee355ee4c12d7338d8734f529110e8da6
 SHA512:
-  metadata.gz: 44884b0decb3af139e287b932110aa614bde3892f692d22528adceee0b02bdf4a966c30abbca6c2a81e755a32fc3189b66de89c8899bae77f64ea30b356cdb81
-  data.tar.gz: f38600d5355545f23acac4e89ee546f46d90c80cedf30b7becb4b8eac2bc1e3ffead361d2aa343fb67fc01eb9845f1bbd0da9a58bbdee7afd3fb4c5aa8cf23ba
+  metadata.gz: 3a145ef20a1c42abaed33ab79746778844e922b530a6c48d1b7f6d6f50a0e5a2c3f23e15a804fc5b75b3baeaac6baa4e67b35391965b5bb5da34892b345c9805
+  data.tar.gz: 2600c209c4f35f2ab7a8d7209189c690ec8f06de819666fd7bdd38f63290b997aa87355d54c7a5b5b2e4633ecfd02f75e908815923c2f44116373a999789bf68

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

@@ -25,5 +25,7 @@ end
 require 'json'
 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,33 @@
+# 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)
+        @external_identifier = external_identifier
+        @label = label
+        @filename = filename
+        @access = access
+        @preserve = preserve
+        @shelve = shelve
+      end
+
+      def as_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
+          }
+        }
+      end
+    end
+  end
+end

data/lib/sdr_client/deposit/file_set.rb

@@ -0,0 +1,31 @@
+# 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: [], files: [])
+        @files = if !uploads.empty?
+                   uploads.map do |upload|
+                     File.new(external_identifier: upload.signed_id, label: upload.filename, filename: upload.filename)
+                   end
+                 else
+                   files
+                 end
+      end
+
+      def as_json
+        {
+          "type": 'http://cocina.sul.stanford.edu/models/fileset.jsonld',
+          structural: {
+            hasMember: files.map(&:as_json)
+          }
+        }
+      end
+
+      private
+
+      attr_reader :files
+    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/process.rb

@@ -37,7 +37,7 @@ module SdrClient
       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 +78,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

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,28 @@ module SdrClient
         end
       end
 
+      # @param [Array<SdrClient::Deposit::Files::DirectUploadResponse>] uploads the uploaded files to attach.
       # @return [Request] a clone of this request with the uploads added
       def with_uploads(uploads)
+        file_sets = uploads.map { |upload| FileSet.new(uploads: [upload]) }
+
         Request.new(label: label,
                     apo: apo,
                     collection: collection,
                     source_id: source_id,
                     catkey: catkey,
                     type: type,
-                    uploads: uploads)
+                    file_sets: file_sets)
       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 add_uploads_each_as_resource(uploads); 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 +73,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/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.1'
+  VERSION = '0.3.0'
 end

data/sdr-client.gemspec

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-13 00:00:00.000000000 Z
+date: 2020-01-23 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
@@ -148,6 +162,8 @@ 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/process.rb