archivesspace-client 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2087a90bf94b94f918d9b1453442e8e7a682ef75a76092fcd7dbe63d21816b83
-  data.tar.gz: 3f8e168c3e7a04e6dbb67e3bef8227f77d46ea3b9c009f08eddd24de3441f736
+  metadata.gz: 6ea50bb167b4debf8781434efa1ff7b06d077a8ab869f02c30ea8d1cd66de3c9
+  data.tar.gz: 83f63ad1f11fc35ca89cdabe871a1e1fa91f935e2e6e284f038b6db2c0257065
 SHA512:
-  metadata.gz: f6977881509e613d26e24bbfa7b20204d20aac113a3d3297d798ba3b5c2f0cc673d217d77f9c161a906229a69a8710cdf9745e9c96b27262f8b0f2ac20583e51
-  data.tar.gz: 2480484be2b5ec0379b3c7c280e8473897a9930cb5a6abc2ec7b28decb81722478e70703a1d8bd38992866d6adaf94492e06480679126213bf500205e948a749
+  metadata.gz: faa0086ae6ecd33700e3cf16c41b7457ebf094eb4a5e79109c3999ce0e916f8924450cb6ef8bcb4a761f0d6ed3a1c12a457dec4cd5738429a8f80fb249303fbe
+  data.tar.gz: '09a6fca39d7846875715216e8b10d5d29b776b433c37abef3490b5964e62deca9de5f01e69f868a476cceb11c7ceaa43032cfb906f9fff35da10b43e0b3582e7'

data/README.md

@@ -87,6 +87,35 @@ client.get('digital_objects') # instead of "repositories/2/digital_objects" etc.
 client.config.base_repo = ""
 ```
 
+## Templates
+
+Templates are an optional feature that can help simplify the effort of creating
+json payloads for ArchivesSpace. Rather than construct the json programatically
+according to the schemas a `.erb` template can be used to generate payloads
+instead which are transformed to json automatically. There are a small number of
+templates provided with the client, but you can create your own and access them
+by setting the `ARCHIVESSPACE_CLIENT_TEMPLATES_PATH` envvar. A particularly simple
+template might look like:
+
+```erb
+{
+  "digital_object_id": "<%= data[:digital_object_id] %>",
+  "title": "<%= data[:title] %>"
+}
+```
+
+Practically speaking there isn't much benefit to this example, but in the case of
+a more complex record structure where you want to populate deeply nested elements
+using a flat file structure (like csv) this can be a very convenient way of
+assembling the payload. To process a template:
+
+```ruby
+data = { repo_code: 'ABC', name: 'ABC Archive', agent_contact_name: 'ABC Admin' }
+json = ArchivesSpace::Template.process(:repository_with_agent, data)
+response = client.post('/repositories/with_agent', json)
+puts response.result.success? ? '=)' : '=('
+```
+
 ## Development
 
 To run the examples start a local instance of ArchivesSpace then:
@@ -110,7 +139,7 @@ bundle exec rake
 Bump version in `lib/archivesspace/client/version.rb` then:
 
 ```bash
-VERSION=0.1.7
+VERSION=0.1.8
 gem build archivesspace-client
 git add . && git commit -m "Bump to $VERSION"
 git tag v$VERSION

data/examples/password_reset.rb

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

data/examples/repo_and_user.rb

@@ -17,7 +17,6 @@ config = ArchivesSpace::Configuration.new(
   }
 )
 
-# default client connection: localhost:8089, admin, admin
 client = ArchivesSpace::Client.new(config).login
 
 ap ArchivesSpace::Template.list # view available templates
