Class: BlueFactory::RequestContext

Inherits:
Object
  • Object
show all
Defined in:
lib/blue_factory/request_context.rb

Overview

An object which provides some metadata about the getFeedSkeleton request being processed. The context is passed to the FeedHandler#get_posts method of the provided feed handler object, if the method is made to accept two parameters.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request) ⇒ RequestContext

Returns a new instance of RequestContext.

Parameters:



24
25
26
# File 'lib/blue_factory/request_context.rb', line 24

def initialize(request)
  @request = request
end

Instance Attribute Details

#requestSinatra::Request (readonly)

Returns the underlying request object.

Returns:



18
19
20
# File 'lib/blue_factory/request_context.rb', line 18

def request
  @request
end

Instance Method Details

#envHash

The request environment hash.

Returns:

  • (Hash)

    Rack environment



32
33
34
# File 'lib/blue_factory/request_context.rb', line 32

def env
  @request.env
end

#has_auth?Boolean

Indicates if an authorization header was provided at all or not.

Returns:

  • (Boolean)

    true when the authorization header is non-empty



48
49
50
# File 'lib/blue_factory/request_context.rb', line 48

def has_auth?
  env['HTTP_AUTHORIZATION'] != nil
end

#userUserInfo

Parsed user information derived from the authorization header.

Returns:



40
41
42
# File 'lib/blue_factory/request_context.rb', line 40

def user
  UserInfo.new(env['HTTP_AUTHORIZATION'])
end