redisearch-rb 0.1.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+ruby '2.4.0'
+
+gem 'redis', '~> 4.0.0.rc1'
+
+group :development, :test do
+  gem 'subprocess'
+  gem 'minitest', '~> 5.0'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 vruizext
+
+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.md

@@ -0,0 +1,69 @@
+# redisearch-rb
+
+A simple Ruby client for RediSearch module
+http://redisearch.io/
+
+
+## Installation
+
+First of all, you need to install RediSearch, if you haven't yet:
+
+1. Install Redis 4.0.0-rc3 https://github.com/antirez/redis/releases/tag/4.0-rc3
+2. Install RediSearch 0.16 http://redisearch.io/Quick_Start/
+3. Edit your `redis.conf` file and add a `loadmodule` directive to load the RediSearch module.
+4. You have to
+To install this gem, add this line to your application's Gemfile:
+
+```ruby
+gem 'redisearch-rb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install redisearch-rb
+
+## Usage
+
+
+```ruby
+require 'redisearch-rb'
+
+redis = Redis.new(REDIS_URL)
+redisearch_client = RediSearch.new('test_idx', redis)
+
+schema = ['title', 'TEXT', 'WEIGHT', '2.0',
+          'director', 'TEXT', 'WEIGHT', '1.0',
+          'year', 'NUMERIC']
+
+redisearch_client.create_index(schema)
+# => "OK"
+
+docs = [['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']],
+        ['id_2', ['title', 'Ex Machina', 'director', 'Alex Garland', 'year', '2014']]]
+redisearch_client.add_docs(docs)
+# => ["OK", "OK"]
+
+# See query syntax here: http://redisearch.io/Query_Syntax/
+redisearch_client.search('lost|machina', { withscores: true })
+# => [{"title"=>"Ex Machina", "director"=>"Alex Garland", "year"=>"2014", "score"=>"2", "id"=>"id_2"},
+   {"title"=>"Lost in translation", "director"=>"Sofia Coppola", "year"=>"2004", "score"=>"1", "id"=>"id_1"}]
+
+redisearch_client.search('@year:[2003 2004]')
+# => [{"title"=>"Lost in translation", "director"=>"Sofia Coppola", "year"=>"2004", "id"=>"id_1"}]
+```
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vruizext/redisearch-rb.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/redisearch-rb.rb

@@ -0,0 +1,2 @@
+require 'redisearch'
+require 'redisearch/version'

data/lib/redisearch.rb

@@ -0,0 +1,150 @@
+require 'redis'
+
+##
+# Ruby client for RediSearch module
+# http://redisearch.io/
+#
+class RediSearch
+  # VERSION = '0.1.0'
+
+  # Create RediSearch client instance
+  #
+  # @param [String] idx_name name of the index
+  # @param [Redis] redis_client Redis instance
+  # If no `redis_client` is given, `RediSearch` tries to connect to the default redis url
+  # i.e. redis://127.0.0.1:6379
+  #
+  # @return [RediSearch] a new client instance
+  def initialize(idx_name, redis_client = nil)
+    @idx_name = idx_name
+    @redis = redis_client || Redis.new
+  end
+
+  # Create new index with the given `schema`
+  # @param [Array] schema
+  #
+  # Example:
+  #
+  #   redisearch = RediSearch.new('my_idx')
+  #   redisearch.create_idx(['title', 'TEXT', 'WEIGHT', '2.0', 'director', 'TEXT', 'WEIGHT', '1.0'])
+  #
+  # See http://redisearch.io/Commands/#ftcreate
+  #
+  # @return [String] "OK" on success
+  def create_index(schema)
+    call(ft_create(schema))
+  end
+
+  # Drop all the keys in the current index
+  #
+  # See http://redisearch.io/Commands/#ftdrop
+  # @return [String] "OK" on success
+  def drop_index
+    call(ft_drop)
+  end
+
+  # Add a single doc to the index, with the given `doc_id` and `fields`
+  #
+  # @param [String] doc_id id assigned to the document
+  # @param [Array] fields name-value pairs to be indexed
+  #
+  # Example:
+  #
+  #   redisearch = RediSearch.new('my_idx')
+  #   redisearch.add_doc('id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola'])
+  #
+  # See http://redisearch.io/Commands/#ftadd
+  # @return [String] "OK" on success
+  def add_doc(doc_id, fields)
+    call(ft_add(doc_id, fields))
+  end
+
+  # Add a set of docs to the index. Uses redis `multi` to make a single bulk insert.
+  #
+  # @param [Array] docs array of tuples doc_id-fields e.g. [[`id_1`, [fields_doc_1]], [`id_2`, [fields_doc_2]]]
+  #
+  # Example:
+  #
+  #   redisearch = RediSearch.new('my_idx')
+  #   docs = [['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola'],
+  #           ['id_2', ['title', 'Ex Machina', 'director', 'Alex Garland']]
+  #   redisearch.add_docs(docs)
+  #
+  # See http://redisearch.io/Commands/#ftadd
+  # @return [String] "OK" on success
+  def add_docs(docs)
+    multi { docs.each { |doc_id, fields| @redis.call(ft_add(doc_id, fields)) } }
+  end
+
+  # Search the index with the given `query`
+  # @param [String] query text query, see syntax here http://redisearch.io/Query_Syntax/
+  # @param [Hash] opts
+  # @option opts [Boolean] :nostopwords If `true` do not filter stopwords from the query.
+  #
+  #
+  def search(query, opts = {})
+    results_to_hash(call(ft_search(query, opts)))
+  end
+
+  def info
+    call(ft_info)
+  end
+
+  private
+
+  def multi
+    @redis.with_reconnect { @redis.multi { yield } }
+  end
+
+  def call(command)
+    @redis.with_reconnect { @redis.call(command) }
+  end
+
+  def add(doc_id, fields)
+    @redis.call(ft_add(doc_id, fields))
+  end
+
+  def ft_create(schema)
+    ['FT.CREATE', @idx_name , 'SCHEMA', *schema]
+  end
+
+  def ft_drop
+    ['FT.DROP', @idx_name]
+  end
+
+  def ft_info
+    ['FT.INFO', @idx_name]
+  end
+
+  def ft_add(doc_id, fields)
+    ['FT.ADD', @idx_name , doc_id, '1.0', 'REPLACE', 'FIELDS', *fields]
+  end
+
+  def ft_search(query, opts)
+    command = ['FT.SEARCH', @idx_name, *query]
+    command << 'NOSTOPWORDS' if opts[:nostopwords]
+    command << 'VERBATIM' if opts[:verbatim]
+    if opts[:offset] || opts[:limit]
+      limit = opts[:limit].to_i > 0 ? opts[:limit].to_i : -1
+      command << "LIMIT #{opts[:offset].to_i} #{limit}"
+    end
+    command << 'WITHSCORES' if opts[:withscores]
+    command << "SCORER #{opts[:scorer]}" unless opts[:scorer].to_s.empty?
+    command << "SLOP #{opts[:slop]}" if opts[:slop].to_i > 0
+    command
+  end
+
+  def results_to_hash(results)
+    return {} if results.nil? || results[0] == 0
+    results.shift
+    offset = results.size % 3 == 0 ? 1 : 0
+    rows_per_doc = 2 + offset
+    nr_of_docs = results.size / (2 + offset)
+    (0..nr_of_docs-1).map do |n|
+      doc = Hash[*results[rows_per_doc * n + 1 + offset]]
+      doc['score'] = results[rows_per_doc * n + offset] if offset > 0
+      doc['id'] = results[rows_per_doc * n]
+      doc
+    end
+  end
+end

data/lib/redisearch/version.rb

@@ -0,0 +1,3 @@
+class RediSearch
+  VERSION = '0.1.3'
+end

data/redisearch-rb.gemspec

@@ -0,0 +1,18 @@
+# coding: utf-8
+require File.expand_path('../lib/redisearch/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "redisearch-rb"
+  spec.version       =  RediSearch::VERSION
+  spec.authors       = ["Victor Ruiz"]
+  spec.email         = ["vruizext@gmail.com"]
+
+  spec.summary       = "A simple Ruby client library for RediSearch"
+  spec.description   = "A simple Ruby client library for RediSearc. RediSearch is a Full-Text search index over Redis,
+                        developed by RedisLabs. http://redisearch.io/"
+  spec.homepage      = "https://github.com/vruizext/redisearch-rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test}/*`.split("\n")
+end

