archivesspace-client 0.1.12 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c009f995726401b9fd781b18796903276b19c2aabb3d6ec8722d60a36ea86600
-  data.tar.gz: 3985545e091850851567ebc1706252da34922120222dd491ca7ae58928e30b19
+  metadata.gz: 4aa54400871b3c9e356f6750ba9aa9fbba6111869ad57bcfe548334296fbf146
+  data.tar.gz: 8fede8b9a6e86517ebea6fa8f3ed0c5e3cb3b18966137a0d7133453bf5f67d1e
 SHA512:
-  metadata.gz: ef5a03e03271cb24133b3f82e2304162a5ede929453bb4af99edc8f011f260f204b390960b30ed691bd569af15813f0a0ee9e8063d4599d78e69eb833aad5b17
-  data.tar.gz: ef541e1ebd699335e4333d195a7ac3e5a554b96543c2f1432e26c056751d584b7a7f1db0c4c0369cbc881e9c6b626286414103b728f778b69a81af1511678eb9
+  metadata.gz: a0f5d93549e1357eb6f6a1470faeeb4b36dfc1f43676ffed68c148298c23f8a4263ac88befebd4d85ba54cdd0a2b9bc69c53eac8a038aa5ce18962c57cf8afaf
+  data.tar.gz: 71cc7ac848b1c60744f122156706e88457da232e08184cff9c2b53fa32871f585743de9c1d87b26a96105f8c98d72b7221b5dfca8bcc828a3b50845089901a1b

data/.github/workflows/ci.yml

@@ -1,8 +1,6 @@
 name: CI
 on: [pull_request]
 
-# TODO: add linters (rubocop)
-
 jobs:
   tests:
     name: Tests
@@ -15,8 +13,11 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: 2.7
+
+      - name: Lint
+        run: |
+          bundle exec standardrb
 
       - name: Run tests
         run: |
-          bundle exec rake
+          bundle exec rspec

data/.github/workflows/publish.yml

@@ -23,7 +23,7 @@ jobs:
 
       - name: Release Gem
         run: |
-          VERSION=$(ruby -e "puts eval(File.read('$GEM_NAME.gemspec')).version")
+          VERSION=$(bundle exec rake version)
           GEM_VERSION=$(gem list --exact --remote $GEM_NAME)
 
           # Publish to RubyGems.org

data/.rubocop.yml

@@ -0,0 +1,4 @@
+require: standard
+
+inherit_gem:
+  standard: config/base.yml

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

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

data/README.md

@@ -45,6 +45,7 @@ config = ArchivesSpace::Configuration.new({
   page_size: 50,
   throttle: 0,
   verify_ssl: false,
+  timeout: 60
 })
 
 client = ArchivesSpace::Client.new(config).login
@@ -73,7 +74,8 @@ user = client.all('users').find { |user| user["username"] == "jdoe" }
 user = client.users.find { |user| user["username"] == "jdoe" }
 ```
 
-See `helpers.rb` for more convenience methods such as `client.digital_objects` etc.
+See `pagination.rb` for endpoints that support record type methods such as
+`client.digital_objects` etc.
 
 **Setting a repository context**
 
@@ -93,11 +95,11 @@ client.use_global_repository
 
 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
+according to the schemas a 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` template might look like:
 
 ```erb
 {
@@ -113,11 +115,13 @@ 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)
+json = ArchivesSpace::Template.process("repository_with_agent.json.erb", data)
 response = client.post('/repositories/with_agent', json)
 puts response.result.success? ? '=)' : '=('
 ```
 
+To view available templates use: `ArchivesSpace::Template.list`
+
 ## CLI
 
 Create an `~/.asclientrc` file with a json version of the client configuration:
@@ -130,6 +134,7 @@ Create an `~/.asclientrc` file with a json version of the client configuration:
   "password": "123456",
   "page_size": 50,
   "throttle": 0,
