cloudinary 1.11.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 629a48ffc8543fc7fc8da12f12d88823232fe70a08556c49b9583437bcc24c45
-  data.tar.gz: 1a34d49c36238a396fc3d1494845f0f97ae71b18bf49175e255c9fbea239031f
+  metadata.gz: f3837b9826e6f31a35e478b9d8bbf81027cee43ece65f7df161b748fd5c21dd9
+  data.tar.gz: 3b47da18531bbfe2252f6cfe4a071bc5972c286c2f5777758d1b1a7e1a30b07e
 SHA512:
-  metadata.gz: 9be4a6c2470fcdbab667610878db7934bff588ceda810e4917caa36b28c9c3e910214ebd4f21baca258ff643f7bd8e7277af4dda89779da356473d49b2cc73b8
-  data.tar.gz: b308cf1059df2bc58ba103d67b845c0a3a2384a4f53e387f950057abbc502ef425506b2861b1b471689b21cd3e04f1c960fe230559ad8d5830babc203a85b2c0
+  metadata.gz: 34d0a6214325094a27683345da51e605b7ba6f6ba5761d4c64478dea618dbf3d4ce14a255bf69d513704d72dca6ef5a27ee4bc6e5e81d66e5548341f9e7c2e8c
+  data.tar.gz: 383bbafb8b06b9bda3fdedbde2f6b7248bcee0bacd5576e98b8e9b79d9ff45cd7d1025056fe1edde412fbf4a04855ba4ea3af197c260374827026f7a0b883f55

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,15 @@
 language: ruby
 
-before_install:
-  - gem install bundler
-
-rvm:
-- 1.9.3
-- ruby-head
+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
 script: bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+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/cloudinary.gemspec

@@ -26,7 +26,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency "actionpack"
   s.add_development_dependency "nokogiri"
   s.add_development_dependency "rake"
+  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 "rspec-rails"
   s.add_development_dependency "rubyzip", "<=1.2.0" # support testing Ruby 1.9
   s.add_development_dependency "simplecov"

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,181 @@
+require 'active_storage/blob_key'
+require 'cloudinary/helper'
+
+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 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
+      @helper = ActionView::Base.new
+    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(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_content_type(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(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)
+      url = Cloudinary::Utils.unsigned_download_url(public_id(key), resource_type: resource_type(nil, key))
+      uri = URI(url)
+      if block_given?
+        instrument :streaming_download, key: key do
+          Net::HTTP.start(uri.host, uri.port) 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) do |http|
+          http.request(req)
+        end
+        res.body.force_encoding(Encoding::BINARY)
+      end
+
+    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
+
+    def ext_for_content_type(content_type)
+      @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(key)
+      # TODO: Allow custom manipulation of key to obscure how we store in Cloudinary
+      key
+    end
+
+    def resource_type(io, key = "")
+      return 'image' unless key.respond_to? :attributes
+      options = key.attributes
+      content_type = options[:content_type] || (io.nil? ? '' : Marcel::MimeType.for(io))
+      case content_type.split('/')[0]
+      when 'video'
+        'video'
+      when 'text'
+        'raw'
+      else
+        'image'
+      end
+    end
+  end
+end

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
@@ -86,7 +86,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,

data/lib/cloudinary/api.rb

@@ -79,7 +79,8 @@ class Cloudinary::Api
     type          = options[:type] || "upload"
     uri           = "resources/#{resource_type}/#{type}/#{public_id}"
     call_api(:get, uri, 
-             only(options, 
+             only(options,
+                  :cinemagraph_analysis,
                   :colors,
                   :coordinates,
                   :exif,
@@ -88,7 +89,8 @@ class Cloudinary::Api
                   :max_results,
                   :pages,
                   :phash,
-                  :quality_analysis
+                  :quality_analysis,
+                  :derived_next_cursor
              ), options)
   end
 
@@ -226,11 +228,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={})
@@ -343,6 +355,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}@")

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/uploader.rb

@@ -5,8 +5,7 @@ require 'cloudinary/cache'
 
 class Cloudinary::Uploader
 
-  REMOTE_URL_REGEX = %r(^ftp:|^https?:|^s3:|^data:[^;]*;base64,([a-zA-Z0-9\/+\n=]+)$)
-
+  REMOTE_URL_REGEX = Cloudinary::Utils::REMOTE_URL_REGEX
   # @deprecated use {Cloudinary::Utils.build_eager} instead
   def self.build_eager(eager)
     Cloudinary::Utils.build_eager(eager)
@@ -28,6 +27,7 @@ class Cloudinary::Uploader
       :backup                    => Cloudinary::Utils.as_safe_bool(options[:backup]),
       :callback                  => options[:callback],
       :categorization            => options[:categorization],
+      :cinemagraph_analysis      => Cloudinary::Utils.as_safe_bool(options[:cinemagraph_analysis]),
       :colors                    => Cloudinary::Utils.as_safe_bool(options[:colors]),
       :context                   => Cloudinary::Utils.encode_context(options[:context]),
       :custom_coordinates        => Cloudinary::Utils.encode_double_array(options[:custom_coordinates]),
@@ -77,7 +77,7 @@ class Cloudinary::Uploader
       params = build_upload_params(options)
       if file.is_a?(Pathname)
         params[:file] = File.open(file, "rb")
-      elsif file.respond_to?(:read) || file.match(REMOTE_URL_REGEX)
+      elsif file.respond_to?(:read) || Cloudinary::Utils.is_remote?(file)
         params[:file] = file
       else
         params[:file] = File.open(file, "rb")
@@ -95,7 +95,7 @@ class Cloudinary::Uploader
       public_id = public_id_or_options
       options   = old_options
     end
-    if file.match(REMOTE_URL_REGEX)
+    if Cloudinary::Utils.is_remote?(file)
       return upload(file, options.merge(:public_id => public_id))
     elsif file.is_a?(Pathname) || !file.respond_to?(:read)
       filename = file