pyramid_scheme 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Pickett
+
+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.rdoc

@@ -0,0 +1,40 @@
+= pyramid_scheme
+
+Index propagation for sphinx to eliminate redundant indexing. Run indexing once on an index server and have index clients retrieve the required files.
+
+Use this if you have a distributed system for your application servers where each one requires a dedicated searchd process locally.
+
+Supports ThinkingSphinx and Ultrasphinx
+
+== Filesystem Configuration
+
+Toss this in an initalizer like config/initializers/pyramid_scheme.rb
+
+  PyramidScheme.configure do |config|
+    config.client_source_path = '/some/client/source'
+    config.client_destination_path = '/some/client/destination'
+    config.server_source_path = '/some/server/source'
+    config.server_destination_path = '/some/server/destination'
+  end
+
+In your Rakefile, require 'pyramid_scheme/tasks' after your thinking sphinx or ultrasphinx require statement
+
+Your client source and server destination paths should point to the same storage path for the transfer to behave the way you want it to. 
+
+The server must run an index via rake pyramid_scheme:index for files to be placed properly for the client to pick up. A lock file will be created in the server destination directory
+
+The client must run an index via rake pyramid_scheme:retrieve_index - upon retrieval, will send a sighup to your searchd process to rotate the indexes
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Dan Pickett. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,75 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pyramid_scheme"
+    gem.summary = %Q{Sphinx index propagation}
+    gem.description = %Q{Sphinx index propagtion (currently via the filesystem)}
+    gem.email = "dpickett@enlightsolutions.com"
+    gem.homepage = "http://github.com/dpickett/pyramid_scheme"
+    gem.files += FileList['lib/**/*.rake']
+    gem.authors = ["Dan Pickett"]
+    gem.add_dependency "rake", ">= 0.8.7"
+    gem.add_dependency "configatron"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "mocha", "0.9.8"
+    gem.add_development_dependency "fakefs", "0.2.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/pyramid_scheme/configuration.rb

@@ -0,0 +1,35 @@
+module PyramidScheme
+  class Configuration
+    INDEX_FILE_EXTENSIONS = [
+      '.spa',
+      '.spd',
+      '.sph',
+      '.spi',
+      '.spm',
+      '.spp'
+    ]
+
+    def initialize(options = {})
+      self.class.set do |config|
+        options.each do |key, value|
+          config.send("#{key}=", value)
+        end
+      end
+    end 
+
+    def self.set(&block)
+      yield(configatron.pyramid_scheme)
+      defaults.each do |key, value|
+        configatron.pyramid_scheme.send("#{key}=", value) unless configatron.pyramid_scheme.to_hash[key]
+      end
+    end
+
+    def self.defaults
+      { :lock_file_name => 'pyramid_scheme_index_in_progress.txt' } 
+    end
+
+    def [](key)
+      configatron.pyramid_scheme.to_hash[key] 
+    end
+  end
+end

data/lib/pyramid_scheme/index_client.rb

@@ -0,0 +1,28 @@
+module PyramidScheme
+  class IndexClient
+    attr_reader :index_provider
+    def initialize(options = {})
+      @index_provider = PyramidScheme::IndexProvider::FileSystem.new
+    end
+
+    def retrieve_index
+      @index_provider.retrieve_index
+      bounce_pids
+    end
+
+    def searchd_pids
+      ps_output = `ps ax | grep searchd`
+      ps_output.split("\n").collect{|p| /^(\d*)/.match(p)[0]}
+    end
+
+    def bounce_pids
+      searchd_pids.each do |pid|
+        begin
+          Process.kill("HUP", pid)
+        rescue 
+        end
+      end
+    end
+
+  end
+end

data/lib/pyramid_scheme/index_lock_file.rb

@@ -0,0 +1,25 @@
+module PyramidScheme
+  class IndexLockFile
+    def self.server_path
+      File.join(PyramidScheme.configuration[:server_destination_path], 
+        PyramidScheme.configuration[:lock_file_name])
+    end
+
+    def self.client_path
+      File.join(PyramidScheme.configuration[:client_source_path], 
+        PyramidScheme.configuration[:lock_file_name])
+    end
+
+    def self.exists?
+      File.exists?(client_path)
+    end
+
+    def self.create
+      FileUtils.touch(server_path)
+    end 
+
+    def self.destroy
+      FileUtils.rm_f(server_path)
+    end
+  end
+end

