cloudinary 1.0.32 → 1.0.33

data/cloudinary.gemspec

@@ -19,5 +19,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.add_dependency "rest-client"
+  s.add_dependency "aws_cf_signer"
   s.add_development_dependency "rspec"
 end

data/lib/cloudinary.rb

@@ -6,6 +6,7 @@ require "uri"
 require "cloudinary/version"
 require "cloudinary/utils"
 require "cloudinary/uploader"
+require "cloudinary/api"
 require "cloudinary/downloader"
 require "cloudinary/blob" 
 require "cloudinary/static"
@@ -41,6 +42,11 @@ module Cloudinary
         "private_cdn" => !uri.path.blank?,
         "secure_distribution" => uri.path[1..-1]
       )
+      uri.query.to_s.split("&").each do
+        |param|
+        key, value = param.split("=")
+        set_config(key=>URI.decode(value))
+      end
     end
 
     set_config(new_config) if new_config

data/lib/cloudinary/api.rb

@@ -0,0 +1,140 @@
+class Cloudinary::Api
+  class Error < StandardError; end
+  class NotFound < Error; end
+  class NotAllowed < Error; end
+  class AlreadyExists < Error; end
+  class RateLimited < Error; end
+  class BadRequest < Error; end
+  class GeneralError < Error; end
+  class AuthorizationRequired < Error; end 
+  class Response < Hash
+    attr_reader :rate_limit_reset_at, :rate_limit_remaining, :rate_limit_allowed
+    def initialize(response)
+      self.update(Cloudinary::Api.send(:parse_json_response, response))
+      @rate_limit_allowed = response.headers[:x_featureratelimit_limit].to_i
+      @rate_limit_reset_at = Time.parse(response.headers[:x_featureratelimit_reset])
+      @rate_limit_remaining = response.headers[:x_featureratelimit_remaining].to_i     
+    end
+  end
+  
+  
+  def self.resource_types(options={})
+    call_api(:get, "resources", {}, options)
+  end
+
+  def self.resources(options={})
+    resource_type = options[:resource_type] || "image"
+    type = options[:type]
+    uri = "resources/#{resource_type}"
+    uri += "/#{type}" if !type.blank?
+    call_api(:get, uri, only(options, :next_cursor, :max_results, :prefix), 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), options)    
+  end
+  
+  def self.resource(public_id, options={})
+    resource_type = options[:resource_type] || "image"
+    type = options[:type] || "upload"
+    uri = "resources/#{resource_type}/#{type}/#{public_id}"
+    call_api(:get, uri, {}, options)      
+  end
+  
+  def self.delete_resources(public_ids, options={})
+    resource_type = options[:resource_type] || "image"
+    type = options[:type] || "upload"    
+    uri = "resources/#{resource_type}/#{type}"
+    call_api(:delete, uri, {:public_ids=>public_ids}, options)      
+  end
+
+  def self.delete_resources_by_prefix(type, prefix, options={})
+    resource_type = options[:resource_type] || "image"
+    uri = "resources/#{resource_type}/#{type}"
+    call_api(:delete, uri, {:prefix=>prefix}, options)      
+  end
+  
+  def self.delete_derived_resources(derived_resource_ids, options={})
+    uri = "derived_resources"
+    call_api(:delete, uri, {:derived_resource_ids=>derived_resource_ids}, options)      
+  end
+
+  def self.tags(options={})
+    resource_type = options[:resource_type] || "image"
+    uri = "tags/#{resource_type}"
+    call_api(:get, uri, only(options, :next_cursor, :max_results, :prefix), options)    
+  end
+  
+  def self.transformations(options={})
+    call_api(:get, "transformations", only(options, :next_cursor, :max_results), options)    
+  end
+
+  def self.transformation(transformation, options={})
+    call_api(:get, "transformations/#{transformation_string(transformation)}", only(options, :max_results), options)    
+  end
+  
+  def self.delete_transformation(transformation, options={})
+    call_api(:delete, "transformations/#{transformation_string(transformation)}", {}, options)    
+  end
+  
+  # updates - currently only supported update is the "allowed_for_strict" boolean flag
+  def self.update_transformation(transformation, updates, options={})
+    call_api(:put, "transformations/#{transformation_string(transformation)}", only(updates, :allowed_for_strict), options)
+  end
+  
+  def self.create_transformation(name, definition, options={})
+    call_api(:post, "transformations/#{name}", {:transformation=>transformation_string(definition)}, options)
+  end
+  
+  protected
+  
+  def self.call_api(method, uri, params, options)
+    cloudinary = options[:upload_prefix] || Cloudinary.config.upload_prefix || "https://api.cloudinary.com"
+    cloud_name = options[:cloud_name] || Cloudinary.config.cloud_name || raise("Must supply cloud_name")
+    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")
+    api_url = [cloudinary, "v1_1", cloud_name, uri].join("/")
+    # 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
+      |response, request, tmpresult|
+      return Response.new(response) if response.code == 200
+      exception_class = case response.code
+        when 400 then BadRequest
+        when 401 then AuthorizationRequired
+        when 403 then NotAllowed
+        when 404 then NotFound
+        when 409 then AlreadyExists
+        when 420 then RateLimited
+        when 500 then GeneralError
+        else raise GeneralError.new("Server returned unexpected status code - #{response.code} - #{response.body}")   
+      end
+      json = parse_json_response(response)
+      raise exception_class.new(json["error"]["message"])
+    end    
+  end
+  
+  def self.parse_json_response(response)
+    return Cloudinary::Utils.json_decode(response.body)
+  rescue => e
+    # Error is parsing json
+    raise GeneralError.new("Error parsing server response (#{response.code}) - #{response.body}. Got - #{e}")
+  end
+  
+  def self.only(hash, *keys)
+    result = {}
+    keys.each do
+      |key| 
+      result[key] = hash[key] if hash.include?(key)
+      result[key] = hash[key.to_s] if hash.include?(key.to_s)
+    end
+    result
+  end  
+  
+  def self.transformation_string(transformation)
+    transformation = transformation.is_a?(String) ? transformation : Cloudinary::Utils.generate_transformation_string(transformation.clone)
+  end
+end

data/lib/cloudinary/helper.rb

@@ -154,6 +154,10 @@ module CloudinaryHelper
   def cl_zip_download_url(tag, options = {})
     Cloudinary::Utils.zip_download_url(tag, options)
   end
+
+  def cl_signed_download_url(public_id, options = {})
+    Cloudinary::Utils.signed_download_url(public_id, options)
+  end
   
   def self.included(base)
     ActionView::Helpers::FormBuilder.send(:include, Cloudinary::FormBuilder)

data/lib/cloudinary/utils.rb

@@ -1,12 +1,21 @@
 # Copyright Cloudinary
 require 'digest/sha1'
 require 'zlib'
+require 'aws_cf_signer'
 
 class Cloudinary::Utils
   SHARED_CDN = "d3jpl91pxevbkh.cloudfront.net"
   
   # Warning: options are being destructively updated!
   def self.generate_transformation_string(options={})
+    if options.is_a?(Array)
+      return options.map{|base_transformation| generate_transformation_string(base_transformation.clone)}.join("/")
+    end
+    # Symbolize keys
+    options.keys.each do |key|
+      options[key.to_sym] = options.delete(key) if key.is_a?(String)
+    end
+    
     size = options.delete(:size)
     options[:width], options[:height] = size.split("x") if size    
     width = options[:width]
@@ -35,10 +44,12 @@ class Cloudinary::Utils
     
     effect = options.delete(:effect)
     effect = Array(effect).flatten.join(":") if effect.is_a?(Array) || effect.is_a?(Hash)
+    
+    angle = build_array(options.delete(:angle)).join(".")
 
-    params = {:w=>width, :h=>height, :t=>named_transformation, :c=>crop, :b=>background, :e=>effect}
+    params = {:w=>width, :h=>height, :t=>named_transformation, :c=>crop, :b=>background, :e=>effect, :a=>angle}
     { :x=>:x, :y=>:y, :r=>:radius, :d=>:default_image, :g=>:gravity, :q=>:quality, 
-      :p=>:prefix, :a=>:angle, :l=>:overlay, :u=>:underlay, :f=>:fetch_format, :dn=>:density, :pg=>:page 
+      :p=>:prefix, :l=>:overlay, :u=>:underlay, :f=>:fetch_format, :dn=>:density, :pg=>:page 
     }.each do
       |param, option|
       params[param] = options.delete(option)
@@ -144,7 +155,7 @@ class Cloudinary::Utils
   def self.private_download_url(public_id, format, options = {})
     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")
-    cloudinary_params = {:timestamp=>Time.now.to_i, :public_id=>public_id, :format=>format}.reject{|k, v| v.blank?}
+    cloudinary_params = {:timestamp=>Time.now.to_i, :public_id=>public_id, :format=>format, :type=>options[:type]}.reject{|k, v| v.blank?}
     cloudinary_params[:signature] = Cloudinary::Utils.api_sign_request(cloudinary_params, api_secret)
     cloudinary_params[:api_key] = api_key
     return Cloudinary::Utils.cloudinary_api_url("download", options) + "?" + cloudinary_params.to_query 
@@ -159,7 +170,17 @@ class Cloudinary::Utils
     return Cloudinary::Utils.cloudinary_api_url("download_tag.zip", options) + "?" + cloudinary_params.to_query 
   end
 
-
+  def self.signed_download_url(public_id, options = {})
+    aws_private_key_path = options[:aws_private_key_path] || Cloudinary.config.aws_private_key_path || raise("Must supply aws_private_key_path")
+    aws_key_pair_id = options[:aws_key_pair_id] || Cloudinary.config.aws_key_pair_id || raise("Must supply aws_key_pair_id")
+    authenticated_distribution = options[:authenticated_distribution] || Cloudinary.config.authenticated_distribution || raise("Must supply authenticated_distribution")
+    @signers ||= Hash.new{|h,k| path, id = k; h[k] = AwsCfSigner.new(path, id)}
+    signer = @signers[[aws_private_key_path, aws_key_pair_id]]
+    url = Cloudinary::Utils.cloudinary_url(public_id, options.merge(:secure=>true, :secure_distribution=>authenticated_distribution, :private_cdn=>true))
+    expires_at = options[:expires_at] || (Time.now+3600)
+    signer.sign(url, :ending => expires_at)
+  end
+  
   def self.asset_file_name(path)
     data = Rails.root.join(path).read(:mode=>"rb")
     ext = path.extname

data/lib/cloudinary/version.rb

@@ -1,4 +1,4 @@
 # Copyright Cloudinary
 module Cloudinary
-  VERSION = "1.0.32"
+  VERSION = "1.0.33"
 end

data/spec/api_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+require 'cloudinary'
+
+describe Cloudinary::Api do
+  break puts("Please setup environment for api test to run") if Cloudinary.config.api_secret.blank?
+
+  before(:all) do
+    @api = Cloudinary::Api
+    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])
+    @api.delete_transformation("api_test_transformation") rescue nil
+  end
+  
+  it "should allow listing resource_types" do
+    @api.resource_types()["resource_types"].should include("image")
+  end
+
+  it "should allow listing resources" do
+    resource = @api.resources()["resources"].find{|resource| resource["public_id"] == "api_test"}
+    resource.should_not be_blank
+    resource["type"].should == "upload" 
+  end
+
+  it "should allow listing resources with cursor" do
+    result = @api.resources(:max_results=>1)
+    result["resources"].should_not be_blank
+    result["resources"].length.should == 1
+    result["next_cursor"].should_not be_blank
+    result2 = @api.resources(:max_results=>1, :next_cursor=>result["next_cursor"])
+    result2["resources"].should_not be_blank
+    result2["resources"].length.should == 1
+    result2["resources"][0]["public_id"].should_not == result["resources"][0]["public_id"] 
+  end
+
+
+  it "should allow listing resources by type" do
+    resource = @api.resources(:type=>"upload")["resources"].find{|resource| resource["public_id"] == "api_test"}
+    resource.should_not be_blank
+  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")
+  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
+  end
+
+  it "should allow get resource metadata" do
+    resource = @api.resource("api_test")
+    resource.should_not be_blank
+    resource["public_id"].should == "api_test"
+    resource["bytes"].should == 3381
+    resource["derived"].length.should == 1
+  end
+  
+  it "should allow deleting derived resource" do
+    Cloudinary::Uploader.upload("spec/logo.png", :public_id=>"api_test3", :eager=>[:width=>101,:crop=>:scale])
+    resource = @api.resource("api_test3")
+    resource.should_not be_blank
+    resource["derived"].length.should == 1
+    derived_resource_id = resource["derived"][0]["id"]
+    @api.delete_derived_resources(derived_resource_id)
+    resource = @api.resource("api_test3")
+    resource.should_not be_blank
+    resource["derived"].length.should == 0
+  end
+
+  it "should allow deleting resources" do
+    Cloudinary::Uploader.upload("spec/logo.png", :public_id=>"api_test3")
+    resource = @api.resource("api_test3")
+    resource.should_not be_blank
+    @api.delete_resources(["apit_test", "api_test2", "api_test3"])
+    lambda{@api.resource("api_test3")}.should raise_error(Cloudinary::Api::NotFound)
+  end
+
+  it "should allow listing tags" do
+    tags = @api.tags()["tags"]
+    tags.should include('api_test_tag')
+  end
+
+  it "should allow listing tag by prefix" do
+    tags = @api.tags(:prefix=>"api_test")["tags"]
+    tags.should include('api_test_tag')
+    tags = @api.tags(:prefix=>"api_test_no_such_tag")["tags"]
+    tags.should be_blank
+  end
+  
+  it "should allow listing transformations" do
+    transformation = @api.transformations()["transformations"].find{|transformation| transformation["name"] == "c_scale,w_100"}
+    transformation.should_not be_blank
+    transformation["used"].should == true
+  end
+
+  it "should allow getting transformation metadata" do
+    transformation = @api.transformation("c_scale,w_100")
+    transformation.should_not be_blank  
+    transformation["info"].should == ["crop"=>"scale", "width"=>100]     
+    transformation = @api.transformation("crop"=>"scale", "width"=>100)
+    transformation.should_not be_blank  
+    transformation["info"].should == ["crop"=>"scale", "width"=>100]     
+  end
+  
+  it "should allow updating transformation allowed_for_strict" do
+    @api.update_transformation("c_scale,w_100", :allowed_for_strict=>true)
+    transformation = @api.transformation("c_scale,w_100")
+    transformation.should_not be_blank  
+    transformation["allowed_for_strict"].should == true
+    @api.update_transformation("c_scale,w_100", :allowed_for_strict=>false)
+    transformation = @api.transformation("c_scale,w_100")
+    transformation.should_not be_blank  
+    transformation["allowed_for_strict"].should == false
+  end
+
+  it "should allow creating named transformation" do
+    @api.create_transformation("api_test_transformation", "crop"=>"scale", "width"=>102)
+    transformation = @api.transformation("api_test_transformation")
+    transformation.should_not be_blank  
+    transformation["allowed_for_strict"].should == true
+    transformation["info"].should == ["crop"=>"scale", "width"=>102]
+    transformation["used"].should == false
+  end
+
+  it "should allow deleting named transformation" do
+    @api.create_transformation("api_test_transformation2", "crop"=>"scale", "width"=>103)
+    @api.transformation("api_test_transformation2")
+    @api.delete_transformation("api_test_transformation2")
+    lambda{@api.transformation("api_test_transformation2")}.should raise_error(Cloudinary::Api::NotFound)
+  end  
+
+  it "should allow deleting implicit transformation" do
+    @api.transformation("c_scale,w_100")
+    @api.delete_transformation("c_scale,w_100")
+    lambda{@api.transformation("c_scale,w_100")}.should raise_error(Cloudinary::Api::NotFound)
+  end
+
+end

data/spec/utils_spec.rb

@@ -104,6 +104,12 @@ describe Cloudinary::Utils do
     result.should == "http://res.cloudinary.com/test123/image/upload/c_fill,w_200,x_100,y_100/r_10/c_crop,w_100/test" 
   end
 
+  it "should support array of tranformations" do    
+    options = [{:x=>100, :y=>100, :width=>200, :crop=>:fill}, {:radius=>10}]
+    result = Cloudinary::Utils.generate_transformation_string(options)
+    result.should == "c_fill,w_200,x_100,y_100/r_10" 
+  end
+
   it "should not include empty tranformations" do    
     options = {:transformation=>[{}, {:x=>100, :y=>100, :crop=>:fill}, {}]}
     result = Cloudinary::Utils.cloudinary_url("test", options)
@@ -191,6 +197,11 @@ describe Cloudinary::Utils do
     result = Cloudinary::Utils.cloudinary_url("test", options)
     options.should == {}
     result.should == "http://res.cloudinary.com/test123/image/upload/a_55/test" 
+
+    options = {:angle=>["auto", "55"]}
+    result = Cloudinary::Utils.cloudinary_url("test", options)
+    options.should == {}
+    result.should == "http://res.cloudinary.com/test123/image/upload/a_auto.55/test" 
   end
   
   it "should support format for fetch urls" do
@@ -273,4 +284,12 @@ describe Cloudinary::Utils do
     options.should == {}
     result.should == "http://a2.hello.com/test123/image/upload/test" 
   end
+  
+  it "should support string param" do
+    options = {"effect"=>{"sepia"=>10}}
+    result = Cloudinary::Utils.cloudinary_url("test", options)
+    options.should == {}
+    result.should == "http://res.cloudinary.com/test123/image/upload/e_sepia:10/test" 
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudinary
 version: !ruby/object:Gem::Version
-  version: 1.0.32
+  version: 1.0.33
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
+date: 2012-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -29,6 +29,22 @@ dependencies:
     - - ! '>='
       - !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
+  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
@@ -61,6 +77,7 @@ files:
 - Rakefile
 - cloudinary.gemspec
 - lib/cloudinary.rb
+- lib/cloudinary/api.rb
 - lib/cloudinary/blob.rb
 - lib/cloudinary/carrier_wave.rb
 - lib/cloudinary/carrier_wave/error.rb
@@ -80,6 +97,8 @@ files:
 - lib/cloudinary/utils.rb
 - lib/cloudinary/version.rb
 - lib/tasks/cloudinary.rake
+- spec/api_spec.rb
+- spec/logo.png
 - spec/spec_helper.rb
 - spec/utils_spec.rb
 - vendor/assets/javascripts/cloudinary/index.js
@@ -113,5 +132,7 @@ signing_key:
 specification_version: 3
 summary: Client library for easily using the Cloudinary service
 test_files:
+- spec/api_spec.rb
+- spec/logo.png
 - spec/spec_helper.rb
 - spec/utils_spec.rb