cloudinary 1.18.1 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42964b1e7b2a93986d13479b494110e502f4d1466f179410e22f58995d75ee1f
-  data.tar.gz: 80eae5018288bedfa0319537850b3e173142d437cf016c83ee3b8ba1f412c5d5
+  metadata.gz: 635b7d9336fcde0655fd8b348bda1cdf443a60e123991a1d6197a5a55e9d159b
+  data.tar.gz: 8cef3ea547da816bf1125243e04ed72834414f8529a27579e2ba3916571d79bc
 SHA512:
-  metadata.gz: 7021d7cd3d1d828660c68d803edc312dc1b7a7a9ac56cb0d9cc6dee894fa47fbb18950f70eb54e1b3e0a20a3f392632f1ef0ac5786f70ded929b2d912f20f3fa
-  data.tar.gz: 5c67f41050189259c3442500525bb27d54355a8b510b4e5f9f32535a8fa0b2dcfc9fb1102403afbbe3fc88e3c94c91b42fe6028d64dab48d6cc86062c8bd1061
+  metadata.gz: a6852e75360ff11e51b3d6be2e8e15f48b06d39ac17b189b6fedd54f5a3041725514db2a799c8d08db3af6f355c9ae21559b3d69015ad8eea54e701554ec3d40
+  data.tar.gz: 32997f5c779e28bb3711fea013d0131b922c92cc4e7314ec37d6c6ca45e8e2e765cfaf2979a3f04f7e4b57a5ddd9dc5ddb0b4c2b0afea9c3ff65e428a6005f41

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+1.19.0 / 2021-03-05
+==================
+
+New functionality and features
+------------------------------
+
+  * Add Account Provisioning API
+  * Add support for `api_proxy` parameter
+  * Add support for `date` parameter in `usage`  Admin API
+ 
+Other Changes
+-------------
+
+* Fix direct upload of raw files
+* Improve unit testing of add-ons
+* Change test for `eval` upload parameter
+* Bump vulnerable version of rubyzip
+* Fix `cloudinary.gemspec` glob issue
+
 
 1.18.1 / 2020-09-30
 ===================

data/cloudinary.gemspec

@@ -15,12 +15,17 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "cloudinary"
 
-  s.files         = (`git ls-files`.split("\n") - `git ls-files {test,spec,features,samples}/*`.split("\n")) + 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"
-  s.add_dependency "rest-client"
+
+  if RUBY_VERSION >= "2.0.0"
+    s.add_dependency "rest-client", ">= 2.0.0"
+  else
+    s.add_dependency "rest-client"
+  end
 
   s.add_development_dependency "actionpack"
   s.add_development_dependency "nokogiri"
@@ -39,7 +44,7 @@ Gem::Specification.new do |s|
   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", "<=1.2.0" # support testing Ruby 1.9
+  s.add_development_dependency "rubyzip"
 
   if RUBY_VERSION <= "2.4.0"
     s.add_development_dependency "simplecov", "<= 0.17.1" # support testing Ruby 1.9

data/lib/active_storage/service/cloudinary_service.rb

@@ -72,6 +72,14 @@ module ActiveStorage
       instrument :url, key: key do |payload|
         options = {:resource_type => resource_type(nil, key)}.merge(@options.merge(options.symbolize_keys))
         options[:public_id] = public_id_internal(key)
+        # Provide file format for raw files, since js client does not include original file name.
+        #
+        # When the file is uploaded from the server, the request includes original filename. That allows Cloudinary
+        # to identify file extension and append it to the public id of the file (raw files include file extension
+        # in their public id, opposed to transformable assets (images/video) that use only basename). When uploading
+        # 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"
         options[:context] = {active_storage_key: key}
         options.delete(:file)
         payload[:url] = api_uri("upload", options)
@@ -174,7 +182,7 @@ module ActiveStorage
     # @param [string]                   content_type The content type of the file.
     #
     # @return [string] The extension of the filename.
-    def ext_for_file(key, filename, content_type)
+    def ext_for_file(key, filename = nil, content_type = nil)
       if filename.blank?
         options = key.respond_to?(:attributes) ? key.attributes : {}
         filename = ActiveStorage::Filename.new(options[:filename]) if options.has_key?(:filename)
@@ -200,6 +208,8 @@ module ActiveStorage
     end
 
     def content_type_to_resource_type(content_type)
+      return 'image' if content_type.nil?
+
       type, subtype = content_type.split('/')
       case type
       when 'video', 'audio'

data/lib/cloudinary.rb

@@ -16,7 +16,12 @@ require "cloudinary/missing"
 module Cloudinary
   autoload :Utils, 'cloudinary/utils'
   autoload :Uploader, 'cloudinary/uploader'
+  autoload :BaseConfig, "cloudinary/base_config"
+  autoload :Config, "cloudinary/config"
+  autoload :AccountConfig, "cloudinary/account_config"
+  autoload :BaseApi, "cloudinary/base_api"
   autoload :Api, "cloudinary/api"
+  autoload :AccountApi, "cloudinary/account_api"
   autoload :Downloader, "cloudinary/downloader"
   autoload :Blob, "cloudinary/blob"
   autoload :PreloadedFile, "cloudinary/preloaded_file"
@@ -58,64 +63,42 @@ module Cloudinary
     "ept"  => "eps"
   }
 
-  @@config = nil
-
+  # Cloudinary config
+  #
+  # @param [Hash] new_config If +new_config+ is passed, Config will be updated with it
+  # @yieldparam [OpenStruct] Config can be updated in the block
+  #
+  # @return [OpenStruct]
   def self.config(new_config=nil)
-    first_time = @@config.nil?
-    @@config   ||= OpenStruct.new((YAML.load(ERB.new(IO.read(config_dir.join("cloudinary.yml"))).result)[config_env] rescue {}))
-
-    config_from_env if first_time
+    @@config ||= make_new_config(Config)
 
-    set_config(new_config) if new_config
-    yield(@@config) if block_given?
+    @@config.update(new_config) if new_config
+    yield @@config if block_given?
 
     @@config
   end
 
-  def self.config_from_url(url)
-    @@config ||= OpenStruct.new
-    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,
-      "api_secret"          => uri.password,
-      "private_cdn"         => !uri.path.blank?,
-      "secure_distribution" => uri.path[1..-1]
-    )
-    uri.query.to_s.split("&").each do
-    |param|
-      key, value = param.split("=")
-      if isNestedKey? key
-        putNestedKey key, value
-      else
-        set_config(key => Utils.smart_unescape(value))
-      end
-    end
-  end
+  # Cloudinary account config
+  #
+  # @param [Hash] new_config If +new_config+ is passed, Account Config will be updated with it
+  # @yieldparam [OpenStruct] Account config can be updated in the block
+  #
+  # @return [OpenStruct]
+  def self.account_config(new_config=nil)
+    @@account_config ||= make_new_config(AccountConfig)
 
-  def self.putNestedKey(key, value)
-    chain   = key.split(/[\[\]]+/).reject { |i| i.empty? }
-    outer   = @@config
-    lastKey = chain.pop()
-    chain.each do |innerKey|
-      inner = outer[innerKey]
-      if inner.nil?
-        inner           = OpenStruct.new
-        outer[innerKey] = inner
-      end
-      outer = inner
-    end
-    outer[lastKey] = value
+    @@account_config.update(new_config) if new_config
+    yield @@account_config if block_given?
+
+    @@account_config
   end
 
+  def self.config_from_url(url)
+    config.load_from_url(url)
+  end
 
-  def self.isNestedKey?(key)
-    /\w+\[\w+\]/ =~ key
+  def self.config_from_account_url(url)
+    account_config.load_from_url(url)
   end
 
   def self.app_root
@@ -129,22 +112,6 @@ module Cloudinary
 
   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
@@ -159,6 +126,20 @@ module Cloudinary
   def self.set_config(new_config)
     new_config.each{|k,v| @@config.send(:"#{k}=", v) if !v.nil?}
   end
+
+  # Builds config from yaml file, extends it with specific module and loads configuration from environment variable
+  #
+  # @param [Module] config_module Config is extended with this module after being built
+  #
+  # @return [OpenStruct]
+  def self.make_new_config(config_module)
+    OpenStruct.new((YAML.load(ERB.new(IO.read(config_dir.join("cloudinary.yml"))).result)[config_env] rescue {})).tap do |config|
+      config.extend(config_module)
+      config.load_config_from_env
+    end
+  end
+
+  private_class_method :make_new_config
 end
   # Prevent require loop if included after Rails is already initialized.
   require "cloudinary/helper" if defined?(::ActionView::Base)

data/lib/cloudinary/account_api.rb

@@ -0,0 +1,231 @@
+class Cloudinary::AccountApi
+  extend Cloudinary::BaseApi
+
+  # Creates a new sub-account. Any users that have access to all sub-accounts will also automatically have access to the
+  # new sub-account.
+  # @param [String] name The display name as shown in the management console
+  # @param [String] cloud_name A case-insensitive cloud name comprised of alphanumeric and underscore characters.
+  #   Generates an error if the specified cloud name is not unique across all Cloudinary accounts.
+  #   Note: Once created, the name can only be changed for accounts with fewer than 1000 assets.
+  # @param [Object] custom_attributes Any custom attributes you want to associate with the sub-account
+  # @param [Boolean] enabled Whether to create the account as enabled (default is enabled)
+  # @param [String] base_account ID of sub-account from which to copy settings
+  # @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,
+      base_sub_account_id: base_account
+    }
+
+    call_account_api(:post, 'sub_accounts', params, options.merge(content_type: :json))
+  end
+
+  # Updates the specified details of the sub-account.
+  # @param [String] sub_account_id The ID of the sub-account.
+  # @param [String] name The display name as shown in the management console
+  # @param [String] cloud_name A case-insensitive cloud name comprised of alphanumeric and underscore characters.
+  #   Generates an error if the specified cloud name is not unique across all Cloudinary accounts.
+  #   Note: Once created, the name can only be changed for accounts with fewer than 1000 assets.
+  # @param [Object] custom_attributes Any custom attributes you want to associate with the sub-account, as a map/hash
+  #   of key/value pairs.
+  # @param [Boolean] enabled Whether the sub-account is enabled.
+  # @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,
+      custom_attributes: custom_attributes,
+      enabled: enabled
+    }
+
+    call_account_api(:put, ['sub_accounts', sub_account_id], params, options.merge(content_type: :json))
+  end
+
+  # Lists sub-accounts.
+  # @param [Boolean] enabled Whether to only return enabled sub-accounts (true) or disabled accounts (false).
+  #  Default: all accounts are returned (both enabled and disabled).
+  # @param [Array<String>] ids A list of up to 100 sub-account IDs. When provided, other parameters are ignored.
+  # @param [String] prefix Returns accounts where the name begins with the specified case-insensitive string.
+  # @param [Object] options additional options
+  def self.sub_accounts(enabled = nil, ids = [], prefix = nil, options = {})
+    params = {
+      enabled: enabled,
+      ids: ids,
+      prefix: prefix
+    }
+
+    call_account_api(:get, 'sub_accounts', params, options.merge(content_type: :json))
+  end
+
+  # Retrieves the details of the specified sub-account.
+  # @param [String] sub_account_id The ID of the sub-account.
+  # @param [Object] options additional options
+  def self.sub_account(sub_account_id, options = {})
+    call_account_api(:get, ['sub_accounts', sub_account_id], {}, options.merge(content_type: :json))
+  end
+
+  # Deletes the specified sub-account. Supported only for accounts with fewer than 1000 assets.
+  # @param [String] sub_account_id The ID of the sub-account.
+  # @param [Object] options additional options
+  def self.delete_sub_account(sub_account_id, options = {})
+    call_account_api(:delete, ['sub_accounts', sub_account_id], {}, options)
+  end
+
+  # Creates a new user in the account.
+  # @param [String] name The name of the user.
+  # @param [String] email A unique email address, which serves as the login name and notification address.
+  # @param [String] role The role to assign. Possible values: master_admin, admin, billing, technical_admin, reports,
+  #   media_library_admin, media_library_user
+  # @param [Array<String>] sub_account_ids The list of sub-account IDs that this user can access.
+  #   Note: This parameter is ignored if the role is specified as master_admin.
+  # @param [Object] options additional options
+  def self.create_user(name, email, role, sub_account_ids = [], options = {})
+    params = {
+      name: name,
+      email: email,
+      role: role,
+      sub_account_ids: sub_account_ids
+    }
+
+    call_account_api(:post, 'users', params, options.merge(content_type: :json))
+  end
+
+  # Deletes an existing user.
+  # @param [String] user_id The ID of the user to delete.
+  # @param [Object] options additional options
+  def self.delete_user(user_id, options = {})
+    call_account_api(:delete, ['users', user_id], {}, options)
+  end
+
+  # Updates the details of the specified user.
+  # @param [String] user_id The ID of the user to update.
+  # @param [String] name The name of the user.
+  # @param [String] email A unique email address, which serves as the login name and notification address.
+  # @param [String] role The role to assign. Possible values: master_admin, admin, billing, technical_admin, reports,
+  #   media_library_admin, media_library_user
+  # @param [Array<String>] sub_account_ids The list of sub-account IDs that this user can access.
+  #   Note: This parameter is ignored if the role is specified as master_admin.
+  # @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,
+      sub_account_ids: sub_account_ids
+    }
+
+    call_account_api(:put, ['users', user_id], params, options.merge(content_type: :json))
+  end
+
+  # Returns the user with the specified ID.
+  # @param [String] user_id The ID of the user.
+  # @param [Object] options additional options
+  def self.user(user_id, options = {})
+    call_account_api(:get, ['users', user_id], {}, options.merge(content_type: :json))
+  end
+
+  # Lists users in the account.
+  # @param [Boolean] pending Whether to only return pending users. Default: all users
+  # @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
+  def self.users(pending = nil, user_ids = [], prefix = nil, sub_account_id = nil, options = {})
+    params = if user_ids && user_ids.count > 0
+               {
+                 ids: user_ids
+               }
+             else
+               {
+                 prefix: prefix,
+                 sub_account_id: sub_account_id,
+                 pending: pending
+               }
+             end
+
+    call_account_api(:get, 'users', params, options.merge(content_type: :json))
+  end
+
+  # Creates a new user group.
+  # @param [String] name The name for the user group.
+  # @param [Object] options additional options
+  def self.create_user_group(name, options = {})
+    params = {
+      name: name
+    }
+
+    call_account_api(:post, 'user_groups', params, options.merge(content_type: :json))
+  end
+
+  # Updates the specified user group.
+  # @param [String] group_id The ID of the user group to update.
+  # @param [String] name The name for the user group.
+  # @param [Object] options additional options
+  def self.update_user_group(group_id, name, options = {})
+    params = {
+      name: name
+    }
+
+    call_account_api(:put, ['user_groups', group_id], params, options.merge(content_type: :json))
+  end
+
+  # Adds a user to a group with the specified ID.
+  # @param [String] group_id The ID of the user group.
+  # @param [String] user_id The ID of the user.
+  # @param [Object] options additional options
+  def self.add_user_to_group(group_id, user_id, options = {})
+    call_account_api(:post, ['user_groups', group_id, 'users', user_id], {}, options.merge(content_type: :json))
+  end
+
+  # Removes a user from a group with the specified ID.
+  # @param [String] group_id The ID of the user group.
+  # @param [String] user_id The ID of the user.
+  # @param [Object] options additional options
+  def self.remove_user_from_group(group_id, user_id, options = {})
+    call_account_api(:delete, ['user_groups', group_id, 'users', user_id], {}, options.merge(content_type: :json))
+  end
+
+  # Deletes the user group with the specified ID.
+  # @param [String] group_id The ID of the user group to delete.
+  # @param [Object] options additional options
+  def self.delete_user_group(group_id, options = {})
+    call_account_api(:delete, ['user_groups', group_id], {}, options)
+  end
+
+  # Lists user groups in the account.
+  # @param [Object] options additional options
+  def self.user_groups(options = {})
+    call_account_api(:get, 'user_groups', {}, options.merge(content_type: :json))
+  end
+
+  # Retrieves the details of the specified user group.
+  # @param [String] group_id The ID of the user group to retrieve.
+  # @param [Object] options additional options
+  def self.user_group(group_id, options = {})
+    call_account_api(:get, ['user_groups', group_id], {}, options.merge(content_type: :json))
+  end
+
+  # Lists users in the specified user group.
+  # @param [String] group_id The ID of the user group.
+  # @param [Object] options additional options
+  def self.user_group_users(group_id, options = {})
+    call_account_api(:get, ['user_groups', group_id, 'users'], {}, 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')
+
+    params.reject! { |_, v| v.nil? }
+
+    call_cloudinary_api(method, uri, api_key, api_secret, params, options) do |cloudinary, inner_uri|
+      [cloudinary, 'v1_1', 'provisioning', 'accounts', account_id, inner_uri]
+    end
+  end
+
+  private_class_method :call_account_api
+end

data/lib/cloudinary/account_config.rb

@@ -0,0 +1,30 @@
+module Cloudinary
+  module AccountConfig
+    include BaseConfig
+
+    ENV_URL = "CLOUDINARY_ACCOUNT_URL"
+    SCHEME = "account"
+
+    def load_config_from_env
+      load_from_url(ENV[ENV_URL]) if ENV[ENV_URL]
+    end
+
+    private
+
+    def env_url
+      ENV_URL
+    end
+
+    def expected_scheme
+      SCHEME
+    end
+
+    def config_from_parsed_url(parsed_url)
+      {
+        "account_id"              => parsed_url.host,
+        "provisioning_api_key"    => parsed_url.user,
+        "provisioning_api_secret" => parsed_url.password
+      }
+    end
+  end
+end

data/lib/cloudinary/api.rb

@@ -1,37 +1,28 @@
-require 'rest_client'
-require 'json'
-
 class Cloudinary::Api
-  class Error < CloudinaryException; end
-  class NotFound < Error; end
-  class NotAllowed < Error; end
-  class AlreadyExists < Error; end
-  class RateLimited < Error; end
-  class BadRequest < Error; end
-  class GeneralError < Error; end
-  class AuthorizationRequired < Error; end
-
-  class Response < Hash
-    attr_reader :rate_limit_reset_at, :rate_limit_remaining, :rate_limit_allowed
-
-    def initialize(response=nil)
-      if response
-        # This sets the instantiated self as the response Hash
-        update Cloudinary::Api.parse_json_response response
-
-        @rate_limit_allowed   = response.headers[:x_featureratelimit_limit].to_i if response.headers[:x_featureratelimit_limit]
-        @rate_limit_reset_at  = Time.parse(response.headers[:x_featureratelimit_reset]) if response.headers[:x_featureratelimit_reset]
-        @rate_limit_remaining = response.headers[:x_featureratelimit_remaining].to_i if response.headers[:x_featureratelimit_remaining]
-      end
-    end
-  end
+  extend Cloudinary::BaseApi
 
   def self.ping(options={})
     call_api(:get, "ping", {}, options)
   end
 
+  # Gets account usage details
+  #
+  # Get a report on the status of your Cloudinary account usage details, including
+  # storage, bandwidth, requests, number of resources, and add-on usage.
+  # Note that numbers are updated periodically.
+  #
+  # @see https://cloudinary.com/documentation/admin_api#get_account_usage_details Get account usage details
+  #
+  # @param [Hash] options Additional options
+  # @return [Cloudinary::Api::Response]
+  # @raise [Cloudinary::Api:Error]
   def self.usage(options={})
-    call_api(:get, "usage", {}, options)
+    uri = 'usage'
+    date = options[:date]
+
+    uri += "/#{Cloudinary::Utils.to_usage_api_date_format(date)}" unless date.nil?
+
+    call_api(:get, uri, {}, options)
   end
 
   def self.resource_types(options={})
@@ -489,44 +480,15 @@ class Cloudinary::Api
   protected
 
   def self.call_api(method, uri, params, options)
-    cloudinary = options[:upload_prefix] || Cloudinary.config.upload_prefix || "https://api.cloudinary.com"
-    cloud_name = options[:cloud_name] || Cloudinary.config.cloud_name || raise("Must supply cloud_name")
-    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}@")
-
-    headers = { "User-Agent" => Cloudinary::USER_AGENT }
-    if options[:content_type]== :json
-      payload = params.to_json
-      headers.merge!("Content-Type"=> 'application/json', "Accept"=> 'application/json')
-    else
-      payload = params.reject { |k, v| v.nil? || v=="" }
-    end
-    call_json_api(method, api_url, payload, timeout, headers)
-  end
-
-  def self.call_json_api(method, api_url, payload, timeout, headers)
-    RestClient::Request.execute(:method => method, :url => api_url, :payload => payload, :timeout => timeout, :headers => headers) do
-    |response, request, tmpresult|
-      return Response.new(response) if response.code == 200
-      exception_class = case response.code
-                        when 400 then BadRequest
-                        when 401 then AuthorizationRequired
-                        when 403 then NotAllowed
-                        when 404 then NotFound
-                        when 409 then AlreadyExists
-                        when 420 then RateLimited
-                        when 500 then GeneralError
-                        else raise GeneralError.new("Server returned unexpected status code - #{response.code} - #{response.body}")
-                        end
-      json = parse_json_response(response)
-      raise exception_class.new(json["error"]["message"])
+    cloud_name = options[:cloud_name] || Cloudinary.config.cloud_name || raise('Must supply cloud_name')
+    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')
+
+    call_cloudinary_api(method, uri, api_key, api_secret, params, options) do |cloudinary, inner_uri|
+      [cloudinary, 'v1_1', cloud_name, inner_uri]
     end
   end
+
   def self.parse_json_response(response)
     return Cloudinary::Utils.json_decode(response.body)
   rescue => e
@@ -593,5 +555,4 @@ class Cloudinary::Api
     params[by_key] = value
     call_api("post", "resources/#{resource_type}/#{type}/update_access_mode", params, options)
   end
-
 end

data/lib/cloudinary/base_api.rb

@@ -0,0 +1,79 @@
+require "rest_client"
+require "json"
+
+module Cloudinary::BaseApi
+  class Error < CloudinaryException; end
+  class NotFound < Error; end
+  class NotAllowed < Error; end
+  class AlreadyExists < Error; end
+  class RateLimited < Error; end
+  class BadRequest < Error; end
+  class GeneralError < Error; end
+  class AuthorizationRequired < Error; end
+
+  class Response < Hash
+    attr_reader :rate_limit_reset_at, :rate_limit_remaining, :rate_limit_allowed
+
+    def initialize(response=nil)
+      if response
+        # This sets the instantiated self as the response Hash
+        update Cloudinary::Api.parse_json_response response
+
+        @rate_limit_allowed   = response.headers[:x_featureratelimit_limit].to_i if response.headers[:x_featureratelimit_limit]
+        @rate_limit_reset_at  = Time.parse(response.headers[:x_featureratelimit_reset]) if response.headers[:x_featureratelimit_reset]
+        @rate_limit_remaining = response.headers[:x_featureratelimit_remaining].to_i if response.headers[:x_featureratelimit_remaining]
+      end
+    end
+  end
+
+  def self.extended(base)
+    [Error, NotFound, NotAllowed, AlreadyExists, RateLimited, BadRequest, GeneralError, AuthorizationRequired, Response].each do |constant|
+      base.const_set(constant.name.split("::").last, constant)
+    end
+  end
+
+  def call_json_api(method, api_url, payload, timeout, headers, proxy = nil, user = nil, password = nil)
+    RestClient::Request.execute(method: method,
+                                url: api_url,
+                                payload: payload,
+                                timeout: timeout,
+                                headers: headers,
+                                proxy: proxy,
+                                user: user,
+                                password: password) do |response|
+      return Response.new(response) if response.code == 200
+      exception_class = case response.code
+                        when 400 then BadRequest
+                        when 401 then AuthorizationRequired
+                        when 403 then NotAllowed
+                        when 404 then NotFound
+                        when 409 then AlreadyExists
+                        when 420 then RateLimited
+                        when 500 then GeneralError
+                        else raise GeneralError.new("Server returned unexpected status code - #{response.code} - #{response.body}")
+                        end
+      json = Cloudinary::Api.parse_json_response(response)
+      raise exception_class.new(json["error"]["message"])
+    end
+  end
+
+  private
+
+  def call_cloudinary_api(method, uri, user, password, params, options, &api_url_builder)
+    cloudinary = options[:upload_prefix] || Cloudinary.config.upload_prefix || 'https://api.cloudinary.com'
+    api_url    = Cloudinary::Utils.smart_escape(api_url_builder.call(cloudinary, uri).flatten.join('/'))
+    timeout    = options[:timeout] || Cloudinary.config.timeout || 60
+    proxy      = options[:api_proxy] || Cloudinary.config.api_proxy
+
+    headers = { "User-Agent" => Cloudinary::USER_AGENT }
+
+    if options[:content_type] == :json
+      payload = params.to_json
+      headers.merge!("Content-Type" => "application/json", "Accept" => "application/json")
+    else
+      payload = params.reject { |_, v| v.nil? || v == "" }
+    end
+
+    call_json_api(method, api_url, payload, timeout, headers, proxy, user, password)
+  end
+end

