cloudinary 1.4.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 7a96fb520a45441c0cc40d980dc03836c6b7ffc4
-  data.tar.gz: 29924a2fa48916d03132b9bf6a080749471b558d
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2E1MWI3ZmRiNDA2YWE2ZTA0OTYzZDUyZmIxMmNjYWJhMjFhNzVmNA==
+  data.tar.gz: !binary |-
+    NjUzMWYwOGVkNTU0ZmE3ZDIyZjJjNzM1MGE5YWM4ZWRhYWY2OGQyYg==
 SHA512:
-  metadata.gz: 86b21f0e18c8759c79162d2b8f2cde2f1fd8807eae924c4fa6906f698f4a92e518763328a91dc36022c62edbf8772bad6b5f3885b41e4457831d1f11dcdd0d56
-  data.tar.gz: 94b7b4a747cb5bab25112cf0ac2041df8fa48009efbbc7f5719fe2df809ea3ae0d0f823928a3b0c6862839f4f3124db8ab3f0e6b2f2de52500d168570d118cb4
+  metadata.gz: !binary |-
+    NDFjMjgyNTE1MTkxODkxZjcyN2VmOGU3ODZiMWU2NjAyMWNiODc2YjJiMGMz
+    YzkxOTYyZjRkOTU4MmM2MGMxNThmMDQ3NThiMWUxOTFmZGE0OTBkNjJkYTlk
+    ZWI1MDdhOGVjMzUyZmE2NzMzMWQ3M2U0MTFmZWY5NmYxNDJjNWY=
+  data.tar.gz: !binary |-
+    ZDEzODU4YWJhOGExNmQxZjY2NGI5OTZkMjk1NmFiMGY1YWFiZTdkODcwZWIw
+    MmM5NGQ5OWIzZGJmNjBhZmE1OGViZmFhZGMzOGJmNTU4M2M2ZTAzM2FkNTlk
+    ZDMxNDA1MDNmOGE4ODk5M2Y5MDkyZDRhOTI4NTNlOGVhYmRjZWI=

data/CHANGELOG.md

@@ -1,4 +1,35 @@
 
+1.5.2 / 2017-02-22
+==================
+
+  * Support URL Authorization token. 
+  * Rename auth_token. 
+  * Support nested keys in CLOUDINARY_URL
+  * Support "authenticated" url without a signature.
+  * Add OpenStruct from ruby 2.0.
+  * Add specific rubyzip version for ruby 1.9
+
+1.5.1 / 2017-02-13
+==================
+  * Fix Carrierwave 1.0.0 integration: broken `remote_image_url`
+
+1.5.0 / 2017-02-07
+==================
+
+New functionality and features
+------------------------------
+
+  * Access mode API
+
+Other Changes
+-------------
+
+  * Fix transformation related tests.
+  * Fix archive test to use `include` instead of `match_array`.
+  * Fix "missing folder" test
+  * Add specific dependency on nokogiri
+  * Update rspec version
+
 1.4.0 / 2017-01-30
 ==================
 

data/cloudinary.gemspec

@@ -21,23 +21,26 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "aws_cf_signer"
-  s.add_development_dependency "rspec", '>=3.2'
+  s.add_development_dependency "rspec", '>=3.5'
   s.add_development_dependency "rspec-rails"
-  s.add_development_dependency "rubyzip"
 
   if RUBY_VERSION > "2.0"
     s.add_dependency "rest-client"
     s.add_development_dependency "actionpack"
     s.add_development_dependency "simplecov"
-  elsif RUBY_VERSION > "1.9"
+    s.add_development_dependency "rubyzip"
+  elsif RUBY_VERSION >= "1.9"
     s.add_dependency "rest-client", '< 2.0'
     s.add_dependency 'json', '~> 1.8'
     s.add_development_dependency "actionpack", '< 5.0'
     s.add_development_dependency "simplecov"
+    s.add_development_dependency "nokogiri", "<1.7.0"
+    s.add_development_dependency "rubyzip", '<1.2.1'
   else
     s.add_dependency "i18n", "<0.7.0"
     s.add_dependency "rest-client", "<=1.6.8"
     s.add_development_dependency "actionpack", "~>3.2.0"
