cloudinary 1.26.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb33366a739a067a66cbcaf66534e48663e726d57f4d4b3657c44ec43f092e7
-  data.tar.gz: 0dd05a5beabf06fc8d1914c7375fa7a6d37fce532edca0021919e13d9b28d318
+  metadata.gz: 97b754051e806086f5dfb98479292bb84bed48968c242d8c55dfa073a8d90e52
+  data.tar.gz: 6a6484d454b0b074fa177b68e90bb62a100c90aa3f4b3ab33dad9acd64d7ec4d
 SHA512:
-  metadata.gz: 64cb7b27cd9909da6fbbaaf98777d4f05046098a6adb1572998323fd7517bf30c73095844683c83da59808f5945c93e90f1e2c685e06ff156b682fe92e902878
-  data.tar.gz: f098206a8c9f6c73609ad2415cfc90f8359c678461d0bb22f5164aba57111fe55129eed6e98767c6242387ee6294bf4139b034848a1ff9b792cf1dba9fa3ef77
+  metadata.gz: dd822c6ec7144df3f7ab863d834802c486bc31ef5051cafbb9d331279a0f3092906990c211ccf1802515d53d51f64e71fd1bd73acc8a2f368c22bddd90ea3a38
+  data.tar.gz: cc2299facddd71188d08c0f934ad8483bc0c9414364699e3f84a20eee489f0883adca4ba838a9534d417e11580ff194761d0d26cc978079c9e3b2f42cceeaa48

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+1.28.0 / 2023-11-06
+==================
+
+New functionality and features
+------------------------------
+
+  * Add support for `image_file` parameter in `visual_search` Admin API
+  * Add support for `on_success` upload parameter
+
+Other Changes
+-------------
+
+  * Replace `update_all` to `update_column` in CarrierWave storage
+
+1.27.0 / 2023-07-31
+==================
+
+New functionality and features
+------------------------------
+
+  * Add support for `visual_search` Admin API
+  * Add support for Search URL
+  * Add support for `SearchFolders` API
+  * Add support for `media_metadata` API parameter
+
 1.26.0 / 2023-06-01
 ==================
 

data/lib/cloudinary/api.rb

@@ -207,6 +207,20 @@ class Cloudinary::Api
     call_api(:get, uri, params, options)
   end
 
+  # Find images based on their visual content.
+  #
+  # @param [Hash]   options      The optional parameters.
+  #
+  # @return [Cloudinary::Api::Response]
+  #
+  # @raise [Cloudinary::Api::Error]
+  def self.visual_search(options = {})
+    uri    = "resources/visual_search"
+    params = only(options, :image_url, :image_asset_id, :text, :image_file)
+    params[:image_file] = Cloudinary::Utils.handle_file_param(params[:image_file]) if params.has_key?(:image_file)
+    call_api(:post, uri, params, options)
+  end
+
   # Returns the details of the specified asset and all its derived assets.
   #
   # Note that if you only need details about the original asset,
@@ -1293,6 +1307,7 @@ class Cloudinary::Api
          :faces,
          :quality_analysis,
          :image_metadata,
+         :media_metadata,
          :phash,
          :pages,
          :cinemagraph_analysis,

data/lib/cloudinary/carrier_wave/storage.rb

@@ -82,14 +82,7 @@ class Cloudinary::CarrierWave::Storage < ::CarrierWave::Storage::Abstract
     end
 
     if defined?(ActiveRecord::Base) && uploader.model.is_a?(ActiveRecord::Base)
-      primary_key = model_class.primary_key.to_sym
-      if defined?(::ActiveRecord::VERSION::MAJOR) && ::ActiveRecord::VERSION::MAJOR > 2
-        model_class.where(primary_key=>uploader.model.send(primary_key)).update_all(column=>name)
-      else
-        # Removed since active record version 3.0.0
-        model_class.update_all({column=>name}, {primary_key=>uploader.model.send(primary_key)})
-      end
-      uploader.model.send :write_attribute, column, name
+      uploader.model.update_column(column, name)
     elsif defined?(Mongoid::Document) && uploader.model.is_a?(Mongoid::Document)
       # Mongoid support
       if Mongoid::VERSION.split(".").first.to_i >= 4

