cloudinary 1.5.2 → 1.6.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    M2E1MWI3ZmRiNDA2YWE2ZTA0OTYzZDUyZmIxMmNjYWJhMjFhNzVmNA==
-  data.tar.gz: !binary |-
-    NjUzMWYwOGVkNTU0ZmE3ZDIyZjJjNzM1MGE5YWM4ZWRhYWY2OGQyYg==
+SHA1:
+  metadata.gz: 36330c17f742e019c7770d39fe11a5e394d69acc
+  data.tar.gz: 511246947d366e91a8d34095f256437bde533f9e
 SHA512:
-  metadata.gz: !binary |-
-    NDFjMjgyNTE1MTkxODkxZjcyN2VmOGU3ODZiMWU2NjAyMWNiODc2YjJiMGMz
-    YzkxOTYyZjRkOTU4MmM2MGMxNThmMDQ3NThiMWUxOTFmZGE0OTBkNjJkYTlk
-    ZWI1MDdhOGVjMzUyZmE2NzMzMWQ3M2U0MTFmZWY5NmYxNDJjNWY=
-  data.tar.gz: !binary |-
-    ZDEzODU4YWJhOGExNmQxZjY2NGI5OTZkMjk1NmFiMGY1YWFiZTdkODcwZWIw
-    MmM5NGQ5OWIzZGJmNjBhZmE1OGViZmFhZGMzOGJmNTU4M2M2ZTAzM2FkNTlk
-    ZDMxNDA1MDNmOGE4ODk5M2Y5MDkyZDRhOTI4NTNlOGVhYmRjZWI=
+  metadata.gz: 4fcbb47f1760342d5e1b36e0438a605524eb20b9f0fac98521846f71102447ce6dda1ebb3f435e43d6227320bb48a65c85f5ae44da20b0c4fcb1539f7d78232a
+  data.tar.gz: 190f0970236cb76615d6537276fdd3633297e4c749815a6c54ae985188bee5e493d778a55c60798ac3ebaf9cb14930eb2b3589f45914c69cc489d378d5b19970

