cloudinary 1.11.1 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 629a48ffc8543fc7fc8da12f12d88823232fe70a08556c49b9583437bcc24c45
-  data.tar.gz: 1a34d49c36238a396fc3d1494845f0f97ae71b18bf49175e255c9fbea239031f
+  metadata.gz: c9179fe1c8105281b33780687c2bed49db41a35fca2d33ff15bd7fd4635d119f
+  data.tar.gz: 7b3bd01f71f1012bc7f315f707450ebb65537064e004fad615d713f489c4316c
 SHA512:
-  metadata.gz: 9be4a6c2470fcdbab667610878db7934bff588ceda810e4917caa36b28c9c3e910214ebd4f21baca258ff643f7bd8e7277af4dda89779da356473d49b2cc73b8
-  data.tar.gz: b308cf1059df2bc58ba103d67b845c0a3a2384a4f53e387f950057abbc502ef425506b2861b1b471689b21cd3e04f1c960fe230559ad8d5830babc203a85b2c0
+  metadata.gz: 347fc122e9a31aa241afa194c09cdc3c0d19e63c5a206cc7751f4939de7c273769d648c7fd33af2cc4e7505fba0a5be9d555f1c3db1e2b41d45cfb58082e1cc3
+  data.tar.gz: 4f04b59256afe8f23c27625d94d761e9802e2ccd91d3c3dc992eb263e3430a7a053467c203d416d379815e317924f042c9310ac0f2b4ca185630307268aa66ca

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/.github/pull_request_template.md

