collectionspace-client 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102021d7f34434b3f5a79382333ec7677ef7fba8dcdfd2f73daff1a7faa10b59
-  data.tar.gz: 2510a4f0c3932bb08545e9c263c4357faccad8c6183f43f2e8122bef740dc34c
+  metadata.gz: 624c2100ab4de83a3748eea7ec37a0fd4743cdda9365e8ccd29d452b11f0b8ad
+  data.tar.gz: 7f25d8c31ad74c28999de4bb5c5822f655f947154828174a3351d818e036a5f1
 SHA512:
-  metadata.gz: 90419be95bd910c0f17e9f0adc9918f702d985278a7b91d0cd531179bacac3e2ce1a1c08aa98510fb7ed66b258451f31923a2013c488110b4e7262383d199feb
-  data.tar.gz: 031e9d9b52bbe9a83a8c3234bc52f9cbcc5a09c89340c7016dc9d8e5075582954945632cdc133426f42fcbeb6d2fc56995fe1cc7059ca2ba1e30eee47f2b62ca
+  metadata.gz: d65eaf040bb629d702085af054b47b2f39411784c0f8f7cdb032f48af79f99b846ef1f803ef357634d477f4b4d7c9f585e07c1d5b5e9476f22247b67ae0cd00c
+  data.tar.gz: 0661b69f11ea60a5ce5edc94f753a048a7ec6ce2585c855c69af25e4cfb1998106a13132e42fdbe8b70a5184a6032c817650253ebf215930a83ba7e1dd73a42d

data/.rubocop.yml

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

data/README.md

@@ -1,10 +1,8 @@
-CollectionSpace Client
-===
+# CollectionSpace Client
 
 CollectionSpace API client.
 
-Installation
----
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -12,54 +10,13 @@ Add this line to your application's Gemfile:
 gem 'collectionspace-client'
 ```
 
-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)
-
-result = client.post_blob_uri "http://cspace.muesum.org/assets/mueseum.png"
-
-raise "=(" if result.status_code != 201
+And then execute `bundle install`, or install it yourself as: `gem install collectionspace-client`.
 
-search_args = {
-  path: "blobs",
-  type: "blobs_common",
-  field: "name",
-  expression: "ILIKE '%museum.png%'",
-}
+## Usage
 
-query = CollectionSpace::Search.new.from_hash search_args
+See the sample scripts within the [examples](examples/) directory.
 
-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,26 @@ To run the tests:
 bundle exec rake
 ```
 
-Publishing
----
+## Publishing
 
 Bump version in `lib/collectionspace/client/version.rb` then:
 
 ```bash
-VERSION=0.1.5
-gem build collectionspace-client
-gem push collectionspace-client-$VERSION.gem
+VERSION=0.2.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
 ```
 
-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,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/collectionspace-client.gemspec

@@ -1,31 +1,31 @@
-# 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 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  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__)
+$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
 
 # 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
+client.all('personauthorities').each do |item|
+  i = client.get item['uri']
+  ap i.parsed
 end

data/examples/media_with_external_file.rb

@@ -1,26 +1,26 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$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,20 @@
+$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/search.rb

@@ -1,67 +1,21 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$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
+config = CollectionSpace::Configuration.new(
+  base_uri: 'https://core.dev.collectionspace.org/cspace-services',
+  username: 'admin@core.collectionspace.org',
+  password: 'Administrator'
+)
 
