@@ -1,3 +1,5 @@ +h1. 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. @@ -5,28 +7,16 @@ 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. -The easiest way to install is to grab the gem from GitHub: - - sudo gem install freelancing-god-riddle --source http://gems.github.com/ - -However, if you're so inclined, you can grab sourcecode. - - git clone git://github.com/freelancing-god/thinking-sphinx.git +h2. Installation -If you're looking for old versions - for older versions of Sphinx - you'll want to peruse the tagged versions in the old subversion repository + sudo gem install riddle --source http://gemcutter.org - svn co http://rails-oceania.googlecode.com/svn/patallan/riddle/tags riddle-tags +h3. Usage -Please note that at the time of writing, the following versions are supported (if you get the appropriate tag): +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. -* 0.9.8-r871 -* 0.9.8-r909 -* 0.9.8-r985 -* 0.9.8-r1065 -* 0.9.8-r1112 -* 0.9.8-rc1 (gem version: 0.9.8.1198) -* 0.9.8-rc2 (gem version: 0.9.8.1231) -* 0.9.8 (gem version: 0.9.8.1371) + require 'riddle' + require 'riddle/0.9.9' To get started, just instantiate a Client object: README.textile @@ -1,30 +1,140 @@ +# 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{riddle} - s.version = "0.9.9.1785.7" + s.version = "1.0.0" s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.authors = ["Pat Allan"] - s.date = %q{2009-11-04} - s.description = %q{API for Sphinx, written in and for Ruby.} + s.date = %q{2009-11-09} + s.description = %q{A Ruby API and configuration helper for the Sphinx search service.} s.email = %q{pat@freelancing-gods.com} - s.files = ["lib/riddle/client/filter.rb", "lib/riddle/client/message.rb", "lib/riddle/client/response.rb", "lib/riddle/client.rb", "lib/riddle/configuration/distributed_index.rb", "lib/riddle/configuration/index.rb", "lib/riddle/configuration/indexer.rb", "lib/riddle/configuration/remote_index.rb", "lib/riddle/configuration/searchd.rb", "lib/riddle/configuration/section.rb", "lib/riddle/configuration/source.rb", "lib/riddle/configuration/sql_source.rb", "lib/riddle/configuration/xml_source.rb", "lib/riddle/configuration.rb", "lib/riddle/controller.rb", "lib/riddle.rb", "lib/tabtab_definitions.rb", "MIT-LICENCE", "README.textile", "spec/functional/excerpt_spec.rb", "spec/functional/keywords_spec.rb", "spec/functional/persistance_spec.rb", "spec/functional/search_spec.rb", "spec/functional/status_spec.rb", "spec/functional/update_spec.rb", "spec/unit/client_spec.rb", "spec/unit/configuration/distributed_index_spec.rb", "spec/unit/configuration/index_spec.rb", "spec/unit/configuration/indexer_spec.rb", "spec/unit/configuration/searchd_spec.rb", "spec/unit/configuration/source_spec.rb", "spec/unit/configuration/sql_source_spec.rb", "spec/unit/configuration/xml_source_spec.rb", "spec/unit/configuration_spec.rb", "spec/unit/filter_spec.rb", "spec/unit/message_spec.rb", "spec/unit/response_spec.rb", "spec/unit/riddle_spec.rb"] + s.extra_rdoc_files = [ + "README.textile" + ] + s.files = [ + "README.textile", + "lib/riddle.rb", + "lib/riddle/0.9.8.rb", + "lib/riddle/0.9.9.rb", + "lib/riddle/0.9.9/client.rb", + "lib/riddle/0.9.9/client/filter.rb", + "lib/riddle/client.rb", + "lib/riddle/client/filter.rb", + "lib/riddle/client/message.rb", + "lib/riddle/client/response.rb", + "lib/riddle/configuration.rb", + "lib/riddle/configuration/distributed_index.rb", + "lib/riddle/configuration/index.rb", + "lib/riddle/configuration/indexer.rb", + "lib/riddle/configuration/remote_index.rb", + "lib/riddle/configuration/searchd.rb", + "lib/riddle/configuration/section.rb", + "lib/riddle/configuration/source.rb", + "lib/riddle/configuration/sql_source.rb", + "lib/riddle/configuration/xml_source.rb", + "lib/riddle/controller.rb" + ] s.homepage = %q{http://riddle.freelancing-gods.com} - s.rdoc_options = ["--title", "Riddle -- Ruby Sphinx Client", "--main", "Riddle::Client", "--line-numbers"] + s.rdoc_options = ["--charset=UTF-8"] s.require_paths = ["lib"] - s.rubyforge_project = %q{riddle} s.rubygems_version = %q{1.3.5} - s.summary = %q{API for Sphinx, written in and for Ruby.} - s.test_files = ["spec/functional/excerpt_spec.rb", "spec/functional/keywords_spec.rb", "spec/functional/persistance_spec.rb", "spec/functional/search_spec.rb", "spec/functional/status_spec.rb", "spec/functional/update_spec.rb", "spec/unit/client_spec.rb", "spec/unit/configuration/distributed_index_spec.rb", "spec/unit/configuration/index_spec.rb", "spec/unit/configuration/indexer_spec.rb", "spec/unit/configuration/searchd_spec.rb", "spec/unit/configuration/source_spec.rb", "spec/unit/configuration/sql_source_spec.rb", "spec/unit/configuration/xml_source_spec.rb", "spec/unit/configuration_spec.rb", "spec/unit/filter_spec.rb", "spec/unit/message_spec.rb", "spec/unit/response_spec.rb", "spec/unit/riddle_spec.rb"] + s.summary = %q{An API for Sphinx, written in and for Ruby.} + s.test_files = [ + "spec/fixtures", + "spec/fixtures/data", + "spec/fixtures/data/anchor.bin", + "spec/fixtures/data/any.bin", + "spec/fixtures/data/boolean.bin", + "spec/fixtures/data/comment.bin", + "spec/fixtures/data/distinct.bin", + "spec/fixtures/data/field_weights.bin", + "spec/fixtures/data/filter.bin", + "spec/fixtures/data/filter_array.bin", + "spec/fixtures/data/filter_array_exclude.bin", + "spec/fixtures/data/filter_boolean.bin", + "spec/fixtures/data/filter_floats.bin", + "spec/fixtures/data/filter_floats_exclude.bin", + "spec/fixtures/data/filter_floats_range.bin", + "spec/fixtures/data/filter_range.bin", + "spec/fixtures/data/filter_range_exclude.bin", + "spec/fixtures/data/group.bin", + "spec/fixtures/data/index.bin", + "spec/fixtures/data/index_weights.bin", + "spec/fixtures/data/keywords_with_hits.bin", + "spec/fixtures/data/keywords_without_hits.bin", + "spec/fixtures/data/overrides.bin", + "spec/fixtures/data/phrase.bin", + "spec/fixtures/data/rank_mode.bin", + "spec/fixtures/data/select.bin", + "spec/fixtures/data/simple.bin", + "spec/fixtures/data/sort.bin", + "spec/fixtures/data/update_simple.bin", + "spec/fixtures/data/weights.bin", + "spec/fixtures/data_generator.0.9.8.php", + "spec/fixtures/data_generator.0.9.9.php", + "spec/fixtures/sphinx", + "spec/fixtures/sphinx/configuration.erb", + "spec/fixtures/sphinx/people.spa", + "spec/fixtures/sphinx/people.spd", + "spec/fixtures/sphinx/people.sph", + "spec/fixtures/sphinx/people.spi", + "spec/fixtures/sphinx/people.spk", + "spec/fixtures/sphinx/people.spm", + "spec/fixtures/sphinx/people.spp", + "spec/fixtures/sphinx/searchd.log", + "spec/fixtures/sphinx/searchd.query.log", + "spec/fixtures/sphinx/spec.conf", + "spec/fixtures/sphinxapi.0.9.8.php", + "spec/fixtures/sphinxapi.0.9.9.php", + "spec/fixtures/sql", + "spec/fixtures/sql/conf.example.yml", + "spec/fixtures/sql/conf.yml", + "spec/fixtures/sql/data.sql", + "spec/fixtures/sql/structure.sql", + "spec/functional", + "spec/functional/excerpt_spec.rb", + "spec/functional/keywords_spec.rb", + "spec/functional/persistance_spec.rb", + "spec/functional/search_spec.rb", + "spec/functional/status_spec.rb", + "spec/functional/update_spec.rb", + "spec/spec_helper.rb", + "spec/sphinx_helper.rb", + "spec/unit", + "spec/unit/client_spec.rb", + "spec/unit/configuration", + "spec/unit/configuration/distributed_index_spec.rb", + "spec/unit/configuration/index_spec.rb", + "spec/unit/configuration/indexer_spec.rb", + "spec/unit/configuration/searchd_spec.rb", + "spec/unit/configuration/source_spec.rb", + "spec/unit/configuration/sql_source_spec.rb", + "spec/unit/configuration/xml_source_spec.rb", + "spec/unit/configuration_spec.rb", + "spec/unit/filter_spec.rb", + "spec/unit/message_spec.rb", + "spec/unit/response_spec.rb", + "spec/unit/riddle_spec.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_development_dependency(%q<rspec>, [">= 1.2.9"]) + s.add_development_dependency(%q<yard>, [">= 0"]) else + s.add_dependency(%q<rspec>, [">= 1.2.9"]) + s.add_dependency(%q<yard>, [">= 0"]) end else + s.add_dependency(%q<rspec>, [">= 1.2.9"]) + s.add_dependency(%q<yard>, [">= 0"]) end end + riddle.gemspec 0486ed7f9de95c23efc007b16764319fce8f0996 Pat Allan pat@freelancing-gods.com http://github.com/freelancing-god/riddle/commit/5f0cff504b277e74717f6cd814eaf569c707e136 5f0cff504b277e74717f6cd814eaf569c707e136 2009-11-08T21:06:32-08:00 2009-11-08T21:06:32-08:00 Update for gemspec, readme 066c6d49fb5d7d8eff6b25f3e6c0aa0afa933f39 Pat Allan pat@freelancing-gods.com