uploadcare-ruby 3.2.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1c9e31f806af7e05c558fac2f5474b1b79bbe6585437049a2ecca5cc7011b46
-  data.tar.gz: 3da125b462b72f76f1cc52b3d9654354399d4864eba72b34e474c5d9a05ca22b
+  metadata.gz: d3c7c464a8d89a9451f4205ba7f82b3c270d2431eb2b9cf9e31f64fc0542e032
+  data.tar.gz: 5ee0ef07f9194986eaf3742a5a80d01be38cd69a7e951551b791bcf479cf17f0
 SHA512:
-  metadata.gz: '06814335c0ac2733f7a71ad0a9f04af2c9e3160d59de4d3d88231403a6e02366a10bb8db9405762d6a2ed70c82fb0185e5e11e59763cc2f04f79a67c89f52718'
-  data.tar.gz: 9c9d034e9d510c0d1839f5b13164a810ee26c58eb75cdcff3aaf6e54aeb6a5f2a0a9c20f2d75d0b6c6f5856eba7a8ccb2b42b7cb4b7ea45f74f5242120bf5534
+  metadata.gz: 6accbd5a9c9c593c252a370947f42756a477cb47d6d1261a54a17df6f7026f9dd5e49ded174718ce159e6f3da9638744c4520673cfc0c81dcac381f129de2016
+  data.tar.gz: c383653917bab7dbc417eeccd16b800066ee07cf3741f3734361b8ae9da2935e369442711071a0ab0453860321b21a7a979265fa2a7f19daaaefb9fd4c5add20

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 3.3.2 - 2022-07-18
+
+- Fixes dry-configurable deprecation warnings
+
+## 3.3.1 - 2022-04-19
+
+- Fixed README: `Uploadcare::URLGenerators::AmakaiGenerator` > `Uploadcare::SignedUrlGenerators::AmakaiGenerator`
+- Autoload generators constants
+
+## 3.3.0 — 2022-04-08
+
+- Added `Uploadcare::URLGenerators::AmakaiGenerator`. Use custom domain and CDN provider to deliver files with authenticated URLs
+
 ## 3.2.0 — 2021-11-16
 
 - Added option `signing_secret` to the `Uploadcare::Webhook`
@@ -28,6 +41,7 @@
 - Added CI
 
 ## 3.0.3-dev — 2020-03-13
+
 - Added better pagination and iterators for `GroupList` & `FileList`
 
 ## 3.0.2-dev — 2020-03-11
@@ -46,6 +60,7 @@
 ## 3.0.0-dev — 2020-02-18
 
 ### Changed
+
 - Rewrote gem from scratch
 
 ### Added

data/README.md

@@ -119,6 +119,8 @@ Uploadcare supports multiple ways to upload files:
 
 ```ruby
 # 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")
 ```
 
