uploadcare-ruby 4.3.6 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 274b1a99804055c03bbd9642e79b3ae718ad95711a3a0066a95199929c6d42ea
-  data.tar.gz: 15240af810033c45a69c96dfde93b949654d55fbf370bb3b046122d17a6b0dd1
+  metadata.gz: 35dc34779d62684051b582e460d75f4e58acaa5f2c7372869b9fa753eea117e6
+  data.tar.gz: ac06dcf3b4921a8199849111bbd38d1ae7cfad4ad1f5d0adb43a06c885102045
 SHA512:
-  metadata.gz: '0487759949cdbbf23e9b5d61b6e49bd005a6e895d42a37ddd2c24852537a594ae740c14c073079a22c19674c184fb50f55f5e1b2234e4e3f90b54f5fc5ae46a8'
-  data.tar.gz: fbd9198af4353d674df9795294c38cd486dab631b1de3824f5b02368d081fc199ba981092b6f074d06752d99f9b1574737005d0087b4c956ddd86af1562f8f87
+  metadata.gz: f189a6b962f27441c40f40f56db9fda78aa492e8d1ad1703663b85a6f6eb7df35f23fdab89c475ecbaec5701c0fc838d8d80f68ca7ee780c9037843906ade31c
+  data.tar.gz: cf4a88871447ed9733cfc777486ee77d6113a55f523b3a6e6eac0ec9340f0652ec85c01434544352094f7672283879a130d6816df31c2a1ba5d8897176ed7dbb

data/.github/workflows/ruby.yml

@@ -16,17 +16,17 @@ jobs:
     strategy:
       matrix:
         ruby-version:
-          - 2.7
           - 3.0
           - 3.1
           - 3.2
+          - 3.3
 
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        bundler: 2.4
+        bundler: latest
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
     - name: Run tests
@@ -41,8 +41,7 @@ jobs:
     strategy:
       matrix:
         ruby-version:
-          - 2.7
-          - 3.2
+          - 3.3
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby

data/.rubocop.yml

@@ -1,6 +1,6 @@
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 Layout/LineLength:
   Max: 120
