cloudinary 1.29.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ec56a8224fa9a3318d7e0d3e7ce7747c888767a4b365a752310e38b7747f4a3
-  data.tar.gz: 58f0148449592fb70e8a87bc292ddeea43a09b0f879fca9c62c1594b3ff487cc
+  metadata.gz: 1244ab3ce91f6fda0b07e5438ed79f896cde743306efb9c3ac58e5a5f1d4a6dc
+  data.tar.gz: a36510b3d2a2e1b788c2455e5def6f314b78b0b94def573a75a4750e96498b6c
 SHA512:
-  metadata.gz: 44e6c4cefaebd3853f8da9c40123d05205b6fa57fd58eb22e1a8a419bad658b3184eb2bd068f79b8d54601793295c333e6a02720d6a5bdbcb699b234432603e2
-  data.tar.gz: de7032533e031e15c51ccc17ff8e77a2aabc6f9aea4958a58d2313b30aeadc8b14574e36090c99a9e58788e3a376bc9330cfdd0e8d77fcb96d3d4deea7cbfd57
+  metadata.gz: 7ba876181927174ec445d3abd04c79cc03af3837713c234ea9a89651131b6dd4c4be6e3ec02d155596d4f2ce821b269600adda74210408af066b04e0671169fb
+  data.tar.gz: 8bcbb47be56d985537d237fcd5989979555ba0d622bf8a6a3f60484e8b31ffd7d0682353ce4768e4f732edb3fe1a909e001640226fc8fe085ff35cc321b662c6

data/.travis.yml

@@ -1,7 +1,6 @@
 dist: jammy
 language: ruby
 rvm:
-  - 2.7.8
   - 3.1.4
   - 3.2.2
   - 3.3.0

data/CHANGELOG.md

@@ -1,3 +1,97 @@
+2.3.0 / 2025-02-20
+==================
+
+New functionality and features
+------------------------------
+
+  * Add support for `429 Too Many Requests` HTTP status code
+  * Add support for `allow_dynamic_list_values` parameter in `MetadataField`
+  * Add support for `config` Admin API
+
+2.2.0 / 2024-09-08
+==================
+
+New functionality and features
+------------------------------
+
+  * Add support for ActiveStorage model service configuration
+
+Other Changes
+-------------
+
+  * Fix asset type detection in ActiveStorage
+  * Add explicit `ostruct` dependency
+
+2.1.2 / 2024-08-18
+==================
+
+  * Fix ActiveStorage type detection for email files
+  * Add `changelog_uri` to `gemspec`
+
+2.1.1 / 2024-05-28
+==================
+
+  * Fix regression in `cloudinary_url` generation
+
+2.1.0 / 2024-05-27
+==================
+
+New functionality and features
+------------------------------
+
+  * Add support for `rename_folder` Admin API
+  * Add support for `delete_access_key` in Provisioning API
+
+Other Changes
+-------------
+
+  * Fix detection of base64 encoded files with complex MIME type
+  * Fix `fetch` url generation with Active Storage `folder` configuration
+  * Fix usage of deprecated `File.exists?` method
+
+2.0.2 / 2024-04-09
+==================
+
+  * Fix CarrierWave `store!` method
+
+2.0.1 / 2024-04-09
+==================
+
+  * Fix rake tasks
+
+2.0.0 / 2024-04-08
+==================
+
+Breaking Changes
+----------------
+
+* Set minimal Ruby version to `3.0`
+  * For older Rubies use version `1.x` of this library
+* Replace `rest-client` with `faraday`
+* Set config `secure` to `true` by default
+  * All delivery URLs are set to be `https://` by default 
+  * To disable - set `secure` to `false` in config/options
+* Add support for URL Analytics
+  * Adds analytics signature query parameter to the delivery URLs 
+  * To disable - set `analytics` to `false` in config/options
+* Remove deprecated methods
+  * `Cloudinary::Utils.unsigned_download_url`
+    * use `Cloudinary::Utils.cloudinary_url` instead
+  * `Cloudinary::Utils.signed_download_url`
+    * use `Cloudinary::Utils.cloudinary_url` instead
+  * `Cloudinary::Utils.zip_download_url`
+    * use `Cloudinary::Utils.download_zip_url` instead
+  * `cl_zip_download_url`
+    * use `cl_download_zip_url` instead
+* Remove deprecated constants
+
+New functionality and features
+------------------------------
+
+  * Add support for `analyze` API
+  * Support chunked uploads with CarrierWave
+  * Filter users by last login in `users` Provisioning API
+
 1.29.0 / 2024-02-26
 ==================
 

