sdr-client 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a66643c6ea7e08e14f529c7e5396a5037ab39cae895fa65bb7ddf7a6d98ca93c
-  data.tar.gz: 7a7986eb90c7de9eb1f4b0335e4bae0981fe2679ac2317de2f66daaee92f141f
+  metadata.gz: 17915ecb6a7106d3236d893589e751def14fbaa53a79eb803a1695b3c71c1a00
+  data.tar.gz: 69d87e176f5989baffcafdd0312ba67a6e87df44bd13d5930113e2bbfe058917
 SHA512:
-  metadata.gz: 8fc2bb28ace65e03d8cf5336b080924a7ed6d2899cf5d2d54459b38b3d2849738cdaf9bee4fb8021a5b174f3062410748e20345cba9e10e42690995d4e0cd9f9
-  data.tar.gz: 4a3dcc3903a17266469c3ad2ca18c2d3fbb7ff57b1711b5753993a5202361d7cb9b526fbef9806a31daabcebc307cae4ba052b5f185bd6a34bfb75e694fbfd11
+  metadata.gz: febadce28e8d780c62461cf61264cd3080d6e8e56ea403f3586b6d1f918aec1a0f2679443cd08c125c881fdd139ca9067379a39e349f8af48a10d6fedd5df743
+  data.tar.gz: 692ce1e5c829206be38d645aca518496b1346cacc09810241ecf4d16d867088ec7f50cd93db312253f76c26d91e270815c70dfbcdb53811a708f71c34d0978d3

data/Gemfile.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    sdr-client (1.0.0)
+    sdr-client (2.0.1)
       activesupport
       cocina-models (~> 0.86.0)
+      config
       dry-monads
       faraday (>= 0.16)
+      launchy
 
 GEM
   remote: https://rubygems.org/
@@ -37,17 +39,25 @@ GEM
       zeitwerk (~> 2.1)
     commonmarker (0.23.6)
     concurrent-ruby (1.1.10)
+    config (4.1.0)
+      deep_merge (~> 1.2, >= 1.2.1)
+      dry-validation (~> 1.0, >= 1.0.0)
     crack (0.4.5)
       rexml
+    deep_merge (1.2.2)
     deprecation (1.1.0)
       activesupport
     diff-lcs (1.5.0)
     docile (1.4.0)
+    dry-configurable (1.0.1)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
     dry-core (1.0.0)
       concurrent-ruby (~> 1.0)
       zeitwerk (~> 2.6)
     dry-inflector (1.0.0)
