sdr-client 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dab3e033cd3f0fd0eae7045c3565f7c24300d99ebcd7141777eb0d005847497
-  data.tar.gz: 25a76561f9aafdcc4a575030ca9bb750e8cdf036b60c14cc92f413bbde4668d2
+  metadata.gz: 52457756d6413fcbb3d78c6778e705dd000f73d4bfd9be51b4455c91f861f2cf
+  data.tar.gz: 2e3fbb925f332ddbf6f70a011f708ed659bb768bf3cea618e3b40cea70b7e1a8
 SHA512:
-  metadata.gz: fa6080f541ce480fc8ca31f5f063404090235e8edce6849aa10c4f50f1a00ef83a166ea1c97ad579e094fbf9b5d8f24df73debc68ce567e1a7886dc7a491b643
-  data.tar.gz: a915029ed2f58221fe4c2418e8fef194f11eb6bde24af289dc9f52da438841a4bab90fec7a95a94eeaa22334e2e72897a6047f01c5909ed995d371473b1c0295
+  metadata.gz: cdaa5ce7b1c83361d33911f02191d4a34c97c24113ffc01e4594a2300b966ef7b0ff399ea56ee033650be0eb808dd3a363dbf04357c2e124ebfe378d78a69459
+  data.tar.gz: 238c7ff0047034134d1a3c4421bed157e09b97692ec6d57226edfc2e4e5ef0a7be3a88a39b9c10f816ae6e53dc7f44d10dea7d38a1f7424bb9a6a5c9b3ea7fd2

data/README.md

@@ -21,8 +21,15 @@ Log in:
 sdr --service-url http://sdr-api-server:3000 login
 ```
 
+Register a new object:
+```
+sdr --service-url https://sdr-api-server:3000 register --label 'hey there' \
+  --admin-policy 'druid:bk123gh4567' \
+  --collection 'druid:gh456kw9876' \
+  --source-id 'googlebooks:stanford_12345' file1.png file2.png
+```
 
-Deposit a new object:
+Deposit (register + accession) a new object:
 ```
 sdr --service-url https://sdr-api-server:3000 deposit --label 'hey there' \
   --admin-policy 'druid:bk123gh4567' \

data/exe/sdr

@@ -27,7 +27,10 @@ global = OptionParser.new do |opts|
 
       COMMANDS
         deposit
-        deposit files to the SDR
+        accession object into the SDR
+
+        register
+        create a draft object in SDR
 
         login
         Will prompt for email & password and exchange it for an login token, which it saves in ~/.sdr/token
@@ -40,77 +43,80 @@ end
 global.order!
 command = ARGV.shift
 
-subcommands = {
-  'deposit' => OptionParser.new do |opts|
-    opts.on('--label LABEL', 'The object label') do |label|
-      options[:label] = label
-    end
+deposit_options = OptionParser.new do |opts|
+  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('--admin-policy ADMIN_POLICY', 'The druid identifier of the admin policy object') do |apo|
+    options[:apo] = apo
+  end
 
-    opts.on('--type TYPE', 'The object type to create. ' \
-            'One of: "image", "book", "document", "map", "manuscript", "media", ' \
-            '"three_dimensional", "collection", or "admin_policy"') do |type|
-      if %w[image book document map manuscript media three_dimensional collection admin_policy].include?(type)
-        options[:type] = "http://cocina.sul.stanford.edu/models/#{type}.jsonld"
-      end
+  opts.on('--type TYPE', 'The object type to create. ' \
+          'One of: "image", "book", "document", "map", "manuscript", "media", ' \
+          '"three_dimensional", "collection", or "admin_policy"') do |type|
+    if %w[image book document map manuscript media three_dimensional collection admin_policy].include?(type)
+      options[:type] = "http://cocina.sul.stanford.edu/models/#{type}.jsonld"
     end
+  end
 
-    opts.on('--collection COLLECTION', 'The druid identifier of the collection object') do |collection|
-      options[:collection] = collection
-    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('--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('--source-id SOURCE_ID', 'The source id for this object') do |source_id|
+    options[:source_id] = source_id
+  end
 
-    opts.on('--copyright COPYRIGHT', 'The copyright statement') do |copyright|
-      options[:copyright] = copyright
-    end
+  opts.on('--copyright COPYRIGHT', 'The copyright statement') do |copyright|
+    options[:copyright] = copyright
+  end
 
-    opts.on('--use-statement STATEMENT', 'The use and reproduction statement') do |use_statement|
-      options[:use_statement] = use_statement
-    end
+  opts.on('--use-statement STATEMENT', 'The use and reproduction statement') do |use_statement|
+    options[:use_statement] = use_statement
+  end
 
-    opts.on('--viewing-direction DIRECTION', 'The viewing direction (if a book). ' \
-            'Either "left-to-right" or "right-to-left"') do |viewing_direction|
-      options[:viewing_direction] = viewing_direction if %w[left-to-right right-to-left].include?(viewing_direction)
-    end
+  opts.on('--viewing-direction DIRECTION', 'The viewing direction (if a book). ' \
+          'Either "left-to-right" or "right-to-left"') do |viewing_direction|
+    options[:viewing_direction] = viewing_direction if %w[left-to-right right-to-left].include?(viewing_direction)
+  end
 
-    opts.on('--access LEVEL', 'The access level for this object. ' \
-            'Either "world", "stanford", "location-based", "citation-only" or "dark"') do |level|
-      options[:access] = level if %w[world stanford location-based citation-only dark].include?(level)
-    end
+  opts.on('--access LEVEL', 'The access level for this object. ' \
+          'Either "world", "stanford", "location-based", "citation-only" or "dark"') do |level|
+    options[:access] = level if %w[world stanford location-based citation-only dark].include?(level)
+  end
 
-    opts.on('--files-metadata FILES_METADATA', 'A JSON object representing per-file metadata') do |files_metadata|
-      options[:files_metadata] = JSON.parse(files_metadata)
-    end
+  opts.on('--files-metadata FILES_METADATA', 'A JSON object representing per-file metadata') do |files_metadata|
+    options[:files_metadata] = JSON.parse(files_metadata)
+  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('--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
-    end
-  end,
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+end
+
+subcommands = {
+  'deposit' => deposit_options,
+  'register' => deposit_options,
   'login' => OptionParser.new
 }
 

data/lib/sdr_client/cli.rb

@@ -6,7 +6,9 @@ module SdrClient
     def self.start(command, options)
       case command
       when 'deposit'
-        SdrClient::Deposit.run(options)
+        SdrClient::Deposit.run(accession: true, **options)
+      when 'register'
+        SdrClient::Deposit.run(accession: false, **options)
       when 'login'
         status = SdrClient::Login.run(options)
         puts status.value if status.failure?

data/lib/sdr_client/deposit.rb

@@ -23,6 +23,7 @@ module SdrClient
                  url:,
                  files: [],
                  files_metadata: {},
+                 accession: false,
                  grouping_strategy: SingleFileGroupingStrategy,
                  logger: Logger.new(STDOUT))
       augmented_metadata = FileMetadataBuilder.build(files: files, files_metadata: files_metadata)
@@ -41,7 +42,9 @@ module SdrClient
                              files_metadata: augmented_metadata)
       connection = Connection.new(url: url)
       Process.new(metadata: metadata, connection: connection, files: files,
-                  grouping_strategy: grouping_strategy, logger: logger).run
+                  grouping_strategy: grouping_strategy,
+                  accession: accession,
+                  logger: logger).run
     end
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/ParameterLists

data/lib/sdr_client/deposit/process.rb

@@ -11,15 +11,20 @@ module SdrClient
       # @param [Class] grouping_strategy class whose run method groups an array of uploads
       # @param [String] connection the server connection to use
       # @param [Array<String>] files a list of file names to upload
+      # @param [Boolean] accession should the accessionWF be started
       # @param [Logger] logger the logger to use
+      #
+      # rubocop:disable Metrics/ParameterLists
       def initialize(metadata:, grouping_strategy: SingleFileGroupingStrategy,
-                     connection:, files: [], logger: Logger.new(STDOUT))
+                     connection:, files: [], accession:, logger: Logger.new(STDOUT))
         @files = files
         @connection = connection
         @metadata = metadata
         @logger = logger
         @grouping_strategy = grouping_strategy
+        @accession = accession
       end
+      # rubocop:enable Metrics/ParameterLists
 
       # rubocop:disable Metrics/AbcSize
       def run
@@ -48,11 +53,15 @@ module SdrClient
         end
       end
 
+      def accession?
+        @accession
+      end
+
+      # @param [Hash<Symbol,String>] the result of the metadata call
+      # @param [Boolean] accession should the accessionWF be started
       # @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 = connection.post(DRO_PATH, request_json, 'Content-Type' => 'application/json')
+        response = metadata_request(metadata)
         unexpected_response(response) unless response.status == 201
 
         logger.info("Response from server: #{response.body}")
@@ -60,6 +69,18 @@ module SdrClient
         { druid: JSON.parse(response.body)['druid'], background_job: response.headers['Location'] }
       end
 
+      def metadata_request(metadata)
+        logger.debug("Starting upload metadata: #{metadata}")
+
+        connection.post(path, JSON.generate(metadata), 'Content-Type' => 'application/json')
+      end
+
+      def path
+        path = DRO_PATH
+        path += '?accession=true' if accession?
+        path
+      end
+
       def unexpected_response(response)
         raise "There was an error with your request: #{response.body}" if response.status == 400
         raise 'There was an error with your credentials. Perhaps they have expired?' if response.status == 401

data/lib/sdr_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdr-client
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -233,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: The CLI for https://github.com/sul-dlss/sdr-api