collectionspace-client 0.14.1 → 0.15.1

data/examples/reports.rb

@@ -1,178 +1,45 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'awesome_print'
-require 'collectionspace/client'
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "awesome_print"
+require "collectionspace/client"
 
-client = CollectionSpace::Client.new(
-  CollectionSpace::Configuration.new(
-    base_uri: 'https://core.dev.collectionspace.org/cspace-services',
-    username: 'admin@core.collectionspace.org',
-    password: 'Administrator'
-  )
-)
+STANDARD_TENANTS = [
+  :anthro,
+  :bonsai,
+  :botgarden,
+  :core,
+  :fcart,
+  :herbarium,
+  :lhmc,
+  :materials,
+  :publicart
+]
 
 # https://github.com/collectionspace/Tools/blob/master/scripts/install_report_records.sh
 # https://github.com/collectionspace/Tools/blob/master/scripts/create-report-records.sh
 
-STANDARD_REPORTS = [
-  {
-    name: 'Acquisition Summary',
-    notes: 'An acquisition summary report. Runs on a single record only.',
-    doctype: 'Acquisition',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'acq_basic.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Acquisition Basic List',
-    notes: 'Catalog info for objects related to an acquisition record. Runs on a single record only.',
-    doctype: 'Acquisition',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'Acq_List_Basic.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Condition Check Basic List',
-    notes: 'Catalog info for objects related to a condition check record. Runs on a single record only.',
-    doctype: 'Conditioncheck',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'CC_List_Basic.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Exhibition Basic List',
-    notes: 'Catalog info for objects related to a exhibition record. Runs on a single record only.',
-    doctype: 'Exhibition',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'Exhibition_List_Basic.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Group Basic List',
-    notes: 'Catalog info for objects related to a group record. Runs on a single record only.',
-    doctype: 'Group',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'Group_List_Basic.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Loan In Basic List',
-    notes: 'Catalog info for objects related to a loan in record. Runs on a single record only.',
-    doctype: 'Loanin',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'LoansIn_List_Basic.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Loan Out Basic List',
-    notes: 'Catalog info for objects related to a loan out record. Runs on a single record only.',
-    doctype: 'Loanout',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'LoansOut_List_Basic.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Acquisition Ethnographic Object List',
-    notes: 'Core acquisition report. Runs on a single record only.',
-    doctype: 'Acquisition',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'coreAcquisition.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Group Object Ethnographic Object List',
-    notes: 'Core group object report. Runs on a single record only.',
-    doctype: 'Group',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'coreGroupObject.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Intake Ethnographic Object List',
-    notes: 'Core intake report. Runs on a single record only.',
-    doctype: 'Intake',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'coreIntake.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Loan In Ethnographic Object List',
-    notes: 'Core loan in report. Runs on a single record only.',
-    doctype: 'Loanin',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'coreLoanIn.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Loan Out Ethnographic Object List',
-    notes: 'Core loan out report. Runs on a single record only.',
-    doctype: 'Loanout',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'coreLoanOut.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Object Exit Ethnographic Object List',
-    notes: 'Core object exit report. Runs on a single record only.',
-    doctype: 'ObjectExit',
-    supports_single_doc: 'true',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'false',
-    filename: 'coreObjectExit.jrxml',
-    mimetype: 'application/pdf'
-  },
-  {
-    name: 'Systematic Inventory',
-    notes: 'Generate a checklist for performing an inventory on a range of storage locations. Runs on all records, using the provided start and end locations.',
-    doctype: 'Locationitem',
-    supports_single_doc: 'false',
-    supports_doc_list: 'false',
-    supports_group: 'false',
-    supports_no_context: 'true',
-    filename: 'systematicInventory.jrxml',
-    mimetype: 'application/pdf'
-  }
-]
+STANDARD_REPORTS = CollectionSpace::Report.all
+
+STANDARD_TENANTS.each do |tenant|
+  client = CollectionSpace::Client.new(
+    CollectionSpace::Configuration.new(
+      base_uri: "https://#{tenant}.dev.collectionspace.org/cspace-services",
+      username: "admin@#{tenant}.collectionspace.org",
+      password: "Administrator"
+    )
+  )
+  base = client.config.base_uri
+    .delete_suffix("/cspace-services")
+    .delete_prefix("https://")
 
-STANDARD_REPORTS.each do |report|
-  response = client.add_report(report)
-  puts response.inspect
+  STANDARD_REPORTS.each do |report|
+    response = client.add_report(report)
+    if response.result.success?
+      puts "Added #{report[:name]} to #{base}"
+    else
+      puts "FAILED TO ADD #{report[:name]} to #{base}"
+      puts response.inspect
+    end
+  end
 end

data/examples/reset_media_blob.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "awesome_print"
+require "collectionspace/client"
+require "csv"
+
+client = CollectionSpace::Client.new(
+  CollectionSpace::Configuration.new(
+    base_uri: "https://core.dev.collectionspace.org/cspace-services",
+    username: "admin@core.collectionspace.org",
+    password: "Administrator"
+  )
+)
+client.config.throttle = 1
+
+path = File.expand_path("~/your/path/here.csv")
+
+CSV.foreach(path, headers: true) do |row|
+  client.reset_media_blob(
+    id: row["identificationnumber"],
+    url: row["mediafileuri"],
+    verbose: true,
+    # client files are on same server as CS instance, and ingestable
+    #   file paths do not all parse as URIs safely
+    ensure_safe_url: false,
+    # This example script used to fix media where the blobs had already
+    #   been deleted, but the blobcsid value was not removed from the
+    #   media record. Attempts to delete the media failed, so this option
+    #   was used to add new blobs without attempting to delete the already
+    #   deleted old blobs (and erroring out)
+    delete_existing_blob: false
+  )
+  sleep 1.5
+end

