sdr-client 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97ae47ce6b50c4fd12228990d25dc3fb63432ba1a1e0fff9a1e614dece546c69
-  data.tar.gz: f64a044b2373cda941ec7fe593d2eacc1602a6178963cf80c0637415ecded9f4
+  metadata.gz: b1d76c1422877b6b5f25f0a1cb46641e32771496771576f8f7c8fd2697c14b0e
+  data.tar.gz: eb116e73a114a3966254a0996c5d843fc960e1454146214ca68fae11eff89bda
 SHA512:
-  metadata.gz: c573233fcff72bb1c1402d170d048b03182ac7dd45c81a7531dd02529869f2354c9d73bd8522cbb1ba463c52bb933cf692a67e3b7932c77f3746bf2276253913
-  data.tar.gz: '0848314bb1fd0b02ca2add9e09c92185fbcf8d9db642d683fcb116dae2cbd7ca6df97d5e9e3464f4b2ab71fa1027eda3d67d07723b50bf3ffc6f08274590f649'
+  metadata.gz: acf219c807f4f22f87437f779cf4d3ab2bb8091bc810a616146a302a9e2bab4b5be99685c91ea072056344a59b5b0f37e9ed5008105d836078d1b70032720c75
+  data.tar.gz: b6ec07336e2014a6fbf02470c08649c426384a51c40ee32a164f29c96ab75cd2057615ee5ee8081f7a70f406f794fed6c100fb93aba7848d629e8933fa91f589

data/.rubocop_todo.yml

@@ -1,22 +1,21 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-01-07 23:33:21 -0800 using RuboCop version 0.79.0.
+# on 2020-01-10 17:16:01 -0600 using RuboCop version 0.79.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
-Layout/ExtraSpacing:
-  Exclude:
-    - 'sdr-client.gemspec'
+Metrics/AbcSize:
+  Max: 16
 
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment, EnforcedStyleForExponentOperator.
-# SupportedStylesForExponentOperator: space, no_space
-Layout/SpaceAroundOperators:
-  Exclude:
-    - 'sdr-client.gemspec'
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 2
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 8

data/.travis.yml

@@ -13,5 +13,8 @@ before_script:
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 
+env:
+  global:
+    - CC_TEST_REPORTER_ID=859fcfe88b00c026d15dce30e838e2299face8088b49fe62bc3a02d1507ce3d5
 notifications:
   email: false

data/README.md

@@ -8,9 +8,22 @@
 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:
+```
+sdr --service-url http://sdr-api-server:3000 login
+```
+
+
 Deposit a new object:
 ```
-sdr --service-url http://sdr-api-server:3000 deposit --label 'hey there' file1.png file2.png
+sdr --service-url https://sdr-api-server:3000 deposit --label 'hey there' \
+  --admin-policy 'druid:bk123gh4567' \
+  --collection 'druid:gh456kw9876' \
+  --source-id 'googlebooks:stanford_12345' file1.png file2.png
 ```

data/exe/sdr

@@ -10,7 +10,28 @@ global = OptionParser.new do |opts|
     options[:url] = url
   end
   opts.on('-h', '--help', 'Display this screen') do
-    puts opts
+    puts <<~HELP
+      DESCRIPTION:
+        The SDR Command Line Interface is a tool to interact with the Stanford Digital Repository.
+
+      SYNOPSIS:
+        sdr [options] <command>
+
+      OPTIONS:
+        --service-url (string)
+        Override the command's default URL with the given URL.
+
+        -h, --help
+        Displays this screen
+
+      COMMANDS
+        deposit
+        deposit files to the SDR
+
+        login
+        Will prompt for email & password and exchange it for an login token, which it saves in ~/.sdr/token
+
+    HELP
     exit
   end
 end
@@ -23,11 +44,28 @@ subcommands = {
     opts.on('--label LABEL', 'The object label') do |label|
       options[:label] = label
     end
+
+    opts.on('--admin-policy ADMIN_POLICY', 'The druid identifier of the admin policy object') do |apo|
+      options[:apo] = apo
+    end
+    opts.on('--collection COLLECTION', 'The druid identifier of the collection object') do |collection|
+      options[:collection] = collection
+    end
+
+    opts.on('--catkey CATKEY', 'The catkey for this item') do |catkey|
+      options[:catkey] = catkey
+    end
+
+    opts.on('--source-id SOURCE_ID', 'The source id for this object') do |source_id|
+      options[:source_id] = source_id
+    end
+
     opts.on('-h', '--help', 'Display this screen') do
       puts opts
       exit
     end
-  end
+  end,
+  'login' => OptionParser.new
 }
 
 unless subcommands.key?(command)

data/lib/sdr_client.rb

@@ -1,9 +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

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

