cloudinary 1.28.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97b754051e806086f5dfb98479292bb84bed48968c242d8c55dfa073a8d90e52
-  data.tar.gz: 6a6484d454b0b074fa177b68e90bb62a100c90aa3f4b3ab33dad9acd64d7ec4d
+  metadata.gz: 0ec56a8224fa9a3318d7e0d3e7ce7747c888767a4b365a752310e38b7747f4a3
+  data.tar.gz: 58f0148449592fb70e8a87bc292ddeea43a09b0f879fca9c62c1594b3ff487cc
 SHA512:
-  metadata.gz: dd822c6ec7144df3f7ab863d834802c486bc31ef5051cafbb9d331279a0f3092906990c211ccf1802515d53d51f64e71fd1bd73acc8a2f368c22bddd90ea3a38
-  data.tar.gz: cc2299facddd71188d08c0f934ad8483bc0c9414364699e3f84a20eee489f0883adca4ba838a9534d417e11580ff194761d0d26cc978079c9e3b2f42cceeaa48
+  metadata.gz: 44e6c4cefaebd3853f8da9c40123d05205b6fa57fd58eb22e1a8a419bad658b3184eb2bd068f79b8d54601793295c333e6a02720d6a5bdbcb699b234432603e2
+  data.tar.gz: de7032533e031e15c51ccc17ff8e77a2aabc6f9aea4958a58d2313b30aeadc8b14574e36090c99a9e58788e3a376bc9330cfdd0e8d77fcb96d3d4deea7cbfd57

data/.travis.yml

@@ -1,22 +1,17 @@
-dist: focal
+dist: jammy
 language: ruby
 rvm:
-  - 2.6.7
-  - 2.7.4
-  - 3.0.2
+  - 2.7.8
+  - 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,21 @@
+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

@@ -42,9 +42,9 @@ the [Ruby on Rails SDK Guide](https://cloudinary.com/documentation/rails_integra
 |-------------|------------|----------|----------|
 | 1.x         | v          | v        | v        |
 
-| 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         | v         | v         | v         |
 
 ## Installation
 

data/cloudinary.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
   else
     s.add_development_dependency "rake", "<= 12.2.1"
   end
-  if RUBY_VERSION >= "2.7.0"
+  if RUBY_VERSION >= "3.0.0"
     s.add_development_dependency "sqlite3"
   else
     s.add_development_dependency "sqlite3", "< 1.6.0"

data/lib/active_storage/service/cloudinary_service.rb

@@ -81,7 +81,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

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
     }
 
@@ -135,10 +135,10 @@ class Cloudinary::AccountApi
   # @param [Object] options additional options
   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
     }
 
     call_account_api(:get, 'users', params, options.merge(content_type: :json))
@@ -210,6 +210,44 @@ 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')

data/lib/cloudinary/api.rb

@@ -68,7 +68,7 @@ class Cloudinary::Api
     type          = options[:type]
     uri           = "resources/#{resource_type}"
     uri           += "/#{type}" unless type.blank?
-    call_api(:get, uri, only(options, :next_cursor, :max_results, :prefix, :tags, :context, :moderations, :direction, :start_at, :metadata), options)
+    call_api(:get, uri, list_resources_params(options).merge(only(options, :prefix, :start_at)), options)
   end
 
   # Lists assets with the specified tag.
@@ -87,7 +87,7 @@ class Cloudinary::Api
   def self.resources_by_tag(tag, options={})
     resource_type = options[:resource_type] || "image"
     uri           = "resources/#{resource_type}/tags/#{tag}"
-    call_api(:get, uri, only(options, :next_cursor, :max_results, :tags, :context, :moderations, :direction, :metadata), options)
+    call_api(:get, uri, list_resources_params(options), options)
   end
 
   # Lists assets currently in the specified moderation queue and status.
@@ -107,7 +107,7 @@ class Cloudinary::Api
   def self.resources_by_moderation(kind, status, options={})
     resource_type = options[:resource_type] || "image"
     uri           = "resources/#{resource_type}/moderations/#{kind}/#{status}"
-    call_api(:get, uri, only(options, :next_cursor, :max_results, :tags, :context, :moderations, :direction, :metadata), options)
+    call_api(:get, uri, list_resources_params(options), options)
   end
 
   # Lists assets with the specified contextual metadata.
@@ -129,30 +129,9 @@ class Cloudinary::Api
   def self.resources_by_context(key, value=nil, options={})
     resource_type = options[:resource_type] || "image"
     uri           = "resources/#{resource_type}/context"
-    params = only(options, :next_cursor, :max_results, :tags, :context, :moderations, :direction, :key, :value, :metadata)
-    params[:key] = key
-    params[:value] = value
-    call_api(:get, uri, params, options)
+    call_api(:get, uri, list_resources_params(options, :key => key, :value => value), options)
   end
 
