cloudinary 1.13.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e5827b8b849956cb26923c951ff72b205ff34e898309513ec1a18eca3abd47f
-  data.tar.gz: 53acb20dcbd39a0dfa3d99c912c128e0731950893066a102bda1e4d267c1ebc2
+  metadata.gz: 38bfe3ef22f15b588b0cc8d80a433eb76d31b899eed350a8722547eeeee86643
+  data.tar.gz: f00c4f2e455a3ef278a5169df4fd40f982e65f774ccd444095053663dc531c15
 SHA512:
-  metadata.gz: efd2057b536c8bbd339efce5046e23a1ee9d8c35cd398354f1ec3d72dcb98f9f2c0d7696441097b9e9de576dd98ae97c594e0368937f9ff60a52c5cd6556e98a
-  data.tar.gz: 19215c9db03f24c24b24aabfaf1bb887eaac5bd2c493890e2426a8523503c3235de85be0a3a243ce2ac31b52c8463f5ce4ef7f1db5775a06082436dc1610baca
+  metadata.gz: 560784ae8664c5d3425599cb40cd72f69010223a22ae8d62dbb0c16033ce25dc28ae5810f39adb859436209d767dbfbe097974f7f8018add701eb072556e5bb3
+  data.tar.gz: 551b473e18bb1774a724da52201c8a8d463cb7dcaaa3926de8f980b150fb18e69c03d50d39fa6e9d11d2d8f29d1413759953d714166252c6390e08ad5811c668

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,42 @@
+---
+name: Bug report
+about: Bug report for Cloudinary Ruby SDK
+title: ''
+labels: ''
+assignees: const-cloudinary
+
+---
+
+## Bug report for Cloudinary Ruby SDK
+Before proceeding, please update to latest version and test if the issue persists
+
+## Describe the bug in a sentence or two.
+…
+
+## Issue Type (Can be multiple)
+[ ] Build - Can’t install or import the SDK
+[ ] Performance - Performance issues
+[ ] Behaviour - Functions aren’t working as expected (Such as generate URL)
+[ ] Documentation - Inconsistency between the docs and behaviour
+[ ] Other (Specify)
+
+## Steps to reproduce
+… if applicable
+
+## Error screenshots or Stack Trace (if applicable)
+…
+
+## Operating System
+[ ] Linux
+[ ] Windows
+[ ] OSX
+[ ] All
+
+## Environment and Libraries (fill in the version numbers)
+Cloudinary Ruby SDK version - 0.0.0
+Ruby Version - 0.0.0
+Rails Version - 0.0.0 
+Other Libraries (Carrierwave, ActiveStorage, etc) - 0.0.0
+
+## Repository
+If possible, please provide a link to a reproducible repository that showcases the problem

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Feature request for Cloudinary Ruby SDK
+title: ''
+labels: ''
+assignees: const-cloudinary
+
+---
+
+## Feature request for Cloudinary Ruby SDK
+…(If your feature is for other SDKs, please request them there)
+
+
+## Explain your use case
+… (A high level explanation of why you need this feature)
+
+## Describe the problem you’re trying to solve
+… (A more technical view of what you’d like to accomplish, and how this feature will help you achieve it)
+
+## Do you have a proposed solution?
+… (yes, no? Please elaborate if needed)

data/CHANGELOG.md

@@ -1,4 +1,65 @@
 
+1.16.0 / 2020-06-29
+===================
+
+New functionality and features
+------------------------------
+
+  * Add support for uploading `StringIO`
+
+Other Changes
+-------------
+
+  * Set default cache storage to `file` in `CarrierWave`
+  * Fix `normalize_expression` to ignore predefined variables
+  * Fix sample projects
+
+1.15.0 / 2020-06-11
+===================
+
+New functionality and features
+------------------------------
+
+  * Add support for `accessibility_analysis` parameter
+  
+Other Changes
+-------------
+  * Fix `download` function in `Cloudinary::CarrierWave`
+  * Fix handling of empty value in `if` parameter
+  * Fix consumption of configuration from environment variables
+
+1.14.0 / 2020-05-06
+===================
+
+New functionality and features
+------------------------------
+
+  * Add support of global folder in ActiveStorage
+  * Add duration to conditions in video
+
+Other Changes
+-------------
+
+  * Fix `URI.unescape is obsolete` warning
+  * Fix lingering Rails 6 autoload warnings
+  * Fix Ruby 1.9 CI build
+  * Allow setting uploader timeout to `nil`
+  * Update link to CarrierWave integration
+  * Update issue templates
+
+1.13.2 / 2020-01-19
+===================
+
+  * Fix asset extension detection in active storage service `url` method
+
+1.13.1 / 2019-11-24
+===================
+
+  * Remove `test_files` from `gemspec`
+  * Remove redundant binary files from `active_storage` spec
+  * Fix `rspec` deprecation warnings in Rails 6
+  * Add test for uploading IO
+
 1.13.0 / 2019-11-14
 ===================
 

data/Rakefile

@@ -1,55 +1,13 @@
 require 'bundler'
 require 'fileutils'
-require 'tmpdir'
-require 'rest_client'
-require 'json'
-require 'rubygems/package'
-
 require 'rspec/core/rake_task'
+
 RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
 
 Bundler::GemHelper.install_tasks
 
-namespace :cloudinary do
-  desc "Fetch the latest JavaScript library files and create the JavaScript index files"
-  task :fetch_assets do
-    index_files      = %w[jquery.ui.widget.js jquery.iframe-transport.js jquery.fileupload.js jquery.cloudinary.js]
-    processing_files = %w[canvas-to-blob.min.js load-image.all.min.js jquery.fileupload-process.js jquery.fileupload-image.js jquery.fileupload-validate.js]
-    files            = index_files + processing_files
-
-    release = JSON(RestClient.get("https://api.github.com/repos/cloudinary/cloudinary_js/releases/latest"))
-
-    FileUtils.rm_rf 'vendor/assets'
-    html_folder = 'vendor/assets/html'
-    FileUtils.mkdir_p html_folder
-    js_folder = 'vendor/assets/javascripts/cloudinary'
-    FileUtils.mkdir_p js_folder
-
-    puts "Fetching cloudinary_js version #{release["tag_name"]}\n\n"
-    sio  = StringIO.new(RestClient.get(release["tarball_url"]).body)
-    file =Zlib::GzipReader.new(sio)
-    tar  = Gem::Package::TarReader.new(file)
-    tar.each_entry do |entry|
-      name = File.basename(entry.full_name)
-      if files.include? name
-        js_full_name = File.join(js_folder, name)
-        puts "Adding #{js_full_name}"
-        File.write js_full_name, entry.read
-      elsif name == 'cloudinary_cors.html'
-        html_full_name = File.join(html_folder, name)
-        puts "Adding #{html_full_name}"
-        File.write html_full_name, entry.read
-      end
-    end
-    puts "Creating 'index.js' and 'processing.js' files"
-    File.open("vendor/assets/javascripts/cloudinary/index.js", "w") do |f|
-      index_files.each { |name| f.puts "//= require ./#{name}" }
-    end
-    File.open("vendor/assets/javascripts/cloudinary/processing.js", "w") do |f|
-      processing_files.each { |name| f.puts "//= require ./#{name}" }
-    end
-  end
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/lib/tasks/**/*.rake").each { |f| import f }
 
-end
 task :build => "cloudinary:fetch_assets"

data/cloudinary.gemspec

@@ -15,8 +15,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "cloudinary"
 
-  s.files         = (`git ls-files`.split("\n") - `git ls-files samples`.split("\n")) + Dir.glob("vendor/assets/javascripts/*/*") + Dir.glob("vendor/assets/html/*")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
@@ -25,11 +24,25 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "actionpack"
   s.add_development_dependency "nokogiri"
-  s.add_development_dependency "rake"
+
+  if RUBY_VERSION >= "2.2.0"
+    s.add_development_dependency "rake", ">= 13.0.1"
+  else
+    s.add_development_dependency "rake", "<= 12.2.1"
+  end
+
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "rspec", '>=3.5'
   s.add_development_dependency "rails", "~>5.2" if RUBY_VERSION >= "2.2.2"
+
+  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 "simplecov"
+
+  if RUBY_VERSION <= "2.4.0"
+    s.add_development_dependency "simplecov", "<= 0.17.1" # support testing Ruby 1.9
+  else
+    s.add_development_dependency "simplecov", "> 0.18.0"
+  end
 end

data/lib/active_storage/service/cloudinary_service.rb

@@ -12,6 +12,15 @@ unless ActiveStorage::Blob.method_defined? :original_key
   end
 end
 
+module CloudinaryHelper
+  alias cloudinary_url_internal_original cloudinary_url_internal
+
+  def cloudinary_url_internal(source, options = {})
+    source = ActiveStorage::Blob.service.public_id(source) if defined? ActiveStorage::Blob.service.public_id
+    cloudinary_url_internal_original(source, options)
+  end
+end
+
 module ActiveStorage
   class Service::CloudinaryService < Service
     module Headers
@@ -22,7 +31,6 @@ module ActiveStorage
 
     def initialize(**options)
       @options = options
-      @helper = ActionView::Base.new
     end
 
     def upload(key, io, filename: nil, checksum: nil, **options)
@@ -32,7 +40,7 @@ module ActiveStorage
           options = @options.merge(options)
           Cloudinary::Uploader.upload(
             io,
-            public_id: public_id(key),
+            public_id: public_id_internal(key),
             resource_type: resource_type(io, key),
             context: {active_storage_key: key, checksum: checksum},
             extra_headers: extra_headers,
@@ -49,9 +57,10 @@ module ActiveStorage
         url = Cloudinary::Utils.cloudinary_url(
           public_id(key),
           resource_type: resource_type(nil, key),
-          format: ext_for_content_type(content_type),
+          format: ext_for_file(filename, content_type),
           **@options.merge(options.symbolize_keys)
         )
+
         payload[:url] = url
 
         url
@@ -61,7 +70,7 @@ module ActiveStorage
     def url_for_direct_upload(key, **options)
       instrument :url, key: key do |payload|
         options = {:resource_type => resource_type(nil, key)}.merge(@options.merge(options.symbolize_keys))
-        options[:public_id] = public_id(key)
+        options[:public_id] = public_id_internal(key)
         options[:context] = {active_storage_key: key}
         options.delete(:file)
         payload[:url] = api_uri("upload", options)
@@ -137,20 +146,41 @@ module ActiveStorage
 
     end
 
+    def public_id(key)
+      return key unless @options[:folder]
+
+      File.join(@options.fetch(:folder), public_id_internal(key))
+    end
+
     private
 
     def api_uri(action, options)
       base_url = Cloudinary::Utils.cloudinary_api_url(action, options)
       upload_params = Cloudinary::Uploader.build_upload_params(options)
 
-      upload_params.reject! {|k, v| Cloudinary::Utils.safe_blank?(v)}
+      upload_params.reject! { |k, v| Cloudinary::Utils.safe_blank?(v) }
       unless options[:unsigned]
         upload_params = Cloudinary::Utils.sign_request(upload_params, options)
       end
       "#{base_url}?#{upload_params.to_query}"
     end
 
-    def ext_for_content_type(content_type)
+    # Helper method for getting the filename extension.
+    #
+    # It does the best effort when original filename does not include extension, but we know the mime-type.
+    #
+    # @param [ActiveStorage::Filename]  filename     The original filename.
+    # @param [string]                   content_type The content type of the file.
+    #
+    # @return [string] The extension of the filename.
+    def ext_for_file(filename, content_type)
+      ext = filename.respond_to?(:extension_without_delimiter) ? filename.extension_without_delimiter : nil
+      return ext unless ext.blank?
+
+      # Raw files are not convertible, no extension guessing for them
+      return nil if content_type_to_resource_type(content_type).eql?('raw')
+
+      # Fallback when there is no extension.
       @formats ||= Hash.new do |h, key|
         ext = Rack::Mime::MIME_TYPES.invert[key]
         h[key] = ext.slice(1..-1) unless ext.nil?
@@ -158,14 +188,12 @@ module ActiveStorage
       @formats[content_type]
     end
 
-    def public_id(key)
+    def public_id_internal(key)
       # TODO: Allow custom manipulation of key to obscure how we store in Cloudinary
       key
     end
 
-    def resource_type(io, key = "")
-      options = key.respond_to?(:attributes) ? key.attributes : {}
-      content_type = options[:content_type] || (io.nil? ? '' : Marcel::MimeType.for(io))
+    def content_type_to_resource_type(content_type)
       type, subtype = content_type.split('/')
       case type
       when 'video', 'audio'
@@ -185,5 +213,11 @@ module ActiveStorage
         'image'
       end
     end
+
+    def resource_type(io, key = "")
+      options = key.respond_to?(:attributes) ? key.attributes : {}
+      content_type = options[:content_type] || (io.nil? ? '' : Marcel::MimeType.for(io))
+      content_type_to_resource_type(content_type)
+    end
   end
 end

data/lib/cloudinary.rb

@@ -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?
@@ -105,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
@@ -140,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,7 +78,7 @@ class Cloudinary::Api
     resource_type = options[:resource_type] || "image"
     type          = options[:type] || "upload"
     uri           = "resources/#{resource_type}/#{type}/#{public_id}"
-    call_api(:get, uri, 
+    call_api(:get, uri,
              only(options,
                   :cinemagraph_analysis,
                   :colors,
@@ -90,7 +90,8 @@ class Cloudinary::Api
                   :pages,
                   :phash,
                   :quality_analysis,
-                  :derived_next_cursor
+                  :derived_next_cursor,
+                  :accessibility_analysis
              ), options)
   end