sunspot-rails-failover 0.0.2 → 0.0.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@sunspot-rails-failover --create

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Justin Ko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# sunspot-rails-failover
+
+Sunspot comes with `MasterSlaveSessionProxy` that does the following:
+
+> This session proxy implementation allows Sunspot to be used with a
+> master/slave Solr deployment. All write methods are delegated to a master
+> session, and read methods are delegated to a slave session.
+
+What this simple gem does is provide failover support if the slave session
+goes down. Reads *and* writes are called on the master session.
+
+## Setup
+
+Your config/sunspot.yml file should look something like this:
+
+    development:
+      master_solr:
+        url: http://localhost:8984/solr
+      solr:
+        url: http://localhost:8985/solr
+        
+NOTE: You do *not* have to have a master session. If a master session is
+not detected, sunspot-rails-failover will default to what sunspot_rails
+provides.
+
+Next, add an initializer (maybe initializers/sunspot.rb) with the following
+code:
+
+    Sunspot::Rails::Failover.setup
+    
+## Exception handling
+
+sunspot-rails-failover supports exception handling for committing and
+searching. Currently, it will use Hoptoad by default if it is installed.
+The exception is passed to `HoptoadNotifier.notify`.
+
+You can also use a custom class/module to customize how you want to handle the
+exception. In `initializers/sunspot.rb`:
+
+    module MyExceptionHandler
+      def self.handle(exception)
+        Notifier.deliver_exception_message(exception)
+      end
+    end
+    
+    Sunspot::Rails::Failover.exception_handler = MyExceptionHandler
+    Sunspot::Rails::Failover.setup
+    
+## Copyright
+
+Copyright (c) 2011 Justin Ko. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/sunspot-rails-failover.rb

@@ -0,0 +1,39 @@
+require 'sunspot'
+require 'sunspot-rails-failover/master_slave_with_failover_session_proxy'
+require 'sunspot-rails-failover/exception_handler_adapter'
+
+module Sunspot
+  module Rails
+    module Failover
+      class << self
+        attr_accessor :exception_handler
+        
+        def setup
+          Sunspot.session = if Sunspot::Rails.configuration.has_master?
+            Sunspot::SessionProxy::MasterSlaveWithFailoverSessionProxy.new(
+              Sunspot::Session.new(master_config), Sunspot::Session.new(slave_config)
+            )
+          else
+            Sunspot::SessionProxy::ThreadLocalSessionProxy.new(slave_config)
+          end
+        end
+        
+      private
+      
+        def slave_config
+          build_config('solr', 'url')
+        end
+        
+        def master_config
+          build_config('master_solr', 'url')
+        end
+        
+        def build_config(*keys)
+          Sunspot::Configuration.build.tap do |config|
+            config.solr.url = Sunspot::Rails.configuration.send :user_configuration_from_key, *keys
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sunspot-rails-failover/exception_handler_adapter.rb

@@ -0,0 +1,22 @@
+module Sunspot
+  module Rails
+    module Failover
+      module ExceptionHandlerAdapter
+      
+        def self.handle(exception)
+          case exception_handler
+          when :hoptoad, nil
+            HoptoadNotifier.notify(exception) if defined?(HoptoadNotifier)  
+          when Class
+            exception_handler.handle(exception)
+          end
+        end
+      
+        def self.exception_handler
+          Failover.exception_handler
+        end
+      
+      end
+    end
+  end
+end

data/lib/sunspot-rails-failover/master_slave_with_failover_session_proxy.rb

@@ -0,0 +1,31 @@
+module Sunspot
+  module SessionProxy
+    class MasterSlaveWithFailoverSessionProxy < MasterSlaveSessionProxy
+      
+      attr_accessor :exception
+      
+      def commit
+        with_exception_handling do
+          master_session.commit
+        end
+      end
+      
+      def search(*types, &block)
+        [slave_session, master_session].any? do |session|
+          with_exception_handling { session.search(*types, &block) }
+        end or raise(exception)
+      end
+      
+    private
+    
+      def with_exception_handling
+        yield
+      rescue Exception => exception
+        Sunspot::Rails::Failover::ExceptionHandlerAdapter.handle(exception)
+        self.exception = exception
+        false
+      end
+      
+    end
+  end
+end

data/lib/sunspot-rails-failover/version.rb

@@ -0,0 +1,7 @@
+module Sunspot
+  module Rails
+    module Failover
+      VERSION = "0.0.3"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'sunspot-rails-failover'
+
+Dir['./spec/support/*.rb'].map {|f| require f }
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

data/spec/sunspot-rails-failover/exception_handler_adapter_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+require 'hoptoad_notifier'
+
+shared_examples_for 'a hoptoad handler' do
+  it 'uses the api' do
+    HoptoadNotifier.should_receive(:notify).with(exception)
+    described_class.handle(exception)
+  end
+end 
+
+describe Sunspot::Rails::Failover::ExceptionHandlerAdapter do
+  describe '.handle' do
+    let(:exception) { Exception.new }
+    
+    context 'with exception_handler not set (default)' do
+      it_should_behave_like 'a hoptoad handler'
+    end
+    
+    context 'with exception_handler set to :hoptoad' do
+      before { Sunspot::Rails::Failover.exception_handler = :hoptoad }
+      it_should_behave_like 'a hoptoad handler'
+    end
+  
+    context 'with exception_handler set to a custom class' do
+      before { Sunspot::Rails::Failover.exception_handler = MyExceptionHandler }
+      
+      it 'passes the exception to #handle' do
+        MyExceptionHandler.should_receive(:handle).with(exception)
+        described_class.handle(exception)
+      end
+    end
+  end
+end

