archivesspace-client 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1723d47efa6b10e5106ca28bfa6f247bf79603d2
-  data.tar.gz: f6b404154c5c87ee9a74036d6501cc3304df01ea
+SHA256:
+  metadata.gz: 6ea50bb167b4debf8781434efa1ff7b06d077a8ab869f02c30ea8d1cd66de3c9
+  data.tar.gz: 83f63ad1f11fc35ca89cdabe871a1e1fa91f935e2e6e284f038b6db2c0257065
 SHA512:
-  metadata.gz: 7de5e06e6900dda657cfae615058c10859ba565aa27f16184ec7d44f23c7c2513a52c9717186f8ce04361adabc3097b562db785694bb38556a003177e92b4718
-  data.tar.gz: 17a2e5174475986516c757f7b4f875352546555f0f3aee8539c7f3d2f090789dd1f7087614ca38ea3d0b554c50a351d7307ec8d29706bc816b4fcb328b2e60d9
+  metadata.gz: faa0086ae6ecd33700e3cf16c41b7457ebf094eb4a5e79109c3999ce0e916f8924450cb6ef8bcb4a761f0d6ed3a1c12a457dec4cd5738429a8f80fb249303fbe
+  data.tar.gz: '09a6fca39d7846875715216e8b10d5d29b776b433c37abef3490b5964e62deca9de5f01e69f868a476cceb11c7ceaa43032cfb906f9fff35da10b43e0b3582e7'

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in archivesspace-client.gemspec

data/README.md

@@ -1,10 +1,8 @@
-Archivesspace Client
-===
+# Archivesspace Client
 
-Interact with ArchivesSpace via its API.
+Interact with ArchivesSpace via the API.
 
-Installation
----
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -20,10 +18,11 @@ bundle install
 
 Or install it yourself as:
 
-    $ gem install archivesspace-client
+```bash
+gem install archivesspace-client
+```
 
-Usage
----
+## Usage
 
 See the examples directory for a range of use cases.
 
@@ -37,8 +36,6 @@ client = ArchivesSpace::Client.new.login
 
 **Custom configuration**
 
-To supply custom configuration to client:
-
 ```ruby
 config = ArchivesSpace::Configuration.new({
   base_uri: "https://archives.university.edu/api",
@@ -90,8 +87,36 @@ client.get('digital_objects') # instead of "repositories/2/digital_objects" etc.
 client.config.base_repo = ""
 ```
 
-Development
----
+## Templates
+
+Templates are an optional feature that can help simplify the effort of creating
+json payloads for ArchivesSpace. Rather than construct the json programatically
+according to the schemas a `.erb` template can be used to generate payloads
+instead which are transformed to json automatically. There are a small number of
+templates provided with the client, but you can create your own and access them
+by setting the `ARCHIVESSPACE_CLIENT_TEMPLATES_PATH` envvar. A particularly simple
+template might look like:
+
+```erb
+{
+  "digital_object_id": "<%= data[:digital_object_id] %>",
+  "title": "<%= data[:title] %>"
+}
+```
+
+Practically speaking there isn't much benefit to this example, but in the case of
+a more complex record structure where you want to populate deeply nested elements
+using a flat file structure (like csv) this can be a very convenient way of
+assembling the payload. To process a template:
+
+```ruby
+data = { repo_code: 'ABC', name: 'ABC Archive', agent_contact_name: 'ABC Admin' }
+json = ArchivesSpace::Template.process(:repository_with_agent, data)
+response = client.post('/repositories/with_agent', json)
+puts response.result.success? ? '=)' : '=('
+```
+
+## Development
 
 To run the examples start a local instance of ArchivesSpace then:
 
@@ -99,7 +124,9 @@ To run the examples start a local instance of ArchivesSpace then:
 bundle exec ruby examples/repo_and_user.rb
 ```
 
-Any script placed in the examples directory with a `my_` prefix are ignored by git. Follow the convention used by the existing scripts to bootstrap and experiment away.
+Any script placed in the examples directory with a `my_` prefix are ignored by
+git. Follow the convention used by the existing scripts to bootstrap and
+experiment away.
 
 To run the tests:
 
@@ -107,13 +134,25 @@ To run the tests:
 bundle exec rake
 ```
 
