Module: SeaFood

Defined in:
lib/sea_food.rb,
lib/sea_food/form.rb,
lib/sea_food/error.rb,
lib/sea_food/service.rb,
lib/sea_food/version.rb,
lib/sea_food/configuration.rb

Overview

SeaFood::Service class serves as a base for creating services. It standardizes the way services are called.

Defined Under Namespace

Classes: Configuration, Error, Form, Service

Constant Summary collapse

VERSION = 
'0.2.0'.freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.configuration ⇒ Object

Method to access the configuration



11
12
13
 
# File 'lib/sea_food/configuration.rb', line 11

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Method to configure the gem

Yields:



16
17
18
 
# File 'lib/sea_food/configuration.rb', line 16

def self.configure
  yield(configuration) if block_given?
end

Instance Method Details

#configuration ⇒ Object

Public: Returns SeaFood::Configuration instance.



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

def configuration
  @configuration ||= Configuration.new
end

#configuration=(configuration) ⇒ Object

Public: Sets SeaFood::Configuration instance.



24
25
26
27
28
 
# File 'lib/sea_food.rb', line 24

def configuration=(configuration)
  # need to reset SeaFood instance if configuration changes
  self.instance = nil
  @configuration = configuration
end

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

Yields SeaFood::Configuration instance.

Yields:



14
15
16
 
# File 'lib/sea_food.rb', line 14

def configure
  yield configuration if block_given?
end