class Asana::HttpClient

Internal: Wrapper over Faraday that abstracts authentication, request parsing and common options.

Constants

BASE_URI

Internal: The API base URI.

Public Class Methods

new(authentication: required('authentication'), adapter: nil, user_agent: nil, debug_mode: false, &config) click to toggle source

Public: Initializes an HttpClient to make requests to the Asana API.

authentication - [Asana::Authentication] An authentication strategy. adapter - [Symbol, Proc] A Faraday adapter, eiter a Symbol for

registered adapters or a Proc taking a builder for a
custom one. Defaults to Faraday.default_adapter.

user_agent - [String] The user agent. Defaults to “ruby-asana vX.Y.Z”. config - [Proc] An optional block that yields the Faraday builder

object for customization.
# File lib/asana/http_client.rb, line 25
def initialize(authentication: required('authentication'),
               adapter: nil,
               user_agent: nil,
               debug_mode: false,
               &config)
  @authentication   = authentication
  @adapter          = adapter || Faraday.default_adapter
  @environment_info = EnvironmentInfo.new(user_agent)
  @debug_mode       = debug_mode
  @config           = config
end

Public Instance Methods

delete(resource_uri) click to toggle source

Public: Performs a DELETE request against the API.

resource_uri - [String] the resource URI relative to the base Asana API

URL, e.g "/tags".

Returns an [Asana::HttpClient::Response] if everything went well. Raises [Asana::Errors::APIError] if anything went wrong.

# File lib/asana/http_client.rb, line 98
def delete(resource_uri)
  perform_request(:delete, resource_uri)
end
get(resource_uri, params: {}, options: {}) click to toggle source

Public: Performs a GET request against the API.

resource_uri - [String] the resource URI relative to the base Asana API

URL, e.g "/users/me".

params - [Hash] the request parameters options - [Hash] the request I/O options

Returns an [Asana::HttpClient::Response] if everything went well. Raises [Asana::Errors::APIError] if anything went wrong.

# File lib/asana/http_client.rb, line 46
def get(resource_uri, params: {}, options: {})
  opts = options.reduce({}) do |acc, (k, v)|
    acc.tap do |hash|
      hash[:"opt_#{k}"] = v.is_a?(Array) ? v.join(',') : v
    end
  end
  perform_request(:get, resource_uri, params.merge(opts))
end
post(resource_uri, body: {}, upload: nil, options: {}) click to toggle source

Public: Performs a POST request against the API.

resource_uri - [String] the resource URI relative to the base Asana API

URL, e.g "/tags".

body - [Hash] the body to POST. upload - [Faraday::UploadIO] an upload object to post as multipart.

Defaults to nil.

options - [Hash] the request I/O options

Returns an [Asana::HttpClient::Response] if everything went well. Raises [Asana::Errors::APIError] if anything went wrong.

# File lib/asana/http_client.rb, line 80
def post(resource_uri, body: {}, upload: nil, options: {})
  params = { data: body }.merge(options.empty? ? {} : { options: options })
  if upload
    perform_request(:post, resource_uri, params.merge(file: upload)) do |c|
      c.request :multipart
    end
  else
    perform_request(:post, resource_uri, params)
  end
end
put(resource_uri, body: {}, options: {}) click to toggle source

Public: Performs a PUT request against the API.

resource_uri - [String] the resource URI relative to the base Asana API

URL, e.g "/users/me".

body - [Hash] the body to PUT. options - [Hash] the request I/O options

Returns an [Asana::HttpClient::Response] if everything went well. Raises [Asana::Errors::APIError] if anything went wrong.

# File lib/asana/http_client.rb, line 64
def put(resource_uri, body: {}, options: {})
  params = { data: body }.merge(options.empty? ? {} : { options: options })
  perform_request(:put, resource_uri, params)
end

Private Instance Methods

add_middleware(builder) click to toggle source
# File lib/asana/http_client.rb, line 129
def add_middleware(builder)
  builder.use Faraday::Response::RaiseError
  builder.use FaradayMiddleware::FollowRedirects
end
configure_format(builder) click to toggle source
# File lib/asana/http_client.rb, line 124
def configure_format(builder)
  builder.request :multi_json
  builder.response :multi_json
end
connection(&request_config) click to toggle source
# File lib/asana/http_client.rb, line 104
def connection(&request_config)
  Faraday.new do |builder|
    @authentication.configure(builder)
    @environment_info.configure(builder)
    request_config.call(builder) if request_config
    configure_format(builder)
    add_middleware(builder)
    @config.call(builder) if @config
    use_adapter(builder, @adapter)
  end
end
handling_errors(&request) click to toggle source
# File lib/asana/http_client.rb, line 143
def handling_errors(&request)
  ErrorHandling.handle(&request)
end
log_request(method, url, body) click to toggle source
# File lib/asana/http_client.rb, line 147
def log_request(method, url, body)
  STDERR.puts format('[%s] %s %s (%s)',
                     self.class,
                     method.to_s.upcase,
                     url,
                     body.inspect)
end
perform_request(method, resource_uri, body = {}, &request_config) click to toggle source
# File lib/asana/http_client.rb, line 116
def perform_request(method, resource_uri, body = {}, &request_config)
  handling_errors do
    url = BASE_URI + resource_uri
    log_request(method, url, body) if @debug_mode
    Response.new(connection(&request_config).public_send(method, url, body))
  end
end
use_adapter(builder, adapter) click to toggle source
# File lib/asana/http_client.rb, line 134
def use_adapter(builder, adapter)
  case adapter
  when Symbol
    builder.adapter(adapter)
  when Proc
    adapter.call(builder)
  end
end