collectionspace-client 0.1.5 → 0.14.1

data/lib/collectionspace/client/response.rb

@@ -1,20 +1,25 @@
-module CollectionSpace
+# frozen_string_literal: true
 
+module CollectionSpace
+  # CollectionSpace response
   class Response
-    attr_reader :result, :parsed, :body, :headers, :status, :status_code, :xml
+    attr_reader :result, :parsed, :status_code, :xml
 
     def initialize(result)
-      # throw error
       @result      = result
       @parsed      = result.parsed_response
-      @body        = result.body
-      @headers     = result.headers
-      @status      = result.response
       @status_code = result.code.to_i
-
-      @xml = (@status_code.to_s =~ /^2/ and @body =~ /<?xml/) ? Nokogiri::XML(@body) : nil
+      body = result.body
+      @xml = @result.success? && body =~ /<?xml/ ? Nokogiri::XML(body) : nil
     end
 
-  end
+    def find(list_type, item_type, property, value)
+      total = parsed[list_type]['totalItems'].to_i
+      return unless total.positive?
 
-end
+      list   = parsed[list_type][item_type]
+      list   = [list] if total == 1 # wrap if single item
+      list.find { |i| i[property] == value }
+    end
+  end
+end

data/lib/collectionspace/client/search.rb

@@ -1,10 +1,17 @@
-module CollectionSpace
+# frozen_string_literal: true
 
+module CollectionSpace
+  # CollectionSpace search
   class Search
-    attr_accessor :path, :type, :field, :expression
+    attr_accessor :path, :namespace, :field, :expression
+
+    DEFAULT_SORT = 'collectionspace_core:updatedAt DESC'
 
-    def initialize(path: nil, type: nil, field: nil, expression: nil)
-      @path, @type, @field, @expression = path, type, field, expression
+    def initialize(path: nil, namespace: nil, field: nil, expression: nil)
+      @path       = path
+      @namespace  = namespace
+      @field      = field
+      @expression = expression
     end
 
     def from_hash(query)
@@ -13,7 +20,5 @@ module CollectionSpace
       end
       self
     end
-
   end
-
-end
+end

