cloudinary 1.11.1 → 1.18.0

data/lib/cloudinary.rb

@@ -29,8 +29,8 @@ module Cloudinary
   OLD_AKAMAI_SHARED_CDN = "cloudinary-a.akamaihd.net"
   SHARED_CDN            = AKAMAI_SHARED_CDN
 
-  USER_AGENT      = "CloudinaryRuby/" + VERSION
-  @@user_platform = ""
+  USER_AGENT      = "CloudinaryRuby/#{VERSION} (Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
+  @@user_platform = defined?(Rails.version) ? "Rails/#{Rails.version}" : ""
 
   # Add platform information to the USER_AGENT header
   # This is intended for platform information and not individual applications!
@@ -44,7 +44,7 @@ module Cloudinary
 
   def self.USER_AGENT
     if @@user_platform.empty?
-      "#{USER_AGENT}"
+      USER_AGENT
     else
       "#{@@user_platform} #{USER_AGENT}"
     end
@@ -64,19 +64,7 @@ module Cloudinary
     first_time = @@config.nil?
     @@config   ||= OpenStruct.new((YAML.load(ERB.new(IO.read(config_dir.join("cloudinary.yml"))).result)[config_env] rescue {}))
 
-    # Heroku support
-    if first_time && ENV["CLOUDINARY_CLOUD_NAME"]
-      set_config(
-        "cloud_name"          => ENV["CLOUDINARY_CLOUD_NAME"],
-        "api_key"             => ENV["CLOUDINARY_API_KEY"],
-        "api_secret"          => ENV["CLOUDINARY_API_SECRET"],
-        "secure_distribution" => ENV["CLOUDINARY_SECURE_DISTRIBUTION"],
-        "private_cdn"         => ENV["CLOUDINARY_PRIVATE_CDN"].to_s == 'true',
-        "secure"              => ENV["CLOUDINARY_SECURE"].to_s == 'true'
-      )
-    elsif first_time && ENV["CLOUDINARY_URL"]
-      config_from_url(ENV["CLOUDINARY_URL"])
-    end
+    config_from_env if first_time
 
     set_config(new_config) if new_config
     yield(@@config) if block_given?
@@ -86,7 +74,12 @@ module Cloudinary
 
   def self.config_from_url(url)
     @@config ||= OpenStruct.new
