collectionspace-client 0.3.0 → 0.15.0

data/lib/collectionspace/client/report.rb

@@ -0,0 +1,180 @@
+# 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/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CollectionSpace
   # CollectionSpace request
   class Request
@@ -9,21 +11,21 @@ module CollectionSpace
         delete: {},
         get: {},
         post: {
-          'Content-Type' => 'application/xml',
-          'Content-Length' => 'nnnn'
+          "Content-Type" => "application/xml",
+          "Content-Length" => "nnnn"
         },
         put: {
-          'Content-Type' => 'application/xml',
-          'Content-Length' => 'nnnn'
+          "Content-Type" => "application/xml",
+          "Content-Length" => "nnnn"
         }
       }
       headers[method]
     end
 
-    def initialize(config, method = 'GET', path = '', options = {})
+    def initialize(config, method = "GET", path = "", options = {})
       @config = config
       @method = method.downcase.to_sym
-      @path   = path.gsub(%r{^/}, '')
+      @path = path.gsub(%r{^/}, "")
 
       @auth = {
         username: config.username,
@@ -33,11 +35,12 @@ module CollectionSpace
       headers = default_headers(@method).merge(options.fetch(:headers, {}))
       @options = options
       @options[:basic_auth] = @auth
-      @options[:headers]    = headers
-      @options[:verify]     = config.verify_ssl
-      @options[:query]      = options.fetch(:query, {})
+      @options[:headers] = headers
+      @options[:verify] = config.verify_ssl
+      @options[:query] = options.fetch(:query, {})
 
       self.class.base_uri config.base_uri
+      self.class.debug_output $stdout if config.verbose
       self.class.default_params(
         wf_deleted: config.include_deleted,
         pgSz: config.page_size

data/lib/collectionspace/client/response.rb

@@ -1,14 +1,25 @@
+# frozen_string_literal: true
+
 module CollectionSpace
   # CollectionSpace response
   class Response
     attr_reader :result, :parsed, :status_code, :xml
 
     def initialize(result)
-      @result      = result
-      @parsed      = result.parsed_response
+      @result = result
+      @parsed = result.parsed_response
       @status_code = result.code.to_i
       body = result.body
-      @xml = @result.success? && body =~ /<?xml/ ? Nokogiri::XML(body) : nil
+      @xml = (@result.success? && body =~ /<?xml/) ? Nokogiri::XML(body) : nil
+    end
+
+    def find(list_type, item_type, property, value)
+      total = parsed[list_type]["totalItems"].to_i
+      return unless total.positive?
+
+      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,12 +1,16 @@
+# 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       = path
-      @type       = type
-      @field      = field
+    def initialize(path: nil, namespace: nil, field: nil, expression: nil)
+      @path = path
+      @namespace = namespace
+      @field = field
       @expression = expression
     end
 

data/lib/collectionspace/client/service.rb

@@ -0,0 +1,204 @@
+# 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
+        },
+        "iterationreports" => {
+          identifier: "iterationIdentificationNumber",
+          ns_prefix: "iterationreports",
+          path: "iterationreports",
+          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).squeeze("\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/batch.xml.erb

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document name="batch">
+  <ns2:batch_common xmlns:ns2="http://collectionspace.org/services/batch">
+    <name><%= data.fetch(:name) %></name>
+    <notes><%= data.fetch(:notes, data[:name]) %></notes>
+    <forDocTypes>
+      <% data.fetch(:doctype).each do |doctype| %>
+        <forDocType><%= doctype %></forDocType>
+      <% end %>
+    </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>
+    <createsNewFocus><%= data.fetch(:creates_new_focus, 'false') %></createsNewFocus>
+    <className><%= data.fetch(:classname) %></className>
+  </ns2:batch_common>
+</document>

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.3.0'.freeze
+    VERSION = "0.15.0"
   end
 end