-Contributing
----
+## Publishing
+
+Bump version in `lib/archivesspace/client/version.rb` then:
+
+```bash
+VERSION=0.1.8
+gem build archivesspace-client
+git add . && git commit -m "Bump to $VERSION"
+git tag v$VERSION
+git push origin master
+git push --tags
+gem push archivesspace-client-$VERSION.gem
+```
+
+## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/lyrasis/archivesspace-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,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/archivesspace-client.gemspec

@@ -1,31 +1,32 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'archivesspace/client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "archivesspace-client"
+  spec.name          = 'archivesspace-client'
   spec.version       = ArchivesSpace::Client::VERSION
-  spec.authors       = ["Mark Cooper"]
-  spec.email         = ["mark.c.cooper@outlook.com"]
-  spec.summary       = %q{Interact with ArchivesSpace via its RESTful API.}
-  spec.description   = %q{Interact with ArchivesSpace via its RESTful API.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Mark Cooper']
+  spec.email         = ['mark.c.cooper@outlook.com']
+  spec.summary       = 'Interact with ArchivesSpace via the API.'
+  spec.description   = 'Interact with ArchivesSpace via the API.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "3.6.0"
-  spec.add_development_dependency "vcr", "3.0.3"
-  spec.add_development_dependency "webmock", "3.0.1"
-  spec.add_development_dependency "awesome_print", "~> 1.8.0"
+  spec.add_development_dependency 'awesome_print', '~> 1.8.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '3.6.0'
+  spec.add_development_dependency 'vcr', '3.0.3'
+  spec.add_development_dependency 'webmock', '3.0.1'
 
-  spec.add_dependency "httparty", "0.14.0"
-  spec.add_dependency "json", "2.0.3"
-  spec.add_dependency "nokogiri", "1.6.8.1"
+  spec.add_dependency 'httparty', '~> 0.14'
+  spec.add_dependency 'json', '~> 2.0'
+  spec.add_dependency 'nokogiri', '~> 1.10'
 end

data/examples/export.rb

@@ -1,29 +1,36 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'awesome_print'
 require 'archivesspace/client'
 
 # official sandbox
-config = ArchivesSpace::Configuration.new({
-  base_uri: "http://sandbox.archivesspace.org/api",
-  base_repo: "",
-  username: "admin",
-  password: "admin",
-  page_size: 50,
-  throttle: 0,
-  verify_ssl: false,
-})
+config = ArchivesSpace::Configuration.new(
+  {
+    base_uri: 'http://test.archivesspace.org/staff/api',
+    base_repo: '',
+    username: 'admin',
+    password: 'admin',
+    page_size: 50,
+    throttle: 0,
+    verify_ssl: false
+  }
+)
 
 client = ArchivesSpace::Client.new(config).login
 client.config.throttle = 0.5
-client.config.base_repo = "repositories/2"
+client.config.base_repo = 'repositories/2'
 
 begin
-  # date -d '2015-07-01 00:00:00' +'%s' # 1435734000
-  client.resources("ead", { query: { modified_since: "1435734000" } }) do |ead|
+  # date -d '2021-02-01 00:00:00' +'%s' # 1612166400
+  client.resources(query: { modified_since: '1612166400' }).each do |resource|
     # for now we are just printing ...
     # but you would actually write to a zip file or whatever
-    ap ead
+    id   = resource['uri'].split('/')[-1]
+    opts = { include_unpublished: false }
+    response = client.get("resource_descriptions/#{id}.xml", opts)
+    puts Nokogiri::XML(response.body).to_xml
   end
-rescue ArchivesSpace::RequestError => ex
-  puts ex.message
-end
+rescue ArchivesSpace::RequestError => e
+  puts e.message
+end

data/examples/password_reset.rb

@@ -1,15 +1,16 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'awesome_print'
 require 'archivesspace/client'
 
-username = "mrx"
-password = "123456"
+username = 'admin'
+password = 'admin'
 
 # default client connection: localhost:8089, admin, admin
 client = ArchivesSpace::Client.new.login
 begin
-  client.password_reset username, password
-  puts "Successfully updated password for #{username}."
-rescue Exception => ex
-  puts "Failed to update password for #{username},\n#{ex.message}"
+  puts client.password_reset(username, password).parsed
+rescue StandardError => e
+  puts "Failed to update password for #{username},\n#{e.message}"
 end

data/examples/repo_and_user.rb

@@ -1,46 +1,60 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'awesome_print'
 require 'archivesspace/client'
 
-# default client connection: localhost:8089, admin, admin
-client = ArchivesSpace::Client.new.login
+# official sandbox
+config = ArchivesSpace::Configuration.new(
+  {
+    base_uri: 'http://sandbox.archivesspace.org/api',
+    base_repo: '',
+    username: 'admin',
+    password: 'admin',
+    page_size: 50,
+    throttle: 0,
+    verify_ssl: false
+  }
+)
+
+client = ArchivesSpace::Client.new(config).login
 
 ap ArchivesSpace::Template.list # view available templates
 
 repo_data = {
-  repo_code: "XYZ",
-  name: "XYZ Archive",
-  agent_contact_name: "John Doe",
+  repo_code: 'XYZ',
+  name: 'XYZ Archive',
+  agent_contact_name: 'XYZ Admin'
 }
 
 user_data = {
-  username: "lmessi",
-  name: "Lionel Messi",
-  is_admin: true,
+  username: 'lmessi',
+  name: 'Lionel Messi',
+  is_admin: true
 }
-user_password = "123456"
+user_password = '123456'
 
-repository = ArchivesSpace::Template.process_template(:repository_with_agent, repo_data)
+repository = ArchivesSpace::Template.process(:repository_with_agent, repo_data)
 
 begin
   response = client.post('/repositories/with_agent', repository)
-  if response.status_code == 201
-    repository = client.repositories.find { |r| r["repo_code"] == "XYZ" }
+  if response.result.success?
+    repository = client.repositories.find { |r| r['repo_code'] == 'XYZ' }
     ap repository
-    ap client.delete(repository["uri"])
+    ap client.delete(repository['uri'])
   else
     ap response.parsed
   end
 
-  user = ArchivesSpace::Template.process_template(:user, user_data)
+  user = ArchivesSpace::Template.process(:user, user_data)
   response = client.post('users', user, { password: user_password })
-  if response.status_code == 201
-    user = client.users.find { |r| r["username"] == "lmessi" }
+  if response.result.success?
+    user = client.users.find { |r| r['username'] == 'lmessi' }
     ap user
-    ap client.delete user["uri"]
+    ap client.delete user['uri']
   else
     ap response.parsed
   end
-rescue ArchivesSpace::RequestError => ex
-  puts ex.message
+rescue ArchivesSpace::RequestError => e
+  puts e.message
 end

data/examples/test_connection.rb

@@ -1,17 +1,21 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'awesome_print'
 require 'archivesspace/client'
 
 # official sandbox
-config = ArchivesSpace::Configuration.new({
-  base_uri: "http://sandbox.archivesspace.org/api",
-  base_repo: "",
-  username: "admin",
-  password: "admin",
-  page_size: 50,
-  throttle: 0,
-  verify_ssl: false,
-})
+config = ArchivesSpace::Configuration.new(
+  {
+    base_uri: 'http://sandbox.archivesspace.org/api',
+    base_repo: '',
+    username: 'admin',
+    password: 'admin',
+    page_size: 50,
+    throttle: 0,
+    verify_ssl: false
+  }
+)
 
 client = ArchivesSpace::Client.new(config).login
-puts client.get("version").body
+puts client.get('version').body

data/examples/user_groups.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'awesome_print'
+require 'archivesspace/client'
+
+# official sandbox
+config = ArchivesSpace::Configuration.new(
+  {
+    base_uri: 'http://sandbox.archivesspace.org/api',
+    base_repo: '',
+    username: 'admin',
+    password: 'admin',
+    page_size: 50,
+    throttle: 0,
+    verify_ssl: false
+  }
+)
+
+client = ArchivesSpace::Client.new(config).login
+
+user_data = {
+  username: 'bde',
+  name: 'BDE',
+  is_admin: false
+}
+
+client.post(
+  'users',
+  ArchivesSpace::Template.process(:user, user_data),
+  { password: '123456' }
+)
+
+users_with_roles = {
+  'bde' => ['repository-basic-data-entry']
+}
+
+begin
+  client.config.base_repo = "repositories/2"
+  results = client.group_user_assignment users_with_roles
+  ap results.map(&:parsed)
+rescue ArchivesSpace::RequestError => e
+  puts e.message
+end

data/lib/archivesspace/client.rb

@@ -1,22 +1,22 @@
+# frozen_string_literal: true
+
 require 'httparty'
 require 'json'
 require 'nokogiri'
 
 # mixins required first
-require "archivesspace/client/helpers"
+require 'archivesspace/client/helpers'
 
-require "archivesspace/client/client"
-require "archivesspace/client/configuration"
-require "archivesspace/client/request"
-require "archivesspace/client/response"
-require "archivesspace/client/template"
-require "archivesspace/client/version"
+require 'archivesspace/client/client'
+require 'archivesspace/client/configuration'
+require 'archivesspace/client/request'
+require 'archivesspace/client/response'
+require 'archivesspace/client/template'
+require 'archivesspace/client/version'
 
 module ArchivesSpace
-
-  class ConnectionError < Exception ; end
-  class ContextError    < Exception ; end
-  class ParamsError     < Exception ; end
-  class RequestError    < Exception ; end
-
-end
+  class ConnectionError < RuntimeError; end
+  class ContextError    < RuntimeError; end
+  class ParamsError     < RuntimeError; end
+  class RequestError    < RuntimeError; end
+end

data/lib/archivesspace/client/client.rb

@@ -1,12 +1,14 @@
-module ArchivesSpace
+# frozen_string_literal: true
 
+module ArchivesSpace
   class Client
     include Helpers
     attr_accessor :token
     attr_reader   :config
 
     def initialize(config = Configuration.new)
-      raise "Invalid configuration object" unless config.kind_of? ArchivesSpace::Configuration
+      raise 'Invalid configuration object' unless config.is_a? ArchivesSpace::Configuration
+
       @config = config
       @token  = nil
     end
@@ -16,11 +18,11 @@ module ArchivesSpace
     end
 
     def post(path, payload, params = {})
-      request 'POST', path, { body: payload.to_json, query: params }
+      request 'POST', path, { body: payload, query: params }
     end
 
     def put(path, payload, params = {})
-      request 'PUT', path, { body: payload.to_json, query: params }
+      request 'PUT', path, { body: payload, query: params }
     end
 
     def delete(path)
@@ -31,11 +33,9 @@ module ArchivesSpace
 
     def request(method, path, options = {})
       sleep config.throttle
-      options[:headers] = { "X-ArchivesSpace-Session" => token } if token
+      options[:headers] = { 'X-ArchivesSpace-Session' => token } if token
       result = Request.new(config, method, path, options).execute
       Response.new result
     end
-
   end
-
 end

data/lib/archivesspace/client/configuration.rb

@@ -1,16 +1,16 @@
-module ArchivesSpace
+# frozen_string_literal: true
 
+module ArchivesSpace
   class Configuration
-
     def defaults
       {
-        base_uri: "http://localhost:8089",
-        base_repo: "",
-        username: "admin",
-        password: "admin",
+        base_uri: 'http://localhost:8089',
+        base_repo: '',
+        username: 'admin',
+        password: 'admin',
         page_size: 50,
         throttle: 0,
-        verify_ssl: true,
+        verify_ssl: true
       }
     end
 
@@ -18,11 +18,10 @@ module ArchivesSpace
       settings = defaults.merge(settings)
       settings.each do |property, value|
         next unless defaults.keys.include? property
+
         instance_variable_set("@#{property}", value)
         self.class.send(:attr_accessor, property)
       end
     end
-
   end
-
-end
+end

data/lib/archivesspace/client/helpers.rb

@@ -1,168 +1,133 @@
+# frozen_string_literal: true
+
 # needed for roundtrip hash merging
 class ::Hash
   def deep_merge(second)
-    merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
-    self.merge(second, &merger)
+    merger = proc { |_key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+    merge(second, &merger)
   end
 end
 
 module ArchivesSpace
-
   module Helpers
+    def accessions(options = {})
+      all('accessions', options)
+    end
+
+    def all(path, options = {})
+      Enumerator.new do |yielder|
+        page = 1
+        unlimited_listing = false
+        loop do
+          options[:query] ||= {}
+          options[:query][:page] = page
+          result = get(path, options)
+          results = []
+
+          if result.parsed.respond_to?(:key) && result.parsed.key?('results')
+            results = result.parsed['results']
+          else
+            results = result.parsed
+            unlimited_listing = true
+          end
 
-    def accessions(options = {}, &block)
-      records = all('accessions', options) do |record|
-        yield record if block_given?
-      end
-      records
-    end
+          if results.any?
+            results.each do |i|
+              yielder << i
+            end
+            raise StopIteration if unlimited_listing
 
-    def all(path, options = {}, &block)
-      all      = []
-      format   = options.delete(:format)
-      parse_id = options.delete(:parse_id)
-      # options[:headers] -- add xml headers if format
-
-      result = get(path, options.merge({ query: { all_ids: true } } ))
-      raise RequestError.new(result.body) if result.status_code != 200
-      ids    = result.parsed
-      ids    = ids.map{ |object| object["uri"].split("/")[-1] } if parse_id
-      ids.each do |id|
-        path_with_id = format ? "#{format}/#{id}.xml" : "#{path}/#{id}"
-        result = get(path_with_id, options)
-        raise RequestError.new(result.body) if result.status_code != 200
-        record = format ? Nokogiri::XML(result.body).to_xml : result.parsed
-        yield record if block_given?
-        all << record
-      end
-      all
+            page += 1
+          else
+            raise StopIteration
+          end
+        end
+      end.lazy
     end
 
     def backend_version
-      get "version"
-    end
-
-    def batch_import(payload, params = {})
-      # create "batch_import", payload, params
+      get 'version'
     end
 
-    def digital_object_to_xml(digital_object, format = "dublin_core", options = {})
-      id   = digital_object["uri"].split("/")[-1]
-      path = "digital_objects/#{format}/#{id}.xml"
-      get_xml path, options
-    end
+    # def batch_import(payload, params = {})
+    #   # TODO: create "batch_import", payload, params
+    # end
 
-    def digital_objects(format = nil, options = {}, &block)
-      path    = "digital_objects"
-      format  = format ? "#{path}/#{format}" : nil
-      records = all(path, options.merge({ format: format })) do |record|
-        yield record if block_given?
-      end
-      records
+    def digital_objects(options = {})
+      all('digital_objects', options)
     end
 
-    def groups
-      records = all('groups', { parse_id: true }) do |record|
-        yield record if block_given?
-      end
-      records
+    def groups(options = {})
+      all('groups', options)
     end
 
-    def group_user_assignment(users_with_roles, params = { with_members: true })
+    def group_user_assignment(users_with_roles)
       updated = []
-      groups do |group|
-        changed = false
+      groups.each do |group|
+        group = get("groups/#{uri_to_id(group['uri'])}").parsed
+        update = false
 
         users_with_roles.each do |user, roles|
-          if roles.include? group["group_code"]
-            unless group["member_usernames"].include? user
-              group["member_usernames"] << user
-              changed = true
-            end
-          else
-            if group["member_usernames"].include? user
-              group["member_usernames"].delete user
-              changed = true
+          # should the user still belong to this group?
+          if group['member_usernames'].include?(user)
+            unless roles.include? group['group_code']
+              group['member_usernames'].delete user
+              update = true
             end
+          # should the user be added to this group?
+          elsif roles.include? group['group_code']
+            group['member_usernames'] << user
+            update = true
           end
         end
 
-        if changed
-          id = group["uri"].split("/")[-1]
-          response = post( "/groups/#{id}", group, params )
-          updated << response.parsed
-        end
+        next unless update
+
+        response = post("/groups/#{uri_to_id(group['uri'])}", group.to_json)
+        updated << response
       end
       updated
     end
 
     def login
-      username, password = config.username, config.password
+      username = config.username
+      password = config.password
       result = request('POST', "/users/#{username}/login", { query: { password: password } })
-      raise ConnectionError.new "Failed to connect to ArchivesSpace backend as #{username} #{password}" unless result.parsed["session"]
-      @token = result.parsed["session"]
+      unless result.parsed['session']
+        raise ConnectionError, "Failed to connect to ArchivesSpace backend as #{username} #{password}"
+      end
+
+      @token = result.parsed['session']
       self
     end
 
     def password_reset(username, password)
-      user = all('users').find { |u| u["username"] == username }
-      raise RequestError.new(user.status) unless user
-      post(user["uri"], user, { password: password })
-    end
+      user = all('users').find { |u| u['username'] == username }
+      raise RequestError, user.status unless user
 
-    def repositories
-      records = get('repositories').parsed.each do |record|
-        yield record if block_given?
-      end
-      records
+      post(user['uri'], user.to_json, { password: password })
     end
 
-    def repositories_with_agent
-      #
+    def repositories(options = {})
+      all('repositories', options)
     end
 
-    def resource_to_xml(resource, format = "ead", options = {})
-      id   = resource["uri"].split("/")[-1]
-      path = format == "ead" ? "resource_descriptions/#{id}.xml" : "resources/#{format}/#{id}.xml"
-      get_xml path, options
-    end
+    def repositories_with_agent; end
 
-    def resources(format = nil, options = {}, &block)
-      path = 'resources'
-      # the api is inconsistent with the path structure for resource ead (and pdf)
-      if format
-        if format =~ /(ead|pdf)/
-          format = "resource_descriptions"
-        else
-          format = "#{path}/#{format}"
-        end
-      end
-      records = all(path, options.merge({ format: format })) do |record|
-        yield record if block_given?
-      end
-      records
+    def resources(options = {})
+      all('resources', options)
     end
 
-    def search(params)
-      # get "search", params
-    end
+    # def search(params)
+    #   # TODO: get "search", params
+    # end
 
-    def users
-      records = all('users') do |record|
-        yield record if block_given?
-      end
-      records
+    def uri_to_id(uri)
+      uri.split('/').last
     end
 
-    private
-
-    def get_xml(path, options = {})
-      # add xml headers
-      response = get(path, options)
-      raise RequestError.new(response.body) unless response.status_code == 200
-      Nokogiri::XML(response.body).to_xml
+    def users(options = {})
+      all('users', options)
     end
-
   end
-
-end
+end

data/lib/archivesspace/client/request.rb

@@ -1,5 +1,6 @@
-module ArchivesSpace
+# frozen_string_literal: true
 
+module ArchivesSpace
   class Request
     include HTTParty
     attr_reader :config, :headers, :method, :path, :options
@@ -9,36 +10,33 @@ module ArchivesSpace
         delete: {},
         get: {},
         post: {
-          "Content-Type" => "application/json",
-          "Content-Length" => "nnnn",
+          'Content-Type' => 'application/json',
+          'Content-Length' => 'nnnn'
         },
         put: {
-          "Content-Type" => "application/json",
-          "Content-Length" => "nnnn",
+          'Content-Type' => 'application/json',
+          'Content-Length' => 'nnnn'
         }
       }
       headers[method]
     end
 
-    def initialize(config, method = "GET", path = "", options = {})
-      @config  = config
-      @method  = method.downcase.to_sym
-      @path    = path
+    def initialize(config, method = 'GET', path = '', options = {})
+      @config            = config
+      @method            = method.downcase.to_sym
+      @path              = path.gsub(%r{^/+}, '')
+      @options           = options
+      @options[:headers] = options[:headers] ? default_headers(@method).merge(options[:headers]) : default_headers(@method)
+      @options[:verify]  = config.verify_ssl
+      @options[:query]   = {} unless options.key? :query
 
-      @options = options
-      @options[:headers]    = options[:headers] ? default_headers(@method).merge(options[:headers]) : default_headers(@method)
-      @options[:verify]     = config.verify_ssl
-      @options[:query]      = {} unless options.has_key? :query
+      base_uri = config.base_repo&.length&.positive? ? File.join(config.base_uri, config.base_repo) : config.base_uri
 
-      base_uri = (config.base_repo.nil? or config.base_repo.empty?) ? config.base_uri : "#{config.base_uri}/#{config.base_repo}"
       self.class.base_uri base_uri
-      # self.class.default_params abc: 123
     end
 
     def execute
       self.class.send method, "/#{path}", options
     end
-
   end
-
 end

data/lib/archivesspace/client/response.rb

@@ -1,10 +1,10 @@
-module ArchivesSpace
+# frozen_string_literal: true
 
+module ArchivesSpace
   class Response
-    attr_reader :result, :parsed, :body, :headers, :status, :status_code, :xml
+    attr_reader :result, :parsed, :body, :headers, :status, :status_code
 
     def initialize(result)
-      # throw error
       @result      = result
       @parsed      = result.parsed_response
       @body        = result.body
@@ -12,7 +12,5 @@ module ArchivesSpace
       @status      = result.response
       @status_code = result.code.to_i
     end
-
   end
-
-end
+end

data/lib/archivesspace/client/template.rb

@@ -1,25 +1,26 @@
-module ArchivesSpace
+# frozen_string_literal: true
 
+module ArchivesSpace
   module Template
-
     def self.list
-      []
+      Dir.glob File.join(templates_path, '*.erb')
     end
 
-    def self.process_template(template, data)
-      t = ERB.new(self.read_template(template))
-      r = t.result(binding).gsub(/\n+/,"\n")
-      JSON.parse(r)
+    def self.process(template, data)
+      t = ERB.new(read(template))
+      r = t.result(binding).gsub(/\n+/, "\n")
+      JSON.parse(r).to_json
     end
 
-    def self.read_template(file)
-      File.read("#{self.templates_path}/#{file.to_s}.json.erb")
+    def self.read(file)
+      File.read("#{templates_path}/#{file}.json.erb")
     end
 
     def self.templates_path
-      File.join(File.dirname(File.expand_path(__FILE__)), 'templates')
+      ENV.fetch(
+        'ARCHIVESSPACE_CLIENT_TEMPLATES_PATH',
+        File.join(File.dirname(File.expand_path(__FILE__)), 'templates')
+      )
     end
-
   end
-
-end
+end

data/lib/archivesspace/client/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module ArchivesSpace
   class Client
-    VERSION = "0.1.3"
+    VERSION = '0.1.8'
   end
 end

data/spec/archivesspace/client_spec.rb

@@ -1,43 +1,39 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ArchivesSpace::Client do
-
   let(:client) { ArchivesSpace::Client.new }
   let(:login)  { -> { client.login } }
 
-  describe "Configuration" do
-
+  describe 'Configuration' do
     it 'will use the default configuration if none is provided' do
       client = ArchivesSpace::Client.new
       expect(client.config.base_uri).to eq DEFAULT_BASE_URI
     end
 
     it 'will raise an error if supplied configuration is of invalid type' do
-      expect{ ArchivesSpace::Client.new({ base_uri: CUSTOM_BASE_URI }) }.to raise_error(RuntimeError)
+      expect { ArchivesSpace::Client.new({ base_uri: CUSTOM_BASE_URI }) }.to raise_error(RuntimeError)
     end
 
     it 'will allow a configuration object to be provided' do
       client = ArchivesSpace::Client.new(ArchivesSpace::Configuration.new({ base_uri: CUSTOM_BASE_URI }))
       expect(client.config.base_uri).to eq CUSTOM_BASE_URI
     end
-
   end
 
-  describe "Version information" do
-
+  describe 'Version information' do
     it 'has a version number' do
       expect(ArchivesSpace::Client::VERSION).not_to be nil
     end
 
-    it "can retrieve the backend version info" do
+    it 'can retrieve the backend version info' do
       VCR.use_cassette('backend_version') do
         login.call
-        response = client.get "version"
+        response = client.get 'version'
         expect(response.status_code).to eq(200)
         expect(response.body).to match(/ArchivesSpace \(.*\)/)
       end
     end
-
   end
-
-end
+end

data/spec/archivesspace/configuration_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ArchivesSpace::Configuration do
-
   it 'uses the default profile for configuration settings' do
     config = ArchivesSpace::Configuration.new
     expect(config.base_uri).to eq DEFAULT_BASE_URI
@@ -9,8 +10,8 @@ describe ArchivesSpace::Configuration do
 
   it 'allows configuration settings to be provided' do
     config = ArchivesSpace::Configuration.new({
-      base_uri: CUSTOM_BASE_URI,
-    })
+                                                base_uri: CUSTOM_BASE_URI
+                                              })
     expect(config.base_uri).to eq CUSTOM_BASE_URI
   end
 
@@ -22,7 +23,6 @@ describe ArchivesSpace::Configuration do
 
   it 'ignores unrecognized configuration properties' do
     config = ArchivesSpace::Configuration.new({ xyz: 123 })
-    expect{ config.xyz }.to raise_error(NoMethodError)
+    expect { config.xyz }.to raise_error(NoMethodError)
   end
-
-end
+end

data/spec/archivesspace/templates_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe ArchivesSpace::Template do
+  it 'can list the default templates' do
+    templates = ArchivesSpace::Template.list
+    expect(templates).to_not be_empty
+    expect(templates).to include(/repository_with_agent.*erb/)
+  end
+
+  it 'can change the path when template envvar is set' do
+    expect(ArchivesSpace::Template.templates_path).to match(
+      /#{File.join('lib', 'archivesspace', 'client', 'templates')}/
+    )
+    ENV['ARCHIVESSPACE_CLIENT_TEMPLATES_PATH'] = '/path/to/nowhere'
+    expect(ArchivesSpace::Template.templates_path).to eq '/path/to/nowhere'
+    ENV.delete('ARCHIVESSPACE_CLIENT_TEMPLATES_PATH')
+  end
+
+  it 'can process a template' do
+    data = { repo_code: 'ABC', name: 'ABC Archive', agent_contact_name: 'ABC Admin' }
+    json = JSON.parse(ArchivesSpace::Template.process(:repository_with_agent, data))
+    expect(json['repository']['repo_code']).to eq data[:repo_code]
+  end
+end