data/lib/pyramid_scheme/index_provider/file_system.rb

@@ -0,0 +1,83 @@
+module PyramidScheme
+  module IndexProvider
+    class FileSystem
+      MAXIMUM_COPY_ATTEMPTS = 5
+      REQUIRED_OPTIONS = [
+        :server_source_path, 
+        :server_destination_path,
+        :client_source_path,
+        :client_destination_path
+      ]
+
+      attr_reader :configuration, :copy_attempts
+
+      def initialize(options = {})
+        @configuration = PyramidScheme::Configuration.new(options)
+        ensure_required_options_are_present
+        @copy_attempts = 0
+      end
+
+      def index_in_progress?
+        PyramidScheme::IndexLockFile.exists?
+      end
+
+      def process_index
+        server_copy
+      end
+
+      def retrieve_index
+        client_copy
+      end
+
+      private
+      def server_copy
+        Configuration::INDEX_FILE_EXTENSIONS.each do |ext|
+          Dir[File.join(self.configuration[:server_source_path], "*#{ext}")].each do |f|
+            FileUtils.cp_r(f, "#{self.configuration[:server_destination_path]}")
+          end
+        end
+      end
+
+      def client_copy
+        if !exceeded_maximum_copy_attempts?
+          attempt_to_copy
+        else
+          raise "copying sphinx indexes failed after maximum number of attempts"
+        end
+      end
+
+      def ensure_required_options_are_present
+        REQUIRED_OPTIONS.each do |opt|
+          if configuration[opt].nil?
+            raise PyramidScheme::RequiredConfigurationNotFound, "the #{opt} setting was not found"
+          end
+        end
+      end
+
+      def attempt_to_copy
+        @copy_attempts += 1
+        if index_in_progress?
+          Kernel.sleep(5)
+          client_copy
+        else
+          copy_client_files
+        end
+      end
+
+      def copy_client_files
+        Configuration::INDEX_FILE_EXTENSIONS.each do |ext|
+          Dir[File.join(self.configuration[:client_source_path], "*#{ext}")].each do |f|
+            new_filename = File.basename(f.gsub(/\./, ".new."))
+            FileUtils.cp_r(f, 
+              "#{self.configuration[:client_destination_path]}/#{new_filename}")
+          end
+        end
+
+      end
+
+      def exceeded_maximum_copy_attempts?
+        copy_attempts > MAXIMUM_COPY_ATTEMPTS
+      end
+    end
+  end
+end

data/lib/pyramid_scheme/index_server.rb

@@ -0,0 +1,35 @@
+module PyramidScheme
+  class IndexServer
+    attr_reader :indexer_class, :configuration, :index_provider
+    
+    # initializes a new index server
+    # @param options [Hash] takes an optional :indexer_class (defaults to PyramidScheme::ThinkingSphinxIndexer 
+    def initialize(options = {})
+      @indexer_class = options[:indexer_class] || PyramidScheme::ThinkingSphinxIndexer
+      @index_provider = PyramidScheme::IndexProvider::FileSystem.new
+      @configuration = PyramidScheme::Configuration.new
+    end
+
+    # @returns [PyramidScheme::Indexer] an instance of the specified indexer_class from initialization
+    def indexer
+      @indexer ||= @indexer_class.new
+    end
+
+    # run the index
+    def index
+      create_lock_file
+      indexer.index
+      destroy_lock_file
+      index_provider.process_index
+    end
+
+    private
+      def create_lock_file
+        PyramidScheme::IndexLockFile.create
+      end
+
+      def destroy_lock_file
+        PyramidScheme::IndexLockFile.destroy
+      end
+  end
+end

data/lib/pyramid_scheme/indexer.rb

