Class: Cloudinary::Uploader

Inherits:
Object show all
Defined in:
lib/cloudinary/uploader.rb

Constant Summary collapse

TEXT_PARAMS =
[:public_id, :font_family, :font_size, :font_color, :text_align, :font_weight, :font_style, :background, :opacity, :text_decoration, :line_spacing]

Class Method Summary collapse

Class Method Details

.add_tag(tag, public_ids = [], options = {}) ⇒ Object

options may include 'exclusive' (boolean) which causes clearing this tag from all other resources


235
236
237
238
239
# File 'lib/cloudinary/uploader.rb', line 235

def self.add_tag(tag, public_ids = [], options = {})
  exclusive = options.delete(:exclusive)
  command = exclusive ? "set_exclusive" : "add"
  return self.call_tags_api(tag, command, public_ids, options)    
end

.build_eager(eager) ⇒ Object


7
8
9
10
11
12
13
14
15
# File 'lib/cloudinary/uploader.rb', line 7

def self.build_eager(eager)
  return nil if eager.nil?
  Cloudinary::Utils.build_array(eager).map do
    |transformation, format|
    transformation = transformation.clone
    format = transformation.delete(:format) || format
    [Cloudinary::Utils.generate_transformation_string(transformation), format].compact.join("/")
  end.join("|")
end

.build_upload_params(options) ⇒ Object


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/cloudinary/uploader.rb', line 17

def self.build_upload_params(options)
  #symbolize keys
  options = options.clone
  options.keys.each{|key| options[key.to_sym] = options.delete(key) if key.is_a?(String)}
  
  params = {:timestamp=>(options[:timestamp] || Time.now.to_i),
            :transformation => Cloudinary::Utils.generate_transformation_string(options.clone),
            :public_id=>options[:public_id],
            :callback=>options[:callback],
            :format=>options[:format],
            :type=>options[:type],
            :backup=>Cloudinary::Utils.as_safe_bool(options[:backup]),
            :faces=>Cloudinary::Utils.as_safe_bool(options[:faces]),
            :exif=>Cloudinary::Utils.as_safe_bool(options[:exif]),
            :colors=>Cloudinary::Utils.as_safe_bool(options[:colors]),
            :image_metadata=>Cloudinary::Utils.as_safe_bool(options[:image_metadata]),
            :invalidate=>Cloudinary::Utils.as_safe_bool(options[:invalidate]),
            :eager=>build_eager(options[:eager]),
            :headers=>build_custom_headers(options[:headers]),
            :use_filename=>Cloudinary::Utils.as_safe_bool(options[:use_filename]),
            :unique_filename=>Cloudinary::Utils.as_safe_bool(options[:unique_filename]),
            :overwrite=>Cloudinary::Utils.as_safe_bool(options[:overwrite]),
            :discard_original_filename=>Cloudinary::Utils.as_safe_bool(options[:discard_original_filename]),
            :notification_url=>options[:notification_url],
            :eager_notification_url=>options[:eager_notification_url],
            :eager_async=>Cloudinary::Utils.as_safe_bool(options[:eager_async]),
            :proxy=>options[:proxy],
            :folder=>options[:folder],
            :allowed_formats =>  Cloudinary::Utils.build_array(options[:allowed_formats]).join(","),
            :tags=>options[:tags] && Cloudinary::Utils.build_array(options[:tags]).join(","),
            :context => Cloudinary::Utils.encode_hash(options[:context]),
            :face_coordinates => Cloudinary::Utils.encode_double_array(options[:face_coordinates]),
            :custom_coordinates => Cloudinary::Utils.encode_double_array(options[:custom_coordinates]),
            :moderation => options[:moderation],
            :raw_convert => options[:raw_convert],
            :ocr => options[:ocr],
            :categorization => options[:categorization],
            :detection => options[:detection],
            :similarity_search => options[:similarity_search],
            :background_removal => options[:background_removal],
            :auto_tagging => options[:auto_tagging] && options[:auto_tagging].to_f,
            :upload_preset => options[:upload_preset],
            :phash => Cloudinary::Utils.as_safe_bool(options[:phash]),
            :return_delete_token => Cloudinary::Utils.as_safe_bool(options[:return_delete_token]),
          }
  params    
end

.destroy(public_id, options = {}) ⇒ Object


127
128
129
130
131
132
133
134
135
136
# File 'lib/cloudinary/uploader.rb', line 127

def self.destroy(public_id, options={})
  call_api("destroy", options) do    
    {
      :timestamp=>(options[:timestamp] || Time.now.to_i),
      :type=>options[:type],
      :public_id=> public_id,
      :invalidate=>options[:invalidate],
    }
  end              
end

.exists?(public_id, options = {}) ⇒ Boolean

Returns:

  • (Boolean)

150
151
152
153
154
155
156
157
158
# File 'lib/cloudinary/uploader.rb', line 150

def self.exists?(public_id, options={})
  cloudinary_url = Cloudinary::Utils.cloudinary_url(public_id, options)
  begin
    RestClient::Request.execute(:method => :head, :url => cloudinary_url, :timeout=>5).code.to_s =~ /2\d{2}/
  rescue RestClient::ResourceNotFound => e
    return false
  end
  
end

.explicit(public_id, options = {}) ⇒ Object


160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# File 'lib/cloudinary/uploader.rb', line 160

