collectionspace-client 0.3.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e63c182e9731f5868556d805eed65b8c85d32789363c90f4ac763cff06e2b693
-  data.tar.gz: 00d6e5804a0131adad73d28eee0dd32a95dd9b9a05346bf4e1374d54bfa1f2b5
+  metadata.gz: d797561c0b44c79ce0bda224d05ff05de6fa7c932b2c33d4a9c888116c6d6fbb
+  data.tar.gz: bfbd46caa314f5fc6620b468e14e262983f3f52a444622ef55669c60ad5c4f84
 SHA512:
-  metadata.gz: fa76fc6c2b8f1761c01dc195198445eba31698d0d530d0993c5fa64ceb1ace2fbc44153a7d8c4dd29fe3d272463e1f82d3185f5a8d46ddfbec9252f0b8ec0ca5
-  data.tar.gz: b67294a65c42c52804af6e429f45e2ea9bcb1a5e4ea4d78fb3da0cfeafb8018221d835a29b81c48fea6e43b287b88e549e6bfd746f124a9814c1079fdae3abc7
+  metadata.gz: 697f5207854022997a0acf1e2249113c763447a5597677d4b7f7b157244467a2c0bee0d163d152ee2191950e41c9478a21443f967087c87e85a765c137542865
+  data.tar.gz: 71d59341de8048599691df601042915c803c10c6710982c76eeda366684aab1ba27ce694a285bcf349d9de08faba78d4951838114ff96059f24c417dc6b9f1a8

data/.git-blame-ignore-revs

@@ -0,0 +1,8 @@
+# Appease standard
+63444da90ce50afd5d282c6cfb5ca6dc3210be7d
+# Lint/format
+0dc6263edaed69d0d472626974a1317c059b3337
+# Make standard happy
+5cbdb2d41997f05e6cbad814c11e2893706ac152
+# Use standard for linting
+e5ba9f76a333609734079c3ec6102c2cbe4974b7

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+on: [pull_request]
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.2', '3.1', '3.0']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Lint
+        run: |
+          bundle exec standardrb
+
+      - name: Run tests
+        run: |
+          bundle exec rake

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,9 @@
 *.gem
+*.jpg
+*.pdf
 *.swp
 /.bundle/
+/.vscode
 /.yardoc
 /Gemfile.lock
 /_yardoc/
@@ -9,5 +12,8 @@
 /examples/my_*.rb
 /pkg/
 /spec/reports/
+.byebug_history
+.rspec_status
 /tmp/
 collectionobject.rb
+coverage

data/.rubocop.yml

@@ -1,8 +1,4 @@
-# .rubocop.yml
-AllCops:
-  Exclude:
-    - '*.gemspec'
-    - '*.rake'
-Metrics/BlockLength:
-  Exclude:
-    - !ruby/regexp /_spec.rb/
+require: standard
+
+inherit_gem:
+  standard: config/base.yml

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in collectionspace-client.gemspec
 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 --pretend # dryrun
+gem bump --version minor # do it for real
+# PR and merge will publish new version
 ```
 
 ## Contributing

data/Rakefile

@@ -1,6 +1,48 @@
-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"
+require "standard/rake"
 
 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 /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    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,34 @@
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'collectionspace/client/version'
+require "collectionspace/client/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'collectionspace-client'
-  spec.version       = CollectionSpace::Client::VERSION
-  spec.authors       = ['Mark Cooper']
-  spec.email         = ['mark.cooper@lyrasis.org']
+  spec.name = "collectionspace-client"
+  spec.version = CollectionSpace::Client::VERSION
+  spec.authors = ["Mark Cooper"]
+  spec.email = ["mark.cooper@lyrasis.org"]
 
-  spec.summary       = '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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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 'awesome_print'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'vcr'
-  spec.add_development_dependency 'webmock'
+  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 "rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "vcr", "~> 6.1"
+  spec.add_development_dependency "webmock"
 end

data/examples/batches.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Install batches (aka data updates)
+# Based on:
+# https://github.com/collectionspace/Tools/blob/master/scripts/install_batch_records.sh
+# https://github.com/collectionspace/Tools/blob/master/scripts/create-batch-records.sh
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "awesome_print"
+require "collectionspace/client"
+require "pry"
+
+STANDARD_TENANTS = [
+  :anthro,
+  :bonsai,
+  :botgarden,
+  :core,
+  :fcart,
+  :herbarium,
+  :lhmc,
+  :materials,
+  :publicart
+]
+
+STANDARD_BATCHES = CollectionSpace::Batch.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://")
+  merge_doctypes = client.authority_doctypes
+
+  STANDARD_BATCHES.each do |batch|
+    batch[:doctype] = merge_doctypes if batch[:name] == "Merge Authority Items"
+    response = client.add_batch(batch)
+    if response.result.success?
+      puts "Added #{batch[:name]} to #{base}"
+    else
+      puts "FAILED TO ADD #{batch[:name]} to #{base}"
+      puts response.inspect
+    end
+  end
+end

data/examples/demo.rb

@@ -1,20 +1,22 @@
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'awesome_print'
-require 'collectionspace/client'
+# 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'
+    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')
+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|
+client.all("personauthorities/urn:cspace:name(person)/items").each do |item|
   puts item
 end

data/examples/media_with_external_file.rb

@@ -1,17 +1,19 @@
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'awesome_print'
-require 'collectionspace/client'
+# 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'
+    base_uri: "https://core.dev.collectionspace.org/cspace-services",
+    username: "admin@core.collectionspace.org",
+    password: "Administrator"
   )
 )
 client.config.throttle = 1
 
-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">
@@ -22,5 +24,5 @@ media = <<-XML
   </document>
 XML
 
-response = client.post('media', media, query: { 'blobUri' => media_url })
-puts response.result.headers['location'] if response.result.success?
+response = client.post("media", media, query: {"blobUri" => media_url})
+puts response.result.headers["location"] if response.result.success?

data/examples/purge_empty_vocabs.rb

@@ -1,20 +1,22 @@
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'collectionspace/client'
+# 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'
+    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']
+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']})"
+  puts "Purging empty vocabulary:\t#{item["displayName"]} (#{item["csid"]})"
   client.delete uri
 end

data/examples/reports.rb

@@ -0,0 +1,45 @@
+# 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"
+    )
+  )
+  base = client.config.base_uri
+    .delete_suffix("/cspace-services")
+    .delete_prefix("https://")
+
+  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,21 +1,34 @@
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'awesome_print'
-require 'collectionspace/client'
+# frozen_string_literal: true
+
+$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',
-  type: 'groups_common',
-  field: 'title',
-  expression: "ILIKE '%DTS 001%'"
+  path: "groups",
+  namespace: "groups_common",
+  field: "title",
+  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"