dor-services-client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b45f21acc65f3b29c81ebf03e4512ee40c5003a315ff47feae0996d15d29d595
-  data.tar.gz: 2b2097c966dedfa7a0fc48d1b6833dd7ce635404e881672b92068d4dcd25eb6b
+  metadata.gz: d0938b1979de1f6767e88044a77182623502a0ee923d445fd11d892f83c9c81c
+  data.tar.gz: d091617c14b075d111980b1052ab0662382362bbbdd2ffe943609c4d94f997ee
 SHA512:
-  metadata.gz: 96db3a5aa59b83229cd041a1940fdc04e0a288b956913bafb0ba5ea00c6bbab2647d4fb5d8d6cd96c5a4f1f82ec7a74e1d7621f37bd9900503a550f7b3d08762
-  data.tar.gz: d1943ff6479e2cc78a482fea8b51cc532ed6b96ea62db2ee9f1ff76effe23b0cf52c0045715b3bc9115fe4be6f5166f37839f9c4e5900058b9451fcb00d381cb
+  metadata.gz: 121eecbb6172914d1bd345167ae7f92064c815c17634f2e017cf1c39617368da597e4d0cb9598c7d907cff64e3d7740d4916f174ba3d1c33b5b2e57b7eb66087
+  data.tar.gz: 99ce5863977ec58b8b315ed91867eeb8c1f2f31efe763f045ca0519676d0b03842bdf9095f67bee5e9ea5bd041c3ddf939c26dd792d68f645eabd591594e4b67

data/dor-services-client.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '~> 5.0'
+  spec.add_dependency 'activesupport', '>= 4.2', '< 6'
   spec.add_dependency 'faraday', '~> 0.15'
 
   spec.add_development_dependency 'bundler', '~> 1.17'

data/lib/dor/services/client.rb

@@ -4,6 +4,7 @@ require 'dor/services/client/version'
 require 'singleton'
 require 'faraday'
 require 'active_support/core_ext/hash/indifferent_access'
+require 'dor/services/client/versioned_service'
 require 'dor/services/client/files'
 require 'dor/services/client/objects'
 require 'dor/services/client/release_tags'
@@ -15,30 +16,36 @@ module Dor
     class Client
       class Error < StandardError; end
 
+      DEFAULT_VERSION = 'v1'
+
       include Singleton
 
       def objects
-        @objects ||= Objects.new(connection: connection)
+        @objects ||= Objects.new(connection: connection, version: DEFAULT_VERSION)
       end
 
       def files
-        @files ||= Files.new(connection: connection)
+        @files ||= Files.new(connection: connection, version: DEFAULT_VERSION)
       end
 
       def workflow
-        @workflow ||= Workflow.new(connection: connection)
+        @workflow ||= Workflow.new(connection: connection, version: DEFAULT_VERSION)
       end
 
       def workspace
-        @workspace ||= Workspace.new(connection: connection)
+        @workspace ||= Workspace.new(connection: connection, version: DEFAULT_VERSION)
       end
 
       def release_tags
-        @release_tags ||= ReleaseTags.new(connection: connection)
+        @release_tags ||= ReleaseTags.new(connection: connection, version: DEFAULT_VERSION)
       end
 
-      def self.configure(url:)
+      def self.configure(url:, username: nil, password: nil)
         instance.url = url
+        instance.username = username
+        instance.password = password
+        # Force connection to be re-established when `.configure` is called
+        instance.connection = nil
       end
 
       # Creates a new object in DOR
@@ -97,16 +104,24 @@ module Dor
         instance.objects.publish(object: object)
       end
 
-      attr_writer :url
+      attr_writer :url, :username, :password, :connection
 
       private
 
+      attr_reader :username, :password
+
       def url
         @url || raise(Error, 'url has not yet been configured')
       end
 
       def connection
-        @connection ||= Faraday.new(url)
+        @connection ||= Faraday.new(url) do |conn|
+          # @note when username & password are nil, this line is required else
+          #       the Faraday instance will be passed an empty block, which
+          #       causes the adapter not to be set. Thus, everything breaks.
+          conn.adapter    Faraday.default_adapter
+          conn.basic_auth username, password if username && password
+        end
       end
     end
   end

data/lib/dor/services/client/files.rb

@@ -4,14 +4,10 @@ module Dor
   module Services
     class Client
       # API calls relating to files
-      class Files
-        def initialize(connection:)
-          @connection = connection
-        end
-
+      class Files < VersionedService
         def retrieve(object:, filename:)
           resp = connection.get do |req|
-            req.url "v1/objects/#{object}/contents/#{filename}"
+            req.url "#{version}/objects/#{object}/contents/#{filename}"
           end
           return unless resp.success?
 
