archivesspace-client 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ac87676e73f32df56e132fdf948cc70f9bcaaed5
-  data.tar.gz: 732ac0b2af6e77d00497f07d3dbd110b451bbaf6
+SHA256:
+  metadata.gz: 2c49aac54a1b49b27bbff319aa83e0a6f7dd711a1e644324ae9d96155b06d417
+  data.tar.gz: bf2fa7e423165f8e03282c718fe819fa7c5836e9090ceacbcf58e642e6ea1938
 SHA512:
-  metadata.gz: 281c55f2fc3d494817b52e95fffc64b1bbe8d50d34ecb5956608f9a781d3c1b46e7d441ccae1ae2a9988beab6ff72fb313f0cdc95c1f4034eca5794831a1f4fb
-  data.tar.gz: 35f0ead243047aa1afb8c7fcdfd8b734872ecc7f38a3ab32a14ed08fb4f8ab6c2fc165399c2b3170268b11296d5065ef2763e9478fc0ea45089068448e667645
+  metadata.gz: 7ba30d239390c5066bc5a673e532fb75a3d1fc4f994a8d2726494363f919e3656a5f0d1e7cb730797cbfcf24d404c0447ea1a2243aef6fe4bb9ac1af61117dc4
+  data.tar.gz: 385795fdc7c63144d96696be8a39a3e6f6e4f6c95fa5040be5e9be8d7db7c6a03b4db066bc3900299bb4e05e8d3446a8fa69b9628452beb0b65b477302702ee6

data/.gitignore

@@ -1,3 +1,4 @@
+*.csv
 *.gem
 *.rbc
 *.lock
@@ -19,4 +20,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-/archivesspace/
+/archivesspace/

data/README.md

@@ -1,10 +1,8 @@
-Archivesspace Client
-===
+# Archivesspace Client
 
-Interact with ArchivesSpace via its API.
+Interact with ArchivesSpace via the API.
 
-Installation
----
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -20,10 +18,11 @@ bundle install
 
 Or install it yourself as:
 
-    $ gem install archivesspace-client
+```bash
+gem install archivesspace-client
+```
 
-Usage
----
+## Usage
 
 See the examples directory for a range of use cases.
 
@@ -37,8 +36,6 @@ client = ArchivesSpace::Client.new.login
 
 **Custom configuration**
 
-To supply custom configuration to client:
-
 ```ruby
 config = ArchivesSpace::Configuration.new({
   base_uri: "https://archives.university.edu/api",
@@ -90,8 +87,7 @@ client.get('digital_objects') # instead of "repositories/2/digital_objects" etc.
 client.config.base_repo = ""
 ```
 
-Development
----
+## Development
 
 To run the examples start a local instance of ArchivesSpace then:
 
@@ -99,7 +95,9 @@ To run the examples start a local instance of ArchivesSpace then:
 bundle exec ruby examples/repo_and_user.rb
 ```
 
-Any script placed in the examples directory with a `my_` prefix are ignored by git. Follow the convention used by the existing scripts to bootstrap and experiment away.
+Any script placed in the examples directory with a `my_` prefix are ignored by
+git. Follow the convention used by the existing scripts to bootstrap and
+experiment away.
 
 To run the tests:
 
@@ -107,13 +105,25 @@ To run the tests:
 bundle exec rake
 ```
 
-Contributing
----
+## Publishing
+
+Bump version in `lib/archivesspace/client/version.rb` then:
+
+```bash
+VERSION=0.1.6
+gem build archivesspace-client
+git add . && git commit -m "Bump to $VERSION"
+git tag v$VERSION
+git push origin master
+git push --tags
+gem push archivesspace-client-$VERSION.gem
+```
+
+## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/lyrasis/archivesspace-client.
 
-License
----
+## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 

data/archivesspace-client.gemspec

@@ -18,14 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "awesome_print"
+  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_development_dependency "awesome_print", "~> 1.8.0"
 
-  spec.add_dependency "httparty"
-  spec.add_dependency "json"
-  spec.add_dependency "nokogiri"
+  spec.add_dependency "httparty", "0.14.0"
+  spec.add_dependency "json", "2.0.3"
+  spec.add_dependency "nokogiri", "1.10.10"
 end

data/examples/export.rb

@@ -2,14 +2,32 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'awesome_print'
 require 'archivesspace/client'
 
-# default client connection: localhost:8089, admin, admin
-client = ArchivesSpace::Client.new.login
-client.config.throttle 0.5
+# 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
+client.config.throttle = 0.5
 client.config.base_repo = "repositories/2"
-# date -d '2015-07-01 00:00:00' +'%s' # 1435734000
-client.resources("ead", { query: { modified_since: "1435734000" } }) do |ead|
-  # for now we are just printing ...
-  # but you would actually write to a zip file or whatever
-  ap ead
+
+begin
+  # date -d '2015-07-01 00:00:00' +'%s' # 1435734000
+  client.resources.each(query: { modified_since: "1435734000"}) do |resource|
+    # for now we are just printing ...
+    # but you would actually write to a zip file or whatever
+    id   = resource['uri'].split('/')[-1]
+    opts = { include_unpublished: false }
+    response = client.get("resource_descriptions/#{id}.xml", opts)
+    puts Nokogiri::XML(response.body).to_xml
+    break
+  end
+rescue ArchivesSpace::RequestError => ex
+  puts ex.message
 end

