Class: EightBall::Providers::Http

Inherits:

Object

• Object
• EightBall::Providers::Http

Defined in:

lib/eight_ball/providers/http.rb

Overview

An HTTP Provider will make a GET request to a given URI, and convert the response into an array of Features using the given Marshaller.

The Features will be automatically kept up to date according to the given RefreshPolicy.

Constant Summary

SUPPORTED_SCHEMES =

%w[http https].freeze

Instance Attribute Summary

• #marshaller ⇒ Object readonly

  Returns the value of attribute marshaller.

Instance Method Summary

• #features ⇒ Array<{EightBall::Feature}>

  Returns the current Features.

• #initialize(uri, options = {}) ⇒ Http constructor

  A new instance of Http.

Constructor Details

#initialize(uri, options = {}) ⇒ Http

Returns a new instance of Http.

Examples:

provider = EightBall::Providers::Http.new(
  'http://www.rewind.io',
  refresh_policy: EightBall::Providers::RefreshPolicies::Interval.new 120
)

Parameters:

• uri (String) —

  The URI to GET the Features from.

• options (Hash) (defaults to: {}) —

  The options to create the Provider with.

Options Hash (options):

• :marshaller (EightBall::Marshallers) —

  The Marshaller used to convert the response to an array of Features. Defaults to an instance of Marshallers::Json

• :refresh_policy (EightBall::Providers::RefreshPolicies) —

  The Policy used to determine when the Features have gone stale and need to be refreshed. Defaults to an instance of RefreshPolicies::Interval

Raises:

• (ArgumentError)

# File 'lib/eight_ball/providers/http.rb', line 36

def initialize(uri, options = {})
  raise ArgumentError, 'Invalid HTTP/HTTPS URI provided' unless uri =~ URI.regexp(SUPPORTED_SCHEMES)

  @uri = URI.parse uri

  @marshaller = options[:marshaller] || EightBall::Marshallers::Json.new
  @policy = options[:refresh_policy] || EightBall::Providers::RefreshPolicies::Interval.new
end

Instance Attribute Details

#marshaller ⇒ Object (readonly)

Returns the value of attribute marshaller.

# File 'lib/eight_ball/providers/http.rb', line 15

def marshaller
  @marshaller
end

Instance Method Details

#features ⇒ Array<{EightBall::Feature}>

Returns the current Features.

Returns:

• (Array<{EightBall::Feature}>)

# File 'lib/eight_ball/providers/http.rb', line 47

def features
  @policy.refresh { fetch }
  @features
end