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 



110
111
112
 
# File 'lib/cistern/service.rb', line 110

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

.collection_path(collection_path) ⇒ Object 



58
59
60
 
# File 'lib/cistern/service.rb', line 58

def collection_path(collection_path)
  @collection_path = collection_path
end

.collections ⇒ Object 



70
71
72
 
# File 'lib/cistern/service.rb', line 70

def collections
  @collections ||= []
end

.inherited(klass) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/cistern/service.rb', line 22

def inherited(klass)
  klass.class_eval "    module Collections\n      include Cistern::Service::Collections\n\n      def service\n        \#{klass.name}\n      end\n    end\n\n    def self.service\n      \#{klass.name}\n    end\n\n    class Real\n      def initialize(options={})\n      end\n    end\n\n    class Mock\n      def initialize(options={})\n      end\n    end\n  EOS\n\n  klass.send(:const_set, :Timeout, Class.new(Cistern::Error))\n\n  klass::Mock.send(:include, klass::Collections)\n  klass::Mock.send(:extend, Cistern::WaitFor)\n  klass::Mock.send(:extend, Cistern::Data)\n  klass::Mock.timeout_error = klass::Timeout\n  klass::Real.send(:include, klass::Collections)\n  klass::Real.send(:extend, Cistern::WaitFor)\n  klass::Real.timeout_error = klass::Timeout\nend\n", __FILE__, __LINE__

.mock! ⇒ Object 



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

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

.mocked_requests ⇒ Object 



102
103
104
 
# File 'lib/cistern/service.rb', line 102

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 



98
99
100
 
# File 'lib/cistern/service.rb', line 98

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

.model_path(model_path) ⇒ Object 



62
63
64
 
# File 'lib/cistern/service.rb', line 62

def model_path(model_path)
  @model_path = model_path
end

.models ⇒ Object 



74
75
76
 
# File 'lib/cistern/service.rb', line 74

def models
  @models ||= []
end

.new(options = {}) ⇒ Object 



177
178
179
180
181
182
 
# File 'lib/cistern/service.rb', line 177

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

  self.const_get(self.mocking? ? :Mock : :Real).new(options)
end

.recognized_arguments ⇒ Object 



78
79
80
 
# File 'lib/cistern/service.rb', line 78

def recognized_arguments
  @recognized_arguments ||= []
end

.recognizes(*args) ⇒ Object 



94
95
96
 
# File 'lib/cistern/service.rb', line 94

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

.request(request_name) ⇒ Object 



106
107
108
 
# File 'lib/cistern/service.rb', line 106

def request(request_name)
  requests << request_name
end

.request_path(request_path) ⇒ Object 



66
67
68
 
# File 'lib/cistern/service.rb', line 66

def request_path(request_path)
  @request_path = request_path
end

.requests ⇒ Object 



86
87
88
 
# File 'lib/cistern/service.rb', line 86

def requests
  @requests ||= []
end

.required_arguments ⇒ Object 



82
83
84
 
# File 'lib/cistern/service.rb', line 82

def required_arguments
  @required_arguments ||= []
end

.requires(*args) ⇒ Object 



90
91
92
 
# File 'lib/cistern/service.rb', line 90

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

.reset! ⇒ Object 



184
185
186
 
# File 'lib/cistern/service.rb', line 184

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

.setup_requirements ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/cistern/service.rb', line 130

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

.unmock! ⇒ Object 



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

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

.validate_options(options = {}) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/cistern/service.rb', line 114

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

  unrecognized_options = options.keys - (required_arguments + recognized_arguments)

  unless unrecognized_options.empty?
    raise "Unrecognized options: #{unrecognized_options.inspect}"
  end
end