cloudinary 1.28.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97b754051e806086f5dfb98479292bb84bed48968c242d8c55dfa073a8d90e52
-  data.tar.gz: 6a6484d454b0b074fa177b68e90bb62a100c90aa3f4b3ab33dad9acd64d7ec4d
+  metadata.gz: 6d6f32cb53d97a60e6d0ec304b1dbee2a80e7d1610c9007a9a0331bf80c3f882
+  data.tar.gz: 29863f2c682c9800cef486624985a8d4f8959b7da19ce0f53b4377bdc0312eaf
 SHA512:
-  metadata.gz: dd822c6ec7144df3f7ab863d834802c486bc31ef5051cafbb9d331279a0f3092906990c211ccf1802515d53d51f64e71fd1bd73acc8a2f368c22bddd90ea3a38
-  data.tar.gz: cc2299facddd71188d08c0f934ad8483bc0c9414364699e3f84a20eee489f0883adca4ba838a9534d417e11580ff194761d0d26cc978079c9e3b2f42cceeaa48
+  metadata.gz: 8b7ac1b9edaeb3d8faad6dc1d75442f41cadef751400840c27ff176d370ca0739f68eda398c05efe56b7bfaa04376a0154f17840e15ac670fd4cc9d673527cb0
+  data.tar.gz: c3ba9122af7accec3abf2b9388b62be44e1e483a6f229e13ba40d1d283e9eef75c7179235b2674011e7d49d1fc12284c83b59f0dcfb0eed38e73195815123294

data/.travis.yml

@@ -1,22 +1,16 @@
-dist: focal
+dist: jammy
 language: ruby
 rvm:
-  - 2.6.7
-  - 2.7.4
-  - 3.0.2
+  - 3.1.4
+  - 3.2.2
+  - 3.3.0
 
 matrix:
   include:
-    - name: "Ruby 1.9"
-      dist: precise
-      rvm: 1.9.3
-      before_install:
-        - gem install bundler -v 1.17.3
-    - name: "Ruby 2.5.9"
-      dist: xenial
-      rvm: ruby-2.5.9
-      before_install:
-        - gem install bundler -v 2.3.26
+    # There is an OpenSSL issue on Jammy with Ruby 3.0
+    - name: "Ruby: 3.0.6"
+      dist: focal
+      rvm: 3.0.6
 
 before_script: >
   export CLOUDINARY_URL=$(bash tools/get_test_cloud.sh);

data/CHANGELOG.md

@@ -1,3 +1,54 @@
+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
+==================
+
+New functionality and features
+------------------------------
+
+  * Add support for `context` parameter in `url_for_direct_upload`
+  * Add support for `use_fetch_format` parameter in `cl_video_tag`
+  * Add support for `fields` parameter in Search and Admin APIs
+  * Add support for access keys management in Account Provisioning API
+
+Other Changes
+-------------
+
+  * Avoid early loading of `ActionView::Base`
+  * Fix `sqlite3` dependency version
+  * Add Rails 7.x to supported versions on `README.md`
+
 1.28.0 / 2023-11-06
 ==================
 

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 |
-|-------------|-----------|-----------|
-| 1.x         | v         | v         |
+| SDK Version | Rails 5.x | Rails 6.x | Rails 7.x |
+|-------------|-----------|-----------|-----------|
+| 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,33 @@ 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.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 >= "2.7.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_development_dependency 'faraday-follow_redirects', '~> 0.3.0'
+  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

@@ -39,10 +39,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
@@ -81,7 +83,9 @@ module ActiveStorage
         # through direct upload (client side js), filename is missing, and that leads to inconsistent/broken URLs.
         # To avoid that, we explicitly pass file format in options.
         options[:format] = ext_for_file(key) if options[:resource_type] == "raw"
+        context = options.delete(:context)
         options[:context] = {active_storage_key: key}
+        options[:context].reverse_merge!(context) if context.respond_to?(:merge)
         options.delete(:file)
         payload[:url] = api_uri("upload", options)
       end
@@ -147,7 +151,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))
+      url = Cloudinary::Utils.cloudinary_url(public_id(key), resource_type: resource_type(nil, key))
       uri = URI(url)
       instrument :download, key: key do
         req = Net::HTTP::Get.new(uri)

