Class: Tml::Api::Client

Inherits:
Base
  • Object
show all
Defined in:
lib/tml/api/client.rb

Direct Known Subclasses

PostOffice

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

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 Tml::Base

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Tml::Base

Class Method Details

.error?(data) ⇒ Boolean 



77
78
79
 
# File 'lib/tml/api/client.rb', line 77

def self.error?(data)
  not data['error'].nil?
end

Instance Method Details

#access_token ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/tml/api/client.rb', line 41

def access_token
  return Tml::Session.access_token if Tml::Session.access_token

  application.access_token ||= begin
    token = Tml.cache.fetch("#{application.key}/access_token") do
      api('oauth/token', {
        :client_id      => application.key,
        :client_secret  => application.secret,
        :grant_type     => :client_credentials
      }, {:method => :post})
    end
    Tml::Session.access_token = token['access_token']
    Tml::Session.access_token
  end
end

#api(path, params = {}, opts = {}) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/tml/api/client.rb', line 93

def api(path, params = {}, opts = {})
  if Tml.session.inline_mode?
    return process_response(execute_request(path, params, opts), opts)
  end

  if opts[:method] == :get and opts[:cache_key]
    data = Tml.cache.fetch(opts[:cache_key]) do
      Tml.cache.read_only? ? nil : 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/tml/api/client.rb', line 85

def connection
  @connection ||= Faraday.new(:url => host) do |faraday|
    faraday.request(:url_encoded)               # form-encode POST params
    # faraday.response :logger                  # log requests to STDOUT
    faraday.adapter(Faraday.default_adapter)    # make requests with Net::HTTP
  end
end

#delete(path, params = {}, opts = {}) ⇒ Object 



73
74
75
 
# File 'lib/tml/api/client.rb', line 73

def delete(path, params = {}, opts = {})
  api(path, params, opts.merge(:method => :delete))
end

#execute_request(path, params = {}, opts = {}) ⇒ Object

Raises:



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/tml/api/client.rb', line 134

def execute_request(path, params = {}, opts = {})
  response = nil
  error = nil

  # oauth path is separate from versioned APIs
  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

  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
      Tml.logger.error("Failed to execute request: #{ex.message[0..255]}")
      error = ex
      nil
    end
  end
  raise Tml::Exception.new("Error: #{error}") if error

  if response.status >= 500 and response.status < 600
    raise Tml::Exception.new("Error: #{response.body}")
  end

  return if response.body.nil? or response.body == ''

  begin
    data = JSON.parse(response.body)
  rescue Exception => ex
    raise Tml::Exception.new("Failed to parse response: #{ex.message[0..255]}")
  end

  if data.is_a?(Hash) and not data['error'].nil?
    raise Tml::Exception.new("Error: #{data['error']}")
  end

  data
end

#get(path, params = {}, opts = {}) ⇒ Object 



61
62
63
 
# File 'lib/tml/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/tml/api/client.rb', line 81

def host
  application.host || API_HOST
end

#object_class(opts) ⇒ Object 



184
185
186
187
 
# File 'lib/tml/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/tml/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/tml/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/tml/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
205
 
# File 'lib/tml/api/client.rb', line 189

def process_response(data, opts)
  return nil if data.nil?
  return data if opts['raw']

  if data.is_a?(Hash) and data['results']
    #Tml.logger.debug("received #{data['results'].size} result(s)")
    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/tml/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/tml/api/client.rb', line 57

def results(path, params = {}, opts = {})
  get(path, params, opts)['results']
end

#to_query(hash) ⇒ Object 



207
208
209
210
211
212
213
 
# File 'lib/tml/api/client.rb', line 207

def to_query(hash)
  query = []
  hash.each do |key, value|
    query << "#{key}=#{value}"
  end
  query.join('&')
end

#trace_api_call(path, params, opts = {}) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/tml/api/client.rb', line 215

def trace_api_call(path, params, opts = {})
  #[:client_secret, :access_token].each do |param|
  #  params = params.merge(param => "##filtered##") if params[param]
  #end

  if opts[:method] == :post
    Tml.logger.debug("post: [#{path}] #{params.inspect}")
  else
    Tml.logger.debug("get: #{path}?#{to_query(params)}")
  end

  t0 = Time.now
  if block_given?
    ret = yield
  end
  t1 = Time.now

  Tml.logger.debug("call took #{t1 - t0} seconds")
  ret
end