ar-octopus 0.0.30 → 0.1.0

data/Gemfile

@@ -1,9 +1,12 @@
-source :gemcutter
+source :rubygems
 
-gem "rspec", "2.0.0.beta.19"
-gem "mysql", ">= 2.8.1"
-gem "pg", ">= 0.9.0"
-gem "sqlite3-ruby", ">= 1.3.1"
 gem 'activerecord', '>= 3.0.0.rc'
 gem 'actionpack', '>= 3.0.0.rc'
-gem "jeweler", ">= 1.4"
+
+group :test do
+	gem "jeweler", ">= 1.4"
+	gem "rspec", "2.0.0.beta.19"
+	gem "mysql", ">= 2.8.1"
+	gem "pg", ">= 0.9.0"
+	gem "sqlite3-ruby", ">= 1.3.1"
+end

data/README.mkdn

@@ -1,9 +1,9 @@
 # Octopus  - Easy Database Sharding for ActiveRecord
 
-Octopus is a better way to do Database Sharding in ActiveRecord. Sharding allows multiple databases in the same rails application. While there are several projects that implement Sharding (e.g. DbCharmer, DataFabric, MultiDb), each project has its own limitations. The main goal of octopus project is to provide a nice and clean way of doing Database Sharding.
+Octopus is a better way to do Database Sharding in ActiveRecord. Sharding allows multiple databases in the same rails application. While there are several projects that implement Sharding (e.g. DbCharmer, DataFabric, MultiDb), each project has its own limitations. The main goal of octopus project is to provide a better way of doing Database Sharding.
 
 ## Feature list:
-The design of the api is made to be simple as possible. Octopus is focusing in the end user, giving the power of multiple databases, but with reliable code and flexibility. Octopus is focused on Rails 3, but is compatible with Rails 2.x.
+The api is designed to be simple as possible. Octopus focuses on the end user, giving the power of multiple databases but with reliable code and flexibility. Octopus is focused on Rails 3, but is compatible with Rails 2.x.
 
 Octopus supports:
 
@@ -16,10 +16,10 @@ Octopus supports:
 When using replication, all writes queries will be sent to master, and read queries to slaves. More info could be found at: <a href="http://wiki.github.com/tchandy/octopus/replication"> Wiki</a>
 
 ### Sharding
- When using sharding, you need to specify what shard the query will be sent. Octopus support selecting the shard inside a controller, or manually in each object. More could be found at <a href="http://wiki.github.com/tchandy/octopus/sharding"> Wiki</a> 
+ When using sharding, you need to specify which shard to send the query. Octopus supports selecting the shard inside a controller, or manually in each object. More could be found at <a href="http://wiki.github.com/tchandy/octopus/sharding"> Wiki</a> 
 
 ### Replication + Sharding
- Replication + Sharding isn't supported yet. This is in our todo, and will be done ASAP. if you need, feel free to fork and implement it.
+ Replication + Sharding isn't supported yet. This is on our TODO list and will be done ASAP. If you need, feel free to fork and implement it.
 
 ## Install 
 
@@ -45,17 +45,17 @@ First, you need to create a config file, shards.yml, inside your config/ directo
 
 ### Syntax 
 
-Octopus adds a method to each AR Class and object. the using method is used to select the shard, like this: 
+Octopus adds a method to each AR Class and object: the using method is used to select the shard like this: 
 <pre>User.where(:name => "Thiago").limit(3).using(:slave_one) </pre>
 
- Octopus also supports queries inside block. When you pass a block to the using method, all queries inside the block will be sent to the specified shard. 
+Octopus also supports queries within a block. When you pass a block to the using method, all queries inside the block will be sent to the specified shard. 
 <pre>
 Octopus.using(:slave_two) do 
   User.create(:name => "Mike")
 end
 </pre>
 
- Each object knows where is your shard, so you could to thinks like this:
+Each model instance knows which shard it came from so this will work automatically:
 <pre> 
 # This will find the user in the shard1
 @user = User.using(:shard1).find_by_name("Joao")
@@ -67,12 +67,12 @@ end
 @user.name = "Mike"
 
 # Save the user in the correct shard, shard1. 
-@user.save()
+@user.save
 </pre>
 
 ### Migrations
 
- In migrations, you also have access to the using method. The syntax is basically the same. This migration will run in brazil and canada shards.
+In migrations, you also have access to the using method. The syntax is basically the same. This migration will run in the brazil and canada shards.
 <pre>
   class CreateUsersOnBothShards < ActiveRecord::Migration
     using(:brazil, :canada)
@@ -82,11 +82,12 @@ end
     end
 
     def self.down
-      User.delete_all()
+      User.delete_all
     end
   end
 </pre>
- You also could send a migration to a group of shards.  This migration will be sent to all shards that belongs to history_shards group, specified in shards.yml: 
+
+You also could send a migration to a group of shards.  This migration will be sent to all shards that belongs to history_shards group, specified in shards.yml: 
 <pre>
   class CreateUsersOnMultiplesGroups < ActiveRecord::Migration
     using_group(:history_shards)
@@ -96,7 +97,7 @@ end
     end
 
     def self.down
-      User.delete_all()
+      User.delete_all
     end
   end
 </pre>
@@ -109,27 +110,34 @@ If you want to send a specified action, or all actions from a controller, to a s
   class ApplicationController < ActionController::Base
     around_filter :select_shard      
     
-    def select_shard
-      Octopus.using(:brazil) do
-        yield
-      end
+    def select_shard(&block)
+      Octopus.using(:brazil, &block)
     end    
   end
 </pre>
 
  To see the complete list of features and syntax, please check out our <a href="http://wiki.github.com/tchandy/octopus/"> Wiki</a>
-Wanna see sample rails applications using octopus features? please check it out: <a href="http://github.com/tchandy/octopus_sharding_example">Sharding Example</a> and <a href="http://github.com/tchandy/octopus_replication_example">Replication Example</a>. Also, we have a example that shows how to use Octopus without Rails: <a href="http://github.com/tchandy/octopus_sinatra"> Octopus + Sinatra Example</a>.
+Want to see sample rails applications using octopus features? please check it out: <a href="http://github.com/tchandy/octopus_sharding_example">Sharding Example</a> and <a href="http://github.com/tchandy/octopus_replication_example">Replication Example</a>. Also, we have an example that shows how to use Octopus without Rails: <a href="http://github.com/tchandy/octopus_sinatra"> Octopus + Sinatra Example</a>.
+
+
+## Important!
+Sometimes, when a connection isn't used for much time, this will makes ActiveRecord raising an exception. if you have this kind of applications, please, add the following line to your configuration:
+
+<pre>
+verify_connection: true
+</pre>
 
+This will tell Octopus to verify the connection before sending the query.
 
 ## Contributing with Octopus
-Contributors are welcome! To run the test suite, you need mysql, postgresql and sqlite3 installed. In order to install necessary gems, this is what you need to setup your Octopus development environment:
+Contributors are welcome! To run the test suite, you need mysql, postgresql and sqlite3 installed. This is what you need to setup your Octopus development environment:
 
 <pre>
   git clone http://github.com/tchandy/octopus.git
   cd octopus
   bundle install
   rake db:prepare
-  rake spec
+  rake
 </pre>
 
 To run our integrations tests inside sample_app, you need to following commands:
@@ -140,7 +148,7 @@ To run our integrations tests inside sample_app, you need to following commands:
   cucumber
 </pre>
 
-If you are having issues with octopus spec suite, check all databases password inside the config files, and make sure that your passwords/permissions are right.
+If you are having issues running the octopus spec suite, verify your database users and passwords match those inside the config files and your permissions are correct.
 
 ## Thanks
 

data/Rakefile

@@ -37,7 +37,7 @@ begin
     gem.add_development_dependency "jeweler", ">= 1.4"
     gem.add_development_dependency "actionpack", ">= 2.3"
     gem.add_dependency('activerecord', '>= 2.3')