-  # Returns the details of the specified asset and all its derived assets by asset id.
-  # 
-  # Note that if you only need details about the original asset,
-  # you can also use the Uploader::upload or Uploader::explicit methods, which return the same information and
-  # are not rate limited.
-  # 
-  # @param [String] asset_id The Asset ID of the asset.
-  # @param [Hash]   options  The optional parameters. See the <a href=https://cloudinary.com/documentation/admin_api#get_the_details_of_a_single_resource target="_blank"> Admin API</a> documentation.
-  # 
-  # @return [Cloudinary::Api::Response]
-  # 
-  # @see https://cloudinary.com/documentation/admin_api#get_the_details_of_a_single_resource
-  def self.resource_by_asset_id(asset_id, options={})
-    uri    = "resources/#{asset_id}"
-    params = prepare_resource_details_params(options)
-    call_api(:get, uri, params, options)
-  end
-  
   # Lists assets with the specified public IDs.
   #
   # @param [String|Array] public_ids The requested public_ids (up to 100).
@@ -168,7 +147,7 @@ class Cloudinary::Api
     resource_type = options[:resource_type] || "image"
     type          = options[:type] || "upload"
     uri           = "resources/#{resource_type}/#{type}"
-    call_api(:get, uri, only(options, :tags, :context, :moderations).merge(:public_ids => public_ids), options)
+    call_api(:get, uri, resources_params(options, :public_ids => public_ids), options)
   end
 
   # Lists assets with the specified asset IDs.
@@ -184,9 +163,7 @@ class Cloudinary::Api
   # @see https://cloudinary.com/documentation/admin_api#get_resources
   def self.resources_by_asset_ids(asset_ids, options={})
     uri = "resources/by_asset_ids"
-    params = only(options, :public_ids, :tags, :moderations, :context)
-    params[:asset_ids] = asset_ids
-    call_api(:get, uri, params, options)
+    call_api(:get, uri, resources_params(options, :asset_ids => asset_ids), options)
   end
 
   # Returns all assets stored directly in a specified asset folder, regardless of the public ID paths of those assets.
@@ -202,9 +179,7 @@ class Cloudinary::Api
   # @see https://cloudinary.com/documentation/dynamic_folders#new_admin_api_endpoints
   def self.resources_by_asset_folder(asset_folder, options={})
     uri = "resources/by_asset_folder"
-    params = only(options, :next_cursor, :max_results, :tags, :context, :moderations, :direction, :key, :value, :metadata)
-    params[:asset_folder] = asset_folder
-    call_api(:get, uri, params, options)
+    call_api(:get, uri, list_resources_params(options, :asset_folder => asset_folder), options)
   end
 
   # Find images based on their visual content.
@@ -243,6 +218,23 @@ class Cloudinary::Api
     call_api(:get, uri, prepare_resource_details_params(options), options)
   end
 
+  # Returns the details of the specified asset and all its derived assets by asset id.
+  #
+  # Note that if you only need details about the original asset,
+  # you can also use the Uploader::upload or Uploader::explicit methods, which return the same information and
+  # are not rate limited.
+  #
+  # @param [String] asset_id The Asset ID of the asset.
+  # @param [Hash]   options  The optional parameters. See the <a href=https://cloudinary.com/documentation/admin_api#get_the_details_of_a_single_resource target="_blank"> Admin API</a> documentation.
+  #
+  # @return [Cloudinary::Api::Response]
+  #
+  # @see https://cloudinary.com/documentation/admin_api#get_the_details_of_a_single_resource
+  def self.resource_by_asset_id(asset_id, options={})
+    uri    = "resources/#{asset_id}"
+    call_api(:get, uri, prepare_resource_details_params(options), options)
+  end
+
   # Reverts to the latest backed up version of the specified deleted assets.
   #
   # @param [String|Array] public_ids The public IDs of the backed up assets to restore. They can be existing or
@@ -1399,4 +1391,19 @@ class Cloudinary::Api
     params[by_key] = value
     call_api("post", "resources/#{resource_type}/#{type}/update_access_mode", params, options)
   end
+
+  private
+
+  RESOURCES_PARAMS = [:tags, :context, :metadata, :moderations, :fields].freeze
+  LIST_RESOURCES_PARAMS = [:next_cursor, :max_results, :direction].freeze
+
+  def self.resources_params(options, params = {})
+    params.merge!(only(options, *RESOURCES_PARAMS))
+    params[:fields] = Cloudinary::Utils.build_array(options[:fields]).join(",") unless params[:fields].nil?
+    params
+  end
+
+  def self.list_resources_params(options, params = {})
+    params.merge(resources_params(options)).merge!(only(options, *LIST_RESOURCES_PARAMS))
+  end
 end

data/lib/cloudinary/railtie.rb

