Module: Attune::Configurable

Included in:
Client, Default
Defined in:
lib/attune/configurable.rb

Constant Summary collapse

KEYS = 
[
  :auth_token,
  :endpoint,
  :middleware,
  :disabled,
  :exception_handler,
  :timeout
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#auth_token ⇒ Object

The Authorization token



13
14
15
 
# File 'lib/attune/configurable.rb', line 13

def auth_token
  @auth_token
end

#disabled ⇒ Object Also known as: disabled?

FIXME



22
23
24
 
# File 'lib/attune/configurable.rb', line 22

def disabled
  @disabled
end

#endpoint ⇒ Object

The HTTP endpoint to connect to



16
17
18
 
# File 'lib/attune/configurable.rb', line 16

def endpoint
  @endpoint
end

#exception_handler ⇒ Object

How to deal with HTTP exceptions

Parameters:

  • handler (:mock, :raise) —

    Method used for handling exceptions.

Raises:

  • (ArgumentError) —

    if handler is not :mock or :raise



31
32
33
 
# File 'lib/attune/configurable.rb', line 31

def exception_handler
  @exception_handler
end

#middleware ⇒ Object

Middleware used by faraday



19
20
21
 
# File 'lib/attune/configurable.rb', line 19

def middleware
  @middleware
end

#timeout ⇒ Object

Time (in seconds) to wait for requests to finish



26
27
28
 
# File 'lib/attune/configurable.rb', line 26

def timeout
  @timeout
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Examples:

configure

Attune.configure do |c|
  c.endpoint = "http://example.com:8080/"
  c.timeout  = 5
end

Yields:

  • (_self)

Yield Parameters:



45
46
47
 
# File 'lib/attune/configurable.rb', line 45

def configure
  yield self
end