data/test/redisearch_test.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+class RediSearchTest < Minitest::Test
+  REDIS_URL = 'redis://127.0.0.1:6379'
+
+  def setup
+    @redis_server = RedisTestServer.new
+    fail('error starting redis-server') unless @redis_server.start
+    sleep(0.25)
+    @redis_client = Redis.new(url: REDIS_URL)
+    @redis_client.flushdb
+    @redisearch_client = RediSearch.new('test_idx', @redis_client)
+    @schema = ['title', 'TEXT', 'WEIGHT', '2.0',
+               'director', 'TEXT', 'WEIGHT', '1.0',
+               'year', 'NUMERIC']
+
+  end
+
+  def teardown
+    @redis_server&.stop
+  end
+
+  def test_that_it_has_a_version_number
+    refute_nil ::RediSearch::VERSION
+  end
+
+  def test_create_idx
+    assert @redisearch_client.create_index(@schema)
+    info = @redis_client.call(['FT.INFO', 'test_idx'])
+    assert_includes(info, 'test_idx')
+  end
+
+  def test_create_idx_fails_with_wrong_schema
+    @schema << ['foo', 'BAR', 'WEIGHT', 'woz']
+    assert_raises(Redis::CommandError) { @redisearch_client.create_index(@schema) }
+  end
+
+  def test_drop_idx
+    assert(@redisearch_client.create_index(@schema))
+    assert(@redisearch_client.drop_index)
+    assert_raises(Redis::CommandError) { @redisearch_client.info }
+  end
+
+  def test_add_doc
+    assert(@redisearch_client.create_index(@schema))
+    doc = ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']
+    assert(@redisearch_client.add_doc('id_1', doc))
+    assert_includes(@redis_client.call(['FT.SEARCH', 'test_idx', 'lost']).to_s, 'Lost in translation')
+  end
+
+  def test_add_docs
+    assert(@redisearch_client.create_index(@schema))
+    docs = [['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']],
+            ['id_2', ['title', 'Ex Machina', 'director', 'Alex Garland', 'year', '2014']]]
+    assert(@redisearch_client.add_docs(docs))
+    search_result = @redis_client.call(['FT.SEARCH', 'test_idx', 'lost|ex'])
+    assert_includes(search_result.to_s, 'Lost in translation')
+    assert_includes(search_result.to_s, 'Ex Machina')
+  end
+
+  def test_search_simple_query
+    assert(@redisearch_client.create_index(@schema))
+    docs = [['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']],
+            ['id_2', ['title', 'Ex Machina', 'director', 'Alex Garland', 'year', '2014']]]
+    assert(@redisearch_client.add_docs(docs))
+    matches = @redisearch_client.search('lost|machina', { withscores: true })
+    assert_equal(2, matches.count)
+    assert matches.any? { |doc| 'Lost in translation' == doc['title'] }
+    assert matches.any? { |doc| 'Ex Machina' == doc['title'] }
+    matches.each { |doc| assert doc['score'].to_i > 0 }
+  end
+
+  def test_search_field_selector
+    assert(@redisearch_client.create_index(@schema))
+    doc = ['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']]
+    assert(@redisearch_client.add_doc(*doc))
+    matches = @redisearch_client.search('@title:lost')
+    assert_equal(1, matches.count)
+    assert 'Lost in translation' == matches[0]['title']
+    assert_empty @redisearch_client.search('@director:lost')
+    assert_equal 1, @redisearch_client.search('@year:[2004 2005]').count
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'logger'
+require 'minitest/autorun'
+require 'subprocess'
+
+require './lib/redisearch'
+
+class RedisTestServer
+  DEFAULT_REDIS_PATH = 'redis-server'
+  DEFAULT_REDIS_CONFIG = './test/redis/redis.conf'
+
+  attr_reader :process
+
+  def initialize(path = nil, config = nil)
+    @path = path || DEFAULT_REDIS_PATH
+    @config = config || DEFAULT_REDIS_CONFIG
+  end
+
+  def start
+    @process = Subprocess.popen([@path, @config])
+    sleep(0.25)
+  rescue => error
+    Logger.new(STDERR).error(error.message)
+    @process = nil
+  end
+
+  def stop
+    @process.terminate
+  rescue => error
+    Logger.new(STDERR).error(error.message)
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: redisearch-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Victor Ruiz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-01 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  A simple Ruby client library for RediSearc. RediSearch is a Full-Text search index over Redis,
+                          developed by RedisLabs. http://redisearch.io/
+email:
+- vruizext@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/redisearch-rb.iml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redisearch-rb.rb
+- lib/redisearch.rb
+- lib/redisearch/version.rb
+- redisearch-rb.gemspec
+- test/redisearch_test.rb
+- test/test_helper.rb
+homepage: https://github.com/vruizext/redisearch-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A simple Ruby client library for RediSearch
+test_files: []