archivesspace-client 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4ff1d8782c564f4dfdf2dce03267b11f9e60fc14648bd07da6a9882c169050e
-  data.tar.gz: 23f900ce6d47bf4a4b55646249306c49f0d41ef671f2c8ba30ad8ea1855ca000
+  metadata.gz: 0cb687dbc7f3a7a89938658d7024ab955b82004b42e25992b848fb956307d91d
+  data.tar.gz: a3ae5bbd93f28c043cbe15d8f4d0f0f3010171710f212116da3c60eecab4f816
 SHA512:
-  metadata.gz: 99478138d6f6902b7f3efd07c92f5635f69ee43b4609135c92bb3c541454c95254da6f401de1be0051245e0a99f30de2c6cb2c19661bf2688a09bda789441a05
-  data.tar.gz: c7f45e1358d6550164a05b1ed966c6ac6cb1f993bd2ab3c570c7ae52ba70de50923c19a4907fbc1951cd8a1db2b82a05062b4b464fa3f6446b6ca50f7a37668e
+  metadata.gz: ce3fb2a7fdea4c8fcd40b61f306581f9dbbb2ae2f83b1096500cb571ae6abcc82291d8493bbfff18b56284c33b8507e46f5eed97c25b81e4d4da6edcbf03bbef
+  data.tar.gz: 04f948ae7c1060b0872e32051a58936ce792190545841ad5153d741ce3af0d8a43f78db7c22c1486aa1d2bef02c368341fb64073a56d0b76f23c14685bfa10d8

data/.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Ruby and install gems
         uses: ruby/setup-ruby@v1

data/.github/workflows/publish.yml

@@ -18,7 +18,6 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
-          ruby-version: 3.2.2
           rubygems: latest
 
       - name: Release Gem

data/README.md

@@ -2,6 +2,26 @@
 
 Interact with ArchivesSpace via the API.
 
