collectionspace-client 0.15.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d797561c0b44c79ce0bda224d05ff05de6fa7c932b2c33d4a9c888116c6d6fbb
-  data.tar.gz: bfbd46caa314f5fc6620b468e14e262983f3f52a444622ef55669c60ad5c4f84
+  metadata.gz: e8efeeecb56c776b3a9b04c57e412e22a3ee1fc091f1c400a38412d14eb2bfc4
+  data.tar.gz: 6cadb420c9cf8dd23794be7bdd069641fd6738afad9faaedfa8a45fa42ca9cf8
 SHA512:
-  metadata.gz: 697f5207854022997a0acf1e2249113c763447a5597677d4b7f7b157244467a2c0bee0d163d152ee2191950e41c9478a21443f967087c87e85a765c137542865
-  data.tar.gz: 71d59341de8048599691df601042915c803c10c6710982c76eeda366684aab1ba27ce694a285bcf349d9de08faba78d4951838114ff96059f24c417dc6b9f1a8
+  metadata.gz: afa91f5b105bef4a7d8507f703081fc0a18e342defac0b4b11e9809334070f301722813053e574a435b2d2bca3fb86ef3e98e53b2b70041bb1cee9209928922b
+  data.tar.gz: e023f885dd4912e71f2df99b59dd339578c75278654b22b23213ba888826b06f63ba2487114ffa0386dbe442b247183933f82e70c7d58ae3b64eea8dc44d6837

data/.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.2', '3.1', '3.0']
+        ruby-version: ['3.3', '3.2', '3.1', '3.0']
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

data/.github/workflows/publish.yml

@@ -18,7 +18,6 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: 2.7
           rubygems: latest
 
       - name: Release Gem

data/.gitignore

@@ -5,7 +5,6 @@
 /.bundle/
 /.vscode
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.0.6

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 3.0

data/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: .
+  specs:
+    collectionspace-client (1.0.0)
+      httparty
+      json
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
+    coderay (1.1.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    csv (3.3.2)
+    diff-lcs (1.5.1)
+    docile (1.4.1)
+    hashdiff (1.1.2)
+    httparty (0.22.0)
+      csv
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    json (2.9.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.8)
+    multi_xml (0.6.0)
+    nokogiri (1.17.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.70.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    standard (1.44.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.70.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.6)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.6.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.23.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    vcr (6.3.1)
+      base64
+    webmock (3.24.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler
+  collectionspace-client!
+  pry
+  rake
+  rspec
+  simplecov
+  standard
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.4.1

data/README.md

@@ -37,10 +37,11 @@ bundle exec rake
 ```bash
 gem install gem-release
 # https://github.com/svenfuchs/gem-release#gem-bump
-gem bump --version $VERSION --tag
+gem bump --version $VERSION
 # i.e.
 gem bump --version minor --pretend # dryrun
 gem bump --version minor # do it for real
+bundle # update gem version in Gemfile.lock
 # PR and merge will publish new version
 ```
 

data/bin/standardrb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/collectionspace-client.gemspec

@@ -9,8 +9,10 @@ Gem::Specification.new do |spec|
   spec.email = ["mark.cooper@lyrasis.org"]
 
   spec.summary = "CollectionSpace API client."
+  spec.description = "Client for interacting with CollectionSpace Services API"
   spec.homepage = "https://github.com/lyrasis/collectionspace-client.git"
   spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.6"
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir = "exe"
@@ -24,11 +26,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "awesome_print"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "standard"
-  spec.add_development_dependency "vcr", "~> 6.1"
+  spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 end

data/examples/demo.rb

@@ -4,13 +4,33 @@ $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"
-  )
+config = CollectionSpace::Configuration.new(
+  base_uri: "https://core.collectionspace.org/cspace-services",
+  username: "admin@core.collectionspace.org",
+  password: "Administrator"
 )
+client = CollectionSpace::Client.new(config)
+
+version_data = client.version
+puts "Success getting UI version?: #{version_data.ui.success?}"
+puts "Instance UI profile: #{version_data.ui.profile}"
+puts "Instance UI version: #{version_data.ui.version}"
+puts "Combined UI profile/version: #{version_data.ui.joined}"
+puts ""
+puts "Success getting API version?: #{version_data.api.success?}"
+puts "API major version number: #{version_data.api.major}"
+puts "API display version: #{version_data.api.joined}"
+puts ""
+puts "Client version: #{version_data.client}"
+
+# GET REQUEST FOR CONDITIONCHECK RECORDS AND PRINT THE PARSED RESPONSE AND XML
+response = client.get("conditionchecks")
+ap response.parsed if response.result.success?
+
+# GET ALL PERSON RECORDS AND PROCESS PER PAGE (INSTEAD OF WAITING FOR ALL)
+client.all("personauthorities/urn:cspace:name(person)/items").each do |item|
+  puts item
+end
 
 # GET REQUEST FOR CONDITIONCHECK RECORDS AND PRINT THE PARSED RESPONSE AND XML
 response = client.get("conditionchecks")

data/examples/reports.rb

@@ -1,45 +1,22 @@
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require "awesome_print"
 require "collectionspace/client"
 
-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 = 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"
-    )
+client = CollectionSpace::Client.new(
+  CollectionSpace::Configuration.new(
+    base_uri: "https://core.dev.collectionspace.org/cspace-services",
+    username: "admin@core.collectionspace.org",
+    password: "Administrator"
   )
-  base = client.config.base_uri
-    .delete_suffix("/cspace-services")
-    .delete_prefix("https://")
+)
+
+report_xml = File.join("spec", "fixtures", "files", "Exhibition_List_Basic.xml")
 
-  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
+response = client.add_report(report_xml)
+if response.result.success?
+  puts "Report added/updated"
+else
+  puts "Report addition/update failed"
+  puts response.inspect
 end

data/lib/collectionspace/client/api_version.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CollectionSpace
+  ApiVersion = Struct.new(:status, :message, :major, :minor, :patch,
+    :build, keyword_init: true) do
+    def success? = status == :success
+
+    def failure? = !success?
+
+    def joined
+      return if failure?
+
+      [major, minor].compact.join(".")
+    end
+  end
+end

data/lib/collectionspace/client/client.rb

@@ -14,6 +14,21 @@ module CollectionSpace
       @config = config
     end
 
+    # User is required to be authenticated in order to access accounts
+    #   endpoint. We cannot distinguish between unknown user and known
+    #   user with bad password because CollectionSpace returns a 401
+    #   error regardless of reason for
+    #   non-authentication/authorization
+    def can_authenticate?
+      return false unless login_credentials_provided?
+
+      response = get("accounts/0/accountperms")
+      response.result.success? &&
+        response.parsed.respond_to?(:dig) &&
+        response.parsed.dig("account_permission", "account",
+          "userId") == config.username
+    end
+
     def get(path, options = {})
       request "GET", path, options
     end
@@ -43,8 +58,21 @@ module CollectionSpace
       request "DELETE", path
     end
 
+    def version
+      Struct.new(:api, :client, :ui, keyword_init: true)
+        .new(
+          api: get_api_version,
+          client: VERSION,
+          ui: CollectionSpace::UiVersion.call(self)
+        )
+    end
+
     private
 
+    def login_credentials_provided?
+      config.username && config.password
+    end
+
     def check_payload(payload)
       errors = Nokogiri::XML(payload).errors
       raise CollectionSpace::PayloadError, errors if errors.any?
@@ -54,5 +82,23 @@ module CollectionSpace
       sleep config.throttle
       Response.new(Request.new(config, method, path, options).execute)
     end
+
+    def get_api_version
+      response = get("systeminfo")
+      unless response.result.success?
+        return CollectionSpace::ApiVersion.new(
+          status: :failure, message: response.result.body
+        )
+      end
+
+      version_info = response.parsed.dig("system_info_common", "version")
+      CollectionSpace::ApiVersion.new(
+        status: :success,
+        major: version_info["major"],
+        minor: version_info["minor"],
+        patch: version_info["patch"],
+        build: version_info["build"]
+      )
+    end
   end
 end

data/lib/collectionspace/client/configuration.rb

@@ -21,7 +21,7 @@ module CollectionSpace
       settings.each do |property, value|
         next unless DEFAULTS.key?(property)
 
-        instance_variable_set("@#{property}", value)
+        instance_variable_set(:"@#{property}", value)
       end
     end
   end

data/lib/collectionspace/client/helpers.rb

@@ -18,10 +18,11 @@ module CollectionSpace
     end
 
     # add / update reports
-    def add_report(data = {}, params = {pgSz: 100})
-      payload = Template.process("report", data)
+    def add_report(payload_path, params = {pgSz: 100})
+      payload = File.read(File.expand_path(payload_path))
+      report_name = payload.match(/<name>(.*)<\/name>/)[1]
       response = get("reports", {query: params})
-      create_or_update(response, "reports", "name", data[:name], payload)
+      create_or_update(response, "reports", "name", report_name, payload)
     end
 
     # returns Array of authority doctypes for use in setting up batches
@@ -81,7 +82,7 @@ module CollectionSpace
         path: service[:path],
         namespace: "#{service[:ns_prefix]}_#{schema}",
         field: field,
-        expression: "#{operator} '#{value.gsub(/'/, "\\\\'")}'"
+        expression: "#{operator} '#{value.gsub("'", "\\\\'")}'"
       )
       search(search_args, sortBy: CollectionSpace::Search::DEFAULT_SORT)
     end
@@ -109,16 +110,13 @@ module CollectionSpace
       }.fetch(path, %w[abstract_common_list list_item])
     end
 
-    def reindex_full_text(doctype, csids = [])
-      if csids.any?
-        run_job(
-          "Reindex Full Text", :reindex_full_text, :reindex_by_csids, {doctype: doctype, csids: csids}
-        )
-      else
-        run_job(
-          "Reindex Full Text", :reindex_full_text, :reindex_by_doctype, {doctype: doctype}
-        )
-      end
+    def reindex_full_text(doctype = nil, csids = [])
+      run_job(
+        "Reindex Full Text",
+        :reindex_full_text,
+        :reindex,
+        {doctype: doctype, csids: csids}
+      )
     end
 
     # @param id [String] media record's identificationNumber value

data/lib/collectionspace/client/search.rb

@@ -16,7 +16,7 @@ module CollectionSpace
 
     def from_hash(query)
       query.each do |property, value|
-        instance_variable_set("@#{property}", value)
+        instance_variable_set(:"@#{property}", value)
       end
       self
     end

data/lib/collectionspace/client/service.rb

@@ -12,6 +12,12 @@ module CollectionSpace
           path: "acquisitions",
           term: nil
         },
+        "chronologyauthorities" => {
+          identifier: "shortIdentifier",
+          ns_prefix: "chronologies",
+          path: "chronologyauthorities/urn:cspace:name(#{subtype})/items",
+          term: "chronology#{TERM_SUFFIX}"
+        },
         "citationauthorities" => {
           identifier: "shortIdentifier",
           ns_prefix: "citations",
@@ -48,18 +54,48 @@ module CollectionSpace
           path: "conservation",
           term: nil
         },
+        "consultations" => {
+          identifier: "consultationNumber",
+          ns_prefix: "consultations",
+          path: "consultations",
+          term: nil
+        },
+        "deaccessions" => {
+          identifier: "deaccessionNumber",
+          ns_prefix: "deaccessions",
+          path: "deaccessions",
+          term: nil
+        },
+        "dutiesofcare" => {
+          identifier: "dutyOfCareNumber",
+          ns_prefix: "dutiesofcare",
+          path: "dutiesofcare",
+          term: nil
+        },
         "exhibitions" => {
           identifier: "exhibitionNumber",
           ns_prefix: "exhibitions",
           path: "exhibitions",
           term: nil
         },
+        "exits" => {
+          identifier: "exitNumber",
+          ns_prefix: "exits",
+          path: "exits",
+          term: nil
+        },
         "groups" => {
           identifier: "title",
           ns_prefix: "groups",
           path: "groups",
           term: nil
         },
+        "heldintrusts" => {
+          identifier: "heldInTrustNumber",
+          ns_prefix: "heldintrusts",
+          path: "heldintrusts",
+          term: nil
+        },
         "insurances" => {
           identifier: "insuranceIndemnityReferenceNumber",
           ns_prefix: "insurances",
@@ -114,6 +150,12 @@ module CollectionSpace
           path: "movements",
           term: nil
         },
+        "nagprainventories" => {
+          identifier: "inventoryNumber",
+          ns_prefix: "nagprainventories",
+          path: "nagprainventories",
+          term: nil
+        },
         "objectexit" => {
           identifier: "exitNumber",
           ns_prefix: "objectexit",
@@ -162,6 +204,24 @@ module CollectionSpace
           path: "relations",
           term: nil
         },
+        "repatriationrequests" => {
+          identifier: "requestNumber",
+          ns_prefix: "repatriationrequests",
+          path: "repatriationrequests",
+          term: nil
+        },
+        "restrictedmedia" => {
+          identifier: "identificationNumber",
+          ns_prefix: "restrictedmedia",
+          path: "restrictedmedia",
+          term: nil
+        },
+        "summarydocumentations" => {
+          identifier: "documentationNumber",
+          ns_prefix: "summarydocumentations",
+          path: "summarydocumentations",
+          term: nil
+        },
         "taxonomyauthority" => {
           identifier: "shortIdentifier",
           ns_prefix: "taxon",

data/lib/collectionspace/client/templates/{reindex_by_csids.xml.erb → reindex.xml.erb}

@@ -1,10 +1,16 @@
 <?xml version="1.0" encoding="utf-8" standalone="yes"?>
 <ns2:invocationContext xmlns:ns2="http://collectionspace.org/services/common/invocable">
+<% if data[:csids].any? %>
   <mode>list</mode>
-  <docType><%= data[:doctype] %></docType>
   <listCSIDs>
-<% data[:csids].each do |csid| %>
-    <csid><%= csid %></csid>
-<% end %>
+    <% data[:csids].each do |csid| %>
+      <csid><%= csid %></csid>
+    <% end %>
   </listCSIDs>
+<% else %>
+  <mode>nocontext</mode>
+<% end %>
+<% if data[:doctype] %>
+  <docType><%= data[:doctype] %></docType>
+<% end %>
 </ns2:invocationContext>

data/lib/collectionspace/client/templates/reindex_full_text.xml.erb

@@ -11,11 +11,8 @@
     <createsNewFocus>false</createsNewFocus>
     <forDocTypes>
       <forDocType>Acquisition</forDocType>
-      <forDocType>Batch</forDocType>
-      <forDocType>Blob</forDocType>
       <forDocType>Citation</forDocType>
       <forDocType>Citationauthority</forDocType>
-      <forDocType>Claim</forDocType>
       <forDocType>CollectionObject</forDocType>
       <forDocType>Conceptauthority</forDocType>
       <forDocType>Conceptitem</forDocType>
@@ -32,7 +29,6 @@
       <forDocType>ObjectExit</forDocType>
       <forDocType>Organization</forDocType>
       <forDocType>Orgauthority</forDocType>
-      <forDocType>Osteology</forDocType>
       <forDocType>Person</forDocType>
       <forDocType>Personauthority</forDocType>
       <forDocType>Placeauthority</forDocType>
@@ -45,7 +41,6 @@
       <forDocType>Vocabulary</forDocType>
       <forDocType>Vocabularyitem</forDocType>
       <forDocType>Workauthority</forDocType>
-      <forDocType>Workitem</forDocType>
     </forDocTypes>
   </ns2:batch_common>
 </document>

data/lib/collectionspace/client/ui_version.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require "strscan"
+require "net/http"
+require "uri"
+
+module CollectionSpace
+  # CollectionSpace request
+  class UiVersion
+    Data = Struct.new(:status, :message, :profile, :version,
+      keyword_init: true) do
+      def success? = status == :success
+
+      def failure? = !success?
+
+      def joined
+        return if failure?
+
+        [profile, version].compact.join(" ")
+      end
+    end
+
+    class << self
+      def call(...) = new(...).call
+    end
+
+    # @param client [CollectionSpace::Client]
+    def initialize(client)
+      @uri = client.config.base_uri
+    end
+
+    def call
+      body = retrieve_response
+      return body if body.respond_to?(:status) && body.status == :failure
+
+      script = last_script_src(body)
+      return script if script.respond_to?(:status) && script.status == :failure
+
+      version = extract_version(script) if script
+      return version if version.respond_to?(:status) &&
+        version.status == :failure
+
+      profile = extract_profile(script) if version
+      return profile if profile.respond_to?(:status) &&
+        profile.status == :failure
+
+      Data.new(status: :success,
+        profile: profile.downcase.tr(" ", "-"),
+        version: version)
+    end
+
+    private
+
+    attr_reader :uri
+
+    def retrieve_response
+      unless response.is_a?(Net::HTTPSuccess)
+        return Data.new(status: :failure, message: response.message)
+      end
+
+      response.body
+    end
+
+    def response
+      @response ||= fetch(base_uri)
+    rescue => err
+      err
+    end
+
+    def base_uri = URI(uri.sub(/\/cspace-services\/?/, ""))
+
+    def fetch(uri, limit = 10)
+      uri = URI(uri) unless uri.is_a?(URI)
+
+      # You should choose a better exception.
+      raise ArgumentError, "too many HTTP redirects" if limit == 0
+
+      response = Net::HTTP.get_response(uri)
+
+      case response
+      when Net::HTTPSuccess
+        response
+      when Net::HTTPRedirection
+        location = response["location"]
+        new_loc = "#{base_uri}#{location}"
+        fetch(new_loc, limit - 1)
+      else
+        response.value
+      end
+    end
+
+    def last_script_src(str)
+      scripts = []
+      scanner = StringScanner.new(str)
+      script_begin = Regexp.new("<script src=\"")
+      script_end_str = '"></script>'
+      script_end = Regexp.new(script_end_str)
+
+      while scanner.exist?(script_begin)
+        scanner.scan_until(script_begin)
+        scripts << scanner.scan_until(script_end)
+          .delete_suffix(script_end_str)
+      end
+
+      if scripts.empty?
+        return Data.new(status: :failure,
+          message: "No CollectionSpace UI plugin script sources " \
+            "detected for #{base_uri}")
+      end
+
+      scripts.last
+    end
+
+    def extract_version(src)
+      case src
+      when /^\/cspace-ui/
+        extract_from_cspace_ui_src(src)
+      when /cspace-ui-plugin-profile-.*@\d.*cspaceUIPluginProfile.*\.min\.js/
+        get_specific_delivered_version(src)
+      when /^https:\/\/cdn\.jsdelivr\.net\/npm.*@latest/
+        get_latest_npm_version(src)
+      else
+        Data.new(status: :failure, message: "Unhandled src type: #{src}")
+      end
+    end
+
+    def extract_from_cspace_ui_src(src)
+      src.match(/@(.*)\.min\.js/)
+        .captures
+        .first
+    rescue
+      Value.new(status: :failure, message: "Cannot extract version from #{src}")
+    end
+
+    def get_specific_delivered_version(src)
+      src.match(/cspace-ui-plugin-profile-.*@(\d[^\/]+)\//)
+        .captures
+        .first
+    end
+
+    def get_latest_npm_version(src)
+      package = src.match(/npm\/(.*)@latest/)
+        .captures.first
+      uri = URI("https://data.jsdelivr.com/v1/packages/npm/#{package}")
+      response = fetch(uri)
+      unless response.is_a?(Net::HTTPSuccess)
+        return Data.new(status: :failure,
+          message: "ERROR: Cannot retrieve latest version " \
+             "number for #{package} from jsdelivr: " \
+             "#{response.message}")
+      end
+
+      data = JSON.parse(response.body)
+      value = data.dig("tags", "latest")
+      unless value
+        return Data.new(status: :failure,
+          message: "Could not extract latest version from #{uri}")
+      end
+
+      value
+    end
+
+    def extract_profile(src)
+      return "core" if src.match?(/^\/cspace-ui\/cspaceUI@/)
+
+      src.match(/UIPluginProfile([^@]+)(?:@|\.min\.js)/)
+        .captures.first
+    end
+  end
+end

data/lib/collectionspace/client/version.rb

@@ -2,6 +2,6 @@
 
 module CollectionSpace
   class Client
-    VERSION = "0.15.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/collectionspace/client.rb

@@ -8,15 +8,16 @@ require "uri"
 require "collectionspace/client/helpers"
 require "collectionspace/client/template"
 
+require "collectionspace/client/api_version"
 require "collectionspace/client/batch"
 require "collectionspace/client/client"
 require "collectionspace/client/configuration"
 require "collectionspace/client/refname"
-require "collectionspace/client/report"
 require "collectionspace/client/request"
 require "collectionspace/client/response"
 require "collectionspace/client/search"
 require "collectionspace/client/service"
+require "collectionspace/client/ui_version"
 require "collectionspace/client/version"
 
 module CollectionSpace

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collectionspace-client
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Mark Cooper
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2025-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -96,20 +96,6 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -140,16 +126,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -168,16 +154,16 @@ dependencies:
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +178,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Client for interacting with CollectionSpace Services API
 email:
 - mark.cooper@lyrasis.org
 executables: []
@@ -204,15 +190,17 @@ files:
 - ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
-- ".rubocop.yml"
 - ".ruby-version"
+- ".standard.yml"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/rspec
+- bin/standardrb
 - collectionspace-client.gemspec
 - examples/batches.rb
 - examples/demo.rb
@@ -223,29 +211,29 @@ files:
 - examples/search.rb
 - examples/update_password.rb
 - lib/collectionspace/client.rb
+- lib/collectionspace/client/api_version.rb
 - lib/collectionspace/client/batch.rb
 - lib/collectionspace/client/client.rb
 - lib/collectionspace/client/configuration.rb
 - lib/collectionspace/client/helpers.rb
 - lib/collectionspace/client/refname.rb
-- lib/collectionspace/client/report.rb
 - lib/collectionspace/client/request.rb
 - lib/collectionspace/client/response.rb
 - lib/collectionspace/client/search.rb
 - lib/collectionspace/client/service.rb
 - lib/collectionspace/client/template.rb
 - lib/collectionspace/client/templates/batch.xml.erb
-- lib/collectionspace/client/templates/reindex_by_csids.xml.erb
-- lib/collectionspace/client/templates/reindex_by_doctype.xml.erb
+- lib/collectionspace/client/templates/reindex.xml.erb
 - lib/collectionspace/client/templates/reindex_full_text.xml.erb
 - lib/collectionspace/client/templates/report.xml.erb
 - lib/collectionspace/client/templates/reset_media_blob.xml.erb
+- lib/collectionspace/client/ui_version.rb
 - lib/collectionspace/client/version.rb
 homepage: https://github.com/lyrasis/collectionspace-client.git
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -253,15 +241,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: CollectionSpace API client.
 test_files: []

data/.rubocop.yml

@@ -1,4 +0,0 @@
-require: standard
-
-inherit_gem:
-  standard: config/base.yml

data/lib/collectionspace/client/report.rb

@@ -1,180 +0,0 @@
-# frozen_string_literal: true
-
-module CollectionSpace
-  # CollectionSpace report
-  class Report
-    def self.all
-      [
-        {
-          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: "Object Valuation",
-          notes: "Returns latest valuation information for selected objects",
-          doctype: "CollectionObject",
-          supports_single_doc: "false",
-          supports_doc_list: "true",
-          supports_group: "false",
-          supports_no_context: "true",
-          filename: "object_valuation.jrxml",
-          mimetype: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
-        },
-        {
-          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"
-        }
-      ]
-    end
-
-    def self.find(key, value)
-      all.find { |report| report[key] == value }
-    end
-  end
-end

data/lib/collectionspace/client/templates/reindex_by_doctype.xml.erb

@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes"?>
-<ns2:invocationContext xmlns:ns2="http://collectionspace.org/services/common/invocable">
-  <mode>nocontext</mode>
-  <docType><%= data[:doctype] %></docType>
-</ns2:invocationContext>