@@ -14,10 +14,6 @@ Style/HashTransformKeys:
     - 'lib/uploadcare/client/conversion/video_conversion_client.rb'
     - 'lib/uploadcare/entity/file.rb'
 
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'uploadcare-ruby.gemspec'
-
 Metrics/BlockLength:
   Exclude:
     - 'bin/'

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 4.4.0 — 2024-03-09
+
+### Breaking 
+
+* Drop support of unmaintainable Ruby versions < 3.x.
+
+### Fixed
+
+* Update locations where Dry::Monads structure has changed.
+* Sign URL uploads if configured (#139).
+* Start returning proper error message when raising RequestError in poll_upload_response, to hint to users what is going on. Fixes #141.
+* When polling, raise if an error is returned (#142).
+* Fix documentation about original file url on simple file upload.
+
+### Changed
+* Support params in Rest client and in file info method, to allow passing custom params like "include=appdata" in `Uploadcare::File.file` calls. Closes #132.
+
+
 ## 4.3.6 — 2023-11-18
 
 ### Fixed

data/Gemfile

@@ -2,12 +2,12 @@
 
 source 'https://rubygems.org'
 
-gem 'byebug', '~> 11.1'
-gem 'rake', '~> 13.0'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 1.48'
-gem 'vcr', '~> 6.1'
-gem 'webmock', '~> 3.18'
+gem 'byebug'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'vcr'
+gem 'webmock'
 
 # Specify your gem's dependencies in uploadcare-ruby.gemspec
 gemspec

data/README.md

@@ -34,7 +34,7 @@ wrapping Upload and REST APIs.
 * [Useful links](#useful-links)
 
 ## Requirements
-* ruby 2.7+
+* ruby 3.0+
 
 ## Compatibility
 
@@ -101,8 +101,8 @@ Using Uploadcare is simple, and here are the basics of handling files.
 # => "dc99200d-9bd6-4b43-bfa9-aa7bfaefca40"
 
 # URL for the file, can be used with your website or app right away
-@uc_file.url
-# => "https://ucarecdn.com/dc99200d-9bd6-4b43-bfa9-aa7bfaefca40/"
+@uc_file.original_file_url
+# => "https://ucarecdn.com/dc99200d-9bd6-4b43-bfa9-aa7bfaefca40/your-file.png"
 ```
 
 Your might then want to store or delete the uploaded file. Storing files could
@@ -134,7 +134,7 @@ Uploadcare::Uploader.upload("https://placekitten.com/96/139")
 There are explicit ways to select upload type:
 
 ```ruby
-files = [File.open("1.jpg"), File.open("1.jpg"]
+files = [File.open("1.jpg"), File.open("1.jpg")]
 Uploadcare::Uploader.upload_files(files)
 
 Uploadcare::Uploader.upload_from_url("https://placekitten.com/96/139")
@@ -208,10 +208,10 @@ Entities are representations of objects in Uploadcare cloud.
 
 #### File
 
-File entity contains its metadata.
+File entity contains its metadata. It also supports `include` param to include additional fields to the file object, such as: "appdata".  
 
 ```ruby
-@file = Uploadcare::File.file("FILE_ID_IN_YOUR_PROJECT")
+@file = Uploadcare::File.file("FILE_ID_IN_YOUR_PROJECT", include: "appdata")
 {
   "datetime_removed"=>nil,
   "datetime_stored"=>"2018-11-26T12:49:10.477888Z",

data/lib/uploadcare/client/conversion/base_conversion_client.rb

@@ -37,9 +37,9 @@ module Uploadcare
 
           parsed_body = JSON.parse(response_body, symbolize_names: true)
           errors = parsed_body[:error] || parsed_body[:problems]
-          return Dry::Monads::Failure(errors) unless errors.nil? || errors.empty?
+          return Dry::Monads::Result::Failure.call(errors) unless errors.nil? || errors.empty?
 
-          Dry::Monads::Success(parsed_body)
+          Dry::Monads::Result::Success.call(parsed_body)
         end
 
         # Prepares body for convert_many method

data/lib/uploadcare/client/file_client.rb

@@ -16,8 +16,8 @@ module Uploadcare
 
       # Acquire file info
       # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/fileInfo
-      def info(uuid)
-        get(uri: "/files/#{uuid}/")
+      def info(uuid, params = {})
+        get(uri: "/files/#{uuid}/", params: params)
       end
       alias file info
 

data/lib/uploadcare/client/rest_client.rb

@@ -27,8 +27,11 @@ module Uploadcare
         request_headers = Param::AuthenticationHeader.call(method: method.upcase, uri: uri,
                                                            content_type: headers[:'Content-Type'], **options)
         handle_throttling do
-          send("api_struct_#{method.downcase}", path: remove_trailing_slash(uri),
-                                                headers: request_headers, body: options[:content])
+          send("api_struct_#{method.downcase}",
+               path: remove_trailing_slash(uri),
+               headers: request_headers,
+               body: options[:content],
+               params: options[:params])
         end
       end
 

data/lib/uploadcare/client/rest_group_client.rb

@@ -17,7 +17,7 @@ module Uploadcare
           end
         end
 
-        Dry::Monads::Success(nil)
+        Dry::Monads::Result::Success.call(nil)
       end
 
       # Get a file group by its ID.

data/lib/uploadcare/client/uploader_client.rb

@@ -3,6 +3,7 @@
 require_relative 'upload_client'
 require 'retries'
 require 'param/upload/upload_params_generator'
+require 'param/upload/signature_generator'
 
 module Uploadcare
   module Client
@@ -42,7 +43,7 @@ module Uploadcare
         uploaded_response = poll_upload_response(token_response.success[:token])
         return uploaded_response if uploaded_response.success[:status] == 'error'
 
-        Dry::Monads::Success(files: [uploaded_response.success])
+        Dry::Monads::Result::Success.call(files: [uploaded_response.success])
       end
 
       # Check upload status
@@ -75,12 +76,22 @@ module Uploadcare
       def poll_upload_response(token)
         with_retries(max_tries: Uploadcare.config.max_request_tries,
                      base_sleep_seconds: Uploadcare.config.base_request_sleep,
-                     max_sleep_seconds: Uploadcare.config.max_request_sleep) do
+                     max_sleep_seconds: Uploadcare.config.max_request_sleep,
+                     rescue: RetryError) do
           response = get_upload_from_url_status(token)
-          raise RequestError if %w[progress waiting unknown].include?(response.success[:status])
+          handle_polling_response(response)
+        end
+      end
 
-          response
+      def handle_polling_response(response)
+        case response.success[:status]
+        when 'error'
+          raise RequestError, response.success[:error]
+        when 'progress', 'waiting', 'unknown'
+          raise RetryError, response.success[:error] || 'Upload is taking longer than expected. Try increasing the max_request_tries config if you know your file uploads will take more time.' # rubocop:disable Layout/LineLength
         end
+
+        response
       end
 
       # Prepares body for upload_many method
@@ -96,13 +107,13 @@ module Uploadcare
 
       # Prepare upload_from_url initial request body
       def upload_from_url_body(url, options = {})
-        HTTP::FormData::Multipart.new(
-          options.merge(
-            'pub_key' => Uploadcare.config.public_key,
-            'source_url' => url,
-            'store' => store_value(options[:store])
-          )
-        )
+        opts = {
+          'pub_key' => Uploadcare.config.public_key,
+          'source_url' => url,
+          'store' => store_value(options[:store])
+        }
+        opts.merge!(Param::Upload::SignatureGenerator.call) if Uploadcare.config.sign_uploads
+        HTTP::FormData::Multipart.new(options.merge(opts))
       end
 
       def store_value(store)

data/lib/uploadcare/exception/request_error.rb

@@ -3,7 +3,6 @@
 module Uploadcare
   module Exception
     # Standard error for invalid API responses
-    class RequestError < StandardError
-    end
+    class RequestError < StandardError; end
   end
 end

data/lib/uploadcare/exception/retry_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Uploadcare
+  module Exception
+    # Standard error to raise when needing to retry a request
+    class RetryError < StandardError; end
+  end
+end

data/lib/uploadcare/param/secure_auth_header.rb

@@ -1,26 +1,28 @@
 # frozen_string_literal: true
 
 require 'digest/md5'
+require 'addressable/uri'
 
 module Uploadcare
   module Param
     # This object returns headers needed for authentication
     # This authentication method is more secure, but more tedious
     class SecureAuthHeader
-      # @see https://uploadcare.com/docs/api_reference/rest/requests_auth/#auth-uploadcare
-      def self.call(options = {})
-        @method = options[:method]
-        @body = options[:content] || ''
-        @content_type = options[:content_type]
-        @uri = options[:uri]
-        @date_for_header = timestamp
-        {
-          Date: @date_for_header,
-          Authorization: "Uploadcare #{Uploadcare.config.public_key}:#{signature}"
-        }
-      end
-
       class << self
+        # @see https://uploadcare.com/docs/api_reference/rest/requests_auth/#auth-uploadcare
+        def call(options = {})
+          @method = options[:method]
+          @body = options[:content] || ''
+          @content_type = options[:content_type]
+          @uri = make_uri(options)
+
+          @date_for_header = timestamp
+          {
+            Date: @date_for_header,
+            Authorization: "Uploadcare #{Uploadcare.config.public_key}:#{signature}"
+          }
+        end
+
         def signature
           content_md5 = Digest::MD5.hexdigest(@body)
           sign_string = [@method, content_md5, @content_type, @date_for_header, @uri].join("\n")
@@ -31,6 +33,18 @@ module Uploadcare
         def timestamp
           Time.now.gmtime.strftime('%a, %d %b %Y %H:%M:%S GMT')
         end
+
+        private
+
+        def make_uri(options)
+          if options[:params] && !options[:params].empty?
+            uri = Addressable::URI.parse options[:uri]
+            uri.query_values = uri.query_values(Array).to_a.concat(options[:params].to_a)
+            uri.to_s
+          else
+            options[:uri]
+          end
+        end
       end
     end
   end

data/lib/uploadcare/ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uploadcare
-  VERSION = '4.3.6'
+  VERSION = '4.4.0'
 end

data/lib/uploadcare.rb

@@ -6,6 +6,7 @@ require 'ruby/version'
 # Exceptions
 require 'exception/throttle_error'
 require 'exception/request_error'
+require 'exception/retry_error'
 
 # Entities
 require 'entity/entity'
@@ -33,18 +34,6 @@ require 'signed_url_generators/base_generator'
 module Uploadcare
   extend Dry::Configurable
 
-  # NOTE: The dry-configurable gem has introduced the `default` keyword argument
-  # and deprecated the positional default argument in v0.13.0, which requires
-  # Ruby >= 2.6.0. In order to provide backwards compatibility and not disable
-  # deprecation warnings, we override the dry-configurable's `setting` DSL method.
-  def self.setting(name, default:, **options, &block)
-    if RUBY_VERSION < '2.6'
-      super name, default, &block
-    else
-      super
-    end
-  end
-
   setting :public_key,                default: ENV.fetch('UPLOADCARE_PUBLIC_KEY', '')
   setting :secret_key,                default: ENV.fetch('UPLOADCARE_SECRET_KEY', '')
   setting :auth_type,                 default: 'Uploadcare'

data/uploadcare-ruby.gemspec

@@ -43,6 +43,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib', 'lib/uploadcare', 'lib/uploadcare/rest']
 
+  spec.required_ruby_version = '>= 3.0'
+
   spec.add_dependency 'mimemagic', '~> 0.4'
   spec.add_dependency 'parallel', '~> 1.22'
   spec.add_dependency 'retries', '~> 0.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uploadcare-ruby
 version: !ruby/object:Gem::Version
-  version: 4.3.6
+  version: 4.4.0
 platform: ruby
 authors:
 - "@dmitrijivanchenko (Dmitrij Ivanchenko), @T0mbery (Andrey Aksenov)"
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-18 00:00:00.000000000 Z
+date: 2024-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimemagic
@@ -132,6 +132,7 @@ files:
 - lib/uploadcare/entity/webhook.rb
 - lib/uploadcare/exception/conversion_error.rb
 - lib/uploadcare/exception/request_error.rb
+- lib/uploadcare/exception/retry_error.rb
 - lib/uploadcare/exception/throttle_error.rb
 - lib/uploadcare/param/authentication_header.rb
 - lib/uploadcare/param/conversion/document/processing_job_url_builder.rb
@@ -168,14 +169,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for uploadcare API