Class: OAuth2::Response

Inherits:
Object
  • Object
show all
Defined in:
lib/oauth2/response.rb

Overview

OAuth2::Response class

Constant Summary collapse

@@parsers =

Procs that, when called, will parse a response body according to the specified format.

{
  :json  => lambda { |body| MultiJson.load(body) rescue body }, # rubocop:disable RescueModifier
  :query => lambda { |body| Rack::Utils.parse_query(body) },
  :text  => lambda { |body| body },
}
@@content_types =

Content type assignments for various potential HTTP content types.

{
  'application/json' => :json,
  'text/javascript' => :json,
  'application/x-www-form-urlencoded' => :query,
  'text/plain' => :text,
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(response, opts = {}) ⇒ Response

Initializes a Response instance

Parameters:

  • response (Faraday::Response)

    The Faraday response instance

  • opts (Hash) (defaults to: {})

    options in which to initialize the instance

Options Hash (opts):

  • :parse (Symbol) — default: :automatic

    how to parse the response body. one of :query (for x-www-form-urlencoded), :json, or :automatic (determined by Content-Type response header)



46
47
48
49
# File 'lib/oauth2/response.rb', line 46

def initialize(response, opts = {})
  @response = response
  @options = {:parse => :automatic}.merge(opts)
end

Instance Attribute Details

#errorObject

Returns the value of attribute error



9
10
11
# File 'lib/oauth2/response.rb', line 9

def error
  @error
end

#optionsObject

Returns the value of attribute options



9
10
11
# File 'lib/oauth2/response.rb', line 9

def options
  @options
end

#responseObject (readonly)

Returns the value of attribute response



8
9
10
# File 'lib/oauth2/response.rb', line 8

def response
  @response
end

Class Method Details

.register_parser(key, mime_types) {|String| ... } ⇒ Object

Adds a new content type parser.

Parameters:

  • key (Symbol)

    A descriptive symbol key such as :json or :query.

  • mime_types (Array)

    One or more mime types to which this parser applies.

Yields:

  • (String)

    A block returning parsed content.



32
33
34
35
36
37
38
# File 'lib/oauth2/response.rb', line 32

def self.register_parser(key, mime_types, &block)
  key = key.to_sym
  @@parsers[key] = block
  Array(mime_types).each do |mime_type|
    @@content_types[mime_type] = key
  end
end

Instance Method Details

#bodyObject

The HTTP response body



62
63
64
# File 'lib/oauth2/response.rb', line 62

def body
  response.body || ''
end

#content_typeObject

Attempts to determine the content type of the response.



75
76
77
# File 'lib/oauth2/response.rb', line 75

def content_type
  ((response.headers.values_at('content-type', 'Content-Type').compact.first || '').split(';').first || '').strip
end

#headersObject

The HTTP response headers



52
53
54
# File 'lib/oauth2/response.rb', line 52

def headers
  response.headers
end

#parsedObject

The parsed response body.

Will attempt to parse application/x-www-form-urlencoded and
application/json Content-Type response bodies


69
70
71
72
# File 'lib/oauth2/response.rb', line 69

def parsed
  return nil unless @@parsers.key?(parser)
  @parsed ||= @@parsers[parser].call(body)
end

#parserObject

Determines the parser that will be used to supply the content of #parsed



80
81
82
83
# File 'lib/oauth2/response.rb', line 80

def parser
  return options[:parse].to_sym if @@parsers.key?(options[:parse])
  @@content_types[content_type]
end

#statusObject

The HTTP response status code



57
58
59
# File 'lib/oauth2/response.rb', line 57

def status
  response.status
end