archivesspace-client 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ea50bb167b4debf8781434efa1ff7b06d077a8ab869f02c30ea8d1cd66de3c9
-  data.tar.gz: 83f63ad1f11fc35ca89cdabe871a1e1fa91f935e2e6e284f038b6db2c0257065
+  metadata.gz: 3b68b6cb7fcd238639742c355e7256cea1ae76536762425d535e49ad0aaec309
+  data.tar.gz: 7188d9e03e36c0ffefb3abd1694bdc5b21e7a5e74aee9e5e9396ee30571d3919
 SHA512:
-  metadata.gz: faa0086ae6ecd33700e3cf16c41b7457ebf094eb4a5e79109c3999ce0e916f8924450cb6ef8bcb4a761f0d6ed3a1c12a457dec4cd5738429a8f80fb249303fbe
-  data.tar.gz: '09a6fca39d7846875715216e8b10d5d29b776b433c37abef3490b5964e62deca9de5f01e69f868a476cceb11c7ceaa43032cfb906f9fff35da10b43e0b3582e7'
+  metadata.gz: 122cf84d68c31fc2a69423489c15ae93fbf671a039ab1f7753f5ab0b47056640e186f073c276ac53f3b145f76663be6cddc9cb23c364bd5e88a0d431b755d6e9
+  data.tar.gz: eb8c1f20902bdf57c7d04a664d0f739878e1521c6d7a8ddcb5a0e2c08da9f1d9c7cb52789f409ac4ecee3705303aa07dd127d6584bb17ba5650c65049361275e

data/README.md

@@ -77,14 +77,16 @@ See `helpers.rb` for more convenience methods such as `client.digital_objects` e
 
 **Setting a repository context**
 
-Update the `base_repo` configuration value to add a repository scope to requests (this is optional).
+Use the `repository` method to add a repository scope to requests (this is optional).
 
 ```ruby
-client.config.base_repo = "repositories/2"
-client.get('digital_objects') # instead of "repositories/2/digital_objects" etc.
+client.repository(2)
+client.get('digital_objects', query: {page: 1}) # instead of "repositories/2/digital_objects" etc.
 
 # to reset
-client.config.base_repo = ""
+client.repository(nil)
+# or
+client.use_global_repository
 ```
 
 ## Templates
@@ -116,6 +118,29 @@ response = client.post('/repositories/with_agent', json)
 puts response.result.success? ? '=)' : '=('
 ```
 
+## CLI
+
+Create an `~/.asclientrc` file with a json version of the client configuration:
+
+```json
+{
+  "base_uri": "https://archives.university.edu/api",
+  "base_repo": "",
+  "username": "admin",
+  "password": "123456",
+  "page_size": 50,
+  "throttle": 0,
+  "verify_ssl": false
+}
+```
+
+Run commands:
+
+```bash
+# when using locally via the repo prefix commands with ./exe/ i.e. ./exe/asclient -v
+asclient -v
+```
+
 ## Development
 
 To run the examples start a local instance of ArchivesSpace then:
@@ -139,7 +164,7 @@ bundle exec rake
 Bump version in `lib/archivesspace/client/version.rb` then:
 
 ```bash
-VERSION=0.1.8
+VERSION=0.1.9
 gem build archivesspace-client
 git add . && git commit -m "Bump to $VERSION"
 git tag v$VERSION

data/Rakefile

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

data/archivesspace-client.gemspec

@@ -19,13 +19,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   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_dependency 'dry-cli', '~> 0.7'
   spec.add_dependency 'httparty', '~> 0.14'
   spec.add_dependency 'json', '~> 2.0'
   spec.add_dependency 'nokogiri', '~> 1.10'

data/exe/asclient

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

data/features/exec.feature

@@ -0,0 +1,4 @@
+Feature: Exec
+  Scenario: With an invalid request type
+    When I run `asclient exec all`
+    Then the output should match /asclient exec TYPE PATH/

data/features/support/setup.rb

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

data/features/version.feature