@@ -20,17 +16,13 @@ module Dor
 
         def list(object:)
           resp = connection.get do |req|
-            req.url "v1/objects/#{object}/contents"
+            req.url "#{version}/objects/#{object}/contents"
           end
           return [] unless resp.success?
 
           json = JSON.parse(resp.body)
           json['items'].map { |item| item['name'] }
         end
-
-        private
-
-        attr_reader :connection
       end
     end
   end

data/lib/dor/services/client/objects.rb

@@ -4,18 +4,12 @@ module Dor
   module Services
     class Client
       # API calls that are about a repository object
-      class Objects
-        def initialize(connection:)
-          @connection = connection
-        end
-
-        attr_reader :connection
-
+      class Objects < VersionedService
         # Creates a new object in DOR
         # @return [HashWithIndifferentAccess] the response, which includes a :pid
         def register(params:)
           resp = connection.post do |req|
-            req.url 'v1/objects'
+            req.url "#{version}/objects"
             req.headers['Content-Type'] = 'application/json'
             # asking the service to return JSON (else it'll be plain text)
             req.headers['Accept'] = 'application/json'
@@ -32,7 +26,7 @@ module Dor
         # @return [boolean] true on success
         def publish(object:)
           resp = connection.post do |req|
-            req.url "v1/objects/#{object}/publish"
+            req.url "#{version}/objects/#{object}/publish"
           end
           raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
 

data/lib/dor/services/client/release_tags.rb

@@ -4,13 +4,7 @@ module Dor
   module Services
     class Client
       # API calls that are about a repository object
-      class ReleaseTags
-        def initialize(connection:)
-          @connection = connection
-        end
-
-        attr_reader :connection
-
+      class ReleaseTags < VersionedService
         # Creates a new release tag for the object
         # @param object [String] the pid for the object
         # @param release [Boolean]
@@ -27,7 +21,7 @@ module Dor
             release: release
           }
           resp = connection.post do |req|
-            req.url "v1/objects/#{object}/release_tags"
+            req.url "#{version}/objects/#{object}/release_tags"
             req.headers['Content-Type'] = 'application/json'
             req.body = params.to_json
           end

data/lib/dor/services/client/version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '0.3.0'
+      VERSION = '0.4.0'
     end
   end
 end

data/lib/dor/services/client/versioned_service.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # @abstract API calls to a versioned endpoint
+      class VersionedService
+        def initialize(connection:, version:)
+          @connection = connection
+          @version = version
+        end
+
+        private
+
+        attr_reader :connection, :version
+      end
+    end
+  end
+end

data/lib/dor/services/client/workflow.rb

@@ -4,13 +4,7 @@ module Dor
   module Services
     class Client
       # API calls that are about workflow
-      class Workflow
-        def initialize(connection:)
-          @connection = connection
-        end
-
-        attr_reader :connection
-
+      class Workflow < VersionedService
         # Begin a new workflow
         # @param object [String] the pid for the object
         # @param wf_name [String] the name of the workflow
@@ -18,7 +12,7 @@ module Dor
         # @return nil
         def create(object:, wf_name:)
           resp = connection.post do |req|
-            req.url "v1/objects/#{object}/apo_workflows/#{wf_name}"
+            req.url "#{version}/objects/#{object}/apo_workflows/#{wf_name}"
           end
           raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?
         end

data/lib/dor/services/client/workspace.rb

@@ -4,13 +4,7 @@ module Dor
   module Services
     class Client
       # API calls that are about the DOR workspace
-      class Workspace
-        def initialize(connection:)
-          @connection = connection
-        end
-
-        attr_reader :connection
-
+      class Workspace  < VersionedService
         # Initializes a new workspace
         # @param object [String] the pid for the object
         # @param source [String] the path to the object
@@ -18,7 +12,7 @@ module Dor
         # @return nil
         def create(object:, source:)
           resp = connection.post do |req|
-            req.url "v1/objects/#{object}/initialize_workspace"
+            req.url "#{version}/objects/#{object}/initialize_workspace"
             req.params['source'] = source
           end
           raise Error, "#{resp.reason_phrase}: #{resp.status} (#{resp.body})" unless resp.success?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-19 00:00:00.000000000 Z
+date: 2018-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +139,7 @@ files:
 - lib/dor/services/client/objects.rb
 - lib/dor/services/client/release_tags.rb
 - lib/dor/services/client/version.rb
+- lib/dor/services/client/versioned_service.rb
 - lib/dor/services/client/workflow.rb
 - lib/dor/services/client/workspace.rb
 homepage: https://github.com/sul-dlss/dor-services-client