Class: Faraday::Connection

Inherits:
Object show all
Includes:
Addressable, Rack::Utils
Defined in:
lib/faraday/connection.rb

Constant Summary collapse

HEADERS = 
Hash.new { |h, k| k.respond_to?(:to_str) ? k : k.to_s.capitalize }.update \
:content_type    => "Content-Type",
:content_length  => "Content-Length",
:accept_charset  => "Accept-Charset",
:accept_encoding => "Accept-Encoding"
METHODS = 
Set.new [:get, :post, :put, :delete, :head]
METHODS_WITH_BODIES = 
Set.new [:post, :put]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url = nil, options = {}, &block) ⇒ Connection

:url :params :headers :request :ssl



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/faraday/connection.rb', line 26

def initialize(url = nil, options = {}, &block)
  if url.is_a?(Hash)
    options = url
    url     = options[:url]
  end
  @headers          = HeaderHash.new
  @params           = {}
  @options          = options[:request] || {}
  @ssl              = options[:ssl]     || {}
  @parallel_manager = options[:parallel]
  self.url_prefix = url if url
  proxy(options[:proxy])
  merge_params  @params,  options[:params]  if options[:params]
  merge_headers @headers, options[:headers] if options[:headers]
  if block
    @builder = Builder.create(&block)
  else
    @builder = options[:builder] || Builder.new
  end
end

Instance Attribute Details

#builder ⇒ Object (readonly)

Returns the value of attribute builder.



19
20
21
 
# File 'lib/faraday/connection.rb', line 19

def builder
  @builder
end

#headers ⇒ Object

Returns the value of attribute headers.



18
19
20
 
# File 'lib/faraday/connection.rb', line 18

def headers
  @headers
end

#host ⇒ Object

Returns the value of attribute host.



18
19
20
 
# File 'lib/faraday/connection.rb', line 18

def host
  @host
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



19
20
21
 
# File 'lib/faraday/connection.rb', line 19

def options
  @options
end

#parallel_manager ⇒ Object

Returns the value of attribute parallel_manager.



18
19
20
 
# File 'lib/faraday/connection.rb', line 18

def parallel_manager
  @parallel_manager
end

#params ⇒ Object

Returns the value of attribute params.



18
19
20
 
# File 'lib/faraday/connection.rb', line 18

def params
  @params
end

#path_prefix ⇒ Object

Returns the value of attribute path_prefix.



19
20
21
 
# File 'lib/faraday/connection.rb', line 19

def path_prefix
  @path_prefix
end

#port ⇒ Object

Returns the value of attribute port.



18
19
20
 
# File 'lib/faraday/connection.rb', line 18

def port
  @port
end

#scheme ⇒ Object

Returns the value of attribute scheme.



18
19
20
 
# File 'lib/faraday/connection.rb', line 18

def scheme
  @scheme
end

#ssl ⇒ Object (readonly)

Returns the value of attribute ssl.



19
20
21
 
# File 'lib/faraday/connection.rb', line 19

def ssl
  @ssl
end

Instance Method Details

#build(options = {}, &block) ⇒ Object 



47
48
49
 
# File 'lib/faraday/connection.rb', line 47

def build(options = {}, &block)
  @builder.build(options, &block)
end

#build_url(url, params = nil) ⇒ Object

Takes a relative url for a request and combines it with the defaults set on the connection instance.

conn = Faraday::Connection.new { ... }
conn.url_prefix = "https://sushi.com/api?token=abc"
conn.scheme      # => https
conn.path_prefix # => "/api"

conn.build_url("nigiri?page=2")      # => https://sushi.com/api/nigiri?token=abc&page=2
conn.build_url("nigiri", :page => 2) # => https://sushi.com/api/nigiri?token=abc&page=2



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/faraday/connection.rb', line 159

def build_url(url, params = nil)
  uri          = URI.parse(url.to_s)
  uri.host   ||= @host
  uri.port   ||= @port
  uri.scheme ||= @scheme
  if @path_prefix && uri.path !~ /^\//
    uri.path = "#{@path_prefix.size > 1 ? @path_prefix : nil}/#{uri.path}"
  end
  replace_query(uri, params)
  uri
end

#delete(url = nil, headers = nil, &block) ⇒ Object 



67
68
69
 
# File 'lib/faraday/connection.rb', line 67

def delete(url = nil, headers = nil, &block)
  run_request :delete, url, nil, headers, &block
end

#dup ⇒ Object 



171
172
173
 
# File 'lib/faraday/connection.rb', line 171

def dup
  self.class.new(build_url(''), :headers => headers.dup, :params => params.dup, :builder => builder.dup)
end

#escape(s) ⇒ Object

Be sure to URI escape ‘+’ symbols to %2B. Otherwise, they get interpreted as spaces.



208
209
210
211
212
 