data/lib/cloudinary/account_api.rb

@@ -13,10 +13,10 @@ class Cloudinary::AccountApi
   # @param [Object] options additional options
   def self.create_sub_account(name, cloud_name = nil, custom_attributes = {}, enabled = nil, base_account = nil, options = {})
     params = {
-      name: name,
-      cloud_name: cloud_name,
-      custom_attributes: custom_attributes,
-      enabled: enabled,
+      name:                name,
+      cloud_name:          cloud_name,
+      custom_attributes:   custom_attributes,
+      enabled:             enabled,
       base_sub_account_id: base_account
     }
 
@@ -35,10 +35,10 @@ class Cloudinary::AccountApi
   # @param [Object] options additional options
   def self.update_sub_account(sub_account_id, name = nil, cloud_name = nil, custom_attributes = nil, enabled = nil, options = {})
     params = {
-      name: name,
-      cloud_name: cloud_name,
+      name:              name,
+      cloud_name:        cloud_name,
       custom_attributes: custom_attributes,
-      enabled: enabled
+      enabled:           enabled
     }
 
     call_account_api(:put, ['sub_accounts', sub_account_id], params, options.merge(content_type: :json))
@@ -53,8 +53,8 @@ class Cloudinary::AccountApi
   def self.sub_accounts(enabled = nil, ids = [], prefix = nil, options = {})
     params = {
       enabled: enabled,
-      ids: ids,
-      prefix: prefix
+      ids:     ids,
+      prefix:  prefix
     }
 
     call_account_api(:get, 'sub_accounts', params, options.merge(content_type: :json))
@@ -84,9 +84,9 @@ class Cloudinary::AccountApi
   # @param [Object] options additional options
   def self.create_user(name, email, role, sub_account_ids = [], options = {})
     params = {
-      name: name,
-      email: email,
-      role: role,
+      name:            name,
+      email:           email,
+      role:            role,
       sub_account_ids: sub_account_ids
     }
 
@@ -111,9 +111,9 @@ class Cloudinary::AccountApi
   # @param [Object] options additional options
   def self.update_user(user_id, name = nil, email = nil, role = nil, sub_account_ids = nil, options = {})
     params = {
-      name: name,
-      email: email,
-      role: role,
+      name:            name,
+      email:           email,
+      role:            role,
       sub_account_ids: sub_account_ids
     }
 
@@ -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,
+      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))
@@ -210,16 +222,55 @@ class Cloudinary::AccountApi
     call_account_api(:get, ['user_groups', group_id, 'users'], {}, options.merge(content_type: :json))
   end
 
+  # Lists access keys.
+  #
+  # @param [String] sub_account_id  The ID of the sub-account.
+  # @param [Object] options         Additional options.
+  def self.access_keys(sub_account_id, options = {})
+    params = Cloudinary::Api.only(options, :page_size, :page, :sort_by, :sort_order)
+    call_account_api(:get, ['sub_accounts', sub_account_id, 'access_keys'], params, options)
+  end
+
+  # Generates access key.
+  #
+  # @param [String]   sub_account_id  The ID of the sub-account.
+  # @param [String]   name            The display name as shown in the management console.
+  # @param [Boolean]  enabled         Whether to create the access key as enabled (default is enabled).
+  # @param [Object]   options         Additional options.
+  def self.generate_access_key(sub_account_id, name = nil, enabled = nil, options = {})
+    params = {
+      name:    name,
+      enabled: enabled,
+    }
+    call_account_api(:post, ['sub_accounts', sub_account_id, 'access_keys'], params, options.merge(content_type: :json))
+  end
+
+  # Updates access key.
+  #
+  # @param [String]   sub_account_id  The ID of the sub-account.
+  # @param [String]   api_key         The API key.
+  # @param [String]   name            The display name as shown in the management console.
+  # @param [Boolean]  enabled         Enable or disable the access key.
+  # @param [Object]   options         Additional options.
+  def self.update_access_key(sub_account_id, api_key, name = nil, enabled = nil, options = {})
+    params = {
+      name:    name,
+      enabled: enabled,
+    }
+    call_account_api(:put, ['sub_accounts', sub_account_id, 'access_keys', api_key], 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