archivesspace-client 0.1.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b68b6cb7fcd238639742c355e7256cea1ae76536762425d535e49ad0aaec309
-  data.tar.gz: 7188d9e03e36c0ffefb3abd1694bdc5b21e7a5e74aee9e5e9396ee30571d3919
+  metadata.gz: 26be5a79844d110ef48e58aff9f3e1d77a9c30cbdcdad23939fce33853a21f1c
+  data.tar.gz: 0b9751a44ecd8e594eaad01395c088b78c438759b7691bcaacc6160262e35325
 SHA512:
-  metadata.gz: 122cf84d68c31fc2a69423489c15ae93fbf671a039ab1f7753f5ab0b47056640e186f073c276ac53f3b145f76663be6cddc9cb23c364bd5e88a0d431b755d6e9
-  data.tar.gz: eb8c1f20902bdf57c7d04a664d0f739878e1521c6d7a8ddcb5a0e2c08da9f1d9c7cb52789f409ac4ecee3705303aa07dd127d6584bb17ba5650c65049361275e
+  metadata.gz: 93475f09b5b24182646d0dce07b57aa2cc1e98a6e78be5874ee20454f9603736f86fe2c0bba360c72641e1364ffec9d28bdbbad12683c7c86d061486148814ad
+  data.tar.gz: 6671814168066bc5c4ad04c436bed59e50fbec5febd6a11867b7f97f93c1be15d40e2d3147c19283ced5f435702f1107bf2476abe0a966dbffc149e461595911

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+on: [pull_request]
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Ruby and install gems
+        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

data/.github/workflows/publish.yml

@@ -0,0 +1,42 @@
+name: Publish Gem
+
+on:
+  push:
+    branches:
+      - main
+      - master
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Ruby and install gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 2.7
+          rubygems: latest
+
+      - name: Release Gem
+        run: |
+          VERSION=$(bundle exec rake version)
+          GEM_VERSION=$(gem list --exact --remote $GEM_NAME)
+
+          # Publish to RubyGems.org
+          if [ "${GEM_VERSION}" != "$GEM_NAME (${VERSION})" ]; then
+            gem build $GEM_NAME.gemspec
+            gem push "$GEM_NAME-${VERSION}.gem"
+          fi
+
+          # Create a release tag
+          if ! git ls-remote --tags --exit-code origin v${VERSION}; then
+            git tag v${VERSION}
+            git push --tags
+          fi
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_AUTH_TOKEN }}"
+          GEM_NAME: archivesspace-client

data/.rubocop.yml

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

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**
 
