module Koala::HTTPService

Constants

DEFAULT_MIDDLEWARE

Koala’s default middleware stack. We encode requests in a Facebook-compatible multipart request, and use whichever adapter has been configured for this application.

DEFAULT_SERVERS

Default servers for Facebook. These are read into the config OpenStruct, and can be overridden via Koala.config.

Attributes

faraday_middleware[RW]

A customized stack of Faraday middleware that will be used to make each request.

http_options[RW]

A default set of HTTP options (see github.com/arsduo/koala/wiki/HTTP-Services)

Public Class Methods

encode_params(param_hash) click to toggle source

Encodes a given hash into a query string. This is used mainly by the Batch API nowadays, since Faraday handles this for regular cases.

@param params_hash a hash of values to CGI-encode and appropriately join

@example

Koala.http_service.encode_params({:a => 2, :b => "My String"})
=> "a=2&b=My+String"

@return the appropriately-encoded string

# File lib/koala/http_service.rb, line 131
def self.encode_params(param_hash)
  ((param_hash || {}).sort_by{|k, v| k.to_s}.collect do |key_and_value|
    key_and_value[1] = JSON.dump(key_and_value[1]) unless key_and_value[1].is_a? String
    "#{key_and_value[0].to_s}=#{CGI.escape key_and_value[1]}"
  end).join("&")
end
make_request(path, args, verb, options = {}) click to toggle source

Makes a request directly to Facebook. @note You’ll rarely need to call this method directly.

@see Koala::Facebook::API#api @see Koala::Facebook::GraphAPIMethods#graph_call @see Koala::Facebook::RestAPIMethods#rest_call

@param path the server path for this request @param args (see Koala::Facebook::API#api) @param verb the HTTP method to use.

If not get or post, this will be turned into a POST request with the appropriate :method
specified in the arguments.

@param options (see Koala::Facebook::API#api)

@raise an appropriate connection error if unable to make the request to Facebook

@return [Koala::HTTPService::Response] a response object representing the results from Facebook

# File lib/koala/http_service.rb, line 76
def self.make_request(path, args, verb, options = {})
  # if the verb isn't get or post, send it as a post argument with a method param
  args.merge!({:method => verb}) && verb = "post" if verb != "get" && verb != "post"

  # turn all the keys to strings (Faraday has issues with symbols under 1.8.7) and resolve UploadableIOs
  params = args.inject({}) {|hash, kv| hash[kv.first.to_s] = kv.last.is_a?(UploadableIO) ? kv.last.to_upload_io : kv.last; hash}

  # figure out our options for this request
  request_options = {:params => (verb == "get" ? params : {})}.merge(http_options || {}).merge(options)
  request_options[:use_ssl] = true if args["access_token"] # require https if there's a token
  if request_options[:use_ssl]
    ssl = (request_options[:ssl] ||= {})
    ssl[:verify] = true unless ssl.has_key?(:verify)
  end

  # if an api_version is specified and the path does not already contain
  # one, prepend it to the path
  api_version = request_options[:api_version] || Koala.config.api_version
  if api_version && !path_contains_api_version?(path)
    begins_with_slash = path[0] == "/"
    divider = begins_with_slash ? "" : "/"
    path = "/#{api_version}#{divider}#{path}"
  end

  # set up our Faraday connection
  # we have to manually assign params to the URL or the
  conn = Faraday.new(server(request_options), faraday_options(request_options), &(faraday_middleware || DEFAULT_MIDDLEWARE))

  # remember, all non-GET requests are turned into POSTs -- see the the start of this method
  if verb == "post" && options[:format] == :json
    response = conn.post do |req|
      req.path = path
      req.headers["Content-Type"] = "application/json"
      req.body = params.to_json
      req
    end
  else
    response = conn.send(verb, path, (verb == "post" ? params : {}))
  end

  # Log URL information
  Koala::Utils.debug "#{verb.upcase}: #{path} params: #{params.inspect}"
  Koala::HTTPService::Response.new(response.status.to_i, response.body, response.headers)
end
path_contains_api_version?(path) click to toggle source

Determines whether a given path already contains an API version.

@param path the URL path.

@return true or false accordingly.

# File lib/koala/http_service.rb, line 143
def self.path_contains_api_version?(path)
  match = /^\/?(v\d+(?:\.\d+)?)\//.match(path)
  !!(match && match[1])
end
server(options = {}) click to toggle source

The address of the appropriate Facebook server.

@param options various flags to indicate which server to use. @option options :rest_api use the old REST API instead of the Graph API @option options :video use the server designated for video uploads @option options :beta use the beta tier @option options :use_ssl force https, even if not needed

@return a complete server address with protocol

# File lib/koala/http_service.rb, line 52
def self.server(options = {})
  server = "#{options[:rest_api] ? Koala.config.rest_server : Koala.config.graph_server}"
  server.gsub!(Koala.config.host_path_matcher, Koala.config.video_replace) if options[:video]
  server.gsub!(Koala.config.host_path_matcher, Koala.config.beta_replace) if options[:beta]
  "#{options[:use_ssl] ? "https" : "http"}://#{server}"
end