Class: Yodeler::Endpoint

Inherits:

Object

• Object
• Yodeler::Endpoint

Defined in:

lib/yodeler/endpoint.rb

Instance Attribute Summary

• #adapter ⇒ Object readonly

  Returns the value of attribute adapter.

• #name ⇒ Object readonly

  Returns the value of attribute name.

Instance Method Summary

• #initialize(name) {|_self| ... } ⇒ Endpoint constructor

  A new instance of Endpoint.

• #use(name) {|@adapter| ... } ⇒ ~Yodeler::Adapters::Base

  Set the adapter this endpoint will use.

Constructor Details

#initialize(name) {|_self| ... } ⇒ Endpoint

Returns a new instance of Endpoint.

Yields:

• (_self)

Yield Parameters:

• _self (Yodeler::Endpoint) —

  the object that the method was called on

# File 'lib/yodeler/endpoint.rb', line 6

def initialize(name)
  @name = name
  yield(self) if block_given?
end

Instance Attribute Details

#adapter ⇒ Object (readonly)

Returns the value of attribute adapter.

# File 'lib/yodeler/endpoint.rb', line 4

def adapter
  @adapter
end

#name ⇒ Object (readonly)

Returns the value of attribute name.

# File 'lib/yodeler/endpoint.rb', line 3

def name
  @name
end

Instance Method Details

#use(name) {|@adapter| ... } ⇒ ~Yodeler::Adapters::Base

Set the adapter this endpoint will use

Examples:

endpoint = Yodeler::Endpoint.new(:dashboard)
endpoint.use(:http)

endpoint = Yodeler::Endpoint.new(:dashboard)
endpoint.use(:http) do |http|
  #your adapter setup here
end

Parameters:

• name (Symbol) —

  the registered name of the adapter

Yields:

• (@adapter)

Returns:

• (~Yodeler::Adapters::Base) —

  yodeler adapter

# File 'lib/yodeler/endpoint.rb', line 25

def use(name)
  @adapter = Yodeler.registered_adapters(name).new
  yield(@adapter) if block_given?
  @adapter
end