data/spec/fixtures/cassettes/backend_version.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://localhost:8089//users/admin/login?password=admin
+    uri: http://localhost:8089/users/admin/login?password=admin
     body:
       encoding: UTF-8
       string: ''

data/spec/spec_helper.rb

@@ -1,14 +1,16 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'archivesspace/client'
 require 'vcr'
 require 'webmock/rspec'
 
 # GLOBAL VALUES FOR SPECS
-DEFAULT_BASE_URI = "http://localhost:8089"
-CUSTOM_BASE_URI  = "https://archives.university.edu/api"
+DEFAULT_BASE_URI = 'http://localhost:8089'
+CUSTOM_BASE_URI  = 'https://archives.university.edu/api'
 
 VCR.configure do |c|
-  c.cassette_library_dir = "spec/fixtures/cassettes"
+  c.cassette_library_dir = 'spec/fixtures/cassettes'
   c.hook_into :webmock
-  c.default_cassette_options = { :record => :once }
-end
+  c.default_cassette_options = { record: :once }
+end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: archivesspace-client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Mark Cooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-01 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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
@@ -80,63 +94,49 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.0.1
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.8.1
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.8.1
-description: Interact with ArchivesSpace via its RESTful API.
+        version: '1.10'
+description: Interact with ArchivesSpace via the API.
 email:
 - mark.c.cooper@outlook.com
 executables: []
@@ -155,6 +155,7 @@ files:
 - examples/password_reset.rb
 - examples/repo_and_user.rb
 - examples/test_connection.rb
+- examples/user_groups.rb
 - lib/archivesspace/client.rb
 - lib/archivesspace/client/client.rb
 - lib/archivesspace/client/configuration.rb
@@ -169,6 +170,7 @@ files:
 - lib/archivesspace/client/version.rb
 - spec/archivesspace/client_spec.rb
 - spec/archivesspace/configuration_spec.rb
+- spec/archivesspace/templates_spec.rb
 - spec/fixtures/cassettes/backend_version.yml
 - spec/spec_helper.rb
 homepage: ''
@@ -190,13 +192,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Interact with ArchivesSpace via its RESTful API.
+summary: Interact with ArchivesSpace via the API.
 test_files:
 - spec/archivesspace/client_spec.rb
 - spec/archivesspace/configuration_spec.rb
+- spec/archivesspace/templates_spec.rb
 - spec/fixtures/cassettes/backend_version.yml
 - spec/spec_helper.rb