-    dry-logic (1.4.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.5.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
@@ -55,6 +65,14 @@ GEM
       concurrent-ruby (~> 1.0)
       dry-core (~> 1.0, < 2)
       zeitwerk (~> 2.6)
+    dry-schema (1.13.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-logic (>= 1.5, < 2)
+      dry-types (>= 1.7, < 2)
+      zeitwerk (~> 2.6)
     dry-struct (1.6.0)
       dry-core (~> 1.0, < 2)
       dry-types (>= 1.7, < 2)
@@ -66,11 +84,17 @@ GEM
       dry-inflector (~> 1.0, < 2)
       dry-logic (>= 1.4, < 2)
       zeitwerk (~> 2.6)
+    dry-validation (1.10.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-schema (>= 1.12, < 2)
+      zeitwerk (~> 2.6)
     edtf (3.1.0)
       activesupport (>= 3.0, < 8.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    faraday (2.7.0)
+    faraday (2.7.2)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -78,29 +102,31 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.6.2)
+    json (2.6.3)
     jsonpath (1.1.2)
       multi_json
+    launchy (2.5.0)
+      addressable (~> 2.7)
     minitest (5.16.3)
     multi_json (1.15.0)
-    nokogiri (1.13.9-x86_64-darwin)
+    nokogiri (1.13.10-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.9-x86_64-linux)
+    nokogiri (1.13.10-x86_64-linux)
       racc (~> 1.4)
     openapi3_parser (0.9.2)
       commonmarker (~> 0.17)
     openapi_parser (0.15.0)
     optimist (3.0.1)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
     patience_diff (1.2.0)
       optimist (~> 3.0)
-    public_suffix (5.0.0)
-    racc (1.6.0)
+    public_suffix (5.0.1)
+    racc (1.6.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -111,7 +137,7 @@ GEM
     rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
@@ -119,7 +145,7 @@ GEM
       rspec-core (>= 2, < 4, != 2.12.0)
     rss (0.2.9)
       rexml
-    rubocop (1.39.0)
+    rubocop (1.40.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
@@ -129,7 +155,7 @@ GEM
       rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.23.0)
+    rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)

data/config/settings.yml

@@ -0,0 +1,4 @@
+authentication_proxy_url:
+  'https://sdr-api-prod.stanford.edu': 'https://argo.stanford.edu/settings/tokens'
+  'https://sdr-api-qa.stanford.edu': 'https://argo-qa.stanford.edu/settings/tokens'
+  'https://sdr-api-stage.stanford.edu': 'https://argo-stage.stanford.edu/settings/tokens'

data/exe/sdr

@@ -4,5 +4,6 @@
 $LOAD_PATH.unshift 'lib'
 
 require 'sdr_client'
+require 'sdr_client/cli'
 
 SdrClient::CLI.start(ARGV)

data/lib/sdr_client/cli/config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'config'
+
+Config.setup do |config|
+  # Name of the constant exposing loaded settings
+  config.const_name = 'Settings'
+
+  # Load environment variables from the `ENV` object and override any
+  # settings defined in files.
+  config.use_env = true
+
+  # Define ENV variable prefix deciding which variables to load into
+  # config.
+  config.env_prefix = 'SETTINGS'
+
+  # What string to use as level separator for settings loaded from ENV
+  # variables. Default value of '.' works well with Heroku, but you might
+  # want to change it for example for '__' to easy override settings from
+  # command line, where using dots in variable names might not be allowed
+  # (eg. Bash).
+  config.env_separator = '__'
+
+  # Ability to process variables names:
+  #   * nil  - no change
+  #   * :downcase - convert to lower case
+  config.env_converter = :downcase
+end
+
+Config.load_and_set_settings(
+  File.join(__dir__, '../../..', 'config/settings.yml')
+)

data/lib/sdr_client/cli.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require 'launchy'
 require 'thor'
+require_relative 'cli/config'
 
 module SdrClient
   # The SDR command-line interface
@@ -31,32 +33,19 @@ module SdrClient
 
     desc 'get DRUID', 'Retrieve an object from the SDR'
     def get(druid)
-      say SdrClient::Find.run(druid, url: options[:url], logger: Logger.new($stderr))
-    rescue SdrClient::Credentials::NoCredentialsError
-      say_error 'Log in first'
-      exit(1)
+      rescue_expected_exceptions do
+        say Find.run(druid, url: options[:url], logger: Logger.new($stderr))
+      end
     end
 
-    desc 'login', 'Prompt for email & password and create a login token (saved in ~/.sdr/token)'
+    desc 'login', 'Open authentication proxy UI, or prompt for username and password, and then prompt for token (saved in ~/.sdr/credentials)'
     def login
-      status = SdrClient::Login.run(
-        url: options[:url],
-        login_service: lambda do
-          {
-            email: ask('Email:'),
-            password: ask('Password:', echo: false)
-          }
-        end
-      )
-      return puts unless status.failure?
-
-      say_error status.failure
-      exit(1)
+      authentication_proxy_url ? login_via_proxy : login_via_credentials
     end
 
     desc 'version', 'Display the SDR CLI version'
     def version
-      say SdrClient::VERSION
+      say VERSION
     end
 
     desc 'update DRUID', 'Update an object in the SDR'
@@ -74,12 +63,11 @@ module SdrClient
     option :cocina_pipe, type: :boolean, default: false, desc: 'Indicate Cocina JSON is being piped in'
     option :basepath, default: Dir.getwd, desc: 'Base path for the files'
     def update(druid)
-      validate_druid!(druid)
-      job_id = SdrClient::Update.run(druid, **options)
-      poll_for_job_complete(job_id: job_id, url: options[:url])
-    rescue SdrClient::Credentials::NoCredentialsError
-      say_error 'Log in first'
-      exit(1)
+      rescue_expected_exceptions do
+        validate_druid!(druid)
+        job_id = Update.run(druid, **options)
+        poll_for_job_complete(job_id: job_id, url: options[:url])
+      end
     end
 
     desc 'deposit OPTIONAL_FILES', 'Deposit (accession) an object into the SDR'
@@ -122,16 +110,63 @@ module SdrClient
 
     private
 
-    def register_or_deposit(files:, accession:)
-      opts = munge_options(options, files)
-      skip_polling = opts.delete(:skip_polling)
-      job_id = SdrClient::Deposit.run(accession: accession, **opts)
-      return if skip_polling
-
-      poll_for_job_complete(job_id: job_id, url: opts[:url])
-    rescue SdrClient::Credentials::NoCredentialsError
-      say_error 'Log in first'
+    def rescue_expected_exceptions
+      yield
+    rescue UnexpectedResponse::TokenExpired
+      say_error 'Token has expired! Please log in again.'
       exit(1)
+    rescue Credentials::NoCredentialsError
+      say_error 'No token found! Please log in first.'
+      exit(1)
+    end
+
+    def login_via_proxy
+      say 'Opened the configured authentication proxy in your browser. Once there, generate a new token and copy the entire value.'
+      Launchy.open(authentication_proxy_url)
+      # Some CLI environments will pop up a message about opening the URL in
+      # an existing browse. Since this is OS-dependency, and not something
+      # we can control via Launchy, just wait a bit before rendering the
+      # `ask` prompt so it's clearer to the user what's happening
+      sleep 0.5
+      token_string = ask('Paste token here:')
+      Credentials.write(token_string)
+      expiry = JSON.parse(token_string)['exp']
+      say "You are now authenticated for #{options[:url]} until #{expiry}"
+    rescue StandardError => e
+      say_error "Error logging in via proxy: #{e}"
+      exit(1)
+    end
+
+    def login_via_credentials
+      status = Login.run(
+        url: options[:url],
+        login_service: lambda do
+          {
+            email: ask('Email:'),
+            password: ask('Password:', echo: false)
+          }
+        end
+      )
+
+      return puts unless status.failure?
+
+      say_error status.failure
+      exit(1)
+    end
+
+    def authentication_proxy_url
+      @authentication_proxy_url ||= Settings.authentication_proxy_url[options[:url]]
+    end
+
+    def register_or_deposit(files:, accession:)
+      rescue_expected_exceptions do
+        opts = munge_options(options, files)
+        skip_polling = opts.delete(:skip_polling)
+        job_id = Deposit.run(accession: accession, **opts)
+        return if skip_polling
+
+        poll_for_job_complete(job_id: job_id, url: opts[:url])
+      end
     end
 
     def munge_options(options, files)
@@ -141,9 +176,9 @@ module SdrClient
         opts[:files_metadata] = JSON.parse(options[:files_metadata]) if options[:files_metadata]
         if options[:grouping_strategy]
           opts[:grouping_strategy] = if options[:grouping_strategy] == 'filename'
-                                       SdrClient::Deposit::MatchingFileGroupingStrategy
+                                       Deposit::MatchingFileGroupingStrategy
                                      else
-                                       SdrClient::Deposit::SingleFileGroupingStrategy
+                                       Deposit::SingleFileGroupingStrategy
                                      end
         end
       end
@@ -161,7 +196,7 @@ module SdrClient
       say('SDR is processing your request.', nil, false)
       result = nil
       1.upto(60) do
-        result = SdrClient::BackgroundJobResults.show(url: url, job_id: job_id)
+        result = BackgroundJobResults.show(url: url, job_id: job_id)
         break unless %w[pending processing].include?(result['status'])
 
         # the extra args to `say` prevent appending a newline

data/lib/sdr_client/deposit.rb

@@ -101,7 +101,6 @@ require 'sdr_client/deposit/request'
 require 'sdr_client/deposit/metadata_builder'
 require 'sdr_client/deposit/model_process'
 require 'sdr_client/deposit/process'
-require 'sdr_client/deposit/unexpected_response'
 require 'sdr_client/deposit/update_resource'
 require 'sdr_client/deposit/update_dro_with_file_identifiers'
 require 'sdr_client/deposit/upload_files'

data/lib/sdr_client/find.rb

@@ -7,9 +7,6 @@ module SdrClient
   module Find
     DRO_PATH = '/v1/resources/%<id>s'
 
-    # Raised when find returns an unsuccessful response
-    class Failed < StandardError; end
-
     # @raise [Failed] if the find operation fails
     # @return [String] JSON for the given Cocina object or an error
     def self.run(druid, url:, logger: Logger.new($stdout))
@@ -17,12 +14,10 @@ module SdrClient
       path = format(DRO_PATH, id: druid)
       logger.info("Retrieving metadata from: #{path}")
       response = connection.get(path)
-      unless response.success?
-        error_message = "There was an HTTP #{response.status} error making the request: #{response.body}"
-        logger.error(error_message)
-        raise Failed, error_message
-      end
-      response.body
+      return response.body if response.success?
+
+      logger.error("There was an HTTP #{response.status} error making the request: #{response.body}")
+      UnexpectedResponse.call(response)
     end
   end
 end

data/lib/sdr_client/unexpected_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SdrClient
+  # Handles unexpected responses
+  class UnexpectedResponse
+    # Raised when there is a request error (e.g.: a cocina-models version mismatch)
+    class BadRequest < StandardError; end
+    # Raised when there is a problem with the credentials
+    class Unauthorized < StandardError; end
+    # Raised when there is an expired token
+    class TokenExpired < StandardError; end
+
+    # @param [Faraday::Response] response
+    def self.call(response)
+      case response.status
+      when 400
+        raise BadRequest, "There was an error with your request: #{response.body}"
+      when 401
+        raise TokenExpired, 'Your token has expired' if response.body.match?('Signature has expired')
+
+        raise Unauthorized, 'There was an error with your credentials.'
+      else
+        raise "unexpected response: #{response.status} #{response.body}"
+      end
+    end
+  end
+end

data/lib/sdr_client/version.rb

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

data/lib/sdr_client.rb

@@ -9,13 +9,13 @@ require 'active_support/core_ext/file/atomic'
 require 'cocina/models'
 
 require 'sdr_client/version'
+require 'sdr_client/unexpected_response'
 require 'sdr_client/deposit'
 require 'sdr_client/update'
 require 'sdr_client/credentials'
 require 'sdr_client/find'
 require 'sdr_client/login'
 require 'sdr_client/login_prompt'
-require 'sdr_client/cli'
 require 'sdr_client/connection'
 require 'sdr_client/background_job_results'
 

data/sdr-client.gemspec

@@ -29,8 +29,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'cocina-models', '~> 0.86.0'
+  spec.add_dependency 'config'
   spec.add_dependency 'dry-monads'
   spec.add_dependency 'faraday', '>= 0.16'
+  spec.add_dependency 'launchy'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Justin Coyne
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.86.0
+- !ruby/object:Gem::Dependency
+  name: config
+  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: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -215,12 +243,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/settings.yml
 - exe/remove_w3cdtf_encoding_from_event_dates
 - exe/sdr
 - lib/sdr-client.rb
 - lib/sdr_client.rb
 - lib/sdr_client/background_job_results.rb
 - lib/sdr_client/cli.rb
+- lib/sdr_client/cli/config.rb
 - lib/sdr_client/connection.rb
 - lib/sdr_client/credentials.rb
 - lib/sdr_client/deposit.rb
@@ -241,7 +271,6 @@ files:
 - lib/sdr_client/deposit/process.rb
 - lib/sdr_client/deposit/request.rb
 - lib/sdr_client/deposit/single_file_grouping_strategy.rb
-- lib/sdr_client/deposit/unexpected_response.rb
 - lib/sdr_client/deposit/update_dro_with_file_identifiers.rb
 - lib/sdr_client/deposit/update_resource.rb
 - lib/sdr_client/deposit/upload_files.rb
@@ -249,6 +278,7 @@ files:
 - lib/sdr_client/find.rb
 - lib/sdr_client/login.rb
 - lib/sdr_client/login_prompt.rb
+- lib/sdr_client/unexpected_response.rb
 - lib/sdr_client/update.rb
 - lib/sdr_client/version.rb
 - sdr-client.gemspec
@@ -259,7 +289,7 @@ metadata:
   source_code_uri: https://github.com/sul-dlss/sdr-client
   changelog_uri: https://github.com/sul-dlss/sdr-client/releases
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -274,8 +304,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.2.32
+signing_key: 
 specification_version: 4
 summary: The CLI for https://github.com/sul-dlss/sdr-api
 test_files: []

data/lib/sdr_client/deposit/unexpected_response.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module SdrClient
-  module Deposit
-    # Handles unexpected responses when manipulating resources
-    class UnexpectedResponse
-      # Raised when there is a request error (e.g.: a cocina-models version mismatch)
-      class BadRequest < StandardError; end
-      # Raised when there is a problem with the credentials
-      class Unauthorized < StandardError; end
-
-      # @param [Faraday::Response] response
-      def self.call(response)
-        case response.status
-        when 400
-          raise BadRequest, "There was an error with your request: #{response.body}"
-        when 401
-          raise Unauthorized, 'There was an error with your credentials. Perhaps they have expired?'
-        else
-          raise "unexpected response: #{response.status} #{response.body}"
-        end
-      end
-    end
-  end
-end