@@ -3,7 +3,9 @@ class Cloudinary::Railtie < Rails::Railtie
     Dir[File.join(File.dirname(__FILE__),'../tasks/**/*.rake')].each { |f| load f }
   end
   config.after_initialize do |app|
-    ActionView::Base.send :include, CloudinaryHelper
+    ActiveSupport.on_load(:action_view) do
+      ActionView::Base.send :include, CloudinaryHelper
+    end
   end
 
   ActiveSupport.on_load(:action_controller_base) do

data/lib/cloudinary/search.rb

@@ -4,7 +4,8 @@ class Cloudinary::Search
   SORT_BY    = :sort_by
   AGGREGATE  = :aggregate
   WITH_FIELD = :with_field
-  KEYS_WITH_UNIQUE_VALUES = [SORT_BY, AGGREGATE, WITH_FIELD].freeze
+  FIELDS     = :fields
+  KEYS_WITH_UNIQUE_VALUES = [SORT_BY, AGGREGATE, WITH_FIELD, FIELDS].freeze
 
   TTL = 300 # Used for search URLs
 
@@ -12,7 +13,8 @@ class Cloudinary::Search
     @query_hash = {
       SORT_BY    => {},
       AGGREGATE  => {},
-      WITH_FIELD => {}
+      WITH_FIELD => {},
+      FIELDS => {},
     }
 
     @endpoint = self.class::ENDPOINT
@@ -59,7 +61,7 @@ class Cloudinary::Search
   #
   # @param [String] value  Supported values: resource_type, type, pixels (only the image assets in the response are
   #                        aggregated), duration (only the video assets in the response are aggregated), format, and
-  #                        bytes. For aggregation fields without discrete values, the results are divided into 
+  #                        bytes. For aggregation fields without discrete values, the results are divided into
   #                        categories.
   # @return [Cloudinary::Search]
   def aggregate(value)
@@ -77,6 +79,19 @@ class Cloudinary::Search
     self
   end
 
+
+  # The list of the asset attributes to include for each asset in the response.
+  #
+  # @param [Array] value The array of attributes' names.
+  #
+  # @return [Cloudinary::Search]
+  def fields(value)
+    Cloudinary::Utils.build_array(value).each do |field|
+      @query_hash[FIELDS][field] = field
+    end
+    self
+  end
+
   # Sets the time to live of the search URL.
   #
   # @param [Object] ttl The time to live in seconds.

data/lib/cloudinary/utils.rb

@@ -998,6 +998,12 @@ class Cloudinary::Utils
     option_value.nil? ? default_value : option_value
   end
 
+  def self.config_option_fetch(options, option_name, default_value = nil)
+    return options.fetch(option_name) if options.include?(option_name)
+    option_value = Cloudinary.config.send(option_name)
+    option_value.nil? ? default_value : option_value
+  end
+
   def self.as_bool(value)
     case value
     when nil then nil
@@ -1250,7 +1256,8 @@ class Cloudinary::Utils
   # @param options url and transformation options. This argument may be changed by the function!
   #
   def self.patch_fetch_format(options={})
-    if options[:type] === :fetch
+    use_fetch_format = config_option_consume(options, :use_fetch_format)
+    if options[:type] === :fetch || use_fetch_format
       format_arg = options.delete(:format)
       options[:fetch_format] ||= format_arg
     end

data/lib/cloudinary/version.rb

@@ -1,4 +1,4 @@
 # Copyright Cloudinary
 module Cloudinary
-  VERSION = "1.28.0"
+  VERSION = "1.29.0"
 end

data/lib/cloudinary/video_helper.rb

@@ -53,7 +53,7 @@ module CloudinaryHelper
   #     }
   #   ])
   def cl_video_tag(source, options = {}, &block)
-    source = strip_known_ext(source)
+    source = strip_known_ext(source) unless Cloudinary::Utils.config_option_fetch(options, :use_fetch_format)
     video_attributes = [:autoplay,:controls,:loop,:muted,:poster, :preload]
     options = Cloudinary::Utils.deep_symbolize_keys(DEFAULT_VIDEO_OPTIONS.merge(options))
 
@@ -155,8 +155,9 @@ module CloudinaryHelper
       content_tag('video', tag_options.merge(video_options)) do
         source_tags = sources.map do |source|
           type = source[:type]
+          options[:format] = type
           transformation = source[:transformations] || {}
-          cloudinary_tag("#{source_name}.#{type}", options.merge(transformation)) do |url, _tag_options|
+          cloudinary_tag(source_name, options.merge(transformation)) do |url, _tag_options|
             mime_type = "video/#{(type == 'ogv' ? 'ogg' : type)}"
             if source[:codecs]
               codecs = source[:codecs].is_a?(Array) ? source[:codecs].join(", ") : source[:codecs]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudinary
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.29.0
 platform: ruby
 authors:
 - Nadav Soferman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws_cf_signer
@@ -86,16 +86,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement