genghis 1.0.4 → 1.2

data/README.rdoc

@@ -2,18 +2,18 @@
 
 == What is Genghis?
 * A configuration framework for mongoDB
-* A resilience framework when using MongoDB in replica pairs
+* A resilience framework when using MongoDB in replica sets
 
 == Getting started
 
 === Configuration
-
+Genghis 1.2 is for use with MongoDB 1.6 or above; for MongoDB < 1.6, use Genghis 1.0.4
 
 When invoked from rails, Genghis looks for a file called mongodb.yml in the RAILS_ROOT/config directory.
 the format of this file closely mimics that of the database.yml file you know well.
 
        development:
-            servers: localhost:27017
+            server: mongodb://localhost
             databases:
                 paperclip : 'paperclip_files'
                 mongo_mapper : 'mongo_mapper'
@@ -21,22 +21,28 @@ the format of this file closely mimics that of the database.yml file you know we
                 pool_size: 7
                 timeout: 2
 
-In this case, we have a single mongodb server at localhost:2701. The database defines an alias for each
+In this case, we have a single mongodb server at localhost:27017. The database defines an alias for each
 actual mongo database in your mongodb server. You can then look up the databases by the alias later.
 The connection_options hash is passed directly to the mongo connection constructor.
 
-=== Paired configuration
+
+=== Replica Sets
 
 
-If you are using replica pairs, the configuration varies somewhat.
+If you are using replica sets, the configuration varies somewhat.
 
     development:
-        servers:
-            -_host:27017
-            - right_host:27017
+        replica_set:
+            - mongodb://replica1
+            - mongodb://replica2
         databases:
             paperclip : 'paperclip_files'
             ...
+        authorization:
+            paperclip:
+                username: pc
+                password: secretpassword
+            ...
         connection_options:
             max_retries: 7
             pool_size: 5
@@ -63,6 +69,8 @@ the following:
 Database names can then be used to configure mongo mapper or any other frameworks you have
 
     MongoMapper.database = Genghis.databases['mongo_mapper']
+    or
+    MongoMapper.database = Genghis.database[:mongo_mapper]
 
 Similarly you can retrieve the actual mongo database
 
@@ -74,14 +82,14 @@ Similarly you can retrieve the actual mongo database
 
 
 While MongoDB provides impressive levels of stability and failover, its driver design leaves failover
-up to the implementor. This leaves your application subject to connection exceptions that can happen
+up to the implementer. This leaves your application subject to connection exceptions that can happen
 at any time, possibly littering your code with ugly and difficult to maintain reconnect logic.
 Genghis's resilience framework solves this for you.
 
 === Setup
 
 
-To make an object resilient, you must first have a replica pair of MongoDB servers. After you have
+To make an object resilient, you must first have a replica set of MongoDB servers. After you have
 that set up, you're ready to make your objects robust.
 
 The following examples will assume you have a mongo_mapper object with the following definition:
@@ -107,7 +115,7 @@ Then you need to need to enlist Genghis's guardian class, which is a protective
             key :bar, String
             key :baz, Integer
         end
-   end
+    end
 
    class Foo < Genghis::Guardian
       protects Unsafe::Foo
@@ -122,7 +130,7 @@ watching over its shoulder, protecting you from any connection related problems.
 
 Let's say that while you are executing an update and a connection error occurs. Genghis's guardian
 realizes something has gone wrong and invalidates the current connection. It then tries to make a
-new connection to the other server in the replica pair. If that succeeds, it then re-tries the code
+new connection to the other server in the replica set. If that succeeds, it then re-tries the code
 that was executing when the failure occurs. It then keeps using this connection.
 
 If the second connection fails, it then reverts to the first server in the list. Genghis will flit

data/lib/genghis.rb

@@ -1,25 +1,52 @@
 require 'yaml'
 require 'mongo'
+require 'uri'
 
 class Genghis
   include Mongo
 
+  def self.hosts
+    @@hosts
+  end
+
+  def self.hosts=(host_list)
+    @@hosts = host_list
+  end
+
   def self.config=(path)
     @@config_file = path
   end
 
   def self.environment=(environment = :development)
-    yaml = YAML.load_file(config_file)
-    @@config = yaml[environment.to_s]
+    yaml        = YAML.load_file(config_file)
+    @connection = nil
+    @@config    = yaml[environment.to_s]
     @@config.each do |k, v|