+    s.add_development_dependency "nokogiri", "<1.6.0"
   end
 
 end

data/lib/cloudinary.rb

@@ -1,5 +1,10 @@
 # Copyright Cloudinary
-require "ostruct"
+if RUBY_VERSION > "2"
+  require "ostruct"
+else
+  require "cloudinary/ostruct2"
+end
+
 require "pathname"
 require "yaml"
 require "uri"
@@ -15,15 +20,15 @@ module Cloudinary
   autoload :Downloader, "cloudinary/downloader"
   autoload :Blob, "cloudinary/blob"
   autoload :PreloadedFile, "cloudinary/preloaded_file"
-  autoload :Static, "cloudinary/static"  
-  autoload :CarrierWave, "cloudinary/carrier_wave"  
-  
-  CF_SHARED_CDN = "d3jpl91pxevbkh.cloudfront.net"
-  AKAMAI_SHARED_CDN = "res.cloudinary.com"
+  autoload :Static, "cloudinary/static"
+  autoload :CarrierWave, "cloudinary/carrier_wave"
+
+  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
-  
-  USER_AGENT = "CloudinaryRuby/" + VERSION
+  SHARED_CDN            = AKAMAI_SHARED_CDN
+
+  USER_AGENT      = "CloudinaryRuby/" + VERSION
   @@user_platform = ""
 
   # Add platform information to the USER_AGENT header
@@ -46,27 +51,27 @@ module Cloudinary
 
   FORMAT_ALIASES = {
     "jpeg" => "jpg",
-    "jpe" => "jpg",
-    "tif" => "tiff",
-    "ps" => "eps",
-    "ept" => "eps"
+    "jpe"  => "jpg",
+    "tif"  => "tiff",
+    "ps"   => "eps",
+    "ept"  => "eps"
   }
-  
+
   @@config = nil
-  
+
   def self.config(new_config=nil)
     first_time = @@config.nil?
-    @@config ||= OpenStruct.new((YAML.load(ERB.new(IO.read(config_dir.join("cloudinary.yml"))).result)[config_env] rescue {}))
-        
+    @@config   ||= OpenStruct.new((YAML.load(ERB.new(IO.read(config_dir.join("cloudinary.yml"))).result)[config_env] rescue {}))
+
     # Heroku support
     if first_time && ENV["CLOUDINARY_CLOUD_NAME"]
       set_config(
-        "cloud_name" => ENV["CLOUDINARY_CLOUD_NAME"],
-        "api_key" => ENV["CLOUDINARY_API_KEY"],
-        "api_secret" => ENV["CLOUDINARY_API_SECRET"],
+        "cloud_name"          => ENV["CLOUDINARY_CLOUD_NAME"],
+        "api_key"             => ENV["CLOUDINARY_API_KEY"],
+        "api_secret"          => ENV["CLOUDINARY_API_SECRET"],
         "secure_distribution" => ENV["CLOUDINARY_SECURE_DISTRIBUTION"],
-        "private_cdn" => ENV["CLOUDINARY_PRIVATE_CDN"].to_s == 'true',
-        "secure" => ENV["CLOUDINARY_SECURE"].to_s == 'true'
+        "private_cdn"         => ENV["CLOUDINARY_PRIVATE_CDN"].to_s == 'true',
+        "secure"              => ENV["CLOUDINARY_SECURE"].to_s == 'true'
       )
     elsif first_time && ENV["CLOUDINARY_URL"]
       config_from_url(ENV["CLOUDINARY_URL"])
@@ -75,26 +80,50 @@ module Cloudinary
     set_config(new_config) if new_config
     yield(@@config) if block_given?
 
-    @@config    
+    @@config
   end
-  
+
   def self.config_from_url(url)
     @@config ||= OpenStruct.new
-    uri = URI.parse(url)
+    uri      = URI.parse(url)
     set_config(
-      "cloud_name" => uri.host,
-      "api_key" => uri.user,
-      "api_secret" => uri.password,
-      "private_cdn" => !uri.path.blank?,
+      "cloud_name"          => uri.host,
+      "api_key"             => uri.user,
+      "api_secret"          => uri.password,
+      "private_cdn"         => !uri.path.blank?,
       "secure_distribution" => uri.path[1..-1]
     )
     uri.query.to_s.split("&").each do
