archivesspace-client 0.1.12 → 0.3.0

data/lib/archivesspace/client/configuration.rb

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

data/lib/archivesspace/client/pagination.rb

@@ -20,7 +20,7 @@ module ArchivesSpace
     ]
 
     ENDPOINTS.each do |endpoint|
-      method_name = endpoint.split('/').last # remove prefix
+      method_name = endpoint.split("/").last # remove prefix
       define_method(method_name) do |options = {}|
         all(endpoint, options)
       end
@@ -36,8 +36,8 @@ module ArchivesSpace
           result = get(path, options)
           results = []
 
-          if result.parsed.respond_to?(:key) && result.parsed.key?('results')
-            results = result.parsed['results']
+          if result.parsed.respond_to?(:key) && result.parsed.key?("results")
+            results = result.parsed["results"]
           else
             results = result.parsed
             unlimited_listing = true

data/lib/archivesspace/client/request.rb

@@ -10,26 +10,28 @@ module ArchivesSpace
         delete: {},
         get: {},
         post: {
-          'Content-Type' => 'application/json',
-          'Content-Length' => 'nnnn'
+          "Content-Type" => "application/json",
+          "Content-Length" => "nnnn"
         },
         put: {
-          'Content-Type' => 'application/json',
-          'Content-Length' => 'nnnn'
+          "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.gsub(%r{^/+}, '')
-      @options           = options
+    def initialize(config, method = "GET", path = "", options = {})
+      @config = config
+      @method = method.downcase.to_sym
+      @path = path.gsub(%r{^/+}, "")
+      @options = options
       @options[:headers] =
         options[:headers] ? default_headers(@method).merge(options[:headers]) : default_headers(@method)
-      @options[:verify]  = config.verify_ssl
-      @options[:query]   = {} unless options.key? :query
+      @options[:headers]["User-Agent"] = "#{Client::NAME}/#{Client::VERSION}"
+      @options[:verify] = config.verify_ssl
+      @options[:timeout] = config.timeout
+      @options[:query] = {} unless options.key? :query
 
       self.class.debug_output($stdout) if @config.debug
 

data/lib/archivesspace/client/response.rb

@@ -5,11 +5,11 @@ module ArchivesSpace
     attr_reader :result, :parsed, :body, :headers, :status, :status_code
 
     def initialize(result)
-      @result      = result
-      @parsed      = result.parsed_response
-      @body        = result.body
-      @headers     = result.headers
-      @status      = result.response
+      @result = result
+      @parsed = result.parsed_response
+      @body = result.body
+      @headers = result.headers
+      @status = result.response
       @status_code = result.code.to_i
     end
   end

data/lib/archivesspace/client/task.rb

@@ -10,51 +10,51 @@ module ArchivesSpace
     def group_user_assignment(users_with_roles)
       updated = []
       groups.each do |group|
-        group = get("groups/#{uri_to_id(group['uri'])}").parsed
+        group = get("groups/#{uri_to_id(group["uri"])}").parsed
         update = false
 
         users_with_roles.each do |user, roles|
           # should the user still belong to this group?
-          if group['member_usernames'].include?(user)
-            unless roles.include? group['group_code']
-              group['member_usernames'].delete user
+          if group["member_usernames"].include?(user)
+            unless roles.include? group["group_code"]
+              group["member_usernames"].delete user
               update = true
             end
           # should the user be added to this group?
-          elsif roles.include? group['group_code']
-            group['member_usernames'] << user
+          elsif roles.include? group["group_code"]
+            group["member_usernames"] << user
             update = true
           end
         end
 
         next unless update
 
-        response = post("/groups/#{uri_to_id(group['uri'])}", group.to_json)
+        response = post("/groups/#{uri_to_id(group["uri"])}", group.to_json)
         updated << response
       end
       updated
     end
 
     def login
-      username  = config.username
-      password  = config.password
+      username = config.username
+      password = config.password
       base_repo = config.base_repo
       use_global_repository # ensure we're in the global scope to login
-      result = request('POST', "/users/#{username}/login", { query: { password: password } })
-      unless result.parsed['session']
+      result = request("POST", "/users/#{username}/login", {query: {password: password}})
+      unless result.parsed["session"]
         raise ConnectionError, "API client login failed as user [#{username}], check username and password are correct"
       end
 
       config.base_repo = base_repo # reset repo as set by the cfg
-      @token = result.parsed['session']
+      @token = result.parsed["session"]
       self
     end
 
     def password_reset(username, password)
-      user = all('users').find { |u| u['username'] == username }
+      user = all("users").find { |u| u["username"] == username }
       raise RequestError, user.status unless user
 
-      post(user['uri'], user.to_json, { password: password })
+      post(user["uri"], user.to_json, {password: password})
     end
 
     # def search(params)
@@ -64,7 +64,7 @@ module ArchivesSpace
     private
 
     def uri_to_id(uri)
-      uri.split('/').last
+      uri.split("/").last
     end
   end
 end

data/lib/archivesspace/client/template.rb

@@ -3,24 +3,67 @@
 module ArchivesSpace
   module Template
     def self.list
-      Dir.glob File.join(templates_path, '*.erb')
+      Dir.glob ["*"], base: File.join(templates_path)
     end
 
     def self.process(template, data)
-      t = ERB.new(read(template))
-      r = t.result(binding).gsub(/\n+/, "\n")
-      JSON.parse(r).to_json
-    end
-
-    def self.read(file)
-      File.read("#{templates_path}/#{file}.json.erb")
+      processor = File.extname(template).delete(".").camelize
+      processor = Object.const_get("ArchivesSpace::Template::#{processor}")
+      processor.new(template, data).process
     end
 
     def self.templates_path
       ENV.fetch(
-        'ARCHIVESSPACE_CLIENT_TEMPLATES_PATH',
-        File.join(File.dirname(File.expand_path(__FILE__)), 'templates')
+        "ARCHIVESSPACE_CLIENT_TEMPLATES_PATH",
+        File.join(File.dirname(File.expand_path(__FILE__)), "templates")
       )
     end
+
+    class Processor
+      attr_reader :template, :data
+
+      def initialize(template, data)
+        @template = template
+        @data = data
+
+        validate_template
+      end
+
+      def extension
+        raise "Not implemented"
+      end
+
+      def read_template
+        File.read(File.join(ArchivesSpace::Template.templates_path, template))
+      end
+
+      def validate_template
+        raise "Invalid template" unless File.extname(template).end_with? extension
+      end
+    end
+
+    class Erb < Processor
+      def extension
+        ".erb"
+      end
+
+      def process
+        t = ERB.new(read_template)
+        r = t.result(binding).squeeze("\n")
+        JSON.parse(r).to_json
+      end
+    end
+
+    class Jbuilder < Processor
+      def extension
+        ".jbuilder"
+      end
+
+      def process
+        ::Jbuilder.encode do |json|
+          eval(read_template, binding) # standard:disable Security/Eval
+        end
+      end
+    end
   end
 end

data/lib/archivesspace/client/templates/resource.json.jbuilder

@@ -0,0 +1,7 @@
+json.id_0 data["object_number"]
+json.title data["title"]
+json.level data["description_level"]
+
+# json.id_0 "001.001"
+# json.title "Title"
+# json.level "collection"

data/lib/archivesspace/client/version.rb

@@ -2,6 +2,6 @@
 
 module ArchivesSpace
   class Client
-    VERSION = '0.1.12'
+    VERSION = "0.3.0"
   end
 end

data/lib/archivesspace/client.rb

@@ -1,34 +1,35 @@
 # frozen_string_literal: true
 
-require 'dry/cli'
-require 'httparty'
-require 'json'
-require 'nokogiri'
+require "dry/cli"
+require "httparty"
+require "json"
+require "nokogiri"
+require "jbuilder"
 
 # mixins required first
-require 'archivesspace/client/pagination'
-require 'archivesspace/client/task'
+require "archivesspace/client/pagination"
+require "archivesspace/client/task"
 
-require 'archivesspace/client/client'
-require 'archivesspace/client/configuration'
-require 'archivesspace/client/request'
-require 'archivesspace/client/response'
-require 'archivesspace/client/template'
-require 'archivesspace/client/version'
+require "archivesspace/client/client"
+require "archivesspace/client/configuration"
+require "archivesspace/client/request"
+require "archivesspace/client/response"
+require "archivesspace/client/template"
+require "archivesspace/client/version"
 
 # cli
-require 'archivesspace/client/cli/exec'
-require 'archivesspace/client/cli/version'
-require 'archivesspace/client/cli' # load the registry last
+require "archivesspace/client/cli/exec"
+require "archivesspace/client/cli/version"
+require "archivesspace/client/cli" # load the registry last
 
 module ArchivesSpace
   class ConnectionError < RuntimeError; end
 
-  class ContextError    < RuntimeError; end
+  class ContextError < RuntimeError; end
 
   class RepositoryIdError < RuntimeError; end
 
-  class ParamsError     < RuntimeError; end
+  class ParamsError < RuntimeError; end
 
-  class RequestError    < RuntimeError; end
+  class RequestError < RuntimeError; end
 end

data/spec/archivesspace/client_spec.rb

@@ -1,87 +1,85 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+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
+  describe "Configuration" do
+    it "will use the default configuration if none is provided" do
       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)
