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,
  :logger,
  :logging_enabled
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#auth_token ⇒ Object

The Authorization token



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

def auth_token
  @auth_token
end

#disabled ⇒ Object Also known as: disabled?

FIXME



24
25
26
 
# File 'lib/attune/configurable.rb', line 24

def disabled
  @disabled
end

#endpoint ⇒ Object

The HTTP endpoint to connect to



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

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



39
40
41
 
# File 'lib/attune/configurable.rb', line 39

def exception_handler
  @exception_handler
end

#logger ⇒ Object

Logger to write request statistics to



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

def logger
  @logger
end

#logging_enabled ⇒ Object

Turn request logging on



34
35
36
 
# File 'lib/attune/configurable.rb', line 34

def logging_enabled
  @logging_enabled
end

#middleware ⇒ Object

Middleware used by faraday



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

def middleware
  @middleware
end

#timeout ⇒ Object

Time (in seconds) to wait for requests to finish



28
29
30
 
# File 'lib/attune/configurable.rb', line 28

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:



53
54
55
 
# File 'lib/attune/configurable.rb', line 53

def configure
  yield self
end