archivesspace-client 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d62f24f62e27e4dcb265982a09d19929029a12d7926983137f7835b9e945ec8d
-  data.tar.gz: 88b7f1d79f02207cba4dfbb6334fae4a7080adca8634c6c52b53d6616398dfd0
+  metadata.gz: b567aa6c6f40826a102d43a028600f562d8842f791d8f26269668eaf23757c95
+  data.tar.gz: 318036e1c02449bf25265431d44baa2d765970f782cc836daa9db25bd2ca3f89
 SHA512:
-  metadata.gz: d776656385e5e84c4ba0adfec158e6a43ef60720aec43108a15e6e307adaf5022eb2168d463cdc74f4657aae62bbea80662d851dc65aee8a4ed02b1f9cc432d2
-  data.tar.gz: 482eeab5c389e3433bae0102a687dfc42ede31792bf0b9bafcd2b0ec22492769523c42639718f9c202fc83abd2b08b6b798a7827826441c2ee951de9d817eda9
+  metadata.gz: 10bae2e2c595663d40ec0629444639acd5c3750ea866a3dc0623152a5598818b33d2d511346d702759cbab9948941fc7fe9b4f0208cabd0c17cbee66d3b52ea3
+  data.tar.gz: 000440d2cfeed3c329c08b37040a3b1be15189f41d69afc0ff54e9426915c70165122d320687ad32eae1fc7277fa1321bc22b8cc26e480b8cb166bc03b213868

data/README.md