-    uri      = URI.parse(url)
+    return unless url && !url.empty?
+    uri = URI.parse(url)
+    if !uri.scheme || "cloudinary" != uri.scheme.downcase
+      raise(CloudinaryException,
+        "Invalid CLOUDINARY_URL scheme. Expecting to start with 'cloudinary://'")
+    end
     set_config(
       "cloud_name"          => uri.host,
       "api_key"             => uri.user,
@@ -100,7 +93,7 @@ module Cloudinary
       if isNestedKey? key
         putNestedKey key, value
       else
-        set_config(key => URI.decode(value))
+        set_config(key => Utils.smart_unescape(value))
       end
     end
   end
@@ -135,18 +128,34 @@ module Cloudinary
   end
 
   private
-  
+
+  def self.config_from_env
+    # Heroku support
+    if ENV["CLOUDINARY_CLOUD_NAME"]
+      config_keys = ENV.keys.select! { |key| key.start_with? "CLOUDINARY_" }
+      config_keys -= ["CLOUDINARY_URL"] # ignore it when explicit options are passed
+      config_keys.each do |full_key|
+        conf_key = full_key["CLOUDINARY_".length..-1].downcase # convert "CLOUDINARY_CONFIG_NAME" to "config_name"
+        conf_val = ENV[full_key]
+        conf_val = conf_val == 'true' if %w[true false].include?(conf_val) # cast relevant boolean values
+        set_config(conf_key => conf_val)
+      end
+    elsif ENV["CLOUDINARY_URL"]
+      config_from_url(ENV["CLOUDINARY_URL"])
+    end
+  end
+
   def self.config_env
     return ENV["CLOUDINARY_ENV"] if ENV["CLOUDINARY_ENV"]
     return Rails.env if defined? Rails::env
     nil
   end
-  
+
   def self.config_dir
-    return Pathname.new(ENV["CLOUDINARY_CONFIG_DIR"]) if ENV["CLOUDINARY_CONFIG_DIR"] 
+    return Pathname.new(ENV["CLOUDINARY_CONFIG_DIR"]) if ENV["CLOUDINARY_CONFIG_DIR"]
     self.app_root.join("config")
   end
-  
+
   def self.set_config(new_config)
     new_config.each{|k,v| @@config.send(:"#{k}=", v) if !v.nil?}
   end

data/lib/cloudinary/api.rb

@@ -78,8 +78,9 @@ class Cloudinary::Api
     resource_type = options[:resource_type] || "image"
     type          = options[:type] || "upload"
     uri           = "resources/#{resource_type}/#{type}/#{public_id}"
-    call_api(:get, uri, 
-             only(options, 
+    call_api(:get, uri,
+             only(options,
+                  :cinemagraph_analysis,
                   :colors,
                   :coordinates,
                   :exif,
@@ -88,7 +89,9 @@ class Cloudinary::Api
                   :max_results,
                   :pages,
                   :phash,
-                  :quality_analysis
+                  :quality_analysis,
+                  :derived_next_cursor,
+                  :accessibility_analysis
              ), options)
   end
 
@@ -226,11 +229,21 @@ class Cloudinary::Api
   end
 
   def self.root_folders(options={})
-    call_api(:get, "folders", {}, options)
+    params = only(options, :max_results, :next_cursor)
+    call_api(:get, "folders", params, options)
   end
 
   def self.subfolders(of_folder_path, options={})
-    call_api(:get, "folders/#{of_folder_path}", {}, options)
+    params = only(options, :max_results, :next_cursor)
+    call_api(:get, "folders/#{of_folder_path}", params, options)
+  end
+
+  def self.delete_folder(path, options={})
+    call_api(:delete, "folders/#{path}", {}, options)
+  end
+
+  def self.create_folder(folder_name, options={})
+    call_api(:post, "folders/#{folder_name}", {}, options)
   end
 
   def self.upload_mappings(options={})
@@ -335,6 +348,144 @@ class Cloudinary::Api
     call_json_api('GET', json_url, {}, 60, {})
   end
 
+  # Returns a list of all metadata field definitions.
+  #
+  # @see https://cloudinary.com/documentation/admin_api#get_metadata_fields Get metadata fields API reference
+  #
+  # @param [Hash] options Additional options
+  # @return [Cloudinary::Api::Response]
+  # @raise [Cloudinary::Api::Error]
+  def self.list_metadata_fields(options = {})
+    call_metadata_api(:get, [], {}, options)
+  end
+
+  # Gets a metadata field by external id.
+  #
+  # @see https://cloudinary.com/documentation/admin_api#get_a_metadata_field_by_external_id Get metadata field by external ID API reference
+  #
+  # @param [String] field_external_id The ID of the metadata field to retrieve
+  # @param [Hash]   options           Additional options
+  # @return [Cloudinary::Api::Response]
+  # @raise [Cloudinary::Api::Error]
+  def self.metadata_field_by_field_id(field_external_id, options = {})
+    uri = [field_external_id]
+
+    call_metadata_api(:get, uri, {}, options)
+  end
+
+  # Creates a new metadata field definition.
+  #
+  # @see https://cloudinary.com/documentation/admin_api#create_a_metadata_field Create metadata field API reference
+  #
+  # @param [Hash] field   The field to add
+  # @param [Hash] options Additional options
+  # @return [Cloudinary::Api::Response]
+  # @raise [Cloudinary::Api::Error]
+  def self.add_metadata_field(field, options = {})
+    params = only(field, :type, :external_id, :label, :mandatory, :default_value, :validation, :datasource)
+
+    call_metadata_api(:post, [], params, options)
+  end
+
+  # Updates a metadata field by external id.
+  #
+  # Updates a metadata field definition (partially, no need to pass the entire object) passed as JSON data.
+  # See https://cloudinary.com/documentation/admin_api#generic_structure_of_a_metadata_field for the generic structure
+  # of a metadata field.
+  #
+  # @see https://cloudinary.com/documentation/admin_api#update_a_metadata_field_by_external_id Update metadata field API reference
+  #
+  # @param [String] field_external_id The id of the metadata field to update
+  # @param [Hash]   field             The field definition
+  # @param [Hash]   options           Additional options
+  # @return [Cloudinary::Api::Response]
+  # @raise [Cloudinary::Api::Error]
+  def self.update_metadata_field(field_external_id, field, options = {})
+    uri = [field_external_id]
+    params = only(field, :label, :mandatory, :default_value, :validation)
+
+    call_metadata_api(:put, uri, params, options)
+  end
+
+  # Deletes a metadata field definition.
+  #
+  # The field should no longer be considered a valid candidate for all other endpoints.
+  #
+  # @see https://cloudinary.com/documentation/admin_api#delete_a_metadata_field_by_external_id Delete metadata field API reference
+  #
+  # @param [String] field_external_id The external id of the field to delete
+  # @param [Hash]   options           Additional options
+  # @return [Cloudinary::Api::Response] A hash with a "message" key. "ok" value indicates a successful deletion
+  # @raise [Cloudinary::Api::Error]
+  def self.delete_metadata_field(field_external_id, options = {})
+    uri = [field_external_id]
+
+    call_metadata_api(:delete, uri, {}, options)
+  end
+
+  # Deletes entries in a metadata field datasource.
+  #
+  # Deletes (blocks) the datasource entries for a specified metadata field definition. Sets the state of the
+  # entries to inactive. This is a soft delete, the entries still exist under the hood and can be activated
+  # again with the restore datasource entries method.
+  #
+  # @see https://cloudinary.com/documentation/admin_api#delete_entries_in_a_metadata_field_datasource Delete entries in a metadata field datasource API reference
+  #
+  # @param [String] field_external_id    The id of the field to update
+  # @param [Array]  entries_external_id  The ids of all the entries to delete from the datasource
+  # @param [Hash]   options              Additional options
+  # @return [Cloudinary::Api::Response] The remaining datasource entries
+  # @raise [Cloudinary::Api::Error]
+  def self.delete_datasource_entries(field_external_id, entries_external_id, options = {})
+    uri = [field_external_id, "datasource"]
+    params = {:external_ids => entries_external_id }
+
+    call_metadata_api(:delete, uri, params, options)
+  end
+
+  # Updates a metadata field datasource.
+  #
+  # Updates the datasource of a supported field type (currently only enum and set), passed as JSON data. The
+  # update is partial: datasource entries with an existing external_id will be updated and entries with new
+  # external_id’s (or without external_id’s) will be appended.
+  #
+  # @see https://cloudinary.com/documentation/admin_api#update_a_metadata_field_datasource Update a metadata field datasource API reference
+  #
+  # @param [String] field_external_id   The external id of the field to update
+  # @param [Array]  entries_external_id
+  # @param [Hash]   options             Additional options
+  # @return [Cloudinary::Api::Response]
+  # @raise [Cloudinary::Api::Error]
+  def self.update_metadata_field_datasource(field_external_id, entries_external_id, options = {})
+    uri = [field_external_id, "datasource"]
+
+    params = entries_external_id.each_with_object({:values => [] }) do |item, hash|
+      item = only(item, :external_id, :value)
+      hash[:values ] << item if item.present?
+    end
+
+    call_metadata_api(:put, uri, params, options)
+  end
+
+  # Restores entries in a metadata field datasource.
+  #
+  # Restores (unblocks) any previously deleted datasource entries for a specified metadata field definition.
+  # Sets the state of the entries to active.
+  #
+  # @see https://cloudinary.com/documentation/admin_api#restore_entries_in_a_metadata_field_datasource Restore entries in a metadata field datasource API reference
+  #
+  # @param [String] field_external_id    The ID of the metadata field
+  # @param [Array]  entries_external_ids An array of IDs of datasource entries to restore (unblock)
+  # @param [Hash]   options              Additional options
+  # @return [Cloudinary::Api::Response]
+  # @raise [Cloudinary::Api::Error]
+  def self.restore_metadata_field_datasource(field_external_id, entries_external_ids, options = {})
+    uri = [field_external_id, "datasource_restore"]
+    params = {:external_ids => entries_external_ids }
+
+    call_metadata_api(:post, uri, params, options)
+  end
+
   protected
 
   def self.call_api(method, uri, params, options)
@@ -343,6 +494,7 @@ class Cloudinary::Api
     api_key    = options[:api_key] || Cloudinary.config.api_key || raise("Must supply api_key")
     api_secret = options[:api_secret] || Cloudinary.config.api_secret || raise("Must supply api_secret")
     timeout    = options[:timeout] || Cloudinary.config.timeout || 60
+    uri = Cloudinary::Utils.smart_escape(uri)
     api_url    = [cloudinary, "v1_1", cloud_name, uri].join("/")
     # Add authentication
     api_url.sub!(%r(^(https?://)), "\\1#{api_key}:#{api_secret}@")
@@ -382,6 +534,22 @@ class Cloudinary::Api
     raise GeneralError.new("Error parsing server response (#{response.code}) - #{response.body}. Got - #{e}")
   end
 
+  # Protected function that assists with performing an API call to the metadata_fields part of the Admin API.
+  #
+  # @protected
+  # @param [Symbol] method  The HTTP method. Valid methods: get, post, put, delete
+  # @param [Array]  uri     REST endpoint of the API (without 'metadata_fields')
+  # @param [Hash]   params  Query/body parameters passed to the method
+  # @param [Hash]   options Additional options. Can be an override of the configuration, headers, etc.
+  # @return [Cloudinary::Api::Response]
+  # @raise [Cloudinary::Api::Error]
+  def self.call_metadata_api(method, uri, params, options)
+    options[:content_type] = :json
+    uri = ["metadata_fields", uri].reject(&:empty?).join("/")
+
+    call_api(method, uri, params, options)
+  end
+
   def self.only(hash, *keys)
     result = {}
     keys.each do |key|

data/lib/cloudinary/auth_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'openssl'
 if RUBY_VERSION > "2"
   require "ostruct"
@@ -10,6 +12,7 @@ module Cloudinary
   module AuthToken
     SEPARATOR = '~'
     UNSAFE = /[ "#%&\'\/:;<=>?@\[\\\]^`{\|}~]/
+    EMPTY_TOKEN = {}.freeze
 
     def self.generate(options = {})
       key = options[:key]
@@ -42,12 +45,11 @@ module Cloudinary
       "#{name}=#{token.join(SEPARATOR)}"
     end
 
-
     # Merge token2 to token1 returning a new
     # Requires to support Ruby 1.9
     def self.merge_auth_token(token1, token2)
-      token1 = token1 || {}
-      token2 = token2 || {}
+      token1 = token1 || EMPTY_TOKEN
+      token2 = token2 || EMPTY_TOKEN
       token1 = token1.respond_to?( :to_h) ? token1.to_h : token1
       token2 = token2.respond_to?( :to_h) ? token2.to_h : token2
       token1.merge(token2)
@@ -69,4 +71,4 @@ module Cloudinary
       OpenSSL::HMAC.hexdigest(digest, bin_key, message)
     end
   end
-end
+end

data/lib/cloudinary/carrier_wave.rb

@@ -9,8 +9,10 @@ module Cloudinary::CarrierWave
 
   def self.included(base)
     base.storage Cloudinary::CarrierWave::Storage
+    base.cache_storage = :file if base.cache_storage.blank?
     base.extend ClassMethods
-    base.class_attribute :storage_type, :metadata
+    base.class_attribute :metadata
+    base.class_attribute :storage_type, instance_reader: false
     override_in_versions(base, :blank?, :full_public_id, :my_public_id, :all_versions_processors, :stored_version)
   end
 

data/lib/cloudinary/carrier_wave/remote.rb

@@ -1,10 +1,11 @@
 module Cloudinary::CarrierWave
   def download!(uri, *args)
-    return super if !self.cloudinary_should_handle_remote?
+    return super unless self.cloudinary_should_handle_remote?
     if respond_to?(:process_uri)
       uri = process_uri(uri)
     else # Backward compatibility with old CarrierWave
-      uri = URI.parse(URI.escape(URI.unescape(uri)))
+      remote_url_unsafe_chars = /([^a-zA-Z0-9_.\-\/:?&=]+)/ # In addition allow query string characters: "?","&" and "="
+      uri = URI.parse(Cloudinary::Utils.smart_escape(Cloudinary::Utils.smart_unescape(uri), remote_url_unsafe_chars))
     end
     return if uri.to_s.blank?
     self.original_filename = @cache_id = @filename = File.basename(uri.path).gsub(/[^a-zA-Z0-9\.\-\+_]/, '')

data/lib/cloudinary/carrier_wave/storage.rb

@@ -1,7 +1,8 @@
 class Cloudinary::CarrierWave::Storage < ::CarrierWave::Storage::Abstract
 
   def store!(file)
-    return if !uploader.enable_processing
+    return unless uploader.enable_processing
+
     if uploader.is_main_uploader?
       case file
       when Cloudinary::CarrierWave::PreloadedCloudinaryFile

data/lib/cloudinary/cloudinary_controller.rb

@@ -1,13 +1,11 @@
 module Cloudinary::CloudinaryController
   protected
-  
+
   def valid_cloudinary_response?
     received_signature = request.query_parameters[:signature]
     calculated_signature = Cloudinary::Utils.api_sign_request(
       request.query_parameters.select{|key, value| [:public_id, :version].include?(key.to_sym)},
       Cloudinary.config.api_secret)
     return received_signature == calculated_signature
-  end  
+  end
 end
-
-ActionController::Base.send :include, Cloudinary::CloudinaryController

data/lib/cloudinary/helper.rb

@@ -286,7 +286,7 @@ module CloudinaryHelper
     Cloudinary::Utils.private_download_url(public_id, format, options)
   end
 
-  # Helper method that uses the deprecated ZIP download API. 
+  # Helper method that uses the deprecated ZIP download API.
   # Replaced by cl_download_zip_url that uses the more advanced and robust archive generation and download API
   # @deprecated
   def cl_zip_download_url(tag, options = {})
@@ -296,7 +296,7 @@ module CloudinaryHelper
   # @see {Cloudinary::Utils.download_archive_url}
   def cl_download_archive_url(options = {})
     Cloudinary::Utils.download_archive_url(options)
-  end  
+  end
 
   # @see {Cloudinary::Utils.download_zip_url}
   def cl_download_zip_url(options = {})
@@ -318,7 +318,7 @@ module CloudinaryHelper
       if Cloudinary.config.enhance_image_tag
         alias_method :image_tag, :image_tag_with_cloudinary
         alias_method :image_path, :image_path_with_cloudinary
-      end    
+      end
     end
   end
 
@@ -419,3 +419,30 @@ rescue LoadError
   # no sass support. Ignore.
 end
 
+begin
+  require 'sassc'
+  require 'sassc/script/functions'
+  module SassC::Script::Functions
+    # Helper method for generating cloudinary_url in scss files.
+    #
+    # As opposed to sass(deprecated), optional named arguments are not supported, use hash map instead.
+    #
+    # Example:
+    #   Sass: cloudinary-url("sample", $quality: "auto", $fetch_format: "auto");
+    #  becomes
+    #   SassC: cloudinary-url("sample", ("quality": "auto", "fetch_format": "auto"));
+    #
+    # @param [::SassC::Script::Value::String] public_id The public ID of the resource
+    # @param [::SassC::Script::Value::Map] sass_options Additional options
+    #
+    # @return [::SassC::Script::Value::String]
+    def cloudinary_url(public_id, sass_options = {})
+      options = {}
+      sass_options.to_h.each { |k, v| options[k.value.to_sym] = v.value }
+      url = Cloudinary::Utils.cloudinary_url(public_id.value, {:type => :asset}.merge(options))
+      ::SassC::Script::Value::String.new("url(#{url})")
+    end
+  end
+rescue LoadError
+  # no sassc support. Ignore.
+end