@@ -0,0 +1,24 @@
+### Brief Summary of Changes
+<!--
+Provide some context as to what was changed, from an implementation standpoint.
+-->
+
+#### What does this PR address?
+[ ] Gitub issue (Add reference - #XX)
+[ ] Refactoring
+[ ] New feature
+[ ] Bug fix
+[ ] Adds more tests
+
+#### Are tests included?
+[ ] Yes
+[ ] No
+
+#### Reviewer, Please Note:
+<!--
+List anything here that the reviewer should pay special attention to. This might
+include, for example:
+• Dependence on other PRs
+• Reference to other Cloudinary SDKs
+• Changes that seem arbitrary without further explanations
+-->

data/.gitignore

@@ -55,4 +55,9 @@ bower.json
 .powenv
 
 !lib/
-cloudinary.yml
+cloudinary.yml
+configuration.yml
+
+# Developer env
+.idea
+.vscode

data/.travis.yml

@@ -1,9 +1,19 @@
 language: ruby
 
-before_install:
-  - gem install bundler
+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.3"
+      dist: xenial
+      rvm: ruby-2.5.3
+      before_install:
+        - gem install bundler
 
-rvm:
-- 1.9.3
-- ruby-head
+before_script: >
+  export CLOUDINARY_URL=$(bash tools/get_test_cloud.sh);
+  echo cloud_name: "$(echo $CLOUDINARY_URL | cut -d'@' -f2)"
 script: bundle exec rspec

data/CHANGELOG.md

@@ -1,4 +1,153 @@
 
+1.18.0 / 2020-09-27
+===================
+
+New functionality and features
+------------------------------
+  * Add `download_folder` helper
+  * Add support for `sources` in `video` tag
+  * Add structured metadata to Admin and Upload API
+  
+Other Changes
+-------------
+  * Fix download of a raw file in ActiveStorage
+  * Update embedded `jquery.cloudinary.js` to fix ES5 compatibility issue
+  
+1.17.1 / 2020-08-25
+===================
+
+  * Fix options handling issue in SassC
+
+1.17.0 / 2020-08-21
+===================
+
+New functionality and features
+------------------------------
+
+  * Add support for `eval` upload parameter
+  * Add support for 32-char signature length
+  
+Other Changes
+-------------
+
+  * Fix escaping of query string characters in CarrierWave integration
+  * Fix detection integration test
+  * Integrate with sub-account test service
+  * Add pull request template
+
+1.16.1 / 2020-07-06
+===================
+
+  * Detect data URLs with suffix in mime type
+  * Fix `Invalid regular expression` error in Safari
+
+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
+===================
+
+New functionality and features
+------------------------------
+  * Add `SassC` `cloudinary-url` function
+  
+Other Changes
+-------------
+
+  * Fix ActiveStorage download not using `ssl` for `https`
+  * Fix resource type detection in ActiveStorage
+  * Fix `storage_type` instance method in `Cloudinary::CarrierWave` module
+  * Fix sample project, limit sqlite3 to a compatible version
+
+1.12.0 / 2019-10-02
+=============
+
+New functionality and features
+------------------------------
+
+  * Add Cloudinary service for ActiveStorage
+  * Add `create_folder` Admin API method
+  * Add `delete_folder` Admin API method
+  * Add `cinemagraph_analysis` to `upload`, `explicit` and `resource` API methods
+  * Add `font_antialiasing` and `font_hinting` text style parameters
+  * Add `derived_next_cursor` parameter to `resource` Admin API
+  * Add `next_cursor` and `max_results` for `root_folders` and `subfolders` Admin API functions
+  * Add `jpeg` to `IMAGE_FORMATS`
+  * Add `pow` transformation operator
+  * Add `force_version` to `cloudinary_url`
+  * Support per corner values for the `radius` transformation parameter
+  * Support using multiple resource types when generating archives
+  * Support Google Storage fetch URL
+  
+Other Changes
+-------------
+  * Ensure `CLOUDINARY_URL` starts with `cloudinary://`
+  * Reduce memory usage in `Cloudinary::Utils.cloudinary_url`
+  * Encode URL in Admin API methods
+  * Fix base64 data validation
+  * Return `video` as the `resource_type` for audio files
+  * Add language and platform version for ruby/rails user agent
+  * Fix TravisCI configuration for ruby 1.9
+  
+
 1.11.1 / 2018-12-22
 ===================
 

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,9 +24,26 @@ 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 "rspec-retry"
+  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/blob_key.rb

@@ -0,0 +1,20 @@
+# Allow Blob attributes to be passed down to the service
+# attributes includes
+# - key - the string the BlobKey represents
+# - content_type
+# - filename
+module ActiveStorage
+  class BlobKey < String
+    attr_reader :attributes
+    def initialize(attributes)
+      if attributes.is_a? Hash
+        attributes.symbolize_keys!
+        super(attributes[:key])
+        @attributes = attributes
+      else
+        super(attributes)
+        @attributes = {key: attributes} if attributes
+      end
+    end
+  end
+end

data/lib/active_storage/service/cloudinary_service.rb

@@ -0,0 +1,229 @@
+require 'active_storage/blob_key'
+require 'cloudinary/helper'
+require 'net/http'
+
+unless ActiveStorage::Blob.method_defined? :original_key
+  class ActiveStorage::Blob
+    alias_method :original_key, :key
+
+    def key
+      original_key
+      ActiveStorage::BlobKey.new(@attributes.as_json)
+    end
+  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
+      CONTENT_TYPE = "Content-Type".freeze
+      CONTENT_MD5 = "Content-MD5".freeze
+    end
+    attr_reader :upload_options
+
+    def initialize(**options)
+      @options = options
+    end
+
+    def upload(key, io, filename: nil, checksum: nil, **options)
+      instrument :upload, key: key, checksum: checksum do
+        begin
+          extra_headers = checksum.nil? ? {} : {Headers::CONTENT_MD5 => checksum}
+          options = @options.merge(options)
+          Cloudinary::Uploader.upload(
+            io,
+            public_id: public_id_internal(key),
+            resource_type: resource_type(io, key),
+            context: {active_storage_key: key, checksum: checksum},
+            extra_headers: extra_headers,
+            **options
+          )
+        rescue CloudinaryException => e
+          raise ActiveStorage::IntegrityError, e.message, e.backtrace
+        end
+      end
+    end
+
+    def url(key, filename: nil, content_type: '', **options)
+      instrument :url, key: key do |payload|
+        url = Cloudinary::Utils.cloudinary_url(
+          public_id(key),
+          resource_type: resource_type(nil, key),
+          format: ext_for_file(key, filename, content_type),
+          **@options.merge(options.symbolize_keys)
+        )
+
+        payload[:url] = url
+
+        url
+      end
+    end
+
+    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_internal(key)
+        options[:context] = {active_storage_key: key}
+        options.delete(:file)
+        payload[:url] = api_uri("upload", options)
+      end
+    end
+
+    def headers_for_direct_upload(key, content_type:, checksum:, **)
+      {
+        Headers::CONTENT_TYPE => content_type,
+        Headers::CONTENT_MD5 => checksum,
+      }
+    end
+
+    def delete(key)
+      instrument :delete, key: key do
+        Cloudinary::Uploader.destroy public_id(key), resource_type: resource_type(nil, key)
+      end
+    end
+
+    def delete_prefixed(prefix)
+      # This method is used by ActiveStorage to delete derived resources after the main resource was deleted.
+      # In Cloudinary, the derived resources are deleted automatically when the main resource is deleted.
+    end
+
+    def exist?(key)
+      instrument :exist, key: key do |payload|
+        begin
+          Cloudinary::Api.resource public_id(key), resource_type: resource_type(nil, key)
+          true
+        rescue Cloudinary::Api::NotFound => e
+          false
+        end
+      end
+    end
+
+    def download(key, &block)
+      uri = URI(url(key))
+      if block_given?
+        instrument :streaming_download, key: key do
+          Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+            request = Net::HTTP::Get.new uri
+            http.request request do |response|
+              response.read_body &block
+            end
+          end
+        end
+      else
+        instrument :download, key: key do
+          res = Net::HTTP::get_response(uri)
+          res.body
+        end
+      end
+    end
+
+    # Return the partial content in the byte +range+ of the file at the +key+.
+    def download_chunk(key, range)
+      url = Cloudinary::Utils.unsigned_download_url(public_id(key), resource_type: resource_type(nil, key))
+      uri = URI(url)
+      instrument :download, key: key do
+        req = Net::HTTP::Get.new(uri)
+        range_end = case
+                    when range.end.nil? then ''
+                    when range.exclude_end? then range.end - 1
+                    else range.end
+                    end
+        req['range'] = "bytes=#{[range.begin, range_end].join('-')}"
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
+          http.request(req)
+        end
+        res.body.force_encoding(Encoding::BINARY)
+      end
+
+    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) }
+      unless options[:unsigned]
+        upload_params = Cloudinary::Utils.sign_request(upload_params, options)
+      end
+      "#{base_url}?#{upload_params.to_query}"
+    end
+
+    # 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::BlobKey]   key          The blob key with attributes.
+    # @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(key, filename, content_type)
+      if filename.blank?
+        options = key.respond_to?(:attributes) ? key.attributes : {}
+        filename = ActiveStorage::Filename.new(options[:filename]) if options.has_key?(:filename)
+      end
+      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?
+      end
+      @formats[content_type]
+    end
+
+    def public_id_internal(key)
+      # TODO: Allow custom manipulation of key to obscure how we store in Cloudinary
+      key
+    end
+
+    def content_type_to_resource_type(content_type)
+      type, subtype = content_type.split('/')
+      case type
+      when 'video', 'audio'
+        'video'
+      when 'text'
+        'raw'
+      when 'application'
+        case subtype
+        when 'pdf', 'postscript'
+          'image'
+        when 'vnd.apple.mpegurl', 'x-mpegurl', 'mpegurl' # m3u8
+          'video'
+        else
+          'raw'
+        end
+      else
+        '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