Class: OAuth2::Response
- Inherits:
-
Object
- Object
- OAuth2::Response
- 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.
{ :query => lambda { |body| Rack::Utils.parse_query(body) }, :text => lambda { |body| body } }
- CONTENT_TYPES =
Content type assignments for various potential HTTP content types.
{ 'application/x-www-form-urlencoded' => :query, 'text/plain' => :text }
Instance Attribute Summary collapse
-
#error ⇒ Object
Returns the value of attribute error.
-
#options ⇒ Object
Returns the value of attribute options.
-
#response ⇒ Object
readonly
Returns the value of attribute response.
Class Method Summary collapse
-
.register_parser(key, mime_types) {|String| ... } ⇒ Object
Adds a new content type parser.
Instance Method Summary collapse
-
#body ⇒ Object
The HTTP response body.
-
#content_type ⇒ Object
Attempts to determine the content type of the response.
-
#headers ⇒ Object
The HTTP response headers.
-
#initialize(response, opts = {}) ⇒ Response
constructor
Initializes a Response instance.
-
#parsed ⇒ Object
The parsed response body.
-
#parser ⇒ Object
Determines the parser that will be used to supply the content of #parsed.
-
#status ⇒ Object
The HTTP response status code.
Constructor Details
#initialize(response, opts = {}) ⇒ Response
Initializes a Response instance
30 31 32 33 |
# File 'lib/oauth2/response.rb', line 30 def initialize(response, opts = {}) @response = response @options = {:parse => :automatic}.merge(opts) end |
Instance Attribute Details
#error ⇒ Object
Returns the value of attribute error.
9 10 11 |
# File 'lib/oauth2/response.rb', line 9 def error @error end |
#options ⇒ Object
Returns the value of attribute options.
9 10 11 |
# File 'lib/oauth2/response.rb', line 9 def @options end |
#response ⇒ Object (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.
16 17 18 19 20 21 22 |
# File 'lib/oauth2/response.rb', line 16 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
#body ⇒ Object
The HTTP response body
46 47 48 |
# File 'lib/oauth2/response.rb', line 46 def body response.body || '' end |
#content_type ⇒ Object
Attempts to determine the content type of the response.
72 73 74 |
# File 'lib/oauth2/response.rb', line 72 def content_type ((response.headers.values_at('content-type', 'Content-Type').compact.first || '').split(';').first || '').strip end |
#headers ⇒ Object
The HTTP response headers
36 37 38 |
# File 'lib/oauth2/response.rb', line 36 def headers response.headers end |
#parsed ⇒ Object
The parsed response body.
Will attempt to parse application/x-www-form-urlencoded and
application/json Content-Type response bodies
66 67 68 69 |
# File 'lib/oauth2/response.rb', line 66 def parsed return nil unless PARSERS.key?(parser) @parsed ||= PARSERS[parser].call(body) end |
#parser ⇒ Object
Determines the parser that will be used to supply the content of #parsed
77 78 79 80 |
# File 'lib/oauth2/response.rb', line 77 def parser return [:parse].to_sym if PARSERS.key?([:parse]) CONTENT_TYPES[content_type] end |
#status ⇒ Object
The HTTP response status code
41 42 43 |
# File 'lib/oauth2/response.rb', line 41 def status response.status end |