+<!-- TOC start (generated with https://github.com/derlin/bitdowntoc) -->
+
+* [Installation](#installation)
+* [Usage](#usage)
+   + [Configuring a client](#configuring-a-client)
+      - [Default configuration](#default-configuration)
+      - [Custom configuration, on the fly](#custom-configuration-on-the-fly)
+      - [Custom configuration, stored for use with CLI or console](#custom-configuration-stored-for-use-with-cli-or-console)
+   + [Making basic requests](#making-basic-requests)
+   + [Setting a repository context](#setting-a-repository-context)
+* [Templates](#templates)
+* [CLI](#cli)
+* [Console usage](#console-usage)
+* [Development](#development)
+* [Publishing](#publishing)
+* [Contributing](#contributing)
+* [License](#license)
+
+<!-- TOC end -->
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,7 +46,9 @@ gem install archivesspace-client
 
 See the examples directory for a range of use cases.
 
-**Default configuration**
+### Configuring a client
+
+#### Default configuration
 
 Create client with default settings (`localhost:8089`, `admin`, `admin`):
 
@@ -34,12 +56,11 @@ Create client with default settings (`localhost:8089`, `admin`, `admin`):
 client = ArchivesSpace::Client.new.login
 ```
 
-**Custom configuration**
+#### Custom configuration, on the fly
 
 ```ruby
 config = ArchivesSpace::Configuration.new({
-  base_uri: "https://archives.university.edu/api",
-  base_repo: "",
+  base_uri: "https://archives.university.edu/staff/api",
   username: "admin",
   password: "123456",
   page_size: 50,
@@ -51,7 +72,35 @@ config = ArchivesSpace::Configuration.new({
 client = ArchivesSpace::Client.new(config).login
 ```
 
-**Making basic requests**
+**NOTE:** `ArchivesSpace::Configuration` allows you to set a `base_repo` value as well, but if this value is set in your config at the start, calls to API endpoints that do not include a repository id in the URI may not work correctly. It is recommended you set/unset the client repository as needed during use via the `#repository` method as described below. If you must set `base_repo` in the config used to create your client, note that the value should be like: "repositories/2", and not just the integer repository id.
+
+#### Custom configuration, stored for use with CLI or console
+
+Create a file containing JSON config data like:
+
+```
+{
+  "base_uri": "http://localhost:4567",
+  "username": "admin",
+  "password": "myverysecurepassword",
+  "page_size": 50,
+  "throttle": 0,
+  "timeout": 60,
+  "verify_ssl": false,
+  "debug": true
+}
+```
+
+The CLI and console commands will, by default, look for this stored config at `~/.asclientrc`,
+
+However, you may also set a custom location for the file by setting an ASCLIENT_CFG environment variable. This is handy if you prefer to use [XDG Base Directory Specification](https://xdgbasedirectoryspecification.com/), or have other opinions about where such config should live:
+
+```
+export ASCLIENT_CFG="$HOME/.config/archivesspace/client.json"
+```
+
+
+### Making basic requests
 
 The client responds to the standard request methods:
 
@@ -77,17 +126,33 @@ user = client.users.find { |user| user["username"] == "jdoe" }
 See `pagination.rb` for endpoints that support record type methods such as
 `client.digital_objects` etc.
 
-**Setting a repository context**
+### Setting a repository context
 
 Use the `repository` method to add a repository scope to requests (this is optional).
 
+Instead of doing:
+
+```ruby
+client.get('repositories/2/digital_objects', query: {page: 1})
+```
+
+You can do:
+
 ```ruby
 client.repository(2)
-client.get('digital_objects', query: {page: 1}) # instead of "repositories/2/digital_objects" etc.
+client.get('digital_objects', query: {page: 1})
+```
+
 
-# to reset
+To reset:
+
+```ruby
 client.repository(nil)
-# or
+```
+
+Or:
+
+```ruby
 client.use_global_repository
 ```
 
@@ -124,26 +189,40 @@ To view available templates use: `ArchivesSpace::Template.list`
 
 ## CLI
 
-Create an `~/.asclientrc` file with a json version of the client configuration:
+Create a stored custom configuration to be used with the CLI as described above.
 
-```json
-{
-  "base_uri": "https://archives.university.edu/api",
-  "base_repo": "",
-  "username": "admin",
-  "password": "123456",
-  "page_size": 50,
-  "throttle": 0,
-  "timeout": 60,
-  "verify_ssl": false
-}
+If you installed this client as a gem via the `gem install archivesspace-client` command, you should be able to use the `asclient` command directly.
+
+If entering `asclient` in your terminal returns an error, you will need to use the CLI from within this repository:
+
+```bash
+cd path/to/archivesspace-client
+./exe/asclient
 ```
 
-Run commands:
+The `asclient` command is self-documenting and will show you information about the currently supported commands.
+
+To get more detailed usage info on a command:
 
 ```bash
-# when using locally via the repo prefix commands with ./exe/ i.e. ./exe/asclient -v
-asclient -v
+asclient exec -h
+```
+
+## Console usage
+
+Loading this application in console allows you to play around with its functionality interactively.
+
+Create a stored custom configuration to be used with the console as described above. Then:
+
+```bash
+cd path/to/archivesspace-client
+./bin/console
+```
+
+An IRB session opens. Entering the following should give you the backend version of the ArchivesSpace instance your stored custom config points to:
+
+```
+@client.backend_version
 ```
 
 ## Development

data/archivesspace-client.gemspec

@@ -33,5 +33,5 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_dependency "jbuilder", "~> 2.12"
 end

data/bin/console

@@ -5,15 +5,7 @@ require "bundler/setup"
 require "archivesspace/client"
 
 config = ArchivesSpace::Configuration.new(
-  {
-    base_uri: "https://test.archivesspace.org/staff/api",
-    base_repo: "",
-    username: "admin",
-    password: "admin",
-    page_size: 50,
-    throttle: 0,
-    verify_ssl: false
-  }
+  ArchivesSpace::Client::CLI.find_config
 )
 @client = ArchivesSpace::Client.new(config).login
 

data/examples/export.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require "awesome_print"
 require "archivesspace/client"
 
 # official sandbox

data/examples/password_reset.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require "awesome_print"
 require "archivesspace/client"
 
 username = "admin"

data/examples/repo_and_user.rb

@@ -1,13 +1,12 @@
 # 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: "https://sandbox.archivesspace.org/api",
+    base_uri: "https://sandbox.archivesspace.org/staff/api",
     base_repo: "",
     username: "admin",
     password: "admin",
@@ -19,7 +18,7 @@ config = ArchivesSpace::Configuration.new(
 
 client = ArchivesSpace::Client.new(config).login
 
-ap ArchivesSpace::Template.list # view available templates
+puts ArchivesSpace::Template.list # view available templates
 
 repo_data = {
   repo_code: "XYZ",
@@ -40,20 +39,20 @@ begin
   response = client.post("/repositories/with_agent", repository)
   if response.result.success?
     repository = client.repositories.find { |r| r["repo_code"] == "XYZ" }
-    ap repository
-    ap client.delete(repository["uri"])
+    puts repository
+    puts client.delete(repository["uri"])
   else
-    ap response.parsed
+    puts response.parsed
   end
 
   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" }
-    ap user
-    ap client.delete user["uri"]
+    puts user
+    puts client.delete(user["uri"]).inspect
   else
-    ap response.parsed
+    puts response.parsed
   end
 rescue ArchivesSpace::RequestError => e
   puts e.message

data/examples/templates.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
-require "awesome_print"
 require "archivesspace/client"
 
 puts ArchivesSpace::Template.list

data/examples/test_connection.rb

@@ -1,13 +1,12 @@
 # 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: "https://sandbox.archivesspace.org/api",
+    base_uri: "https://sandbox.archivesspace.org/staff/api",
     base_repo: "",
     username: "admin",
     password: "admin",

data/examples/user_groups.rb

@@ -1,13 +1,12 @@
 # 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: "https://sandbox.archivesspace.org/api",
+    base_uri: "https://sandbox.archivesspace.org/staff/api",
     base_repo: "",
     username: "admin",
     password: "admin",
@@ -19,17 +18,13 @@ config = ArchivesSpace::Configuration.new(
 
 client = ArchivesSpace::Client.new(config).login
 
-user_data = {
+user_data = ArchivesSpace::Template.process("user.json.erb", {
   username: "bde",
   name: "BDE",
   is_admin: false
-}
+})
 
-client.post(
-  "users",
-  ArchivesSpace::Template.process("user.json.erb", user_data),
-  {password: "123456"}
-)
+client.post("users", user_data, {password: "123456"})
 
 users_with_roles = {
   "bde" => ["repository-basic-data-entry"]
@@ -38,7 +33,7 @@ users_with_roles = {
 begin
   client.config.base_repo = "repositories/2"
   results = client.group_user_assignment users_with_roles
-  ap results.map(&:parsed)
+  puts results.map(&:parsed)
 rescue ArchivesSpace::RequestError => e
   puts e.message
 end

data/lib/archivesspace/client/client.rb

@@ -25,11 +25,11 @@ module ArchivesSpace
     end
 
     def post(path, payload, params = {})
-      request "POST", path, {body: payload, query: params}
+      request "POST", path, {body: payload.to_json, query: params}
     end
 
     def put(path, payload, params = {})
-      request "PUT", path, {body: payload, query: params}
+      request "PUT", path, {body: payload.to_json, query: params}
     end
 
     def delete(path)

data/lib/archivesspace/client/task.rb

@@ -3,10 +3,6 @@
 module ArchivesSpace
   # Perform specific API tasks
   module Task
-    # def batch_import(payload, params = {})
-    #   # TODO: create "batch_import", payload, params
-    # end
-
     def group_user_assignment(users_with_roles)
       updated = []
       groups.each do |group|
@@ -29,7 +25,7 @@ module ArchivesSpace
 
         next unless update
 
-        response = post("/groups/#{uri_to_id(group["uri"])}", group.to_json)
+        response = post("/groups/#{uri_to_id(group["uri"])}", group)
         updated << response
       end
       updated
@@ -54,13 +50,9 @@ module ArchivesSpace
       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, {password: password})
     end
 
-    # def search(params)
-    #   # TODO: get "search", params
-    # end
-
     private
 
     def uri_to_id(uri)

data/lib/archivesspace/client/template.rb

@@ -50,7 +50,7 @@ module ArchivesSpace
       def process
         t = ERB.new(read_template)
         r = t.result(binding).squeeze("\n")
-        JSON.parse(r).to_json
+        JSON.parse(r)
       end
     end
 
@@ -60,9 +60,9 @@ module ArchivesSpace
       end
 
       def process
-        ::Jbuilder.encode do |json|
+        ::Jbuilder.new do |json|
           eval(read_template, binding) # standard:disable Security/Eval
-        end
+        end.attributes!
       end
     end
   end

data/lib/archivesspace/client/version.rb

@@ -2,6 +2,6 @@
 
 module ArchivesSpace
   class Client
-    VERSION = "0.4.0"
+    VERSION = "0.4.2"
   end
 end

data/spec/archivesspace/templates_spec.rb

@@ -21,14 +21,14 @@ describe ArchivesSpace::Template do
 
   it "can process an erb template" do
     data = {repo_code: "ABC", name: "ABC Archive", agent_contact_name: "ABC Admin"}
-    json = JSON.parse(ArchivesSpace::Template.process("repository_with_agent.json.erb", data))
-    expect(json["repository"]["repo_code"]).to eq data[:repo_code]
+    record = ArchivesSpace::Template.process("repository_with_agent.json.erb", data)
+    expect(record["repository"]["repo_code"]).to eq data[:repo_code]
   end
 
   it "can process a jbuilder template" do
     data = {"title" => "Title", "object_number" => "001.001", "description_level" => "collection"}
-    json = JSON.parse(ArchivesSpace::Template.process("resource.json.jbuilder", data))
-    expect(json["id_0"]).to eq data["object_number"]
+    record = ArchivesSpace::Template.process("resource.json.jbuilder", data)
+    expect(record["id_0"]).to eq data["object_number"]
   end
 
   it "rejects a template that does not match by extension" do

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: archivesspace-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Mark Cooper
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -204,14 +203,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.5
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.11.5
+        version: '2.12'
 description: Interact with ArchivesSpace via the API.
 email:
 - mark.c.cooper@outlook.com
@@ -268,7 +267,6 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -283,8 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Interact with ArchivesSpace via the API.
 test_files: []