data/lib/cloudinary/search.rb

@@ -1,15 +1,23 @@
 class Cloudinary::Search
+  ENDPOINT = 'resources'
+
   SORT_BY    = :sort_by
   AGGREGATE  = :aggregate
   WITH_FIELD = :with_field
   KEYS_WITH_UNIQUE_VALUES = [SORT_BY, AGGREGATE, WITH_FIELD].freeze
 
+  TTL = 300 # Used for search URLs
+
   def initialize
     @query_hash = {
       SORT_BY    => {},
       AGGREGATE  => {},
       WITH_FIELD => {}
     }
+
+    @endpoint = self.class::ENDPOINT
+
+    @ttl = self.class::TTL
   end
 
   ## implicitly generate an instance delegate the method
@@ -69,11 +77,21 @@ class Cloudinary::Search
     self
   end
 
+  # Sets the time to live of the search URL.
+  #
+  # @param [Object] ttl The time to live in seconds.
+  #
+  # @return [Cloudinary::Search]
+  def ttl(ttl)
+    @ttl = ttl
+    self
+  end
+
   # Returns the query as an hash.
   #
   # @return [Hash]
   def to_h
-    @query_hash.each_with_object({}) do |(key, value), query|
+    @query_hash.sort.each_with_object({}) do |(key, value), query|
       next if value.nil? || ((value.is_a?(Array) || value.is_a?(Hash)) && value.blank?)
 
       query[key] = KEYS_WITH_UNIQUE_VALUES.include?(key) ? value.values : value
@@ -82,7 +100,44 @@ class Cloudinary::Search
 
   def execute(options = {})
     options[:content_type] = :json
-    uri = 'resources/search'
+    uri = "#{@endpoint}/search"
     Cloudinary::Api.call_api(:post, uri, to_h, options)
   end
+
+  # Creates a signed Search URL that can be used on the client side.
+  #
+  # @param [Integer] ttl The time to live in seconds.
+  # @param [String] next_cursor Starting position.
+  # @param [Hash] options Additional url delivery options.
+  #
+  # @return [String] The resulting Search URL
+  def to_url(ttl = nil, next_cursor = nil, options = {})
+    api_secret = options[:api_secret] || Cloudinary.config.api_secret || raise(CloudinaryException, "Must supply api_secret")
+
+    ttl   = ttl || @ttl
+    query = self.to_h
+
+    _next_cursor = query.delete(:next_cursor)
+    next_cursor  = _next_cursor if next_cursor.nil?
+
+    b64query = Base64.urlsafe_encode64(JSON.generate(query))
+
+    prefix = Cloudinary::Utils.build_distribution_domain(options)
+
+    signature = Cloudinary::Utils.hash("#{ttl}#{b64query}#{api_secret}", :sha256, :hexdigest)
+
+    next_cursor = "/#{next_cursor}" if !next_cursor.nil? && !next_cursor.empty?
+
+    "#{prefix}/search/#{signature}/#{ttl}/#{b64query}#{next_cursor}"
+  end
+
+  # Sets the API endpoint.
+  #
+  # @param [String] endpoint the endpoint to set.
+  #
+  # @return [Cloudinary::Search]
+  def endpoint(endpoint)
+    @endpoint = endpoint
+    self
+  end
 end

data/lib/cloudinary/search_folders.rb

@@ -0,0 +1,5 @@
+# The Cloudinary API folders search method allows you fine control on filtering and retrieving information on all the
+# folders in your cloud with the help of query expressions in a Lucene-like query language.
+class Cloudinary::SearchFolders < Cloudinary::Search
+  ENDPOINT = 'folders'
+end

data/lib/cloudinary/uploader.rb

@@ -40,6 +40,7 @@ class Cloudinary::Uploader
       :eager_notification_url               => options[:eager_notification_url],
       :exif                                 => Cloudinary::Utils.as_safe_bool(options[:exif]),
       :eval                                 => options[:eval],