data/spec/sunspot-rails-failover/master_slave_with_failover_session_proxy_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Sunspot::SessionProxy::MasterSlaveWithFailoverSessionProxy do
+  let(:master) { Sunspot::Session.new }
+  let(:slave) { Sunspot::Session.new }
+  let(:proxy) { Sunspot::SessionProxy::MasterSlaveWithFailoverSessionProxy.new(master, slave) }
+  
+  let(:exception_handler_adapter) { Sunspot::Rails::Failover::ExceptionHandlerAdapter }
+  
+  describe '#commit' do
+    context 'with no error' do
+      it 'calls on the master session' do
+        master.should_receive(:commit)
+        proxy.commit
+      end
+    end
+    
+    context 'with an error' do
+      it 'passes the exception to the exception handler adapter' do
+        exception = Exception.new
+        exception_handler_adapter.should_receive(:handle).with(exception)
+        master.should_receive(:commit).and_raise(exception)
+        proxy.commit
+      end
+    end
+  end
+  
+  describe '#search' do
+    context 'with no error' do
+      it 'calls on the slave session' do
+        slave.should_receive(:search).and_return(true)
+        master.should_not_receive(:search)
+        proxy.search
+      end
+    end
+    
+    context 'with an error on the slave session' do
+      it 'calls on the master session' do
+        exception = Exception.new
+        slave.should_receive(:search).and_raise(exception)
+        exception_handler_adapter.should_receive(:handle).with(exception)
+        master.should_receive(:search).and_return(true)
+        proxy.search
+      end
+    end
+    
+    context 'with an error on the slave and master sessions' do
+      it 'raises the error with no handling' do
+        exception = Exception.new
+        slave.should_receive(:search).and_raise(exception)
+        master.should_receive(:search).and_raise(exception)
+        exception_handler_adapter.should_receive(:handle).with(exception).twice
+        proxy.should_receive(:raise).with(exception)
+        proxy.search
+      end
+    end
+  end
+  
+end

data/spec/sunspot-rails-failover_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Sunspot::Rails::Failover do
+  describe '.setup' do
+    let(:configuration) { double('configuration') }
+    
+    before do
+      Sunspot::Rails.stub(:configuration).and_return(configuration)
+      configuration.should_receive(:user_configuration_from_key).with('solr', 'url')
+    end
+    
+    context 'with a master configuration' do
+      before do
+        configuration.should_receive(:has_master?).and_return(true)
+        configuration.should_receive(:user_configuration_from_key).with('master_solr', 'url')
+      end
+      
+      it 'sets the session to master/slave with failover support' do
+        described_class.setup
+        Sunspot.session.should be_an_instance_of(Sunspot::SessionProxy::MasterSlaveWithFailoverSessionProxy)
+      end
+    end
+    
+    context 'with no master configuration' do
+      before do
+        configuration.should_receive(:has_master?).and_return(false)
+      end
+          
+      it 'sets the session to the default' do
+        described_class.setup
+        Sunspot.session.should be_an_instance_of(Sunspot::SessionProxy::ThreadLocalSessionProxy)
+      end
+    end
+    
+  end
+end

data/spec/support/my_exception_handler.rb

@@ -0,0 +1,4 @@
+class MyExceptionHandler
+  def handle
+  end
+end

data/sunspot-rails-failover.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'sunspot-rails-failover/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'sunspot-rails-failover'
+  s.version     = Sunspot::Rails::Failover::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = 'Justin Ko'
+  s.email       = 'jko170@gmail.com'
+  s.homepage    = 'https://github.com/justinko/sunspot-rails-failover'
+  s.description = 'Failover support for sunspot_rails'
+  s.summary     = 'If the Sunspot slave session goes down, reads *and* writes ' \
+                  'are called upon the master session'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.executables  = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_path = 'lib'
+  
+  s.add_dependency 'sunspot_rails', '~> 1.2.1'
+  
+  s.add_development_dependency 'rspec', '~> 2.5'
+  s.add_development_dependency 'hoptoad_notifier'
+end

metadata

@@ -2,7 +2,7 @@
 name: sunspot-rails-failover
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Justin Ko
@@ -54,8 +54,23 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sunspot-rails-failover.rb
+- lib/sunspot-rails-failover/exception_handler_adapter.rb
+- lib/sunspot-rails-failover/master_slave_with_failover_session_proxy.rb
+- lib/sunspot-rails-failover/version.rb
+- spec/spec_helper.rb
+- spec/sunspot-rails-failover/exception_handler_adapter_spec.rb
+- spec/sunspot-rails-failover/master_slave_with_failover_session_proxy_spec.rb
+- spec/sunspot-rails-failover_spec.rb
+- spec/support/my_exception_handler.rb
+- sunspot-rails-failover.gemspec
 has_rdoc: true
 homepage: https://github.com/justinko/sunspot-rails-failover
 licenses: []
@@ -83,6 +98,10 @@ rubyforge_project:
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Failover support for sunspot_rails
-test_files: []
-
+summary: If the Sunspot slave session goes down, reads *and* writes are called upon the master session
+test_files: 
+- spec/spec_helper.rb
+- spec/sunspot-rails-failover/exception_handler_adapter_spec.rb
+- spec/sunspot-rails-failover/master_slave_with_failover_session_proxy_spec.rb
+- spec/sunspot-rails-failover_spec.rb
+- spec/support/my_exception_handler.rb