preservation-client 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5935f4397931242b724daedc842b1fdbdb8d84de5a0a61c0bd08b00064c4396
-  data.tar.gz: d9ffeef6b17897ebad03ddab8508c62caaa247a35ce380e4ba5b543cf8244a04
+  metadata.gz: 6e05a1561753b1ba55bf0d15d239ab6e740430818548143e330327e32e44da7f
+  data.tar.gz: 8385f5b0f5c7fdbf0ee69e9c0f182a899fd36ea4e41b1d1f5d7f3a008e9e207f
 SHA512:
-  metadata.gz: 5afaae843e9fd36aac08b07d514e307993864222a60210e94537f3cfa25f278bd7eccbdc7af6c1bc90b9987ca0bce3e78330092408acc3bf125e6f9685fea28f
-  data.tar.gz: 4177db6c38c34714601a481ef8c6b4b89de04ce607ef766db3af6f136fd497675679a17080c1404fddc5c91a29d85ce2af1e18e09d5d0abcb9b10b47f3e1355d
+  metadata.gz: af564b18b850e9a4528743844dfc062fdb6b848f3725470f86e6b46e4c3c1e640952c736dfbad40985bdacee81c78ca344a2fe74455df862ab3ee44263a65981
+  data.tar.gz: 83944e43ffc7538068655d5dbf9385bb137e6a978e1307fb43285f574ddda510a705ce8ba64077bb6573cea67f0cae5a2b8e05e094df5793f518b52f6eec2762

data/lib/preservation/client/objects.rb

@@ -50,8 +50,9 @@ module Preservation
       # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
       # @param [String] filepath - the path of the file relative to the moab content directory
       # @param [String] version - the version of the file requested (defaults to nil for latest version)
-      def content(druid:, filepath:, version: nil)
-        file(druid, 'content', filepath, version)
+      # @param [Proc] on_data a block, if provided is called to do streaming responses
+      def content(druid:, filepath:, version: nil, on_data: nil)
+        file(druid, 'content', filepath, version, on_data: on_data)
       end
 
       # retrieve a manifest file from a Moab object
@@ -83,10 +84,11 @@ module Preservation
       # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
       # @param [String] category - one of 'manifest', 'metadata' or 'content'
       # @param [String] filepath - the path of the file relative to the moab category directory
-      # @param [String] version - the version of the file requested (defaults to nil for latest version)
+      # @param [String] version - the version of the file requested
+      # @param [Proc] on_data a block, if provided is called to do streaming responses
       # @return the retrieved file
-      def file(druid, category, filepath, version = nil)
-        get("objects/#{druid}/file", category: category, filepath: filepath, version: version)
+      def file(druid, category, filepath, version, on_data: nil)
+        get("objects/#{druid}/file", { category: category, filepath: filepath, version: version }, on_data: on_data)
       end
     end
   end

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '3.1.0'
+    VERSION = '3.2.0'
   end
 end

data/lib/preservation/client/versioned_api_service.rb

@@ -15,7 +15,7 @@ module Preservation
 
       # @param path [String] path to be appended to connection url (no leading slash)
       def get_json(path, object_id)
-        req_url = api_version.present? ? "#{api_version}/#{path}" : path
+        req_url = "#{api_version}/#{path}"
         resp = connection.get do |req|
           req.url req_url
           req.headers['Content-Type'] = 'application/json'
@@ -36,29 +36,52 @@ module Preservation
       end
 
       # @param path [String] path to be appended to connection url (no leading slash)
-      # @param params [Hash] optional params
-      def get(path, params)
-        http_response(:get, path, params)
+      # @param params [Hash] optional request parameters
+      # @param on_data [Proc] a callback to use when a streaming response is desired.
+      def get(path, params, on_data:)
+        return http_response(:get, path, params) unless on_data
+
+        connection.get("#{api_version}/#{path}", params) do |req|
+          req.options.on_data = on_data
+        end
       end
 
       # @param path [String] path to be appended to connection url (no leading slash)
-      # @param params [Hash] optional params
+      # @param params [Hash] optional request parameters
       def post(path, params)
         http_response(:post, path, params)
       end
 
-      # @param method [Symbol] :get or :post
       # @param path [String] path to be appended to connection url (no leading slash)
-      # @param params [Hash] optional params
+      # @param params [Hash] optional request parameters
+      def patch(path, params)
+        http_response(:patch, path, params)
+      end
+
+      # @param path [String] path to be appended to connection url (no leading slash)
+      # @param params [Hash] optional request parameters
+      def put(path, params)
+        http_response(:put, path, params)
+      end
+
+      # @param path [String] path to be appended to connection url (no leading slash)
+      # @param params [Hash] optional request parameters
+      def delete(path, params)
+        http_response(:delete, path, params)
+      end
+
+      # @param method [Symbol] a symbol representing an HTTP method: :get, :post, :patch, :put, :delete
+      # @param path [String] path to be appended to connection url (no leading slash)
+      # @param params [Hash] optional request parameters
       def http_response(method, path, params)
-        req_url = api_version.present? ? "#{api_version}/#{path}" : path
+        req_url = "#{api_version}/#{path}"
         resp =
           case method
-          when :get
-            connection.get(req_url, params)
-          when :post
+          when :delete, :get
+            connection.public_send(method, req_url, params)
+          when :patch, :post, :put
             request_json = params.to_json if params&.any?
-            connection.post(req_url, request_json, 'Content-Type' => 'application/json')
+            connection.public_send(method, req_url, request_json, 'Content-Type' => 'application/json')
           end
         return resp.body if resp.success?
 

data/preservation-client.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.77.0'
   spec.add_development_dependency 'simplecov'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,16 +110,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A thin client for getting info from SDR preservation.