Class: Wordnik::Request

Inherits:
Object show all
Extended by:
ActiveModel::Naming
Includes:
ActiveModel::Conversion, ActiveModel::Validations
Defined in:
lib/wordnik/request.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(http_method, path, attributes = {}) ⇒ Request

All requests must have an HTTP method and a path Optionals parameters are :params, :headers, :body, :format, :host



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/wordnik/request.rb', line 20

def initialize(http_method, path, attributes={})
  attributes[:format] ||= Wordnik.configuration.response_format
  attributes[:params] ||= {}

  # Set default headers
  default_headers = {
    'Content-Type' => "application/#{attributes[:format].downcase}",
    :api_key => Wordnik.configuration.api_key,
    :user_agent => Wordnik.configuration.user_agent
  }

  # api_key from headers hash trumps the default, even if its value is blank
  if attributes[:headers].present? && attributes[:headers].has_key?(:api_key)
    default_headers.delete(:api_key)
  end

  # api_key from params hash trumps all others (headers and default_headers)
  if attributes[:params].present? && attributes[:params].has_key?(:api_key)
    default_headers.delete(:api_key)
    attributes[:headers].delete(:api_key) if attributes[:headers].present?
  end

  # Merge argument headers into defaults
  attributes[:headers] = default_headers.merge(attributes[:headers] || {})

  # Stick in the auth token if there is one
  if Wordnik.authenticated?
    attributes[:headers].merge!({:auth_token => Wordnik.configuration.auth_token})
  end

  self.http_method = http_method.to_sym
  self.path = path
  attributes.each do |name, value|
    send("#{name.to_s.underscore.to_sym}=", value)
  end
end

Instance Attribute Details

#body ⇒ Object

Returns the value of attribute body.



13
14
15
 
# File 'lib/wordnik/request.rb', line 13

def body
  @body
end

#format ⇒ Object

Returns the value of attribute format.



13
14
15
 
# File 'lib/wordnik/request.rb', line 13

def format
  @format
end

#headers ⇒ Object

Returns the value of attribute headers.



13
14
15
 
# File 'lib/wordnik/request.rb', line 13

def headers
  @headers
end

#host ⇒ Object

Returns the value of attribute host.



13
14
15
 
# File 'lib/wordnik/request.rb', line 13

def host
  @host
end

#http_method ⇒ Object

Returns the value of attribute http_method.



13
14
15
 
# File 'lib/wordnik/request.rb', line 13

def http_method
  @http_method
end

#params ⇒ Object

Returns the value of attribute params.



13
14
15
 
# File 'lib/wordnik/request.rb', line 13

def params
  @params
end

#path ⇒ Object

Returns the value of attribute path.



13
14
15
 
# File 'lib/wordnik/request.rb', line 13

def path
  @path
end

Instance Method Details

#interpreted_path ⇒ Object

Iterate over the params hash, injecting any path values into the path string e.g. /word.#format/word/entries => /word.json/cat/entries



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/wordnik/request.rb', line 78

def interpreted_path
  p = self.path.dup

  # Fill in the path params
  self.params.each_pair do |key, value|
    p = p.gsub("{#{key}}", value.to_s)
  end

  # Stick a .{format} placeholder into the path if there isn't
  # one already or an actual format like json or xml
  # e.g. /words/blah => /words.{format}/blah
  unless ['.json', '.xml', '{format}'].any? {|s| p.downcase.include? s }
    p = p.sub(/^(\/?\w+)/, "\\1.#{format}")
  end

  p = p.sub("{format}", self.format.to_s)

  URI.encode [Wordnik.configuration.base_path, p].join("/").gsub(/\/+/, '/')
end

#make(attempt = 0) ⇒ Object 



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/wordnik/request.rb', line 141

def make(attempt = 0)
  # url is calculated, so we need to compute it once.
  u = self.url
  #Wordnik.logger.debug "Making attempt #{attempt}; now fetching #{u}" if attempt > 0
  request = Typhoeus::Request.new(u,
    :headers => self.headers.stringify_keys,
    :method => self.http_method.to_sym)

  # Make request proxy-aware
  if Wordnik.configuration.proxy.present?
    request.proxy = Wordnik.configuration.proxy
    request.proxy_username = Wordnik.configuration.proxy_username if Wordnik.configuration.proxy_username.present?
    request.proxy_password = Wordnik.configuration.proxy_password if Wordnik.configuration.proxy_password.present?
  end

  Wordnik.logger.debug "\n  #{self.http_method.to_s.upcase} #{u}\n  body: #{self.outgoing_body}\n\n"

  request.body = self.outgoing_body unless self.http_method.to_sym == :get

  # Execute the request — blocking call here.
  Typhoeus::Hydra.hydra.queue request
  Typhoeus::Hydra.hydra.run

  # if we are using local load balancing, check for timeouts and connection errors
  resp = request.response

  if Wordnik.configuration.load_balancer
    if (resp.timed_out? || resp.code == 0)
      Wordnik.logger.info "Wordnik: informing load balancer about failure"
      Wordnik.configuration.load_balancer.inform_failure
      if (attempt <= 3)
        Wordnik.logger.info "Trying again after failing #{attempt} times..."
        return make(attempt + 1) if attempt <= 3 # try three times to get a result...
      end
    else
      Wordnik.logger.debug "informing load balancer about success"
      Wordnik.configuration.load_balancer.inform_success
    end
  end

  Response.new(resp)
end

#outgoing_body ⇒ Object

If body is an object, JSONify it before making the actual request.



113
114
115
 
# File 'lib/wordnik/request.rb', line 113

def outgoing_body
  body.is_a?(String) ? body : body.to_json
end

#persisted? ⇒ Boolean

It’s an ActiveModel thing..

Returns:

  • (Boolean) 


200
201
202
 
# File 'lib/wordnik/request.rb', line 200

def persisted?
  false
end

#query_string ⇒ Object

Construct a query string from the query-string-type params



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/wordnik/request.rb', line 118

def query_string

  # Iterate over all params,
  # .. removing the ones that are part of the path itself.
  # .. stringifying values so Addressable doesn't blow up.
  query_values = {}
  self.params.each_pair do |key, value|
    next if self.path.include? "{#{key}}"                                   # skip path params
    next if value.blank? && value.class != FalseClass                       # skip empties
    key = key.to_s.camelize(:lower).to_sym unless key.to_sym == :api_key    # api_key is not a camelCased param
    query_values[key] = value.to_s
  end

  # We don't want to end up with '?' as our query string
  # if there aren't really any params
  return "" if query_values.blank?

  # Addressable requires query_values to be set after initialization..
  qs = Addressable::URI.new
  qs.query_values = query_values
  qs.to_s
end

#response ⇒ Object 



184
185
186
 
# File 'lib/wordnik/request.rb', line 184

def response
  self.make
end

#response_code_pretty ⇒ Object 



188
189
190
191
 
# File 'lib/wordnik/request.rb', line 188

def response_code_pretty
  return unless @response.present?
  @response.code.to_s
end

#response_headers_pretty ⇒ Object 



193
194
195
196
197
 
# File 'lib/wordnik/request.rb', line 193

def response_headers_pretty
  return unless @response.present?
  # JSON.pretty_generate(@response.headers).gsub(/\n/, '<br/>') # <- This was for RestClient
  @response.headers.gsub(/\n/, '<br/>') # <- This is for Typhoeus
end

#url(options = {}) ⇒ Object

Construct a base URL



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/wordnik/request.rb', line 59

def url(options = {})
  u = Addressable::URI.new(
    :scheme => Wordnik.configuration.scheme,
    :host => Wordnik.configuration.host,
    :path => self.interpreted_path,
    :query => self.query_string.sub(/\?/, '')
  ).to_s

  # Drop trailing question mark, if present
  u.sub! /\?$/, ''

  # Obfuscate API key?
  u.sub! /api\_key=\w+/, 'api_key=YOUR_API_KEY' if options[:obfuscated]

  u
end