redisearch-rb 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 223cca42fa38796e6abd0b5780b589dc2d0536bb
-  data.tar.gz: ee5aa7e8e327dd933cf8079d02fdbca425abb3aa
+  metadata.gz: 38fdd275f958d4e5df2905efaca54d8d50d98c5b
+  data.tar.gz: f96e95211a060b7ba444be7d6edc8d264fd77f03
 SHA512:
-  metadata.gz: 003b2d21b74b25530e9126028e416b003b690a05d29c7e9cee79abb46e5874ca1c9bbb2f4ae532f766897834f993729f3530785220ca66c1426385c8145b3619
-  data.tar.gz: 5a9856724a08319139ad6ad9af814f77eca878a247db345248b59ec051afe2016810f5c58f8bce718ce6db62b666493f130eaca390dcbee22730f4c596bb849e
+  metadata.gz: a1e81b076d263436bbbf1586df2ad7397be0804bce9c0885f79e54d0cc5b43db735cf6e880656aff995d0bef0ae09df1d8cf8b28cd72c34014cc323dc9ccb76c
+  data.tar.gz: 5cc4a44605e1e420319d5daa68482e4c684321bdbcb2bb2af1401509b964b952781c4c2cd46fe285e9ccfebce7c2fba73b150aa7510823716e3d95d3b3b80de4

data/.gitignore

@@ -11,3 +11,4 @@
 .idea/
 *.gem
 *.rdb
+*.so

data/.travis.yml

@@ -1,14 +1,18 @@
-sudo: false
+sudo: required
+dist: trusty
 language: ruby
 rvm:
-  - 2.4.0
+  - 2.4.1
 before_install:
 - gem install bundler -v 1.14.6
-- git clone --depth 1 https://github.com/antirez/redis.git
+- git clone --depth 10 https://github.com/antirez/redis.git
 - cd redis
+- git fetch origin 4.0.1
+- git checkout ae43e164d4b09d7753e27bb7cba6f7f4f85326b3
 - make
 - cd ..
 - git clone --depth 1 https://github.com/RedisLabsModules/RediSearch.git
 - cd RediSearch/src
 - make all
+- ls -la *.so
 - cd ..

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-ruby '2.4.0'
+ruby '2.4.1'
 
 gem 'redis', '~> 4.0.0.rc1'
 

data/TODO.md

@@ -0,0 +1,16 @@
+## TODO
+
+- [ x ] Add options hash in `FT.CREATE` (`[NOOFFSETS] [NOFIELDS] [NOSCOREIDX]`) / Allow _raw_ options block
+
+- [ x ] Add options hash in `FT.ADD` (`[NOSAVE] [REPLACE] [LANGUAGE {language}] [PAYLOAD {payload}]`) / Allow _raw_ options block
+
+- [ x ] Add more options to options hash in `FT.SEARCH` / Allow _raw_ options block
+
+- [ ] Add function `FT.DEL`
+
+- [ ] Add function `FT.OPTIMIZE`
+
+- [ ] Add autocomplete functions: `FT.SUGGADD`, `FT.SUGGET`, `FT.SUGGDEL`, `FT.SUGGLEN`
+
+- [ ] Add function `FT.EXPLAIN`
+

data/lib/redisearch.rb

@@ -5,6 +5,22 @@ require 'redis'
 # http://redisearch.io/
 #
 class RediSearch
+  DEFAULT_WEIGHT = '1.0'
+
+  # Supported options
+  # Flags options can be only true or false,
+  #
+  # { verbatim: true, withscores: true, withsortkey: false }
+
+  CREATE_OPTIONS_FLAGS = [:nooffsets, :nofreqs, :noscoreidx, :nofields]
+  ADD_OPTIONS_FLAGS = [:nosave, :replace]
+  SEARCH_OPTIONS_FLAGS = [:nocontent, :verbatim, :nostopwords,  :withscores, :withsortkeys]
+
+  # Params options need an array with the values for the option
+  #  { limit: ['0', '50'], sortby: ['year', 'desc'], return: ['2', 'title', 'year'] }
+  ADD_OPTIONS_PARAMS = [:language]
+  SEARCH_OPTIONS_PARAMS = [:filter, :return, :infields, :inkeys, :slop, :scorer, :sortby, :limit]
+
   # Create RediSearch client instance
   #
   # @param [String] idx_name name of the index
@@ -29,8 +45,8 @@ class RediSearch
   # See http://redisearch.io/Commands/#ftcreate
   #
   # @return [String] "OK" on success
-  def create_index(schema)
-    call(ft_create(schema))
+  def create_index(schema, opts = {})
+    call(ft_create(schema, opts))
   end
 
   # Drop all the keys in the current index