-      |param|
+    |param|
       key, value = param.split("=")
-      set_config(key=>URI.decode(value))
-    end    
+      if isNestedKey? key
+        putNestedKey key, value
+      else
+        set_config(key => URI.decode(value))
+      end
+    end
   end
-  
+
+  def self.putNestedKey(key, value)
+    chain   = key.split(/[\[\]]+/).reject { |i| i.empty? }
+    outer   = @@config
+    lastKey = chain.pop()
+    chain.each do |innerKey|
+      inner = outer[innerKey]
+      if inner.nil?
+        inner           = OpenStruct.new
+        outer[innerKey] = inner
+      end
+      outer = inner
+    end
+    outer[lastKey] = value
+  end
+
+
+  def self.isNestedKey?(key)
+    /\w+\[\w+\]/ =~ key
+  end
+
   def self.app_root
     if defined? Rails::root
       # Rails 2.2 return String for Rails.root
@@ -121,10 +150,9 @@ module Cloudinary
     new_config.each{|k,v| @@config.send(:"#{k}=", v) if !v.nil?}
   end
 end
-
-# Prevent require loop if included after Rails is already initialized.
-require "cloudinary/helper" if defined?(::ActionView::Base)
-require "cloudinary/controller" if defined?(::ActionController::Base)
-require "cloudinary/railtie" if defined?(Rails) && defined?(Rails::Railtie)
-require "cloudinary/engine" if defined?(Rails) && defined?(Rails::Engine)
+  # Prevent require loop if included after Rails is already initialized.
+  require "cloudinary/helper" if defined?(::ActionView::Base)
+  require "cloudinary/controller" if defined?(::ActionController::Base)
+  require "cloudinary/railtie" if defined?(Rails) && defined?(Rails::Railtie)
+  require "cloudinary/engine" if defined?(Rails) && defined?(Rails::Engine)
 

data/lib/cloudinary/api.rb

@@ -267,6 +267,42 @@ class Cloudinary::Api
     call_api(:put, "streaming_profiles/#{name}", params, options)
   end
 
+  # Update resources access mode. Resources are selected by the prefix
+  # @param [String] access_mode the access mode to set the resources to
+  # @param [String] prefix The prefix by which to filter applicable resources
+  # @param [Object] options    additional options
+  # @option options [String] :resource_type ("image") the type of resources to modify
+  # @option options [Fixnum] :max_results (nil) the maximum resources to process in a single invocation
+  # @option options [String] :next_cursor (nil) provided by a previous call to the method
+  def self.update_resources_access_mode_by_prefix(access_mode, prefix, options = {})
+
+      update_resources_access_mode(access_mode, :prefix, prefix, options)
+  end
+
+  # Update resources access mode. Resources are selected by the tag
+  # @param [String] access_mode the access mode to set the resources to
+  # @param [String] tag the tag by which to filter applicable resources
+  # @param [Object] options    additional options
+  # @option options [String] :resource_type ("image") the type of resources to modify
+  # @option options [Fixnum] :max_results (nil) the maximum resources to process in a single invocation
+  # @option options [String] :next_cursor (nil) provided by a previous call to the method
+  def self.update_resources_access_mode_by_tag(access_mode, tag, options = {})
+
+      update_resources_access_mode(access_mode, :tag, tag, options)
+  end
+
+  # Update resources access mode. Resources are selected by the provided public_ids
+  # @param [String] access_mode the access mode to set the resources to
+  # @param [Array<String>] public_ids The prefix by which to filter applicable resources
+  # @param [Object] options    additional options
+  # @option options [String] :resource_type ("image") the type of resources to modify
+  # @option options [Fixnum] :max_results (nil) the maximum resources to process in a single invocation
+  # @option options [String] :next_cursor (nil) provided by a previous call to the method
+  def self.update_resources_access_mode_by_ids(access_mode, public_ids, options = {})
+
+      update_resources_access_mode(access_mode, :public_ids, public_ids, options)
+  end
+
   protected
 
   def self.call_api(method, uri, params, options)