@@ -25,7 +24,7 @@ ap ArchivesSpace::Template.list # view available templates
 repo_data = {
   repo_code: 'XYZ',
   name: 'XYZ Archive',
-  agent_contact_name: 'John Doe'
+  agent_contact_name: 'XYZ Admin'
 }
 
 user_data = {
@@ -35,11 +34,11 @@ user_data = {
 }
 user_password = '123456'
 
-repository = ArchivesSpace::Template.process_template(:repository_with_agent, repo_data)
+repository = ArchivesSpace::Template.process(:repository_with_agent, repo_data)
 
 begin
   response = client.post('/repositories/with_agent', repository)
-  if response.status_code.to_s =~ /^2/
+  if response.result.success?
     repository = client.repositories.find { |r| r['repo_code'] == 'XYZ' }
     ap repository
     ap client.delete(repository['uri'])
@@ -47,9 +46,9 @@ begin
     ap response.parsed
   end
 
-  user = ArchivesSpace::Template.process_template(:user, user_data)
+  user = ArchivesSpace::Template.process(:user, user_data)
   response = client.post('users', user, { password: user_password })
-  if response.status_code.to_s =~ /^2/
+  if response.result.success?
     user = client.users.find { |r| r['username'] == 'lmessi' }
     ap user
     ap client.delete user['uri']

data/examples/user_groups.rb

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

data/lib/archivesspace/client/client.rb

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

data/lib/archivesspace/client/helpers.rb

@@ -49,9 +49,9 @@ module ArchivesSpace
       get 'version'
     end
 
-    def batch_import(payload, params = {})
-      # create "batch_import", payload, params
-    end
+    # def batch_import(payload, params = {})
+    #   # TODO: create "batch_import", payload, params
+    # end
 
     def digital_objects(options = {})
       all('digital_objects', options)
@@ -61,30 +61,30 @@ module ArchivesSpace
       all('groups', options)
     end
 
-    def group_user_assignment(users_with_roles, params = { with_members: true })
+    def group_user_assignment(users_with_roles)
       updated = []
       groups.each do |group|
-        changed = false
+        group = get("groups/#{uri_to_id(group['uri'])}").parsed
+        update = false
 
         users_with_roles.each do |user, roles|
-          if roles.include? group['group_code']
-            unless group['member_usernames'].include? user
-              group['member_usernames'] << user
-              changed = true
-            end
-          else
-            if group['member_usernames'].include? user
+          # 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
-              changed = true
+              update = true
             end
+          # should the user be added to this group?
+          elsif roles.include? group['group_code']
+            group['member_usernames'] << user
+            update = true
           end
         end
 
-        next unless changed
+        next unless update
 
-        id = group['uri'].split('/')[-1]
-        response = post("/groups/#{id}", group, params)
-        updated << response.parsed
+        response = post("/groups/#{uri_to_id(group['uri'])}", group.to_json)
+        updated << response
       end
       updated
     end
@@ -105,7 +105,7 @@ module ArchivesSpace
       user = all('users').find { |u| u['username'] == username }
       raise RequestError, user.status unless user
 
-      post(user['uri'], user, { password: password })
+      post(user['uri'], user.to_json, { password: password })
     end
 
     def repositories(options = {})
@@ -118,8 +118,12 @@ module ArchivesSpace
       all('resources', options)
     end
 
-    def search(params)
-      # get "search", params
+    # def search(params)
+    #   # TODO: get "search", params
+    # end
+
+    def uri_to_id(uri)
+      uri.split('/').last
     end
 
     def users(options = {})

data/lib/archivesspace/client/response.rb

@@ -2,10 +2,9 @@
 
 module ArchivesSpace
   class Response
-    attr_reader :result, :parsed, :body, :headers, :status, :status_code, :xml
+    attr_reader :result, :parsed, :body, :headers, :status, :status_code
 
     def initialize(result)
-      # throw error
       @result      = result
       @parsed      = result.parsed_response
       @body        = result.body

data/lib/archivesspace/client/template.rb

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

data/lib/archivesspace/client/version.rb

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

data/spec/archivesspace/templates_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archivesspace-client
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Mark Cooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -155,6 +155,7 @@ files:
 - examples/password_reset.rb
 - examples/repo_and_user.rb
 - examples/test_connection.rb
+- examples/user_groups.rb
 - lib/archivesspace/client.rb
 - lib/archivesspace/client/client.rb
 - lib/archivesspace/client/configuration.rb
@@ -169,6 +170,7 @@ files:
 - lib/archivesspace/client/version.rb
 - spec/archivesspace/client_spec.rb
 - spec/archivesspace/configuration_spec.rb
+- spec/archivesspace/templates_spec.rb
 - spec/fixtures/cassettes/backend_version.yml
 - spec/spec_helper.rb
 homepage: ''
@@ -190,12 +192,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Interact with ArchivesSpace via the API.
 test_files:
 - spec/archivesspace/client_spec.rb
 - spec/archivesspace/configuration_spec.rb
+- spec/archivesspace/templates_spec.rb
 - spec/fixtures/cassettes/backend_version.yml
 - spec/spec_helper.rb