Exception: Api2Convert::ConversionFailedError

Inherits:
Error
  • Object
show all
Defined in:
lib/api2convert/errors.rb

Overview

A job reached the failed (or canceled) status.

The originating Model::Job is attached so you can inspect its errors and warnings.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(job, message = nil) ⇒ ConversionFailedError

Returns a new instance of ConversionFailedError.



77
78
79
80
 
# File 'lib/api2convert/errors.rb', line 77

def initialize(job, message = nil)
  @job = job
  super(message.nil? ? self.class.build_message(job) : message)
end

Instance Attribute Details

#job ⇒ Model::Job (readonly)

Returns the failed job.

Returns:



75
76
77
 
# File 'lib/api2convert/errors.rb', line 75

def job
  @job
end

Class Method Details

.build_message(job) ⇒ Object 



88
89
90
91
92
93
94
95
96
 
# File 'lib/api2convert/errors.rb', line 88

def self.build_message(job)
  first = job.errors.first
  unless first.nil?
    code = first.code.nil? ? "" : " (code #{first.code})"
    return "Conversion failed: #{first.message}#{code}"
  end
  info = job.status.info
  info.nil? ? "Conversion failed." : "Conversion failed: #{info}"
end

Instance Method Details

#errors ⇒ Array<Model::JobMessage>

Returns the failed job's errors (may be empty if the API gave no detail).

Returns:

  • (Array<Model::JobMessage>) —

    the failed job's errors (may be empty if the API gave no detail).



84
85
86
 
# File 'lib/api2convert/errors.rb', line 84

def errors
  @job.errors
end