data/lib/sdr_client/credentials.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SdrClient
+  # The stored credentials
+  class Credentials
+    # @param [String] a json string that contains a field 'token'
+    def self.write(body)
+      json = JSON.parse(body)
+      Dir.mkdir(credentials_path, 0o700) unless Dir.exist?(credentials_path)
+      File.open(credentials_file, 'w', 0o600) do |file|
+        file.write(json.fetch('token'))
+      end
+      puts 'Signed in.'
+    end
+
+    def self.read
+      return IO.readlines(credentials_file, chomp: true).first if ::File.exist?(credentials_file)
+
+      puts 'Log in first'
+      exit(1)
+    end
+
+    def self.credentials_path
+      @credentials_path ||= File.join(Dir.home, '.sdr')
+    end
+
+    def self.credentials_file
+      File.join(credentials_path, 'credentials')
+    end
+  end
+end

data/lib/sdr_client/deposit.rb

@@ -3,15 +3,30 @@
 module SdrClient
   # The namespace for the "deposit" command
   module Deposit
-    def self.run(label:,
+    def self.run(label: nil,
                  type: 'http://cocina.sul.stanford.edu/models/book.jsonld',
+                 apo:,
+                 collection:,
+                 catkey: nil,
+                 source_id:,
                  url:, files: [])
-      Process.new(label: label, type: type, url: url, files: files).run
+      token = Credentials.read
+
+      metadata = Request.new(label: label,
+                             type: type,
+                             apo: apo,
+                             collection: collection,
+                             source_id: source_id,
+                             catkey: catkey)
+      Process.new(metadata: metadata, url: url, token: token, files: files).run
     end
   end
 end
 require 'json'
+require 'sdr_client/deposit/default_file_set_builder'
 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/default_file_set_builder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SdrClient
+  module Deposit
+    # This strategy is for building one file set per uploaded file
+    class DefaultFileSetBuilder
+      # @return [Request] request The initial request
+      # @param [Array<SdrClient::Deposit::Files::DirectUploadResponse>] uploads the uploaded files to attach.
+      # @return [Request] a clone of this request with the uploads added
+      def self.run(request:, uploads: [])
+        file_sets = uploads.each_with_index.map do |upload, i|
+          FileSet.new(uploads: [upload], label: "Object #{i + 1}")
+        end
+        request.with_file_sets(file_sets)
+      end
+    end
+  end
+end

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,33 @@
+# 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: [], label:)
+        @label = label
+        @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',
+          "label": label,
+          structural: {
+            hasMember: files.map(&:as_json)
+          }
+        }
+      end
+
+      private
+
+      attr_reader :files, :label
+    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

@@ -6,14 +6,22 @@ module SdrClient
   module Deposit
     # The process for doing a deposit
     class Process
-      BLOB_PATH = '/rails/active_storage/direct_uploads'
+      BLOB_PATH = '/v1/direct_uploads'
       DRO_PATH = '/v1/resources'
-      def initialize(label:, type:, url:, files: [], logger: Logger.new(STDOUT))
-        @label = label
-        @type = type
+      # @param [Request] metadata information about the object
+      # @param [#build] file_set_builder a strategy for constructing FileSets
+      # @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 [Logger] logger the logger to use
+      def initialize(metadata:, file_set_builder: DefaultFileSetBuilder, url:,
+                     token:, files: [], logger: Logger.new(STDOUT))
         @files = files
         @url = url
+        @token = token
+        @metadata = metadata
         @logger = logger
+        @file_set_builder = file_set_builder
       end
 
       def run
@@ -21,20 +29,18 @@ module SdrClient
         file_metadata = collect_file_metadata
         upload_responses = upload_file_metadata(file_metadata)
         upload_files(upload_responses)
-        metadata = Request.new(label: label,
-                               type: type,
-                               uploads: upload_responses.values)
-        upload_metadata(metadata.as_json)
+        request = file_set_builder.run(request: metadata, uploads: upload_responses.values)
+        upload_metadata(request.as_json)
       end
 
       private
 
-      attr_reader :label, :type, :files, :url, :logger
+      attr_reader :metadata, :files, :url, :token, :logger, :file_set_builder
 
       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
 
@@ -51,7 +57,7 @@ module SdrClient
 
       def direct_upload(metadata_json)
         logger.info("Starting an upload request: #{metadata_json}")
-        response = Faraday.post(url + BLOB_PATH, metadata_json, 'Content-Type' => 'application/json')
+        response = connection.post(BLOB_PATH, metadata_json, 'Content-Type' => 'application/json')
         raise "unexpected response: #{response.inspect}" unless response.status == 200
 
         logger.info("Response from server: #{response.body}")
@@ -73,11 +79,9 @@ module SdrClient
 
       def upload_file(filename:, url:, content_type:, content_length:)
         logger.info("Uploading `#{filename}' to #{url}")