# File 'lib/faraday/connection.rb', line 208

def escape(s)
  s.to_s.gsub(/([^a-zA-Z0-9_.-]+)/n) do
    '%' << $1.unpack('H2'*bytesize($1)).join('%').tap { |c| c.upcase! }
  end
end

#get(url = nil, headers = nil, &block) ⇒ Object 



51
52
53
 
# File 'lib/faraday/connection.rb', line 51

def get(url = nil, headers = nil, &block)
  run_request :get, url, nil, headers, &block
end

#head(url = nil, headers = nil, &block) ⇒ Object 



63
64
65
 
# File 'lib/faraday/connection.rb', line 63

def head(url = nil, headers = nil, &block)
  run_request :head, url, nil, headers, &block
end

#in_parallel(manager) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/faraday/connection.rb', line 75

def in_parallel(manager)
  @parallel_manager = manager
  yield
  @parallel_manager && @parallel_manager.run
ensure
  @parallel_manager = nil
end

#in_parallel? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/faraday/connection.rb', line 71

def in_parallel?
  !!@parallel_manager
end

#merge_headers(existing_headers, new_headers) ⇒ Object

turns headers keys and values into strings. Look up symbol keys in the the HEADERS hash.

h = merge_headers(HeaderHash.new, :content_type => 'text/plain')
h['Content-Type'] # = 'text/plain'



200
201
202
203
204
 
# File 'lib/faraday/connection.rb', line 200

def merge_headers(existing_headers, new_headers)
  new_headers.each do |key, value|
    existing_headers[HEADERS[key]] = value.to_s
  end
end

#merge_params(existing_params, new_params) ⇒ Object

turns param keys into strings



188
189
190
191
192
 
# File 'lib/faraday/connection.rb', line 188

def merge_params(existing_params, new_params)
  new_params.each do |key, value|
    existing_params[key.to_s] = value
  end
end

#post(url = nil, body = nil, headers = nil, &block) ⇒ Object 



55
56
57
 
# File 'lib/faraday/connection.rb', line 55

def post(url = nil, body = nil, headers = nil, &block)
  run_request :post, url, body, headers, &block
end

#proxy(arg = nil) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/faraday/connection.rb', line 83

def proxy(arg = nil)
  return @proxy if arg.nil?

  @proxy = 
    case arg
      when String then {:uri => proxy_arg_to_uri(arg)}
      when URI    then {:uri => arg}
      when Hash   then arg
        if arg[:uri] = proxy_arg_to_uri(arg[:uri])
          arg
        else
          raise ArgumentError, "no :uri option."
        end
    end
end

#proxy_arg_to_uri(arg) ⇒ Object 



214
215
216
217
218
219
 
# File 'lib/faraday/connection.rb', line 214

def proxy_arg_to_uri(arg)
  case arg
    when String then URI.parse(arg)
    when URI    then arg
  end
end

#put(url = nil, body = nil, headers = nil, &block) ⇒ Object 



59
60
61
 
# File 'lib/faraday/connection.rb', line 59

def put(url = nil, body = nil, headers = nil, &block)
  run_request :put, url, body, headers, &block
end

#replace_query(uri, params) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/faraday/connection.rb', line 175

def replace_query(uri, params)
  url_params = @params.dup
  if uri.query && !uri.query.empty?
    merge_params url_params, parse_query(uri.query)
  end
  if params && !params.empty?
    merge_params url_params, params
  end
  uri.query = url_params.empty? ? nil : build_query(url_params)
  uri
end

#run_request(method, url, body, headers) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/faraday/connection.rb', line 135

def run_request(method, url, body, headers)
  if !METHODS.include?(method)
    raise ArgumentError, "unknown http method: #{method}"
  end

  Request.run(self, method) do |req|
    req.url(url)                if url
    req.headers.update(headers) if headers
    req.body = body             if body
    yield req if block_given?
  end
end

#to_app ⇒ Object

return the assembled Rack application for this instance.



131
132
133
 
# File 'lib/faraday/connection.rb', line 131

def to_app
  @builder.to_app
end

#url_prefix=(url) ⇒ Object

Parses the giving url with Addressable::URI and stores the individual components in this connection. These components serve as defaults for requests made by this connection.

conn = Faraday::Connection.new { ... }
conn.url_prefix = "https://sushi.com/api"
conn.scheme      # => https
conn.path_prefix # => "/api"

conn.get("nigiri?page=2") # accesses https://sushi.com/api/nigiri



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/faraday/connection.rb', line 110

def url_prefix=(url)
  uri              = URI.parse(url)
  self.scheme      = uri.scheme
  self.host        = uri.host
  self.port        = uri.port
  self.path_prefix = uri.path
  if uri.query && !uri.query.empty?
    merge_params @params, parse_query(uri.query)
  end
end