-      self.class.instance_eval do
-        define_method(k.to_sym){v}
+      if k == 'server'
+        self.hosts = parse_mongo_urls([v])
+      elsif k == 'replica_set'
+        self.hosts = parse_mongo_urls(v)
+      else
+        self.class.instance_eval do
+          v = HashWithConsistentAccess.new(v) if v.is_a?(::Hash)
+          define_method(k.to_sym) { v }
+        end
       end
     end
+    parse_connection_options unless @@config['connection_options'].nil?
+    nil
+  end
+
+  def self.on_failure(&block)
+    @failure_method = block if block_given?
+  end
+
+  def self.failure_callback
+    @failure_method
   end
 
   def self.connection
-    @connection || safe_create_connection
+    @connection ||= safe_create_connection
   end
 
   def self.database(db_alias)
@@ -32,6 +59,23 @@ class Genghis
 
   private
 
+  def self.parse_connection_options
+    @@connection_options ||= symbolize_keys(default_connection_options.merge(@@config['connection_options']))
+    @@retries            ||= @@connection_options.delete(:max_retries)
+    @@connection_options
+  end
+
+  def self.parse_mongo_urls(urls)
+    urls.collect do |url|
+      uri = URI.parse(url)
+      {:host     => uri.host,
+       :port     => uri.port || 27017,
+       :username => uri.user,
+       :password => uri.password,
+      }
+    end
+  end
+
   def self.config_file
     if defined? @@config_file
       @@config_file
@@ -41,36 +85,53 @@ class Genghis
     end
   end
 
+  def self.max_retries=(num)
+    @@retries = num
+  end
+
   def self.max_retries
     connection_options
-    @@retries || 5
+    @@retries ||= 5
+  end
+
+  def self.sleep_time=(num)
+    @@sleep_time = num
+  end
+
+  def self.sleep_time
+    @@sleep_time || 1
   end
 
   def self.connection_options
-    @@connection_options ||= symbolize_keys((@@config['connection_options']) || default_connection_options)
-    @@retries ||= @@connection_options.delete(:max_retries)
-    @@connection_options
+    @@connection_options ||= parse_connection_options
   end
 
   def self.default_connection_options
     {:max_retries => 5,
-     :pool_size => 5,
-     :timeout => 5,
-     :use_slave => false
+     :pool_size   => 5,
+     :timeout     => 5,
+     :slave_ok    => false
     }
   end
 
   def self.safe_create_connection
     opts = connection_options
-    if self.servers.is_a? Array
-      servers = self.servers.collect{|x| parse_host(x)}
-      puts "Multi called with #{servers.inspect} #{opts.inspect}"
-
+    if self.hosts.size > 1
+      servers    = self.hosts.collect { |x| [x[:host], x[:port]] }
       connection = Connection.multi(servers, opts)
     else
-      host, port = parse_host(self.servers)
-      connection = Connection.new(host, port, opts)
+      host       = self.hosts.first
+      connection = Connection.new(host[:host], host[:port], opts)
+    end
+
+    if self.hosts.first[:username]
+      auth = self.hosts.first
+      self.databases.each_pair do |k, db|
+        connection.add_auth(db.to_s, auth[:username], auth[:password])
+      end
+      connection.apply_saved_authentication
     end
+
     connection
   end
 
@@ -81,7 +142,7 @@ class Genghis
   end
 
   def self.symbolize_keys(hash)
-    hash.inject({}){|memo, (k, v)| memo[k.to_sym] = v; memo}
+    hash.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo }
   end
 
 
@@ -91,6 +152,13 @@ class Genghis
       mod.class_eval do
         extend ClassMethods
       end
+
+    end
+
+    module InstanceMethods
+      def safe?
+        true
+      end
     end
 
     module ClassMethods
@@ -98,16 +166,21 @@ class Genghis
 
       def protects(clazz)
         Guardian.add(clazz)
+        Guardian.add_protected_class(self, clazz)
         @protected_class= clazz
       end
 
+      def protected_class
+        @protected_class
+      end
+
       def protected?(clazz)
         @@protected_classes.include? clazz
       end
 
-      def method_missing(method, *args, &block)
+      def method_missing(method, * args, & block)
         protect_from_exception do
-          Guardian.make_safe(@protected_class.__send__(method, *args, &block))
+          Guardian.make_safe(@protected_class.__send__(method, * args, & block))
         end
       end
 
@@ -119,22 +192,23 @@ class Genghis
         true
       end
 
-      def protect_from_exception(&block)
-        success = false
+      def protect_from_exception(& block)
+        success     = false
         max_retries = Genghis.max_retries
