archivesspace-client 0.1.6 → 0.1.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +2 -0
- data/README.md +1 -1
- data/Rakefile +5 -3
- data/archivesspace-client.gemspec +20 -19
- data/examples/export.rb +20 -17
- data/examples/password_reset.rb +7 -5
- data/examples/repo_and_user.rb +27 -23
- data/examples/test_connection.rb +15 -11
- data/lib/archivesspace/client.rb +14 -14
- data/lib/archivesspace/client/client.rb +5 -7
- data/lib/archivesspace/client/configuration.rb +9 -10
- data/lib/archivesspace/client/helpers.rb +30 -27
- data/lib/archivesspace/client/request.rb +10 -13
- data/lib/archivesspace/client/response.rb +3 -4
- data/lib/archivesspace/client/template.rb +6 -8
- data/lib/archivesspace/client/version.rb +3 -1
- data/spec/archivesspace/client_spec.rb +8 -12
- data/spec/archivesspace/configuration_spec.rb +6 -6
- data/spec/spec_helper.rb +8 -6
- metadata +31 -31
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2087a90bf94b94f918d9b1453442e8e7a682ef75a76092fcd7dbe63d21816b83
|
4
|
+
data.tar.gz: 3f8e168c3e7a04e6dbb67e3bef8227f77d46ea3b9c009f08eddd24de3441f736
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f6977881509e613d26e24bbfa7b20204d20aac113a3d3297d798ba3b5c2f0cc673d217d77f9c161a906229a69a8710cdf9745e9c96b27262f8b0f2ac20583e51
|
7
|
+
data.tar.gz: 2480484be2b5ec0379b3c7c280e8473897a9930cb5a6abc2ec7b28decb81722478e70703a1d8bd38992866d6adaf94492e06480679126213bf500205e948a749
|
data/Gemfile
CHANGED
data/README.md
CHANGED
data/Rakefile
CHANGED
@@ -1,31 +1,32 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
lib = File.expand_path('lib', __dir__)
|
3
4
|
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
5
|
require 'archivesspace/client/version'
|
5
6
|
|
6
7
|
Gem::Specification.new do |spec|
|
7
|
-
spec.name =
|
8
|
+
spec.name = 'archivesspace-client'
|
8
9
|
spec.version = ArchivesSpace::Client::VERSION
|
9
|
-
spec.authors = [
|
10
|
-
spec.email = [
|
11
|
-
spec.summary =
|
12
|
-
spec.description =
|
13
|
-
spec.homepage =
|
14
|
-
spec.license =
|
10
|
+
spec.authors = ['Mark Cooper']
|
11
|
+
spec.email = ['mark.c.cooper@outlook.com']
|
12
|
+
spec.summary = 'Interact with ArchivesSpace via the API.'
|
13
|
+
spec.description = 'Interact with ArchivesSpace via the API.'
|
14
|
+
spec.homepage = ''
|
15
|
+
spec.license = 'MIT'
|
15
16
|
|
16
17
|
spec.files = `git ls-files -z`.split("\x0")
|
17
18
|
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
19
|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
-
spec.require_paths = [
|
20
|
+
spec.require_paths = ['lib']
|
20
21
|
|
21
|
-
spec.add_development_dependency
|
22
|
-
spec.add_development_dependency
|
23
|
-
spec.add_development_dependency
|
24
|
-
spec.add_development_dependency
|
25
|
-
spec.add_development_dependency
|
26
|
-
spec.add_development_dependency
|
22
|
+
spec.add_development_dependency 'awesome_print', '~> 1.8.0'
|
23
|
+
spec.add_development_dependency 'bundler'
|
24
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
25
|
+
spec.add_development_dependency 'rspec', '3.6.0'
|
26
|
+
spec.add_development_dependency 'vcr', '3.0.3'
|
27
|
+
spec.add_development_dependency 'webmock', '3.0.1'
|
27
28
|
|
28
|
-
spec.add_dependency
|
29
|
-
spec.add_dependency
|
30
|
-
spec.add_dependency
|
29
|
+
spec.add_dependency 'httparty', '~> 0.14'
|
30
|
+
spec.add_dependency 'json', '~> 2.0'
|
31
|
+
spec.add_dependency 'nokogiri', '~> 1.10'
|
31
32
|
end
|
data/examples/export.rb
CHANGED
@@ -1,33 +1,36 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
|
2
4
|
require 'awesome_print'
|
3
5
|
require 'archivesspace/client'
|
4
6
|
|
5
7
|
# official sandbox
|
6
|
-
config = ArchivesSpace::Configuration.new(
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
8
|
+
config = ArchivesSpace::Configuration.new(
|
9
|
+
{
|
10
|
+
base_uri: 'http://test.archivesspace.org/staff/api',
|
11
|
+
base_repo: '',
|
12
|
+
username: 'admin',
|
13
|
+
password: 'admin',
|
14
|
+
page_size: 50,
|
15
|
+
throttle: 0,
|
16
|
+
verify_ssl: false
|
17
|
+
}
|
18
|
+
)
|
15
19
|
|
16
20
|
client = ArchivesSpace::Client.new(config).login
|
17
21
|
client.config.throttle = 0.5
|
18
|
-
client.config.base_repo =
|
22
|
+
client.config.base_repo = 'repositories/2'
|
19
23
|
|
20
24
|
begin
|
21
|
-
# date -d '
|
22
|
-
client.resources
|
25
|
+
# date -d '2021-02-01 00:00:00' +'%s' # 1612166400
|
26
|
+
client.resources(query: { modified_since: '1612166400' }).each do |resource|
|
23
27
|
# for now we are just printing ...
|
24
28
|
# but you would actually write to a zip file or whatever
|
25
29
|
id = resource['uri'].split('/')[-1]
|
26
30
|
opts = { include_unpublished: false }
|
27
31
|
response = client.get("resource_descriptions/#{id}.xml", opts)
|
28
32
|
puts Nokogiri::XML(response.body).to_xml
|
29
|
-
break
|
30
33
|
end
|
31
|
-
rescue ArchivesSpace::RequestError =>
|
32
|
-
puts
|
33
|
-
end
|
34
|
+
rescue ArchivesSpace::RequestError => e
|
35
|
+
puts e.message
|
36
|
+
end
|
data/examples/password_reset.rb
CHANGED
@@ -1,15 +1,17 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
|
2
4
|
require 'awesome_print'
|
3
5
|
require 'archivesspace/client'
|
4
6
|
|
5
|
-
username =
|
6
|
-
password =
|
7
|
+
username = 'mrx'
|
8
|
+
password = '123456'
|
7
9
|
|
8
10
|
# default client connection: localhost:8089, admin, admin
|
9
11
|
client = ArchivesSpace::Client.new.login
|
10
12
|
begin
|
11
13
|
client.password_reset username, password
|
12
14
|
puts "Successfully updated password for #{username}."
|
13
|
-
rescue
|
14
|
-
puts "Failed to update password for #{username},\n#{
|
15
|
+
rescue StandardError => e
|
16
|
+
puts "Failed to update password for #{username},\n#{e.message}"
|
15
17
|
end
|
data/examples/repo_and_user.rb
CHANGED
@@ -1,17 +1,21 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
|
2
4
|
require 'awesome_print'
|
3
5
|
require 'archivesspace/client'
|
4
6
|
|
5
7
|
# official sandbox
|
6
|
-
config = ArchivesSpace::Configuration.new(
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
8
|
+
config = ArchivesSpace::Configuration.new(
|
9
|
+
{
|
10
|
+
base_uri: 'http://sandbox.archivesspace.org/api',
|
11
|
+
base_repo: '',
|
12
|
+
username: 'admin',
|
13
|
+
password: 'admin',
|
14
|
+
page_size: 50,
|
15
|
+
throttle: 0,
|
16
|
+
verify_ssl: false
|
17
|
+
}
|
18
|
+
)
|
15
19
|
|
16
20
|
# default client connection: localhost:8089, admin, admin
|
17
21
|
client = ArchivesSpace::Client.new(config).login
|
@@ -19,26 +23,26 @@ client = ArchivesSpace::Client.new(config).login
|
|
19
23
|
ap ArchivesSpace::Template.list # view available templates
|
20
24
|
|
21
25
|
repo_data = {
|
22
|
-
repo_code:
|
23
|
-
name:
|
24
|
-
agent_contact_name:
|
26
|
+
repo_code: 'XYZ',
|
27
|
+
name: 'XYZ Archive',
|
28
|
+
agent_contact_name: 'John Doe'
|
25
29
|
}
|
26
30
|
|
27
31
|
user_data = {
|
28
|
-
username:
|
29
|
-
name:
|
30
|
-
is_admin: true
|
32
|
+
username: 'lmessi',
|
33
|
+
name: 'Lionel Messi',
|
34
|
+
is_admin: true
|
31
35
|
}
|
32
|
-
user_password =
|
36
|
+
user_password = '123456'
|
33
37
|
|
34
38
|
repository = ArchivesSpace::Template.process_template(:repository_with_agent, repo_data)
|
35
39
|
|
36
40
|
begin
|
37
41
|
response = client.post('/repositories/with_agent', repository)
|
38
42
|
if response.status_code.to_s =~ /^2/
|
39
|
-
repository = client.repositories.find { |r| r[
|
43
|
+
repository = client.repositories.find { |r| r['repo_code'] == 'XYZ' }
|
40
44
|
ap repository
|
41
|
-
ap client.delete(repository[
|
45
|
+
ap client.delete(repository['uri'])
|
42
46
|
else
|
43
47
|
ap response.parsed
|
44
48
|
end
|
@@ -46,12 +50,12 @@ begin
|
|
46
50
|
user = ArchivesSpace::Template.process_template(:user, user_data)
|
47
51
|
response = client.post('users', user, { password: user_password })
|
48
52
|
if response.status_code.to_s =~ /^2/
|
49
|
-
user = client.users.find { |r| r[
|
53
|
+
user = client.users.find { |r| r['username'] == 'lmessi' }
|
50
54
|
ap user
|
51
|
-
ap client.delete user[
|
55
|
+
ap client.delete user['uri']
|
52
56
|
else
|
53
57
|
ap response.parsed
|
54
58
|
end
|
55
|
-
rescue ArchivesSpace::RequestError =>
|
56
|
-
puts
|
59
|
+
rescue ArchivesSpace::RequestError => e
|
60
|
+
puts e.message
|
57
61
|
end
|
data/examples/test_connection.rb
CHANGED
@@ -1,17 +1,21 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
|
2
4
|
require 'awesome_print'
|
3
5
|
require 'archivesspace/client'
|
4
6
|
|
5
7
|
# official sandbox
|
6
|
-
config = ArchivesSpace::Configuration.new(
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
8
|
+
config = ArchivesSpace::Configuration.new(
|
9
|
+
{
|
10
|
+
base_uri: 'http://sandbox.archivesspace.org/api',
|
11
|
+
base_repo: '',
|
12
|
+
username: 'admin',
|
13
|
+
password: 'admin',
|
14
|
+
page_size: 50,
|
15
|
+
throttle: 0,
|
16
|
+
verify_ssl: false
|
17
|
+
}
|
18
|
+
)
|
15
19
|
|
16
20
|
client = ArchivesSpace::Client.new(config).login
|
17
|
-
puts client.get(
|
21
|
+
puts client.get('version').body
|
data/lib/archivesspace/client.rb
CHANGED
@@ -1,22 +1,22 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'httparty'
|
2
4
|
require 'json'
|
3
5
|
require 'nokogiri'
|
4
6
|
|
5
7
|
# mixins required first
|
6
|
-
require
|
8
|
+
require 'archivesspace/client/helpers'
|
7
9
|
|
8
|
-
require
|
9
|
-
require
|
10
|
-
require
|
11
|
-
require
|
12
|
-
require
|
13
|
-
require
|
10
|
+
require 'archivesspace/client/client'
|
11
|
+
require 'archivesspace/client/configuration'
|
12
|
+
require 'archivesspace/client/request'
|
13
|
+
require 'archivesspace/client/response'
|
14
|
+
require 'archivesspace/client/template'
|
15
|
+
require 'archivesspace/client/version'
|
14
16
|
|
15
17
|
module ArchivesSpace
|
16
|
-
|
17
|
-
class
|
18
|
-
class
|
19
|
-
class
|
20
|
-
|
21
|
-
|
22
|
-
end
|
18
|
+
class ConnectionError < RuntimeError; end
|
19
|
+
class ContextError < RuntimeError; end
|
20
|
+
class ParamsError < RuntimeError; end
|
21
|
+
class RequestError < RuntimeError; end
|
22
|
+
end
|
@@ -1,14 +1,14 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
2
|
|
3
|
+
module ArchivesSpace
|
3
4
|
class Client
|
4
5
|
include Helpers
|
5
6
|
attr_accessor :token
|
6
7
|
attr_reader :config
|
7
8
|
|
8
9
|
def initialize(config = Configuration.new)
|
9
|
-
unless config.
|
10
|
-
|
11
|
-
end
|
10
|
+
raise 'Invalid configuration object' unless config.is_a? ArchivesSpace::Configuration
|
11
|
+
|
12
12
|
@config = config
|
13
13
|
@token = nil
|
14
14
|
end
|
@@ -33,11 +33,9 @@ module ArchivesSpace
|
|
33
33
|
|
34
34
|
def request(method, path, options = {})
|
35
35
|
sleep config.throttle
|
36
|
-
options[:headers] = {
|
36
|
+
options[:headers] = { 'X-ArchivesSpace-Session' => token } if token
|
37
37
|
result = Request.new(config, method, path, options).execute
|
38
38
|
Response.new result
|
39
39
|
end
|
40
|
-
|
41
40
|
end
|
42
|
-
|
43
41
|
end
|
@@ -1,16 +1,16 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
2
|
|
3
|
+
module ArchivesSpace
|
3
4
|
class Configuration
|
4
|
-
|
5
5
|
def defaults
|
6
6
|
{
|
7
|
-
base_uri:
|
8
|
-
base_repo:
|
9
|
-
username:
|
10
|
-
password:
|
7
|
+
base_uri: 'http://localhost:8089',
|
8
|
+
base_repo: '',
|
9
|
+
username: 'admin',
|
10
|
+
password: 'admin',
|
11
11
|
page_size: 50,
|
12
12
|
throttle: 0,
|
13
|
-
verify_ssl: true
|
13
|
+
verify_ssl: true
|
14
14
|
}
|
15
15
|
end
|
16
16
|
|
@@ -18,11 +18,10 @@ module ArchivesSpace
|
|
18
18
|
settings = defaults.merge(settings)
|
19
19
|
settings.each do |property, value|
|
20
20
|
next unless defaults.keys.include? property
|
21
|
+
|
21
22
|
instance_variable_set("@#{property}", value)
|
22
23
|
self.class.send(:attr_accessor, property)
|
23
24
|
end
|
24
25
|
end
|
25
|
-
|
26
26
|
end
|
27
|
-
|
28
|
-
end
|
27
|
+
end
|
@@ -1,15 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# needed for roundtrip hash merging
|
2
4
|
class ::Hash
|
3
5
|
def deep_merge(second)
|
4
|
-
merger = proc { |
|
5
|
-
|
6
|
+
merger = proc { |_key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
|
7
|
+
merge(second, &merger)
|
6
8
|
end
|
7
9
|
end
|
8
10
|
|
9
11
|
module ArchivesSpace
|
10
|
-
|
11
12
|
module Helpers
|
12
|
-
|
13
13
|
def accessions(options = {})
|
14
14
|
all('accessions', options)
|
15
15
|
end
|
@@ -19,7 +19,9 @@ module ArchivesSpace
|
|
19
19
|
page = 1
|
20
20
|
unlimited_listing = false
|
21
21
|
loop do
|
22
|
-
|
22
|
+
options[:query] ||= {}
|
23
|
+
options[:query][:page] = page
|
24
|
+
result = get(path, options)
|
23
25
|
results = []
|
24
26
|
|
25
27
|
if result.parsed.respond_to?(:key) && result.parsed.key?('results')
|
@@ -44,7 +46,7 @@ module ArchivesSpace
|
|
44
46
|
end
|
45
47
|
|
46
48
|
def backend_version
|
47
|
-
get
|
49
|
+
get 'version'
|
48
50
|
end
|
49
51
|
|
50
52
|
def batch_import(payload, params = {})
|
@@ -65,49 +67,52 @@ module ArchivesSpace
|
|
65
67
|
changed = false
|
66
68
|
|
67
69
|
users_with_roles.each do |user, roles|
|
68
|
-
if roles.include? group[
|
69
|
-
unless group[
|
70
|
-
group[
|
70
|
+
if roles.include? group['group_code']
|
71
|
+
unless group['member_usernames'].include? user
|
72
|
+
group['member_usernames'] << user
|
71
73
|
changed = true
|
72
74
|
end
|
73
75
|
else
|
74
|
-
if group[
|
75
|
-
group[
|
76
|
+
if group['member_usernames'].include? user
|
77
|
+
group['member_usernames'].delete user
|
76
78
|
changed = true
|
77
79
|
end
|
78
80
|
end
|
79
81
|
end
|
80
82
|
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
83
|
+
next unless changed
|
84
|
+
|
85
|
+
id = group['uri'].split('/')[-1]
|
86
|
+
response = post("/groups/#{id}", group, params)
|
87
|
+
updated << response.parsed
|
86
88
|
end
|
87
89
|
updated
|
88
90
|
end
|
89
91
|
|
90
92
|
def login
|
91
|
-
username
|
93
|
+
username = config.username
|
94
|
+
password = config.password
|
92
95
|
result = request('POST', "/users/#{username}/login", { query: { password: password } })
|
93
|
-
|
94
|
-
|
96
|
+
unless result.parsed['session']
|
97
|
+
raise ConnectionError, "Failed to connect to ArchivesSpace backend as #{username} #{password}"
|
98
|
+
end
|
99
|
+
|
100
|
+
@token = result.parsed['session']
|
95
101
|
self
|
96
102
|
end
|
97
103
|
|
98
104
|
def password_reset(username, password)
|
99
|
-
user = all('users').find { |u| u[
|
100
|
-
raise RequestError
|
101
|
-
|
105
|
+
user = all('users').find { |u| u['username'] == username }
|
106
|
+
raise RequestError, user.status unless user
|
107
|
+
|
108
|
+
post(user['uri'], user, { password: password })
|
102
109
|
end
|
103
110
|
|
104
111
|
def repositories(options = {})
|
105
112
|
all('repositories', options)
|
106
113
|
end
|
107
114
|
|
108
|
-
def repositories_with_agent
|
109
|
-
#
|
110
|
-
end
|
115
|
+
def repositories_with_agent; end
|
111
116
|
|
112
117
|
def resources(options = {})
|
113
118
|
all('resources', options)
|
@@ -120,7 +125,5 @@ module ArchivesSpace
|
|
120
125
|
def users(options = {})
|
121
126
|
all('users', options)
|
122
127
|
end
|
123
|
-
|
124
128
|
end
|
125
|
-
|
126
129
|
end
|
@@ -1,5 +1,6 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
2
|
|
3
|
+
module ArchivesSpace
|
3
4
|
class Request
|
4
5
|
include HTTParty
|
5
6
|
attr_reader :config, :headers, :method, :path, :options
|
@@ -9,29 +10,27 @@ module ArchivesSpace
|
|
9
10
|
delete: {},
|
10
11
|
get: {},
|
11
12
|
post: {
|
12
|
-
|
13
|
-
|
13
|
+
'Content-Type' => 'application/json',
|
14
|
+
'Content-Length' => 'nnnn'
|
14
15
|
},
|
15
16
|
put: {
|
16
|
-
|
17
|
-
|
17
|
+
'Content-Type' => 'application/json',
|
18
|
+
'Content-Length' => 'nnnn'
|
18
19
|
}
|
19
20
|
}
|
20
21
|
headers[method]
|
21
22
|
end
|
22
23
|
|
23
|
-
def initialize(config, method =
|
24
|
+
def initialize(config, method = 'GET', path = '', options = {})
|
24
25
|
@config = config
|
25
26
|
@method = method.downcase.to_sym
|
26
|
-
@path = path.gsub(
|
27
|
+
@path = path.gsub(%r{^/+}, '')
|
27
28
|
@options = options
|
28
29
|
@options[:headers] = options[:headers] ? default_headers(@method).merge(options[:headers]) : default_headers(@method)
|
29
30
|
@options[:verify] = config.verify_ssl
|
30
|
-
@options[:query] = {} unless options.
|
31
|
+
@options[:query] = {} unless options.key? :query
|
31
32
|
|
32
|
-
base_uri = (
|
33
|
-
config.base_repo.nil? or config.base_repo.empty?
|
34
|
-
) ? config.base_uri : "#{config.base_uri}/#{config.base_repo}"
|
33
|
+
base_uri = config.base_repo&.length&.positive? ? File.join(config.base_uri, config.base_repo) : config.base_uri
|
35
34
|
|
36
35
|
self.class.base_uri base_uri
|
37
36
|
end
|
@@ -39,7 +38,5 @@ module ArchivesSpace
|
|
39
38
|
def execute
|
40
39
|
self.class.send method, "/#{path}", options
|
41
40
|
end
|
42
|
-
|
43
41
|
end
|
44
|
-
|
45
42
|
end
|
@@ -1,5 +1,6 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
2
|
|
3
|
+
module ArchivesSpace
|
3
4
|
class Response
|
4
5
|
attr_reader :result, :parsed, :body, :headers, :status, :status_code, :xml
|
5
6
|
|
@@ -12,7 +13,5 @@ module ArchivesSpace
|
|
12
13
|
@status = result.response
|
13
14
|
@status_code = result.code.to_i
|
14
15
|
end
|
15
|
-
|
16
16
|
end
|
17
|
-
|
18
|
-
end
|
17
|
+
end
|
@@ -1,25 +1,23 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
2
|
|
3
|
+
module ArchivesSpace
|
3
4
|
module Template
|
4
|
-
|
5
5
|
def self.list
|
6
6
|
[]
|
7
7
|
end
|
8
8
|
|
9
9
|
def self.process_template(template, data)
|
10
|
-
t = ERB.new(
|
11
|
-
r = t.result(binding).gsub(/\n+/,"\n")
|
10
|
+
t = ERB.new(read_template(template))
|
11
|
+
r = t.result(binding).gsub(/\n+/, "\n")
|
12
12
|
JSON.parse(r)
|
13
13
|
end
|
14
14
|
|
15
15
|
def self.read_template(file)
|
16
|
-
File.read("#{
|
16
|
+
File.read("#{templates_path}/#{file}.json.erb")
|
17
17
|
end
|
18
18
|
|
19
19
|
def self.templates_path
|
20
20
|
File.join(File.dirname(File.expand_path(__FILE__)), 'templates')
|
21
21
|
end
|
22
|
-
|
23
22
|
end
|
24
|
-
|
25
|
-
end
|
23
|
+
end
|
@@ -1,43 +1,39 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'spec_helper'
|
2
4
|
|
3
5
|
describe ArchivesSpace::Client do
|
4
|
-
|
5
6
|
let(:client) { ArchivesSpace::Client.new }
|
6
7
|
let(:login) { -> { client.login } }
|
7
8
|
|
8
|
-
describe
|
9
|
-
|
9
|
+
describe 'Configuration' do
|
10
10
|
it 'will use the default configuration if none is provided' do
|
11
11
|
client = ArchivesSpace::Client.new
|
12
12
|
expect(client.config.base_uri).to eq DEFAULT_BASE_URI
|
13
13
|
end
|
14
14
|
|
15
15
|
it 'will raise an error if supplied configuration is of invalid type' do
|
16
|
-
expect{ ArchivesSpace::Client.new({ base_uri: CUSTOM_BASE_URI }) }.to raise_error(RuntimeError)
|
16
|
+
expect { ArchivesSpace::Client.new({ base_uri: CUSTOM_BASE_URI }) }.to raise_error(RuntimeError)
|
17
17
|
end
|
18
18
|
|
19
19
|
it 'will allow a configuration object to be provided' do
|
20
20
|
client = ArchivesSpace::Client.new(ArchivesSpace::Configuration.new({ base_uri: CUSTOM_BASE_URI }))
|
21
21
|
expect(client.config.base_uri).to eq CUSTOM_BASE_URI
|
22
22
|
end
|
23
|
-
|
24
23
|
end
|
25
24
|
|
26
|
-
describe
|
27
|
-
|
25
|
+
describe 'Version information' do
|
28
26
|
it 'has a version number' do
|
29
27
|
expect(ArchivesSpace::Client::VERSION).not_to be nil
|
30
28
|
end
|
31
29
|
|
32
|
-
it
|
30
|
+
it 'can retrieve the backend version info' do
|
33
31
|
VCR.use_cassette('backend_version') do
|
34
32
|
login.call
|
35
|
-
response = client.get
|
33
|
+
response = client.get 'version'
|
36
34
|
expect(response.status_code).to eq(200)
|
37
35
|
expect(response.body).to match(/ArchivesSpace \(.*\)/)
|
38
36
|
end
|
39
37
|
end
|
40
|
-
|
41
38
|
end
|
42
|
-
|
43
|
-
end
|
39
|
+
end
|
@@ -1,7 +1,8 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'spec_helper'
|
2
4
|
|
3
5
|
describe ArchivesSpace::Configuration do
|
4
|
-
|
5
6
|
it 'uses the default profile for configuration settings' do
|
6
7
|
config = ArchivesSpace::Configuration.new
|
7
8
|
expect(config.base_uri).to eq DEFAULT_BASE_URI
|
@@ -9,8 +10,8 @@ describe ArchivesSpace::Configuration do
|
|
9
10
|
|
10
11
|
it 'allows configuration settings to be provided' do
|
11
12
|
config = ArchivesSpace::Configuration.new({
|
12
|
-
|
13
|
-
|
13
|
+
base_uri: CUSTOM_BASE_URI
|
14
|
+
})
|
14
15
|
expect(config.base_uri).to eq CUSTOM_BASE_URI
|
15
16
|
end
|
16
17
|
|
@@ -22,7 +23,6 @@ describe ArchivesSpace::Configuration do
|
|
22
23
|
|
23
24
|
it 'ignores unrecognized configuration properties' do
|
24
25
|
config = ArchivesSpace::Configuration.new({ xyz: 123 })
|
25
|
-
expect{ config.xyz }.to raise_error(NoMethodError)
|
26
|
+
expect { config.xyz }.to raise_error(NoMethodError)
|
26
27
|
end
|
27
|
-
|
28
|
-
end
|
28
|
+
end
|
data/spec/spec_helper.rb
CHANGED
@@ -1,14 +1,16 @@
|
|
1
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
|
2
4
|
require 'archivesspace/client'
|
3
5
|
require 'vcr'
|
4
6
|
require 'webmock/rspec'
|
5
7
|
|
6
8
|
# GLOBAL VALUES FOR SPECS
|
7
|
-
DEFAULT_BASE_URI =
|
8
|
-
CUSTOM_BASE_URI =
|
9
|
+
DEFAULT_BASE_URI = 'http://localhost:8089'
|
10
|
+
CUSTOM_BASE_URI = 'https://archives.university.edu/api'
|
9
11
|
|
10
12
|
VCR.configure do |c|
|
11
|
-
c.cassette_library_dir =
|
13
|
+
c.cassette_library_dir = 'spec/fixtures/cassettes'
|
12
14
|
c.hook_into :webmock
|
13
|
-
c.default_cassette_options = { :
|
14
|
-
end
|
15
|
+
c.default_cassette_options = { record: :once }
|
16
|
+
end
|
metadata
CHANGED
@@ -1,15 +1,29 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: archivesspace-client
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.7
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Mark Cooper
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-04-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: awesome_print
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 1.8.0
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 1.8.0
|
13
27
|
- !ruby/object:Gem::Dependency
|
14
28
|
name: bundler
|
15
29
|
requirement: !ruby/object:Gem::Requirement
|
@@ -80,63 +94,49 @@ dependencies:
|
|
80
94
|
- - '='
|
81
95
|
- !ruby/object:Gem::Version
|
82
96
|
version: 3.0.1
|
83
|
-
- !ruby/object:Gem::Dependency
|
84
|
-
name: awesome_print
|
85
|
-
requirement: !ruby/object:Gem::Requirement
|
86
|
-
requirements:
|
87
|
-
- - "~>"
|
88
|
-
- !ruby/object:Gem::Version
|
89
|
-
version: 1.8.0
|
90
|
-
type: :development
|
91
|
-
prerelease: false
|
92
|
-
version_requirements: !ruby/object:Gem::Requirement
|
93
|
-
requirements:
|
94
|
-
- - "~>"
|
95
|
-
- !ruby/object:Gem::Version
|
96
|
-
version: 1.8.0
|
97
97
|
- !ruby/object:Gem::Dependency
|
98
98
|
name: httparty
|
99
99
|
requirement: !ruby/object:Gem::Requirement
|
100
100
|
requirements:
|
101
|
-
- -
|
101
|
+
- - "~>"
|
102
102
|
- !ruby/object:Gem::Version
|
103
|
-
version: 0.14
|
103
|
+
version: '0.14'
|
104
104
|
type: :runtime
|
105
105
|
prerelease: false
|
106
106
|
version_requirements: !ruby/object:Gem::Requirement
|
107
107
|
requirements:
|
108
|
-
- -
|
108
|
+
- - "~>"
|
109
109
|
- !ruby/object:Gem::Version
|
110
|
-
version: 0.14
|
110
|
+
version: '0.14'
|
111
111
|
- !ruby/object:Gem::Dependency
|
112
112
|
name: json
|
113
113
|
requirement: !ruby/object:Gem::Requirement
|
114
114
|
requirements:
|
115
|
-
- -
|
115
|
+
- - "~>"
|
116
116
|
- !ruby/object:Gem::Version
|
117
|
-
version: 2.0
|
117
|
+
version: '2.0'
|
118
118
|
type: :runtime
|
119
119
|
prerelease: false
|
120
120
|
version_requirements: !ruby/object:Gem::Requirement
|
121
121
|
requirements:
|
122
|
-
- -
|
122
|
+
- - "~>"
|
123
123
|
- !ruby/object:Gem::Version
|
124
|
-
version: 2.0
|
124
|
+
version: '2.0'
|
125
125
|
- !ruby/object:Gem::Dependency
|
126
126
|
name: nokogiri
|
127
127
|
requirement: !ruby/object:Gem::Requirement
|
128
128
|
requirements:
|
129
|
-
- -
|
129
|
+
- - "~>"
|
130
130
|
- !ruby/object:Gem::Version
|
131
|
-
version: 1.10
|
131
|
+
version: '1.10'
|
132
132
|
type: :runtime
|
133
133
|
prerelease: false
|
134
134
|
version_requirements: !ruby/object:Gem::Requirement
|
135
135
|
requirements:
|
136
|
-
- -
|
136
|
+
- - "~>"
|
137
137
|
- !ruby/object:Gem::Version
|
138
|
-
version: 1.10
|
139
|
-
description: Interact with ArchivesSpace via
|
138
|
+
version: '1.10'
|
139
|
+
description: Interact with ArchivesSpace via the API.
|
140
140
|
email:
|
141
141
|
- mark.c.cooper@outlook.com
|
142
142
|
executables: []
|
@@ -190,10 +190,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
190
190
|
- !ruby/object:Gem::Version
|
191
191
|
version: '0'
|
192
192
|
requirements: []
|
193
|
-
rubygems_version: 3.
|
193
|
+
rubygems_version: 3.1.4
|
194
194
|
signing_key:
|
195
195
|
specification_version: 4
|
196
|
-
summary: Interact with ArchivesSpace via
|
196
|
+
summary: Interact with ArchivesSpace via the API.
|
197
197
|
test_files:
|
198
198
|
- spec/archivesspace/client_spec.rb
|
199
199
|
- spec/archivesspace/configuration_spec.rb
|