archivesspace-client 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e9f5cb28d4e103f422b9679168d14615b9104f3
-  data.tar.gz: ec0f1fb50c060f4aa8e6f3e7db32d426d97c0936
+  metadata.gz: 1723d47efa6b10e5106ca28bfa6f247bf79603d2
+  data.tar.gz: f6b404154c5c87ee9a74036d6501cc3304df01ea
 SHA512:
-  metadata.gz: c5cf1ca6b5790c4b746a452b1ac1b8779fe9a0668e60e89c090d2c80e7a53ea6daee851619b9c9945d249bec896b65cb688605df59db8c5bbd33317f42021ebb
-  data.tar.gz: 6fe609191724b4fb6b742c69541b8fa02c45f1f2d166be6a7e915834a0e9e2bb7775b29d88ca7ea814b2d98a1fe92752300ae547e3875ae6386972041992821c
+  metadata.gz: 7de5e06e6900dda657cfae615058c10859ba565aa27f16184ec7d44f23c7c2513a52c9717186f8ce04361adabc3097b562db785694bb38556a003177e92b4718
+  data.tar.gz: 17a2e5174475986516c757f7b4f875352546555f0f3aee8539c7f3d2f090789dd1f7087614ca38ea3d0b554c50a351d7307ec8d29706bc816b4fcb328b2e60d9

data/archivesspace-client.gemspec

@@ -20,12 +20,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   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.6.8.1"
 end

data/examples/export.rb

@@ -2,14 +2,28 @@ $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("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
+  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

@@ -13,28 +13,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 == 201
+    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 == 201
+    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/helpers.rb

@@ -24,13 +24,13 @@ module ArchivesSpace
       # 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
+      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.status if result.status_code != 200
+        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
@@ -106,7 +106,7 @@ 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
 
@@ -159,7 +159,7 @@ module ArchivesSpace
     def get_xml(path, options = {})
       # add xml headers
       response = get(path, options)
-      raise RequestError.new path unless response.status_code == 200
+      raise RequestError.new(response.body) unless response.status_code == 200
       Nokogiri::XML(response.body).to_xml
     end
 

data/lib/archivesspace/client/request.rb

@@ -26,7 +26,7 @@ module ArchivesSpace
       @path    = path
 
       @options = options
-      @options[:headers]    = options[:headers] ? default_headers(@method).merge(options[:headers]) : default_headers
+      @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
 
@@ -41,4 +41,4 @@ module ArchivesSpace
 
   end
 
-end
+end

data/lib/archivesspace/client/version.rb

@@ -1,5 +1,5 @@
 module ArchivesSpace
   class Client
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archivesspace-client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Mark Cooper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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.6.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.8.1
 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
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.10
 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