@@ -659,13 +661,27 @@ Params in the response:
 
 More examples and options can be found [here](https://uploadcare.com/docs/transformations/document-conversion/#document-conversion)
 
+## Secure delivery
+
+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):
+```ruby
+generator = Uploadcare::SignedUrlGenerators::AmakaiGenerator.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
+```
 ## Useful links
 
 * [Development](https://github.com/uploadcare/uploadcare-ruby/blob/main/DEVELOPMENT.md)
-* [Uploadcare documentation](https://uploadcare.com/docs/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby)  
-* [Upload API reference](https://uploadcare.com/api-refs/upload-api/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby)  
-* [REST API reference](https://uploadcare.com/api-refs/rest-api/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby)  
-* [Changelog](./CHANGELOG.md)  
-* [Contributing guide](https://github.com/uploadcare/.github/blob/master/CONTRIBUTING.md)  
-* [Security policy](https://github.com/uploadcare/uploadcare-ruby/security/policy)  
-* [Support](https://github.com/uploadcare/.github/blob/master/SUPPORT.md)  
+* [Uploadcare documentation](https://uploadcare.com/docs/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby)
+* [Upload API reference](https://uploadcare.com/api-refs/upload-api/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby)
+* [REST API reference](https://uploadcare.com/api-refs/rest-api/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby)
+* [Changelog](./CHANGELOG.md)
+* [Contributing guide](https://github.com/uploadcare/.github/blob/master/CONTRIBUTING.md)
+* [Security policy](https://github.com/uploadcare/uploadcare-ruby/security/policy)
+* [Support](https://github.com/uploadcare/.github/blob/master/SUPPORT.md)

data/lib/uploadcare/ruby/version.rb

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

data/lib/uploadcare/signed_url_generators/amakai_generator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'base_generator'
+
+module Uploadcare
+  module SignedUrlGenerators
+    class AmakaiGenerator < 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)
+        raise ArgumentError, 'Must contain valid UUID' unless valid?(uuid)
+
+        expire = build_expire
+        signature = build_signature(expire, acl)
+
+        TEMPLATE.gsub('{delimiter}', delimiter)
+                .sub('{cdn_host}', sanitized_string(cdn_host))
+                .sub('{uuid}', sanitized_string(uuid))
+                .sub('{acl}', "/#{sanitized_string(acl)}/")
+                .sub('{expiration}', expire)
+                .sub('{token}', signature)
+      end
+
+      private
+
+      def valid?(uuid)
+        uuid.match(UUID_REGEX)
+      end
+
+      def delimiter
+        '~'
+      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)
+      end
+
+      # rubocop:disable Style/SlicingWithRange
+      def sanitized_string(string)
+        string = string[1..-1] if string[0] == '/'
+        string = string[0...-1] if string[-1] == '/'
+        string.strip
+      end
+      # rubocop:enable Style/SlicingWithRange
+    end
+  end
+end

data/lib/uploadcare/signed_url_generators/base_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Uploadcare
+  module SignedUrlGenerators
+    class BaseGenerator
+      attr_accessor :cdn_host, :ttl, :algorithm
+      attr_reader :secret_key
+
+      def initialize(cdn_host:, secret_key:, ttl: 300, algorithm: 'sha256')
+        @ttl = ttl
+        @algorithm = algorithm
+        @cdn_host = cdn_host
+        @secret_key = secret_key
+      end
+
+      def generate_url
+        raise NotImplementedError, "#{__method__} method not present"
+      end
+    end
+  end
+end

data/lib/uploadcare.rb

@@ -23,23 +23,40 @@ require 'param/webhook_signature_verifier'
 # General api
 require 'api/api'
 
+# SignedUrlGenerators
+require 'signed_url_generators/amakai_generator'
+require 'signed_url_generators/base_generator'
+
 # Ruby wrapper for Uploadcare API
 #
 # @see https://uploadcare.com/docs/api_reference
 module Uploadcare
   extend Dry::Configurable
-  setting :public_key, ENV.fetch('UPLOADCARE_PUBLIC_KEY')
-  setting :secret_key, ENV.fetch('UPLOADCARE_SECRET_KEY')
-  setting :auth_type, 'Uploadcare'
-  setting :multipart_size_threshold, 100 * 1024 * 1024
-  setting :rest_api_root, 'https://api.uploadcare.com'
-  setting :upload_api_root, 'https://upload.uploadcare.com'
-  setting :max_request_tries, 100
-  setting :base_request_sleep, 1 # seconds
-  setting :max_request_sleep, 60.0 # seconds
-  setting :sign_uploads, false
-  setting :upload_signature_lifetime, 30 * 60 # seconds
-  setting :max_throttle_attempts, 5
-  setting :upload_threads, 2 # used for multiupload only ATM
-  setting :framework_data, ''
+
+  # 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'
+  setting :multipart_size_threshold,  default: 100 * 1024 * 1024
+  setting :rest_api_root,             default: 'https://api.uploadcare.com'
+  setting :upload_api_root,           default: 'https://upload.uploadcare.com'
+  setting :max_request_tries,         default: 100
+  setting :base_request_sleep,        default: 1 # seconds
+  setting :max_request_sleep,         default: 60.0 # seconds
+  setting :sign_uploads,              default: false
+  setting :upload_signature_lifetime, default: 30 * 60 # seconds
+  setting :max_throttle_attempts,     default: 5
+  setting :upload_threads,            default: 2 # used for multiupload only ATM
+  setting :framework_data,            default: ''
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uploadcare-ruby
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.2
 platform: ruby
 authors:
 - Stepan Redka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-25 00:00:00.000000000 Z
+date: 2022-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api_struct
@@ -216,6 +216,8 @@ 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/base_generator.rb
 - uploadcare-ruby.gemspec
 homepage: https://github.com/uploadcare/uploadcare-ruby
 licenses: