archivesspace-client 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9b4ca0ba3d8d057c3e6173cfec463660ab5edca6
-  data.tar.gz: 78fb789484fb50bf3892e1a2e9d0d3eb56a8bc88
+SHA256:
+  metadata.gz: 19da316e65bd48aaf2efa4268eb7217d051f9e11a1e822b0b4813bae4dd5f906
+  data.tar.gz: 8ea7445f1fa00f42a3c0ea633f3f6938aeee071b679408e3acfcb1e16a7858df
 SHA512:
-  metadata.gz: cc2d5f97f7f2d444b1779db3bbd41052862f066051dd408b358f6d38fe85a0daa13c39d110d9a534f98c5e2bb8b47688316e2acefa05ee205a8956af7ad1bdb5
-  data.tar.gz: 71d430fba940727214d3a46fd5d249d7e580a9463418087e66c69ad27c0b5685cb7e2d12465f0f2c002977d4a5e05a999f88f91f1f11eaf288ef802e11ea8c2a
+  metadata.gz: 79b6c0d669fa21b7df8a55ca888155dc1d15be16283fa050ff87bd68bb0a4c26e028ae6baa27abb4446515ea9afe91204e87054d7db3fa49934d06e65a20dee6
+  data.tar.gz: 27c911770a1bdb0813b913722234d52c8eb948cfc8f925589d877c7b4f0ed78aac31e0275ae135c8bb5762a175a0d3be5249d61e4ef616ed96bc49c04d4d6675

data/README.md

@@ -110,7 +110,7 @@ bundle exec rake
 Bump version in `lib/archivesspace/client/version.rb` then:
 
 ```bash
-VERSION=0.1.4
+VERSION=0.1.5
 gem build archivesspace-client
 gem push archivesspace-client-$VERSION.gem
 git tag v$VERSION

data/archivesspace-client.gemspec

@@ -18,7 +18,7 @@ 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", "3.6.0"
   spec.add_development_dependency "vcr", "3.0.3"

data/examples/export.rb

@@ -19,10 +19,13 @@ client.config.base_repo = "repositories/2"
 
 begin
   # date -d '2015-07-01 00:00:00' +'%s' # 1435734000
-  client.resources("ead", { query: { modified_since: "1435734000" } }) do |ead|
+  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
-    ap ead
+    id   = resource['uri'].split('/')[-1]
+    opts = { include_unpublished: false }
+    response = client.get("resource_descriptions/#{id}.xml", opts)
+    puts Nokogiri::XML(response.body).to_xml
   end
 rescue ArchivesSpace::RequestError => ex
   puts ex.message

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
 
@@ -24,7 +35,7 @@ repository = ArchivesSpace::Template.process_template(:repository_with_agent, re
 
 begin
   response = client.post('/repositories/with_agent', repository)
-  if response.status_code == 201
+  if response.status_code.to_s =~ /^2/
     repository = client.repositories.find { |r| r["repo_code"] == "XYZ" }
     ap repository
     ap client.delete(repository["uri"])
@@ -34,7 +45,7 @@ begin
 
   user = ArchivesSpace::Template.process_template(:user, user_data)
   response = client.post('users', user, { password: user_password })
-  if response.status_code == 201
+  if response.status_code.to_s =~ /^2/
     user = client.users.find { |r| r["username"] == "lmessi" }
     ap user
     ap client.delete user["uri"]

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.body) 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.body) 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", options = {})
-      id   = digital_object["uri"].split("/")[-1]
-      path = "digital_objects/#{format}/#{id}.xml"
-      get_xml path, options
-    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|
@@ -110,59 +101,26 @@ module ArchivesSpace
       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", options = {})
-      id   = resource["uri"].split("/")[-1]
-      path = format == "ead" ? "resource_descriptions/#{id}.xml" : "resources/#{format}/#{id}.xml"
-      get_xml path, options
-    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, options = {})
-      # add xml headers
-      response = get(path, options)
-      raise RequestError.new(response.body) 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.gsub(/^\/+/, '')
+      @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(@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}"
       self.class.base_uri base_uri
-      # self.class.default_params abc: 123
     end
 
     def execute

data/lib/archivesspace/client/version.rb

@@ -1,5 +1,5 @@
 module ArchivesSpace
   class Client
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: archivesspace-client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mark Cooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2019-05-21 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
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Interact with ArchivesSpace via its RESTful API.