+    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 }))
+    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 'Repository scoping' do
-    it 'will set the repository with an integer id' do
-      client = ArchivesSpace::Client.new
+  describe "Repository scoping" do
+    it "will set the repository with an integer id" do
       client.repository 2
-      expect(client.config.base_repo).to eq 'repositories/2'
+      expect(client.config.base_repo).to eq "repositories/2"
     end
 
-    it 'will set the repository with a string id cast to integer' do
-      client = ArchivesSpace::Client.new
-      client.repository '2'
-      expect(client.config.base_repo).to eq 'repositories/2'
+    it "will set the repository with a string id cast to integer" do
+      client.repository "2"
+      expect(client.config.base_repo).to eq "repositories/2"
     end
 
-    it 'will fail if the id cannot be cast to integer' do
-      client = ArchivesSpace::Client.new
-      expect { client.repository('xyz') }.to raise_error(
+    it "will fail if the id cannot be cast to integer" do
+      expect { client.repository("xyz") }.to raise_error(
         ArchivesSpace::RepositoryIdError
       )
     end
 
-    it 'will use the global repo if repository is passed nil' do
-      client = ArchivesSpace::Client.new
+    it "will use the global repo if repository is passed nil" do
       client.repository 2
       client.repository nil
-      expect(client.config.base_repo).to eq ''
+      expect(client.config.base_repo).to eq ""
     end
 
-    it 'will use the global repo when the method is called' do
-      client = ArchivesSpace::Client.new
+    it "will use the global repo when the method is called" do
       client.repository 2
       client.use_global_repository
-      expect(client.config.base_repo).to eq ''
+      expect(client.config.base_repo).to eq ""
     end
   end
 
-  describe 'Pagination' do
-    it 'will have a method for defined paginated record types' do
-      client = ArchivesSpace::Client.new
+  describe "Requests" do
+    it "will have an identifiable user agent" do
+      request = ArchivesSpace::Request.new(client.config)
+      expect(request.options[:headers]["User-Agent"]).to eq "#{ArchivesSpace::Client::NAME}/#{ArchivesSpace::Client::VERSION}"
+    end
+  end
+
+  describe "Pagination" do
+    it "will have a method for defined paginated record types" do
       ArchivesSpace::Pagination::ENDPOINTS.each do |e|
-        next if e.match?('/')
+        next if e.match?("/")
 
         expect(client.respond_to?(e.to_sym)).to be true
       end
     end
 
-    it 'will have a method for defined paginated record types with multipart path' do
-      client = ArchivesSpace::Client.new
+    it "will have a method for defined paginated record types with multipart path" do
       expect(client.respond_to?(:people)).to be true
     end
   end
 
-  describe 'Version information' do
-    it 'has a version number' do
+  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'
+    it "can retrieve the backend version info" do
+      VCR.use_cassette("backend_version") do
+        client.login
+        response = client.get "version"
         expect(response.status_code).to eq(200)
         expect(response.body).to match(/ArchivesSpace \(.*\)/)
       end

data/spec/archivesspace/configuration_spec.rb

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe ArchivesSpace::Configuration do
-  it 'uses the default profile for configuration settings' 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
+  it "allows configuration settings to be provided" do
     config = ArchivesSpace::Configuration.new({
-                                                base_uri: CUSTOM_BASE_URI
-                                              })
+      base_uri: CUSTOM_BASE_URI
+    })
     expect(config.base_uri).to eq CUSTOM_BASE_URI
   end
 