@@ -45,7 +61,7 @@ class RediSearch
   #
   # @param [String] doc_id id assigned to the document
   # @param [Array] fields name-value pairs to be indexed
-  #
+  # @param [Hash] opts optional parameters
   # Example:
   #
   #   redisearch = RediSearch.new('my_idx')
@@ -53,8 +69,8 @@ class RediSearch
   #
   # See http://redisearch.io/Commands/#ftadd
   # @return [String] "OK" on success
-  def add_doc(doc_id, fields)
-    call(ft_add(doc_id, fields))
+  def add_doc(doc_id, fields, opts = {})
+    call(ft_add(doc_id, fields, opts))
   end
 
   # Add a set of docs to the index. Uses redis `multi` to make a single bulk insert.
@@ -70,8 +86,8 @@ class RediSearch
   #
   # 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)) } }
+  def add_docs(docs, opts = {})
+    multi { docs.each { |doc_id, fields| @redis.call(ft_add(doc_id, fields, opts)) } }
   end
 
   # Search the index with the given `query`
@@ -80,7 +96,7 @@ class RediSearch
   #
   #@return [Array] documents matching the query
   def search(query, opts = {})
-    results_to_hash(call(ft_search(query, opts)))
+    results_to_hash(call(ft_search(query, opts)), opts)
   end
 
   # Return information and statistics on the index.
@@ -104,8 +120,8 @@ class RediSearch
     @redis.call(ft_add(doc_id, fields))
   end
 
-  def ft_create(schema)
-    ['FT.CREATE', @idx_name , 'SCHEMA', *schema]
+  def ft_create(schema, opts)
+    ['FT.CREATE', @idx_name , *create_options(opts), 'SCHEMA', *schema]
   end
 
   def ft_drop
@@ -116,28 +132,39 @@ class RediSearch
     ['FT.INFO', @idx_name]
   end
 
