sphinx 0.9.9.2117

data/lib/sphinx/timeout.rb

@@ -0,0 +1,31 @@
+module Sphinx
+  begin
+    # Try to use the SystemTimer gem instead of Ruby's timeout library
+    # when running on something that looks like Ruby 1.8.x. See:
+    #   http://ph7spot.com/articles/system_timer
+    # We don't want to bother trying to load SystemTimer on jruby and
+    # ruby 1.9+
+    if defined?(JRUBY_VERSION) || (RUBY_VERSION >= '1.9')
+      require 'timeout'
+      Timeout = ::Timeout
+    else
+      require 'system_timer'
+      Timeout = ::SystemTimer
+    end
+  rescue LoadError => e
+    puts "[sphinx] Could not load SystemTimer gem, falling back to Ruby's slower/unsafe timeout library: #{e.message}"
+    require 'timeout'
+    Timeout = ::Timeout
+  end
+
+  # Executes specified block respecting timeout passed.
+  #
+  # @private
+  def self.safe_execute(timeout = 5, &block)
+    if timeout > 0
+      Sphinx::Timeout.timeout(timeout, &block)
+    else
+      yield
+    end
+  end
+end

data/lib/sphinx.rb

@@ -0,0 +1,51 @@
+# Sphinx Client API
+#
+# Author::    Dmytro Shteflyuk <mailto:kpumuk@kpumuk.info>.
+# Copyright:: Copyright (c) 2006 — 2009 Dmytro Shteflyuk
+# License::   Distributes under the same terms as Ruby
+# Version::   0.9.9-r2117
+# Website::   http://kpumuk.info/projects/ror-plugins/sphinx
+# Sources::   http://github.com/kpumuk/sphinx
+#
+# This library is distributed under the terms of the Ruby license.
+# You can freely distribute/modify this library.
+#
+module Sphinx
+  VERSION = begin
+    require 'yaml'
+    config = YAML.load(File.read(File.dirname(__FILE__) + '/../VERSION.yml'))
+    "#{config[:major]}.#{config[:minor]}.#{config[:patch]}.#{config[:build]}"
+  end
+
+  # Base class for all Sphinx errors
+  class SphinxError < StandardError; end
+
+  # Connect error occurred on the API side.
+  class SphinxConnectError < SphinxError; end
+
+  # Request error occurred on the API side.
+  class SphinxResponseError < SphinxError; end
+
+  # Internal error occurred inside searchd.
+  class SphinxInternalError < SphinxError; end
+
+  # Temporary error occurred inside searchd.
+  class SphinxTemporaryError < SphinxError; end
+
+  # Unknown error occurred inside searchd.
+  class SphinxUnknownError < SphinxError; end
+end
+
+require 'net/protocol'
+require 'socket'
+require 'zlib'
+
+path = File.dirname(__FILE__)
+require "#{path}/sphinx/constants"
+require "#{path}/sphinx/indifferent_access"
+require "#{path}/sphinx/request"
+require "#{path}/sphinx/response"
+require "#{path}/sphinx/timeout"
+require "#{path}/sphinx/buffered_io"
+require "#{path}/sphinx/server"
+require "#{path}/sphinx/client"

data/spec/client_response_spec.rb

@@ -0,0 +1,170 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+# To execute these tests you need to execute sphinx_test.sql and configure sphinx using sphinx.conf
+# (both files are placed under sphinx directory)
+describe Sphinx::Client, 'connected' do
+  before :each do
+    @sphinx = Sphinx::Client.new
+  end
+  
+  context 'in Query method' do
+    it 'should parse response' do
+      result = @sphinx.Query('wifi', 'test1')
+      validate_results_wifi(result)
+    end
+
+    it 'should process 64-bit keys' do
+      result = @sphinx.Query('wifi', 'test2')
+      result['total_found'].should == 3
+      result['matches'].length.should == 3
+      result['matches'][0]['id'].should == 4294967298
+      result['matches'][1]['id'].should == 4294967299
+      result['matches'][2]['id'].should == 4294967297
+    end
+
+    it 'should process errors in Query method' do
+      @sphinx.Query('wifi', 'fakeindex').should be_false
+      @sphinx.GetLastError.should_not be_empty
+    end
+  end
+  
+  context 'in RunQueries method' do
+    it 'should parse batch-query responce' do
+      @sphinx.AddQuery('wifi', 'test1')
+      @sphinx.AddQuery('gprs', 'test1')
+      results = @sphinx.RunQueries
+      results.should be_an_instance_of(Array)
+      results.should have(2).items
+      validate_results_wifi(results[0])
+    end
+
+    it 'should process errors in RunQueries method' do
+      @sphinx.AddQuery('wifi', 'fakeindex')
+      r = @sphinx.RunQueries
+      r[0]['error'].should_not be_empty
+    end
+  end
+
+  context 'in BuildExcerpts method' do
+    it 'should parse response' do
+      result = @sphinx.BuildExcerpts(['what the world', 'London is the capital of Great Britain'], 'test1', 'the')
+      result.should == ['what <b>the</b> world', 'London is <b>the</b> capital of Great Britain']
+    end
+  end
+
+  context 'in BuildKeywords method' do
+    it 'should parse response' do
+      result = @sphinx.BuildKeywords('wifi gprs', 'test1', true)
+      result.should == [
+        { 'normalized' => 'wifi', 'tokenized' => 'wifi', 'hits' => 6, 'docs' => 3 },
+        { 'normalized' => 'gprs', 'tokenized' => 'gprs', 'hits' => 1, 'docs' => 1 }
+      ]
+    end
+  end
+
+  context 'in UpdateAttributes method' do
+    it 'should parse response' do
+      @sphinx.UpdateAttributes('test1', ['group_id'], { 2 => [1] }).should == 1
+      result = @sphinx.Query('wifi', 'test1')
+      result['matches'][0]['attrs']['group_id'].should == 1
+      @sphinx.UpdateAttributes('test1', ['group_id'], { 2 => [2] }).should == 1
+      result = @sphinx.Query('wifi', 'test1')
+      result['matches'][0]['attrs']['group_id'].should == 2
+    end
+
+    it 'should parse response with MVA' do
+      @sphinx.UpdateAttributes('test1', ['tags'], { 2 => [[1, 2, 3, 4, 5, 6, 7, 8, 9]] }, true).should == 1
+      result = @sphinx.Query('wifi', 'test1')
+      result['matches'][0]['attrs']['tags'].should == [1, 2, 3, 4, 5, 6, 7, 8, 9]
+      @sphinx.UpdateAttributes('test1', ['tags'], { 2 => [[5, 6, 7, 8]] }, true).should == 1
+      result = @sphinx.Query('wifi', 'test1')
+      result['matches'][0]['attrs']['tags'].should == [5, 6, 7, 8]
+    end
+  end
+
+  context 'in Open method' do
+    it 'should open socket' do
+      @sphinx.Open.should be_true
+      socket = @sphinx.servers.first.instance_variable_get(:@socket)
+      socket.should_not be_nil
+      socket.should be_kind_of(Sphinx::BufferedIO)
+      socket.close
+    end
+  
+    it 'should produce an error when opened twice' do
+      @sphinx.Open.should be_true
+      @sphinx.Open.should be_false
+      @sphinx.GetLastError.should == 'already connected'
+  
+      socket = @sphinx.servers.first.instance_variable_get(:@socket)
+      socket.should be_kind_of(Sphinx::BufferedIO)
+      socket.close
+    end
+  end
+  
+  context 'in Close method' do
+    it 'should open socket' do
+      @sphinx.Open.should be_true
+      @sphinx.Close.should be_true
+      @sphinx.servers.first.instance_variable_get(:@socket).should be_nil
+    end
+  
+    it 'should produce socket is closed' do
+      @sphinx.Close.should be_false
+      @sphinx.GetLastError.should == 'not connected'
+      @sphinx.servers.first.instance_variable_get(:@socket).should be_nil
+  
+      @sphinx.Open.should be_true
+      @sphinx.Close.should be_true
+      @sphinx.Close.should be_false
+      @sphinx.GetLastError.should == 'not connected'
+      @sphinx.servers.first.instance_variable_get(:@socket).should be_nil
+    end
+  end
+
+  context 'in Status method' do
+    it 'should parse response' do
+      response = @sphinx.Status
+      response.should be_an(Array)
+      response.size.should be > 10
+    end
+  end
+
+  def validate_results_wifi(result)
+    result['total_found'].should == 3
+    result['matches'].length.should == 3
+    result['time'].should_not be_nil
+    result['attrs'].should == {
+      'group_id' => Sphinx::SPH_ATTR_INTEGER,
+      'created_at' => Sphinx::SPH_ATTR_TIMESTAMP,
+      'rating' => Sphinx::SPH_ATTR_FLOAT,
+      'tags' => Sphinx::SPH_ATTR_MULTI | Sphinx::SPH_ATTR_INTEGER
+    }
+    result['fields'].should == [ 'name', 'description' ]
+    result['total'].should == 3
+    result['matches'].should be_an_instance_of(Array)
+
+    result['matches'][0]['id'].should == 2
+    result['matches'][0]['weight'].should == 2
+    result['matches'][0]['attrs']['group_id'].should == 2
+    result['matches'][0]['attrs']['created_at'].should == 1175658555
+    result['matches'][0]['attrs']['tags'].should == [5, 6, 7, 8]
+    ('%0.2f' % result['matches'][0]['attrs']['rating']).should == '54.85'
+
+    result['matches'][1]['id'].should == 3
+    result['matches'][1]['weight'].should == 2
+    result['matches'][1]['attrs']['group_id'].should == 1
+    result['matches'][1]['attrs']['created_at'].should == 1175658647
+    result['matches'][1]['attrs']['tags'].should == [1, 7, 9, 10]
+    ('%0.2f' % result['matches'][1]['attrs']['rating']).should == '16.25'
+
+    result['matches'][2]['id'].should == 1
+    result['matches'][2]['weight'].should == 1
+    result['matches'][2]['attrs']['group_id'].should == 1
+    result['matches'][2]['attrs']['created_at'].should == 1175658490
+    result['matches'][2]['attrs']['tags'].should == [1, 2, 3, 4]
+    ('%0.2f' % result['matches'][2]['attrs']['rating']).should == '13.32'
+
+    result['words'].should == { 'wifi' => { 'hits' => 6, 'docs' => 3 } }
+  end
+end