-  it 'allows the configuration properties to be updated' do
+  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 })
+  it "ignores unrecognized configuration properties" do
+    config = ArchivesSpace::Configuration.new({xyz: 123})
     expect { config.xyz }.to raise_error(NoMethodError)
   end
 end

data/spec/archivesspace/templates_spec.rb

@@ -1,26 +1,40 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
 
 describe ArchivesSpace::Template do
-  it 'can list the default templates' do
+  it "can list the default templates" do
     templates = ArchivesSpace::Template.list
     expect(templates).to_not be_empty
     expect(templates).to include(/repository_with_agent.*erb/)
+    expect(templates).to include(/resource.*jbuilder/)
   end
 
-  it 'can change the path when template envvar is set' do
+  it "can change the path when template envvar is set" do
     expect(ArchivesSpace::Template.templates_path).to match(
-      /#{File.join('lib', 'archivesspace', 'client', 'templates')}/
+      /#{File.join("lib", "archivesspace", "client", "templates")}/
     )
-    ENV['ARCHIVESSPACE_CLIENT_TEMPLATES_PATH'] = '/path/to/nowhere'
-    expect(ArchivesSpace::Template.templates_path).to eq '/path/to/nowhere'
-    ENV.delete('ARCHIVESSPACE_CLIENT_TEMPLATES_PATH')
+    ENV["ARCHIVESSPACE_CLIENT_TEMPLATES_PATH"] = "/path/to/nowhere"
+    expect(ArchivesSpace::Template.templates_path).to eq "/path/to/nowhere"
+    ENV.delete("ARCHIVESSPACE_CLIENT_TEMPLATES_PATH")
   end
 
-  it 'can process a template' do
-    data = { repo_code: 'ABC', name: 'ABC Archive', agent_contact_name: 'ABC Admin' }
-    json = JSON.parse(ArchivesSpace::Template.process(:repository_with_agent, data))
-    expect(json['repository']['repo_code']).to eq data[:repo_code]
+  it "can process an erb template" do
+    data = {repo_code: "ABC", name: "ABC Archive", agent_contact_name: "ABC Admin"}
+    json = JSON.parse(ArchivesSpace::Template.process("repository_with_agent.json.erb", data))
+    expect(json["repository"]["repo_code"]).to eq data[:repo_code]
+  end
+
+  it "can process a jbuilder template" do
+    data = {"title" => "Title", "object_number" => "001.001", "description_level" => "collection"}
+    json = JSON.parse(ArchivesSpace::Template.process("resource.json.jbuilder", data))
+    expect(json["id_0"]).to eq data["object_number"]
+  end
+
+  it "rejects a template that does not match by extension" do
+    data = {"title" => "Title"}
+    expect {
+      JSON.parse(ArchivesSpace::Template::Erb.new("resource.json.jbuilder", data).process)
+    }.to raise_error "Invalid template"
   end
 end