data/examples/search.rb

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'awesome_print'
-require 'collectionspace/client'
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "awesome_print"
+require "collectionspace/client"
 
 config = CollectionSpace::Configuration.new(
-  base_uri: 'https://core.dev.collectionspace.org/cspace-services',
-  username: 'admin@core.collectionspace.org',
-  password: 'Administrator'
+  base_uri: "https://core.dev.collectionspace.org/cspace-services",
+  username: "admin@core.collectionspace.org",
+  password: "Administrator"
 )
 
 client = CollectionSpace::Client.new(config)
 
 search_args = {
-  path: 'groups',
-  namespace: 'groups_common',
-  field: 'title',
+  path: "groups",
+  namespace: "groups_common",
+  field: "title",
   expression: "ILIKE '%D%'"
 }
 
-puts 'Search: %D'
+puts "Search: %D"
 response = client.search(
   CollectionSpace::Search.new.from_hash(search_args),
-  { sortBy: CollectionSpace::Search::DEFAULT_SORT }
+  {sortBy: CollectionSpace::Search::DEFAULT_SORT}
 )
 if response.result.success?
-  response.parsed['abstract_common_list']['list_item'].map do |i|
-    puts i['uri']
+  response.parsed["abstract_common_list"]["list_item"].map do |i|
+    puts i["uri"]
   end
 end
 
-puts 'Object and authority term searches have been moved to spec.'
-puts 'See helpers_spec.rb examples describing find'
+puts "Object and authority term searches have been moved to spec."
+puts "See helpers_spec.rb examples describing find"

data/examples/update_password.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-puts 'Update password has been moved to Rake task: `cli:update_password[args...]`'
+puts "Update password has been moved to Rake task: `cli:update_password[args...]`"

data/lib/collectionspace/client/batch.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module CollectionSpace
+  # CollectionSpace batch
+  class Batch
+    def self.all
+      [
+        {
+          name: "Update Current Location",
+          notes: "Recompute the current location of Object records, based on the " \
+            "related Location/Movement/Inventory records. Runs on a single record " \
+            "or all records.",
+          doctype: %w[CollectionObject],
+          supports_single_doc: "true",
+          supports_doc_list: "false",
+          supports_group: "false",
+          supports_no_context: "true",
+          creates_new_focus: "false",
+          classname:
+          "org.collectionspace.services.batch.nuxeo.UpdateObjectLocationBatchJob"
+        },
+        {
+          name: "Update Inventory Status",
+          notes: "Set the inventory status of selected Object records. Runs on a " \
+            "record list only.",
+          doctype: %w[CollectionObject],
+          supports_single_doc: "false",
+          supports_doc_list: "true",
+          supports_group: "false",
+          supports_no_context: "false",
+          creates_new_focus: "false",
+          classname:
+          "org.collectionspace.services.batch.nuxeo.UpdateInventoryStatusBatchJob"
+        },
+        {
+          name: "Merge Authority Items",
+          notes: "Merge an authority item into a target, and update all " \
+            "referencing records. Runs on a single record only.",
+          doctype: %w[],
+          supports_single_doc: "true",
+          supports_doc_list: "false",
+          supports_group: "false",
+          supports_no_context: "false",
+          creates_new_focus: "false",
+          classname:
+          "org.collectionspace.services.batch.nuxeo.MergeAuthorityItemsBatchJob"
+        }
+      ]
+    end
+
+    def self.find(key, value)
+      all.find { |batch| batch[key] == value }
+    end
+  end
+end

data/lib/collectionspace/client/client.rb

@@ -8,28 +8,39 @@ module CollectionSpace
 
     def initialize(config = Configuration.new)
       unless config.is_a? CollectionSpace::Configuration
-        raise CollectionSpace::ArgumentError, 'Invalid configuration object'
+        raise CollectionSpace::ArgumentError, "Invalid configuration object"
       end
 
       @config = config
     end
 
     def get(path, options = {})
-      request 'GET', path, options
+      request "GET", path, options
     end
 
     def post(path, payload, options = {})
       check_payload(payload)
-      request 'POST', path, { body: payload }.merge(options)
+      request "POST", path, {body: payload}.merge(options)
+    end
+
+    def post_file(file, options = {})
+      file = File.expand_path(file)
+      raise ArgumentError, "cannot find file #{file}" unless File.exist? file
+
+      request "POST", "blobs", {
+        body: {
+          file: File.open(file)
+        }
+      }.merge(options)
     end
 
     def put(path, payload, options = {})
       check_payload(payload)
-      request 'PUT', path, { body: payload }.merge(options)
+      request "PUT", path, {body: payload}.merge(options)
     end
 
     def delete(path)
-      request 'DELETE', path
+      request "DELETE", path
     end
 
     private

data/lib/collectionspace/client/configuration.rb

@@ -10,10 +10,11 @@ module CollectionSpace
       page_size: 25,
       include_deleted: false,
       throttle: 0,
+      verbose: false,
       verify_ssl: true
     }.freeze
 
-    attr_accessor :base_uri, :username, :password, :page_size, :include_deleted, :throttle, :verify_ssl
+    attr_accessor :base_uri, :username, :password, :page_size, :include_deleted, :throttle, :verbose, :verify_ssl
 
     def initialize(settings = {})
       settings = DEFAULTS.merge(settings)