@@ -130,6 +132,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
 }
 ```
@@ -161,17 +164,8 @@ bundle exec rake
 
 ## Publishing
 
-Bump version in `lib/archivesspace/client/version.rb` then:
-
-```bash
-VERSION=0.1.9
-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
-```
+When an updated version (`lib/archivesspace/client/version.rb`) is merged into the
+main/master branch a new release will be built and published.
 
 ## Contributing
 

data/Rakefile

@@ -1,14 +1,20 @@
 # 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
+  puts ArchivesSpace::Client::VERSION
+end

data/archivesspace-client.gemspec

@@ -1,37 +1,38 @@
 # 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 'vcr', '3.0.3'
-  spec.add_development_dependency 'webmock', '3.0.1'
+  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 "standard"
+  spec.add_development_dependency "vcr", "3.0.3"
+  spec.add_development_dependency "webmock", "3.0.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"
 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)
 
 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 })
+  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/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,19 +20,19 @@ 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',
+  "users",
   ArchivesSpace::Template.process(:user, user_data),
-  { password: '123456' }
+  {password: "123456"}
 )
 
 users_with_roles = {
-  'bde' => ['repository-basic-data-entry']
+  "bde" => ["repository-basic-data-entry"]
 }
 
 begin

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,33 @@ module ArchivesSpace
     include Pagination
     include Task
     attr_accessor :token
-    attr_reader   :config
+    attr_reader :config
 
     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 +43,7 @@ module ArchivesSpace
 
       begin
         Integer(id)
-      rescue StandardError
+      rescue
         raise RepositoryIdError, "Invalid Repository id: #{id}"
       end
 
@@ -51,14 +51,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

data/lib/archivesspace/client/configuration.rb

@@ -4,21 +4,22 @@ module ArchivesSpace
   class Configuration
     def defaults
       {
-        base_uri: 'http://localhost:8089',
-        base_repo: '',
+        base_uri: "http://localhost:8089",
+        base_repo: "",
         debug: false,
-        username: 'admin',
-        password: 'admin',
+        username: "admin",
+        password: "admin",
         page_size: 50,
         throttle: 0,
-        verify_ssl: true
+        verify_ssl: true,
+        timeout: 60
       }
     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)

data/lib/archivesspace/client/pagination.rb

@@ -13,14 +13,14 @@ module ArchivesSpace
       archival_objects
       digital_objects
       groups
-      repositiories
+      repositories
       resources
       subjects
       users
     ]
 
     ENDPOINTS.each do |endpoint|
-      method_name = endpoint.split('/').last # remove prefix
+      method_name = endpoint.split("/").last # remove prefix
       define_method(method_name) do |options = {}|
         all(endpoint, options)
       end
@@ -36,8 +36,8 @@ module ArchivesSpace
           result = get(path, options)
           results = []
 
-          if result.parsed.respond_to?(:key) && result.parsed.key?('results')
-            results = result.parsed['results']
+          if result.parsed.respond_to?(:key) && result.parsed.key?("results")
+            results = result.parsed["results"]
           else
             results = result.parsed
             unlimited_listing = true

data/lib/archivesspace/client/request.rb

@@ -10,25 +10,27 @@ 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.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
+    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[:timeout] = config.timeout
+      @options[:query] = {} unless options.key? :query
 
       self.class.debug_output($stdout) if @config.debug
 

data/lib/archivesspace/client/response.rb

@@ -5,11 +5,11 @@ module ArchivesSpace
     attr_reader :result, :parsed, :body, :headers, :status, :status_code
 
     def initialize(result)
-      @result      = result
-      @parsed      = result.parsed_response
-      @body        = result.body
-      @headers     = result.headers
-      @status      = result.response
+      @result = result
+      @parsed = result.parsed_response
+      @body = result.body
+      @headers = result.headers
+      @status = result.response
       @status_code = result.code.to_i
     end
   end

data/lib/archivesspace/client/task.rb

@@ -10,51 +10,51 @@ module ArchivesSpace
     def group_user_assignment(users_with_roles)
       updated = []
       groups.each do |group|
-        group = get("groups/#{uri_to_id(group['uri'])}").parsed
+        group = get("groups/#{uri_to_id(group["uri"])}").parsed
         update = false
 
         users_with_roles.each do |user, roles|
           # 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
+          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
+          elsif roles.include? group["group_code"]
+            group["member_usernames"] << user
             update = true
           end
         end
 
         next unless update
 
-        response = post("/groups/#{uri_to_id(group['uri'])}", group.to_json)
+        response = post("/groups/#{uri_to_id(group["uri"])}", group.to_json)
         updated << response
       end
       updated
     end
 
     def login
-      username  = config.username
-      password  = config.password
+      username = config.username
+      password = config.password
       base_repo = config.base_repo
       use_global_repository # ensure we're in the global scope to login
-      result = request('POST', "/users/#{username}/login", { query: { password: password } })
-      unless result.parsed['session']
-        raise ConnectionError, "Failed to connect to ArchivesSpace backend as #{username} #{password}"
+      result = request("POST", "/users/#{username}/login", {query: {password: password}})
+      unless result.parsed["session"]
+        raise ConnectionError, "API client login failed as user [#{username}], check username and password are correct"
       end
 
       config.base_repo = base_repo # reset repo as set by the cfg
-      @token = result.parsed['session']
+      @token = result.parsed["session"]
       self
     end
 
     def password_reset(username, password)
-      user = all('users').find { |u| u['username'] == username }
+      user = all("users").find { |u| u["username"] == username }
       raise RequestError, user.status unless user
 
-      post(user['uri'], user.to_json, { password: password })
+      post(user["uri"], user.to_json, {password: password})
     end
 
     # def search(params)
@@ -64,7 +64,7 @@ module ArchivesSpace
     private
 
     def uri_to_id(uri)
-      uri.split('/').last
+      uri.split("/").last
     end
   end
 end

data/lib/archivesspace/client/template.rb

@@ -3,12 +3,12 @@
 module ArchivesSpace
   module Template
     def self.list
-      Dir.glob File.join(templates_path, '*.erb')
+      Dir.glob File.join(templates_path, "*.erb")
     end
 
     def self.process(template, data)
       t = ERB.new(read(template))
-      r = t.result(binding).gsub(/\n+/, "\n")
+      r = t.result(binding).squeeze("\n")
       JSON.parse(r).to_json
     end
 
@@ -18,8 +18,8 @@ module ArchivesSpace
 
     def self.templates_path
       ENV.fetch(
-        'ARCHIVESSPACE_CLIENT_TEMPLATES_PATH',
-        File.join(File.dirname(File.expand_path(__FILE__)), 'templates')
+        "ARCHIVESSPACE_CLIENT_TEMPLATES_PATH",
+        File.join(File.dirname(File.expand_path(__FILE__)), "templates")
       )
     end
   end

data/lib/archivesspace/client/version.rb

@@ -2,6 +2,6 @@
 
 module ArchivesSpace
   class Client
-    VERSION = '0.1.10'
+    VERSION = "0.2.0"
   end
 end

data/lib/archivesspace/client.rb

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
-require 'dry/cli'
-require 'httparty'
-require 'json'
-require 'nokogiri'
+require "dry/cli"
+require "httparty"
+require "json"
+require "nokogiri"
 
 # mixins required first
-require 'archivesspace/client/pagination'
-require 'archivesspace/client/task'
+require "archivesspace/client/pagination"
+require "archivesspace/client/task"
 
-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"
 
 # cli
-require 'archivesspace/client/cli/exec'
-require 'archivesspace/client/cli/version'
-require 'archivesspace/client/cli' # load the registry last
+require "archivesspace/client/cli/exec"
+require "archivesspace/client/cli/version"
+require "archivesspace/client/cli" # load the registry last
 
 module ArchivesSpace
   class ConnectionError < RuntimeError; end
 
-  class ContextError    < RuntimeError; end
+  class ContextError < RuntimeError; end
 
   class RepositoryIdError < RuntimeError; end
 
-  class ParamsError     < RuntimeError; end
+  class ParamsError < RuntimeError; end
 
-  class RequestError    < RuntimeError; end
+  class RequestError < RuntimeError; end
 end

data/spec/archivesspace/client_spec.rb

@@ -1,87 +1,87 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe ArchivesSpace::Client do
   let(:client) { ArchivesSpace::Client.new }
-  let(:login)  { -> { client.login } }
+  let(:login) { -> { client.login } }
 
-  describe 'Configuration' do
-    it 'will use the default configuration if none is provided' 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)
+    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)
     end
 
-    it 'will allow a configuration object to be provided' do
-      client = ArchivesSpace::Client.new(ArchivesSpace::Configuration.new({ base_uri: CUSTOM_BASE_URI }))
+    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 'Repository scoping' do
-    it 'will set the repository with an integer id' do
+  describe "Repository scoping" do
+    it "will set the repository with an integer id" do
       client = ArchivesSpace::Client.new
       client.repository 2
-      expect(client.config.base_repo).to eq 'repositories/2'
+      expect(client.config.base_repo).to eq "repositories/2"
     end
 
-    it 'will set the repository with a string id cast to integer' do
+    it "will set the repository with a string id cast to integer" do
       client = ArchivesSpace::Client.new
-      client.repository '2'
-      expect(client.config.base_repo).to eq 'repositories/2'
+      client.repository "2"
+      expect(client.config.base_repo).to eq "repositories/2"
     end
 
-    it 'will fail if the id cannot be cast to integer' do
+    it "will fail if the id cannot be cast to integer" do
       client = ArchivesSpace::Client.new
-      expect { client.repository('xyz') }.to raise_error(
+      expect { client.repository("xyz") }.to raise_error(
         ArchivesSpace::RepositoryIdError
       )
     end
 
-    it 'will use the global repo if repository is passed nil' do
+    it "will use the global repo if repository is passed nil" do
       client = ArchivesSpace::Client.new
       client.repository 2
       client.repository nil
-      expect(client.config.base_repo).to eq ''
+      expect(client.config.base_repo).to eq ""
     end
 
-    it 'will use the global repo when the method is called' do
+    it "will use the global repo when the method is called" do
       client = ArchivesSpace::Client.new
       client.repository 2
       client.use_global_repository
-      expect(client.config.base_repo).to eq ''
+      expect(client.config.base_repo).to eq ""
     end
   end
 
-  describe 'Pagination' do
-    it 'will have a method for defined paginated record types' do
+  describe "Pagination" do
+    it "will have a method for defined paginated record types" do
       client = ArchivesSpace::Client.new
       ArchivesSpace::Pagination::ENDPOINTS.each do |e|
-        next if e.match?('/')
+        next if e.match?("/")
 
         expect(client.respond_to?(e.to_sym)).to be true
       end
     end
 
-    it 'will have a method for defined paginated record types with multipart path' do
+    it "will have a method for defined paginated record types with multipart path" do
       client = ArchivesSpace::Client.new
       expect(client.respond_to?(:people)).to be true
     end
   end
 
-  describe 'Version information' do
-    it 'has a version number' 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
-      VCR.use_cassette('backend_version') 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

data/spec/archivesspace/configuration_spec.rb

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe ArchivesSpace::Configuration do
-  it 'uses the default profile for configuration settings' do
+  it "uses the default profile for configuration settings" do
     config = ArchivesSpace::Configuration.new
     expect(config.base_uri).to eq DEFAULT_BASE_URI
   end
 
-  it 'allows configuration settings to be provided' 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
 
-  it 'allows the configuration properties to be updated' do
+  it "allows the configuration properties to be updated" do
     config = ArchivesSpace::Configuration.new
     config.base_uri = CUSTOM_BASE_URI
     expect(config.base_uri).to eq CUSTOM_BASE_URI
   end
 
-  it 'ignores unrecognized configuration properties' do
-    config = ArchivesSpace::Configuration.new({ xyz: 123 })
+  it "ignores unrecognized configuration properties" do
+    config = ArchivesSpace::Configuration.new({xyz: 123})
     expect { config.xyz }.to raise_error(NoMethodError)
   end
 end

data/spec/archivesspace/templates_spec.rb

@@ -1,26 +1,26 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe ArchivesSpace::Template do
-  it 'can list the default templates' 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
+  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')
+    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' }
+  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]
+    expect(json["repository"]["repo_code"]).to eq data[:repo_code]
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
-require 'archivesspace/client'
-require 'vcr'
-require 'webmock/rspec'
+$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 }
+  c.default_cassette_options = {record: :once}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archivesspace-client
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Cooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -122,6 +122,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: standard
+  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: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -213,8 +241,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -270,16 +301,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.21
 signing_key: 
 specification_version: 4
 summary: Interact with ArchivesSpace via the API.
-test_files:
-- features/exec.feature
-- features/support/setup.rb
-- features/version.feature
-- 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
+test_files: []