Module: Muve

Defined in:
lib/muve.rb,
lib/muve/model.rb,
lib/muve/place.rb,
lib/muve/store.rb,
lib/muve/errors.rb,
lib/muve/helpers.rb,
lib/muve/version.rb,
lib/muve/location.rb,
lib/muve/movement.rb,
lib/muve/traveller.rb

Overview

Muve

The muve gem provides a abstraction layer for the Muve resources which include:

  • locations, the places of interest to be travelled to and fro

  • travellers, the wonderful creatures doing the travelling

  • movements, the appearances of a traveller at a location

Although the gem is named muve which is short and sweet, the codename for the project is Muvement because is serves as a tool to help with geolocation services.

This gem is mostly for internal use and I expect it to be refactored numerous times to improve its usability and implementation.

Defined Under Namespace

Modules: Error, Helper, Model, Store Classes: Location, Movement, Place, Traveller

Constant Summary collapse

VERSION = 
"1.2.1"

Class Method Summary collapse

Class Method Details

.init(connection = nil, database = nil) ⇒ Object

Initialize Muve with an optional connection to the datastore. This could be a MongoDB or PostgreSQL connection for instance. Besides a connection, an adaptor will be needed to actually handle the interaction between the models and the datastore through the given connection.



70
71
72
73
 
# File 'lib/muve.rb', line 70

def self.init(connection=nil, database=nil)
  Model.connection = connection if connection
  Model.database = database if database
end

.raise_something ⇒ Object

Raises:

  • (NotConfigured) 


75
76
77
 
# File 'lib/muve.rb', line 75

def self.raise_something
  raise NotConfigured
end