uploadcare-ruby 4.3.6 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 274b1a99804055c03bbd9642e79b3ae718ad95711a3a0066a95199929c6d42ea
-  data.tar.gz: 15240af810033c45a69c96dfde93b949654d55fbf370bb3b046122d17a6b0dd1
+  metadata.gz: 1cd6e50f0d12bc1cd65c531fa7e5656e41149433c042aedeb5d8899425ae6e53
+  data.tar.gz: baa9f7cc358eba65895e608073d2ad188bc68ff1b5a44b8c51e6d5b2e72fc8bb
 SHA512:
-  metadata.gz: '0487759949cdbbf23e9b5d61b6e49bd005a6e895d42a37ddd2c24852537a594ae740c14c073079a22c19674c184fb50f55f5e1b2234e4e3f90b54f5fc5ae46a8'
-  data.tar.gz: fbd9198af4353d674df9795294c38cd486dab631b1de3824f5b02368d081fc199ba981092b6f074d06752d99f9b1574737005d0087b4c956ddd86af1562f8f87
+  metadata.gz: eab5bac3add563b090d18e7f82e2c7c852e95ff0d99530f8a3d25ec2d9eb47f1d146d38fc3dec9335af3bb9cebb74079b5fb27d3f46c7c1971d892185607df06
+  data.tar.gz: 2edc0a691512ac31210f5fada71d7515c59ac8305c5a522e04f2f90924af313cdba4707860e8bb6d1aaeec4053cff0869f0f5f14a458d33832c57587d3ab9822

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,9 +1,11 @@
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 Layout/LineLength:
   Max: 120
+  Exclude:
+    - 'spec/**/*'
 
 Lint/IneffectiveAccessModifier:
   Enabled: false
@@ -14,16 +16,16 @@ 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/'
     - 'spec/**/*'
     - 'uploadcare-ruby.gemspec'
 
+Metrics/ModuleLength:
+  Exclude:
+    - 'spec/**/*'
+
 Metrics/MethodLength:
   Max: 20
 

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 4.4.1 — 2024-04-27
+
+### Added
+* Added `AWS Rekognition Moderation` Add-On.
+* Added an optional `wildcard` boolean parameter to the `generate_url` method of `AkamaiGenerator`.
+
+### Changed
+* File attribute `datetime_stored` is deprecated and will warn on usage from `File` object properties.
+
+### Fixed
+
+* Throw `AuthError` if current public key or secret key config are empty when accessing any of the APIs.
+* `AmakaiGenerator` has been renamed to `AkamaiGenerator` to fix typo in class name.
+
+## 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
@@ -50,7 +82,7 @@ Add support of new ruby versions
 ### Breaking Сhanges
 
 - Drop support of unmaintainable Ruby versions (2.4, 2.5, 2.6).
-- Replace unmaintainable `api_struct` with `uploadcare-api_struct` 
+- Replace unmaintainable `api_struct` with `uploadcare-api_struct`
 
 ### Added
 

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
 
@@ -95,23 +95,25 @@ Using Uploadcare is simple, and here are the basics of handling files.
 ```ruby
 @file_to_upload = File.open("your-file.png")
 
-@uc_file = Uploadcare::Uploader.upload(@file_to_upload)
+@uc_file = Uploadcare::Uploader.upload(@file_to_upload, store: "auto")
 
 @uc_file.uuid
 # => "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
-be crucial if you aren't using the “Automatic file storing” option for your
-Uploadcare project. If not stored manually or automatically, files get deleted
-within a 24-hour period.
+The `store` option can have these possible values:
+- `true`: mark the uploaded file as stored.
+- `false`: do not mark the uploaded file as stored and remove it after 24 hours.
+- `"auto"`: defers the choice of storage behavior to the [auto-store setting](https://app.uploadcare.com/projects/-/settings/#storage) for your Uploadcare project. This is the default behavior.
+
+Your might then want to store or delete the uploaded file.
 
 ```ruby
-# that's how you store a file
+# that's how you store a file, if you have uploaded the file using store: false and changed your mind later
 @uc_file.store
 # => #<Uploadcare::Api::File ...
 
@@ -128,16 +130,16 @@ Uploadcare supports multiple ways to upload files:
 # Smart upload - detects type of passed object and picks appropriate upload method
 # If you have a large file (more than 100Mb / 10485760 bytes), the uploader will automatically process it with a multipart upload
 
-Uploadcare::Uploader.upload("https://placekitten.com/96/139")
+Uploadcare::Uploader.upload("https://placekitten.com/96/139", store: "auto")
 ```
 
 There are explicit ways to select upload type:
 
 ```ruby