@@ -320,4 +356,14 @@ class Cloudinary::Api
   def self.transformation_string(transformation)
     transformation.is_a?(String) ? transformation : Cloudinary::Utils.generate_transformation_string(transformation.clone)
   end
+
+  def self.update_resources_access_mode(access_mode, by_key, value, options = {})
+    resource_type = options[:resource_type] || "image"
+    type = options[:type] || "upload"
+    params = only(options, :next_cursor)
+    params[:access_mode] = access_mode
+    params[by_key] = value
+    call_api("post", "resources/#{resource_type}/#{type}/update_access_mode", params, options)
+  end
+
 end

data/lib/cloudinary/auth_token.rb

@@ -0,0 +1,68 @@
+require 'openssl'
+if RUBY_VERSION > "2"
+  require "ostruct"
+else
+  require "cloudinary/ostruct2"
+end
+
+
+module Cloudinary
+  module AuthToken
+    SEPARATOR = '~'
+
+    def self.generate(options = {})
+      key = options[:key]
+      raise "Missing auth token key configuration" unless key
+      name = options[:token_name] || "__cld_token__"
+      start = options[:start_time]
+      expiration = options[:expiration]
+      ip = options[:ip]
+      acl = options[:acl]
+      duration = options[:duration]
+      url = options[:url]
+      start = Time.new.getgm.to_i if start == 'now'
+      if expiration.nil? || expiration == 0
+        if !(duration.nil? || duration == 0)
+          expiration = (start || Time.new.getgm.to_i) + duration
+        else
+          raise 'Must provide either expiration or duration'
+        end
+      end
+
+      token = []
+      token << "ip=#{ip}" if ip
+      token << "st=#{start}" if start
+      token << "exp=#{expiration}"
+      token << "acl=#{escape_to_lower(acl)}" if acl
+      to_sign = token.clone
+      to_sign << "url=#{escape_to_lower(url)}" if url
+      auth = digest(to_sign.join(SEPARATOR), key)
+      token << "hmac=#{auth}"
+      "#{name}=#{token.join(SEPARATOR)}"
+    end
+
+
+    # Merge token2 to token1 returning a new
+    # Requires to support Ruby 1.9
+    def self.merge_auth_token(token1, token2)
+      token1 = token1 || {}
+      token2 = token2 || {}
+      token1 = token1.respond_to?( :to_h) ? token1.to_h : token1
+      token2 = token2.respond_to?( :to_h) ? token2.to_h : token2
+      token1.merge(token2)
+    end
+
+    private
+
+    # escape URI pattern using lowercase hex. For example "/" -> "%2f".
+    def self.escape_to_lower(url)
+      CGI::escape(url).gsub(/%../) { |h| h.downcase }
+    end
+
+    def self.digest(message, key)
+      bin_key = Array(key).pack("H*")
+      digest = OpenSSL::Digest::SHA256.new
+      OpenSSL::HMAC.hexdigest(digest, bin_key, message)
+    end
+  end
+end

data/lib/cloudinary/carrier_wave/remote.rb

@@ -1,5 +1,5 @@
 module Cloudinary::CarrierWave
-  def download!(uri)
+  def download!(uri, *args)
     return super if !self.cloudinary_should_handle_remote?
     if respond_to?(:process_uri)
       uri = process_uri(uri)
@@ -17,9 +17,9 @@ module Cloudinary::CarrierWave
       @uri = uri
       @original_filename = filename
     end
-    
+
     def delete
       # Do nothing. This is a virtual file.
     end
   end
-end  
+end

data/lib/cloudinary/ostruct2.rb

@@ -0,0 +1,284 @@
+#
+# = ostruct.rb: OpenStruct implementation
+#
+# Author:: Yukihiro Matsumoto
+# Documentation:: Gavin Sinclair
+#
+# OpenStruct allows the creation of data objects with arbitrary attributes.
+# See OpenStruct for an example.
+#
+
+#
+# An OpenStruct is a data structure, similar to a Hash, that allows the
+# definition of arbitrary attributes with their accompanying values. This is
+# accomplished by using Ruby's metaprogramming to define methods on the class
+# itself.
+#
+# == Examples:
+#
+#   require 'ostruct'
+#
+#   person = OpenStruct.new
+#   person.name    = "John Smith"
+#   person.age     = 70
+#   person.pension = 300
+#
+#   puts person.name     # -> "John Smith"
+#   puts person.age      # -> 70
+#   puts person.address  # -> nil
+#
+# An OpenStruct employs a Hash internally to store the methods and values and
+# can even be initialized with one:
+#
+#   australia = OpenStruct.new(:country => "Australia", :population => 20_000_000)
+#   p australia   # -> <OpenStruct country="Australia" population=20000000>
+#
+# Hash keys with spaces or characters that would normally not be able to use for
+# method calls (e.g. ()[]*) will not be immediately available on the
+# OpenStruct object as a method for retrieval or assignment, but can be still be
+# reached through the Object#send method.
+#
+#   measurements = OpenStruct.new("length (in inches)" => 24)
+#   measurements.send("length (in inches)")  # -> 24
+#
+#   data_point = OpenStruct.new(:queued? => true)
+#   data_point.queued?                       # -> true
+#   data_point.send("queued?=",false)
+#   data_point.queued?                       # -> false
+#
+# Removing the presence of a method requires the execution the delete_field
+# method as setting the property value to +nil+ will not remove the method.
+#
+#   first_pet = OpenStruct.new(:name => 'Rowdy', :owner => 'John Smith')
+#   first_pet.owner = nil
+#   second_pet = OpenStruct.new(:name => 'Rowdy')
+#
+#   first_pet == second_pet   # -> false
+#
+#   first_pet.delete_field(:owner)
+#   first_pet == second_pet   # -> true
+#
+#
+# == Implementation:
+#
+# An OpenStruct utilizes Ruby's method lookup structure to and find and define
+# the necessary methods for properties. This is accomplished through the method
+# method_missing and define_method.
+#
+# This should be a consideration if there is a concern about the performance of
+# the objects that are created, as there is much more overhead in the setting
+# of these properties compared to using a Hash or a Struct.
+#
+class OpenStruct
+  #
+  # Creates a new OpenStruct object.  By default, the resulting OpenStruct
+  # object will have no attributes.
+  #
+  # The optional +hash+, if given, will generate attributes and values
+  # (can be a Hash, an OpenStruct or a Struct).
+  # For example:
+  #
+  #   require 'ostruct'
+  #   hash = { "country" => "Australia", :population => 20_000_000 }
+  #   data = OpenStruct.new(hash)
+  #
+  #   p data        # -> <OpenStruct country="Australia" population=20000000>
+  #
+  def initialize(hash=nil)
+    @table = {}
+    if hash
+      hash.each_pair do |k, v|
+        k = k.to_sym
+        @table[k] = v
+        new_ostruct_member(k)
+      end
+    end
+  end
+
+  # Duplicate an OpenStruct object members.
+  def initialize_copy(orig)
+    super
+    @table = @table.dup
+    @table.each_key{|key| new_ostruct_member(key)}
+  end
+
+  #
+  # Converts the OpenStruct to a hash with keys representing
+  # each attribute (as symbols) and their corresponding values
+  # Example:
+  #
+  #   require 'ostruct'
+  #   data = OpenStruct.new("country" => "Australia", :population => 20_000_000)
+  #   data.to_h   # => {:country => "Australia", :population => 20000000 }
+  #
+  def to_h
+    @table.dup
+  end
+
+  #
+  # Yields all attributes (as a symbol) along with the corresponding values
+  # or returns an enumerator if not block is given.
+  # Example:
+  #
+  #   require 'ostruct'
+  #   data = OpenStruct.new("country" => "Australia", :population => 20_000_000)
+  #   data.each_pair.to_a  # => [[:country, "Australia"], [:population, 20000000]]
+  #
+  def each_pair
+    return to_enum __method__ unless block_given?
+    @table.each_pair{|p| yield p}
+  end
+
+  #
+  # Provides marshalling support for use by the Marshal library.
+  #
+  def marshal_dump
+    @table
+  end
+
+  #
+  # Provides marshalling support for use by the Marshal library.
+  #
+  def marshal_load(x)
+    @table = x
+    @table.each_key{|key| new_ostruct_member(key)}
+  end
+
+  #
+  # Used internally to check if the OpenStruct is able to be
+  # modified before granting access to the internal Hash table to be modified.
+  #
+  def modifiable
+    begin
+      @modifiable = true
+    rescue
+      raise TypeError, "can't modify frozen #{self.class}", caller(3)
+    end
+    @table
+  end
+  protected :modifiable
+
+  #
+  # Used internally to defined properties on the
+  # OpenStruct. It does this by using the metaprogramming function
+  # define_singleton_method for both the getter method and the setter method.
+  #
+  def new_ostruct_member(name)
+    name = name.to_sym
+    unless respond_to?(name)
+      define_singleton_method(name) { @table[name] }
+      define_singleton_method("#{name}=") { |x| modifiable[name] = x }
+    end
+    name
+  end
+  protected :new_ostruct_member
+
+  def method_missing(mid, *args) # :nodoc:
+    mname = mid.id2name
+    len = args.length
+    if mname.chomp!('=')
+      if len != 1
+        raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1)
+      end
+      modifiable[new_ostruct_member(mname)] = args[0]
+    elsif len == 0
+      @table[mid]
+    else
+      raise NoMethodError, "undefined method `#{mid}' for #{self}", caller(1)
+    end
+  end
+
+  # Returns the value of a member.
+  #
+  #   person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
+  #   person[:age] # => 70, same as ostruct.age
+  #
+  def [](name)
+    @table[name.to_sym]
+  end
+
+  #
+  # Sets the value of a member.
+  #
+  #   person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
+  #   person[:age] = 42 # => equivalent to ostruct.age = 42
+  #   person.age # => 42
+  #
+  def []=(name, value)
+    modifiable[new_ostruct_member(name)] = value
+  end
+
+  #
+  # Remove the named field from the object. Returns the value that the field
+  # contained if it was defined.
+  #
+  #   require 'ostruct'
+  #
+  #   person = OpenStruct.new('name' => 'John Smith', 'age' => 70)
+  #
+  #   person.delete_field('name')  # => 'John Smith'
+  #
+  def delete_field(name)
+    sym = name.to_sym
+    singleton_class.__send__(:remove_method, sym, "#{name}=")
+    @table.delete sym
+  end
+
+  InspectKey = :__inspect_key__ # :nodoc:
+
+  #
+  # Returns a string containing a detailed summary of the keys and values.
+  #
+  def inspect
+    str = "#<#{self.class}"
+
+    ids = (Thread.current[InspectKey] ||= [])
+    if ids.include?(object_id)
+      return str << ' ...>'
+    end
+
+    ids << object_id
+    begin
+      first = true
+      for k,v in @table
+        str << "," unless first
+        first = false
+        str << " #{k}=#{v.inspect}"
+      end
+      return str << '>'
+    ensure
+      ids.pop
+    end
+  end
+  alias :to_s :inspect
+
+  attr_reader :table # :nodoc:
+  protected :table
+
+  #
+  # Compares this object and +other+ for equality.  An OpenStruct is equal to
+  # +other+ when +other+ is an OpenStruct and the two objects' Hash tables are
+  # equal.
+  #
+  def ==(other)
+    return false unless other.kind_of?(OpenStruct)
+    @table == other.table
+  end
+
+  #
+  # Compares this object and +other+ for equality.  An OpenStruct is eql? to
+  # +other+ when +other+ is an OpenStruct and the two objects' Hash tables are
+  # eql?.
+  #
+  def eql?(other)
+    return false unless other.kind_of?(OpenStruct)
+    @table.eql?(other.table)
+  end
+
+  # Compute a hash-code for this OpenStruct.
+  # Two hashes with the same content will have the same hash code
+  # (and will be eql?).
+  def hash
+    @table.hash
+  end
+end