data/lib/collectionspace/client/service.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module CollectionSpace
+  # CollectionSpace service
+  class Service
+    TERM_SUFFIX = 'TermGroupList/0/termDisplayName'
+    def self.get(type:, subtype: '')
+      {
+        'acquisitions' => {
+          identifier: 'acquisitionReferenceNumber',
+          ns_prefix: 'acquisitions',
+          path: 'acquisitions',
+          term: nil
+        },
+        'citationauthorities' => {
+          identifier: 'shortIdentifier',
+          ns_prefix: 'citations',
+          path: "citationauthorities/urn:cspace:name(#{subtype})/items",
+          term: "citation#{TERM_SUFFIX}"
+        },
+        'claims' => {
+          identifier: 'claimNumber',
+          ns_prefix: 'claims',
+          path: 'claims',
+          term: nil
+        },
+        'collectionobjects' => {
+          identifier: 'objectNumber',
+          ns_prefix: 'collectionobjects',
+          path: 'collectionobjects',
+          term: nil
+        },
+        'conceptauthorities' => {
+          identifier: 'shortIdentifier',
+          ns_prefix: 'concepts',
+          path: "conceptauthorities/urn:cspace:name(#{subtype})/items",
+          term: "concept#{TERM_SUFFIX}"
+        },
+        'conditionchecks' => {
+          identifier: 'conditionCheckRefNumber',
+          ns_prefix: 'conditionchecks',
+          path: 'conditionchecks',
+          term: nil
+        },
+        'conservation' => {
+          identifier: 'conservationNumber',
+          ns_prefix: 'conservation',
+          path: 'conservation',
+          term: nil
+        },
+        'exhibitions' => {
+          identifier: 'exhibitionNumber',
+          ns_prefix: 'exhibitions',
+          path: 'exhibitions',
+          term: nil
+        },
+        'groups' => {
+          identifier: 'title',
+          ns_prefix: 'groups',
+          path: 'groups',
+          term: nil
+        },
+        'insurances' => {
+          identifier: 'insuranceIndemnityReferenceNumber',
+          ns_prefix: 'insurances',
+          path: 'insurances',
+          term: nil
+        },
+        'intakes' => {
+          identifier: 'entryNumber',
+          ns_prefix: 'intakes',
+          path: 'intakes',
+          term: nil
+        },
+        'loansin' => {
+          identifier: 'loanInNumber',
+          ns_prefix: 'loansin',
+          path: 'loansin',
+          term: nil
+        },
+        'loansout' => {
+          identifier: 'loanOutNumber',
+          ns_prefix: 'loansout',
+          path: 'loansout',
+          term: nil
+        },
+        'locationauthorities' => {
+          identifier: 'shortIdentifier',
+          ns_prefix: 'locations',
+          path: "locationauthorities/urn:cspace:name(#{subtype})/items",
+          term: "loc#{TERM_SUFFIX}"
+        },
+        'materialauthorities' => {
+          identifier: 'shortIdentifier',
+          ns_prefix: 'materials',
+          path: "materialauthorities/urn:cspace:name(#{subtype})/items",
+          term: "material#{TERM_SUFFIX}"
+        },
+        'media' => {
+          identifier: 'identificationNumber',
+          ns_prefix: 'media',
+          path: 'media',
+          term: nil
+        },
+        'movements' => {
+          identifier: 'movementReferenceNumber',
+          ns_prefix: 'movements',
+          path: 'movements',
+          term: nil
+        },
+        'objectexit' => {
+          identifier: 'exitNumber',
+          ns_prefix: 'objectexit',
+          path: 'objectexit',
+          term: nil
+        },
+        'orgauthorities' => {
+          identifier: 'shortIdentifier',
+          ns_prefix: 'organizations',
+          path: "orgauthorities/urn:cspace:name(#{subtype})/items",
+          term: "org#{TERM_SUFFIX}"
+        },
+        'osteology' => {
+          identifier: 'InventoryID',
+          ns_prefix: 'osteology',
+          path: 'osteology',
+          term: nil
+        },
+        'personauthorities' => {
+          identifier: 'shortIdentifier',
+          ns_prefix: 'persons',
+          path: "personauthorities/urn:cspace:name(#{subtype})/items",
+          term: "person#{TERM_SUFFIX}"
+        },
+        'placeauthorities' => {
+          identifier: 'shortIdentifier',
+          ns_prefix: 'places',
+          path: "placeauthorities/urn:cspace:name(#{subtype})/items",
+          term: "place#{TERM_SUFFIX}"
+        },
+        'pottags' => {
+          identifier: 'potTagNumber',
+          ns_prefix: 'pottags',
+          path: 'pottags',
+          term: nil
+        },
+        'propagations' => {
+          identifier: 'propNumber',
+          ns_prefix: 'propagations',
+          path: 'propagations',
+          term: nil
+        },
+        'relations' => {
+          identifier: 'csid',
+          ns_prefix: 'relations',
+          path: 'relations',
+          term: nil
+        },
+        'taxonomyauthority' => {
+          identifier: 'shortIdentifier',
+          ns_prefix: 'taxon',
+          path: "taxonomyauthority/urn:cspace:name(#{subtype})/items",
+          term: "taxon#{TERM_SUFFIX}"
+        },
+        'transports' => {
+          identifier: 'transportReferenceNumber',
+          ns_prefix: 'transports',
+          path: 'transports',
+          term: nil
+        },
+        'uoc' => {
+          identifier: 'referenceNumber',
+          ns_prefix: 'uoc',
+          path: 'uoc',
+          term: nil
+        },
+        'valuationcontrols' => {
+          identifier: 'valuationcontrolRefNumber',
+          ns_prefix: 'valuationcontrols',
+          path: 'valuationcontrols',
+          term: nil
+        },
+        'vocabularies' => {
+          identifier: 'shortIdentifier',
+          ns_prefix: 'vocabularyitems',
+          path: "vocabularies/urn:cspace:name(#{subtype})/items",
+          term: 'displayName'
+        },
+        'workauthorities' => {
+          identifier: 'shortIdentifier',
+          ns_prefix: 'works',
+          path: "workauthorities/urn:cspace:name(#{subtype})/items",
+          term: "work#{TERM_SUFFIX}"
+        }
+      }.fetch(type)
+    end
+  end
+end

