Class: Grac::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/grac/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uri, options = {}) ⇒ Client

Returns a new instance of Client.



13
14
15
16
17
18
19
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
 
# File 'lib/grac/client.rb', line 13

def initialize(uri, options = {})
  URI.parse(uri)

  @uri = uri
  @options = {
    :connecttimeout => options[:connecttimeout] || 0.1,
    :timeout        => options[:timeout]        || 15,
    :params         => options[:params]         || {},
    :headers        => {
      "User-Agent"   => "Grac v#{Grac::VERSION}",
      "Content-Type" => "application/json;charset=utf-8"
    }.merge(options[:headers] || {}),
    :postprocessing => {},
    :middleware     => options[:middleware]     || []
  }

  if options[:postprocessing]
    options[:postprocessing]
      .each_with_object(postprocessing = {}) do |(pattern, transformation), obj|
      if pattern.kind_of?(Regexp)
        obj[pattern] = transformation
      else
        obj[Regexp.new(pattern)] = transformation
      end
    end

    @options[:postprocessing] = postprocessing
  end

  @options.freeze

  [:params, :headers, :postprocessing, :middleware].each do |k|
    @options[k].freeze
  end

  @uri.freeze
end

Instance Attribute Details

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



11
12
13
 
# File 'lib/grac/client.rb', line 11

def uri
  @uri
end

Instance Method Details

#call(opts, request_uri, method, params, body) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/grac/client.rb', line 81

def call(opts, request_uri, method, params, body)
  request_hash = {
    :method         => method,
    :params         => params,  # Query params are escaped by Typhoeus
    :body           => body,
    :connecttimeout => opts[:connecttimeout],
    :timeout        => opts[:timeout],
    :headers        => opts[:headers]
  }

  request  = ::Typhoeus::Request.new(request_uri, request_hash)
  response = request.run

  # Retry GET and HEAD requests - modifying requests might not be idempotent
  response = request.run if response.timed_out? && ['get', 'head'].include?(method)

  # A request can time out while receiving data. In this case response.code might indicate
  # success although data hasn't been fully transferred. Thus rely on Typhoeus for
  # detecting a timeout.
  if response.timed_out?
    raise Exception::ServiceTimeout.new(method, request.url, response.return_message)
  end

  # List of possible codes
  # https://github.com/typhoeus/ethon/blob/ab052b6a317309b6ae8be7b538738b138b11437a/lib/ethon/curls/codes.rb#L10
  case response.return_code
  # A request may have received a response but may have aborted while receiving the data.
  # Typhoeus does not necessarily consider this a timeout but might try to parse a response.
  # If the response content length does not match the content length header,
  # the return code will be :partial_file.
  # In that case we do not want to pass it on as it would result in JSON Parser errors
  # due to invalid JSON from the incomplete response.
  when :partial_file
    raise Exception::PartialResponse.new(method, request.url, response.return_message)
  end

  return Response.new(response)
end

#path(path, variables = {}) ⇒ Object 



60
61
62
63
64
65
 
# File 'lib/grac/client.rb', line 60

def path(path, variables = {})
  variables.each do |key, value|
    path = path.gsub("{#{key}}", escape_url_param(value))
  end
  self.class.new("#{@uri}#{path}", @options)
end

#set(options = {}) ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'lib/grac/client.rb', line 51

def set(options = {})
  options = options.merge({
    headers:    @options[:headers].merge(options[:headers]    || {}),
    middleware: @options[:middleware] + (options[:middleware] || [])
  })

  self.class.new(@uri, @options.merge(options))
end