cloudinary 1.17.1 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e74e0f92ef1143c670e497a22d7b78c638f57d7a35a51585c7a895e654bb95e1
-  data.tar.gz: 64c6b47d7fe482f4cbc7a82a7024a3c18ab51529dc52224067bd120d29e239c1
+  metadata.gz: c9179fe1c8105281b33780687c2bed49db41a35fca2d33ff15bd7fd4635d119f
+  data.tar.gz: 7b3bd01f71f1012bc7f315f707450ebb65537064e004fad615d713f489c4316c
 SHA512:
-  metadata.gz: 784f4de3203258629ee5843fd80d105e6ad59727a43299c5742ae9af25bdd02389b5cc990c563d542a5463970a9d4ae27c9abe99747518962b0a017273c14c85
-  data.tar.gz: da26474dc9fa48717859e648f3620416c02717169a7bd1347e7d2636e6e86b9e39313a8ae5077b9f39c994c465a0d887b5d90d16d0ee0aa58e210757607f1dd3
+  metadata.gz: 347fc122e9a31aa241afa194c09cdc3c0d19e63c5a206cc7751f4939de7c273769d648c7fd33af2cc4e7505fba0a5be9d555f1c3db1e2b41d45cfb58082e1cc3
+  data.tar.gz: 4f04b59256afe8f23c27625d94d761e9802e2ccd91d3c3dc992eb263e3430a7a053467c203d416d379815e317924f042c9310ac0f2b4ca185630307268aa66ca

data/CHANGELOG.md

@@ -1,4 +1,18 @@
 
+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
 ===================
 

data/lib/active_storage/service/cloudinary_service.rb

@@ -1,5 +1,6 @@
 require 'active_storage/blob_key'
 require 'cloudinary/helper'
+require 'net/http'
 
 unless ActiveStorage::Blob.method_defined? :original_key
   class ActiveStorage::Blob
@@ -57,7 +58,7 @@ module ActiveStorage
         url = Cloudinary::Utils.cloudinary_url(
           public_id(key),
           resource_type: resource_type(nil, key),
-          format: ext_for_file(filename, content_type),
+          format: ext_for_file(key, filename, content_type),
           **@options.merge(options.symbolize_keys)
         )
 
@@ -107,8 +108,7 @@ module ActiveStorage
     end
 
     def download(key, &block)
-      url = Cloudinary::Utils.unsigned_download_url(public_id(key), resource_type: resource_type(nil, key))
-      uri = URI(url)
+      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|
@@ -169,12 +169,18 @@ module ActiveStorage
     #
     # 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(filename, content_type)
+    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

data/lib/cloudinary/api.rb

@@ -348,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)
@@ -396,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/uploader.rb

@@ -65,7 +65,8 @@ class Cloudinary::Uploader
       :unique_filename           => Cloudinary::Utils.as_safe_bool(options[:unique_filename]),
       :upload_preset             => options[:upload_preset],
       :use_filename              => Cloudinary::Utils.as_safe_bool(options[:use_filename]),
-      :accessibility_analysis    => Cloudinary::Utils.as_safe_bool(options[:accessibility_analysis])
+      :accessibility_analysis    => Cloudinary::Utils.as_safe_bool(options[:accessibility_analysis]),
+      :metadata                  => Cloudinary::Utils.encode_context(options[:metadata])
     }
     params
   end
@@ -272,6 +273,29 @@ class Cloudinary::Uploader
     return self.call_tags_api(nil, "remove_all", public_ids, options)
   end
 