+      :on_success                           => options[:on_success],
       :face_coordinates                     => Cloudinary::Utils.encode_double_array(options[:face_coordinates]),
       :faces                                => Cloudinary::Utils.as_safe_bool(options[:faces]),
       :folder                               => options[:folder],
@@ -47,6 +48,7 @@ class Cloudinary::Uploader
       :filename_override                    => options[:filename_override],
       :headers                              => build_custom_headers(options[:headers]),
       :image_metadata                       => Cloudinary::Utils.as_safe_bool(options[:image_metadata]),
+      :media_metadata                       => Cloudinary::Utils.as_safe_bool(options[:media_metadata]),
       :invalidate                           => Cloudinary::Utils.as_safe_bool(options[:invalidate]),
       :moderation                           => options[:moderation],
       :notification_url                     => options[:notification_url],
@@ -62,6 +64,7 @@ class Cloudinary::Uploader
       :responsive_breakpoints               => Cloudinary::Utils.generate_responsive_breakpoints_string(options[:responsive_breakpoints]),
       :return_delete_token                  => Cloudinary::Utils.as_safe_bool(options[:return_delete_token]),
       :similarity_search                    => options[:similarity_search],
+      :visual_search                        => Cloudinary::Utils.as_safe_bool(options[:visual_search]),
       :tags                                 => options[:tags] && Cloudinary::Utils.build_array(options[:tags]).join(","),
       :timestamp                            => (options[:timestamp] || Time.now.to_i),
       :transformation                       => Cloudinary::Utils.generate_transformation_string(options.clone),
@@ -85,16 +88,7 @@ class Cloudinary::Uploader
   def self.upload(file, options={})
     call_api("upload", options) do
       params = build_upload_params(options)
-      if file.is_a?(Pathname)
-        params[:file] = File.open(file, "rb")
-      elsif file.is_a?(StringIO)
-        file.rewind
-        params[:file] = Cloudinary::Blob.new(file.read, options)
-      elsif file.respond_to?(:read) || Cloudinary::Utils.is_remote?(file)
-        params[:file] = file
-      else
-        params[:file] = File.open(file, "rb")
-      end
+      params[:file] = Cloudinary::Utils.handle_file_param(file, options)
       [params, [:file]]
     end
   end
@@ -151,11 +145,7 @@ class Cloudinary::Uploader
     options[:resource_type] ||= :raw
     call_api("upload", options) do
       params = build_upload_params(options)
-      if file.is_a?(Pathname) || !file.respond_to?(:read)
-        params[:file] = File.open(file, "rb")
-      else
-        params[:file] = file
-      end
+      params[:file] = Cloudinary::Utils.handle_file_param(file, options)
       [params, [:file]]
     end
   end

data/lib/cloudinary/utils.rb

@@ -524,18 +524,10 @@ class Cloudinary::Utils
     version = options.delete(:version)
     force_version = config_option_consume(options, :force_version, true)
     format = options.delete(:format)
-    cloud_name = config_option_consume(options, :cloud_name) || raise(CloudinaryException, "Must supply cloud_name in tag or in configuration")
 
-    secure = options.delete(:secure)
-    ssl_detected = options.delete(:ssl_detected)
-    secure = ssl_detected || Cloudinary.config.secure if secure.nil?
-    private_cdn = config_option_consume(options, :private_cdn)
-    secure_distribution = config_option_consume(options, :secure_distribution)
-    cname = config_option_consume(options, :cname)
     shorten = config_option_consume(options, :shorten)
     force_remote = options.delete(:force_remote)
-    cdn_subdomain = config_option_consume(options, :cdn_subdomain)
-    secure_cdn_subdomain = config_option_consume(options, :secure_cdn_subdomain)
+
     sign_url = config_option_consume(options, :sign_url)
     secret = config_option_consume(options, :api_secret)
     sign_version = config_option_consume(options, :sign_version) # Deprecated behavior
@@ -558,7 +550,7 @@ class Cloudinary::Utils
     type = type.to_s unless type.nil?
     resource_type ||= "image"
     source = source.to_s
-    if !force_remote
+    unless force_remote
       static_support = Cloudinary.config.static_file_support || Cloudinary.config.static_image_support
       return original_source if !static_support && type == "asset"
       return original_source if (type.nil? || type == "asset") && source.match(%r(^https?:/)i)
