collectionspace-client 0.3.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e63c182e9731f5868556d805eed65b8c85d32789363c90f4ac763cff06e2b693
-  data.tar.gz: 00d6e5804a0131adad73d28eee0dd32a95dd9b9a05346bf4e1374d54bfa1f2b5
+  metadata.gz: 89651eb1e87693f52f835cbe34eccc510f40888db54696a41082ae114a084817
+  data.tar.gz: e3c161e2a64848a1f0065e18da8aa23ad6117995daf62538cf5437bc0192cfc6
 SHA512:
-  metadata.gz: fa76fc6c2b8f1761c01dc195198445eba31698d0d530d0993c5fa64ceb1ace2fbc44153a7d8c4dd29fe3d272463e1f82d3185f5a8d46ddfbec9252f0b8ec0ca5
-  data.tar.gz: b67294a65c42c52804af6e429f45e2ea9bcb1a5e4ea4d78fb3da0cfeafb8018221d835a29b81c48fea6e43b287b88e549e6bfd746f124a9814c1079fdae3abc7
+  metadata.gz: 7d9d9989ff3272bffe9fc99c19036e72004b7e672bc3d02ce5556b69bb478a441a78768d394685534ba83144d76054903bac35fa4f715c50cff32b838e60132c
+  data.tar.gz: 7bea83ddcadf1aa7019e196c8ede59cd9e9ffd6fdd9b23a90ff7d0f89666122cb6c865a0b422287cb8a04d4032718e493e48f23b6356d65039a1bde00626e53b

data/.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish Gem
+
+on:
+  push:
+    branches:
+      - main
+      - master
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 2.7
+          rubygems: latest
+
+      - name: Release Gem
+        run: |
+          VERSION=$(bundle exec rake version)
+          GEM_VERSION=$(gem list --exact --remote $GEM_NAME)
+
+          # Publish to RubyGems.org
+          if [ "${GEM_VERSION}" != "$GEM_NAME (${VERSION})" ]; then
+            gem build $GEM_NAME.gemspec
+            gem push "$GEM_NAME-${VERSION}.gem"
+          fi
+
+          # Create a release tag
+          if ! git ls-remote --tags --exit-code origin v${VERSION}; then
+            git tag v${VERSION}
+            git push --tags
+          fi
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_AUTH_TOKEN }}"
+          GEM_NAME: collectionspace-client

data/.gitignore

@@ -1,6 +1,7 @@
 *.gem
 *.swp
 /.bundle/
+/.vscode
 /.yardoc
 /Gemfile.lock
 /_yardoc/
@@ -9,5 +10,8 @@
 /examples/my_*.rb
 /pkg/
 /spec/reports/
+.byebug_history
+.rspec_status
 /tmp/
 collectionobject.rb
+coverage

data/.ruby-version

@@ -0,0 +1 @@
+2.7.4

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in collectionspace-client.gemspec

data/README.md

@@ -4,13 +4,13 @@ CollectionSpace API client.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile (replace `$VERSION` with an available tag):
 
 ```ruby
-gem 'collectionspace-client'
+gem 'collectionspace-client', tag: $VERSION, git: 'https://github.com/collectionspace/collectionspace-client.git'
 ```
 
-And then execute `bundle install`, or install it yourself as: `gem install collectionspace-client`.
+And then execute `bundle install`.
 
 ## Usage
 
@@ -32,19 +32,16 @@ To run the tests:
 bundle exec rake
 ```
 
-## Publishing
-
-Bump version in `lib/collectionspace/client/version.rb` then:
+## Releasing
 
 ```bash