@@ -0,0 +1,12 @@
+Feature: Version
+  Scenario: Output with 'v'
+    When I run `asclient v`
+    Then the output should match /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/
+
+  Scenario: Output with -v
+    When I run `asclient -v`
+    Then the output should match /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/
+
+  Scenario: Output with --version
+    When I run `asclient --version`
+    Then the output should match /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ArchivesSpace
+  class Client
+    module CLI
+      # ArchivesSpace::Client::CLI::Exec executes an API request
+      class Exec < Dry::CLI::Command
+        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'
+
+        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: '{}', **)
+          client = ArchivesSpace::Client::CLI.client
+          client.repository(rid) if rid
+          type    = type.to_sym
+          payload = JSON.parse(payload, 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
+          puts JSON.generate(response.parsed)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ArchivesSpace
+  class Client
+    module CLI
+      # ArchivesSpace::Client::CLI::Version prints version
+      class Version < Dry::CLI::Command
+        desc 'Print ArchivesSpace Client version'
+
+        def call(*)
+          puts ArchivesSpace::Client::VERSION
+        end
+      end
+    end
+  end
+end

data/lib/archivesspace/client/cli.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ArchivesSpace
+  class Client
+    module CLI
+      extend Dry::CLI::Registry
+
+      def self.client
+        cfg = ArchivesSpace::Configuration.new(ArchivesSpace::Client::CLI.find_config)
+        ArchivesSpace::Client.new(cfg).login
+      end
+
+      def self.find_config
+        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']
+    end
+  end
+end

data/lib/archivesspace/client/client.rb

@@ -2,7 +2,8 @@
 
 module ArchivesSpace
   class Client
-    include Helpers
+    include Pagination
+    include Task
     attr_accessor :token
     attr_reader   :config
 
@@ -13,6 +14,10 @@ module ArchivesSpace
       @token  = nil
     end
 
+    def backend_version
+      get 'version'
+    end
+
     def get(path, options = {})
       request 'GET', path, options
     end
@@ -29,6 +34,26 @@ module ArchivesSpace
       request 'DELETE', path
     end
 
+    # Scoping requests
+    def repository(id)
+      if id.nil?
+        use_global_repository
+        return
+      end
+
+      begin
+        Integer(id)
+      rescue StandardError
+        raise RepositoryIdError, "Invalid Repository id: #{id}"
+      end
+
+      @config.base_repo = "repositories/#{id}"
+    end
+
+    def use_global_repository
+      @config.base_repo = ''
+    end
+
     private
 
     def request(method, path, options = {})

data/lib/archivesspace/client/configuration.rb

@@ -6,6 +6,7 @@ module ArchivesSpace
       {
         base_uri: 'http://localhost:8089',
         base_repo: '',
+        debug: false,
         username: 'admin',
         password: 'admin',
         page_size: 50,

data/lib/archivesspace/client/pagination.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ArchivesSpace
+  # Handle API Pagination using enumerator
+  module Pagination
+    # TODO: get via lookup of endpoints that support pagination? (nice-to-have)
+    ENDPOINTS = %w[
+      accessions
+      agents/corporate_entities
+      agents/families
+      agents/people
+      agents/software
+      archival_objects
+      digital_objects
+      groups
+      repositiories
+      resources
+      subjects
+      users
+    ]
+
+    ENDPOINTS.each do |endpoint|
+      method_name = endpoint.split('/').last # remove prefix
+      define_method(method_name) do |options = {}|
+        all(endpoint, options)
+      end
+    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
+
+          if results.any?
+            results.each do |i|
+              yielder << i
+            end
+            raise StopIteration if unlimited_listing
+
+            page += 1
+          else
+            raise StopIteration
+          end
+        end
+      end.lazy
+    end
+  end
+end

data/lib/archivesspace/client/request.rb

@@ -30,8 +30,9 @@ module ArchivesSpace
       @options[:verify]  = config.verify_ssl
       @options[:query]   = {} unless options.key? :query
 
-      base_uri = config.base_repo&.length&.positive? ? File.join(config.base_uri, config.base_repo) : config.base_uri
+      self.class.debug_output($stdout) if @config.debug
 
+      base_uri = config.base_repo&.length&.positive? ? File.join(config.base_uri, config.base_repo) : config.base_uri
       self.class.base_uri base_uri
     end
 

data/lib/archivesspace/client/{helpers.rb → task.rb}

@@ -1,66 +1,12 @@
 # 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 }
-    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
-
-          if results.any?
-            results.each do |i|
-              yielder << i
-            end
-            raise StopIteration if unlimited_listing
-
-            page += 1
-          else
-            raise StopIteration
-          end
-        end
-      end.lazy
-    end
-
-    def backend_version
-      get 'version'
-    end
-
+  # Perform specific API tasks
+  module Task
     # def batch_import(payload, params = {})
     #   # TODO: create "batch_import", payload, params
     # end
 
-    def digital_objects(options = {})
-      all('digital_objects', options)
-    end
-
-    def groups(options = {})
-      all('groups', options)
-    end
-
     def group_user_assignment(users_with_roles)
       updated = []
       groups.each do |group|
@@ -90,13 +36,16 @@ module ArchivesSpace
     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}"
       end
 
+      config.base_repo = base_repo # reset repo as set by the cfg
       @token = result.parsed['session']
       self
     end
@@ -108,26 +57,14 @@ module ArchivesSpace
       post(user['uri'], user.to_json, { password: password })
     end
 
-    def repositories(options = {})
-      all('repositories', options)
-    end
-
-    def repositories_with_agent; end
-
-    def resources(options = {})
-      all('resources', options)
-    end
-
     # def search(params)
     #   # TODO: get "search", params
     # end
 
+    private
+
     def uri_to_id(uri)
       uri.split('/').last
     end
-
-    def users(options = {})
-      all('users', options)
-    end
   end
 end

data/lib/archivesspace/client/version.rb

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

data/lib/archivesspace/client.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'dry/cli'
 require 'httparty'
 require 'json'
 require 'nokogiri'
 
 # mixins required first
-require 'archivesspace/client/helpers'
+require 'archivesspace/client/pagination'
+require 'archivesspace/client/task'
 
 require 'archivesspace/client/client'
 require 'archivesspace/client/configuration'
@@ -14,9 +16,19 @@ 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
+
 module ArchivesSpace
   class ConnectionError < RuntimeError; end
+
   class ContextError    < RuntimeError; end
+
+  class RepositoryIdError < RuntimeError; end
+
   class ParamsError     < RuntimeError; end
+
   class RequestError    < RuntimeError; end
 end

data/spec/archivesspace/client_spec.rb

@@ -22,6 +22,57 @@ describe ArchivesSpace::Client do
     end
   end
 
+  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'
+    end
+
+    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'
+    end
+
+    it 'will fail if the id cannot be cast to integer' do
+      client = ArchivesSpace::Client.new
+      expect { client.repository('xyz') }.to raise_error(
+        ArchivesSpace::RepositoryIdError
+      )
+    end
+
+    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 ''
+    end
+
+    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 ''
+    end
+  end
+
+  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?('/')
+
+        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
+      client = ArchivesSpace::Client.new
+      expect(client.respond_to?(:people)).to be true
+    end
+  end
+
   describe 'Version information' do
     it 'has a version number' do
       expect(ArchivesSpace::Client::VERSION).not_to be nil

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: archivesspace-client
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Mark Cooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara_discoball
+  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: cucumber
+  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: json_spec
+  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
@@ -94,6 +150,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -156,12 +226,20 @@ files:
 - examples/repo_and_user.rb
 - examples/test_connection.rb
 - examples/user_groups.rb
+- exe/asclient
+- features/exec.feature
+- features/support/setup.rb
+- features/version.feature
 - lib/archivesspace/client.rb
+- lib/archivesspace/client/cli.rb
+- lib/archivesspace/client/cli/exec.rb
+- lib/archivesspace/client/cli/version.rb
 - lib/archivesspace/client/client.rb
 - lib/archivesspace/client/configuration.rb
-- lib/archivesspace/client/helpers.rb
+- lib/archivesspace/client/pagination.rb
 - lib/archivesspace/client/request.rb
 - lib/archivesspace/client/response.rb
+- lib/archivesspace/client/task.rb
 - lib/archivesspace/client/template.rb
 - lib/archivesspace/client/templates/digital_object.json.erb
 - lib/archivesspace/client/templates/repository.json.erb
@@ -197,6 +275,9 @@ 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