Class: ChartMogul::APIResource

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/chartmogul/api_resource.rb

Constant Summary collapse

RETRY_STATUSES = 
[429, *500..599].freeze
RETRY_EXCEPTIONS = 
[
  'Faraday::ConnectionFailed',
  'Faraday::RetriableResponse'
].freeze
BACKOFF_FACTOR = 
2
INTERVAL_RANDOMNESS = 
0.5
INTERVAL = 
1
MAX_INTERVAL = 
60

Class Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Object

#allowed_for_write?, #assign_all_attributes, #assign_writeable_attributes, attributes, define_private_writer, define_reader, define_writer, #initialize, #instance_attributes, new_from_json, readonly_attr, #serialize_for_write, #serialized_value_for_attr, writeable_attr, writeable_attributes

Constructor Details

This class inherits a constructor from ChartMogul::Object

Class Attribute Details

.resource_name ⇒ Object (readonly)

Returns the value of attribute resource_name.



17
18
19
 
# File 'lib/chartmogul/api_resource.rb', line 17

def resource_name
  @resource_name
end

.resource_path ⇒ Object (readonly)

Returns the value of attribute resource_path.



17
18
19
 
# File 'lib/chartmogul/api_resource.rb', line 17

def resource_path
  @resource_path
end

.resource_root_key ⇒ Object (readonly)

Returns the value of attribute resource_root_key.



17
18
19
 
# File 'lib/chartmogul/api_resource.rb', line 17

def resource_root_key
  @resource_root_key
end

Class Method Details

.connection ⇒ Object 



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/chartmogul/api_resource.rb', line 31

def self.connection
  @connection ||= Faraday.new(url: ChartMogul::API_BASE) do |faraday|
    faraday.use Faraday::Request::BasicAuthentication, ChartMogul., ChartMogul.secret_key
    faraday.use Faraday::Response::RaiseError
    faraday.request :retry, max: ChartMogul.max_retries, retry_statuses: RETRY_STATUSES,
      max_interval: MAX_INTERVAL, backoff_factor: BACKOFF_FACTOR,
      interval_randomness: INTERVAL_RANDOMNESS, interval: INTERVAL, exceptions: RETRY_EXCEPTIONS
    faraday.use Faraday::Adapter::NetHttp
  end
end

.handle_other_error(exception) ⇒ Object

Raises:



75
76
77
 
# File 'lib/chartmogul/api_resource.rb', line 75

def self.handle_other_error(exception)
  raise ChartMogul::ChartMogulError, exception.message
end

.handle_request_error(exception) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/chartmogul/api_resource.rb', line 50

def self.handle_request_error(exception)
  response = exception.response[:body]
  http_status = exception.response[:status]
  case http_status
  when 400
    message = "JSON schema validation hasn't passed."
    raise ChartMogul::SchemaInvalidError.new(message, http_status: 400, response: response)
  when 401
    message = 'No valid API key provided'
    raise ChartMogul::UnauthorizedError.new(message, http_status: 401, response: response)
  when 403
    message = 'The requested action is forbidden.'
    raise ChartMogul::ForbiddenError.new(message, http_status: 403, response: response)
  when 404
    message = "The requested #{resource_name} could not be found."
    raise ChartMogul::NotFoundError.new(message, http_status: 404, response: response)
  when 422
    message = "The #{resource_name} could not be created or updated."
    raise ChartMogul::ResourceInvalidError.new(message, http_status: 422, response: response)
  else
    message = "#{resource_name} request error has occurred."
    raise ChartMogul::ChartMogulError.new(message, http_status: http_status, response: response)
  end
end

.handling_errors ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/chartmogul/api_resource.rb', line 42

def self.handling_errors
  yield
rescue Faraday::ClientError => exception
  exception.response ? handle_request_error(exception) : handle_other_error(exception)
rescue => exception
  handle_other_error(exception)
end

.set_resource_name(name) ⇒ Object 



23
24
25
 
# File 'lib/chartmogul/api_resource.rb', line 23

def self.set_resource_name(name)
  @resource_name = name
end

.set_resource_path(path) ⇒ Object 



19
20
21
 
# File 'lib/chartmogul/api_resource.rb', line 19

def self.set_resource_path(path)
  @resource_path = ChartMogul::ResourcePath.new(path)
end

.set_resource_root_key(root_key) ⇒ Object 



27
28
29
 
# File 'lib/chartmogul/api_resource.rb', line 27

def self.set_resource_root_key(root_key)
  @resource_root_key = root_key
end