flying-sphinx 0.4.4 → 0.5.0

data/lib/flying_sphinx/rails.rb

@@ -6,7 +6,11 @@ unless Rails.env.development? || Rails.env.test?
   
     ThinkingSphinx::Configuration.instance.address = config.host
     ThinkingSphinx::Configuration.instance.port    = config.port
+    ThinkingSphinx::Configuration.instance.configuration.searchd.client_key =
+      config.client_key
   end
 
-  ThinkingSphinx.database_adapter = FlyingSphinx::HerokuSharedAdapter
+  if ENV['DATABASE_URL'][/^mysql/].nil?
+    ThinkingSphinx.database_adapter = FlyingSphinx::HerokuSharedAdapter
+  end
 end

data/lib/flying_sphinx/railtie.rb

@@ -8,7 +8,11 @@ class FlyingSphinx::Railtie < Rails::Railtie
     
     ThinkingSphinx::Configuration.instance.address = config.host
     ThinkingSphinx::Configuration.instance.port    = config.port
+    ThinkingSphinx::Configuration.instance.configuration.searchd.client_key =
+      config.client_key
     
-    ThinkingSphinx.database_adapter = FlyingSphinx::HerokuSharedAdapter
+    if ENV['DATABASE_URL'][/^mysql/].nil?
+      ThinkingSphinx.database_adapter = FlyingSphinx::HerokuSharedAdapter
+    end
   end unless Rails.env.development? || Rails.env.test?
 end

data/lib/flying_sphinx/tasks.rb

@@ -2,8 +2,10 @@ namespace :fs do
   task :index => :environment do
     puts "Starting Index Request"
     FlyingSphinx::IndexRequest.cancel_jobs
-    FlyingSphinx::IndexRequest.new.update_and_index
-    puts "Index Request has completed"
+    request = FlyingSphinx::IndexRequest.new
+    request.update_and_index
+    puts request.status_message
+    
   end
   
   task :start => :environment do
@@ -20,4 +22,12 @@ namespace :fs do
   
   task :restart => [:environment, :stop, :start]
   task :rebuild => [:environment, :stop, :index, :start]
+  
+  task :index_log => :environment do
+    FlyingSphinx::IndexRequest.output_last_index
+  end
+  
+  task :actions => :environment do
+    FlyingSphinx::Configuration.new.output_recent_actions
+  end
 end

data/lib/flying_sphinx/tunnel.rb

@@ -2,45 +2,54 @@ class FlyingSphinx::Tunnel
   def self.connect(configuration, &block)
     tunnel = new configuration
     tunnel.open do |session|
-      session.loop &block
+      session.loop do
+        block.call
+      end
     end
   end
   
+  def self.required?
+    ThinkingSphinx.database_adapter == FlyingSphinx::HerokuSharedAdapter
+  end
+  
   def initialize(configuration)
     @configuration = configuration
   end
-  
+
   def open(&block)
-    Net::SSH.start(@configuration.host, 'sphinx', ssh_options) do |session|
-      session.forward.remote(
-        db_port, db_host, @configuration.database_port, '0.0.0.0'
-      )
-      session.loop { !remote_exists?(session) }
-      
-      yield session
-    end
-  end
+    session = Net::SSH.start(@configuration.host, 'sphinx', ssh_options)
+    session.forward.remote(
+      db_port, db_host, @configuration.database_port, '0.0.0.0'
+    )
+
+    session.loop { !remote_exists?(session) }
     
-  private
+    yield session
+  rescue IOError
+    # Server closed the connection on us. That's (hopefully) expected, nothing
+    # to worry about.
+  end
   
+  private
+
   def db_host
     db_config[:host]
   end
-  
+
   def db_port
     db_config[:port]
   end
-  
+
   def db_config
     @db_config ||= ActiveRecord::Base.connection.instance_variable_get(:@config)
   end
-  
+
   def ssh_options
     {:keys => [
       File.expand_path('../../../keys/key', __FILE__)
     ]}
   end
-  
+
   def remote_exists?(session)
     session.forward.active_remotes.include?(
       [@configuration.database_port, '0.0.0.0']

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+begin
+  require 'bundler'
+rescue LoadError
+  puts "although not required, it's recommended you use bundler during development"
+end
+
+require 'timeout'
+
+require 'thinking-sphinx'
+require 'flying_sphinx'
+require 'delayed_job'
+
+require 'fakeweb'
+require 'fakeweb_matcher'
+
+FakeWeb.allow_net_connect = false
+
+Delayed::Worker.backend = :active_record
+
+# we don't want a checking of interval in testing
+FlyingSphinx::IndexRequest.send(:remove_const, :INDEX_COMPLETE_CHECKING_INTERVAL)
+FlyingSphinx::IndexRequest::INDEX_COMPLETE_CHECKING_INTERVAL = 0

data/spec/specs/configuration_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'multi_json'
+
+describe FlyingSphinx::Configuration do
+  describe '#initialize' do
+    let(:api_server) { 'https://flying-sphinx.com/api/my' }
+    let(:api_key)    { 'foo-bar-baz' }
+    let(:identifier) { 'app@heroku.com' }
+    let(:config)     { FlyingSphinx::Configuration.new identifier, api_key }
+    
+    before :each do
+      FakeWeb.register_uri(:get, "#{api_server}/app",
+        :body => MultiJson.encode(
+          :server        => 'foo.bar.com',
+          :port          => 9319,
+          :database_port => 10001
+        )
+      )
+    end
+    
+    it "requests details from the server with the given API key" do
+      config
+      FakeWeb.should have_requested :get, "#{api_server}/app"
+    end
+    
+    it "sets the host from the server information" do
+      config.host.should == 'foo.bar.com'
+    end
+    
+    it "sets the port from the server information" do
+      config.port.should == 9319
+    end
+    
+    it "sets the port from the server information" do
+      config.database_port.should == 10001
+    end
+  end
+end

data/spec/specs/index_request_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+
+describe FlyingSphinx::IndexRequest do
+  let(:api)           { FlyingSphinx::API.new 'foo', 'bar' }
+  let(:configuration) {
+    stub(:configuration, :api => api, :sphinx_configuration => 'foo {}')
+  }
+  
+  let(:index_response)    {
+    stub(:response, :body => stub(:body, :id => 42, :status => 'OK'))
+  }
+  let(:blocked_response)  {
+    stub(:response, :body => stub(:body, :id => nil, :status => 'BLOCKED'))
+  }
+    
+  before :each do
+    ThinkingSphinx.database_adapter = FlyingSphinx::HerokuSharedAdapter
+    
+    FlyingSphinx::Configuration.stub!(:new => configuration)
+    FlyingSphinx::Tunnel.stub(:connect) { |config, block| block.call }
+  end
+  
+  describe '.cancel_jobs' do
+    before :each do
+      Delayed::Job.stub!(:delete_all => true)
+    end
+    
+    it "should not delete any rows if the delayed_jobs table does not exist" do
+      Delayed::Job.stub!(:table_exists? => false)
+      Delayed::Job.should_not_receive(:delete_all)
+      
+      FlyingSphinx::IndexRequest.cancel_jobs
+    end
+    
+    it "should delete rows if the delayed_jobs table does exist" do
+      Delayed::Job.stub!(:table_exists? => true)
+      Delayed::Job.should_receive(:delete_all)
+      
+      FlyingSphinx::IndexRequest.cancel_jobs
+    end
+    
+    it "should delete only Thinking Sphinx jobs" do
+      Delayed::Job.stub!(:table_exists? => true)
+      Delayed::Job.should_receive(:delete_all) do |sql|
+        sql.should match(/handler LIKE '--- !ruby\/object:FlyingSphinx::\%'/)
+      end
+      
+      FlyingSphinx::IndexRequest.cancel_jobs
+    end
+  end
+  
+  describe '#update_and_index' do
+    let(:index_request) { FlyingSphinx::IndexRequest.new }
+    let(:conf_params)   { { :configuration => 'foo {}' } }
+    let(:index_params)  { { :indices => '' } }
+        
+    it "makes a new request" do
+      api.should_receive(:put).with('/', conf_params).and_return('ok')
+      api.should_receive(:post).
+        with('indices', index_params).and_return(index_response)
+      
+      begin
+        Timeout::timeout(0.2) {
+          index_request.update_and_index
+        }
+      rescue Timeout::Error
+      end
+    end
+    
+    context 'delta request without delta support' do
+      it "should explain why the request failed" do
+        api.should_receive(:put).
+          with('/', conf_params).and_return('ok')
+        api.should_receive(:post).
+          with('indices', index_params).and_return(blocked_response)
+        index_request.should_receive(:puts).
+          with('Your account does not support delta indexing. Upgrading plans is probably the best way around this.')
+
+        index_request.update_and_index
+      end
+    end
+    
+    context 'request for a MySQL database' do
+      before :each do
+        ThinkingSphinx.database_adapter = nil
+      end
+      
+      after :each do
+        ThinkingSphinx.database_adapter = FlyingSphinx::HerokuSharedAdapter
+      end
+      
+      it "should not establish an SSH connection" do
+        FlyingSphinx::Tunnel.should_not_receive(:connect)
+        
+        api.should_receive(:put).with('/', conf_params).and_return('ok')
+        api.should_receive(:post).
+          with('indices', index_params).and_return(index_response)
+        api.should_receive(:get).with('indices/42').
+          and_return(stub(:response, :body => stub(:body, :status => 'FINISHED')))
+        
+        index_request.update_and_index
+      end
+    end
+  end
+  
+  describe '#perform' do
+    let(:index_request) { FlyingSphinx::IndexRequest.new ['foo_delta'] }
+    let(:index_params)  { { :indices => 'foo_delta' } }
+    
+    it "makes a new request" do
+      api.should_receive(:post).
+        with('indices', index_params).and_return(index_response)
+      
+      begin
+        Timeout::timeout(0.2) {
+          index_request.perform
+        }
+      rescue Timeout::Error
+      end
+    end
+  end
+  
+  describe '#status_message' do
+    let(:index_request)     { FlyingSphinx::IndexRequest.new }
+    let(:finished_response) {
+      stub(:response, :body => stub(:body, :status => 'FINISHED'))
+    }
+    let(:failure_response)  {
+      stub(:response, :body => stub(:body, :status => 'FAILED'))
+    }
+    let(:pending_response)  {
+      stub(:response, :body => stub(:body, :status => 'PENDING'))
+    }
+    let(:unknown_response)  {
+      stub(:response, :body => stub(:body, :status => 'UNKNOWN'))
+    }
+    
+    before :each do
+      api.stub(:post => index_response)
+    end
+    
+    it "returns with a positive message on success" do
+      api.stub(:get => finished_response)
+      
+      index_request.status_message.should == 'Index Request has completed.'
+    end
+    
+    it "returns with a failure message on failure" do
+      api.stub(:get => failure_response)
+      
+      index_request.status_message.should == 'Index Request failed.'
+    end
+    
+    it "warns the user if the request is still pending" do
+      api.stub(:get => pending_response)
+      
+      index_request.status_message.should == 'Index Request is still pending - something has gone wrong.'
+    end
+    
+    it "treats all other statuses as unknown" do
+      api.stub(:get => unknown_response)
+      
+      index_request.status_message.should == "Unknown index response: 'UNKNOWN'."
+    end
+  end
+  
+  describe "#display_name" do
+    let(:index_request) {
+      FlyingSphinx::IndexRequest.new ['foo_core', 'bar_core']
+    }
+    
+    it "should display class name with all indexes" do
+      index_request.display_name.should == "FlyingSphinx::IndexRequest for foo_core, bar_core"
+    end
+  end
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: flying-sphinx
 version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 4
-  version: 0.4.4
+  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors: 
 - Pat Allan
@@ -15,167 +10,141 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 +11:00
+date: 2011-05-12 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
   name: thinking-sphinx
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
   type: :runtime
-  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: net-ssh
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 33
-        segments: 
-        - 2
-        - 0
-        - 23
         version: 2.0.23
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multi_json
   prerelease: false
-  name: json
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 4
-        - 6
-        version: 1.4.6
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
+        version: 1.0.1
   type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: faraday
   prerelease: false
-  name: httparty
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 6
-        - 1
         version: 0.6.1
-  requirement: *id004
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: faraday_middleware
   prerelease: false
-  name: jeweler
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  requirement: *id005
+        version: 0.6.3
+  type: :runtime
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: rash
   prerelease: false
-  name: rspec
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
-        version: 2.1.0
-  requirement: *id006
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: yajl-ruby
   prerelease: false
-  name: rcov
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 9
-        - 8
-        version: 0.9.8
-  requirement: *id007
+        version: 0.8.2
+  type: :development
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
   type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rcov
   prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.9
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
   name: fakeweb
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
         version: 1.3.0
-  requirement: *id008
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
   name: fakeweb-matcher
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 2
-        - 2
         version: 1.2.2
-  requirement: *id009
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
   name: delayed_job
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 1
-        - 2
-        version: 2.1.2
-  requirement: *id010
+        version: 2.1.4
+  type: :development
+  version_requirements: *id012
 description: Hooks Thinking Sphinx into the Flying Sphinx service
 email: pat@freelancing-gods.com
 executables: []
@@ -185,9 +154,13 @@ extensions: []
 extra_rdoc_files: 
 - README.textile
 files: 
+- .gitignore
+- Gemfile
 - LICENCE
 - README.textile
+- Rakefile
 - VERSION
+- flying-sphinx.gemspec
 - keys/key
 - lib/flying-sphinx.rb
 - lib/flying_sphinx.rb
@@ -201,15 +174,20 @@ files:
 - lib/flying_sphinx/railtie.rb
 - lib/flying_sphinx/tasks.rb
 - lib/flying_sphinx/tunnel.rb
-- spec/flying_sphinx/configuration_spec.rb
-- spec/flying_sphinx/delayed_delta_spec.rb
-- spec/flying_sphinx/flag_as_deleted_job_spec.rb
-- spec/flying_sphinx/index_request_spec.rb
+- spec/spec_helper.rb
+- spec/specs/configuration_spec.rb
+- spec/specs/delayed_delta_spec.rb
+- spec/specs/flag_as_deleted_job_spec.rb
+- spec/specs/index_request_spec.rb
 has_rdoc: true
 homepage: https://flying-sphinx.com
 licenses: []
 
-post_install_message: 
+post_install_message: |
+  If you're upgrading, you should rebuild your Sphinx setup when deploying:
+  
+    $ heroku rake fs:rebuild
+
 rdoc_options: []
 
 require_paths: 
@@ -219,28 +197,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Sphinx in the Cloud
 test_files: 
-- spec/flying_sphinx/configuration_spec.rb
-- spec/flying_sphinx/delayed_delta_spec.rb
-- spec/flying_sphinx/flag_as_deleted_job_spec.rb
-- spec/flying_sphinx/index_request_spec.rb
+- spec/spec_helper.rb
+- spec/specs/configuration_spec.rb
+- spec/specs/delayed_delta_spec.rb
+- spec/specs/flag_as_deleted_job_spec.rb
+- spec/specs/index_request_spec.rb