-        conn = Faraday.new(url) do |builder|
-          builder.adapter :net_http
-        end
-        upload_response = conn.put(url) do |req|
-          req.body = File.open(filename)
+
+        upload_response = connection.put(url) do |req|
+          req.body = ::File.open(filename)
           req.headers['Content-Type'] = content_type
           req.headers['Content-Length'] = content_length.to_s
         end
@@ -85,15 +89,30 @@ module SdrClient
         raise "unexpected response: #{upload_response.inspect}" unless upload_response.status == 204
       end
 
+      # @return [Hash<Symbol,String>] the result of the metadata call
       def upload_metadata(metadata)
         logger.info("Starting upload metadata: #{metadata}")
         request_json = JSON.generate(metadata)
-        response = Faraday.post(url + DRO_PATH, request_json, 'Content-Type' => 'application/json')
-        raise "unexpected response: #{response.inspect}" unless response.status == 200
+        response = connection.post(DRO_PATH, request_json, 'Content-Type' => 'application/json')
+        unexpected_response(response) unless response.status == 201
 
         logger.info("Response from server: #{response.body}")
 
-        JSON.parse(response.body)
+        { druid: JSON.parse(response.body)['druid'], background_job: response.headers['Location'] }
+      end
+
+      def unexpected_response(response)
+        raise "unexpected response: #{response.inspect}" unless response.status == 400
+
+        puts "\nThere was an error with your request: #{response.body}"
+        exit(1)
+      end
+
+      def connection
+        @connection ||= Faraday.new(url: url) do |conn|
+          conn.authorization :Bearer, token
+          conn.adapter :net_http
+        end
       end
     end
   end

data/lib/sdr_client/deposit/request.rb

@@ -4,49 +4,70 @@ module SdrClient
   module Deposit
     # This represents the metadata that we send to the server for doing a deposit
     class Request
-      CONTEXT = 'http://cocina.sul.stanford.edu/contexts/cocina-base.jsonld'
-
       # @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.
-      def initialize(label:,
+      # @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
-        @uploads = uploads
+        @source_id = source_id
+        @collection = collection
+        @catkey = catkey
+        @apo = apo
+        @file_sets = file_sets
       end
 
       def as_json
         {
-          "@context": CONTEXT,
-          "@type": type,
-          label: label,
-          structural: {
-            hasMember: file_sets_as_json
-          }
-        }
+          access: {},
+          type: type,
+          administrative: administrative,
+          identification: identification,
+          structural: structural
+        }.tap do |json|
+          json[:label] = label if label
+        end
+      end
+
+      # @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,
+                    file_sets: file_sets)
       end
 
       private
 
-      attr_reader :label, :uploads, :type
-
-      # 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|
-          {
-            "@context": CONTEXT,
-            "@type": 'http://cocina.sul.stanford.edu/models/fileset.jsonld',
-            label: upload.filename,
-            structural: {
-              hasMember: [upload.signed_id]
-            }
-          }
+      attr_reader :label, :file_sets, :source_id, :catkey, :apo, :collection, :type
+
+      def administrative
+        {
+          hasAdminPolicy: apo
+        }
+      end
+
+      def identification
+        { sourceId: source_id }.tap do |json|
+          json[:catkey] = catkey if catkey
         end
       end
+
+      def structural
+        {
+          isMemberOf: collection,
+          hasMember: file_sets.map(&:as_json)
+        }
+      end
     end
   end
 end

data/lib/sdr_client/login.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+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
+        Failure('Email address is not a valid email')
+      when 401
+        Failure('Invalid username or password')
+      else
+        Failure("Status: #{response.status}\n#{response.body}")
+      end
+    end
+  end
+end

data/lib/sdr_client/login_prompt.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'io/console'
+
+module SdrClient
+  # The namespace for the "login" command
+  module LoginPrompt
+    def self.run
+      print 'Email: '
+      email = gets
+      email.strip!
+      print 'Password: '
+      password = $stdin.noecho(&:gets)
+      password.strip!
+      puts
+      { email: email, password: password }
+    end
+  end
+end

data/lib/sdr_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SdrClient
-  VERSION = '0.1.0'
+  VERSION = '0.4.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.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-01-24 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
@@ -146,11 +160,17 @@ files:
 - exe/sdr
 - lib/sdr_client.rb
 - lib/sdr_client/cli.rb
+- lib/sdr_client/credentials.rb
 - lib/sdr_client/deposit.rb
+- lib/sdr_client/deposit/default_file_set_builder.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
 - lib/sdr_client/deposit/request.rb
+- lib/sdr_client/login.rb
+- lib/sdr_client/login_prompt.rb
 - lib/sdr_client/version.rb
 - sdr-client.gemspec
 homepage: https://github.com/sul-dlss/sdr-client
@@ -174,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The CLI for https://github.com/sul-dlss/sdr-api