archivesspace-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 166c7dc29eb3bba590d2480d4b0a4d67392d7066
+  data.tar.gz: 63c5bd51a5f5f093a1afb247da0942bba3bd68d2
+SHA512:
+  metadata.gz: 774fcbf7d02bbb34cdc549ee8dbda2f6fb7181eaecb188f70879a7f975a7e93ca2792d2748ade0fc46afda945a57ecaadd5c0f7cd5cd9198621d459c11813667
+  data.tar.gz: d6996636d70071997bd14f185acf17e3e3cd7b3338be987a39514af25ce46516b2cc456aae9e64ed1d2b3b4caa9e66c81648424fe34d8e4031839674a0e469e7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+*.lock
+*.xml
+*.zip
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+examples/my_*.rb
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/archivesspace/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in archivesspace-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mark Cooper
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+Archivesspace Client
+===
+
+Interact with ArchivesSpace via its API.
+
+Installation
+---
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'archivesspace-client'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+    $ gem install archivesspace-client
+
+Usage
+---
+
+See the examples directory for a range of use cases.
+
+**Default configuration**
+
+Create client with default settings (`localhost:8089`, `admin`, `admin`):
+
+```ruby
+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",
+  base_repo: "",
+  username: "admin",
+  password: "123456",
+  page_size: 50,
+  throttle: 0,
+  verify_ssl: false,
+})
+
+client = ArchivesSpace::Client.new(config).login
+```
+
+**Making basic requests**
+
+The client responds to the standard request methods:
+
+```ruby
+client.post('users', payload, { password: "abc123" }) # CREATE
+client.get('users/5') # READ
+client.post('users/5', payload) # UPDATE
+client.delete('users/5') # DELETE
+
+# these all defer to `request`
+client.request('GET', 'users/5')
+
+# to add params
+client.get('users', { query: { all_ids: true } }).parsed
+
+# using convenience methods
+user = client.all('users').find { |user| user["username"] == "jdoe" }
+
+# or even ...
+user = client.users.find { |user| user["username"] == "jdoe" }
+```
+
+See `helpers.rb` for more convenience methods such as `client.digital_objects` etc.
+
+**Setting a repository context**
+
+Update the `base_repo` configuration value to add a repository scope to requests (this is optional).
+
+```ruby
+client.config.base_repo = "repositories/2"
+client.get('digital_objects') # instead of "repositories/2/digital_objects" etc.
+
+# to reset
+client.config.base_repo = ""
+```
+
+Development
+---
+
+To run the examples start a local instance of ArchivesSpace then:
+
+```bash
+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.
+
+To run the tests:
+
+```bash
+bundle exec rake
+```
+
+Contributing
+---
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lyrasis/archivesspace-client.
+
+License
+---
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+---

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/archivesspace-client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'archivesspace/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "archivesspace-client"
+  spec.version       = ArchivesSpace::Client::VERSION
+  spec.authors       = ["Mark Cooper"]
+  spec.email         = ["mark.c.cooper@outlook.com"]
+  spec.summary       = %q{Interact with ArchivesSpace via its RESTful API.}
+  spec.description   = %q{Interact with ArchivesSpace via its RESTful API.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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 "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_dependency "httparty"
+  spec.add_dependency "json"
+  spec.add_dependency "nokogiri"
+end

data/examples/export.rb

@@ -0,0 +1,15 @@
+$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
+
+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
+end

data/examples/password_reset.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'awesome_print'
+require 'archivesspace/client'
+
+username = "mrx"
+password = "123456"
+
+# default client connection: localhost:8089, admin, admin
+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}"
+end

data/examples/perms_and_groups.rb

@@ -0,0 +1,8 @@
+$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

data/examples/repo_and_user.rb

@@ -0,0 +1,40 @@
+$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
+
+ap ArchivesSpace::Template.list # view available templates
+
+repo_data = {
+  repo_code: "XYZ",
+  name: "XYZ Archive",
+  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 = 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

data/lib/archivesspace/client.rb

@@ -0,0 +1,22 @@
+require 'httparty'
+require 'json'
+require 'nokogiri'
+
+# mixins required first
+require "archivesspace/client/helpers"
+
+require "archivesspace/client/client"
+require "archivesspace/client/configuration"
+require "archivesspace/client/request"
+require "archivesspace/client/response"
+require "archivesspace/client/template"
+require "archivesspace/client/version"
+
+module ArchivesSpace
+
+  class ConnectionError < Exception ; end
+  class ContextError    < Exception ; end
+  class ParamsError     < Exception ; end
+  class RequestError    < Exception ; end
+
+end

data/lib/archivesspace/client/client.rb

@@ -0,0 +1,41 @@
+module ArchivesSpace
+
+  class Client
+    include Helpers
+    attr_accessor :token
+    attr_reader   :config
+
+    def initialize(config = Configuration.new)
+      raise "Invalid configuration object" unless config.kind_of? ArchivesSpace::Configuration
+      @config = config
+      @token  = nil
+    end
+
+    def get(path, options = {})
+      request 'GET', path, options
+    end
+
+    def post(path, payload, params = {})
+      request 'POST', path, { body: payload.to_json, query: params }
+    end
+
+    def put(path, payload)
+      request 'PUT', path, { body: payload.to_json }
+    end
+
+    def delete(path)
+      request 'DELETE', path
+    end
+
+    private
+
+    def request(method, path, options = {})
+      sleep config.throttle
+      options[:headers] = { "X-ArchivesSpace-Session" => token } if token
+      result = Request.new(config, method, path, options).execute
+      Response.new result
+    end
+
+  end
+
+end

data/lib/archivesspace/client/configuration.rb

@@ -0,0 +1,28 @@
+module ArchivesSpace
+
+  class Configuration
+
+    def defaults
+      {
+        base_uri: "http://localhost:8089",
+        base_repo: "",
+        username: "admin",
+        password: "admin",
+        page_size: 50,
+        throttle: 0,
+        verify_ssl: true,
+      }
+    end
+
+    def initialize(settings = {})
+      settings = defaults.merge(settings)
+      settings.each do |property, value|
+        next unless defaults.keys.include? property
+        instance_variable_set("@#{property}", value)
+        self.class.send(:attr_accessor, property)
+      end
+    end
+
+  end
+
+end

data/lib/archivesspace/client/helpers.rb

@@ -0,0 +1,163 @@
+# needed for roundtrip hash merging
+class ::Hash
+  def deep_merge(second)
+    merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+    self.merge(second, &merger)
+  end
+end
+
+module ArchivesSpace
+
+  module Helpers
+
+    def accessions(options = {}, &block)
+      records = all('accessions', options) do |record|
+        yield record if block_given?
+      end
+      records
+    end
+
+    def all(path, options = {}, &block)
+      all    = []
+      format = options.delete(:format)
+      # options[:headers] -- add xml headers if format
+
+      result = get(path, options.merge({ query: { all_ids: true } } ))
+      ap result
+      raise RequestError.new result.status if result.status_code != 200
+      result.parsed.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
+    end
+
+    def backend_version
+      get "version"
+    end
+
+    def batch_import(payload, params = {})
+      # 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
+    end
+
+    def groups
+      #
+    end
+
+    def group_user_assignment(users_with_roles, params = { with_members: true })
+      # updated = []
+      # groups.each do |group|
+      #   changed = false
+
+      #   users_with_roles.each do |user, roles|
+      #     if roles.include? group["group_code"]
+      #       unless group["member_usernames"].include? user
+      #         group["member_usernames"] << user
+      #         changed = true
+      #       end
+      #     else
+      #       if group["member_usernames"].include? user
+      #         group["member_usernames"].delete user
+      #         changed = true
+      #       end
+      #     end
+      #   end
+
+      #   if changed
+      #     updated << update( group, params )
+      #   end
+        
+      #   sleep 1 # moderate requests
+      # end
+      # updated
+    end
+
+    def login
+      username, password = config.username, config.password
+      result = request('POST', "/users/#{username}/login", { query: { password: password } })
+      raise ConnectionError.new "Failed to connect to ArchivesSpace backend as #{username} #{password}" unless result.parsed["session"]
+      @token = result.parsed["session"]
+      self
+    end
+
+    def password_reset(username, password)
+      user = all('users').find { |u| u["username"] == username }
+      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
+    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
+    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
+    end
+
+  end
+
+end

data/lib/archivesspace/client/request.rb

@@ -0,0 +1,44 @@
+module ArchivesSpace
+
+  class Request
+    include HTTParty
+    attr_reader :config, :headers, :method, :path, :options
+
+    def default_headers(method = :get)
+      headers = {
+        delete: {},
+        get: {},
+        post: {
+          "Content-Type" => "application/json",
+          "Content-Length" => "nnnn",
+        },
+        put: {
+          "Content-Type" => "application/json",
+          "Content-Length" => "nnnn",
+        }
+      }
+      headers[method]
+    end
+
+    def initialize(config, method = "GET", path = "", options = {})
+      @config  = config
+      @method  = method.downcase.to_sym
+      @path    = path
+
+      @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
+      self.class.send method, "/#{path}", options
+    end
+
+  end
+
+end

data/lib/archivesspace/client/response.rb

@@ -0,0 +1,18 @@
+module ArchivesSpace
+
+  class Response
+    attr_reader :result, :parsed, :body, :headers, :status, :status_code, :xml
+
+    def initialize(result)
+      # throw error
+      @result      = result
+      @parsed      = result.parsed_response
+      @body        = result.body
+      @headers     = result.headers
+      @status      = result.response
+      @status_code = result.code.to_i
+    end
+
+  end
+
+end

data/lib/archivesspace/client/template.rb

@@ -0,0 +1,25 @@
+module ArchivesSpace
+
+  module Template
+
+    def self.list
+      []
+    end
+
+    def self.process_template(template, data)
+      t = ERB.new(self.read_template(template))
+      r = t.result(binding).gsub(/\n+/,"\n")
+      JSON.parse(r)
+    end
+
+    def self.read_template(file)
+      File.read("#{self.templates_path}/#{file.to_s}.json.erb")
+    end
+
+    def self.templates_path
+      File.join(File.dirname(File.expand_path(__FILE__)), 'templates')
+    end
+
+  end
+
+end

data/lib/archivesspace/client/templates/digital_object.json.erb

@@ -0,0 +1,4 @@
+{
+  "digital_object_id": "<%= data[:digital_object_id] %>",
+  "title": "<%= data[:title] %>"
+}

data/lib/archivesspace/client/templates/repository.json.erb

@@ -0,0 +1,8 @@
+{
+  "repo_code": "<%= data[:repo_code] %>",
+  "name": "<%= data[:name] %>",
+  "org_code": "<%= data[:org_code] %>",
+  "country": "<%= data[:country] %>",
+  "parent_institution_name": "<%= data[:parent_institution_name] %>",
+  "url": "<%= data[:url] %>"
+}

data/lib/archivesspace/client/templates/repository_with_agent.json.erb

@@ -0,0 +1,36 @@
+{
+  "repository": {
+    "repo_code": "<%= data[:repo_code] %>",
+    "name": "<%= data[:name] %>",
+    "org_code": "<%= data[:org_code] %>",
+    "country": "<%= data[:country] %>",
+    "parent_institution_name": "<%= data[:parent_institution_name] %>",
+    "url": "<%= data[:url] %>"
+  },
+  "agent_representation": {
+    "names": [
+      {
+        "primary_name": "<%= data[:name] %>",
+        "source": "local",
+        "sort_name": "<%= data[:name] %>"
+      }
+    ],
+    "agent_contacts": [
+      {
+        "name": "<%= data[:agent_contact_name] %>",
+        "address_1": "<%= data[:agent_contact_address_1] %>",
+        "address_2": "<%= data[:agent_contact_address_2] %>",
+        "address_3": "<%= data[:agent_contact_address_3] %>",
+        "city": "<%= data[:agent_contact_city] %>",
+        "region": "",
+        "country": "<%= data[:agent_contact_country] %>",
+        "post_code": "<%= data[:agent_contact_post_code] %>",
+        "telephone": "<%= data[:agent_contact_telephone] %>",
+        "telephone_ext": "",
+        "fax": "",
+        "email": "<%= data[:agent_contact_email] %>",
+        "note": ""
+      }
+    ]
+  }
+}

data/lib/archivesspace/client/templates/user.json.erb

@@ -0,0 +1,12 @@
+{
+  "username": "<%= data[:username] %>",
+  "name": "<%= data[:name] %>",
+  "email": "<%= data[:email] %>",
+  "first_name": "<%= data[:first_name] %>",
+  "last_name": "<%= data[:last_name] %>",
+  "telephone": "<%= data[:telephone] %>",
+  "title": "<%= data[:title] %>",
+  "department": "<%= data[:department] %>",
+  "additional_contact": "<%= data[:additional_contact] %>",
+  "is_admin": <%= data[:is_admin] || "false" %>
+}

data/lib/archivesspace/client/version.rb

@@ -0,0 +1,5 @@
+module ArchivesSpace
+  class Client
+    VERSION = "0.1.0"
+  end
+end

data/spec/archivesspace/client_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe ArchivesSpace::Client do
+
+  let(:client) { ArchivesSpace::Client.new }
+  let(:login)  { -> { client.login } }
+
+  describe "Configuration" do
+
+    it 'will use the default configuration if none is provided' do
+      client = ArchivesSpace::Client.new
+      expect(client.config.base_uri).to eq DEFAULT_BASE_URI
+    end
+
+    it 'will raise an error if supplied configuration is of invalid type' do
+      expect{ ArchivesSpace::Client.new({ base_uri: CUSTOM_BASE_URI }) }.to raise_error(RuntimeError)
+    end
+
+    it 'will allow a configuration object to be provided' do
+      client = ArchivesSpace::Client.new(ArchivesSpace::Configuration.new({ base_uri: CUSTOM_BASE_URI }))
+      expect(client.config.base_uri).to eq CUSTOM_BASE_URI
+    end
+
+  end
+
+  describe "Version information" do
+
+    it 'has a version number' do
+      expect(ArchivesSpace::Client::VERSION).not_to be nil
+    end
+
+    it "can retrieve the backend version info" do
+      VCR.use_cassette('backend_version') do
+        login.call
+        response = client.get "version"
+        expect(response.status_code).to eq(200)
+        expect(response.body).to match(/ArchivesSpace \(.*\)/)
+      end
+    end
+
+  end
+
+end

data/spec/archivesspace/configuration_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe ArchivesSpace::Configuration do
+
+  it 'uses the default profile for configuration settings' do
+    config = ArchivesSpace::Configuration.new
+    expect(config.base_uri).to eq DEFAULT_BASE_URI
+  end
+
+  it 'allows configuration settings to be provided' do
+    config = ArchivesSpace::Configuration.new({
+      base_uri: CUSTOM_BASE_URI,
+    })
+    expect(config.base_uri).to eq CUSTOM_BASE_URI
+  end
+
+  it 'allows the configuration properties to be updated' do
+    config = ArchivesSpace::Configuration.new
+    config.base_uri = CUSTOM_BASE_URI
+    expect(config.base_uri).to eq CUSTOM_BASE_URI
+  end
+
+  it 'ignores unrecognized configuration properties' do
+    config = ArchivesSpace::Configuration.new({ xyz: 123 })
+    expect{ config.xyz }.to raise_error(NoMethodError)
+  end
+
+end

data/spec/fixtures/cassettes/backend_version.yml

@@ -0,0 +1,68 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:8089//users/admin/login?password=admin
+    body:
+      encoding: UTF-8
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 26 Dec 2015 05:05:14 GMT
+      Content-Type:
+      - application/json
+      Cache-Control:
+      - private, must-revalidate, max-age=0
+      Content-Length:
+      - '2491'
+      X-Content-Type-Options:
+      - nosniff
+      Server:
+      - Jetty(8.1.5.v20120716)
+    body:
+      encoding: UTF-8
+      string: |
+        {"session":"a1b9e7cac8fb01d2502678702c1eaa71b1fa6375a1de8b1f965095e71f4fd6f8","user":{"lock_version":84,"username":"admin","name":"Administrator","is_system_user":true,"create_time":"2015-12-24T05:51:42Z","system_mtime":"2015-12-26T05:05:14Z","user_mtime":"2015-12-26T05:05:14Z","jsonmodel_type":"user","groups":[],"is_admin":true,"uri":"/users/1","agent_record":{"ref":"/agents/people/1"},"permissions":{"/repositories/1":["update_location_record","delete_vocabulary_record","update_subject_record","delete_subject_record","update_agent_record","delete_agent_record","update_vocabulary_record","merge_subject_record","merge_agent_record","update_container_profile_record","administer_system","become_user","cancel_importer_job","create_repository","delete_archival_record","delete_classification_record","delete_event_record","delete_repository","import_records","index_system","manage_agent_record","manage_container_profile_record","manage_container_record","manage_rde_templates","manage_repository","manage_subject_record","manage_users","manage_vocabulary_record","mediate_edits","merge_agents_and_subjects","merge_archival_record","suppress_archival_record","system_config","transfer_archival_record","transfer_repository","update_accession_record","update_classification_record","update_container_record","update_digital_object_record","update_event_record","update_resource_record","view_all_records","view_repository","view_suppressed"],"_archivesspace":["administer_system","become_user","cancel_importer_job","create_repository","delete_archival_record","delete_classification_record","delete_event_record","delete_repository","import_records","index_system","manage_agent_record","manage_container_profile_record","manage_container_record","manage_rde_templates","manage_repository","manage_subject_record","manage_users","manage_vocabulary_record","mediate_edits","merge_agents_and_subjects","merge_archival_record","suppress_archival_record","system_config","transfer_archival_record","transfer_repository","update_accession_record","update_classification_record","update_container_record","update_digital_object_record","update_event_record","update_resource_record","view_all_records","view_repository","view_suppressed","update_location_record","delete_vocabulary_record","update_subject_record","delete_subject_record","update_agent_record","delete_agent_record","update_vocabulary_record","merge_subject_record","merge_agent_record","update_container_profile_record"]}}}
+    http_version: 
+  recorded_at: Sat, 26 Dec 2015 05:05:14 GMT
+- request:
+    method: get
+    uri: http://localhost:8089/version
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Archivesspace-Session:
+      - a1b9e7cac8fb01d2502678702c1eaa71b1fa6375a1de8b1f965095e71f4fd6f8
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 26 Dec 2015 05:05:14 GMT
+      Content-Type:
+      - text/html;charset=UTF-8
+      Cache-Control:
+      - private, must-revalidate, max-age=0
+      Content-Length:
+      - '29'
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+      Server:
+      - Jetty(8.1.5.v20120716)
+    body:
+      encoding: UTF-8
+      string: ArchivesSpace (20151120-0315)
+    http_version: 
+  recorded_at: Sat, 26 Dec 2015 05:05:14 GMT
+recorded_with: VCR 3.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'archivesspace/client'
+require 'vcr'
+require 'webmock/rspec'
+
+# GLOBAL VALUES FOR SPECS
+DEFAULT_BASE_URI = "http://localhost:8089"
+CUSTOM_BASE_URI  = "https://archives.university.edu/api"
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/fixtures/cassettes"
+  c.hook_into :webmock
+  c.default_cassette_options = { :record => :once }
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: archivesspace-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mark Cooper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-15 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Interact with ArchivesSpace via its RESTful API.
+email:
+- mark.c.cooper@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- archivesspace-client.gemspec
+- examples/export.rb
+- examples/password_reset.rb
+- examples/perms_and_groups.rb
+- examples/repo_and_user.rb
+- lib/archivesspace/client.rb
+- lib/archivesspace/client/client.rb
+- lib/archivesspace/client/configuration.rb
+- lib/archivesspace/client/helpers.rb
+- lib/archivesspace/client/request.rb
+- lib/archivesspace/client/response.rb
+- lib/archivesspace/client/template.rb
+- lib/archivesspace/client/templates/digital_object.json.erb
+- lib/archivesspace/client/templates/repository.json.erb
+- lib/archivesspace/client/templates/repository_with_agent.json.erb
+- lib/archivesspace/client/templates/user.json.erb
+- lib/archivesspace/client/version.rb
+- spec/archivesspace/client_spec.rb
+- spec/archivesspace/configuration_spec.rb
+- spec/fixtures/cassettes/backend_version.yml
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Interact with ArchivesSpace via its RESTful API.
+test_files:
+- spec/archivesspace/client_spec.rb
+- spec/archivesspace/configuration_spec.rb
+- spec/fixtures/cassettes/backend_version.yml
+- spec/spec_helper.rb