-  def ft_add(doc_id, fields)
-    ['FT.ADD', @idx_name , doc_id, '1.0', 'REPLACE', 'FIELDS', *fields]
+  def ft_add(doc_id, fields, opts = {}, weight =  nil)
+    ['FT.ADD', @idx_name , doc_id, weight || DEFAULT_WEIGHT, *add_options(opts), '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], 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.flatten
+    ['FT.SEARCH', @idx_name, *query, *search_options(opts)].flatten
+  end
+
+  def create_options(opts = {})
+    build_options(opts, CREATE_OPTIONS_FLAGS, [])
+  end
+
+  def add_options(opts = {})
+    build_options(opts, ADD_OPTIONS_FLAGS, ADD_OPTIONS_PARAMS)
+  end
+
+  def search_options(opts = {})
+    build_options(opts, SEARCH_OPTIONS_FLAGS, SEARCH_OPTIONS_PARAMS)
+  end
+
+  def build_options(opts, flags_keys, params_keys)
+    flags_keys.map do |key|
+      key.to_s.upcase if opts[key]
+    end.compact +
+    params_keys.map do |key|
+      [key.to_s.upcase, *opts[key]] unless opts[key].nil?
+    end.compact
   end
 
-  def results_to_hash(results)
+  def results_to_hash(results, opts = {})
     return {} if results.nil? || results[0] == 0
     results.shift
-    offset = results.size % 3 == 0 ? 1 : 0
+    offset = opts[:withscores] ? 1 : 0
     rows_per_doc = 2 + offset
     nr_of_docs = results.size / (2 + offset)
     (0..nr_of_docs-1).map do |n|

data/lib/redisearch/version.rb

@@ -1,3 +1,3 @@
 class RediSearch
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/redisearch-rb.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.description   = "A simple Ruby client library for RediSearch.
+                        RediSearch is a Redis powered search engine, developed by RedisLabs. http://redisearch.io/"
   spec.homepage      = "https://github.com/vruizext/redisearch-rb"
   spec.license       = "MIT"
 

data/test/redisearch_test.rb

@@ -2,15 +2,15 @@ require 'test_helper'
 
 class RediSearchTest < Minitest::Test
   def setup
-    @redis_server = RedisTestServer.new
+    @redis_server = RedisTestServer.new(6388)
     fail('error starting redis-server') unless @redis_server.start
     sleep(0.25)
-    @redis_client = Redis.new(url: ENV['REDIS_URL'])
+    @redis_client = Redis.new(url: @redis_server.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']
+               'year', 'NUMERIC', 'SORTABLE']
 
   end
 
@@ -47,6 +47,21 @@ class RediSearchTest < Minitest::Test
     assert_includes(@redis_client.call(['FT.SEARCH', 'test_idx', 'lost']).to_s, 'Lost in translation')
   end
 
+  def test_add_doc_replace
+    assert(@redisearch_client.create_index(@schema))
+    doc = ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']
+    assert(@redisearch_client.add_doc('id_1', doc))
+
+    doc = ['title', 'Lost in translation', 'director', 'SC', 'year', '2005']
+    assert_raises(Redis::CommandError) { @redisearch_client.add_doc('id_1', doc) }
+    assert(@redisearch_client.add_doc('id_1', doc, { replace: true }))
+
+    result = @redis_client.call(['FT.SEARCH', 'test_idx', 'SC'])
+    assert result.any?
+    assert result.to_s.include?('2005')
+    assert result.to_s.include?('id_1')
+  end
+
   def test_add_docs
     assert(@redisearch_client.create_index(@schema))
     docs = [['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']],
@@ -80,6 +95,57 @@ class RediSearchTest < Minitest::Test
     assert_equal 1, @redisearch_client.search('@year:[2004 2005]').count
   end
 
+  def test_search_inkeys
+    @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|garland)', { infields: ['1', 'title'] })
+    assert_equal 1, matches.count
+    matches = @redisearch_client.search('(lost|garland)', { infields: ['2', 'director', 'title'] })
+    assert_equal 2, matches.count
+  end
+
+  def test_search_return_keys
+    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', { return: ['2', 'title', 'year'] })
+    assert_equal 1, matches.count
+    assert_nil matches[0]['director']
+    assert_equal 'Lost in translation', matches[0]['title']
+    assert_equal '2004', matches[0]['year']
+  end
+
+  def test_search_sort_by
+    @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('@year:[2000 2017]', { sortby: ['year', 'asc'] })
+    assert_equal 2, matches.count
+    assert_equal 'id_1', matches[0]['id']
+    matches = @redisearch_client.search('@year:[2000 2017]', { sortby: ['year', 'desc'] })
+    assert_equal 'id_2', matches[0]['id']
+  end
+
+  def test_search_limit
+    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']],
+            ['id_3', ['title', 'Terminator', 'director', 'James Cameron', 'year', '1984']],
+            ['id_4', ['title', 'Blade Runner', 'director', 'Ridley Scott', 'year', '1982']]]
+    assert(@redisearch_client.add_docs(docs))
+    matches = @redisearch_client.search('@year:[1980 2017]', { limit: ['0', '3'], sortby: ['year', 'asc'] })
+    assert_equal 3, matches.count
+    assert_equal 'id_4', matches[0]['id']
+    assert_equal 'id_3', matches[1]['id']
+    assert_equal 'id_1', matches[2]['id']
+    matches = @redisearch_client.search('@year:[1980 2017]', { limit: ['3', '3'], sortby: ['year', 'asc'] })
+    assert_equal 1, matches.count
+    assert_equal 'id_2', matches[0]['id']
+  end
+
   def test_index_info
     assert(@redisearch_client.create_index(@schema))
     doc = ['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']]

data/test/test_helper.rb

@@ -10,17 +10,19 @@ require './lib/redisearch-rb'
 Dotenv.load('./.env')
 
 class RedisTestServer
-  DEFAULT_REDIS_PATH = ''#'redis-server'
+  DEFAULT_REDIS_PATH = 'redis-server'
 
-  attr_reader :process
+  attr_reader :process, :url
 
-  def initialize
+  def initialize(default_port = nil)
     @command = [ENV['REDIS_SERVER_PATH'] || DEFAULT_REDIS_PATH]
+    @port = ENV['REDIS_PORT'] || default_port
   end
 
   def start
     build_args
     @process = Subprocess.popen(@command)
+    @url = "redis://127.0.0.1:#{@port}"
   rescue => error
     Logger.new(STDERR).error(error.message)
     @process = nil
@@ -36,7 +38,7 @@ class RedisTestServer
 
   def build_args
     if ENV['REDIS_CONF_PATH'].to_s.empty?
-      @command << "--port #{ENV['REDIS_PORT']}" unless ENV['REDIS_PORT'].to_s.empty?
+      @command << "--port #{@port}" unless @port.to_s.empty?
       @command << "--loadmodule #{ENV['REDIS_MODULE_PATH']}" unless ENV['REDIS_MODULE_PATH'].to_s.empty?
     else
       @command << ENV['REDIS_CONF_PATH']

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: redisearch-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Victor Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2017-08-08 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/
+  A simple Ruby client library for RediSearch.
+                          RediSearch is a Redis powered search engine, developed by RedisLabs. http://redisearch.io/
 email:
 - vruizext@gmail.com
 executables: []
@@ -26,6 +26,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - lib/redisearch-rb.rb
 - lib/redisearch.rb
 - lib/redisearch/version.rb