preservation-client 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2b61bc152d52b868d7274c7e29753dca42e4547f04c836766922bad0eca4ed9
-  data.tar.gz: 36f04a3919075d95729a6b74108f4acb9c5bb68f6625e4fc0e6b5a19f16fc52d
+  metadata.gz: dfb058593a0636a69c8a496a846dbfdcee34ebe79475545c80999642dffc5ffd
+  data.tar.gz: c0c4a0d3c0994116ff61648fcba67575adcc144edaacac0e6986dc81cf4fd117
 SHA512:
-  metadata.gz: 7750ce3cd4ef6df3ffe47dfb8b1f693894dff7dc9ad776ade1d703447c8dc52ce00464ac780d9870c93dfbf5dddbe9bd5b7a6977aeebb80876112aa31e5773b4
-  data.tar.gz: 3a280db80ba0163894c8510238af78337866e853f09d3a528e097046d7f7c44d5f8f69805d5d67e993eafb76fc0cff9f3d53ca63ed1549941b3d72ceb7ff69fb
+  metadata.gz: d742c45557b5bd9e2c8bcdee76bd24149ab6b4b225772cbbbcb7ab1f1e35a28b6f6951869c9a4e3443970562824a824dd9cdc83f06a4499fbdcdf560f992d79a
+  data.tar.gz: 8d0983ba3bc0d3c0def903983a118a462b496b1397d5b235c08bca37a63186a3a169fca293657acaa0c8039b52480d13f7485d2d29ba65bbba48248510e70f22

data/.travis.yml

@@ -8,7 +8,7 @@ env:
   - "RAILS_VERSION=5.2.3"
   - "RAILS_VERSION=6.0.0"
 
-before_install: gem install bundler -v 2.0.2
+before_install: gem install bundler -v 2.1.2
 
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

data/README.md

@@ -37,7 +37,7 @@ end
 private
 
 def client
-  @client ||= Preservation::Client.configure(url: Settings.preservation_catalog.url)
+  @client ||= Preservation::Client.configure(url: Settings.preservation_catalog.url, token: Settings.preservation_catalog.token)
 end
 ```
 
@@ -47,7 +47,7 @@ OR
 require 'preservation/client'
 
 def initialize
-  Preservation::Client.configure(url: Settings.preservation_catalog.url)
+  Preservation::Client.configure(url: Settings.preservation_catalog.url, token: Settings.preservation_catalog.token)
 end
 
 def do_the_thing
@@ -55,7 +55,9 @@ def do_the_thing
 end
 ```
 
-Note that the client may **not** be used without first having been configured, and the `url` keyword is **required**.
+Note that the client may **not** be used without first having been configured, and both the `url` and `token` keywords are **required**.
+
+See https://github.com/sul-dlss/preservation_catalog#api for info on obtaining a valid API token.
 
 Note that the preservation service is behind a firewall.
 

data/lib/preservation/client.rb

@@ -27,6 +27,7 @@ module Preservation
     class ConnectionFailedError < Error; end
 
     DEFAULT_API_VERSION = 'v1'
+    TOKEN_HEADER = 'Authorization'
 
     include Singleton
 
@@ -42,8 +43,10 @@ module Preservation
 
     class << self
       # @param [String] url
-      def configure(url:)
+      # @param [String] token a bearer token for HTTP authentication
+      def configure(url:, token:)
         instance.url = url
+        instance.token = token
 
         # Force connection to be re-established when `.configure` is called
         instance.connection = nil
@@ -54,7 +57,7 @@ module Preservation
       delegate :objects, :update, to: :instance
     end
 
-    attr_writer :url, :connection
+    attr_writer :url, :connection, :token
     delegate :update, to: :catalog
 
     private
@@ -63,6 +66,10 @@ module Preservation
       @url || raise(Error, 'url has not yet been configured')
     end
 
+    def token
+      @token || raise(Error, 'auth token has not been configured')
+    end
+
     def connection
       @connection ||= Faraday.new(url) do |builder|
         builder.use ErrorFaradayMiddleware
@@ -70,6 +77,7 @@ module Preservation
         builder.use Faraday::Response::RaiseError # raise exceptions on 40x, 50x responses
         builder.adapter Faraday.default_adapter
         builder.headers[:user_agent] = user_agent
+        builder.headers[TOKEN_HEADER] = "Bearer #{token}"
       end
     end
 

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '2.2.0'
+    VERSION = '3.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A thin client for getting info from SDR preservation.