@@ -4,22 +4,22 @@ Interact with ArchivesSpace via the API.
 
 <!-- TOC start (generated with https://github.com/derlin/bitdowntoc) -->
 
-* [Installation](#installation)
-* [Usage](#usage)
-  * [Configuring a client](#configuring-a-client)
-    * [Default configuration](#default-configuration)
-    * [Custom configuration, on the fly](#custom-configuration-on-the-fly)
-    * [Custom configuration, stored for use with CLI or console](#custom-configuration-stored-for-use-with-cli-or-console)
-  * [Making basic requests](#making-basic-requests)
-  * [Setting a repository context](#setting-a-repository-context)
-* [Templates](#templates)
-* [CLI](#cli)
-* [Console usage](#console-usage)
-* [Development](#development)
-* [Publishing](#publishing)
-* [Changelog](#changelog)
-* [Contributing](#contributing)
-* [License](#license)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Configuring a client](#configuring-a-client)
+    - [Default configuration](#default-configuration)
+    - [Custom configuration, on the fly](#custom-configuration-on-the-fly)
+    - [Custom configuration, stored for use with CLI or console](#custom-configuration-stored-for-use-with-cli-or-console)
+  - [Making basic requests](#making-basic-requests)
+  - [Setting a repository context](#setting-a-repository-context)
+- [Templates](#templates)
+- [CLI](#cli)
+- [Console usage](#console-usage)
+- [Development](#development)
+- [Publishing](#publishing)
+- [Changelog](#changelog)
+- [Contributing](#contributing)
+- [License](#license)
 
 <!-- TOC end -->
 
@@ -145,7 +145,8 @@ end
 ```
 
 Scopes restore the previous context on exit (even if the block raises) and can
-be nested:
+be nested. Call `repository` with no id to nest a global-scope block inside a
+repository scope:
 
 ```ruby
 client.repository(2) do
@@ -153,6 +154,11 @@ client.repository(2) do
     client.resources  # scoped to repo 3
   end
   client.resources    # back to repo 2
+
+  client.repository do
+    client.get('repositories')  # global scope
+  end
+  client.resources    # back to repo 2 again
 end
 
 # now back in the global scope
@@ -260,19 +266,33 @@ main/master branch a new release will be built and published.
 
 ## Changelog
 
+### 0.7.0
+
+- Add support for multipart POST requests, including file uploads to the
+  `jobs_with_files` endpoint.
+
+### 0.6.0
+
+- Support global scope within a nested context. This makes it much
+  more ergonomic to request uris within a repository context.
+
+### 0.5.1
+
+- Fix: prevent caller options passed to request from being mutated.
+
 ### 0.5.0
 
 Breaking changes:
 
-* Removed the `base_repo` configuration option. Use `client.repository(id)` to
+- Removed the `base_repo` configuration option. Use `client.repository(id)` to
   scope requests to a repository instead, either persistently or with a
   block that auto-restores the previous scope.
-* `client.repository(id)` with a block now saves and restores the previous
+- `client.repository(id)` with a block now saves and restores the previous
   context (including when nested or when the block raises), instead of always
   resetting to the global scope.
-* Login failure now raises `ArchivesSpace::AuthenticationError` (was
+- Login failure now raises `ArchivesSpace::AuthenticationError` (was
   `ConnectionError`). `ConnectionError` has been removed.
-* `Client.new` raises `ArchivesSpace::ConfigurationError` (was `RuntimeError`)
+- `Client.new` raises `ArchivesSpace::ConfigurationError` (was `RuntimeError`)
   when given a non-`Configuration` argument.
 
 ## Contributing

data/archivesspace-client.gemspec

@@ -29,8 +29,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr", "~> 6.3"
   spec.add_development_dependency "webmock", "~> 3.24"
 
-  spec.add_dependency "dry-cli", "~> 0.7"
-  spec.add_dependency "httparty", "~> 0.14"
+  spec.add_dependency "dry-cli", "< 2.0"
+  spec.add_dependency "httparty", "~> 0.16"
   spec.add_dependency "json", "~> 2.0"
   spec.add_dependency "jbuilder", "~> 2.12"
 end

data/examples/upload_ead.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "archivesspace/client"
+
+# usage: ruby examples/upload_ead.rb path/to/ead.xml
+path = ARGV.fetch(0) { abort "usage: ruby #{$PROGRAM_NAME} path/to/ead.xml" }
+
+# official sandbox, config boilerplate
+config = ArchivesSpace::Configuration.new(
+  {
+    base_uri: "https://test.archivesspace.org/staff/api",
+    username: "admin",
+    password: "admin",
+    page_size: 50,
+    throttle: 0,
+    verify_ssl: false
+  }
+)
+
+client = ArchivesSpace::Client.new(config).login
+
+job = {
+  jsonmodel_type: "job",
+  job: {
+    jsonmodel_type: "import_job",
+    import_type: "ead_xml",
+    filenames: [File.basename(path)]
+  }
+}
+
+client.repository 2 do
+  response = File.open(path) do |file|
+    client.post_multipart("jobs_with_files", {job: job.to_json, files: [file]})
+  end
+  abort "upload failed (#{response.status_code}): #{response.body}" unless
+    response.status_code == 200
+
+  job_id = response.parsed["id"]
+  puts "created import job #{job_id}"
+
+  # poll until the import finishes, but not for more than ~60s
+  status = nil
+  30.times do
+    status = client.get("jobs/#{job_id}").parsed["status"]
+    puts "status: #{status}"
+    break if %w[completed failed canceled].include?(status)
+
+    sleep 2
+  end
+
+  puts client.get("jobs/#{job_id}/log").body
+end

data/lib/archivesspace/client/client.rb

@@ -33,6 +33,12 @@ module ArchivesSpace
       request "POST", path, {body: payload.to_json, query: params}
     end
 
+    # Allow passing a file object (multipart = true)
+    def post_multipart(path, payload, params = {})
+      body = payload.transform_values { |v| v.is_a?(Hash) ? v.to_json : v }
+      request "POST", path, {body: body, query: params, multipart: true}
+    end
+
     def put(path, payload, params = {})
       request "PUT", path, {body: payload.to_json, query: params}
     end
@@ -42,18 +48,22 @@ module ArchivesSpace
     end
 
     # Scoping requests
-    def repository(id)
-      return use_global_repository if id.nil?
-
-      begin
-        Integer(id)
-      rescue ArgumentError, TypeError
-        raise RepositoryIdError, "Invalid Repository id: #{id}"
+    def repository(id = nil)
+      if id.nil?
+        return use_global_repository unless block_given?
+
+        new_context = nil
+      else
+        begin
+          Integer(id)
+        rescue ArgumentError, TypeError
+          raise RepositoryIdError, "Invalid Repository id: #{id}"
+        end
+
+        new_context = "repositories/#{id}"
+        return @context = new_context unless block_given?
       end
 
-      new_context = "repositories/#{id}"
-      return @context = new_context unless block_given?
-
       previous = @context
       @context = new_context
       begin
@@ -72,7 +82,7 @@ module ArchivesSpace
     def request(method, path, options = {})
       sleep config.throttle
       options = options.dup
-      options[:headers] = {TOKEN => token} if token
+      options[:headers] = options.fetch(:headers, {}).merge(TOKEN => token) if token
       Request.new(context, config, method, path, options).execute
     end
   end

data/lib/archivesspace/client/request.rb

@@ -17,6 +17,7 @@ module ArchivesSpace
       @options = options.dup
 
       @options[:headers] = DEFAULT_HEADERS.merge(@options.fetch(:headers, {}))
+      @options[:headers].delete("Content-Type") if @options[:multipart]
       @options[:headers]["User-Agent"] = "#{Client::NAME}/#{Client::VERSION}"
 
       @options[:verify] = config.verify_ssl

data/lib/archivesspace/client/version.rb

@@ -2,6 +2,6 @@
 
 module ArchivesSpace
   class Client
-    VERSION = "0.5.1"
+    VERSION = "0.7.0"
   end
 end

data/spec/archivesspace/client_spec.rb

@@ -141,6 +141,39 @@ describe ArchivesSpace::Client do
       expect(client.context).to eq "repositories/2"
     end
 
+    it "scopes to the global repository within a block and restores afterwards" do
+      client.repository 2
+      client.repository(nil) do
+        expect(client.context).to be_nil
+      end
+      expect(client.context).to eq "repositories/2"
+    end
+
+    it "scopes to the global repository when called with no id and a block" do
+      client.repository 2
+      client.repository do
+        expect(client.context).to be_nil
+      end
+      expect(client.context).to eq "repositories/2"
+    end
+
+    it "nests a no-arg global block inside a repository block and restores both contexts" do
+      client.repository(2) do
+        expect(client.context).to eq "repositories/2"
+        client.repository do
+          expect(client.context).to be_nil
+        end
+        expect(client.context).to eq "repositories/2"
+      end
+      expect(client.context).to be_nil
+    end
+
+    it "restores the previous repository context even if a nil-scoped block raises" do
+      client.repository 2
+      expect { client.repository(nil) { raise "boom" } }.to raise_error("boom")
+      expect(client.context).to eq "repositories/2"
+    end
+
     it "restores the context even if the block raises" do
       expect { client.repository(2) { raise "boom" } }.to raise_error("boom")
       expect(client.context).to be_nil
@@ -176,6 +209,24 @@ describe ArchivesSpace::Client do
       client.get("resources", opts)
       expect(opts).to eq(caller_opts)
     end
+
+    it "posts a file (as multipart form data) with session token" do
+      client.token = "abc123"
+      stub = stub_request(:post, "#{DEFAULT_BASE_URI}/repositories/2/jobs_with_files")
+        .with { |req|
+          req.headers["Content-Type"].start_with?("multipart/form-data; boundary=") &&
+            req.headers["X-Archivesspace-Session"] == "abc123" &&
+            req.body.include?('name="files[]"; filename="client_spec.rb"') &&
+            req.body.include?('name="job"')
+        }
+        .to_return(status: 200, body: "{}", headers: {"Content-Type" => "application/json"})
+      File.open(__FILE__) do |file|
+        client.repository(2) do
+          client.post_multipart("jobs_with_files", {job: {jsonmodel_type: "job"}, files: [file]})
+        end
+      end
+      expect(stub).to have_been_requested
+    end
   end
 
   describe "URL construction" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: archivesspace-client
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Mark Cooper
@@ -145,30 +145,30 @@ dependencies:
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -223,6 +223,7 @@ files:
 - examples/templates.rb
 - examples/test_connection.rb
 - examples/update_feed.rb
+- examples/upload_ead.rb
 - examples/user_groups.rb
 - exe/asclient
 - features/exec.feature
@@ -269,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.22
 specification_version: 4
 summary: Interact with ArchivesSpace via the API.
 test_files: []