data/lib/collectionspace/client/template.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CollectionSpace
+  module Template
+    def self.list
+      Dir.glob File.join(templates_path, '*.erb')
+    end
+
+    def self.process(template, data)
+      t = ERB.new(read(template))
+      r = t.result(binding).gsub(/\n+/, "\n")
+      Nokogiri::XML.parse(r).to_xml
+    end
+
+    def self.read(file)
+      File.read("#{templates_path}/#{file}.xml.erb")
+    end
+
+    def self.templates_path
+      ENV.fetch(
+        'COLLECTIONSPACE_CLIENT_TEMPLATES_PATH',
+        File.join(File.dirname(File.expand_path(__FILE__)), 'templates')
+      )
+    end
+  end
+end

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

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

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

@@ -0,0 +1,5 @@
+<?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>

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

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes"?>
+<document name="batch">
+  <ns2:batch_common xmlns:ns2="http://collectionspace.org/services/batch" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <name>Reindex Full Text</name>
+    <notes>Recomputes the indexed full text of all or specified records.</notes>
+    <className>org.collectionspace.services.batch.nuxeo.ReindexFullTextBatchJob</className>
+    <supportsNoContext>true</supportsNoContext>
+    <supportsSingleDoc>true</supportsSingleDoc>
+    <supportsDocList>true</supportsDocList>
+    <supportsGroup>false</supportsGroup>
+    <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>
+      <forDocType>Contact</forDocType>
+      <forDocType>Dimension</forDocType>
+      <forDocType>Group</forDocType>
+      <forDocType>Intake</forDocType>
+      <forDocType>Loanin</forDocType>
+      <forDocType>Loanout</forDocType>
+      <forDocType>Locationauthority</forDocType>
+      <forDocType>Locationitem</forDocType>
+      <forDocType>Media</forDocType>
+      <forDocType>Movement</forDocType>
+      <forDocType>ObjectExit</forDocType>
+      <forDocType>Organization</forDocType>
+      <forDocType>Orgauthority</forDocType>
+      <forDocType>Osteology</forDocType>
+      <forDocType>Person</forDocType>
+      <forDocType>Personauthority</forDocType>
+      <forDocType>Placeauthority</forDocType>
+      <forDocType>Placeitem</forDocType>
+      <forDocType>PublicItem</forDocType>
+      <forDocType>Relation</forDocType>
+      <forDocType>Report</forDocType>
+      <forDocType>Taxon</forDocType>
+      <forDocType>Taxonomyauthority</forDocType>
+      <forDocType>Vocabulary</forDocType>
+      <forDocType>Vocabularyitem</forDocType>
+      <forDocType>Workauthority</forDocType>
+      <forDocType>Workitem</forDocType>
+    </forDocTypes>
+  </ns2:batch_common>
+</document>

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

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document name="reports">
+  <ns2:reports_common xmlns:ns2="http://collectionspace.org/services/report">
+    <name><%= data.fetch(:name) %></name>
+    <notes><%= data.fetch(:notes, data[:name]) %></notes>
+    <forDocTypes>
+      <forDocType><%= data.fetch(:doctype) %></forDocType>
+    </forDocTypes>
+    <supportsSingleDoc><%= data.fetch(:supports_single_doc, 'true') %></supportsSingleDoc>
+    <supportsDocList><%= data.fetch(:supports_doc_list, 'false') %></supportsDocList>
+    <supportsGroup><%= data.fetch(:supports_group, 'false') %></supportsGroup>
+    <supportsNoContext><%= data.fetch(:supports_no_context, 'true') %></supportsNoContext>
+    <filename><%= data.fetch(:filename) %></filename>
+    <outputMIME><%= data.fetch(:mimetype, 'application/pdf') %></outputMIME>
+  </ns2:reports_common>
+</document>

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

@@ -0,0 +1,6 @@
+<?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">
+    <identificationNumber><%= data[:id] %></identificationNumber>
+  </ns2:media_common>
+</document>

data/lib/collectionspace/client/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module CollectionSpace
   class Client
-    VERSION = "0.1.5"
+    VERSION = '0.14.1'
   end
 end