-# EXAMPLE NESTED ATTRIBUTE SEARCH
-search_args = {
-  path: "collectionobjects",
-  type: "collectionobjects_common",
-  field: 'titleGroupList/*1/title',
-  expression: "ILIKE '%blue%'",
-}
-
-query = CollectionSpace::Search.new.from_hash search_args
-ap client.search(query).parsed
-
-# SEARCH AND REFORMAT RESULTS
-
-# assume retrieved for collectionobject i.e.: AttributeMap.where(type: 'collectionobject')
-attribute_map = [
-  { field: 'title', key: 'collectionobjects_common', nested_key: 'title', with: nil },
-  { field: 'title_type', key: 'collectionobjects_common', nested_key: 'titleType', with: nil },
-  { field: 'display_date', key: 'collectionobjects_common', nested_key: 'dateDisplayDate', with: nil },
-  { field: 'object_production_person_group', key: 'collectionobjects_common', nested_key: 'objectProductionPersonGroup', with: 'objectProductionPerson' },
-  { field: 'content_persons', key: 'collectionobjects_common', nested_key: 'contentPersons', with: 'contentPerson' },
-  { field: 'responsible_department', key: 'collectionobjects_common', nested_key: 'responsibleDepartment', with: nil },
-  { field: 'created_by', key: 'collectionspace_core', nested_key: 'createdBy', with: nil },
-  { field: 'created_at', key: 'collectionspace_core', nested_key: 'createdAt', with: nil },
-  { field: 'updated_at', key: 'collectionspace_core', nested_key: 'updatedAt', with: nil },
-]
+client = CollectionSpace::Client.new(config)
 
 search_args = {
-  path: "collectionobjects",
-  type: "collectionspace_core",
-  field: 'updatedAt',
-  expression: ">= TIMESTAMP '2015-12-17T00:00:00'",
+  path: 'groups',
+  type: 'groups_common',
+  field: 'title',
+  expression: "ILIKE '%DTS 001%'"
 }
 
-query = CollectionSpace::Search.new.from_hash search_args
-
-result = client.search(query)
-if result.status_code == 200
-  data = result.parsed["abstract_common_list"]["list_item"]
-  data.each do |item|
-    record = client.get(item["uri"]).parsed
-
-    attributes = {}
-    attribute_map.each do |map|
-      if map[:with]
-        as = client.deep_find(record, map[:key], map[:nested_key])
-        values = []
-        if as.is_a? Array
-          values = as.map { |a| client.strip_refname( client.deep_find(a, map[:with]) ) }
-        elsif as.is_a? Hash and as[ map[:with] ]
-          values = as[ map[:with] ].is_a?(Array) ? as[ map[:with] ].map { |a| client.strip_refname(a) } : [ client.strip_refname(as[ map[:with] ]) ]
-        end
-        attributes[map[:field]] = values
-      else
-        attributes[map[:field]] = client.deep_find(record, map[:key], map[:nested_key])
-      end
-    end
-    # PRINT REFORMATTED RESULTS
-    ap attributes
-  end
-end
+response = client.search(CollectionSpace::Search.new.from_hash(search_args))
+ap response.parsed['abstract_common_list'] if response.result.success?

data/lib/collectionspace/client/client.rb

@@ -1,12 +1,14 @@
 module CollectionSpace
-
+  # CollectionSpace client
   class Client
-    include DeepFind
     include Helpers
     attr_reader :config
 
     def initialize(config = Configuration.new)
-      raise "Invalid configuration object" unless config.kind_of? CollectionSpace::Configuration
+      unless config.is_a? CollectionSpace::Configuration
+        raise CollectionSpace::ArgumentError, 'Invalid configuration object'
+      end
+
       @config = config
     end
 
@@ -14,15 +16,14 @@ module CollectionSpace
       request 'GET', path, options
     end
 
-    # additional_options: { query: { foo: 'bar' } }
-    def post(path, payload, additional_options = {})
-      raise PayloadError.new, Nokogiri::XML(payload).errors if Nokogiri::XML(payload).errors.any?
-      request 'POST', path, { body: payload }.merge(additional_options)
+    def post(path, payload, options = {})
+      check_payload(payload)
+      request 'POST', path, { body: payload }.merge(options)
     end
 
     def put(path, payload)
-      raise PayloadError.new, Nokogiri::XML(payload).errors if Nokogiri::XML(payload).errors.any?
-      request 'PUT', path, { body: payload }
+      check_payload(payload)
+      request 'PUT', path, body: payload
     end
 
     def delete(path)
@@ -31,12 +32,14 @@ module CollectionSpace
 
     private
 
+    def check_payload(payload)
+      errors = Nokogiri::XML(payload).errors
+      raise CollectionSpace::PayloadError, errors if errors.any?
+    end
+
     def request(method, path, options = {})
       sleep config.throttle
-      result = Request.new(config, method, path, options).execute
-      Response.new result
+      Response.new(Request.new(config, method, path, options).execute)
     end
-
   end
-
 end

data/lib/collectionspace/client/configuration.rb

@@ -1,28 +1,26 @@
 module CollectionSpace
-
+  # CollectionSpace configuration
   class Configuration