data/examples/password_reset.rb

@@ -10,6 +10,6 @@ client = ArchivesSpace::Client.new.login
 begin
   client.password_reset username, password
   puts "Successfully updated password for #{username}."
-rescue Exception => e
-  puts "Failed to update password for #{username},\n#{e.message}"
+rescue Exception => ex
+  puts "Failed to update password for #{username},\n#{ex.message}"
 end

data/examples/repo_and_user.rb

@@ -2,8 +2,19 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 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,
+})
+
 # default client connection: localhost:8089, admin, admin
-client = ArchivesSpace::Client.new.login
+client = ArchivesSpace::Client.new(config).login
 
 ap ArchivesSpace::Template.list # view available templates
 
@@ -13,28 +24,34 @@ repo_data = {
   agent_contact_name: "John Doe",
 }
 
-repository = ArchivesSpace::Template.process_template(:repository_with_agent, repo_data)
-response = client.post('/repositories/with_agent', repository)
-if response.status_code == 201
-  repository = client.repositories.find { |r| r["repo_code"] == "XYZ" }
-  ap repository
-  ap client.delete(repository["uri"])
-else
-  ap response.parsed
-end
-
 user_data = {
   username: "lmessi",
   name: "Lionel Messi",
   is_admin: true,
 }
+user_password = "123456"
 
-user = ArchivesSpace::Template.process_template(:user, user_data)
-response = client.post('users', user, { password: "123456" })
-if response.status_code == 201
-  user = client.users.find { |r| r["username"] == "lmessi" }
-  ap user
-  ap client.delete user["uri"]
-else
-  ap response.parsed
-end
+repository = ArchivesSpace::Template.process_template(:repository_with_agent, repo_data)
+
+begin
+  response = client.post('/repositories/with_agent', repository)
+  if response.status_code.to_s =~ /^2/
+    repository = client.repositories.find { |r| r["repo_code"] == "XYZ" }
+    ap repository
+    ap client.delete(repository["uri"])
+  else
+    ap response.parsed
+  end
+
+  user = ArchivesSpace::Template.process_template(:user, user_data)
+  response = client.post('users', user, { password: user_password })
+  if response.status_code.to_s =~ /^2/
+    user = client.users.find { |r| r["username"] == "lmessi" }
+    ap user
+    ap client.delete user["uri"]
+  else
+    ap response.parsed
+  end
+rescue ArchivesSpace::RequestError => ex
+  puts ex.message
+end

data/examples/test_connection.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+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
+puts client.get("version").body

data/lib/archivesspace/client/client.rb

@@ -6,7 +6,9 @@ module ArchivesSpace
     attr_reader   :config
 
     def initialize(config = Configuration.new)
-      raise "Invalid configuration object" unless config.kind_of? ArchivesSpace::Configuration
+      unless config.kind_of? ArchivesSpace::Configuration
+        raise "Invalid configuration object"
+      end
       @config = config
       @token  = nil
     end

data/lib/archivesspace/client/helpers.rb

@@ -10,32 +10,37 @@ module ArchivesSpace
 
   module Helpers
 
-    def accessions(options = {}, &block)
-      records = all('accessions', options) do |record|
-        yield record if block_given?
-      end
-      records
+    def accessions(options = {})
+      all('accessions', options)
     end
 
-    def all(path, options = {}, &block)
-      all      = []
-      format   = options.delete(:format)
-      parse_id = options.delete(:parse_id)
-      # options[:headers] -- add xml headers if format
-
-      result = get(path, options.merge({ query: { all_ids: true } } ))
-      raise RequestError.new result.status if result.status_code != 200
-      ids    = result.parsed
-      ids    = ids.map{ |object| object["uri"].split("/")[-1] } if parse_id
-      ids.each do |id|
-        path_with_id = format ? "#{format}/#{id}.xml" : "#{path}/#{id}"
-        result = get(path_with_id, options)
-        raise RequestError.new result.status if result.status_code != 200
-        record = format ? Nokogiri::XML(result.body).to_xml : result.parsed
-        yield record if block_given?
-        all << record
-      end
-      all
+    def all(path, options = {})
+      Enumerator.new do |yielder|
+        page = 1
+        unlimited_listing = false
+        loop do
+          result = get(path, options.merge(query: { page: page }))
+          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
@@ -46,31 +51,17 @@ module ArchivesSpace
       # create "batch_import", payload, params
     end
 
-    def digital_object_to_xml(digital_object, format = "dublin_core")
-      id   = digital_object["uri"].split("/")[-1]
-      path = "digital_objects/#{format}/#{id}.xml"
-      get_xml path
-    end
-
-    def digital_objects(format = nil, options = {}, &block)
-      path    = "digital_objects"
-      format  = format ? "#{path}/#{format}" : nil
-      records = all(path, options.merge({ format: format })) do |record|
-        yield record if block_given?
-      end
-      records
+    def digital_objects(options = {})
+      all('digital_objects', options)
     end
 