-files = [File.open("1.jpg"), File.open("1.jpg"]
-Uploadcare::Uploader.upload_files(files)
+files = [File.open("1.jpg"), File.open("1.jpg")]
+Uploadcare::Uploader.upload_files(files, store: 'auto')
 
-Uploadcare::Uploader.upload_from_url("https://placekitten.com/96/139")
+Uploadcare::Uploader.upload_from_url("https://placekitten.com/96/139", store: "auto")
 ```
 It is possible to track progress of the upload-from-URL process. To do that, you should specify the `async` option and get a token:
 
@@ -188,11 +190,12 @@ Options available in a block:
 
 #### Uploading options
 
-You can override global [`:autostore`](#initialization) option for each upload request:
+You can override [auto-store setting](https://app.uploadcare.com/projects/-/settings/#storage) from your Uploadcare project for each upload request:
 
 ```ruby
-@api.upload(files, store: true)
-@api.upload_from_url(url, store: :auto)
+@api.upload(files, store: true)          # mark the uploaded file as stored.
+@api.upload(files, store: false)         # do not mark the uploaded file as stored and remove it after 24 hours.
+@api.upload_from_url(url, store: "auto") # defers the choice of storage behavior to the auto-store setting.
 ```
 
 You can upload file with custom metadata, for example `subsystem` and `pet`:
@@ -208,10 +211,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_UUID", include: "appdata")
 {
   "datetime_removed"=>nil,
   "datetime_stored"=>"2018-11-26T12:49:10.477888Z",
@@ -219,11 +222,11 @@ File entity contains its metadata.
   "is_image"=>true,
   "is_ready"=>true,
   "mime_type"=>"image/jpeg",
-  "original_file_url"=>"https://ucarecdn.com/FILE_ID_IN_YOUR_PROJECT/pineapple.jpg",
+  "original_file_url"=>"https://ucarecdn.com/FILE_UUID/pineapple.jpg",
   "original_filename"=>"pineapple.jpg",
   "size"=>642,
-  "url"=>"https://api.uploadcare.com/files/FILE_ID_IN_YOUR_PROJECT/",
-  "uuid"=>"FILE_ID_IN_YOUR_PROJECT",
+  "url"=>"https://api.uploadcare.com/files/FILE_UUID/",
+  "uuid"=>"FILE_UUID",
   "variations"=>nil,
   "content_info"=>{
     "mime"=>{
@@ -322,7 +325,7 @@ File entity contains its metadata.
 The File object is also can be converted if it is a document or a video file. Imagine, you have a document file:
 
 ```ruby
-@file = Uploadcare::File.file("FILE_ID_IN_YOUR_PROJECT")
+@file = Uploadcare::File.file("FILE_UUID")
 ```
 
 To convert it to an another file, just do:
@@ -437,16 +440,16 @@ As an example, you could store unique file identifier from your system.
 
 ```ruby
 # Get file's metadata keys and values.
-Uploadcare::FileMetadata.index('FILE_ID_IN_YOUR_PROJECT')
+Uploadcare::FileMetadata.index('FILE_UUID')
 
 # Get the value of a single metadata key.
-Uploadcare::FileMetadata.show('FILE_ID_IN_YOUR_PROJECT', 'KEY')
+Uploadcare::FileMetadata.show('FILE_UUID', 'KEY')
 
 # Update the value of a single metadata key. If the key does not exist, it will be created.
-Uploadcare::FileMetadata.update('FILE_ID_IN_YOUR_PROJECT', 'KEY', 'VALUE')
+Uploadcare::FileMetadata.update('FILE_UUID', 'KEY', 'VALUE')
 
 # Delete a file's metadata key.
-Uploadcare::FileMetadata.delete('FILE_ID_IN_YOUR_PROJECT', 'KEY')
+Uploadcare::FileMetadata.delete('FILE_UUID', 'KEY')
 ```
 
 #### Group
@@ -470,6 +473,7 @@ Uploadcare::Group.rest_info(group.id)
 
 # group can be deleted by group ID.
 Uploadcare::Group.delete(group.id)
+# Note: This operation only removes the group object itself. All the files that were part of the group are left as is.
 ```
 
 #### GroupList
@@ -552,37 +556,50 @@ An `Add-On` is an application implemented by Uploadcare that accepts uploaded fi
 ##### AWS Rekognition
 
 ```ruby
-# Execute AWS Rekognition Add-On for a given target to detect labels in an image. Note: Detected labels are stored in the file's appdata.
-Uploadcare::Addons.ws_rekognition_detect_labels('FILE_ID_IN_YOUR_PROJECT')
+# Execute AWS Rekognition Add-On for a given target to detect labels in an image. 
+# Note: Detected labels are stored in the file's appdata.
+Uploadcare::Addons.ws_rekognition_detect_labels('FILE_UUID')
 
 # Check the status of AWS Rekognition.
 Uploadcare::Addons.ws_rekognition_detect_labels_status('RETURNED_ID_FROM_WS_REKOGNITION_DETECT_LABELS')
 ```
 
+##### AWS Rekognition Moderation
+
+```ruby
+# Execute AWS Rekognition Moderation Add-On for a given target to detect moderation labels in an image. 
+# Note: Detected moderation labels are stored in the file's appdata.
+
+Uploadcare::Addons.ws_rekognition_detect_moderation_labels('FILE_UUID')
+
+# Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
+Uploadcare::Addons.ws_rekognition_detect_moderation_labels_status('RETURNED_ID_FROM_WS_REKOGNITION_DETECT_MODERATION_LABELS')
+```
+
 ##### ClamAV
 
 ```ruby
 # ClamAV virus checking Add-On for a given target.
-Uploadcare::Addons.uc_clamav_virus_scan('FILE_ID_IN_YOUR_PROJECT')
+Uploadcare::Addons.uc_clamav_virus_scan('FILE_UUID')
 
-# Checking and purge infected file.
-Uploadcare::Addons.uc_clamav_virus_scan('FILE_ID_IN_YOUR_PROJECT', purge_infected: true )
+# Check and purge infected file.
+Uploadcare::Addons.uc_clamav_virus_scan('FILE_UUID', purge_infected: true )
 
-# Check the status ClamAV virus scan.
+# Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
 Uploadcare::Addons.uc_clamav_virus_scan_status('RETURNED_ID_FROM_UC_CLAMAV_VIRUS_SCAN')
 ```
 
 ##### Remove.bg
 
 ```ruby
-# Remove background image removal Add-On for a given target.
-Uploadcare::Addons.remove_bg('FILE_ID_IN_YOUR_PROJECT')
+# Execute remove.bg background image removal Add-On for a given target.
+Uploadcare::Addons.remove_bg('FILE_UUID')
 
 # You can pass optional parameters.
 # See the full list of parameters here: https://uploadcare.com/api-refs/rest-api/v0.7.0/#operation/removeBgExecute
-Uploadcare::Addons.remove_bg('FILE_ID_IN_YOUR_PROJECT', crop: true, type_level: '2')
+Uploadcare::Addons.remove_bg('FILE_UUID', crop: true, type_level: '2')
 
-# Check the status of background image removal.
+# Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
 Uploadcare::Addons.remove_bg_status('RETURNED_ID_FROM_REMOVE_BG')
 ```
 
@@ -821,15 +838,29 @@ More examples and options can be found [here](https://uploadcare.com/docs/transf
 
 You can use custom domain and CDN provider to deliver files with authenticated URLs (see [original documentation](https://uploadcare.com/docs/security/secure_delivery/)).
 
-To generate authenticated URL from the library, you should choose `Uploadcare::SignedUrlGenerators::AmakaiGenerator` (or create your generator implementation):
+To generate authenticated URL from the library, you should choose `Uploadcare::SignedUrlGenerators::AkamaiGenerator` (or create your own generator implementation):
+
 ```ruby
-generator = Uploadcare::SignedUrlGenerators::AmakaiGenerator.new(cdn_host: 'example.com', secret_key: 'secret_key'). Optional parameters: ttl: 300, algorithm: 'sha256'
+generator = Uploadcare::SignedUrlGenerators::AkamaiGenerator.new(cdn_host: 'example.com', secret_key: 'secret_key') 
+# Optional parameters: ttl: 300, algorithm: 'sha256'
 generator.generate_url(uuid, acl = optional)
 
-generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3") ->
-https://example.com/a7d5645e-5cd7-4046-819f-a6a2933bafe3/?token=exp=1649405263~acl=/a7d5645e-5cd7-4046-819f-a6a2933bafe3/~hmac=a989cae5342f17013677f5a0e6577fc5594cc4e238fb4c95eda36634eb47018b
-generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3", '/*/') ->
-https://example.com/a7d5645e-5cd7-4046-819f-a6a2933bafe3/?token=exp=1649405263~acl=/*/~hmac=3ce1152c6af8864b36d4dc721f08ca3cf0b3a20278d7f849e82c6c930d48ccc1
+generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3")
+# https://example.com/a7d5645e-5cd7-4046-819f-a6a2933bafe3/?token=exp=1649405263~acl=/a7d5645e-5cd7-4046-819f-a6a2933bafe3/~hmac=a989cae5342f17013677f5a0e6577fc5594cc4e238fb4c95eda36634eb47018b
+
+# You can pass in ACL as a second parameter to generate_url. See https://uploadcare.com/docs/security/secure-delivery/#authenticated-urls for supported acl formats
+generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3", '/*/') 
+# https://example.com/a7d5645e-5cd7-4046-819f-a6a2933bafe3/?token=exp=1649405263~acl=/*/~hmac=3ce1152c6af8864b36d4dc721f08ca3cf0b3a20278d7f849e82c6c930d48ccc1
+
+# Optionally you can use wildcard: true to generate a wildcard acl token
+generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3", wildcard: true)
+# https://example.com/a7d5645e-5cd7-4046-819f-a6a2933bafe3/?token=exp=1714233449~acl=/a7d5645e-5cd7-4046-819f-a6a2933bafe3/*~hmac=a568ee2a85dd90a8a8a1ef35ea0cc0ef0acb84fe81990edd3a06eacf10a52b4e
+ 
+# You can also pass in a custom ttl and algorithm to AkamaiGenerator
+generator = Uploadcare::SignedUrlGenerators::AkamaiGenerator.new(cdn_host: 'example.com', secret_key: 'secret_key', ttl: 10)
+generator.generate_url("a7d5645e-5cd7-4046-819f-a6a2933bafe3")
+# This generates a URL that expires in 10 seconds
+# https://example.com/a7d5645e-5cd7-4046-819f-a6a2933bafe3/?token=exp=1714233277~acl=/a7d5645e-5cd7-4046-819f-a6a2933bafe3/~hmac=f25343104aeced3004d2cc4d49807d8d7c732300b54b154c319da5283a871a71
 ```
 ## Useful links
 

data/lib/uploadcare/client/addons_client.rb

@@ -46,6 +46,19 @@ module Uploadcare
         get(uri: "/addons/remove_bg/execute/status/#{query_params(uuid)}")
       end
 
+      # Execute AWS Rekognition Moderation Add-On for a given target to detect labels in an image.
+      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Add-Ons/operation/awsRekognitionDetectModerationLabelsExecute
+      def ws_rekognition_detect_moderation_labels(uuid)
+        content = { target: uuid }.to_json
+        post(uri: '/addons/aws_rekognition_detect_moderation_labels/execute/', content: content)
+      end
+
+      # Check the status of an Add-On execution request that had been started using the Execute Add-On operation.
+      # @see https://uploadcare.com/api-refs/rest-api/v0.7.0/#tag/Add-Ons/operation/awsRekognitionDetectModerationLabelsExecutionStatus
+      def ws_rekognition_detect_moderation_labels_status(uuid)
+        get(uri: "/addons/aws_rekognition_detect_moderation_labels/execute/status/#{query_params(uuid)}")
+      end
+
       private
 
       def query_params(uuid)

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/entity/conversion/base_converter.rb

@@ -9,7 +9,7 @@ module Uploadcare
         class << self
           # Converts files
           #
-          # @param doc_params [Array] of hashes with params or [Hash]
+          # @param params [Array] of hashes with params or [Hash]
           # @option options [Boolean] :store whether to store file on servers.
           def convert(params, options = {})
             files_params = params.is_a?(Hash) ? [params] : params

data/lib/uploadcare/entity/file.rb

@@ -15,6 +15,11 @@ module Uploadcare
 
       attr_entity(*RESPONSE_PARAMS)
 
+      def datetime_stored
+        Uploadcare.config.logger&.warn 'datetime_stored property has been deprecated, and will be removed without a replacement in future.' # rubocop:disable Layout/LineLength
+        @entity.datetime_stored
+      end
+
       # gets file's uuid - even if it's only initialized with url
       # @returns [String]
       def uuid

data/lib/uploadcare/exception/auth_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Uploadcare
+  module Exception
+    # Invalid Auth configuration error
+    class AuthError < StandardError; end
+  end
+end

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/authentication_header.rb

@@ -11,6 +11,7 @@ module Uploadcare
     class AuthenticationHeader
       # @see https://uploadcare.com/docs/api_reference/rest/requests_auth/#auth-uploadcare
       def self.call(options = {})
+        validate_auth_config
         case Uploadcare.config.auth_type
         when 'Uploadcare'
           SecureAuthHeader.call(options)
@@ -20,6 +21,17 @@ module Uploadcare
           raise ArgumentError, "Unknown auth_scheme: '#{Uploadcare.config.auth_type}'"
         end
       end
+
+      def self.validate_auth_config
+        raise AuthError, 'Public Key is blank.' if is_blank?(Uploadcare.config.public_key)
+        raise AuthError, 'Secret Key is blank.' if is_blank?(Uploadcare.config.secret_key)
+      end
+
+      # rubocop:disable Naming/PredicateName
+      def self.is_blank?(value)
+        value.nil? || value.empty?
+      end
+      # rubocop:enable Naming/PredicateName
     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.1'
 end

data/lib/uploadcare/signed_url_generators/{amakai_generator.rb → akamai_generator.rb}

@@ -4,20 +4,21 @@ require_relative 'base_generator'
 
 module Uploadcare
   module SignedUrlGenerators
-    class AmakaiGenerator < Uploadcare::SignedUrlGenerators::BaseGenerator
+    class AkamaiGenerator < Uploadcare::SignedUrlGenerators::BaseGenerator
       UUID_REGEX = '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}'
       TEMPLATE = 'https://{cdn_host}/{uuid}/?token=exp={expiration}{delimiter}acl={acl}{delimiter}hmac={token}'
 
-      def generate_url(uuid, acl = uuid)
+      def generate_url(uuid, acl = uuid, wildcard: false)
         raise ArgumentError, 'Must contain valid UUID' unless valid?(uuid)
 
+        formatted_acl = build_acl(uuid, acl, wildcard: wildcard)
         expire = build_expire
-        signature = build_signature(expire, acl)
+        signature = build_signature(expire, formatted_acl)
 
         TEMPLATE.gsub('{delimiter}', delimiter)
                 .sub('{cdn_host}', sanitized_string(cdn_host))
                 .sub('{uuid}', sanitized_string(uuid))
-                .sub('{acl}', "/#{sanitized_string(acl)}/")
+                .sub('{acl}', formatted_acl)
                 .sub('{expiration}', expire)
                 .sub('{token}', signature)
       end
@@ -32,13 +33,22 @@ module Uploadcare
         '~'
       end
 
+      def build_acl(uuid, acl, wildcard: false)
+        if wildcard
+          "/#{sanitized_string(uuid)}/*"
+        else
+          "/#{sanitized_string(acl)}/"
+        end
+      end
+
       def build_expire
         (Time.now.to_i + ttl).to_s
       end
 
       def build_signature(expire, acl)
-        signature = ["exp=#{expire}", "acl=/#{sanitized_string(acl)}/"].join(delimiter)
-        OpenSSL::HMAC.hexdigest(algorithm, secret_key, signature)
+        signature = ["exp=#{expire}", "acl=#{acl}"].join(delimiter)
+        secret_key_bin = Array(secret_key.gsub(/\s/, '')).pack('H*')
+        OpenSSL::HMAC.hexdigest(algorithm, secret_key_bin, signature)
       end
 
       # rubocop:disable Style/SlicingWithRange

data/lib/uploadcare.rb

@@ -6,6 +6,8 @@ require 'ruby/version'
 # Exceptions
 require 'exception/throttle_error'
 require 'exception/request_error'
+require 'exception/retry_error'
+require 'exception/auth_error'
 
 # Entities
 require 'entity/entity'
@@ -24,7 +26,7 @@ require 'param/webhook_signature_verifier'
 require 'api/api'
 
 # SignedUrlGenerators
-require 'signed_url_generators/amakai_generator'
+require 'signed_url_generators/akamai_generator'
 require 'signed_url_generators/base_generator'
 
 # Ruby wrapper for Uploadcare API
@@ -33,18 +35,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'
@@ -60,4 +50,5 @@ module Uploadcare
   setting :upload_threads,            default: 2 # used for multiupload only ATM
   setting :framework_data,            default: ''
   setting :file_chunk_size,           default: 100
+  setting :logger,                    default: Logger.new($stdout)
 end

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.1
 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-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimemagic
@@ -130,8 +130,10 @@ files:
 - lib/uploadcare/entity/project.rb
 - lib/uploadcare/entity/uploader.rb
 - lib/uploadcare/entity/webhook.rb
+- lib/uploadcare/exception/auth_error.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
@@ -144,7 +146,7 @@ files:
 - lib/uploadcare/param/user_agent.rb
 - lib/uploadcare/param/webhook_signature_verifier.rb
 - lib/uploadcare/ruby/version.rb
-- lib/uploadcare/signed_url_generators/amakai_generator.rb
+- lib/uploadcare/signed_url_generators/akamai_generator.rb
 - lib/uploadcare/signed_url_generators/base_generator.rb
 - uploadcare-ruby.gemspec
 homepage: https://uploadcare.com/
@@ -168,14 +170,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.9
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for uploadcare API