-        retries = 0
-        rv = nil
+        retries     = 0
+        rv          = nil
         while !success
           begin
-            rv = yield
+            rv      = yield
             success = true
           rescue Mongo::ConnectionFailure => ex
-            Rails.logger.fatal('Mongo has died ', ex)
-            WebServiceFailed.deliver_mongo_down(ex, Genghis.connection)
+            if Genghis.failure_callback
+              Genghis.failure_callback.call(ex, Genghis.connection)
+            end
             retries += 1
             raise ex if retries > max_retries
             fix_broken_connection
-            sleep(1)
+            sleep(Genghis.sleep_time)
           end
         end
         rv
@@ -142,22 +216,65 @@ class Genghis
 
       def fix_broken_connection
         Genghis.reconnect
-        MongoMapper.connection = Genghis.connection
-        MongoMapper.database = Genghis.databases['mongo_mapper']
+        if defined?(MongoMapper)
+          MongoMapper.connection = Genghis.connection
+          MongoMapper.database   = Genghis.databases['mongo_mapper']
+        end
+      end
+    end
+  end
+
+  class HashWithConsistentAccess
+
+    def initialize(proxied={})
+      @proxied = proxied.inject({}) do |memo, (k, v)|
+        memo[k.to_s] = v
+        memo
+      end
+    end
+
+    def each_pair(&block)
+      @proxied.each_pair do |k, v|
+        yield(k.to_s, v)
       end
     end
+
+    def []=(key, value)
+      @proxied[key.to_s] = value
+    end
+
+    def [](key)
+      @proxied[key.to_s]
+    end
+
+    def key?(key)
+      @proxied.key?(key.to_s)
+    end
+
+    def inspect
+      @proxied.inspect
+    end
   end
 
 
   class Guardian
     alias_method :old_class, :class
-    instance_methods.each { |m| undef_method m unless m =~ /^__|^old/}
+    instance_methods.each { |m| undef_method m unless m =~ /^__|^old/ }
 
     include ProxyMethods
 
-    def initialize(*args)
+    def self.add_protected_class(subclass, protected_class)
+      @@protected_mappings                  ||= {}
+      @@protected_mappings[protected_class] = subclass
+    end
+
+    def self.protected_mappings
+      @@protected_mappings
+    end
+
+    def initialize(* args)
 
-      opts = args.extract_options!
+      opts = args.last.is_a?(Hash) ? args.last : {}
       if opts.empty?
         if args.empty?
           what = self.old_class.protected_class.new
@@ -179,7 +296,7 @@ class Genghis
       protected_classes << clazz
     end
 
-    def self.under_protection?(clazz)
+    def self.protecting?(clazz)
       protected_classes.include?(clazz)
     end
 
@@ -188,21 +305,32 @@ class Genghis
     end
 
     def self.make_safe(o)
+
       if o.is_a? Array
-        Guardian.under_protection?(o.first.class) ? ArrayProxy.new(o) : o
+        Guardian.protecting?(o.first.class) ? ArrayProxy.new(o) : o
       else
-        Guardian.under_protection?(o.class) ? Guardian.new(o) : o
+        class_providing_protection = protected_mappings[o.class] || Guardian
+        Guardian.protecting?(o.class) ? class_providing_protection.new(o) : o
       end
     end
 
+    def unprotected_object
+      @protected
+    end
+
 
-    def method_missing(method, *args, &block)
+    def method_missing(method, * args, & block)
       return true if method == :safe?
       self.old_class.protect_from_exception do
-        Guardian.make_safe(@protected.__send__(method, *args, &block))
+        Guardian.make_safe(@protected.__send__(method, * args, & block))
       end
     end
 
+
+    class << self
+      alias_method :under_protection?, :protecting?
+    end
+
   end
 
   class ArrayProxy < Guardian
@@ -213,4 +341,5 @@ class Genghis
     end
   end
 
-end
+
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: genghis
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 11
   prerelease: false
   segments: 
   - 1
-  - 0
-  - 4
-  version: 1.0.4
+  - 2
+  version: "1.2"
 platform: ruby
 authors: 
 - Steve Cohen
@@ -15,7 +14,7 @@ autorequire: genghis
 bindir: bin
 cert_chain: []
 
-date: 2010-08-31 00:00:00 -07:00
+date: 2010-11-30 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,11 +25,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 45
+        hash: 19
         segments: 
+        - 1
+        - 1
         - 0
-        - 19
-        version: "0.19"
+        version: 1.1.0
   type: :runtime
   version_requirements: *id001
 description: