Class: Tr8n::Api::Client
- Inherits:
-
Base
- Object
- Base
- Tr8n::Api::Client
show all
- Defined in:
- lib/tr8n/api/client.rb
Constant Summary
collapse
- API_HOST =
'https://api.translationexchange.com'
- API_PATH =
'/v1'
Instance Attribute Summary
Attributes inherited from Base
#attributes
Class Method Summary
collapse
Instance Method Summary
collapse
-
#access_token ⇒ Object
-
#api(path, params = {}, opts = {}) ⇒ Object
-
#connection ⇒ Object
-
#delete(path, params = {}, opts = {}) ⇒ Object
-
#execute_request(path, params = {}, opts = {}) ⇒ Object
-
#get(path, params = {}, opts = {}) ⇒ Object
-
#host ⇒ Object
-
#object_class(opts) ⇒ Object
-
#paginate(path, params = {}, opts = {}) ⇒ Object
-
#post(path, params = {}, opts = {}) ⇒ Object
-
#prepare_api_path(path) ⇒ Object
-
#process_response(data, opts) ⇒ Object
-
#put(path, params = {}, opts = {}) ⇒ Object
-
#results(path, params = {}, opts = {}) ⇒ Object
Methods inherited from Base
attributes, belongs_to, has_many, #hash_value, hash_value, #initialize, #method_missing, #to_hash, #update_attributes
Constructor Details
This class inherits a constructor from Tr8n::Base
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
in the class Tr8n::Base
Class Method Details
.error?(data) ⇒ Boolean
77
78
79
|
# File 'lib/tr8n/api/client.rb', line 77
def self.error?(data)
not data['error'].nil?
end
|
Instance Method Details
#api(path, params = {}, opts = {}) ⇒ Object
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
# File 'lib/tr8n/api/client.rb', line 93
def api(path, params = {}, opts = {})
if Tr8n.session.inline_mode?
return process_response(execute_request(path, params, opts), opts)
end
if opts[:method] == :get and opts[:cache_key]
data = Tr8n.cache.fetch(opts[:cache_key]) do
Tr8n.cache.read_only? ? {} : execute_request(path, params, opts)
end
process_response(data, opts)
else
process_response(execute_request(path, params, opts), opts)
end
end
|
#connection ⇒ Object
85
86
87
88
89
90
91
|
# File 'lib/tr8n/api/client.rb', line 85
def connection
@connection ||= Faraday.new(:url => host) do |faraday|
faraday.request(:url_encoded) faraday.adapter(Faraday.default_adapter) end
end
|
#delete(path, params = {}, opts = {}) ⇒ Object
73
74
75
|
# File 'lib/tr8n/api/client.rb', line 73
def delete(path, params = {}, opts = {})
api(path, params, opts.merge(:method => :delete))
end
|
#execute_request(path, params = {}, opts = {}) ⇒ Object
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
# File 'lib/tr8n/api/client.rb', line 134
def execute_request(path, params = {}, opts = {})
response = nil
error = nil
path = prepare_api_path(path)
params = params.merge(:access_token => access_token) unless path.index('oauth')
if opts[:method] == :post
params = params.merge(:api_key => application.key)
end
Tr8n.logger.trace_api_call(path, params, opts) do
begin
if opts[:method] == :post
response = connection.post(path, params)
elsif opts[:method] == :put
response = connection.put(path, params)
elsif opts[:method] == :delete
response = connection.delete(path, params)
else
response = connection.get(path, params)
end
rescue Exception => ex
Tr8n.logger.error("Failed to execute request: #{ex.message[0..255]}")
error = ex
nil
end
end
raise Tr8n::Exception.new("Error: #{error}") if error
if response.status >= 500 and response.status < 600
raise Tr8n::Exception.new("Error: #{response.body}")
end
return if response.body.nil? or response.body == ''
begin
data = JSON.parse(response.body)
rescue Exception => ex
raise Tr8n::Exception.new("Failed to parse response: #{ex.message[0..255]}")
end
if data.is_a?(Hash) and not data['error'].nil?
raise Tr8n::Exception.new("Error: #{data['error']}")
end
data
end
|
#get(path, params = {}, opts = {}) ⇒ Object
61
62
63
|
# File 'lib/tr8n/api/client.rb', line 61
def get(path, params = {}, opts = {})
api(path, params, opts.merge(:method => :get))
end
|
#host ⇒ Object
81
82
83
|
# File 'lib/tr8n/api/client.rb', line 81
def host
application.host || API_HOST
end
|
#object_class(opts) ⇒ Object
184
185
186
187
|
# File 'lib/tr8n/api/client.rb', line 184
def object_class(opts)
return unless opts[:class]
opts[:class].is_a?(String) ? opts[:class].constantize : opts[:class]
end
|
#paginate(path, params = {}, opts = {}) ⇒ Object
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
# File 'lib/tr8n/api/client.rb', line 108
def paginate(path, params = {}, opts = {})
data = get(path, params, opts.merge({'raw' => true}))
while data
if data['results'].is_a?(Array)
data['results'].each do |result|
yield(result)
end
else
yield(data['results'])
end
if data['pagination'] and data['pagination']['links']['next']
data = get(data['pagination']['links']['next'], {}, opts.merge({'raw' => true}))
else
data = nil
end
end
end
|
#post(path, params = {}, opts = {}) ⇒ Object
65
66
67
|
# File 'lib/tr8n/api/client.rb', line 65
def post(path, params = {}, opts = {})
api(path, params, opts.merge(:method => :post))
end
|
#prepare_api_path(path) ⇒ Object
128
129
130
131
132
|
# File 'lib/tr8n/api/client.rb', line 128
def prepare_api_path(path)
return path if path.index('oauth')
return path if path.match(/^https?:\/\//)
"#{API_PATH}#{path[0] == '/' ? '' : '/'}#{path}"
end
|
#process_response(data, opts) ⇒ Object
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
# File 'lib/tr8n/api/client.rb', line 189
def process_response(data, opts)
return data if opts['raw']
if data.is_a?(Hash) and data['results']
return data['results'] unless object_class(opts)
objects = []
data['results'].each do |data|
objects << object_class(opts).new(data.merge(opts[:attributes] || {}))
end
return objects
end
return data unless object_class(opts)
object_class(opts).new(data.merge(opts[:attributes] || {}))
end
|
#put(path, params = {}, opts = {}) ⇒ Object
69
70
71
|
# File 'lib/tr8n/api/client.rb', line 69
def put(path, params = {}, opts = {})
api(path, params, opts.merge(:method => :put))
end
|
#results(path, params = {}, opts = {}) ⇒ Object
57
58
59
|
# File 'lib/tr8n/api/client.rb', line 57
def results(path, params = {}, opts = {})
get(path, params, opts)['results']
end
|