data/lib/collectionspace/client.rb

@@ -1,21 +1,30 @@
+# frozen_string_literal: true
+
 require 'httparty'
 require 'nokogiri'
 require 'uri'
 
 # mixins required first
-require "collectionspace/client/helpers"
+require 'collectionspace/client/helpers'
+require 'collectionspace/client/template'
 
-require "collectionspace/client/client"
-require "collectionspace/client/configuration"
-require "collectionspace/client/request"
-require "collectionspace/client/response"
-require "collectionspace/client/search"
-require "collectionspace/client/version"
+require 'collectionspace/client/client'
+require 'collectionspace/client/configuration'
+require 'collectionspace/client/refname'
+require 'collectionspace/client/request'
+require 'collectionspace/client/response'
+require 'collectionspace/client/search'
+require 'collectionspace/client/service'
+require 'collectionspace/client/version'
 
 module CollectionSpace
+  class ArgumentError < StandardError; end
+
+  class DuplicateIdFound < StandardError; end
+
+  class NotFoundError < StandardError; end
 
-  class ArgumentError < Exception ; end
-  class PayloadError  < Exception ; end
-  class RequestError  < Exception ; end
+  class PayloadError  < StandardError; end
 
-end
+  class RequestError  < StandardError; end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collectionspace-client
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.14.1
 platform: ruby
 authors:
 - Mark Cooper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2022-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +137,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -143,26 +185,40 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/rspec
 - collectionspace-client.gemspec
 - examples/demo.rb
-- examples/export.rb
 - examples/media_with_external_file.rb
-- examples/purge-empty-vocabularies.rb
+- examples/purge_empty_vocabs.rb
+- examples/reports.rb
 - examples/search.rb
+- examples/update_password.rb
 - lib/collectionspace/client.rb
 - lib/collectionspace/client/client.rb
 - lib/collectionspace/client/configuration.rb
 - lib/collectionspace/client/helpers.rb
+- lib/collectionspace/client/refname.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/reindex_by_csids.xml.erb
+- lib/collectionspace/client/templates/reindex_by_doctype.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/version.rb
 homepage: https://github.com/lyrasis/collectionspace-client.git
 licenses:
@@ -183,8 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.3.18
 signing_key: 
 specification_version: 4
 summary: CollectionSpace API client.

data/examples/export.rb

@@ -1,31 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'awesome_print'
-require 'collectionspace/client'
-require 'date'
-
-# MONKEY PATCHING FOR RAILS LIKE 3.days.ago
-class Fixnum
-  SECONDS_IN_DAY = 24 * 60 * 60
-
-  def days
-    self * SECONDS_IN_DAY
-  end
-
-  def ago
-    Time.now - self
-  end
-end
-
-# CREATE CLIENT WITH DEFAULT (DEMO) CONFIGURATION -- BE NICE!!!
-client = CollectionSpace::Client.new
-client.config.throttle = 1
-
-# GET ALL CATALOGING RECORDS AND DUMP THE XML IF UPDATED SINCE 3 DAYS AGO
-client.all('collectionobjects').each do |item|
-  updated = Date.parse item["updatedAt"]
-  if updated > Date.parse(14.days.ago.to_s)
-    collectionobject = client.get item["uri"]
-    # TO EXPORT WRITE THE BODY TO FILE, HERE WE JUST PRINT IT
-    ap collectionobject.body # OR .xml.to_s
-  end
-end

data/examples/purge-empty-vocabularies.rb

@@ -1,17 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'awesome_print'
-require 'collectionspace/client'
-
-# CREATE CLIENT WITH DEFAULT (DEMO) CONFIGURATION -- BE NICE!!!
-client = CollectionSpace::Client.new
-client.config.throttle = 1
-
-client.all('vocabularies').each do |item|
-  uri = item["uri"]
-  puts "Checking vocabulary: #{uri}"
-  if client.count("#{uri}/items") == 0
-    puts "Purging empty vocabulary:\t#{item['displayName']} (#{item['csid']})"
-    # YOU WOULD UNCOMMENT THIS TO ACTUALLY PERFORM THE PURGE ...
-    # client.delete uri
-  end
-end