Class: Cistern::Service

Inherits:
Object
  • Object
show all
Defined in:
lib/cistern/service.rb

Defined Under Namespace

Modules: Collections

Class Method Summary collapse

Class Method Details

.collection(collection_name, options = {}) ⇒ Object 



88
89
90
 
# File 'lib/cistern/service.rb', line 88

def collection(collection_name, options={})
  collections << [collection_name, options]
end

.collections ⇒ Object 



48
49
50
 
# File 'lib/cistern/service.rb', line 48

def collections
  @collections ||= []
end

.inherited(klass) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/cistern/service.rb', line 22

def inherited(klass)
  klass.class_eval <<-EOS, __FILE__, __LINE__
    module Collections
      include Cistern::Service::Collections

      def service
        #{klass.name}
      end
    end

    def self.service
      #{klass.name}
    end
  EOS

  klass.send(:const_set, :Timeout, Class.new(Cistern::Error))
end

.mock! ⇒ Object 



3
 
# File 'lib/cistern/service.rb', line 3

def self.mock!;    @mocking = true; end

.mocked_requests ⇒ Object 



80
81
82
 
# File 'lib/cistern/service.rb', line 80

def mocked_requests
  @mocked_requests ||= []
end

.mocking? ⇒ Boolean

Returns:

  • (Boolean) 


4
 
# File 'lib/cistern/service.rb', line 4

def self.mocking?; @mocking; end

.model(model_name, options = {}) ⇒ Object 



76
77
78
 
# File 'lib/cistern/service.rb', line 76

def model(model_name, options={})
  models << [model_name, options]
end

.model_path(model_path) ⇒ Object 



40
41
42
 
# File 'lib/cistern/service.rb', line 40

def model_path(model_path)
  @model_path = model_path
end

.models ⇒ Object 



52
53
54
 
# File 'lib/cistern/service.rb', line 52

def models
  @models ||= []
end

.new(options = {}) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/cistern/service.rb', line 142

def new(options={})
  validate_options(options)
  setup_requirements

  klass = self.const_get(self.mocking? ? :Mock : :Real)

  klass.send(:include, service::Collections)
  klass.send(:extend, Cistern::WaitFor)
  klass.timeout_error = service::Timeout
  klass.new(options)
end

.recognized_arguments ⇒ Object 



56
57
58
 
# File 'lib/cistern/service.rb', line 56

def recognized_arguments
  @recognized_arguments ||= []
end

.recognizes(*args) ⇒ Object 



72
73
74
 
# File 'lib/cistern/service.rb', line 72

def recognizes(*args)
  self.recognized_arguments.concat(args)
end

.request(request_name) ⇒ Object 



84
85
86
 
# File 'lib/cistern/service.rb', line 84

def request(request_name)
  requests << request_name
end

.request_path(request_path) ⇒ Object 



44
45
46
 
# File 'lib/cistern/service.rb', line 44

def request_path(request_path)
  @request_path = request_path
end

.requests ⇒ Object 



64
65
66
 
# File 'lib/cistern/service.rb', line 64

def requests
  @requests ||= []
end

.required_arguments ⇒ Object 



60
61
62
 
# File 'lib/cistern/service.rb', line 60

def required_arguments
  @required_arguments ||= []
end

.requires(*args) ⇒ Object 



68
69
70
 
# File 'lib/cistern/service.rb', line 68

def requires(*args)
  self.required_arguments.concat(args)
end

.reset! ⇒ Object 



154
155
156
 
# File 'lib/cistern/service.rb', line 154

def reset!
  self.const_get(:Mock).reset!
end

.setup_requirements ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/cistern/service.rb', line 105

def setup_requirements
  @required ||= false
  unless @required
    models.each do |model, options|
      require File.join(@model_path, model.to_s) unless options[:require] == false
      class_name = model.to_s.split("_").map(&:capitalize).join
      self.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__
        def #{model}(attributes={})
          #{service}::#{class_name}.new({connection: self}.merge(attributes))
        end
      EOS
    end
    requests.each do |request|
      require File.join(@request_path, request.to_s)
      if service::Mock.method_defined?(request)
        mocked_requests << request
      else
        service::Mock.module_eval <<-EOS, __FILE__, __LINE__
          def #{request}(*args)
            Cistern::Mock.not_implemented
          end
        EOS
      end
    end
    collections.each do |collection, options|
      require File.join(@model_path, collection.to_s) unless options[:require] == false
      class_name = collection.to_s.split("_").map(&:capitalize).join
      self.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__
        def #{collection}(attributes={})
          #{service}::#{class_name}.new({connection: self}.merge(attributes))
        end
      EOS
    end
    @required = true
  end
end

.unmock! ⇒ Object 



5
 
# File 'lib/cistern/service.rb', line 5

def self.unmock!;  @mocking = false; end

.validate_options(options = {}) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/cistern/service.rb', line 92

def validate_options(options={})
  required_options = Cistern::Hash.slice(options, *required_arguments)
  missing_required_options = required_arguments - required_options.keys
  unless missing_required_options.empty?
    raise "Missing required options: #{missing_required_options.inspect}"
  end
  recognized_options = Cistern::Hash.slice(options, *(required_arguments + recognized_arguments))
  unrecognized_options = options.keys - (required_arguments + recognized_arguments)
  unless unrecognized_options.empty?
    raise "Unrecognized options: #{unrecognized_options.inspect}"
  end
end