data/lib/cloudinary/base_config.rb

@@ -0,0 +1,70 @@
+module Cloudinary
+  module BaseConfig
+    def load_from_url(url)
+      return unless url && !url.empty?
+
+      parsed_url = URI.parse(url)
+      scheme = parsed_url.scheme.to_s.downcase
+
+      if expected_scheme != scheme
+        raise(CloudinaryException,
+              "Invalid #{env_url} scheme. Expecting to start with '#{expected_scheme}://'")
+      end
+
+      update(config_from_parsed_url(parsed_url))
+      setup_from_parsed_url(parsed_url)
+    end
+
+    def update(new_config = {})
+      new_config.each{ |k,v| public_send(:"#{k}=", v) unless v.nil?}
+    end
+
+    def load_config_from_env
+      raise NotImplementedError
+    end
+
+    private
+
+    def config_from_parsed_url(parsed_url)
+      raise NotImplementedError
+    end
+
+    def env_url
+      raise NotImplementedError
+    end
+
+    def expected_scheme
+      raise NotImplementedError
+    end
+
+    def put_nested_key(key, value)
+      chain   = key.split(/[\[\]]+/).reject(&:empty?)
+      outer   = self
+      lastKey = chain.pop
+      chain.each do |innerKey|
+        inner = outer[innerKey]
+        if inner.nil?
+          inner           = OpenStruct.new
+          outer[innerKey] = inner
+        end
+        outer = inner
+      end
+      outer[lastKey] = value
+    end
+
+    def is_nested_key?(key)
+      /\w+\[\w+\]/ =~ key
+    end
+
+    def setup_from_parsed_url(parsed_url)
+      parsed_url.query.to_s.split("&").each do |param|
+        key, value = param.split("=")
+        if is_nested_key? key
+          put_nested_key key, value
+        else
+          update(key => Utils.smart_unescape(value))
+        end
+      end
+    end
+  end
+end

