Class: Dragonfly::Job

Inherits:
Object show all
Extended by:
Forwardable
Defined in:
lib/dragonfly/job.rb

Defined Under Namespace

Modules: OverrideInstanceMethods Classes: AppDoesNotMatch, Encode, Fetch, FetchFile, FetchUrl, Generate, IncorrectSHA, InvalidArray, JobAlreadyApplied, NoContent, NoSHAGiven, NothingToEncode, NothingToProcess, Process, Step

Constant Summary

STEPS = 
[
  Fetch,
  Process,
  Encode,
  Generate,
  FetchFile,
  FetchUrl
]

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Job) initialize(app, content = nil, meta = {}, url_attrs = {})

A new instance of Job



206
207
208
209
210
211
212
213
 
# File 'lib/dragonfly/job.rb', line 206

def initialize(app, content=nil, meta={}, url_attrs={})
  @app = app
  @steps = []
  @next_step_index = 0
  @previous_temp_objects = []
  update(content, meta) if content
  self.url_attrs = url_attrs
end

Instance Attribute Details

- (Object) app (readonly)

Returns the value of attribute app



222
223
224
 
# File 'lib/dragonfly/job.rb', line 222

def app
  @app
end

- (Object) steps

Returns the value of attribute steps



222
223
224
 
# File 'lib/dragonfly/job.rb', line 222

def steps
  @steps
end

- (Object) temp_object

Returns the value of attribute temp_object



223
224
225
 
# File 'lib/dragonfly/job.rb', line 223

def temp_object
  @temp_object
end

- (Object) url_attrs

Returns the value of attribute url_attrs



315
316
317
 
# File 'lib/dragonfly/job.rb', line 315

def url_attrs
  @url_attrs
end

Class Method Details

+ (Object) deserialize(string, app) 



168
169
170
 
# File 'lib/dragonfly/job.rb', line 168

def deserialize(string, app)
  from_a(Serializer.marshal_decode(string), app)
end

+ (Object) from_a(steps_array, app) 



155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/dragonfly/job.rb', line 155

def from_a(steps_array, app)
  unless steps_array.is_a?(Array) &&
         steps_array.all?{|s| s.is_a?(Array) && step_abbreviations[s.first] }
    raise InvalidArray, "can't define a job from #{steps_array.inspect}"
  end
  job = app.new_job
  steps_array.each do |step_array|
    step_class = step_abbreviations[step_array.shift]
    job.steps << step_class.new(job, *step_array)
  end
  job
end

+ (Object) step_abbreviations 



172
173
174
 
# File 'lib/dragonfly/job.rb', line 172

def step_abbreviations
  @step_abbreviations ||= STEPS.inject({}){|hash, step_class| hash[step_class.abbreviation] = step_class; hash }
end

+ (Object) step_names 



176
177
178
 
# File 'lib/dragonfly/job.rb', line 176

def step_names
  @step_names ||= STEPS.map{|step_class| step_class.step_name }
end

Instance Method Details

- (Object) analyse(method, *args) 



246
247
248
 
# File 'lib/dragonfly/job.rb', line 246

def analyse(method, *args)
  analyser.analyse(result, method, *args)
end

- (Boolean) applied?

Returns:

  • (Boolean) 


258
259
260
 
# File 'lib/dragonfly/job.rb', line 258

def applied?
  next_step_index == steps.length
end

- (Object) applied_steps 



262
263
264
 
# File 'lib/dragonfly/job.rb', line 262

def applied_steps
  steps[0...next_step_index]
end

- (Object) apply

Applying, etc.



252
253
254
255
256
 
# File 'lib/dragonfly/job.rb', line 252

def apply
  pending_steps.each{|step| step.apply }
  self.next_step_index = steps.length
  self
end

- (Object) b64_data 



317
318
319
 
# File 'lib/dragonfly/job.rb', line 317

def b64_data
  "data:#{mime_type};base64,#{Base64.encode64(data)}"
end

- (Object) close 



392
393
394
395
 
# File 'lib/dragonfly/job.rb', line 392

def close
  previous_temp_objects.each{|temp_object| temp_object.close }
  temp_object.close if temp_object
end

- (Object) encode_step 



365
366
367
 
# File 'lib/dragonfly/job.rb', line 365

def encode_step
  last_step_of_type(Encode)
end

- (Object) fetch_file_step 



353
354
355
 
# File 'lib/dragonfly/job.rb', line 353

def fetch_file_step
  last_step_of_type(FetchFile)
end

- (Object) fetch_step 



345
346
347
 
# File 'lib/dragonfly/job.rb', line 345

def fetch_step
  last_step_of_type(Fetch)
end