@@ -594,7 +586,9 @@ class Cloudinary::Utils
       signature = "s--#{signature[0, long_url_signature ? LONG_URL_SIGNATURE_LENGTH : SHORT_URL_SIGNATURE_LENGTH ]}--"
     end
 
-    prefix = unsigned_download_url_prefix(source, cloud_name, private_cdn, cdn_subdomain, secure_cdn_subdomain, cname, secure, secure_distribution)
+    options[:source] = source
+    prefix = build_distribution_domain(options)
+
     source = [prefix, resource_type, type, signature, transformation, version, source].reject(&:blank?).join("/")
     if sign_url && auth_token && !auth_token.empty?
       auth_token[:url] = URI.parse(source).path
@@ -707,6 +701,22 @@ class Cloudinary::Utils
     prefix
   end
 
+  def self.build_distribution_domain(options = {})
+    cloud_name = config_option_consume(options, :cloud_name) || raise(CloudinaryException, "Must supply cloud_name in tag or in configuration")
+
+    source = options.delete(:source)
+    secure = options.delete(:secure)
+    ssl_detected = options.delete(:ssl_detected)
+    secure = ssl_detected || Cloudinary.config.secure if secure.nil?
+    private_cdn = config_option_consume(options, :private_cdn)
+    secure_distribution = config_option_consume(options, :secure_distribution)
+    cname = config_option_consume(options, :cname)
+    cdn_subdomain = config_option_consume(options, :cdn_subdomain)
+    secure_cdn_subdomain = config_option_consume(options, :secure_cdn_subdomain)
+
+    unsigned_download_url_prefix(source, cloud_name, private_cdn, cdn_subdomain, secure_cdn_subdomain, cname, secure, secure_distribution)
+  end
+
   # Creates a base URL for the cloudinary api
   #
   # @param [Object] path  Resource name
@@ -1285,6 +1295,27 @@ class Cloudinary::Utils
     }
   end
 
+  # Handles file parameter.
+  #
+  # @param [Pathname, StringIO, File, String, int, _ToPath] file
+  # @return [StringIO, File] A File object.
+  #
+  # @private
+  def self.handle_file_param(file, options = {})
+    if file.is_a?(Pathname)
+      return File.open(file, "rb")
+    elsif file.is_a?(Cloudinary::Blob)
+      return file
+    elsif file.is_a?(StringIO)
+      file.rewind
+      return Cloudinary::Blob.new(file.read, options)
+    elsif file.respond_to?(:read) || Cloudinary::Utils.is_remote?(file)
+      return file
+    end
+
+    File.open(file, "rb")
+  end
+
   # The returned url should allow downloading the backedup asset based on the version and asset id
   #
   # asset and version id are returned with resource(<PUBLIC_ID1>, { versions: true })
@@ -1373,6 +1404,4 @@ class Cloudinary::Utils
     algorithm = ALGORITHM_SIGNATURE[signature_algorithm] || raise("Unsupported algorithm '#{signature_algorithm}'")
     algorithm.public_send(hash_method, input)
   end
-
-  private_class_method :hash
 end

data/lib/cloudinary/version.rb

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

data/lib/cloudinary.rb

@@ -28,6 +28,7 @@ module Cloudinary
   autoload :Static, "cloudinary/static"
   autoload :CarrierWave, "cloudinary/carrier_wave"
   autoload :Search, "cloudinary/search"
+  autoload :SearchFolders, "cloudinary/search_folders"
 
   CF_SHARED_CDN         = "d3jpl91pxevbkh.cloudfront.net"
   AKAMAI_SHARED_CDN     = "res.cloudinary.com"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudinary
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Nadav Soferman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws_cf_signer
@@ -235,6 +235,7 @@ files:
 - lib/cloudinary/railtie.rb
 - lib/cloudinary/responsive.rb
 - lib/cloudinary/search.rb
+- lib/cloudinary/search_folders.rb
 - lib/cloudinary/static.rb
 - lib/cloudinary/uploader.rb
 - lib/cloudinary/utils.rb