data/README.md

@@ -40,11 +40,13 @@ the [Ruby on Rails SDK Guide](https://cloudinary.com/documentation/rails_integra
 
 | SDK Version | Ruby 1.9.3 | Ruby 2.x | Ruby 3.x |
 |-------------|------------|----------|----------|
-| 1.x         | v          | v        | v        |
+| 1.x         | ✔          | ✔        | ✔        |
+| 2.x         | ✘          | ✘        | ✔        |
 
 | SDK Version | Rails 5.x | Rails 6.x | Rails 7.x |
 |-------------|-----------|-----------|-----------|
-| 1.x         | v         | v         | v         |
+| 1.x         | ✔         | ✔         | ✔         |
+| 2.x         | ✘         | ✔         | ✔         |
 
 ## Installation
 
@@ -64,7 +66,7 @@ require 'cloudinary'
 - [See full documentation](https://cloudinary.com/documentation/rails_image_manipulation).
 
 ```ruby
- cl_image_tag("sample.jpg", :width => 100, :height => 150, :crop => :fill)
+ cl_image_tag("sample.jpg", width: 100, height: 150, crop: "fill")
 ```
 
 ### Upload

data/cloudinary.gemspec

@@ -7,63 +7,38 @@ Gem::Specification.new do |s|
   s.version     = Cloudinary::VERSION
   s.authors     = ["Nadav Soferman","Itai Lahan","Tal Lev-Ami"]
   s.email       = ["nadav.soferman@cloudinary.com","itai.lahan@cloudinary.com","tal.levami@cloudinary.com"]
-  s.homepage    = "http://cloudinary.com"
+  s.homepage    = "https://cloudinary.com"
   s.license     = "MIT"
 
   s.summary     = %q{Client library for easily using the Cloudinary service}
   s.description = %q{Client library for easily using the Cloudinary service}
 
-  s.rubyforge_project = "cloudinary"
+  s.metadata = {
+    "changelog_uri" => "https://github.com/cloudinary/cloudinary_gem/blob/master/CHANGELOG.md"
+  }
 
-  s.files         = `git ls-files`.split("\n").select { |f| !f.start_with?("test", "spec", "features", "samples") } + Dir.glob("vendor/assets/javascripts/*/*") + Dir.glob("vendor/assets/html/*")
+  s.files         = `git ls-files`.split("\n").select { |f| !f.start_with?("test", "spec", "features", "samples") } +
+    Dir.glob("vendor/assets/javascripts/*/*") + Dir.glob("vendor/assets/html/*")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "aws_cf_signer"
-
-  if RUBY_VERSION >= "2.0.0"
-    s.add_dependency "rest-client", ">= 2.0.0"
-  else
-    s.add_dependency "rest-client"
-  end
-
-  if RUBY_VERSION >= "3.0.0"
-    s.add_development_dependency "rexml"
-  end
-
-  s.add_development_dependency "actionpack"
-  s.add_development_dependency "nokogiri"
-
-  if RUBY_VERSION >= "2.2.0"
-    s.add_development_dependency "rake", ">= 13.0.1"
-  else
-    s.add_development_dependency "rake", "<= 12.2.1"
-  end
-  if RUBY_VERSION >= "3.0.0"
-    s.add_development_dependency "sqlite3"
-  else
-    s.add_development_dependency "sqlite3", "< 1.6.0"
-  end
-
-  s.add_development_dependency "rspec", '>=3.5'
-  s.add_development_dependency "rspec-retry"
-
-  if RUBY_VERSION >= "3.0.0"
-    s.add_development_dependency "rails", "~> 6.0.3"
-  elsif RUBY_VERSION >= "2.2.2"
-    s.add_development_dependency "rails", "~> 5.2"
-  end
-
-  s.add_development_dependency "railties", "<= 4.2.7" if RUBY_VERSION <= "1.9.3"
-  s.add_development_dependency "rspec-rails"
-
-  s.add_development_dependency "rubyzip"
-
-  if RUBY_VERSION <= "2.4.0"
-    s.add_development_dependency "simplecov", "<= 0.17.1" # support testing Ruby 1.9
-    s.add_development_dependency 'loofah', '~>2.19.1'
-    s.add_development_dependency "rails-html-sanitizer", "<1.5.0"
-  else
-    s.add_development_dependency "simplecov", "> 0.18.0"
-  end
+  s.required_ruby_version = '~> 3'
+
+  s.add_dependency "faraday", ">= 2.0.1", "< 3.0.0"
+  s.add_dependency "faraday-multipart", "~> 1.0", ">= 1.0.4"
+  s.add_dependency 'faraday-follow_redirects', '~> 0.3.0'
+  s.add_dependency "ostruct"
+
+  s.add_development_dependency "rails", ">= 6.1.7", "< 8.0.0"
+  s.add_development_dependency "rexml", ">= 3.2.5", "< 4.0.0"
+  s.add_development_dependency "actionpack", ">= 6.1.7", "< 8.0.0"
+  s.add_development_dependency "nokogiri", ">= 1.12.5", "< 2.0.0"
+  s.add_development_dependency "rake", ">= 13.0.6", "< 14.0.0"
+  s.add_development_dependency "sqlite3", ">= 1.4.2", "< 2.0.0"
+  s.add_development_dependency "rspec", ">= 3.11.2", "< 4.0.0"
+  s.add_development_dependency "rspec-retry", ">= 0.6.2", "< 1.0.0"
+  s.add_development_dependency "railties", ">= 6.0.4", "< 8.0.0"
+  s.add_development_dependency "rspec-rails", ">= 6.0.4", "< 7.0.0"
+  s.add_development_dependency "rubyzip", ">= 2.3.0", "< 3.0.0"
+  s.add_development_dependency "simplecov", ">= 0.21.2", "< 1.0.0"
 end

data/lib/active_storage/service/cloudinary_service.rb

@@ -17,7 +17,13 @@ module CloudinaryHelper
   alias cloudinary_url_internal_original cloudinary_url_internal
 
   def cloudinary_url_internal(source, options = {})
-    source = ActiveStorage::Blob.service.public_id(source) if defined? ActiveStorage::Blob.service.public_id
+    service_instance, options = ActiveStorage::Service::CloudinaryService.fetch_service_instance_and_config(source, options)
+    service_instance ||= ActiveStorage::Blob.service
+
+    if defined?(service_instance.public_id) && options.fetch(:type, "").to_s != "fetch"
+      source = service_instance.public_id(source)
+    end
+
     cloudinary_url_internal_original(source, options)
   end
 end
@@ -39,10 +45,12 @@ module ActiveStorage
         begin
           extra_headers = checksum.nil? ? {} : {Headers::CONTENT_MD5 => checksum}
           options = @options.merge(options)
+          resource_type = resource_type(io, key)
+          options[:format] = ext_for_file(key) if resource_type == "raw"
           Cloudinary::Uploader.upload_large(
             io,
             public_id: public_id_internal(key),
-            resource_type: resource_type(io, key),
+            resource_type: resource_type,
             context: {active_storage_key: key, checksum: checksum},
             extra_headers: extra_headers,
             **options
@@ -54,9 +62,10 @@ module ActiveStorage
     end
 
     def url(key, filename: nil, content_type: '', **options)
+      key = find_blob_or_use_key(key)
       instrument :url, key: key do |payload|
         url = Cloudinary::Utils.cloudinary_url(
-          full_public_id_internal(key),
+          full_public_id_internal(key, options),
           resource_type: resource_type(nil, key, content_type),
           format: ext_for_file(key, filename, content_type),
           **@options.merge(options.symbolize_keys)
@@ -97,6 +106,7 @@ module ActiveStorage
     end
 
     def delete(key)
+      key = find_blob_or_use_key(key)
       instrument :delete, key: key do
         options = {
           resource_type: resource_type(nil, key),
@@ -113,6 +123,7 @@ module ActiveStorage
     end
 
     def exist?(key)
+      key = find_blob_or_use_key(key)
       instrument :exist, key: key do |payload|
         begin
           options = {
@@ -149,8 +160,7 @@ module ActiveStorage
 
     # Return the partial content in the byte +range+ of the file at the +key+.
     def download_chunk(key, range)
-      url = Cloudinary::Utils.unsigned_download_url(public_id(key), resource_type: resource_type(nil, key))
-      uri = URI(url)
+      uri = URI(url(key))
       instrument :download, key: key do
         req = Net::HTTP::Get.new(uri)
         range_end = case
@@ -186,6 +196,33 @@ module ActiveStorage
       full_public_id_internal(public_id)
     end
 
+    def self.fetch_service_instance_and_config(source, options)
+      return [nil, options] unless defined?(ActiveStorage::BlobKey) && source.is_a?(ActiveStorage::BlobKey) &&
+        source.respond_to?(:attributes) && source.attributes.key?(:service_name)
+
+      service_name = source.attributes[:service_name]
+
+      begin
+        service_instance = ActiveStorage::Blob.services.fetch(service_name.to_sym)
+
+        unless service_instance.instance_of?(ActiveStorage::Service::CloudinaryService)
+          Rails.logger.error "Expected service instance #{service_instance.class.name} to be of type ActiveStorage::Service::CloudinaryService."
+          return [nil, options]
+        end
+
+        service_config = Rails.application.config.active_storage.service_configurations.fetch(service_name)
+        options        = service_config.merge(options)
+      rescue NameError => e
+        Rails.logger.error "Failed to retrieve the service instance for #{service_name}: #{e.message}"
+        return [nil, options]
+      rescue => e
+        Rails.logger.error "An unexpected error occurred: #{e.message}"
+        return [nil, options]
+      end
+
+      [service_instance, options]
+    end
+
     private
 
     def api_uri(action, options)
@@ -229,10 +266,12 @@ module ActiveStorage
     end
 
     # Returns the full public id including folder.
-    def full_public_id_internal(key)
+    def full_public_id_internal(key, options = {})
       public_id = public_id_internal(key)
 
-      return public_id unless @options[:folder]
+      options = @options.merge(options)
+
+      return public_id if !options[:folder] || options.fetch(:type, "").to_s == "fetch"
 
       File.join(@options.fetch(:folder), public_id)
     end
@@ -249,7 +288,7 @@ module ActiveStorage
       case type
       when 'video', 'audio'
         'video'
-      when 'text'
+      when 'text', 'message'
         'raw'
       when 'application'
         case subtype
@@ -272,5 +311,19 @@ module ActiveStorage
       end
       content_type_to_resource_type(content_type)
     end
+
+    def find_blob_or_use_key(key)
+      if key.is_a?(ActiveStorage::BlobKey)
+        key
+      else
+        begin
+          blob = ActiveStorage::Blob.find_by(key: key)
+          blob ? ActiveStorage::BlobKey.new(blob.attributes.as_json) : key
+        rescue ActiveRecord::StatementInvalid => e
+          # Return the original key if an error occurs
+          key
+        end
+      end
+    end
   end
 end

data/lib/cloudinary/account_api.rb

@@ -127,18 +127,30 @@ class Cloudinary::AccountApi
     call_account_api(:get, ['users', user_id], {}, options.merge(content_type: :json))
   end
 
-  # Lists users in the account.
-  # @param [Boolean] pending Limit results to pending users (true), users that are not pending (false), or all users (nil, the default)
-  # @param [Array<String>] user_ids A list of up to 100 user IDs. When provided, other parameters are ignored.
-  # @param [String] prefix Returns users where the name or email address begins with the specified case-insensitive string.
-  # @param [String] sub_account_id Only returns users who have access to the specified account.
-  # @param [Object] options additional options
+  # Get a list of the users according to filters.
+  #
+  # @param [Boolean]        pending        Optional. Limit results to pending users (true), users that are not pending (false), or all users (null)
+  # @param [Array<String>]  user_ids       Optional. List of user IDs. Up to 100
+  # @param [String]         prefix         Optional. Search by prefix of the user's name or email. Case-insensitive
+  # @param [String]         sub_account_id Optional. Return only users who have access to the given sub-account
+  # @param [Object]         options        Generic advanced options map, see online documentation.
+  # @option options [Boolean] :last_login  Optional. Return only users that last logged in in the specified range of dates (true),
+  #                                                users that didn't last logged in in that range (false), or all users (null).
+  # @option options [Date]    :from        Optional. Last login start date.
+  # @option options [Date]    :to          Optional. Last login end date.
+  #
+  # @return [Cloudinary::Api::Response] the users' details.
+  #
+  # @raise [Cloudinary::Api::Error] If the request fails.
   def self.users(pending = nil, user_ids = [], prefix = nil, sub_account_id = nil, options = {})
     params = {
       ids:            user_ids,
       prefix:         prefix,
       sub_account_id: sub_account_id,
-      pending:        pending
+      pending:        pending,
+      last_login:     options[:last_login].to_s,
+      from:           Cloudinary::Utils.to_usage_api_date_format(options[:from]),
+      to:             Cloudinary::Utils.to_usage_api_date_format(options[:to])
     }
 
     call_account_api(:get, 'users', params, options.merge(content_type: :json))
@@ -248,16 +260,35 @@ class Cloudinary::AccountApi
     call_account_api(:put, ['sub_accounts', sub_account_id, 'access_keys', api_key], params, options.merge(content_type: :json))
   end
 
+  # Deletes access key.
+  #
+  # @param [String]        sub_account_id  The ID of the sub-account.
+  # @param [String, nil]   api_key         The API key.
+  # @param [String, nil]   name            The display name as shown in the management console.
+  # @param [Object]        options         Additional options.
+  def self.delete_access_key(sub_account_id, api_key = nil, name = nil, options = {})
+    uri = ['sub_accounts', sub_account_id, 'access_keys']
+    unless api_key.blank?
+      uri.append(api_key)
+    end
+
+    params = {
+      name: name,
+    }
+    call_account_api(:delete, uri, params, options.merge(content_type: :json))
+  end
+
   def self.call_account_api(method, uri, params, options)
     account_id = options[:account_id] || Cloudinary.account_config.account_id || raise('Must supply account_id')
     api_key    = options[:provisioning_api_key] || Cloudinary.account_config.provisioning_api_key || raise('Must supply provisioning api_key')
     api_secret = options[:provisioning_api_secret] || Cloudinary.account_config.provisioning_api_secret || raise('Must supply provisioning api_secret')
+    api_version = options[:api_version] || Cloudinary.config.api_version || 'v1_1'
 
     params.reject! { |_, v| v.nil? }
     auth = { :key => api_key, :secret => api_secret }
 
     call_cloudinary_api(method, uri, auth, params, options) do |cloudinary, inner_uri|
-      [cloudinary, 'v1_1', 'provisioning', 'accounts', account_id, inner_uri]
+      [cloudinary, api_version, 'provisioning', 'accounts', account_id, inner_uri]
     end
   end
 

data/lib/cloudinary/analytics.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Cloudinary
+  module Analytics
+    extend self
+
+    QUERY_KEY    = '_a'
+    ALGO_VERSION = 'B' # The version of the algorithm
+    SDK_CODE     = 'C' # Cloudinary Ruby SDK
+
+    @product      = 'A' # Official SDK. Set to 'B' for integrations.
+    @sdk_code     = SDK_CODE
+    @sdk_version  = Cloudinary::VERSION
+    @tech_version = "#{RUBY_VERSION[/\d+\.\d+/]}"
+
+    CHARS           = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'
+    BINARY_PAD_SIZE = 6
+
+    @char_codes = nil
+    @signature  = nil
+
+    # Gets the SDK analytics signature query parameter.
+    #
+    # @return [String] The SDK signature query parameter.
+    def sdk_analytics_query_param
+      "#{QUERY_KEY}=#{self.sdk_analytics_signature}"
+    end
+
+    # Gets the SDK signature by encoding the SDK version and tech version.
+    #
+    # @return [String] The SDK signature.
+    def sdk_analytics_signature
+      return @signature unless @signature.nil?
+
+      begin
+        @signature = ALGO_VERSION + @product + @sdk_code + encode_version(@sdk_version) + encode_version(@tech_version)
+      rescue RangeError
+        @signature = 'E'
+      end
+
+      @signature
+    end
+
+    # Sets the product code.
+    #
+    # Used for integrations.
+    #
+    # @param [String] product The product code to set. 'A' is for the official SDK. 'B' for integrations.
+    #
+    # @return [void]
+    #
+    # @internal
+    def product(product)
+      @product = product
+    end
+
+    # Sets the SDK code.
+    #
+    # Used for integrations.
+    #
+    # @param [String] sdk_code The SDK code to set.
+    #
+    # @return [void]
+    #
+    # @internal
+    def sdk_code(sdk_code)
+      @sdk_code = sdk_code
+    end
+
+    # Sets the SDK version.
+    #
+    # Used for integrations.
+    #
+    # @param [String] sdk_version The SDK version to set (MAJOR.MINOR.PATCH), for example: "1.0.0".
+    #
+    # @return [void]
+    #
+    # @internal
+    def sdk_version(sdk_version)
+      @sdk_version = sdk_version
+    end
+
+    # Sets the tech version.
+    #
+    # Used for integrations.
+    #
+    # @param [String] tech_version The tech version to set (MAJOR.MINOR), for example: "1.0".
+    #
+    # @return [void]
+    #
+    # @internal
+    def tech_version(tech_version)
+      @tech_version = tech_version.split('.').first(2).join('.')
+    end
+
+    # Encodes a semVer-like version string.
+    #
+    # Example:
+    #  input:      '1.24.0'
+    #  explode:    ['1','24','0']
+    #  pad:        ['01','24','00']
+    #  reverse:    ['00', '24', '01']
+    #  implode:    '002401'
+    #  int:        2401
+    #  binary:     '100101100001'
+    #  padded:     '000000100101100001'
+    #  str_split:  ['000000', '100101', '100001']
+    #  getKey:     ['A', 'l', 'h']
+    #  implode:    'Alh'
+    #
+    # @param [String] version Can be either x.y.z or x.y
+    #
+    # @return [String] A string built from 3 characters of the base64 table
+    #
+    # @raise [RangeError] when version is larger than 43.21.26
+    def encode_version(version)
+      parts = version.split('.')
+
+      padded_parts  = parts.map { |part| part.rjust(2, '0') }
+      number        = padded_parts.reverse.join.to_i
+      padded_binary = int_to_padded_bin(number, parts.length * BINARY_PAD_SIZE)
+
+      raise RangeError, 'Version must be smaller than 43.21.26' if padded_binary.length % BINARY_PAD_SIZE != 0
+
+      encoded_chars = padded_binary.chars.each_slice(BINARY_PAD_SIZE).map { |slice| get_key(slice.join) }
+
+      encoded_chars.join
+    end
+
+    # Gets the key for binary value.
+    #
+    # @param [String] binary_value The value.
+    #
+    # @return [Array, Object] The key for the binary value.
+    def get_key(binary_value)
+      @char_codes ||= initialize_char_codes
+
+      @char_codes[binary_value] || ''
+    end
+
+    def initialize_char_codes
+      char_codes = {}
+      CHARS.chars.each_with_index { |char, idx| char_codes[int_to_padded_bin(idx, BINARY_PAD_SIZE)] = char }
+      char_codes
+    end
+
+    # Converts integer to left padded binary string.
+    #
+    # @param [Integer] integer The input.
+    # @param [Integer] pad_num  The num of padding chars.
+    #
+    # @return [String] The padded binary string.
+    def int_to_padded_bin(integer, pad_num)
+      integer.to_s(2).rjust(pad_num, '0')
+    end
+  end
+end