-    def groups
-      records = all('groups', { parse_id: true }) do |record|
-        yield record if block_given?
-      end
-      records
+    def groups(options = {})
+      all('groups', options)
     end
 
     def group_user_assignment(users_with_roles, params = { with_members: true })
       updated = []
-      groups do |group|
+      groups.each do |group|
         changed = false
 
         users_with_roles.each do |user, roles|
@@ -106,63 +97,30 @@ module ArchivesSpace
 
     def password_reset(username, password)
       user = all('users').find { |u| u["username"] == username }
-      raise RequestError.new user.status unless user
+      raise RequestError.new(user.status) unless user
       post(user["uri"], user, { password: password })
     end
 
-    def repositories
-      records = get('repositories').parsed.each do |record|
-        yield record if block_given?
-      end
-      records
+    def repositories(options = {})
+      all('repositories', options)
     end
 
     def repositories_with_agent
       #
     end
 
-    def resource_to_xml(resource, format = "ead")
-      id   = resource["uri"].split("/")[-1]
-      path = format == "ead" ? "resource_descriptions/#{id}.xml" : "resources/#{format}/#{id}.xml"
-      get_xml path
-    end
-
-    def resources(format = nil, options = {}, &block)
-      path = 'resources'
-      # the api is inconsistent with the path structure for resource ead (and pdf)
-      if format
-        if format =~ /(ead|pdf)/
-          format = "resource_descriptions"
-        else
-          format = "#{path}/#{format}"
-        end
-      end
-      records = all(path, options.merge({ format: format })) do |record|
-        yield record if block_given?
-      end
-      records
+    def resources(options = {})
+      all('resources', options)
     end
 
     def search(params)
       # get "search", params
     end
 
-    def users
-      records = all('users') do |record|
-        yield record if block_given?
-      end
-      records
-    end
-
-    private
-
-    def get_xml(path)
-      # add xml headers
-      response = get(path)
-      raise RequestError.new path unless response.status_code == 200
-      Nokogiri::XML(response.body).to_xml
+    def users(options = {})
+      all('users', options)
     end
 
   end
 
-end
+end

data/lib/archivesspace/client/request.rb

@@ -21,18 +21,19 @@ module ArchivesSpace
     end
 
     def initialize(config, method = "GET", path = "", options = {})
-      @config  = config
-      @method  = method.downcase.to_sym
-      @path    = path
+      @config            = config
+      @method            = method.downcase.to_sym
+      @path              = path.gsub(/^\/+/, '')
+      @options           = options
+      @options[:headers] = options[:headers] ? default_headers(@method).merge(options[:headers]) : default_headers(@method)
+      @options[:verify]  = config.verify_ssl
+      @options[:query]   = {} unless options.has_key? :query
+
+      base_uri = (
+        config.base_repo.nil? or config.base_repo.empty?
+      ) ? config.base_uri : "#{config.base_uri}/#{config.base_repo}"
 
-      @options = options
-      @options[:headers]    = options[:headers] ? default_headers(@method).merge(options[:headers]) : default_headers
-      @options[:verify]     = config.verify_ssl
-      @options[:query]      = {} unless options.has_key? :query
-
-      base_uri = (config.base_repo.nil? or config.base_repo.empty?) ? config.base_uri : "#{config.base_uri}/#{config.base_repo}"
       self.class.base_uri base_uri
-      # self.class.default_params abc: 123
     end
 
     def execute
@@ -41,4 +42,4 @@ module ArchivesSpace
 
   end
 
-end
+end

data/lib/archivesspace/client/version.rb

@@ -1,5 +1,5 @@
 module ArchivesSpace
   class Client
-    VERSION = "0.1.1"
+    VERSION = "0.1.6"
   end
 end

data/spec/fixtures/cassettes/backend_version.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: http://localhost:8089//users/admin/login?password=admin
+    uri: http://localhost:8089/users/admin/login?password=admin
     body:
       encoding: UTF-8
       string: ''

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: archivesspace-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Mark Cooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -42,100 +42,100 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.10
 description: Interact with ArchivesSpace via its RESTful API.
 email:
 - mark.c.cooper@outlook.com
@@ -153,8 +153,8 @@ files:
 - archivesspace-client.gemspec
 - examples/export.rb
 - examples/password_reset.rb
-- examples/perms_and_groups.rb
 - examples/repo_and_user.rb
+- examples/test_connection.rb
 - lib/archivesspace/client.rb
 - lib/archivesspace/client/client.rb
 - lib/archivesspace/client/configuration.rb
@@ -190,8 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Interact with ArchivesSpace via its RESTful API.

data/examples/perms_and_groups.rb

@@ -1,8 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'awesome_print'
-require 'archivesspace/client'
-
-# default client connection: localhost:8089, admin, admin
-client = ArchivesSpace::Client.new.login
-
-# todo ... example of assignment using CSV