def self.explicit(public_id, options={})
  call_api("explicit", options) do    
    {
      :timestamp=>(options[:timestamp] || Time.now.to_i),
      :type=>options[:type],
      :public_id=> public_id,
      :callback=> options[:callback],
      :eager=>build_eager(options[:eager]),
      :eager_notification_url=>options[:eager_notification_url],
      :eager_async=>Cloudinary::Utils.as_safe_bool(options[:eager_async]),
      :headers=>build_custom_headers(options[:headers]),
      :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

.explode(public_id, options = {}) ⇒ Object


221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/cloudinary/uploader.rb', line 221

def self.explode(public_id, options={})    
  call_api("explode", options) do
    {
      :timestamp=>(options[:timestamp] || Time.now.to_i),
      :public_id=>public_id,
      :type=>options[:type],
      :format=>options[:format],
      :notification_url=>options[:notification_url],
      :transformation => Cloudinary::Utils.generate_transformation_string(options.clone)        
    }    
  end
end

.generate_sprite(tag, options = {}) ⇒ Object


186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/cloudinary/uploader.rb', line 186

def self.generate_sprite(tag, options={})
  version_store = options.delete(:version_store)
  
  result = call_api("sprite", options) do
    {
      :timestamp=>(options[:timestamp] || Time.now.to_i),
      :tag=>tag,
      :async=>options[:async],
      :notification_url=>options[:notification_url],
      :transformation => Cloudinary::Utils.generate_transformation_string(options.merge(:fetch_format=>options[:format]))        
    }    
  end
  
  if version_store == :file && result && result["version"]
    if defined?(Rails) && defined?(Rails.root)
      FileUtils.mkdir_p("#{Rails.root}/tmp/cloudinary")
      File.open("#{Rails.root}/tmp/cloudinary/cloudinary_sprite_#{tag}.version", "w"){|file| file.print result["version"].to_s}                      
    end  
  end      
  return result
end

.multi(tag, options = {}) ⇒ Object


208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/cloudinary/uploader.rb', line 208

def self.multi(tag, options={})
  call_api("multi", options) do
    {
      :timestamp=>(options[:timestamp] || Time.now.to_i),
      :tag=>tag,
      :format=>options[:format],
      :async=>options[:async],
      :notification_url=>options[:notification_url],
      :transformation => Cloudinary::Utils.generate_transformation_string(options.clone)        
    }    
  end
end

.remove_tag(tag, public_ids = [], options = {}) ⇒ Object


241
242
243
# File 'lib/cloudinary/uploader.rb', line 241

def self.remove_tag(tag, public_ids = [], options = {})
  return self.call_tags_api(tag, "remove", public_ids, options)    
end

.rename(from_public_id, to_public_id, options = {}) ⇒ Object


138
139
140
141
142
143
144
145
146
147
148
# File 'lib/cloudinary/uploader.rb', line 138

def self.rename(from_public_id, to_public_id, options={})
  call_api("rename", options) do    
    {
      :timestamp=>(options[:timestamp] || Time.now.to_i),
      :type=>options[:type],
      :overwrite=>options[:overwrite],
      :from_public_id=>from_public_id,
      :to_public_id=>to_public_id,
    }
  end              
end

.replace_tag(tag, public_ids = [], options = {}) ⇒ Object


245
246
247
# File 'lib/cloudinary/uploader.rb', line 245

def self.replace_tag(tag, public_ids = [], options = {})
  return self.call_tags_api(tag, "replace", public_ids, options)    
end

.text(text, options = {}) ⇒ Object


178
179
180
181
182
183
184
# File 'lib/cloudinary/uploader.rb', line 178

def self.text(text, options={})
  call_api("text", options) do
    params = {:timestamp => Time.now.to_i, :text=>text}
    TEXT_PARAMS.each{|k| params[k] = options[k] if !options[k].nil?}
    params
  end
end

.unsigned_upload(file, upload_preset, options = {}) ⇒ Object


65
66
67
# File 'lib/cloudinary/uploader.rb', line 65

def self.unsigned_upload(file, upload_preset, options={})
  upload(file, options.merge(:unsigned => true, :upload_preset => upload_preset))
end

.upload(file, options = {}) ⇒ Object


69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/cloudinary/uploader.rb', line 69

def self.upload(file, options={})
  call_api("upload", options) do    
    params = build_upload_params(options)
    if file.is_a?(Pathname)
      params[:file] = File.open(file, "rb")
    elsif file.respond_to?(:read) || file =~ /^ftp:|^https?:|^s3:|^data:[^;]*;base64,([a-zA-Z0-9\/+\n=]+)$/
      params[:file] = file
    else 
      params[:file] = File.open(file, "rb")
    end
    [params, [:file]]
  end              
end

.upload_large(file, public_id_or_options = {}, old_options = {}) ⇒ Object

Upload large files. Note that public_id should include an extension for best results.


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/cloudinary/uploader.rb', line 84

def self.upload_large(file, public_id_or_options={}, old_options={})
  if public_id_or_options.is_a?(Hash)
    options = public_id_or_options
    public_id = options[:public_id]
  else
    public_id = public_id_or_options
    options = old_options
  end 
  if file.is_a?(Pathname) || !file.respond_to?(:read)
    filename = file
    file = File.open(file, "rb")
  else
    filename = "cloudinaryfile"
  end
  upload = upload_id = nil
  index = 0
  chunk_size = options[:chunk_size] || 20_000_000
  while !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, :content_range=>range))
    public_id = upload["public_id"]      
    index += 1
  end
  upload
end

.upload_large_part(file, options = {}) ⇒ Object

Upload large files. Note that public_id should include an extension for best results.


114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/cloudinary/uploader.rb', line 114

def self.upload_large_part(file, options={})
  options[:resource_type] ||= :raw
  call_api("upload", options) do    
    params = build_upload_params(options)
    if file.is_a?(Pathname) || !file.respond_to?(:read)
      params[:file] = File.open(file, "rb")
    else
      params[:file] = file
    end
    [params, [:file]]
  end              
end