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 



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

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

.collection_path(collection_path) ⇒ Object 



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

def collection_path(collection_path)
  @collection_path = collection_path
end

.collections ⇒ Object 



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

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
 
# 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

    class Real
    end

    class Mock
    end
  EOS

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

  klass::Mock.send(:include, klass::Collections)
  klass::Mock.send(:extend, Cistern::WaitFor)
  klass::Mock.timeout_error = klass::Timeout
  klass::Real.send(:include, klass::Collections)
  klass::Real.send(:extend, Cistern::WaitFor)
  klass::Real.timeout_error = klass::Timeout
end

.mock! ⇒ Object 



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

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

.mocked_requests ⇒ Object 



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

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 



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

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

.model_path(model_path) ⇒ Object 



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

def model_path(model_path)
  @model_path = model_path
end

.models ⇒ Object 



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

def models
  @models ||= []
end

.new(options = {}) ⇒ Object 



166
167
168
169
170
171
 
# File 'lib/cistern/service.rb', line 166

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

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

.recognized_arguments ⇒ Object 



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

def recognized_arguments
  @recognized_arguments ||= []
end

.recognizes(*args) ⇒ Object 



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

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

.request(request_name) ⇒ Object 



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

def request(request_name)
  requests << request_name
end

.request_path(request_path) ⇒ Object 



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

def request_path(request_path)
  @request_path = request_path
end

.requests ⇒ Object 



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

def requests
  @requests ||= []
end

.required_arguments ⇒ Object 



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

def required_arguments
  @required_arguments ||= []
end

.requires(*args) ⇒ Object 



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

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

.reset! ⇒ Object 



173
174
175
 
# File 'lib/cistern/service.rb', line 173

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

.setup_requirements ⇒ Object 



122
123
124
125
126
127
128
129
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
 
# File 'lib/cistern/service.rb', line 122

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(request)
          end
        EOS
      end
    end
    collections.each do |collection, options|
      unless options[:require] == false
        if @collection_path
          require File.join(@collection_path, collection.to_s)
        else
          require File.join(@model_path, collection.to_s)
        end
      end

      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 



109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/cistern/service.rb', line 109

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