Module: Cistern::Client::ClassMethods

Defined in:
lib/cistern/client.rb

Instance Method Summary collapse

Instance Method Details

#collections ⇒ Object 



164
165
166
 
# File 'lib/cistern/client.rb', line 164

def collections
  @collections ||= []
end

#mock! ⇒ Object 



160
 
# File 'lib/cistern/client.rb', line 160

def mock!;    @mocking = true; end

#mocking? ⇒ Boolean

Returns:

  • (Boolean) 


161
 
# File 'lib/cistern/client.rb', line 161

def mocking?; @mocking; end

#models ⇒ Object 



168
169
170
 
# File 'lib/cistern/client.rb', line 168

def models
  @_models ||= []
end

#new(options = {}) ⇒ Object 



246
247
248
249
250
251
 
# File 'lib/cistern/client.rb', line 246

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

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

#recognized_arguments ⇒ Object 



176
177
178
 
# File 'lib/cistern/client.rb', line 176

def recognized_arguments
  @_recognized_arguments ||= []
end

#recognizes(*args) ⇒ Object 



192
193
194
 
# File 'lib/cistern/client.rb', line 192

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

#requests ⇒ Object 



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

def requests
  @_requests ||= []
end

#required_arguments ⇒ Object 



180
181
182
 
# File 'lib/cistern/client.rb', line 180

def required_arguments
  @_required_arguments ||= []
end

#requires(*args) ⇒ Object 



188
189
190
 
# File 'lib/cistern/client.rb', line 188

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

#reset! ⇒ Object 



253
254
255
 
# File 'lib/cistern/client.rb', line 253

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

#setup ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/cistern/client.rb', line 212

def setup
  return true if @_setup

  requests.each do |klass|
    name = klass.service_method ||
      Cistern::String.camelize(Cistern::String.demodulize(klass.name))

    Cistern::Request.service_request(self, klass, name)
  end

  collections.each do |klass|
    name = klass.service_method ||
      Cistern::String.underscore(klass.name.gsub("#{self.name}::", "").gsub("::", ""))

    Cistern::Collection.service_collection(self, klass, name)
  end

  models.each do |klass|
    name = klass.service_method ||
      Cistern::String.underscore(klass.name.gsub("#{self.name}::", "").gsub("::", ""))

    Cistern::Model.service_model(self, klass, name)
  end

  singularities.each do |klass|
    name = klass.service_method ||
      Cistern::String.underscore(klass.name.gsub("#{self.name}::", "").gsub("::", ""))

    Cistern::Singular.service_singular(self, klass, name)
  end

  @_setup = true
end

#singularities ⇒ Object 



172
173
174
 
# File 'lib/cistern/client.rb', line 172

def singularities
  @_singularities ||= []
end

#unmock! ⇒ Object 



162
 
# File 'lib/cistern/client.rb', line 162

def unmock!;  @mocking = false; end

#validate_options(options = {}) ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/cistern/client.rb', line 196

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