cloudinary 1.25.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27739f4540fd5b75d22128cc2bb0d885160c4d00163e658048ef770e72ab2d33
-  data.tar.gz: e4f02a3ce402b625a1323f6e0cc14d8f55436de953127090491266377d9576e9
+  metadata.gz: 9bb33366a739a067a66cbcaf66534e48663e726d57f4d4b3657c44ec43f092e7
+  data.tar.gz: 0dd05a5beabf06fc8d1914c7375fa7a6d37fce532edca0021919e13d9b28d318
 SHA512:
-  metadata.gz: 15e356e735c9c9e7a2cf0df6269e553bff2e4416386cfdff9a3d5edc81d6fbd4213c73d4c6e907e6a42e8d3680dcbf74e4d90ded012d7ed1c8167a2271ab251f
-  data.tar.gz: 2720b423770f63dbb7369233c12096846fa157ba2f0f4f465da94128bd574bdc2992bfba8a89ee81877e571a26fbd33a86b6150cfccb78923bd9d2267c9f0b08
+  metadata.gz: 64cb7b27cd9909da6fbbaaf98777d4f05046098a6adb1572998323fd7517bf30c73095844683c83da59808f5945c93e90f1e2c685e06ff156b682fe92e902878
+  data.tar.gz: f098206a8c9f6c73609ad2415cfc90f8359c678461d0bb22f5164aba57111fe55129eed6e98767c6242387ee6294bf4139b034848a1ff9b792cf1dba9fa3ef77

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+1.26.0 / 2023-06-01
+==================
+
+New functionality and features
+------------------------------
+
+  * Add support for related assets Admin APIs
+  * Add support for expressions in `start_offset` and `end_offset` parameters
+  * Add support for Conditional Metadata Rules API
+  * Add support for large files in Active Storage
+
 1.25.0 / 2023-01-04
 ==================
 

data/cloudinary.gemspec

@@ -39,8 +39,12 @@ Gem::Specification.new do |s|
   else
     s.add_development_dependency "rake", "<= 12.2.1"
   end
+  if RUBY_VERSION >= "2.7.0"
+    s.add_development_dependency "sqlite3"
+  else
+    s.add_development_dependency "sqlite3", "< 1.6.0"
+  end
 
-  s.add_development_dependency "sqlite3"
   s.add_development_dependency "rspec", '>=3.5'
   s.add_development_dependency "rspec-retry"
 
@@ -57,6 +61,8 @@ Gem::Specification.new do |s|
 
   if RUBY_VERSION <= "2.4.0"
     s.add_development_dependency "simplecov", "<= 0.17.1" # support testing Ruby 1.9
+    s.add_development_dependency 'loofah', '~>2.19.1'
+    s.add_development_dependency "rails-html-sanitizer", "<1.5.0"
   else
     s.add_development_dependency "simplecov", "> 0.18.0"
   end

data/lib/active_storage/service/cloudinary_service.rb

@@ -39,7 +39,7 @@ module ActiveStorage
         begin
           extra_headers = checksum.nil? ? {} : {Headers::CONTENT_MD5 => checksum}
           options = @options.merge(options)
-          Cloudinary::Uploader.upload(
+          Cloudinary::Uploader.upload_large(
             io,
             public_id: public_id_internal(key),
             resource_type: resource_type(io, key),

data/lib/cloudinary/api.rb

@@ -406,6 +406,76 @@ class Cloudinary::Api
     call_api(:delete, uri, params, options)
   end
 
+  # Relates an asset to other assets by public IDs.
+  #
+  # @param [String]            public_id        The public ID of the asset.
+  # @param [String|Array]      assets_to_relate The array of up to 10 fully_qualified_public_ids given as
+  #                                             resource_type/type/public_id.
+  # @param [Hash]              options          The optional parameters. See the
+  #   {https://cloudinary.com/documentation/admin_api#add_related_assets Admin API} documentation.
+  #
+  # @return [Cloudinary::Api::Response]
+  #
+  # @raise [Cloudinary::Api::Error]
+  def self.add_related_assets(public_id, assets_to_relate, options={})
+    resource_type = options[:resource_type] || "image"
+    type          = options[:type] || "upload"
+    uri           = "resources/related_assets/#{resource_type}/#{type}/#{public_id}"
+    params = {:assets_to_relate => Cloudinary::Utils.build_array(assets_to_relate)}
+    call_api(:post, uri, params, options)
+  end
+
+  # Relates an asset to other assets by asset IDs.
+  #
+  # @param [String]            asset_id         The asset ID of the asset to update.
+  # @param [String|Array]      assets_to_relate The array of up to 10 asset IDs.
+  # @param [Hash]              options          The optional parameters. See the
+  #   {https://cloudinary.com/documentation/admin_api#add_related_assets_by_asset_id Admin API} documentation.
+  #
+  # @return [Cloudinary::Api::Response]
+  #
+  # @raise [Cloudinary::Api::Error]
+  def self.add_related_assets_by_asset_ids(asset_id, assets_to_relate, options={})
+    uri           = "resources/related_assets/#{asset_id}"
+    params = {:assets_to_relate => Cloudinary::Utils.build_array(assets_to_relate)}
+    call_api(:post, uri, params, options)
+  end
+
+  # Unrelates an asset from other assets by public IDs.
+  #
+  # @param [String]            public_id          The public ID of the asset.
+  # @param [String|Array]      assets_to_unrelate The array of up to 10 fully_qualified_public_ids given as
+  #                                               resource_type/type/public_id.
+  # @param [Hash]              options            The optional parameters. See the
+  #   {https://cloudinary.com/documentation/admin_api#delete_related_assets Admin API} documentation.
+  #
+  # @return [Cloudinary::Api::Response]
+  #
+  # @raise [Cloudinary::Api::Error]
+  def self.delete_related_assets(public_id, assets_to_unrelate, options={})
+    resource_type = options[:resource_type] || "image"
+    type          = options[:type] || "upload"
+    uri           = "resources/related_assets/#{resource_type}/#{type}/#{public_id}"
+    params = {:assets_to_unrelate => Cloudinary::Utils.build_array(assets_to_unrelate)}
+    call_api(:delete, uri, params, options)
+  end
+
+  # Unrelates an asset from other assets by asset IDs.
+  #
+  # @param [String]            asset_id           The asset ID of the asset to update.
+  # @param [String|Array]      assets_to_unrelate The array of up to 10 asset IDs.
+  # @param [Hash]              options            The optional parameters. See the
+  #   {https://cloudinary.com/documentation/admin_api#delete_related_assets_by_asset_id Admin API} documentation.
+  #
+  # @return [Cloudinary::Api::Response]
+  #
+  # @raise [Cloudinary::Api::Error]
+  def self.delete_related_assets_by_asset_ids(asset_id, assets_to_unrelate, options={})
+    uri           = "resources/related_assets/#{asset_id}"
+    params = {:assets_to_unrelate => Cloudinary::Utils.build_array(assets_to_unrelate)}
+    call_api(:delete, uri, params, options)
+  end
+
   # Lists all the tags currently used for a specified asset type.
   #
   # @param [Hash] options The optional parameters. See the
@@ -1077,6 +1147,75 @@ class Cloudinary::Api
     call_metadata_api(:put, uri, params, options)
   end
 
+  # Lists all metadata rules definitions.
+  #
+  # @param [Hash] options The optional parameters.
+  #
+  # @return [Cloudinary::Api::Response]
+  #
+  # @raise [Cloudinary::Api::Error]
+  #
+  # @see https://cloudinary.com/documentation/conditional_metadata_rules_api#get_metadata_rules
+  def self.list_metadata_rules(options = {})
+    call_metadata_rules_api(:get, [], {}, options)
+  end
+
+
+  # Creates a new metadata rule definition.
+  #
+  # @param [Hash] rule    The rule to add.
+  # @param [Hash] options The optional parameters.
+  #
+  # @return [Cloudinary::Api::Response]
+  #
+  # @raise [Cloudinary::Api::Error]
+  #
+  # @see https://cloudinary.com/documentation/conditional_metadata_rules_api#create_a_metadata_rule
+  def self.add_metadata_rule(rule, options = {})
+    params = only(rule, :metadata_field_id, :condition, :result, :name)
+
+    call_metadata_rules_api(:post, [], params, options)
+  end
+
+  # Updates a metadata rule by external ID.
+  #
+  # Updates an existing metadata rule definition. Expects a JSON object which defines the updated rule.
+  #
+  # @param [String] external_id       The ID of the rule to update.
+  # @param [Hash]   rule              The rule definition.
+  # @param [Hash]   options           The optional parameters.
+  #
+  # @return [Cloudinary::Api::Response]
+  #
+  # @raise [Cloudinary::Api::Error]
+  #
+  # @see https://cloudinary.com/documentation/conditional_metadata_rules_api#update_a_metadata_rule_by_id
+  def self.update_metadata_rule(external_id, rule, options = {})
+    uri = [external_id]
+    params = only(rule, :metadata_field_id, :condition, :result, :name, :state)
+
+    call_metadata_rules_api(:put, uri, params, options)
+  end
+
+  # Deletes a metadata rule definition by external ID.
+  #
+  # The rule should no longer be considered a valid candidate for all other endpoints
+  # (it will not show up in the list of rules, etc).
+  #
+  # @param [String] external_id The ID of the rule to delete.
+  # @param [Hash]   options     The optional parameters.
+  #
+  # @return [Cloudinary::Api::Response]
+  #
+  # @raise [Cloudinary::Api::Error]
+  #
+  # @see https://cloudinary.com/documentation/conditional_metadata_rules_api#delete_a_metadata_rule_by_id
+  def self.delete_metadata_rule(external_id, options = {})
+    uri = [external_id]
+
+    call_metadata_rules_api(:delete, uri, {}, options)
+  end
+
   protected
 
   # Execute a call api for input params.
@@ -1128,6 +1267,22 @@ class Cloudinary::Api
     call_api(method, uri, params, options)
   end
 
+  # Protected function that assists with performing an API call to the metadata_rules 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_rules')
+  # @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] Returned response from Cloudinary
+  # @raise [Cloudinary::Api::Error]
+  def self.call_metadata_rules_api(method, uri, params, options)
+    options[:content_type] = :json
+    uri = ["metadata_rules", uri].reject(&:empty?).join("/")
+
+    call_api(method, uri, params, options)
+  end
+
   # Prepares optional parameters for asset/assetByAssetId API calls.
   # @param  [Hash]   options Additional options
   # @return [Object]         Optional parameters

data/lib/cloudinary/uploader.rb

@@ -108,26 +108,38 @@ class Cloudinary::Uploader
       public_id = public_id_or_options
       options   = old_options
     end
+
+    options.merge(:public_id => public_id)
+
     if Cloudinary::Utils.is_remote?(file)
-      return upload(file, options.merge(:public_id => public_id))
-    elsif file.is_a?(Pathname) || !file.respond_to?(:read)
+      return upload(file, options)
+    end
+
+    if file.is_a?(Pathname) || !file.respond_to?(:read)
       filename = file
       file     = File.open(file, "rb")
     else
       filename = "cloudinaryfile"
     end
 
+    chunk_size = options[:chunk_size] || 20_000_000
+
+    if file.size < chunk_size
+      return upload(file, options)
+    end
+
     filename = options[:filename] if options[:filename]
 
     unique_upload_id = Cloudinary::Utils.random_public_id
     upload     = nil
     index      = 0
-    chunk_size = options[:chunk_size] || 20_000_000
+
     until file.eof?
       buffer      = file.read(chunk_size)
       current_loc = index*chunk_size
       range       = "bytes #{current_loc}-#{current_loc+buffer.size - 1}/#{file.size}"
-      upload      = upload_large_part(Cloudinary::Blob.new(buffer, :original_filename => filename), options.merge(:public_id => public_id, :unique_upload_id => unique_upload_id, :content_range => range))
+      upload      = upload_large_part(Cloudinary::Blob.new(buffer, :original_filename => filename),
+                                      options.merge(:unique_upload_id => unique_upload_id, :content_range => range))
       index       += 1
     end
     upload

data/lib/cloudinary/utils.rb

@@ -1175,11 +1175,13 @@ class Cloudinary::Utils
   # @private
   def self.norm_range_value(value) # :nodoc:
     offset = /^#{offset_any_pattern}$/.match( value.to_s)
+
     if offset
-      modifier   = offset[5].present? ? 'p' : ''
-      value  = "#{offset[1]}#{modifier}"
+      modifier = offset[5].present? ? 'p' : ''
+      "#{offset[1]}#{modifier}"
+    else
+      normalize_expression(value)
     end
-    value
   end
   private_class_method :norm_range_value
 

data/lib/cloudinary/version.rb

@@ -1,4 +1,4 @@
 # Copyright Cloudinary
 module Cloudinary
-  VERSION = "1.25.0"
+  VERSION = "1.26.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudinary
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Nadav Soferman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws_cf_signer
@@ -276,8 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: cloudinary
-rubygems_version: 2.7.6
+rubygems_version: 3.4.12
 signing_key: 
 specification_version: 4
 summary: Client library for easily using the Cloudinary service