-
     def defaults
       {
-        base_uri: "https://core.collectionspace.org/cspace-services",
-        username: "admin@core.collectionspace.org",
-        password: "Administrator",
-        page_size: 50,
+        base_uri: nil,
+        username: nil,
+        password: nil,
+        page_size: 25,
         include_deleted: false,
         throttle: 0,
-        verify_ssl: true,
+        verify_ssl: true
       }
     end
 
     def initialize(settings = {})
       settings = defaults.merge(settings)
       settings.each do |property, value|
-        next unless defaults.keys.include? property
+        next unless defaults.key? property
+
         instance_variable_set("@#{property}", value)
         self.class.send(:attr_accessor, property)
       end
     end
-
   end
-
 end

data/lib/collectionspace/client/helpers.rb

@@ -1,36 +1,21 @@
 module CollectionSpace
-
-  # http://www.garrettqmartin.com/2015/02/03/finding-deeply-nested-hash-keys/
-  module DeepFind
-    def deep_find(obj, key, nested_key = nil)
-      return obj[key] if obj.respond_to?(:key?) && obj.key?(key)
-      if obj.is_a? Enumerable
-        found = nil
-        obj.find { |*a| found = deep_find(a.last, key) }
-        if nested_key
-          deep_find(found, nested_key)
-        else
-          found
-        end
-      end
-    end
-  end
-
+  # Helper methods for client requests
   module Helpers
-
     # get ALL records at path by paging through record set
     def all(path, options = {})
       list_type, list_item = get_list_types(path)
       Enumerator.new do |yielder|
         page = 0
         loop do
-          result = request('GET', path, options.merge(query: { pgNum: page }))
-          raise StopIteration unless result.parsed[list_type].key?('itemsInPage')
+          response = request('GET', path, options.merge(query: { pgNum: page }))
+          unless response.result.success?
+            raise CollectionSpace::RequestError, response.result.body
+          end
 
-          items = result.parsed[list_type]['itemsInPage'].to_i
-          raise StopIteration if items == 0
+          items = response.parsed[list_type].fetch('itemsInPage', 0).to_i
+          raise StopIteration if items.zero?
 
-          list_items = result.parsed[list_type][list_item]
+          list_items = response.parsed[list_type][list_item]
           list_items = [list_items] if items == 1
           list_items.each { |item| yielder << item }
           page += 1
@@ -39,84 +24,27 @@ module CollectionSpace
     end
 
     def count(path)
-      # make sure path is only 1 level deep?
-      count  = nil
-      result = request('GET', path, { query: { pgSz: 1 } })
-      count  = result.parsed['abstract_common_list']['totalItems'].to_i if result.status_code == 200
-      count
-    end
-
-    # create blob record by external url
-    def post_blob_url(url)
-      raise ArgumentError.new("Invalid blob URL #{url}") unless URI.parse(url).scheme =~ /^https?/
-      request 'POST', "blobs", {
-        query: { "blobUri" => url },
-      }
-    end
-
-    def post_relationship(type_a, csid_a, type_b, csid_b)
-      # requires an erb template
-      # request 'POST', "relations", { body: payload }
-      # flip for reciprocal relationship
-      # request 'POST', "relations", { body: payload }
-    end
-
-    def search(query, options = {})
-      options = prepare_query(query, options)
-      request "GET", query.path, options
+      list_type, = get_list_types(path)
+      response   = request('GET', path, query: { pgSz: 1 })
+      response.parsed[list_type]['totalItems'].to_i if response.result.success?
     end
 
-    def search_all(query, options = {}, &block)
-      options = prepare_query(query, options)
-      all query.path, options, &block
-    end
-
-    def strip_refname(refname)
-      stripped = refname.match(/('.*')/)[0].delete("'") rescue ''
-      stripped
-    end
-
-    # parsed record and map to get restructured object
-    def to_object(record, attribute_map, stringify_keys = false)
-      attributes = {}
-      attribute_map.each do |map|
-        map = map.inject({}) { |memo,(k,v)| memo[k.to_s] = v; memo} if stringify_keys
-        if map["with"]
-          as = deep_find(record, map["key"], map["nested_key"])
-          values = []
-          if as.is_a? Array
-            values = as.map { |a| strip_refname( deep_find(a, map["with"]) ) }
-          elsif as.is_a? Hash and as[ map["with"] ]
-            values = as[ map["with"] ].is_a?(Array) ? as[ map["with"] ].map { |a| strip_refname(a) } : [ strip_refname(as[ map["with"] ]) ]
-          end
-          attributes[map["field"]] = values
-        else
-          attributes[map["field"]] = deep_find(record, map["key"], map["nested_key"])
-        end
-      end
-      attributes
-    end
-
-    private
-
     def get_list_types(path)
