collectionspace-client 0.1.5 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102021d7f34434b3f5a79382333ec7677ef7fba8dcdfd2f73daff1a7faa10b59
-  data.tar.gz: 2510a4f0c3932bb08545e9c263c4357faccad8c6183f43f2e8122bef740dc34c
+  metadata.gz: 89651eb1e87693f52f835cbe34eccc510f40888db54696a41082ae114a084817
+  data.tar.gz: e3c161e2a64848a1f0065e18da8aa23ad6117995daf62538cf5437bc0192cfc6
 SHA512:
-  metadata.gz: 90419be95bd910c0f17e9f0adc9918f702d985278a7b91d0cd531179bacac3e2ce1a1c08aa98510fb7ed66b258451f31923a2013c488110b4e7262383d199feb
-  data.tar.gz: 031e9d9b52bbe9a83a8c3234bc52f9cbcc5a09c89340c7016dc9d8e5075582954945632cdc133426f42fcbeb6d2fc56995fe1cc7059ca2ba1e30eee47f2b62ca
+  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/.rubocop.yml

@@ -0,0 +1,8 @@
+# .rubocop.yml
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - '*.rake'
+Metrics/BlockLength:
+  Exclude:
+    - !ruby/regexp /_spec.rb/

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

@@ -1,65 +1,22 @@
-CollectionSpace Client
-===
+# CollectionSpace Client
 
 CollectionSpace API client.
 
-Installation
----
+## 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
-
-Usage
----
-
-Basic usage:
-
-```ruby
-require 'collectionspace/client'
-
-config = CollectionSpace::Configuration.new({
-  base_uri: "https://cspace.muesum.org/cspace-services",
-  username: "admin@cspace.muesum.org",
-  password: "Administrator",
-})
-
-client = CollectionSpace::Client.new(config)
+And then execute `bundle install`.
 
-result = client.post_blob_uri "http://cspace.muesum.org/assets/mueseum.png"
+## Usage
 
-raise "=(" if result.status_code != 201
+See the sample scripts within the [examples](examples/) directory.
 
-search_args = {
-  path: "blobs",
-  type: "blobs_common",
-  field: "name",
-  expression: "ILIKE '%museum.png%'",
-}
-
-query = CollectionSpace::Search.new.from_hash search_args
-
-result = client.search(query)
-
-if result.status_code == 200
-  ap result.parsed['abstract_common_list']
-end
-```
-
-See the sample scripts within the `examples` directory for more.
-
-Development
----
+## Development
 
 To run the examples:
 
@@ -75,26 +32,23 @@ To run the tests:
 bundle exec rake
 ```
 
-Publishing
----
-
-Bump version in `lib/collectionspace/client/version.rb` then:
+## Releasing
 
 ```bash
-VERSION=0.1.5
-gem build collectionspace-client
-gem push collectionspace-client-$VERSION.gem
-git tag v$VERSION
-git push --tags
+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
----
+## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/lyrasis/collectionspace-client.
+Bug reports and pull requests are welcome on GitHub at https://github.com/collectionspace/collectionspace-client.
 
-License
----
+## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 

data/Rakefile

@@ -1,6 +1,47 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# 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 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

@@ -1,31 +1,33 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'collectionspace/client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "collectionspace-client"
+  spec.name          = 'collectionspace-client'
   spec.version       = CollectionSpace::Client::VERSION
-  spec.authors       = ["Mark Cooper"]
-  spec.email         = ["mark.cooper@lyrasis.org"]
+  spec.authors       = ['Mark Cooper']
+  spec.email         = ['mark.cooper@lyrasis.org']
 
-  spec.summary       = %q{CollectionSpace API client.}
-  spec.homepage      = "https://github.com/lyrasis/collectionspace-client.git"
-  spec.license       = "MIT"
+  spec.summary       = 'CollectionSpace API client.'
+  spec.homepage      = 'https://github.com/lyrasis/collectionspace-client.git'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "httparty"
-  spec.add_dependency "json"
-  spec.add_dependency "nokogiri"
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'json'
+  spec.add_dependency 'nokogiri'
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "awesome_print"
+  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,21 +1,22 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'awesome_print'
 require 'collectionspace/client'
 
-# CREATE CLIENT WITH DEFAULT (DEMO) CONFIGURATION -- BE NICE!!!
-client = CollectionSpace::Client.new
-client.config.throttle = 1
+client = CollectionSpace::Client.new(
+  CollectionSpace::Configuration.new(
+    base_uri: 'https://core.dev.collectionspace.org/cspace-services',
+    username: 'admin@core.collectionspace.org',
+    password: 'Administrator'
+  )
+)
 
 # GET REQUEST FOR CONDITIONCHECK RECORDS AND PRINT THE PARSED RESPONSE AND XML
 response = client.get('conditionchecks')
-if response.status_code == 200
-  ap response.parsed
-  ap response.xml
-end
+ap response.parsed if response.result.success?
 
-# GET ALL INTAKE RECORDS AND PROCESS PER PAGE (INSTEAD OF WAITING FOR ALL)
-client.all('media').each do |item|
-  uri    = item["uri"]
-  intake = client.get uri
-  ap intake.parsed
+# 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

data/examples/media_with_external_file.rb

@@ -1,26 +1,28 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'awesome_print'
 require 'collectionspace/client'
 
-# CREATE CLIENT WITH DEFAULT (DEMO) CONFIGURATION -- BE NICE!!!
-client = CollectionSpace::Client.new
+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
 
-# ap client.get('media/c453755d-3442-4516-9883').xml.to_xml
-
-media_url = "https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"
+media_url = 'https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png'
 media = <<-XML
-<?xml version="1.0" encoding="UTF-8"?>
-<document name="media">
-  <ns2:media_common xmlns:ns2="http://collectionspace.org/services/media" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-    <title>GOOGLE</title>
-    <identificationNumber>GOOGLE-1</identificationNumber>
-  </ns2:media_common>
-</document>
+  <?xml version="1.0" encoding="UTF-8"?>
+  <document name="media">
+    <ns2:media_common xmlns:ns2="http://collectionspace.org/services/media" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+      <title>GOOGLE</title>
+      <identificationNumber>GOOGLE-1</identificationNumber>
+    </ns2:media_common>
+  </document>
 XML
 
-response = client.post('media', media, { query: { "blobUri" => media_url } })
-puts response.status_code
-if response.status_code == 201
-  puts response.headers['location']
-end
+response = client.post('media', media, query: { 'blobUri' => media_url })
+puts response.result.headers['location'] if response.result.success?

data/examples/purge_empty_vocabs.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+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'
+  )
+)
+client.config.throttle = 1
+
+client.all('vocabularies').each do |item|
+  uri = item['uri']
+  puts "Checking vocabulary: #{uri}"
+  next unless client.count("#{uri}/items").zero?
+
+  puts "Purging empty vocabulary:\t#{item['displayName']} (#{item['csid']})"
+  client.delete uri
+end

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