Class: Tr8n::Api::Client

Inherits:
Base
  • Object
show all
Defined in:
lib/tr8n/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 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

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/tr8n/api/client.rb', line 66

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
 
# File 'lib/tr8n/api/client.rb', line 41

def access_token
  application.access_token ||= begin
    Tr8n.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
  end
  application.access_token['access_token']
end

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/tr8n/api/client.rb', line 82

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 



74
75
76
77
78
79
80
 
# File 'lib/tr8n/api/client.rb', line 74

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

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

Raises:



123
124
125
126
127
128
129
130
131
132
133
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
 
# File 'lib/tr8n/api/client.rb', line 123

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')

  Tr8n.logger.trace_api_call(path, params, opts) do
    begin
      if opts[:method] == :post
        response = connection.post(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

  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 



58
59
60
 
# File 'lib/tr8n/api/client.rb', line 58

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

#host ⇒ Object 



70
71
72
 
# File 'lib/tr8n/api/client.rb', line 70

def host
  application.host || API_HOST
end

#object_class(opts) ⇒ Object 



163
164
165
166
 
# File 'lib/tr8n/api/client.rb', line 163

def object_class(opts)
  return unless opts[:class]
  opts[:class].is_a?(String) ? opts[:class].constantize : opts[:class]
end

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/tr8n/api/client.rb', line 97

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 



62
63
64
 
# File 'lib/tr8n/api/client.rb', line 62

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

#prepare_api_path(path) ⇒ Object 



117
118
119
120
121
 
# File 'lib/tr8n/api/client.rb', line 117

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 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/tr8n/api/client.rb', line 168

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

  if data.is_a?(Hash) and data['results']
    #Tr8n.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

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



54
55
56
 
# File 'lib/tr8n/api/client.rb', line 54

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