cloudinary 1.0.66 → 1.0.67

data/CHANGELOG

@@ -1,3 +1,11 @@
+= Version 1.0.67 - 2014-01-09
+  * Support specifying face coordinates in upload API.
+  * Support specifying context (currently alt and caption) in upload API and returning context in API.  
+  * Support specifying allowed image formats in upload API.
+  * Support listing resources in admin API by multiple public IDs.
+  * Send User-Agent header with client library version in API request.  
+  * Support for signed-URLs to override restricted dynamic URLs.    
+
 = Version 1.0.66 - 2013-11-14
   * Support overwrite flag in upload
   * Support tags flag in resources_by_tag

data/lib/cloudinary.rb

@@ -25,7 +25,9 @@ module Cloudinary
   CF_SHARED_CDN = "d3jpl91pxevbkh.cloudfront.net"
   AKAMAI_SHARED_CDN = "res.cloudinary.com"
   OLD_AKAMAI_SHARED_CDN = "cloudinary-a.akamaihd.net"
-  SHARED_CDN = AKAMAI_SHARED_CDN  
+  SHARED_CDN = AKAMAI_SHARED_CDN
+  
+  USER_AGENT = "cld-ruby-" + VERSION
     
   FORMAT_ALIASES = {
     "jpeg" => "jpg",

data/lib/cloudinary/api.rb

@@ -36,13 +36,20 @@ class Cloudinary::Api
     type = options[:type]
     uri = "resources/#{resource_type}"
     uri += "/#{type}" if !type.blank?
-    call_api(:get, uri, only(options, :next_cursor, :max_results, :prefix, :tags), options)    
+    call_api(:get, uri, only(options, :next_cursor, :max_results, :prefix, :tags, :context), options)    
   end
   
   def self.resources_by_tag(tag, options={})
     resource_type = options[:resource_type] || "image"
     uri = "resources/#{resource_type}/tags/#{tag}"
-    call_api(:get, uri, only(options, :next_cursor, :max_results, :tags), options)    
+    call_api(:get, uri, only(options, :next_cursor, :max_results, :tags, :context), options)    
+  end
+  
+  def self.resources_by_ids(public_ids, options={})
+    resource_type = options[:resource_type] || "image"
+    type = options[:type] || "upload"
+    uri = "resources/#{resource_type}/#{type}"
+    call_api(:get, uri, only(options, :tags, :context).merge(public_ids: public_ids), options)
   end
   
   def self.resource(public_id, options={})
@@ -126,7 +133,7 @@ class Cloudinary::Api
     # Add authentication
     api_url.sub!(%r(^(https?://)), "\\1#{api_key}:#{api_secret}@")
     
-    RestClient::Request.execute(:method => method, :url => api_url, :payload => params.reject{|k, v| v.nil? || v==""}, :timeout=>60) do
+    RestClient::Request.execute(:method => method, :url => api_url, :payload => params.reject{|k, v| v.nil? || v==""}, :timeout=>60, :headers => {"User-Agent" => Cloudinary::USER_AGENT}) do
       |response, request, tmpresult|
       return Response.new(response) if response.code == 200
       exception_class = case response.code

data/lib/cloudinary/uploader.rb

@@ -38,7 +38,10 @@ class Cloudinary::Uploader
               :eager_async=>Cloudinary::Utils.as_safe_bool(options[:eager_async]),
               :proxy=>options[:proxy],
               :folder=>options[:folder],
-              :tags=>options[:tags] && Cloudinary::Utils.build_array(options[:tags]).join(",")}    
+              :tags=>options[:tags] && Cloudinary::Utils.build_array(options[:tags]).join(","),
+              :allowed_formats =>  Cloudinary::Utils.build_array(options[:allowed_formats]).join(","),
+              :context => Cloudinary::Utils.encode_hash(options[:context]),
+              :face_coordinates => Cloudinary::Utils.encode_double_array(options[:face_coordinates])}    
     params    
   end
    
@@ -98,7 +101,8 @@ class Cloudinary::Uploader
         :callback=> options[:callback],
         :eager=>build_eager(options[:eager]),
         :headers=>build_custom_headers(options[:headers]),
-        :tags=>options[:tags] && Cloudinary::Utils.build_array(options[:tags]).join(",")    
+        :tags=>options[:tags] && Cloudinary::Utils.build_array(options[:tags]).join(","),
+        :face_coordinates => options[:face_coordinates] && Cloudinary::Utils.encode_double_array(options[:face_coordinates])  
       }
     end              
   end
@@ -205,7 +209,7 @@ class Cloudinary::Uploader
     
     api_url = Cloudinary::Utils.cloudinary_api_url(action, options)
     
-    RestClient::Request.execute(:method => :post, :url => api_url, :payload => params.reject{|k, v| v.nil? || v==""}, :timeout=>60) do
+    RestClient::Request.execute(:method => :post, :url => api_url, :payload => params.reject{|k, v| v.nil? || v==""}, :timeout=>60, :headers => {"User-Agent" => Cloudinary::USER_AGENT}) do
       |response, request, tmpresult|
       raise CloudinaryException, "Server returned unexpected status code - #{response.code} - #{response.body}" if ![200,400,401,403,404,500].include?(response.code)
       begin

data/lib/cloudinary/utils.rb

@@ -107,6 +107,8 @@ class Cloudinary::Utils
     shorten = config_option_consume(options, :shorten) 
     force_remote = options.delete(:force_remote)
     cdn_subdomain = config_option_consume(options, :cdn_subdomain) 
+    sign_url = config_option_consume(options, :sign_url)
+    secret = config_option_consume(options, :api_secret)
     
     original_source = source
     return original_source if source.blank?
@@ -165,9 +167,13 @@ class Cloudinary::Utils
       type = nil
     end
     version ||= 1 if source.include?("/") and !source.match(/^v[0-9]+/) and !source.match(/^https?:\//)
-    source = prefix + "/" + [resource_type, 
-     type, transformation, version ? "v#{version}" : nil,
-     source].reject(&:blank?).join("/").gsub(%r(([^:])//), '\1/')
+    
+    rest = [transformation, version ? "v#{version}" : nil, source].reject(&:blank?).join("/").gsub(%r(([^:])//), '\1/')
+    if sign_url
+      rest = 's--' + Base64.urlsafe_encode64(Digest::SHA1.digest(rest + secret))[0,8] + '--/' + rest
+    end
+    
+    source = prefix + "/" + [resource_type, type, rest].reject(&:blank?).join("/").gsub(%r(([^:])//), '\1/')
   end
   
   def self.cloudinary_api_url(action = 'upload', options = {})
@@ -272,6 +278,18 @@ class Cloudinary::Utils
       else [array]
     end
   end
+    
+  def self.encode_hash(hash)
+    case hash
+      when Hash then hash.map{|k,v| "#{k}=#{v}"}.join("|")
+      when nil then ""
+      else hash
+    end
+  end
+  
+  def self.encode_double_array(array)
+    build_array(array).map{|a| build_array(a).join(",")}.join("|")
+  end
   
   IMAGE_FORMATS = %w(bmp png tif tiff jpg jpeg gif pdf ico eps jpc jp2 psd) 
   

data/lib/cloudinary/version.rb

@@ -1,4 +1,4 @@
 # Copyright Cloudinary
 module Cloudinary
-  VERSION = "1.0.66"
+  VERSION = "1.0.67"
 end

data/spec/api_spec.rb

@@ -8,8 +8,8 @@ describe Cloudinary::Api do
     @api = Cloudinary::Api
     Cloudinary::Uploader.destroy("api_test")
     Cloudinary::Uploader.destroy("api_test2")
-    Cloudinary::Uploader.upload("spec/logo.png", :public_id=>"api_test", :tags=>"api_test_tag", :eager=>[:width=>100,:crop=>:scale])
-    Cloudinary::Uploader.upload("spec/logo.png", :public_id=>"api_test2", :tags=>"api_test_tag", :eager=>[:width=>100,:crop=>:scale])
+    Cloudinary::Uploader.upload("spec/logo.png", :public_id=>"api_test", :tags=>"api_test_tag", :context => "key=value", :eager=>[:width=>100,:crop=>:scale])
+    Cloudinary::Uploader.upload("spec/logo.png", :public_id=>"api_test2", :tags=>"api_test_tag", :context => "key=value", :eager=>[:width=>100,:crop=>:scale])
     @api.delete_transformation("api_test_transformation") rescue nil
     @api.delete_transformation("api_test_transformation2") rescue nil
     @api.delete_transformation("api_test_transformation3") rescue nil
@@ -44,13 +44,25 @@ describe Cloudinary::Api do
   end
 
   it "should allow listing resources by prefix" do
-    public_ids = @api.resources(:type=>"upload", :prefix=>"api_test")["resources"].map{|resource| resource["public_id"]}
-    public_ids.should include("api_test", "api_test2")
+    resources = @api.resources(:type=>"upload", :prefix=>"api_test", :tags => true, :context => true)["resources"]
+    resources.map{|resource| resource["public_id"]}.should include("api_test", "api_test2")
+    resources.map{|resource| resource["tags"]}.should include(["api_test_tag"])
+    resources.map{|resource| resource["context"]}.should include({"custom" => {"key" => "value"}})
   end
 
   it "should allow listing resources by tag" do
-    resource = @api.resources_by_tag("api_test_tag")["resources"].find{|resource| resource["public_id"] == "api_test"}
-    resource.should_not be_blank
+    resources = @api.resources_by_tag("api_test_tag", :tags => true, :context => true)["resources"]
+    resources.find{|resource| resource["public_id"] == "api_test"}.should_not be_blank
+    resources.map{|resource| resource["tags"]}.should include(["api_test_tag"])
+    resources.map{|resource| resource["context"]}.should include({"custom" => {"key" => "value"}})
+  end
+  
+  it "should allow listing resources by public ids" do
+    resources = @api.resources_by_ids(["api_test", "api_test2"], :tags => true, :context => true)["resources"]
+    resources.length.should == 2
+    resources.find{|resource| resource["public_id"] == "api_test"}.should_not be_blank
+    resources.map{|resource| resource["tags"]}.should include(["api_test_tag"])
+    resources.map{|resource| resource["context"]}.should include({"custom" => {"key" => "value"}})
   end
 
   it "should allow get resource metadata" do

data/spec/uploader_spec.rb

@@ -75,4 +75,36 @@ describe Cloudinary::Uploader do
     result = Cloudinary::Uploader.upload("spec/logo.png", use_filename: true, unique_filename: false)
     result["public_id"].should  == "logo"
   end
+  
+  it "should allow whitelisted formats if allowed_formats", :allowed=>true do
+    result = Cloudinary::Uploader.upload("spec/logo.png", allowed_formats: ["png"])
+    result["format"].should == "png"
+  end
+  
+  it "should prevent non whitelisted formats from being uploaded if allowed_formats is specified", :allowed=>true do
+    lambda{Cloudinary::Uploader.upload("spec/logo.png", allowed_formats: ["jpg"])}.should raise_error
+  end
+  
+  it "should allow non whitelisted formats if type is specified and convert to that type", :allowed=>true do
+    result = Cloudinary::Uploader.upload("spec/logo.png", allowed_formats: ["jpg"], format: "jpg")
+    result["format"].should == "jpg"
+  end
+  
+  it "should allow sending face coordinates" do
+    coordinates = [[120, 30, 109, 150], [121, 31, 110, 151]]
+    result = Cloudinary::Uploader.upload("spec/logo.png", {face_coordinates: coordinates, faces: true})
+    result["faces"].should == coordinates
+
+    different_coordinates = [[122, 32, 111, 152]]
+    Cloudinary::Uploader.explicit(result["public_id"], {face_coordinates: different_coordinates, faces: true, type: "upload"})
+    info = Cloudinary::Api.resource(result["public_id"], {faces: true})
+    info["faces"].should == different_coordinates
+  end
+  
+  it "should allow sending context" do
+    context = {"caption" => "some caption", "alt" => "alternative"}
+    result = Cloudinary::Uploader.upload("spec/logo.png", {:context => context})
+    info = Cloudinary::Api.resource(result["public_id"], {:context => true})
+    info["context"].should == {"custom" => context}
+  end
 end

data/spec/utils_spec.rb

@@ -12,7 +12,7 @@ describe Cloudinary::Utils do
       config.cname = nil
       config.cdn_subdomain = false
       config.api_key = "1234"
-      config.api_secret = "1234"
+      config.api_secret = "b"
     end
   end
   
@@ -439,4 +439,25 @@ describe Cloudinary::Utils do
       Cloudinary::Utils.cloudinary_url(source).should == "http://res.cloudinary.com/test123/image/upload/#{target}"   
     end      
   end
+  
+  it "should correctly sign URLs", :signed => true do
+    options = {version: 1234, transformation: {crop: "crop", width: 10, height: 20}, sign_url: true}
+    expected = "http://res.cloudinary.com/test123/image/upload/s--MaRXzoEC--/c_crop,h_20,w_10/v1234/image.jpg"
+    actual = Cloudinary::Utils.cloudinary_url("image.jpg", options)
+    actual.should == expected
+    
+    options = {version: 1234, sign_url: true}
+    expected = "http://res.cloudinary.com/test123/image/upload/s--ZlgFLQcO--/v1234/image.jpg"
+    actual = Cloudinary::Utils.cloudinary_url("image.jpg", options)
+    actual.should == expected
+    
+    options = {transformation: {crop: "crop", width: 10, height: 20}, sign_url: true}
+    expected = "http://res.cloudinary.com/test123/image/upload/s--Ai4Znfl3--/c_crop,h_20,w_10/image.jpg"
+    actual = Cloudinary::Utils.cloudinary_url("image.jpg", options)
+    actual.should == expected
+    
+    expected = "http://res.cloudinary.com/test123/image/fetch/s--_GAUclyB--/v1234/http://google.com/path/to/image.png"
+    actual = Cloudinary::Utils.cloudinary_url("http://google.com/path/to/image.png", type: "fetch", version: 1234, sign_url: true)
+    actual.should == expected    
+  end
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: cloudinary
 version: !ruby/object:Gem::Version
-  version: 1.0.66
+  version: 1.0.67
+  prerelease: 
 platform: ruby
 authors:
 - Nadav Soferman
@@ -10,46 +11,52 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2014-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  name: rest-client
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: aws_cf_signer
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  name: aws_cf_signer
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  name: rspec
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -114,26 +121,27 @@ files:
 homepage: http://cloudinary.com
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: cloudinary
-rubygems_version: 2.0.6
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Client library for easily using the Cloudinary service
 test_files:
 - spec/api_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjljOWM1ZTk5ODJmZDAyMzc3Y2Y0MGU0OGY0NTE5NTI5N2FkZjA3OA==
-  data.tar.gz: !binary |-
-    MmFiZjlmNzJjMDQwZDI4YzUzZmJkZjA0NjRjMzk0MzI2YzVhNDk1Yw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MWNkY2Y0MzQ1YjljZWM4OTYwZjkxNWY0ZGI1OWRmNjAwOWZlZjRkZTgxOGFm
-    NmI3YjVhMDJlM2Y2MGJmYjk0NmFiNjVkMmI2NzkxNjM3NmViNTdkM2ZhNDc2
-    MTE5MzQ1MjM0ZTY5OGJiMmU0NDliYzBhNDI4N2I0YTY2ZDNmMTM=
-  data.tar.gz: !binary |-
-    ZTk2ZGUwMTA5MjYyZmFkMWEzZmIzMTQ4NTQ5MjdhMzliMjk5YmQzNzNhZDhh
-    NTBiNGM0MDcyZWVhOGMzODk5NDQ2ZTcxMWI3MTFlMDkzZDkyNTYzOGM5NDI5
-    Yzc4Yjc1MmQ0ZGUxMTcwNDViNjI0ZmUyMTk4NTM2Njg0NDMyMjA=