archivesspace-client 0.1.3 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +25 -17
- data/lib/archivesspace/client/request.rb +1 -1
- data/lib/archivesspace/client/version.rb +1 -1
- data/spec/fixtures/cassettes/backend_version.yml +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9b4ca0ba3d8d057c3e6173cfec463660ab5edca6
|
|
4
|
+
data.tar.gz: 78fb789484fb50bf3892e1a2e9d0d3eb56a8bc88
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: cc2d5f97f7f2d444b1779db3bbd41052862f066051dd408b358f6d38fe85a0daa13c39d110d9a534f98c5e2bb8b47688316e2acefa05ee205a8956af7ad1bdb5
|
|
7
|
+
data.tar.gz: 71d430fba940727214d3a46fd5d249d7e580a9463418087e66c69ad27c0b5685cb7e2d12465f0f2c002977d4a5e05a999f88f91f1f11eaf288ef802e11ea8c2a
|
data/README.md
CHANGED
|
@@ -1,10 +1,8 @@
|
|
|
1
|
-
Archivesspace Client
|
|
2
|
-
===
|
|
1
|
+
# Archivesspace Client
|
|
3
2
|
|
|
4
|
-
Interact with ArchivesSpace via
|
|
3
|
+
Interact with ArchivesSpace via the API.
|
|
5
4
|
|
|
6
|
-
Installation
|
|
7
|
-
---
|
|
5
|
+
## Installation
|
|
8
6
|
|
|
9
7
|
Add this line to your application's Gemfile:
|
|
10
8
|
|
|
@@ -20,10 +18,11 @@ bundle install
|
|
|
20
18
|
|
|
21
19
|
Or install it yourself as:
|
|
22
20
|
|
|
23
|
-
|
|
21
|
+
```bash
|
|
22
|
+
gem install archivesspace-client
|
|
23
|
+
```
|
|
24
24
|
|
|
25
|
-
Usage
|
|
26
|
-
---
|
|
25
|
+
## Usage
|
|
27
26
|
|
|
28
27
|
See the examples directory for a range of use cases.
|
|
29
28
|
|
|
@@ -37,8 +36,6 @@ client = ArchivesSpace::Client.new.login
|
|
|
37
36
|
|
|
38
37
|
**Custom configuration**
|
|
39
38
|
|
|
40
|
-
To supply custom configuration to client:
|
|
41
|
-
|
|
42
39
|
```ruby
|
|
43
40
|
config = ArchivesSpace::Configuration.new({
|
|
44
41
|
base_uri: "https://archives.university.edu/api",
|
|
@@ -90,8 +87,7 @@ client.get('digital_objects') # instead of "repositories/2/digital_objects" etc.
|
|
|
90
87
|
client.config.base_repo = ""
|
|
91
88
|
```
|
|
92
89
|
|
|
93
|
-
Development
|
|
94
|
-
---
|
|
90
|
+
## Development
|
|
95
91
|
|
|
96
92
|
To run the examples start a local instance of ArchivesSpace then:
|
|
97
93
|
|
|
@@ -99,7 +95,9 @@ To run the examples start a local instance of ArchivesSpace then:
|
|
|
99
95
|
bundle exec ruby examples/repo_and_user.rb
|
|
100
96
|
```
|
|
101
97
|
|
|
102
|
-
Any script placed in the examples directory with a `my_` prefix are ignored by
|
|
98
|
+
Any script placed in the examples directory with a `my_` prefix are ignored by
|
|
99
|
+
git. Follow the convention used by the existing scripts to bootstrap and
|
|
100
|
+
experiment away.
|
|
103
101
|
|
|
104
102
|
To run the tests:
|
|
105
103
|
|
|
@@ -107,13 +105,23 @@ To run the tests:
|
|
|
107
105
|
bundle exec rake
|
|
108
106
|
```
|
|
109
107
|
|
|
110
|
-
|
|
111
|
-
|
|
108
|
+
## Publishing
|
|
109
|
+
|
|
110
|
+
Bump version in `lib/archivesspace/client/version.rb` then:
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
VERSION=0.1.4
|
|
114
|
+
gem build archivesspace-client
|
|
115
|
+
gem push archivesspace-client-$VERSION.gem
|
|
116
|
+
git tag v$VERSION
|
|
117
|
+
git push --tags
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## Contributing
|
|
112
121
|
|
|
113
122
|
Bug reports and pull requests are welcome on GitHub at https://github.com/lyrasis/archivesspace-client.
|
|
114
123
|
|
|
115
|
-
License
|
|
116
|
-
---
|
|
124
|
+
## License
|
|
117
125
|
|
|
118
126
|
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
|
119
127
|
|
|
@@ -23,7 +23,7 @@ module ArchivesSpace
|
|
|
23
23
|
def initialize(config, method = "GET", path = "", options = {})
|
|
24
24
|
@config = config
|
|
25
25
|
@method = method.downcase.to_sym
|
|
26
|
-
@path = path
|
|
26
|
+
@path = path.gsub(/^\/+/, '')
|
|
27
27
|
|
|
28
28
|
@options = options
|
|
29
29
|
@options[:headers] = options[:headers] ? default_headers(@method).merge(options[:headers]) : default_headers(@method)
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
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.4
|
|
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: 2018-08-08 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: bundler
|
|
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
191
191
|
version: '0'
|
|
192
192
|
requirements: []
|
|
193
193
|
rubyforge_project:
|
|
194
|
-
rubygems_version: 2.6.
|
|
194
|
+
rubygems_version: 2.6.13
|
|
195
195
|
signing_key:
|
|
196
196
|
specification_version: 4
|
|
197
197
|
summary: Interact with ArchivesSpace via its RESTful API.
|