+  "timeout": 60,
   "verify_ssl": false
 }
 ```

data/Rakefile

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 # require 'rubocop/rake_task'
 # RuboCop::RakeTask.new
 
-require 'cucumber/rake/task'
+require "cucumber/rake/task"
 Cucumber::Rake::Task.new
 
+require "standard/rake"
+
 task default: %i[spec cucumber]
 
 task :version do

data/archivesspace-client.gemspec

@@ -1,38 +1,34 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'archivesspace/client/version'
+require "archivesspace/client/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'archivesspace-client'
-  spec.version       = ArchivesSpace::Client::VERSION
-  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.name = "archivesspace-client"
+  spec.version = ArchivesSpace::Client::VERSION
+  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.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'aruba'
-  spec.add_development_dependency 'awesome_print', '~> 1.8.0'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'capybara_discoball'
-  spec.add_development_dependency 'cucumber'
-  spec.add_development_dependency 'json_spec'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '3.6.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'vcr', '3.0.3'
-  spec.add_development_dependency 'webmock', '3.0.1'
+  spec.add_development_dependency "aruba", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.6.0"
+  spec.add_development_dependency "rubocop", "1.56"
+  spec.add_development_dependency "standard", "1.31.0"
+  spec.add_development_dependency "vcr", "6.2.0"
+  spec.add_development_dependency "webmock", "3.19.1"
 
-  spec.add_dependency 'dry-cli', '~> 0.7'
-  spec.add_dependency 'httparty', '~> 0.14'
-  spec.add_dependency 'json', '~> 2.0'
-  spec.add_dependency 'nokogiri', '~> 1.10'
+  spec.add_dependency "dry-cli", "~> 0.7"
+  spec.add_dependency "httparty", "~> 0.14"
+  spec.add_dependency "json", "~> 2.0"
+  spec.add_dependency "nokogiri", "~> 1.10"
+  spec.add_dependency "jbuilder", "~> 2.11.5"
 end

data/examples/export.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'awesome_print'
-require 'archivesspace/client'
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "awesome_print"
+require "archivesspace/client"
 
 # official sandbox
 config = ArchivesSpace::Configuration.new(
   {
-    base_uri: 'http://test.archivesspace.org/staff/api',
-    base_repo: '',
-    username: 'admin',
-    password: 'admin',
+    base_uri: "http://test.archivesspace.org/staff/api",
+    base_repo: "",
+    username: "admin",
+    password: "admin",
     page_size: 50,
     throttle: 0,
     verify_ssl: false
@@ -19,15 +19,15 @@ config = ArchivesSpace::Configuration.new(
 
 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 '2021-02-01 00:00:00' +'%s' # 1612166400
-  client.resources(query: { modified_since: '1612166400' }).each do |resource|
+  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
-    id   = resource['uri'].split('/')[-1]
-    opts = { include_unpublished: false }
+    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

data/examples/password_reset.rb

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

data/examples/repo_and_user.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'awesome_print'
-require 'archivesspace/client'
+$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',
+    base_uri: "http://sandbox.archivesspace.org/api",
+    base_repo: "",
+    username: "admin",
+    password: "admin",
     page_size: 50,
     throttle: 0,
     verify_ssl: false
@@ -22,36 +22,36 @@ client = ArchivesSpace::Client.new(config).login
 ap ArchivesSpace::Template.list # view available templates
 
 repo_data = {
-  repo_code: 'XYZ',
-  name: 'XYZ Archive',
-  agent_contact_name: 'XYZ Admin'
+  repo_code: "XYZ",
+  name: "XYZ Archive",
+  agent_contact_name: "XYZ Admin"
 }
 
 user_data = {
-  username: 'lmessi',
-  name: 'Lionel Messi',
+  username: "lmessi",
+  name: "Lionel Messi",
   is_admin: true
 }
-user_password = '123456'
+user_password = "123456"
 
-repository = ArchivesSpace::Template.process(:repository_with_agent, repo_data)
+repository = ArchivesSpace::Template.process("repository_with_agent.json.erb", repo_data)
 
 begin
-  response = client.post('/repositories/with_agent', repository)
+  response = client.post("/repositories/with_agent", repository)
   if response.result.success?
-    repository = client.repositories.find { |r| r['repo_code'] == 'XYZ' }
+    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(:user, user_data)
-  response = client.post('users', user, { password: user_password })
+  user = ArchivesSpace::Template.process("user.json.erb", user_data)
+  response = client.post("users", user, {password: user_password})
   if response.result.success?
-    user = client.users.find { |r| r['username'] == 'lmessi' }
+    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

data/examples/templates.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "awesome_print"
+require "archivesspace/client"
+
+puts ArchivesSpace::Template.list
+
+template = "repository_with_agent.json.erb"
+user_data = {
+  username: "harrykane",
+  name: "Harry Kane",
+  is_admin: false
+}
+
+puts ArchivesSpace::Template.process(template, user_data)
+# or, if you really want ...
+puts ArchivesSpace::Template::Erb.new(template, user_data).process

data/examples/test_connection.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'awesome_print'
-require 'archivesspace/client'
+$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',
+    base_uri: "http://sandbox.archivesspace.org/api",
+    base_repo: "",
+    username: "admin",
+    password: "admin",
     page_size: 50,
     throttle: 0,
     verify_ssl: false
@@ -18,4 +18,4 @@ config = ArchivesSpace::Configuration.new(
 )
 
 client = ArchivesSpace::Client.new(config).login
-puts client.get('version').body
+puts client.get("version").body

data/examples/user_groups.rb

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

data/exe/asclient

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'archivesspace/client'
+require "bundler/setup"
+require "archivesspace/client"
 
 Dry::CLI.new(ArchivesSpace::Client::CLI).call

data/features/support/setup.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'aruba/cucumber'
-require 'json_spec/cucumber'
-require 'capybara_discoball'
+require "aruba/cucumber"
+require "json_spec/cucumber"
+require "capybara_discoball"
 
 def last_json
   last_command_started.output

data/lib/archivesspace/client/cli/exec.rb

@@ -5,37 +5,37 @@ module ArchivesSpace
     module CLI
       # ArchivesSpace::Client::CLI::Exec executes an API request
       class Exec < Dry::CLI::Command
-        desc 'Execute an API request'
+        desc "Execute an API request"
 
-        argument :type, required: true, values: %i[get post put delete], desc: 'API request type'
-        argument :path, required: true, desc: 'API request path'
+        argument :type, required: true, values: %i[get post put delete], desc: "API request type"
+        argument :path, required: true, desc: "API request path"
 
-        option   :rid, type: :integer, default: nil, desc: 'Repository id'
-        option   :payload, type: :string, default: '{}', desc: 'Data payload (json)'
-        option   :params, type: :string, default: '{}', desc: 'Params (json)'
+        option :rid, type: :integer, default: nil, desc: "Repository id"
+        option :payload, type: :string, default: "{}", desc: "Data payload (json)"
+        option :params, type: :string, default: "{}", desc: "Params (json)"
 
         example [
           'exec get --rid 2 "resources/1"',
           'exec get users --params \'{"query": {"page": 1}}\''
         ]
 
-        def call(type:, path:, rid: nil, payload: '{}', params: '{}', **)
+        def call(type:, path:, rid: nil, payload: "{}", params: "{}", **)
           client = ArchivesSpace::Client::CLI.client
           client.repository(rid) if rid
-          type    = type.to_sym
+          type = type.to_sym
           payload = JSON.parse(payload, symbolize_names: true)
-          params  = JSON.parse(params, symbolize_names: true)
+          params = JSON.parse(params, symbolize_names: true)
 
           response = case type
-                     when :get
-                       client.get(path, params)
-                     when :post
-                       client.post(path, payload, params)
-                     when :put
-                       client.put(path, payload, params)
-                     when :delete
-                       client.delete(path)
-                     end
+          when :get
+            client.get(path, params)
+          when :post
+            client.post(path, payload, params)
+          when :put
+            client.put(path, payload, params)
+          when :delete
+            client.delete(path)
+          end
           puts JSON.generate(response.parsed)
         end
       end

data/lib/archivesspace/client/cli/version.rb

@@ -5,7 +5,7 @@ module ArchivesSpace
     module CLI
       # ArchivesSpace::Client::CLI::Version prints version
       class Version < Dry::CLI::Command
-        desc 'Print ArchivesSpace Client version'
+        desc "Print ArchivesSpace Client version"
 
         def call(*)
           puts ArchivesSpace::Client::VERSION

data/lib/archivesspace/client/cli.rb

@@ -11,14 +11,14 @@ module ArchivesSpace
       end
 
       def self.find_config
-        config = ENV.fetch('ASCLIENT_CFG', File.join(ENV['HOME'], '.asclientrc'))
+        config = ENV.fetch("ASCLIENT_CFG", File.join(ENV["HOME"], ".asclientrc"))
         raise "Unable to find asclient configuration file at: #{config}" unless File.file?(config)
 
         JSON.parse(File.read(config), symbolize_names: true)
       end
 
-      register 'exec', Exec, aliases: ['e', '-e']
-      register 'version', Version, aliases: ['v', '-v', '--version']
+      register "exec", Exec, aliases: ["e", "-e"]
+      register "version", Version, aliases: ["v", "-v", "--version"]
     end
   end
 end

data/lib/archivesspace/client/client.rb

@@ -5,33 +5,35 @@ module ArchivesSpace
     include Pagination
     include Task
     attr_accessor :token
-    attr_reader   :config
+    attr_reader :config
+
+    NAME = "ArchivesSpaceClient"
 
     def initialize(config = Configuration.new)
-      raise 'Invalid configuration object' unless config.is_a? ArchivesSpace::Configuration
+      raise "Invalid configuration object" unless config.is_a? ArchivesSpace::Configuration
 
       @config = config
-      @token  = nil
+      @token = nil
     end
 
     def backend_version
-      get 'version'
+      get "version"
     end
 
     def get(path, options = {})
-      request 'GET', path, options
+      request "GET", path, options
     end
 
     def post(path, payload, params = {})
-      request 'POST', path, { body: payload, query: params }
+      request "POST", path, {body: payload, query: params}
     end
 
     def put(path, payload, params = {})
-      request 'PUT', path, { body: payload, query: params }
+      request "PUT", path, {body: payload, query: params}
     end
 
     def delete(path)
-      request 'DELETE', path
+      request "DELETE", path
     end
 
     # Scoping requests
@@ -43,7 +45,7 @@ module ArchivesSpace
 
       begin
         Integer(id)
-      rescue StandardError
+      rescue
         raise RepositoryIdError, "Invalid Repository id: #{id}"
       end
 
@@ -51,14 +53,14 @@ module ArchivesSpace
     end
 
     def use_global_repository
-      @config.base_repo = ''
+      @config.base_repo = ""
     end
 
     private
 
     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