+  # Populates metadata fields with the given values. Existing values will be overwritten.
+  #
+  # Any metadata-value pairs given are merged with any existing metadata-value pairs
+  # (an empty value for an existing metadata field clears the value).
+  #
+  # @param [Hash] metadata    A list of custom metadata fields (by external_id) and the values to assign to each of them.
+  # @param [Array] public_ids An array of Public IDs of assets uploaded to Cloudinary.
+  # @param [Hash] options
+  # @option options [String] :resource_type The type of file. Default: image. Valid values: image, raw, video.
+  # @option options [String] :type          The storage type. Default: upload. Valid values: upload, private, authenticated
+  # @return mixed a list of public IDs that were updated
+  # @raise [Cloudinary::Api:Error]
+  def self.update_metadata(metadata, public_ids, options = {})
+    self.call_api("metadata", options) do
+      {
+        timestamp: (options[:timestamp] || Time.now.to_i),
+        type: options[:type],
+        public_ids: Cloudinary::Utils.build_array(public_ids),
+        metadata: Cloudinary::Utils.encode_context(metadata)
+      }
+    end
+  end
+
   private
 
   def self.call_tags_api(tag, command, public_ids = [], options = {})

data/lib/cloudinary/utils.rb

@@ -736,6 +736,18 @@ class Cloudinary::Utils
     download_archive_url(options.merge(:target_format => "zip"))
   end
 
+  # Creates and returns a URL that when invoked creates an archive of a folder.
+  #
+  # @param [Object] folder_path Full path (from the root) of the folder to download.
+  # @param [Hash] options       Additional options.
+  #
+  # @return [String]
+  def self.download_folder(folder_path, options = {})
+    resource_type = options[:resource_type] || "all"
+
+    download_archive_url(options.merge(:resource_type => resource_type, :prefixes => folder_path))
+  end
+
   def self.signed_download_url(public_id, options = {})
     aws_private_key_path = options[:aws_private_key_path] || Cloudinary.config.aws_private_key_path
     if aws_private_key_path

data/lib/cloudinary/version.rb

@@ -1,4 +1,4 @@
 # Copyright Cloudinary
 module Cloudinary
-  VERSION = "1.17.1"
+  VERSION = "1.18.0"
 end

data/lib/cloudinary/video_helper.rb

@@ -3,12 +3,33 @@ module CloudinaryHelper
   DEFAULT_POSTER_OPTIONS = { :format => 'jpg', :resource_type => 'video' }
   DEFAULT_SOURCE_TYPES   = %w(webm mp4 ogv)
   DEFAULT_VIDEO_OPTIONS  = { :resource_type => 'video' }
+  DEFAULT_SOURCES        = [
+    {
+      :type            => "mp4",
+      :codecs          => "hev1",
+      :transformations => { :video_codec => "h265" }
+    },
+    {
+      :type            => "webm",
+      :codecs          => "vp9",
+      :transformations => { :video_codec => "vp9" }
+    },
+    {
+      :type            => "mp4",
+      :transformations => { :video_codec => "auto" }
+    },
+    {
+      :type            => "webm",
+      :transformations => { :video_codec => "auto" }
+    }
+  ]
 
   # Creates an HTML video tag for the provided +source+
   #
   # ==== Options
   # * <tt>:source_types</tt> - Specify which source type the tag should include. defaults to webm, mp4 and ogv.
   # * <tt>:source_transformation</tt> - specific transformations to use for a specific source type.
+  # * <tt>:sources</tt> - list of sources (overrides :source_types when present)
   # * <tt>:poster</tt> - override default thumbnail:
   #   * url: provide an ad hoc url
   #   * options: with specific poster transformations and/or Cloudinary +:public_id+
@@ -20,6 +41,17 @@ module CloudinaryHelper
   #   cl_video_tag("mymovie.webm", :source_types => [:webm, :mp4], :poster => {:effect => 'sepia'}) do
   #     content_tag( :span, "Cannot present video!")
   #   end
+  #   cl_video_tag("mymovie", :sources => [
+  #     {
+  #       :type => "mp4",
+  #       :codecs => "hev1",
+  #       :transformations => { :video_codec => "h265" }
+  #     },
+  #     {
+  #       :type => "webm",
+  #       :transformations => { :video_codec => "auto" }
+  #     }
+  #   ])
   def cl_video_tag(source, options = {}, &block)
     source = strip_known_ext(source)
     video_attributes = [:autoplay,:controls,:loop,:muted,:poster, :preload]
@@ -48,30 +80,12 @@ module CloudinaryHelper
       video_options[:poster] = cl_video_thumbnail_path(source, options)
     end
 