@@ -0,0 +1,14 @@
+module PyramidScheme
+  #defines an interface for indexers
+  class Indexer
+    attr_reader :rake_task_name
+
+    def initialize(rake_task_name = nil)
+      @rake_task_name = rake_task_name || self.class.default_task_name
+    end
+
+    def index
+      Rake::Task[@rake_task_name].invoke
+    end
+  end
+end

data/lib/pyramid_scheme/required_configuration_not_found.rb

@@ -0,0 +1,5 @@
+module PyramidScheme
+  class RequiredConfigurationNotFound < Exception
+
+  end
+end

data/lib/pyramid_scheme/tasks/rake_tasks.rake

@@ -0,0 +1,11 @@
+namespace :pyramid_scheme do
+  desc "retrieve new sphinx indexes as the client"
+  task :retrieve => :environment do
+    PyramidScheme::IndexClient.new.retrieve_index
+  end
+
+  desc "create new sphinx indexes as the server"
+  task :index => :environment do
+    PyramidScheme::IndexServer.new.index
+  end
+end

data/lib/pyramid_scheme/tasks.rb

@@ -0,0 +1 @@
+load(File.join(File.dirname(__FILE__), 'tasks/rake_tasks.rake'))

data/lib/pyramid_scheme/thinking_sphinx_indexer.rb

@@ -0,0 +1,7 @@
+module PyramidScheme
+  class ThinkingSphinxIndexer < PyramidScheme::Indexer
+    def self.default_task_name
+      'ts:in'
+    end
+  end
+end

data/lib/pyramid_scheme/ultrasphinx_indexer.rb

@@ -0,0 +1,7 @@
+module PyramidScheme
+  class UltrasphinxIndexer < Indexer
+    def self.default_task_name
+      'ultrasphinx:index'
+    end
+  end
+end

data/lib/pyramid_scheme.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'rake'
+require 'configatron'
+
+require 'pyramid_scheme/required_configuration_not_found'
+
+require 'pyramid_scheme/indexer'
+require 'pyramid_scheme/thinking_sphinx_indexer'
+require 'pyramid_scheme/ultrasphinx_indexer'
+
+require 'pyramid_scheme/index_lock_file'
+require 'pyramid_scheme/configuration'
+require 'pyramid_scheme/index_provider/file_system'
+
+require 'pyramid_scheme/index_server'
+
+require 'pyramid_scheme/index_client'
+
+require 'pyramid_scheme/tasks/rake_tasks.rake'
+require 'pyramid_scheme/tasks'
+
+module PyramidScheme
+  def self.configure(&block)
+    PyramidScheme::Configuration.set(&block)
+  end
+
+  def self.configuration
+    PyramidScheme::Configuration.new
+  end
+end

data/pyramid_scheme.gemspec

@@ -0,0 +1,94 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pyramid_scheme}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Pickett"]
+  s.date = %q{2010-02-08}
+  s.description = %q{Sphinx index propagtion (currently via the filesystem)}
+  s.email = %q{dpickett@enlightsolutions.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/pyramid_scheme.rb",
+     "lib/pyramid_scheme/configuration.rb",
+     "lib/pyramid_scheme/index_client.rb",
+     "lib/pyramid_scheme/index_lock_file.rb",
+     "lib/pyramid_scheme/index_provider/file_system.rb",
+     "lib/pyramid_scheme/index_server.rb",
+     "lib/pyramid_scheme/indexer.rb",
+     "lib/pyramid_scheme/required_configuration_not_found.rb",
+     "lib/pyramid_scheme/tasks.rb",
+     "lib/pyramid_scheme/tasks/rake_tasks.rake",
+     "lib/pyramid_scheme/thinking_sphinx_indexer.rb",
+     "lib/pyramid_scheme/ultrasphinx_indexer.rb",
+     "pyramid_scheme.gemspec",
+     "spec/pyramid_scheme.rb",
+     "spec/pyramid_scheme/index_client_spec.rb",
+     "spec/pyramid_scheme/index_provider/file_system_spec.rb",
+     "spec/pyramid_scheme/index_provider_configuration_spec.rb",
+     "spec/pyramid_scheme/index_server_spec.rb",
+     "spec/pyramid_scheme/thinking_sphinx_indexer_spec.rb",
+     "spec/pyramid_scheme/ultrasphinx_indexer_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "tasks/pyramid_scheme.rake"
+  ]
+  s.homepage = %q{http://github.com/dpickett/pyramid_scheme}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Sphinx index propagation}
+  s.test_files = [
+    "spec/pyramid_scheme/index_client_spec.rb",
+     "spec/pyramid_scheme/index_provider/file_system_spec.rb",
+     "spec/pyramid_scheme/index_provider_configuration_spec.rb",
+     "spec/pyramid_scheme/index_server_spec.rb",
+     "spec/pyramid_scheme/thinking_sphinx_indexer_spec.rb",
+     "spec/pyramid_scheme/ultrasphinx_indexer_spec.rb",
+     "spec/pyramid_scheme.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0.8.7"])
+      s.add_runtime_dependency(%q<configatron>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, ["= 0.9.8"])
+      s.add_development_dependency(%q<fakefs>, ["= 0.2.1"])
+    else
+      s.add_dependency(%q<rake>, [">= 0.8.7"])
+      s.add_dependency(%q<configatron>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<mocha>, ["= 0.9.8"])
+      s.add_dependency(%q<fakefs>, ["= 0.2.1"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0.8.7"])
+    s.add_dependency(%q<configatron>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<mocha>, ["= 0.9.8"])
+    s.add_dependency(%q<fakefs>, ["= 0.2.1"])
+  end
+end
+

data/spec/pyramid_scheme/index_client_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper' 
+
+describe PyramidScheme::IndexClient do
+  before(:each) do
+    @client = PyramidScheme::IndexClient.new
+  end
+
+  it 'should have an index provider' do
+    @client.index_provider.should_not be_nil
+  end
+ 
+  it 'should send SIGHUP to active searchd processes' do
+    @client.expects(:searchd_pids).returns(["4345"])
+    Process.expects(:kill).with("HUP", "4345")
+    @client.bounce_pids
+  end
+end
+
+

data/spec/pyramid_scheme/index_provider/file_system_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe PyramidScheme::IndexProvider::FileSystem do
+  before(:each) do
+    @provider = PyramidScheme::IndexProvider::FileSystem.new
+  end
+  include FakeFS::SpecHelpers
+
+  it 'should have a configuration' do
+    @provider.configuration.should_not be_nil 
+  end
+
+  [
+    :server_source_path,
+    :server_destination_path,
+    :client_source_path,
+    :client_destination_path
+  ].each do |option|
+    it "should require the #{option} configuration option" do
+      PyramidScheme.configure do |config|
+        config.send("#{option}=", nil)
+      end
+
+      lambda { PyramidScheme::IndexProvider::FileSystem.new
+        }.should raise_error(PyramidScheme::RequiredConfigurationNotFound)
+    end
+  end
+
+  it 'should indicate that an index is in process if a lock file is present' do
+    @configuration = PyramidScheme::Configuration.new
+    FileUtils.mkdir_p(@configuration[:client_source_path])
+    FileUtils.touch(File.join(
+      @configuration[:client_source_path], @configuration[:lock_file_name]))
+    @provider.index_in_progress?.should be_true
+  end
+
+  it 'should sleep if the server is still indexing' do
+    @provider.stubs(:index_in_progress?).returns(true).then.returns(false)
+    Kernel.expects(:sleep).once
+    @provider.retrieve_index
+    @provider.copy_attempts.should eql(2)
+  end
+
+  it 'should raise an error if the server is stuck indexing' do
+    Kernel.stub!(:sleep)
+    @provider.stubs(:index_in_progress?).returns(true)
+    lambda { @provider.retrieve_index }.should raise_error
+  end
+
+  it 'should copy all sphinx files from server source to server destination' do
+    FileUtils.mkdir_p(PyramidScheme.configuration[:server_source_path])   
+    FileUtils.mkdir_p(PyramidScheme.configuration[:server_destination_path])
+    @filenames = [
+      '.spi',
+      '.spd',
+      '.spa',
+      '.sph',
+      '.spm',
+      '.spp'
+    ].collect{|s| "some_index#{s}" }
+
+    @filenames.each do |f|
+      FileUtils.touch(File.join(PyramidScheme.configuration[:server_source_path], f))
+      File.exists?(File.join(PyramidScheme.configuration[:server_source_path], f)).should be_true
+    end
+
+    @provider.process_index
+    
+    @filenames.each do |f|
+      File.exists?(File.join(PyramidScheme.configuration[:server_destination_path], f)).should be_true
+    end
+  end
+end
+
+describe "copying from the filesytem" do
+  include FakeFS::SpecHelpers
+
+  before(:each) do
+    @configuration = PyramidScheme::Configuration.new
+    @provider = PyramidScheme::IndexProvider::FileSystem.new
+    FileUtils.mkdir_p(@configuration[:client_source_path])
+    FileUtils.mkdir_p(@configuration[:client_destination_path])
+
+  end
+
+  it 'should copy the files with .new extensions' do
+    @filenames = [
+      '.spi',
+      '.spd',
+      '.spa',
+      '.sph',
+      '.spm',
+      '.spp'
+    ].collect{|s| "some_index#{s}" }
+
+    @filenames.each do |f|
+      FileUtils.touch(File.join(PyramidScheme.configuration[:client_source_path], f))
+      File.exists?(File.join(PyramidScheme.configuration[:client_source_path], f)).should be_true
+    end
+
+    @provider.retrieve_index
+
+    @filenames.each do |f|
+      new_filename = File.basename(f).gsub(/\./, ".new.")
+      File.exists?(File.join(PyramidScheme.configuration[:client_destination_path], 
+        new_filename)).should be_true
+    end
+
+  end
+end
+

data/spec/pyramid_scheme/index_provider_configuration_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe PyramidScheme::Configuration do
+  before(:each) do
+    @source_path = '/some_mount_location'
+    @destination_path = '/data/app/current/db/sphinx/production'
+    PyramidScheme.configure do |config|
+      config.source_path = @source_path
+      config.destination_path = @destination_path
+    end
+  end
+
+  it 'should use allow me to set global configuration options' do 
+    @configuration = PyramidScheme::Configuration.new
+    @configuration[:source_path].should eql(@source_path)
+  end
+
+  it 'should allow me to override configuration options' do
+    @new_dest = '/some/other/path'
+    @configuration = PyramidScheme::Configuration.new(
+      :destination_path => @new_dest)
+    @configuration[:destination_path].should eql(@new_dest)
+  end
+
+  it 'should set a default index lock file' do
+    @configuration = PyramidScheme::Configuration.new
+    @configuration[:lock_file_name].should_not be_nil
+  end
+end

data/spec/pyramid_scheme/index_server_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe PyramidScheme::IndexServer do
+  include FakeFS::SpecHelpers
+
+  before(:each) do
+    @server = PyramidScheme::IndexServer.new
+    @server.indexer.stub(:index)
+    FileUtils.mkdir_p(PyramidScheme.configuration[:server_destination_path])
+    FileUtils.mkdir_p(PyramidScheme.configuration[:client_source_path])
+  end
+
+  it 'should have an indexer' do
+    @server.indexer.should_not be_nil
+  end
+
+  it 'should default to a thinking sphinx indexer' do
+    @server.indexer.should be_kind_of(PyramidScheme::ThinkingSphinxIndexer)
+  end
+
+  it 'should allow me to specify an ultrasphinx indexer' do
+    @server = PyramidScheme::IndexServer.new(:indexer_class => PyramidScheme::UltrasphinxIndexer)
+    @server.indexer.should be_kind_of(PyramidScheme::UltrasphinxIndexer)
+  end
+
+  it 'should index via the indexer' do
+    @server.indexer.expects(:index).once
+    @server.index
+  end
+
+  it 'should touch a lock file before indexing' do
+    FileUtils.should_receive(:touch)
+    @server.index
+  end
+
+  it 'should remove the lock file after indexing' do
+    FileUtils.should_receive(:rm_f)
+    @server.index
+  end
+
+  it 'should have the index provider process the index' do
+    @server.index_provider.expects(:process_index)
+    @server.index
+  end
+end

data/spec/pyramid_scheme/thinking_sphinx_indexer_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe PyramidScheme::ThinkingSphinxIndexer do 
+  before(:each) do
+    @indexer = PyramidScheme::ThinkingSphinxIndexer.new
+  end
+
+  it 'should have the default rake task of ts:in' do
+    @indexer.class.default_task_name.should eql('ts:in')
+  end
+end

data/spec/pyramid_scheme/ultrasphinx_indexer_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe PyramidScheme::UltrasphinxIndexer do
+  before(:each) do
+    @indexer = PyramidScheme::UltrasphinxIndexer.new
+  end
+
+  it 'should have the default rake task of ultrasphinx:index' do
+    @indexer.class.default_task_name.should eql('ultrasphinx:index')
+  end
+
+  it 'should default to the default rake task' do
+    @indexer.rake_task_name.should eql(@indexer.class.default_task_name)
+  end
+end

data/spec/pyramid_scheme.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe PyramidScheme do
+  it 'should have a shorthand delegate for setting the configuration' do
+    @path = '/a/path'
+
+    PyramidScheme.configure do |config|
+      config[:source_path] = @path
+    end
+
+    PyramidScheme::Configuration.new[:source_path].should eql(@path)
+  end
+  
+  it 'should have a shorthand delegate for getting the configuration' do
+    PyramidScheme.configuration[:source_path].should eql(PyramidScheme::Configuration.new[:source_path])
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'pyramid_scheme'
+require 'spec'
+require 'spec/autorun'
+
+require 'rubygems'
+require 'mocha'
+require 'fakefs'
+require 'fakefs/spec_helpers'
+
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    PyramidScheme.configure do |config|
+      config.client_source_path = '/some/default/source'
+      config.client_destination_path = '/some/default/destination'
+      config.server_source_path = '/some/server/source'
+      config.server_destination_path = '/some/server/destination'
+    end
+  end  
+end

data/tasks/pyramid_scheme.rake

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE), '../lib/pyramid_scheme/tasks'

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: pyramid_scheme
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Pickett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-08 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: configatron
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: 
+description: Sphinx index propagtion (currently via the filesystem)
+email: dpickett@enlightsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pyramid_scheme.rb
+- lib/pyramid_scheme/configuration.rb
+- lib/pyramid_scheme/index_client.rb
+- lib/pyramid_scheme/index_lock_file.rb
+- lib/pyramid_scheme/index_provider/file_system.rb
+- lib/pyramid_scheme/index_server.rb
+- lib/pyramid_scheme/indexer.rb
+- lib/pyramid_scheme/required_configuration_not_found.rb
+- lib/pyramid_scheme/tasks.rb
+- lib/pyramid_scheme/tasks/rake_tasks.rake
+- lib/pyramid_scheme/thinking_sphinx_indexer.rb
+- lib/pyramid_scheme/ultrasphinx_indexer.rb
+- pyramid_scheme.gemspec
+- spec/pyramid_scheme.rb
+- spec/pyramid_scheme/index_client_spec.rb
+- spec/pyramid_scheme/index_provider/file_system_spec.rb
+- spec/pyramid_scheme/index_provider_configuration_spec.rb
+- spec/pyramid_scheme/index_server_spec.rb
+- spec/pyramid_scheme/thinking_sphinx_indexer_spec.rb
+- spec/pyramid_scheme/ultrasphinx_indexer_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/pyramid_scheme.rake
+has_rdoc: true
+homepage: http://github.com/dpickett/pyramid_scheme
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Sphinx index propagation
+test_files: 
+- spec/pyramid_scheme/index_client_spec.rb
+- spec/pyramid_scheme/index_provider/file_system_spec.rb
+- spec/pyramid_scheme/index_provider_configuration_spec.rb
+- spec/pyramid_scheme/index_server_spec.rb
+- spec/pyramid_scheme/thinking_sphinx_indexer_spec.rb
+- spec/pyramid_scheme/ultrasphinx_indexer_spec.rb
+- spec/pyramid_scheme.rb
+- spec/spec_helper.rb