-VERSION=0.3.0
-git add .
-git commit -m "Bump version: v${VERSION}"
-git push origin master
-git tag v$VERSION
-git push --tags
-gem build collectionspace-client
-gem push collectionspace-client-$VERSION.gem
+gem install gem-release
+# https://github.com/svenfuchs/gem-release#gem-bump
+gem bump --version $VERSION --tag
+# i.e.
+gem bump --version minor --tag --pretend # dryrun
+gem bump --version minor --tag # do it for real
+# PR and merge will publish new version
 ```
 
 ## Contributing

data/Rakefile

@@ -1,6 +1,47 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'base64'
+require 'collectionspace/client'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+task :version do
+  puts CollectionSpace::Client::VERSION
+end
+
+namespace :cli do
+  desc "Update a user's password: requires an Admin level account to perform the update"
+  task :update_password, [:endpoint, :admin, :password, :user, :new_password] do |_t, args|
+    endpoint     = args[:endpoint]
+    admin        = args[:admin]
+    password     = args[:password]
+    user         = args[:user]
+    new_password = args[:new_password]
+
+    client = CollectionSpace::Client.new(
+      CollectionSpace::Configuration.new(
+        base_uri: endpoint,
+        username: admin,
+        password: password
+      )
+    )
+
+    payload = <<~XML
+      <ns2:accounts_common xmlns:ns2="http://collectionspace.org/services/account">
+          <userId>#{user}</userId>
+          <password>#{Base64.encode64(new_password).chomp}</password>
+      </ns2:accounts_common>
+    XML
+
+    client.all('accounts').each do |account|
+      if account['email'] == user
+        puts client.put(account['uri'], payload).parsed
+        break
+      end
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,26 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+Bundler.require(:tools)
+
+require_relative '../lib/collectionspace/client'
+require 'irb'
+
+module CollectionSpace
+  ::CS = CollectionSpace # alias only in console to minimize typing
+
+  module_function
+
+  def coredev
+    CollectionSpace::Client.new(
+      CollectionSpace::Configuration.new(
+        base_uri: 'https://core.dev.collectionspace.org/cspace-services',
+        username: 'admin@core.collectionspace.org',
+        password: 'Administrator'
+      )
+    )
+  end
+end
+
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /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("rspec-core", "rspec")

data/collectionspace-client.gemspec

@@ -23,9 +23,11 @@ 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', '~> 10.0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
 end

data/examples/demo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'awesome_print'
 require 'collectionspace/client'

data/examples/media_with_external_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'awesome_print'
 require 'collectionspace/client'

data/examples/purge_empty_vocabs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'collectionspace/client'
 

data/examples/reports.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+$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'
+  )
+)
+
+# 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.each do |report|
+  response = client.add_report(report)
+  puts response.inspect
+end

data/examples/search.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'awesome_print'
 require 'collectionspace/client'
@@ -12,10 +14,21 @@ client = CollectionSpace::Client.new(config)
 
 search_args = {
   path: 'groups',
-  type: 'groups_common',
+  namespace: 'groups_common',
   field: 'title',
-  expression: "ILIKE '%DTS 001%'"
+  expression: "ILIKE '%D%'"
 }
 
-response = client.search(CollectionSpace::Search.new.from_hash(search_args))
-ap response.parsed['abstract_common_list'] if response.result.success?
+puts 'Search: %D'
+response = client.search(
+  CollectionSpace::Search.new.from_hash(search_args),
+  { sortBy: CollectionSpace::Search::DEFAULT_SORT }
+)
+if response.result.success?
+  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'

data/examples/update_password.rb

@@ -1,33 +1,3 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'awesome_print'
-require 'base64'
-require 'collectionspace/client'
-
-CS_CFG_URL  = ENV.fetch('CS_CFG_URL', 'https://core.dev.collectionspace.org/cspace-services')
-CS_CFG_USER = ENV.fetch('CS_CFG_USER', 'admin@core.collectionspace.org')
-CS_CFG_PASS = ENV.fetch('CS_CFG_PASS', 'Administrator')
-CS_UPD_USER = ENV.fetch('CS_UPD_USER', 'admin@core.collectionspace.org')
-CS_UPD_PASS = Base64.encode64(ENV.fetch('CS_UPD_PASS', 'Administrator')).chomp
-
-client = CollectionSpace::Client.new(
-  CollectionSpace::Configuration.new(
-    base_uri: CS_CFG_URL,
-    username: CS_CFG_USER,
-    password: CS_CFG_PASS
-  )
-)
-
-PAYLOAD = <<~XML
-  <ns2:accounts_common xmlns:ns2="http://collectionspace.org/services/account">
-      <userId>#{CS_UPD_USER}</userId>
-      <password>#{CS_UPD_PASS}</password>
-  </ns2:accounts_common>
-XML
-
-client.all('accounts').each do |item|
-  next unless item['email'] == CS_UPD_USER
-
-  ap client.put(item['uri'], PAYLOAD).parsed
-end
+puts 'Update password has been moved to Rake task: `cli:update_password[args...]`'

data/lib/collectionspace/client/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CollectionSpace
   # CollectionSpace client
   class Client
@@ -21,9 +23,9 @@ module CollectionSpace
       request 'POST', path, { body: payload }.merge(options)
     end
 
-    def put(path, payload)
+    def put(path, payload, options = {})
       check_payload(payload)
-      request 'PUT', path, body: payload
+      request 'PUT', path, { body: payload }.merge(options)
     end
 
     def delete(path)

data/lib/collectionspace/client/configuration.rb

@@ -1,25 +1,26 @@
+# frozen_string_literal: true
+
 module CollectionSpace
   # CollectionSpace configuration
   class Configuration
-    def defaults
-      {
-        base_uri: nil,
-        username: nil,
-        password: nil,
-        page_size: 25,
-        include_deleted: false,
-        throttle: 0,
-        verify_ssl: true
-      }
-    end
+    DEFAULTS = {
+      base_uri: nil,
+      username: nil,
+      password: nil,
+      page_size: 25,
+      include_deleted: false,
+      throttle: 0,
+      verify_ssl: true
+    }.freeze
+
+    attr_accessor :base_uri, :username, :password, :page_size, :include_deleted, :throttle, :verify_ssl
 
     def initialize(settings = {})
-      settings = defaults.merge(settings)
+      settings = DEFAULTS.merge(settings)
       settings.each do |property, value|
-        next unless defaults.key? property
+        next unless DEFAULTS.key?(property)
 
         instance_variable_set("@#{property}", value)
-        self.class.send(:attr_accessor, property)
       end
     end
   end