-    source_transformation = options.delete(:source_transformation) || {}
-    source_types = Array(options.delete(:source_types))
-    fallback     = (capture(&block) if block_given?) || options.delete(:fallback_content)
+    fallback = (capture(&block) if block_given?) || options.delete(:fallback_content)
 
-    if source_types.size > 1
-      cloudinary_tag(source, options) do |_source, tag_options|
-        content_tag('video', tag_options.merge(video_options)) do
-          source_tags = source_types.map do |type|
-            transformation = source_transformation[type.to_sym] || {}
-            cloudinary_tag("#{source}.#{type}", options.merge(transformation)) do |url, _tag_options|
-              mime_type = "video/#{(type == 'ogv' ? 'ogg' : type)}"
-              tag("source", :src => url, :type => mime_type)
-            end
-          end
-          source_tags.push(fallback.html_safe) unless fallback.blank?
-          safe_join(source_tags)
-        end
-      end
+    if options[:sources]
+      video_tag_from_sources(source, options, video_options, fallback)
     else
-      transformation      = source_transformation[source_types.first.to_sym] || {}
-      video_options[:src] = cl_video_path("#{source}.#{source_types.first.to_sym}", transformation.merge(options))
-      cloudinary_tag(source, options) do |_source, tag_options|
-        content_tag('video', fallback, tag_options.merge(video_options))
-      end
+      video_tag_from_source_types(source, options, video_options, fallback)
     end
   end
 
@@ -96,6 +110,66 @@ module CloudinaryHelper
     name.sub(/\.(#{DEFAULT_SOURCE_TYPES.join("|")})$/, '')
   end
 
+  private
+
+  def video_tag_from_source_types(source_name, options, video_options, fallback)
+    source_transformation = options.delete(:source_transformation) || {}
+    source_types = Array(options.delete(:source_types))
+
+    if source_types.size > 1
+      sources = source_types.map do |type|
+        {
+          :type => type,
+          :transformations => source_transformation[type.to_sym] || {}
+        }
+      end
+
+      generate_tag_from_sources(:source_name => source_name,
+                                :sources => sources,
+                                :options => options,
+                                :video_options => video_options,
+                                :fallback => fallback)
+    else
+      transformation      = source_transformation[source_types.first.to_sym] || {}
+      video_options[:src] = cl_video_path("#{source_name}.#{source_types.first.to_sym}", transformation.merge(options))
+      cloudinary_tag(source_name, options) do |_source, tag_options|
+        content_tag('video', fallback, tag_options.merge(video_options))
+      end
+    end
+  end
+
+  def video_tag_from_sources(source_name, options, video_options, fallback)
+    sources = options.delete(:sources)
+
+    generate_tag_from_sources(:source_name => source_name,
+                              :sources => sources,
+                              :options => options,
+                              :video_options => video_options,
+                              :fallback => fallback)
+  end
+
+  def generate_tag_from_sources(params)
+    source_name, sources, options, video_options, fallback = params.values_at(:source_name, :sources, :options, :video_options, :fallback)
+
+    cloudinary_tag(source_name, options) do |_source, tag_options|
+      content_tag('video', tag_options.merge(video_options)) do
+        source_tags = sources.map do |source|
+          type = source[:type]
+          transformation = source[:transformations] || {}
+          cloudinary_tag("#{source_name}.#{type}", options.merge(transformation)) do |url, _tag_options|
+            mime_type = "video/#{(type == 'ogv' ? 'ogg' : type)}"
+            if source[:codecs]
+              codecs = source[:codecs].is_a?(Array) ? source[:codecs].join(", ") : source[:codecs]
+              mime_type = "#{mime_type}; codecs=#{codecs}"
+            end
+            tag("source", :src => url, :type => mime_type)
+          end
+        end
+        source_tags.push(fallback.html_safe) unless fallback.blank?
+        safe_join(source_tags)
+      end
+    end
+  end
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudinary
 version: !ruby/object:Gem::Version
-  version: 1.17.1
+  version: 1.18.0
 platform: ruby
 authors:
 - Nadav Soferman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws_cf_signer