-    gem.version = "0.0.30"
+    gem.version = "0.1.0"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/ar-octopus.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ar-octopus}
-  s.version = "0.0.30"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thiago Pradi", "Mike Perham"]
-  s.date = %q{2010-08-14}
+  s.date = %q{2010-08-20}
   s.description = %q{This gem allows you to use sharded databases with ActiveRecord. this also provides a interface for replication and for running migrations with multiples shards.}
   s.email = %q{tchandy@gmail.com}
   s.extra_rdoc_files = [

data/lib/octopus.rb

@@ -50,9 +50,10 @@ module Octopus
   
   def self.using(shard, &block)
     ActiveRecord::Base.hijack_initializer()
-
-    if ActiveRecord::Base.connection.is_a?(Octopus::Proxy)
-      ActiveRecord::Base.connection.run_queries_on_shard(shard, &block)
+    conn = ActiveRecord::Base.connection
+    
+    if conn.is_a?(Octopus::Proxy)
+      conn.run_queries_on_shard(shard, &block)
     else
       yield
     end

data/lib/octopus/model.rb

@@ -42,7 +42,6 @@ module Octopus::Model
     end
 
     def hijack_connection()
-      
       def self.should_use_normal_connection?
         defined?(Rails) && Octopus.config() && !Octopus.enviroments.include?(Rails.env.to_s)
       end

data/lib/octopus/proxy.rb

@@ -11,6 +11,13 @@ class Octopus::Proxy
     @groups = {}
     @shards[:master] = ActiveRecord::Base.connection_pool()
     @current_shard = :master
+    
+    if !config.nil? && config.has_key?("verify_connection")
+      @verify_connection = config["verify_connection"]
+    else
+      @verify_connection = false
+    end
+    
     if !config.nil?
       @entire_sharded = config['entire_sharded']  
       shards_config = config[Octopus.rails_env()] 
@@ -71,6 +78,7 @@ class Octopus::Proxy
   end
 
   def select_connection()
+    @shards[shard_name].verify_active_connections! if @verify_connection 
     @shards[shard_name].connection()
   end
 

data/sample_app/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source :rubygems
 
 gem 'rails', '3.0.0.rc'
 

data/sample_app/Gemfile.lock

@@ -46,7 +46,6 @@ GEM
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
       selenium-webdriver (>= 0.0.3)
-    columnize (0.3.1)
     configuration (1.1.0)
     cucumber (0.8.5)
       builder (~> 2.1.2)
@@ -70,7 +69,6 @@ GEM
     launchy (0.3.7)
       configuration (>= 0.0.5)
       rake (>= 0.8.1)
-    linecache (0.43)
     mail (2.2.5)
       activesupport (>= 2.3.6)
       mime-types
@@ -108,11 +106,6 @@ GEM
     rspec-rails (2.0.0.beta.19)
       rspec (= 2.0.0.beta.19)
       webrat (>= 0.7.2.beta.1)
-    ruby-debug (0.10.3)
-      columnize (>= 0.1)
-      ruby-debug-base (~> 0.10.3.0)
-    ruby-debug-base (0.10.3)
-      linecache (>= 0.3)
     rubyzip (0.9.4)
     selenium-webdriver (0.0.27)
       ffi (>= 0.6.1)
@@ -144,6 +137,5 @@ DEPENDENCIES
   launchy
   rails (= 3.0.0.rc)
   rspec-rails (>= 2.0.0.beta.16)
-  ruby-debug
   spork
   sqlite3-ruby

data/sample_app/db/schema.rb

@@ -1,10 +1,11 @@
-# This file is auto-generated from the current state of the database. Instead of editing this file, 
-# please use the migrations feature of Active Record to incrementally modify your database, and
-# then regenerate this schema definition.
+# This file is auto-generated from the current state of the database. Instead 
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
 #
-# Note that this schema.rb definition is the authoritative source for your database schema. If you need
-# to create the application database on another system, you should be using db:schema:load, not running
-# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# Note that this schema.rb definition is the authoritative source for your 
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
 # It's strongly recommended to check this file into your version control system.

data/spec/config/shards.yml

@@ -104,6 +104,7 @@ production_fully_replicated:
       
 octopus_rails:
   replicated: true
+  verify_connection: true
   enviroments:
     - staging
     - production

data/spec/octopus/proxy_spec.rb

@@ -16,6 +16,10 @@ describe Octopus::Proxy do
     it "should initialize replicated attribute as false" do
       proxy.instance_variable_get(:@replicated).should be_false      
     end
+    
+    it "should not verify connections for default" do
+      proxy.instance_variable_get(:@verify_connection).should be_false
+    end
 
     describe "should raise error if you have duplicated shard names" do
       before(:each) do
@@ -72,6 +76,7 @@ describe Octopus::Proxy do
       Octopus.config()
 
       proxy.instance_variable_get(:@replicated).should be_true
+      proxy.instance_variable_get(:@verify_connection).should be_true
       Octopus.enviroments.should == ["staging", "production"] 
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ar-octopus
 version: !ruby/object:Gem::Version 
-  hash: 35
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 30
-  version: 0.0.30
+  version: 0.1.0
 platform: ruby
 authors: 
 - Thiago Pradi
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-14 00:00:00 -03:00
+date: 2010-08-20 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency