riddle 1.5.12 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0743ec72ebf70708fe0cbdbfb63d44c307e7c798
+  data.tar.gz: a46b1a68d1104d21d7d63b52d712e313e6b48c6a
+SHA512:
+  metadata.gz: 6df640330c4c08a437e831de9c2a78c0d0fe55618bdad21ad36e80ef0b908f0f8f6445533c2a395122a0121cdc298dacb723ca98712d277f86ab2e72df8af9ea
+  data.tar.gz: 097f533203b245d59c2cdaccc52cca61bfefacb551e0c58e974e9a777d97b01e45c4ed843095d7119dc9889d6d83591926d0f5437ad330229d74fbeb6a81416e

data/.travis.yml

@@ -1,14 +1,11 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
   - 2.1
-  - jruby-18mode
+  - 2.2
 env:
-  - SPHINX_BIN=/usr/local/sphinx-2.0.9/bin SPHINX_VERSION=2.0.9
-  - SPHINX_BIN=/usr/local/sphinx-2.1.3/bin SPHINX_VERSION=2.1.3
-  - SPHINX_BIN=/usr/local/sphinx-2.2.1/bin SPHINX_VERSION=2.2.1
+  - SPHINX_BIN=/usr/local/sphinx-2.0.10/bin SPHINX_VERSION=2.0.10
+  - SPHINX_BIN=/usr/local/sphinx-2.1.9/bin SPHINX_VERSION=2.1.9
+  - SPHINX_BIN=/usr/local/sphinx-2.2.6/bin SPHINX_VERSION=2.2.6
 before_script: killall searchd; echo ''
 after_script:  killall searchd; echo ''
+sudo: false

data/Gemfile

@@ -2,5 +2,5 @@ source 'http://rubygems.org'
 
 gemspec
 
-gem 'mysql2',     '0.3.2',  :platform => :ruby
-gem 'jdbc-mysql', '5.1.13', :platform => :jruby
+gem 'mysql2',     '0.3.20', :platform => :ruby
+gem 'jdbc-mysql', '5.1.35', :platform => :jruby

data/HISTORY

@@ -1,3 +1,13 @@
+2.0.0 - September 25th 2016
+- Start and stop commands now accept a verbose option.
+- Failed commands (as determined by a non-zero status code) raise a Riddle::CommandFailedError exception.
+- A missing configuration file when running the start and stop commands now raises a Riddle::NoConfigurationFileError instance instead of a generic RuntimeError instance.
+- Riddle::Controller now returns Riddle::CommandResult instances for indexing, start and stop commands, which includes status code and (non-verbose) output.
+- Handle group_concat attribute types (@crazyshot, @bibendi).
+- Additional searchd settings: query_log_min_msec, agent_conect_timeout, agent_query_timeout, agent_retry_count, agent_retry_delay.
+- Default to 2.1.0 or newer support.
+- Move plugin_dir option from searchd to common.
+
 1.5.12 - June 1st 2015
 - Adding ? as an escaped character (Alexey Nikitin).
 - Adding contributor code of conduct.

data/README.markdown

@@ -0,0 +1,192 @@
+# Riddle
+
+[![Build Status](https://travis-ci.org/pat/riddle.svg?branch=develop)](https://travis-ci.org/pat/riddle)
+
+Riddle is a Ruby library interfacing with the [Sphinx](http://sphinxsearch.com/) full-text search tool. It is written by [Pat Allan](http://freelancing-gods.com), and has been influenced by both Dmytro Shteflyuk's Ruby client and the original PHP client. It can be used for interactions with Sphinx's command-line tools `searchd` and `indexer`, sending search queries via the binary protocol, and programmatically generating Sphinx configuration files.
+
+The syntax here, while closer to a usual Ruby approach than the PHP client, is quite old (Riddle was first published in 2007). While it would be nice to re-work things, it's really not a priority, given the bulk of Riddle's code is for Sphinx's deprecated binary protocol.
+
+## Installation
+
+Riddle is available as a gem, so you can install it directly:
+
+    gem install riddle
+
+Or include it in a Gemfile:
+
+    gem 'riddle', '~> 1.5.12'
+
+## Usage
+
+As of version 1.0.0, Riddle supports multiple versions of Sphinx in the one gem - you'll need to require your specific version after a normal require, though. The latest distinct version is `2.1.0`:
+
+	require 'riddle'
+	require 'riddle/2.1.0'
+
+The full list of versions available are `0.9.8` (the initial base), `0.9.9`, `1.10`, `2.0.1`, and `2.1.0`. If you're using something more modern than 2.1.0, then just require that, and the rest should be fine (changes to the binary protocol since then are minimal).
+
+### Configuration
+
+Riddle's structure for generating Sphinx configuration is very direct mapping to Sphinx's configuration options. First, create an instance of `Riddle::Configuration`:
+
+    config = Riddle::Configuration.new
+
+This configuration instance has methods `indexer`, `searchd` and `common`, which return separate inner-configuration objects with methods mapping to the equivalent [Sphinx settings](http://sphinxsearch.com/docs/current.html#conf-reference). So, you may want to do the following:
+
+    config.indexer.mem_limit = '128M'
+    config.searchd.log       = '/my/log/file.log'
+
+Similarly, there are two further methods `indices` and `sources`, which are arrays meant to hold instances of index and source inner-configuration objects respectively (all of which have methods matching their Sphinx settings). The available index classes are:
+
+* `Riddle::Configuration::DistributedIndex`
+* `Riddle::Configuration::Index`
+* `Riddle::Configuration::RealtimeIndex`
+* `Riddle::Configuration::RemoteIndex`
+* `Riddle::Configuration::TemplateIndex`
+
+All of these index classes should be initialised with their name, and in the case of plain indices, their source objects. Remote indices take an address, port and name as their initialiser parameters.
+
+    index = Riddle::Configuration::Index.new 'articles', article_source_a, article_source_b
+    index.path    = '/path/to/index/files"
+    index.docinfo = 'external'
+
+The available source classes are:
+
+* `Riddle::Configuration::SQLSource`
+* `Riddle::Configuration::TSVSource`
+* `Riddle::Configuration::XMLSource`
+
+The initialising parameters are the name of the source, and the type of source:
+
+    source = Riddle::Configuration::SQLSource.new 'article_source', 'mysql'
+    source.sql_query = "SELECT id, title, body FROM articles"
+    source.sql_host  = "127.0.0.1"
+
+Once you have created your configuration object tree, you can then generate the string representation and perhaps save it to a file:
+
+    File.write "sphinx.conf", configuration.render
+
+It's also possible to parse an existing Sphinx configuration file into a configuration option tree:
+
+    configuration = Riddle::Configuration.parse! File.read('sphinx.conf')
+
+### Indexing and Starting/Stopping the Daemon
+
+using Sphinx's command-line tools `indexer` and `searchd` via Riddle is all done via an instance of `Riddle::Controller`:
+
+    configuration_file = "/path/to/sphinx.conf"
+    configuration      = Riddle::Configuration.parse! File.read(configuration_file)
+    controller         = Riddle::Controller.new configuration, configuration_file
+
+    # set the path where the indexer and searchd binaries are located:
+    controller.bin_path = '/usr/local/bin'
+
+    # set different binary names if you're running a custom Sphinx installation:
+    controller.searchd_binary_name = 'sphinxsearchd'
+    controller.indexer_binary_name = 'sphinxindexer'
+
+    # process all indices:
+    controller.index
+    # process specific indices:
+    controller.index 'articles', 'books'
+    # rotate old index files out for the new ones:
+    controller.rotate
+
+    # start the daemon:
+    controller.start
+    # start the daemon and do not detach the process:
+    controller.start :nodetach => true
+    # stop the daemon:
+    controller.stop
+
+The index, start and stop methods all accept a hash of options, and the :verbose option is respected in each case.
+
+Each of these methods will return an instance of `Riddle::CommandResult` - or, if the command fails (as judged by the process status code), a `Riddle::CommandFailedError` exception is raised. These exceptions respond to the `command_result` method with the corresponding details.
+
+### SphinxQL Queries
+
+Riddle does not have any code to send SphinxQL queries and commands to Sphinx. Because Sphinx uses the mysql41 protocol (thus, mimicing a MySQL database server), I recommend using the [mysql2](https://github.com/brianmario/mysql2) gem instead. The [connection code](https://github.com/pat/thinking-sphinx/blob/develop/lib/thinking_sphinx/connection.rb) in Thinking Sphinx may provide some inspiration on this.
+
+### Binary Protocol Searching
+
+Sphinx's legacy binary protocol does not have many of the more recent Sphinx features - such as real-time indices - as these are only available in the SphinxQL/mysql41 protocol. However, Riddle can still be used for the binary protocol if you wish.
+
+To get started, just instantiate a Client object:
+
+	client = Riddle::Client.new # defaults to localhost and port 9312
+	client = Riddle::Client.new "sphinxserver.domain.tld", 3333 # custom settings
+
+And then set the parameters to what you want, before running a query:
+
+	client.match_mode = :extended
+	client.query "Pat Allan @state Victoria"
+
+The results from a query are similar to the other clients - but here's the details. It's a hash with
+the following keys:
+
+* `:matches`
+* `:fields`
+* `:attributes`
+* `:attribute_names`
+* `:words`
+* `:total`
+* `:total_found`
+* `:time`
+* `:status`
+* `:warning` (if appropriate)
+* `:error` (if appropriate)
+
+The key `:matches` returns an array of hashes - the actual search results. Each hash has the document id (`:doc`), the result weighting (`:weight`), and a hash of the attributes for the document (`:attributes`).
+
+The `:fields` and `:attribute_names` keys return list of fields and attributes for the documents. The key `:attributes` will return a hash of attribute name and type pairs, and `:words` returns a hash of hashes representing the words from the search, with the number of documents and hits for each, along the lines of:
+
+    results[:words]["Pat"] #=> {:docs => 12, :hits => 15}
+
+`:total`, `:total_found` and `:time` return the number of matches available, the total number of matches (which may be greater than the maximum available), and the time in milliseconds that the query took to run.
+
+`:status` is the error code for the query - and if there was a related warning, it will be under the `:warning` key. Fatal errors will be described under `:error`.
+
+## Contributing
+
+Please note that this project has a [Contributor Code of Conduct](http://contributor-covenant.org/version/1/0/0/). By participating in this project you agree to abide by its terms.
+
+Riddle uses the [git-flow](http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/) process for development. The `master` branch is the latest released code (in a gem). The `develop` branch is what's coming in the next release. (There may be occasional feature and hotfix branches, although these are generally not pushed to GitHub.)
+
+When submitting a patch to Riddle, please submit your pull request against the `develop` branch.
+
+## Contributors
+
+Thanks to the following people who have contributed to Riddle in some shape or form:
+
+* Andrew Aksyonoff
+* Brad Greenlee
+* Lachie Cox
+* Jeremy Seitz
+* Mark Lane
+* Xavier Noria
+* Henrik Nye
+* Kristopher Chambers
+* Rob Anderton
+* Dylan Egan
+* Jerry Vos
+* Piotr Sarnacki
+* Tim Preston
+* Amir Yalon
+* Sam Goldstein
+* Matt Todd
+* Paco Guzmán
+* Greg Weber
+* Enrico Thierbach
+* Jason Lambert
+* Saberma
+* James Cook
+* Alexey Artamonov
+* Paul Gibler
+* Ngan Pham
+* Aaron Gilbralter
+* Steven Bristol
+* Ilia Lobsanov
+* Aleksey Morozov
+* S\. Christoffer Eliesen
+* Rob Golkosky
+* Darcy Brown

data/lib/riddle.rb

@@ -67,8 +67,11 @@ end
 
 require 'riddle/auto_version'
 require 'riddle/client'
+require 'riddle/command_failed_error'
+require 'riddle/command_result'
 require 'riddle/configuration'
 require 'riddle/controller'
+require 'riddle/execute_command'
 require 'riddle/query'
 
 Riddle.loaded_version = nil

data/lib/riddle/auto_version.rb

@@ -10,7 +10,7 @@ class Riddle::AutoVersion
       require 'riddle/1.10'
     when /2.0.[12]/
       require 'riddle/2.0.1'
-    when /2.0.[^12]/, /2.1.\d/, /2.2.\d/
+    else
       require 'riddle/2.1.0'
     end
   end

data/lib/riddle/client.rb

@@ -92,14 +92,15 @@ module Riddle
     }
 
     AttributeTypes = {
-      :integer    => 1, # SPH_ATTR_INTEGER
-      :timestamp  => 2, # SPH_ATTR_TIMESTAMP
-      :ordinal    => 3, # SPH_ATTR_ORDINAL
-      :bool       => 4, # SPH_ATTR_BOOL
-      :float      => 5, # SPH_ATTR_FLOAT
-      :bigint     => 6, # SPH_ATTR_BIGINT
-      :string     => 7, # SPH_ATTR_STRING
-      :multi      => 0x40000000 # SPH_ATTR_MULTI
+      :integer      => 1, # SPH_ATTR_INTEGER
+      :timestamp    => 2, # SPH_ATTR_TIMESTAMP
+      :ordinal      => 3, # SPH_ATTR_ORDINAL
+      :bool         => 4, # SPH_ATTR_BOOL
+      :float        => 5, # SPH_ATTR_FLOAT
+      :bigint       => 6, # SPH_ATTR_BIGINT
+      :string       => 7, # SPH_ATTR_STRING
+      :group_concat => 10,
+      :multi        => 0x40000000 # SPH_ATTR_MULTI
     }
 
     GroupFunctions = {
@@ -830,13 +831,14 @@ module Riddle
     end
 
     AttributeHandlers = {
-      AttributeTypes[:integer]   => :next_int,
-      AttributeTypes[:timestamp] => :next_int,
-      AttributeTypes[:ordinal]   => :next_int,
-      AttributeTypes[:bool]      => :next_int,
-      AttributeTypes[:float]     => :next_float,
-      AttributeTypes[:bigint]    => :next_64bit_int,
-      AttributeTypes[:string]    => :next,
+      AttributeTypes[:integer]      => :next_int,
+      AttributeTypes[:timestamp]    => :next_int,
+      AttributeTypes[:ordinal]      => :next_int,
+      AttributeTypes[:bool]         => :next_int,
+      AttributeTypes[:float]        => :next_float,
+      AttributeTypes[:bigint]       => :next_64bit_int,
+      AttributeTypes[:string]       => :next,
+      AttributeTypes[:group_concat] => :next,
       AttributeTypes[:multi] + AttributeTypes[:integer] => :next_int_array
     }
 

data/lib/riddle/command_failed_error.rb

@@ -0,0 +1,3 @@
+class Riddle::CommandFailedError < StandardError
+  attr_accessor :command_result
+end

data/lib/riddle/command_result.rb

@@ -0,0 +1,14 @@
+class Riddle::CommandResult
+  attr_reader   :command, :status, :output
+  attr_accessor :successful
+
+  def initialize(command, status, output = nil, successful = nil)
+    @command, @status, @output = command, status, output
+
+    if successful.nil?
+      @successful = (@status == 0)
+    else
+      @successful = successful
+    end
+  end
+end

data/lib/riddle/configuration/common.rb

@@ -5,7 +5,7 @@ module Riddle
         [
           :lemmatizer_base, :json_autoconv_numbers, :json_autoconv_keynames,
           :on_json_attr_error, :rlp_root, :rlp_environment, :rlp_max_batch_size,
-          :rlp_max_batch_docs
+          :rlp_max_batch_docs, :plugin_dir
         ]
       end
 

data/lib/riddle/configuration/searchd.rb

@@ -12,13 +12,15 @@ module Riddle
           :max_batch_queries, :subtree_docs_cache, :subtree_hits_cache,
           :workers, :dist_threads, :binlog_path, :binlog_flush,
           :binlog_max_log_size, :snippets_file_prefix, :collation_server,
-          :collation_libc_locale, :plugin_dir, :mysql_version_string,
+          :collation_libc_locale, :mysql_version_string,
           :rt_flush_period, :thread_stack, :expansion_limit,
           :compat_sphinxql_magics, :watchdog, :prefork_rotation_throttle,
           :sphinxql_state, :ha_ping_interval, :ha_period_karma,
           :persistent_connections_limit, :rt_merge_iops, :rt_merge_maxiosize,
           :predicted_time_costs, :snippets_file_prefix, :shutdown_timeout,
-          :ondisk_attrs_default, :client_key
+          :ondisk_attrs_default, :query_log_min_msec, :agent_connect_timeout,
+          :agent_query_timeout, :agent_retry_count, :agenty_retry_delay,
+          :client_key
         ]
       end
 

data/lib/riddle/controller.rb

@@ -1,4 +1,6 @@
 module Riddle
+  NoConfigurationFileError = Class.new StandardError
+
   class Controller
     attr_accessor :path, :bin_path, :searchd_binary_name, :indexer_binary_name
 
@@ -21,55 +23,41 @@ module Riddle
       options = indices.last.is_a?(Hash) ? indices.pop : {}
       indices << '--all' if indices.empty?
 
-      cmd = "#{indexer} --config \"#{@path}\" #{indices.join(' ')}"
-      cmd << " --rotate" if running?
-      options[:verbose] ? system(cmd) : `#{cmd}`
+      command = "#{indexer} --config \"#{@path}\" #{indices.join(' ')}"
+      command << " --rotate" if running?
+
+      Riddle::ExecuteCommand.call command, options[:verbose]
     end
 
-    def start(options={})
+    def start(options = {})
       return if running?
       check_for_configuration_file
 
-      cmd = "#{searchd} --pidfile --config \"#{@path}\""
-      cmd << " --nodetach" if options[:nodetach]
-
-      if options[:nodetach]
-        exec(cmd)
-      elsif RUBY_PLATFORM =~ /mswin|mingw/
-        output = system("start /B #{cmd} 1> NUL 2>&1")
-      else
-        output = `#{cmd}`
-      end
+      command = "#{searchd} --pidfile --config \"#{@path}\""
+      command << " --nodetach" if options[:nodetach]
 
-      sleep(1)
+      exec(command) if options[:nodetach]
 
-      unless running?
-        puts "Failed to start searchd daemon. Check #{@configuration.searchd.log}."
-      end
-      
-      output
+      # Code does not get here if nodetach is true.
+      Riddle::ExecuteCommand.call command, options[:verbose]
     end
 
-    def stop
+    def stop(options = {})
       return true unless running?
       check_for_configuration_file
 
       stop_flag = 'stopwait'
       stop_flag = 'stop' if Riddle.loaded_version.split('.').first == '0'
-      cmd = %(#{searchd} --pidfile --config "#{@path}" --#{stop_flag})
+      command = %(#{searchd} --pidfile --config "#{@path}" --#{stop_flag})
 
-      if RUBY_PLATFORM =~ /mswin|mingw/
-        system("start /B #{cmd} 1> NUL 2>&1")
-      else
-        `#{cmd}`
-      end
-
-      !running?
+      result = Riddle::ExecuteCommand.call command, options[:verbose]
+      result.successful = !running?
+      result
     end
 
     def pid
-      if File.exists?(@configuration.searchd.pid_file)
-        File.read(@configuration.searchd.pid_file)[/\d+/]
+      if File.exists?(configuration.searchd.pid_file)
+        File.read(configuration.searchd.pid_file)[/\d+/]
       else
         nil
       end
@@ -87,6 +75,8 @@ module Riddle
 
     private
 
+    attr_reader :configuration
+
     def indexer
       "#{bin_path}#{indexer_binary_name}"
     end
@@ -97,7 +87,8 @@ module Riddle
 
     def check_for_configuration_file
       return if File.exist?(@path)
-      raise "Configuration file '#{@path}' does not exist"
+
+      raise Riddle::NoConfigurationFileError, "'#{@path}' does not exist"
     end
   end
 end

data/lib/riddle/execute_command.rb

@@ -0,0 +1,45 @@
+class Riddle::ExecuteCommand
+  WINDOWS = (RUBY_PLATFORM =~ /mswin|mingw/)
+
+  def self.call(command, verbose = true)
+    new(command, verbose).call
+  end
+
+  def initialize(command, verbose)
+    @command, @verbose = command, verbose
+
+    return unless WINDOWS
+
+    @command = "start /B #{@command} 1> NUL 2>&1"
+    @verbose = true
+  end
+
+  def call
+    result = verbose? ? result_from_system : result_from_backticks
+    return result if result.status == 0
+
+    error = Riddle::CommandFailedError.new "Sphinx command failed to execute"
+    error.command_result = result
+    raise error
+  end
+
+  private
+
+  attr_reader :command, :verbose
+
+  def result_from_backticks
+    output = `#{command}`
+
+    Riddle::CommandResult.new command, $?.exitstatus, output
+  end
+
+  def result_from_system
+    system command
+
+    Riddle::CommandResult.new command, $?.exitstatus
+  end
+
+  def verbose?
+    verbose
+  end
+end

data/riddle.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'riddle'
-  s.version     = '1.5.12'
+  s.version     = '2.0.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Pat Allan']
   s.email       = ['pat@freelancing-gods.com']

metadata

@@ -1,86 +1,70 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: riddle
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 1
-  - 5
-  - 12
-  version: 1.5.12
+version: !ruby/object:Gem::Version
+  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2015-06-01 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2016-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 9
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.9.2
-  prerelease: false
   type: :development
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
   name: rspec
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.5.0
-  prerelease: false
   type: :development
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
   name: yard
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 7
-        - 2
+      - !ruby/object:Gem::Version
         version: 0.7.2
-  prerelease: false
   type: :development
-  requirement: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 description: A Ruby API and configuration helper for the Sphinx search service.
-email: 
+email:
 - pat@freelancing-gods.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .travis.yml
+files:
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - HISTORY
 - LICENCE
-- README.textile
+- README.markdown
 - Rakefile
 - lib/riddle.rb
 - lib/riddle/0.9.8.rb
@@ -98,6 +82,8 @@ files:
 - lib/riddle/client/filter.rb
 - lib/riddle/client/message.rb
 - lib/riddle/client/response.rb
+- lib/riddle/command_failed_error.rb
+- lib/riddle/command_result.rb
 - lib/riddle/configuration.rb
 - lib/riddle/configuration/common.rb
 - lib/riddle/configuration/distributed_index.rb
@@ -115,6 +101,7 @@ files:
 - lib/riddle/configuration/tsv_source.rb
 - lib/riddle/configuration/xml_source.rb
 - lib/riddle/controller.rb
+- lib/riddle/execute_command.rb
 - lib/riddle/query.rb
 - lib/riddle/query/delete.rb
 - lib/riddle/query/insert.rb
@@ -283,39 +270,30 @@ files:
 - spec/unit/response_spec.rb
 - spec/unit/riddle_spec.rb
 homepage: http://pat.github.io/riddle/
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: riddle
-rubygems_version: 1.8.25
+rubygems_version: 2.4.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An API for Sphinx, written in and for Ruby.
-test_files: 
+test_files:
 - spec/fixtures/.gitignore
 - spec/fixtures/data/0.9.9/anchor.bin
 - spec/fixtures/data/0.9.9/any.bin

data/README.textile

@@ -1,101 +0,0 @@
-h1. Riddle
-
-"!https://secure.travis-ci.org/pat/riddle.png!":http://travis-ci.org/pat/riddle
-
-This client has been written to interface with "Sphinx":http://sphinxsearch.com/. It is written by "Pat Allan":http://freelancing-gods.com, and has been influenced by both Dmytro Shteflyuk's Ruby client and the original PHP client - credit where credit's due, after all.
-
-It does not follow the same syntax as those two, though (not much point writing this otherwise) - opting for a more Ruby-like structure.
-
-h2. Installation
-
-<pre><code>sudo gem install riddle</code></pre>
-
-h3. Usage
-
-As of version 1.0.0, Riddle now supports multiple versions of Sphinx in the one gem - you'll need to require your specific version after a normal require, though.
-
-<pre><code>require 'riddle'
-require 'riddle/0.9.9'</code></pre>
-
-To get started, just instantiate a Client object:
-
-<pre><code>client = Riddle::Client.new # defaults to localhost and port 9312
-client = Riddle::Client.new "sphinxserver.domain.tld", 3333 # custom settings</code></pre>
-
-And then set the parameters to what you want, before running a query:
-
-<pre><code>client.match_mode = :extended
-client.query "Pat Allan @state Victoria"</code></pre>
-
-The results from a query are similar to the other clients - but here's the details. It's a hash with
-the following keys:
-
-* @:matches@
-* @:fields@
-* @:attributes@
-* @:attribute_names@
-* @:words@
-* @:total@
-* @:total_found@
-* @:time@
-* @:status@
-* @:warning@ (if appropriate)
-* @:error@ (if appropriate)
-
-The key @:matches@ returns an array of hashes - the actual search results. Each hash has the document id (@:doc@), the result weighting (@:weight@), and a hash of the attributes for the document (@:attributes@).
-
-The @:fields@ and @:attribute_names@ keys return list of fields and attributes for the documents. The key @:attributes@ will return a hash of attribute name and type pairs, and @:words@ returns a hash of hashes representing the words from the search, with the number of documents and hits for each, along the lines of:
-
-<pre><code>results[:words]["Pat"] #=> {:docs => 12, :hits => 15}</code></pre>
-
-@:total@, @:total_found@ and @:time@ return the number of matches available, the
-total number of matches (which may be greater than the maximum available), and the time in milliseconds that the query took to run.
-
-@:status@ is the error code for the query - and if there was a related warning, it will be under the @:warning@ key. Fatal errors will be described under @:error@.
-
-If you've installed the gem and wondering why there's no tests - check out the git version. I've kept the specs out of the gem as I have a decent amount of test data in there, which really isn't needed unless you want to submit patches.
-
-h2. Contributing
-
-Please note that this project now has a "Contributor Code of Conduct":http://contributor-covenant.org/version/1/0/0/. By participating in this project you agree to abide by its terms.
-
-Riddle uses the "git-flow":http://jeffkreeftmeijer.com/2010/why-arent-you-using-git-flow/ process for development. The "master" branch is the latest released code (in a gem). The "develop" branch is what's coming in the next release. (There may be occasional feature and hotfix branches, although these are generally not pushed to GitHub.)
-
-When submitting a patch to riddle, please submit your pull request against the "develop" branch.
-
-h2. Contributors
-
-Thanks to the following people who have contributed to Riddle in some shape or form:
-
-* Andrew Aksyonoff
-* Brad Greenlee
-* Lachie Cox
-* Jeremy Seitz
-* Mark Lane
-* Xavier Noria
-* Henrik Nye
-* Kristopher Chambers
-* Rob Anderton
-* Dylan Egan
-* Jerry Vos
-* Piotr Sarnacki
-* Tim Preston
-* Amir Yalon
-* Sam Goldstein
-* Matt Todd
-* Paco Guzmán
-* Greg Weber
-* Enrico Thierbach
-* Jason Lambert
-* Saberma
-* James Cook
-* Alexey Artamonov
-* Paul Gibler
-* Ngan Pham
-* Aaron Gilbralter
-* Steven Bristol
-* Ilia Lobsanov
-* Aleksey Morozov
-* S. Christoffer Eliesen
-* Rob Golkosky
-* Darcy Brown