- (Object) fetch_url_step 



357
358
359
 
# File 'lib/dragonfly/job.rb', line 357

def fetch_url_step
  last_step_of_type(FetchUrl)
end

- (Object) generate_step 



349
350
351
 
# File 'lib/dragonfly/job.rb', line 349

def generate_step
  last_step_of_type(Generate)
end

- (Object) initialize_copy(other)

Used by 'dup' and 'clone'



216
217
218
219
220
 
# File 'lib/dragonfly/job.rb', line 216

def initialize_copy(other)
  self.steps = other.steps.map do |step|
    step.class.new(self, *step.args)
  end
end

- (Object) inspect 



380
381
382
 
# File 'lib/dragonfly/job.rb', line 380

def inspect
  "<Dragonfly::Job app=#{app.name.inspect}, steps=#{steps.inspect}, temp_object=#{temp_object.inspect}, steps applied:#{applied_steps.length}/#{steps.length} >"
end

- (Object) pending_steps 



266
267
268
 
# File 'lib/dragonfly/job.rb', line 266

def pending_steps
  steps[next_step_index..-1]
end

- (Object) process_steps 



361
362
363
 
# File 'lib/dragonfly/job.rb', line 361

def process_steps
  steps.select{|s| s.is_a?(Process) }
end

- (Object) serialize 



282
283
284
 
# File 'lib/dragonfly/job.rb', line 282

def serialize
  Serializer.marshal_encode(to_a)
end

- (Object) sha 



290
291
292
 
# File 'lib/dragonfly/job.rb', line 290

def sha
  Digest::SHA1.hexdigest("#{to_unique_s}#{app.secret}")[0...8]
end

- (Object) step_types 



369
370
371
 
# File 'lib/dragonfly/job.rb', line 369

def step_types
  steps.map{|s| s.class.step_name }
end

- (Object) store(opts = {})

Misc



375
376
377
378
 
# File 'lib/dragonfly/job.rb', line 375

def store(opts={})
  temp_object = result
  app.store(temp_object, opts_for_store.merge(opts).merge(:meta => temp_object.meta))
end

- (Object) to_a 



270
271
272
273
274
 
# File 'lib/dragonfly/job.rb', line 270

def to_a
  steps.map{|step|
    [step.class.abbreviation, *step.args]
  }
end

- (Object) to_app

to_stuff...



323
324
325
 
# File 'lib/dragonfly/job.rb', line 323

def to_app
  JobEndpoint.new(self)
end

- (Object) to_fetched_job(uid) 



331
332
333
334
335
336
 
# File 'lib/dragonfly/job.rb', line 331

def to_fetched_job(uid)
  new_job = self.class.new(app, temp_object, meta, url_attrs)
  new_job.fetch!(uid)
  new_job.next_step_index = 1
  new_job
end

- (Object) to_response(env = {"REQUEST_METHOD" => "GET"}) 



327
328
329
 
# File 'lib/dragonfly/job.rb', line 327

def to_response(env={"REQUEST_METHOD" => "GET"})
  to_app.call(env)
end

- (Object) to_unique_s

Serializing, etc.



278
279
280
 
# File 'lib/dragonfly/job.rb', line 278

def to_unique_s
  to_a.to_dragonfly_unique_s
end

- (Object) uid

Step inspection



340
341
342
343
 
# File 'lib/dragonfly/job.rb', line 340

def uid
  step = fetch_step
  step.uid if step
end

- (Object) unique_signature 



286
287
288
 
# File 'lib/dragonfly/job.rb', line 286

def unique_signature
  Digest::SHA1.hexdigest(to_unique_s)
end

- (Object) update(content, new_meta) 



384
385
386
387
388
389
390
 
# File 'lib/dragonfly/job.rb', line 384

def update(content, new_meta)
  if new_meta
    new_meta.merge!(new_meta.delete(:meta)) if new_meta[:meta] # legacy data etc. may have nested meta hash - deprecate gracefully here
  end
  old_meta = temp_object ? temp_object.meta : {}
  self.temp_object = TempObject.new(content, old_meta.merge(new_meta || {}))
end

- (Object) url(opts = {})

URLs, etc.



307
308
309
 
# File 'lib/dragonfly/job.rb', line 307

def url(opts={})
  app.url_for(self, attributes_for_url.merge(opts)) unless steps.empty?
end

- (Object) validate_sha!(sha) 



294
295
296
297
298
299
300
301
302
303
 
# File 'lib/dragonfly/job.rb', line 294

def validate_sha!(sha)
  case sha
  when nil
    raise NoSHAGiven
  when self.sha
    self
  else
    raise IncorrectSHA, sha
  end
end