data/lib/cloudinary/config.rb

@@ -0,0 +1,43 @@
+module Cloudinary
+  module Config
+    include BaseConfig
+
+    ENV_URL = "CLOUDINARY_URL"
+    SCHEME = "cloudinary"
+
+    def load_config_from_env
+      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
+          update(conf_key => conf_val)
+        end
+      elsif ENV[ENV_URL]
+        load_from_url(ENV[ENV_URL])
+      end
+    end
+
+    private
+
+    def env_url
+      ENV_URL
+    end
+
+    def expected_scheme
+      SCHEME
+    end
+
+    def config_from_parsed_url(parsed_url)
+      {
+        "cloud_name"          => parsed_url.host,
+        "api_key"             => parsed_url.user,
+        "api_secret"          => parsed_url.password,
+        "private_cdn"         => !parsed_url.path.blank?,
+        "secure_distribution" => parsed_url.path[1..-1]
+      }
+    end
+  end
+end

data/lib/cloudinary/uploader.rb

@@ -346,6 +346,7 @@ class Cloudinary::Uploader
       params[:signature] = Cloudinary::Utils.api_sign_request(params.reject { |k, v| non_signable.include?(k) }, api_secret)
       params[:api_key]   = api_key
     end
+    proxy   = options[:api_proxy] || Cloudinary.config.api_proxy
     timeout = options.fetch(:timeout) { Cloudinary.config.to_h.fetch(:timeout, 60) }
 
     result = nil