-      list_type, list_item = nil
       if path == 'relations'
-        list_type = 'relations_common_list'
-        list_item = 'relation_list_item'
+        %w[relations_common_list relation_list_item]
       else
-        list_type = 'abstract_common_list'
-        list_item = 'list_item'
+        %w[abstract_common_list list_item]
       end
-      return list_type, list_item
     end
 
     def prepare_query(query, options = {})
       query_string = "#{query.type}:#{query.field} #{query.expression}"
-      options      = options.merge({ query: { as: query_string } })
-      options
+      options.merge(query: { as: query_string })
     end
 
+    def search(query, options = {})
+      options = prepare_query(query, options)
+      request 'GET', query.path, options
+    end
   end
-
-end
+end

data/lib/collectionspace/client/request.rb

@@ -1,5 +1,5 @@
 module CollectionSpace
-
+  # CollectionSpace request
   class Request
     include HTTParty
     attr_reader :config, :headers, :method, :path, :options
@@ -9,41 +9,43 @@ 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(/^\//, '')
+      @path   = path.gsub(%r{^/}, '')
 
       @auth = {
         username: config.username,
-        password: config.password,
+        password: config.password
       }
 
+      headers = default_headers(@method).merge(options.fetch(:headers, {}))
       @options = options
       @options[:basic_auth] = @auth
-      @options[:headers]    = options[:headers] ? default_headers(@method).merge(options[:headers]) : default_headers(@method)
+      @options[:headers]    = headers
       @options[:verify]     = config.verify_ssl
-      @options[:query]      = {} unless options.has_key? :query
+      @options[:query]      = options.fetch(:query, {})
 
       self.class.base_uri config.base_uri
-      self.class.default_params wf_deleted: config.include_deleted, pgSz: config.page_size
+      self.class.default_params(
+        wf_deleted: config.include_deleted,
+        pgSz: config.page_size
+      )
     end
 
     def execute
       self.class.send method, "/#{path}", options
     end
-
   end
-
 end

data/lib/collectionspace/client/response.rb

@@ -1,20 +1,14 @@
 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
-
-end
+end

data/lib/collectionspace/client/search.rb

@@ -1,10 +1,13 @@
 module CollectionSpace
-
+  # CollectionSpace search
   class Search
     attr_accessor :path, :type, :field, :expression
 
     def initialize(path: nil, type: nil, field: nil, expression: nil)
-      @path, @type, @field, @expression = path, type, field, expression
+      @path       = path
+      @type       = type
+      @field      = field
+      @expression = expression
     end
 
     def from_hash(query)
@@ -13,7 +16,5 @@ module CollectionSpace
       end
       self
     end
-
   end
-
-end
+end

data/lib/collectionspace/client/version.rb

@@ -1,5 +1,5 @@
 module CollectionSpace
   class Client
-    VERSION = "0.1.5"
+    VERSION = '0.2.0'.freeze
   end
 end

data/lib/collectionspace/client.rb

@@ -3,19 +3,17 @@ require 'nokogiri'
 require 'uri'
 
 # mixins required first
-require "collectionspace/client/helpers"
+require 'collectionspace/client/helpers'
 
-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/request'
+require 'collectionspace/client/response'
+require 'collectionspace/client/search'
+require 'collectionspace/client/version'
 
 module CollectionSpace
-
-  class ArgumentError < Exception ; end
-  class PayloadError  < Exception ; end
-  class RequestError  < Exception ; end
-
-end
+  class ArgumentError < StandardError; end
+  class PayloadError  < StandardError; 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.2.0
 platform: ruby
 authors:
 - Mark Cooper
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2019-11-25 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
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -145,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -152,9 +167,8 @@ files:
 - Rakefile
 - 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/search.rb
 - lib/collectionspace/client.rb
 - lib/collectionspace/client/client.rb

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