data/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+1.6.0 / 2017-03-08
+==================
+
+New functionality and features
+------------------------------
+
+  * Support user defined variables
+  * Add `to_type` parameter to the rename method (#236)
+  * Add `async` parameter to the upload method (#235)
+
+Other Changes
+-------------
+
+  * Switch ow & oh to iw & ih on respective test case
+  * test auto gravity transformation in URL build
+
 1.5.2 / 2017-02-22
 ==================
 

data/lib/cloudinary/uploader.rb

@@ -18,6 +18,7 @@ class Cloudinary::Uploader
     params = {
       :access_mode               => options[:access_mode],
       :allowed_formats           => Cloudinary::Utils.build_array(options[:allowed_formats]).join(","),
+      :async                     => Cloudinary::Utils.as_safe_bool(options[:async]),
       :auto_tagging              => options[:auto_tagging] && options[:auto_tagging].to_f,
       :background_removal        => options[:background_removal],
       :backup                    => Cloudinary::Utils.as_safe_bool(options[:backup]),
@@ -142,6 +143,7 @@ class Cloudinary::Uploader
         :overwrite      => Cloudinary::Utils.as_safe_bool(options[:overwrite]),
         :from_public_id => from_public_id,
         :to_public_id   => to_public_id,
+        :to_type        => options[:to_type],
         :invalidate     => Cloudinary::Utils.as_safe_bool(options[:invalidate])
       }
     end

data/lib/cloudinary/utils.rb

@@ -19,15 +19,26 @@ class Cloudinary::Utils
     "<=" => 'lte',
     ">=" => 'gte',
     "&&" => 'and',
-    "||" => 'or'
+    "||" => 'or',
+    "*" => 'mul',
+    "/" => 'div',
+    "+" => 'add',
+    "-" => 'sub'
   }
 
-  CONDITIONAL_PARAMETERS = {
-    "width" => "w",
-    "height" => "h",
-    "aspect_ratio" => "ar",
-    "page_count" => "pc",
-    "face_count" => "fc"
+  PREDEFINED_VARS = {
+    "aspect_ratio"         => "ar",
+    "current_page"         => "cp",
+    "face_count"           => "fc",
+    "height"               => "h",
+    "initial_aspect_ratio" => "iar",
+    "initial_height"       => "ih",
+    "initial_width"        => "iw",
+    "page_count"           => "pc",
+    "page_x"               => "px",
+    "page_y"               => "py",
+    "tags"                 => "tags",
+    "width"                => "w"
   }
   # Warning: options are being destructively updated!
   def self.generate_transformation_string(options={}, allow_implicit_crop_mode = false)
@@ -96,24 +107,30 @@ class Cloudinary::Utils
     ifValue = process_if(options.delete(:if))
 
     params = {
-      :a   => angle,
+      :a   => normalize_expression(angle),
+      :ar => normalize_expression(options.delete(:aspect_ratio)),
       :b   => background,
       :bo  => border,
       :c   => crop,
       :co  => color,
-      :dpr => dpr,
-      :e   => effect,
+      :dpr => normalize_expression(dpr),
+      :e   => normalize_expression(effect),
       :fl  => flags,
-      :h   => height,
+      :h   => normalize_expression(height),
       :l  => overlay,
+      :o => normalize_expression(options.delete(:opacity)),
+      :q => normalize_expression(options.delete(:quality)),
+      :r => normalize_expression(options.delete(:radius)),
       :t   => named_transformation,
       :u  => underlay,
-      :w   => width
+      :w   => normalize_expression(width),
+      :x => normalize_expression(options.delete(:x)),
+      :y => normalize_expression(options.delete(:y)),
+      :z => normalize_expression(options.delete(:zoom))
     }
     {
       :ac => :audio_codec,
       :af => :audio_frequency,
-      :ar => :aspect_ratio,
       :br => :bit_rate,
       :cs => :color_space,
       :d  => :default_image,
@@ -124,18 +141,12 @@ class Cloudinary::Utils
       :f  => :fetch_format,
       :g  => :gravity,
       :ki => :keyframe_interval,
-      :o  => :opacity,
       :p  => :prefix,
       :pg => :page,
-      :q  => :quality,
-      :r  => :radius,
       :so => :start_offset,
       :sp => :streaming_profile,
       :vc => :video_codec,
-      :vs => :video_sampling,
-      :x  => :x,
-      :y  => :y,
-      :z  => :zoom
+      :vs => :video_sampling
     }.each do
       |param, option|
       params[param] = options.delete(option)
@@ -146,10 +157,25 @@ class Cloudinary::Utils
       params[range_value] = norm_range_value params[range_value] if params[range_value].present?
     end
 
+    variables = options.delete(:variables)
+    var_params = []
+    options.each_pair do |key, value|
+      if key =~ /^\$/
+        var_params.push "#{key}_#{normalize_expression(value.to_s)}"
+      end
+    end
+    var_params.sort!
+    unless variables.nil? || variables.empty?
+      for name, value in variables
+        var_params.push "#{name}_#{normalize_expression(value.to_s)}"
+      end
+    end
+    variables = var_params.join(',')
+
     raw_transformation = options.delete(:raw_transformation)
     transformation = params.reject{|_k,v| v.blank?}.map{|k,v| "#{k}_#{v}"}.sort
     transformation = transformation.join(",")
-    transformation = [ifValue, transformation, raw_transformation].reject(&:blank?).join(",")
+    transformation = [ifValue, variables, transformation, raw_transformation].reject(&:blank?).join(",")
 
     transformations = base_transformations << transformation
     if responsive_width
@@ -173,15 +199,23 @@ class Cloudinary::Utils
   # @private
   def self.process_if(ifValue)
     if ifValue
-      ifValue = ifValue.gsub(
-        /(#{CONDITIONAL_PARAMETERS.keys.join("|")}|[=<>&|!]+)/,
-        CONDITIONAL_PARAMETERS.merge(CONDITIONAL_OPERATORS))
-        .gsub(/[ _]+/, "_")
+      ifValue = normalize_expression(ifValue)
 
       ifValue = "if_" + ifValue
     end
   end
 
+  def self.normalize_expression(expression)
+    if expression =~ /^!.+!$/ # quoted string
+      expression
+    else
+      expression.to_s.gsub(
+        Regexp.union(*PREDEFINED_VARS.keys, *CONDITIONAL_OPERATORS.keys.reverse),
+        PREDEFINED_VARS.merge(CONDITIONAL_OPERATORS)
+      ).gsub(/[ _]+/, "_")
+    end
+  end
+
   # Parse layer options
   # @return [string] layer transformation string
   # @private
@@ -218,8 +252,16 @@ class Cloudinary::Utils
            unless public_id.blank? ^ text_style.blank?
              raise(CloudinaryException, "Must supply either style parameters or a public_id when providing text parameter in a text overlay/underlay")
            end
-           text = smart_escape smart_escape(text, %r"([,/])")
 
+           result = ""
+           # Don't encode interpolation expressions e.g. $(variable)
+           while(/\$\([a-zA-Z]\w+\)/.match text) do
+             match = Regexp.last_match
+             result += smart_escape smart_escape(match.pre_match, %r"([,/])") # append encoded pre-match
+             result += match.to_s # append match
+             text = match.post_match
+           end
+           text = result + smart_escape( smart_escape(text, %r"([,/])"))
          end
        end
        components.push(resource_type) if resource_type != "image"

data/lib/cloudinary/version.rb

@@ -1,4 +1,4 @@
 # Copyright Cloudinary
 module Cloudinary
-  VERSION = "1.5.2"
+  VERSION = "1.6.0"
 end

data/spec/uploader_spec.rb

@@ -30,10 +30,16 @@ describe Cloudinary::Uploader do
     expect(result["signature"]).to eq(expected_signature)
   end
 
+  it "should successfully upload file asynchronously" do
+    result = Cloudinary::Uploader.upload(Pathname.new(TEST_IMG), :async => true)
+    expect(result["status"]).to eq("pending")
+  end
+
   describe '.rename' do
     before(:all) do
       @result        = Cloudinary::Uploader.upload(TEST_IMG, :tags => [TEST_TAG, TIMESTAMP_TAG])
       @resource_1_id = @result["public_id"]
+      @resource_1_type = @result["type"]
       result         = Cloudinary::Uploader.upload("spec/favicon.ico", :tags => [TEST_TAG, TIMESTAMP_TAG])
       @resource_2_id = result["public_id"]
     end
@@ -49,6 +55,14 @@ describe Cloudinary::Uploader do
       expect { Cloudinary::Uploader.rename(id, @resource_1_id+"2") }.to raise_error(CloudinaryException)
       @resource_2_id = id
     end
+    it 'should allow changing type of an uploaded resource' do
+      id = @resource_2_id
+      from_type = @resource_1_type
+      to_type = "private"
+      Cloudinary::Uploader.rename(id, id, :type => from_type, :to_type => to_type)
+      expect(Cloudinary::Api.resource(id, type: to_type)).to_not be_empty
+      Cloudinary::Uploader.rename(id, id, :type => to_type, :to_type => from_type)
+    end
     context ':overwrite => true' do
       it 'should rename to an existing ID' do
         new_id = Cloudinary::Uploader.upload(TEST_IMG, :tags => [TEST_TAG, TIMESTAMP_TAG])["public_id"]

data/spec/utils_spec.rb

@@ -230,9 +230,9 @@ describe Cloudinary::Utils do
       expect(["test", { :width => "auto:breakpoints:json", :crop => :fill }])
           .to produce_url("#{upload_path}/c_fill,w_auto:breakpoints:json/test")
     end
-    it 'should support oh,ow' do
-      expect(["test", {:width => "ow", :height => "oh", :crop => :crop}])
-          .to produce_url("#{upload_path}/c_crop,h_oh,w_ow/test")
+    it 'should support ih,iw' do
+      expect(["test", {:width => "iw", :height => "ih", :crop => :crop}])
+          .to produce_url("#{upload_path}/c_crop,h_ih,w_iw/test")
     end
   end
 
@@ -240,8 +240,12 @@ describe Cloudinary::Utils do
     expect(["test", { :x => 1, :y => 2, :radius => 3, :gravity => :center, :quality => 0.4, :prefix => "a" }])
       .to produce_url("#{upload_path}/g_center,p_a,q_0.4,r_3,x_1,y_2/test")
             .and empty_options
+
+    expect(["test", { :width => 0.5, :crop => :crop, :gravity => :auto }])
+      .to produce_url("#{upload_path}/c_crop,g_auto,w_0.5/test")
+            .and empty_options
   end
-  context ":quality" do
+  describe ":quality" do
     it "support a percent value" do
       expect(["test", { :x => 1, :y => 2, :radius => 3, :gravity => :center, :quality => 80, :prefix => "a" }])
           .to produce_url("#{upload_path}/g_center,p_a,q_80,r_3,x_1,y_2/test")
@@ -771,21 +775,51 @@ describe Cloudinary::Utils do
       end
       it "should support and translate operators:  '=', '!=', '<', '>', '<=', '>=', '&&', '||'" do
 
-        allOperators =
-          'if_'           +
-            'w_eq_0_and'    +
-            '_w_ne_0_or'    +
-            '_h_lt_0_and'   +
-            '_ar_gt_0_and'   +
-            '_pc_lte_0_and'  +
-            '_fc_gte_0'      +
+        all_operators =
+          'if_' +
+            'w_eq_0_and' +
+            '_w_ne_0_or' +
+            '_h_lt_0_and' +
+            '_ar_gt_0_and' +
+            '_pc_lte_0_and' +
+            '_fc_gte_0' +
             ',e_grayscale'
 
         expect( ["sample",
                  :if =>"width = 0 && w != 0 || height < 0 and aspect_ratio > 0 and page_count <= 0 and face_count >= 0",
                  :effect =>"grayscale"])
-          .to produce_url("#{upload_path}/#{allOperators}/sample")
+          .to produce_url("#{upload_path}/#{all_operators}/sample")
+    end
+
+    end
+  end
+
+  describe "variables" do
+    it "array should define a set of variables" do
+      options = {
+          :if => "face_count > 2",
+          :variables => [ ["$z", 5], ["$foo", "$z * 2"] ],
+          :crop => "scale", :width => "$foo * 200"
+        }
+      t = Cloudinary::Utils.generate_transformation_string options
+      expect(t).to eq("if_fc_gt_2,$z_5,$foo_$z_mul_2,c_scale,w_$foo_mul_200")
+    end
+    it "'$key' should define a variable" do
+      options = { :transformation => [
+        {"$foo" => 10 },
+        {:if => "face_count > 2"},
+        {:crop => "scale", :width => "$foo * 200 / face_count"},
+        {:if => "end"}
+      ] }
+      t = Cloudinary::Utils.generate_transformation_string options
+      expect(t).to eq("$foo_10/if_fc_gt_2/c_scale,w_$foo_mul_200_div_fc/if_end")
+    end
+    it "should support text values" do
+      expect( ["sample", :effect => "$efname:100", "$efname" => "!blur!"]).to produce_url "#{upload_path}/$efname_!blur!,e_$efname:100/sample"
+
     end
+    it "should support string interpolation" do
+      expect( ["sample", :crop => "scale", :overlay => {:text => "$(start)Hello $(name)$(ext), $(no ) $( no)$(end)", :font_family => "Arial", :font_size => "18"} ]).to produce_url "#{upload_path}/c_scale,l_text:Arial_18:$(start)Hello%20$(name)$(ext)%252C%20%24%28no%20%29%20%24%28%20no%29$(end)/sample"
 
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudinary
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Nadav Soferman
@@ -10,134 +10,106 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws_cf_signer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - <
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - <
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - <
-      - !ruby/object:Gem::Version
-        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: '0'
 description: Client library for easily using the Cloudinary service
 email:
 - nadav.soferman@cloudinary.com
@@ -147,9 +119,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -219,17 +191,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: cloudinary
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Client library for easily using the Cloudinary service