@@ -355,7 +356,7 @@ class Cloudinary::Uploader
     headers['Content-Range'] = options[:content_range] if options[:content_range]
     headers['X-Unique-Upload-Id'] = options[:unique_upload_id] if options[:unique_upload_id]
     headers.merge!(options[:extra_headers]) if options[:extra_headers]
-    RestClient::Request.execute(:method => :post, :url => api_url, :payload => params.reject { |k, v| v.nil? || v=="" }, :timeout => timeout, :headers => headers) do
+    RestClient::Request.execute(:method => :post, :url => api_url, :payload => params.reject { |k, v| v.nil? || v=="" }, :timeout => timeout, :headers => headers, :proxy => proxy) do
     |response, request, tmpresult|
       raise CloudinaryException, "Server returned unexpected status code - #{response.code} - #{response.body}" unless [200, 400, 401, 403, 404, 500].include?(response.code)
       begin

data/lib/cloudinary/utils.rb

@@ -1149,6 +1149,20 @@ class Cloudinary::Utils
     REMOTE_URL_REGEX === url
   end
 
+  # Format date in a format accepted by the usage API (e.g., 31-12-2020) if
+  # passed value is of type Date, otherwise return the string representation of
+  # the input.
+  #
+  # @param [Date|Object] date
+  # @return [String]
+  def self.to_usage_api_date_format(date)
+    if date.is_a?(Date)
+      date.strftime('%d-%m-%Y')
+    else
+      date.to_s
+    end
+  end
+
   # Computes a short or long signature based on a message and secret
   # @param [String]  message The string to sign
   # @param [String]  secret A secret that will be added to the message when signing

data/lib/cloudinary/version.rb

@@ -1,4 +1,4 @@
 # Copyright Cloudinary
 module Cloudinary
-  VERSION = "1.18.1"
+  VERSION = "1.19.0"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: cloudinary
 version: !ruby/object:Gem::Version
-  version: 1.18.1
+  version: 1.19.0
 platform: ruby
 authors:
 - Nadav Soferman
 - Itai Lahan
 - Tal Lev-Ami
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws_cf_signer
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -156,16 +156,16 @@ dependencies:
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -204,8 +204,12 @@ files:
 - lib/active_storage/blob_key.rb
 - lib/active_storage/service/cloudinary_service.rb
 - lib/cloudinary.rb
+- lib/cloudinary/account_api.rb
+- lib/cloudinary/account_config.rb
 - lib/cloudinary/api.rb
 - lib/cloudinary/auth_token.rb
+- lib/cloudinary/base_api.rb
+- lib/cloudinary/base_config.rb
 - lib/cloudinary/blob.rb
 - lib/cloudinary/cache.rb
 - lib/cloudinary/cache/breakpoints_cache.rb
@@ -219,6 +223,7 @@ files:
 - lib/cloudinary/carrier_wave/remote.rb
 - lib/cloudinary/carrier_wave/storage.rb
 - lib/cloudinary/cloudinary_controller.rb
+- lib/cloudinary/config.rb
 - lib/cloudinary/downloader.rb
 - lib/cloudinary/engine.rb
 - lib/cloudinary/exceptions.rb
@@ -256,7 +261,7 @@ homepage: http://cloudinary.com
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -271,8 +276,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Client library for easily using the Cloudinary service
 test_files: []