redisearch-rb 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1184cc3821b5bee90dcb18d41ad3b6ea9a93b750
-  data.tar.gz: 11ac50692f0cfc629e4283baa588e20cba18d854
+  metadata.gz: ea52a309430c3f6fbed50c64e43e8a6158606584
+  data.tar.gz: 0bcfe47c805b649f14cefed4772526f7004f2173
 SHA512:
-  metadata.gz: c0e51193c7b3d7989f973472e5cdc4335f3ed428fa73c56ddbefa271023c053c85107639fc6f05bf0dee00820e4eb729cea3782ab7f0d62cb197d3587e7da624
-  data.tar.gz: ab05d37fe0469216d05dff6fa0223dd7530832b0a945226352a67a270a2e5239376111418793b7ccff8c2245b68916d46cc71fcba486c8a3f9b48c96d9b30904
+  metadata.gz: c3d38b1b71012fa9acd1bb7d14a7e71db16c7d840a3ec934f93f1167b5fb4e86440fc6be916ab17bfe77757b1f4617d2f25d92b490ef3eeed734177edf18605a
+  data.tar.gz: 2f80306e5c404618a47ed90aee72c42e77ee343559f2ce54539ef4f74e61d575f3a851761c22ef6520994bde9a04d9ff84269da2da0560efa4d98f0f23d26666

data/.travis.yml

@@ -14,7 +14,7 @@ before_install:
 - git clone --depth 1 https://github.com/RedisLabsModules/RediSearch.git
 - cd RediSearch
 - git fetch && git fetch --tags
-- git checkout v1.0.4
+- git checkout v1.2.0
 - make all
 - cd ..
 

data/lib/redisearch.rb

@@ -12,15 +12,24 @@ class RediSearch
   #
   # { verbatim: true, withscores: true, withsortkey: false }
 
-  CREATE_OPTIONS_FLAGS = [:nooffsets, :nofreqs, :nohl, :nofields]
-  ADD_OPTIONS_FLAGS = [:nosave, :replace, :partial]
-  SEARCH_OPTIONS_FLAGS = [:nocontent, :verbatim, :nostopwords,  :withscores, :withsortkeys]
+  OPTIONS_FLAGS = {
+    add: [:nosave, :replace, :partial],
+    create: [:nooffsets, :nofreqs, :nohl, :nofields],
+    del: [:dd],
+    drop: [:keepdocs],
+    search: [:nocontent, :verbatim, :nostopwords, :withscores, :withsortkeys],
+    sugadd: [:incr],
+    sugget: [:fuzzy, :withscores],
+  }
 
   # Params options need an array with the values for the option
   #  { limit: ['0', '50'], sortby: ['year', 'desc'], return: ['2', 'title', 'year'] }
-  CREATE_OPTIONS_PARAMS = [:stopwords]
-  ADD_OPTIONS_PARAMS = [:language]
-  SEARCH_OPTIONS_PARAMS = [:filter, :return, :infields, :inkeys, :slop, :scorer, :sortby, :limit]
+  OPTIONS_PARAMS = {
+    add: [:language, :payload],
+    create: [:stopwords],
+    search: [:filter, :return, :infields, :inkeys, :slop, :scorer, :sortby, :limit, :payload],
+    sugget: [:max],
+  }
 
   # Create RediSearch client instance
   #
@@ -54,8 +63,8 @@ class RediSearch
   #
   # See http://redisearch.io/Commands/#ftdrop
   # @return [String] "OK" on success
-  def drop_index
-    call(ft_drop)
+  def drop_index(opts = {})
+    call(ft_drop(opts))
   end
 
   # Add a single doc to the index, with the given `doc_id` and `fields`
@@ -122,27 +131,75 @@ class RediSearch
   #
   # @param [String] doc_id id assigned to the document
   # @return [int] 1 if the document was in the index, or 0 if not.
-  def delete_by_id(doc_id)
-    call(ft_del(doc_id))
+  def delete_by_id(doc_id, opts = {})
+    call(ft_del(doc_id, opts))
   end
 
-  # Deletes all documents returned by the query
+  # Deletes all documents matching the query
   #
   # @param [String] query in the same format as used in `search`
   # @param [Hash] opts options for the query, same  as in `search`
   # @return [int] count of documents deleted
   def delete_by_query(query, opts = {})
     call(ft_search(query, opts.merge(nocontent: true)))[1..-1].map do |doc_id|
-      call(ft_del(doc_id))
+      call(ft_del(doc_id, opts))
     end.sum
   end
 
-  # Execute arbitrary command. Only RediSearch commands are allowed
+  # Adds a string to an auto-complete suggestion dictionary.
+  #
+  # See https://oss.redislabs.com/redisearch/Commands/#ftsugadd
+  #
+  # @param [String] dict_name the key used to store the dictionary
+  # @param [String] content the string that is going to be indexed
+  # @param [Hash] opts optional parameters
+  # @return [int] current size of the dictionary
+  def autocomplete_add(dict_name, content, score = 1.0, opts = {})
+    call(ft_sugadd(dict_name, content, score, opts))
+  end
+
+  # Gets completion suggestions for a prefix.
+  #
+  # See https://oss.redislabs.com/redisearch/Commands/#ftsugadd
+  #
+  # @param [String] dict_name the key used to store the dictionary
+  # @param [String] prefix the prefix to search / complete
+  # @param [Hash] opts optional parameters
+  # @return [Array] a list of the top suggestions matching the prefix,
+  # optionally with score after each entry
+  def autocomplete_get(dict_name, prefix, opts = {})
+    call(ft_sugget(dict_name, prefix, opts))
+  end
+
+  # Deletes a string from an auto-complete suggestion dictionary.
+  #
+  # See https://oss.redislabs.com/redisearch/Commands/#ftsugdel
+  #
+  # @param [String] dict_name the key used to store the dictionary
+  # @param [String] content the string that is going to be deleted
+  # @param [Hash] opts optional parameters
+  # @return [int] 1 if the string was found and deleted, 0 otherwise
+  def autocomplete_del(dict_name, content)
+    call(ft_sugdel(dict_name, content))
+  end
+
+  # Gets the current size of an auto-complete suggestion dictionary.
+  #
+  # See https://oss.redislabs.com/redisearch/Commands/#ftsugdel
+  #
+  # @param [String] dict_name the key used to store the dictionary
+  # @return [int] current size of the dictionary
+  def autocomplete_len(dict_name)
+    call(ft_suglen(dict_name))
+  end
+
+  # Execute arbitrary command in redisearch index
+  # Only RediSearch commands are allowed
   #
   # @param [Array] command
   # @return [mixed] The output returned by redis
   def call(command)
-    raise ArgumentError.new("#{command&.first} is not a RediSearch command") unless valid_command?(command)
+    raise ArgumentError.new("unknown/unsupported command '#{command.first}'") unless valid_command?(command.first)
     @redis.with_reconnect { @redis.call(command.flatten) }
   end
 
@@ -161,11 +218,11 @@ class RediSearch
   end
 
   def ft_create(schema, opts)
-    ['FT.CREATE', @idx_name , *create_options(opts), 'SCHEMA', *schema]
+    ['FT.CREATE', @idx_name , *serialize_options(opts, :create), 'SCHEMA', *schema]
   end
 
-  def ft_drop
-    ['FT.DROP', @idx_name]
+  def ft_drop(opts)
+    ['FT.DROP', @idx_name, *serialize_options(opts, :drop)]
   end
 
   def ft_info
@@ -173,15 +230,15 @@ class RediSearch
   end
 
   def ft_add(doc_id, fields, opts = {}, weight =  nil)
-    ['FT.ADD', @idx_name , doc_id, weight || DEFAULT_WEIGHT, *add_options(opts), 'FIELDS', *fields]
+    ['FT.ADD', @idx_name , doc_id, weight || DEFAULT_WEIGHT, *serialize_options(opts, :add), 'FIELDS', *fields]
   end
 
   def ft_add_hash(doc_id, opts = {}, weight =  nil)
-    ['FT.ADDHASH', @idx_name , doc_id, weight || DEFAULT_WEIGHT, *add_options(opts)]
+    ['FT.ADDHASH', @idx_name , doc_id, weight || DEFAULT_WEIGHT, *serialize_options(opts, :add)]
   end
 
   def ft_search(query, opts)
-    ['FT.SEARCH', @idx_name, *query, *search_options(opts)].flatten
+    ['FT.SEARCH', @idx_name, *query, *serialize_options(opts, :search)].flatten
   end
 
   def ft_get(doc_id)
@@ -192,40 +249,59 @@ class RediSearch
     ['FT.MGET', @idx_name , *doc_ids]
   end
 
-  def ft_del(doc_id)
-    ['FT.DEL', @idx_name , doc_id]
+  def ft_del(doc_id, opts)
+    ['FT.DEL', @idx_name , doc_id, *serialize_options(opts, :del)]
+  end
+
+  def ft_tagvals(field_name)
+    ['FT.TAGVALS', @idx_name , field_name]
+  end
+
+  def ft_explain(query, opts)
+    ['FT.EXPLAIN', @idx_name, *query, *serialize_options(opts, :search)].flatten
+  end
+
+  def ft_sugadd(dict_name, content, score, opts)
+    ['FT.SUGADD', dict_name , content, score, *serialize_options(opts, :sugadd)]
   end
 
-  def create_options(opts = {})
-    build_options(opts, CREATE_OPTIONS_FLAGS, [])
+  def ft_sugdel(dict_name, content)
+    ['FT.SUGDEL', dict_name , content]
   end
 
-  def add_options(opts = {})
-    build_options(opts, ADD_OPTIONS_FLAGS, ADD_OPTIONS_PARAMS)
+  def ft_suglen(dict_name)
+    ['FT.SUGLEN', dict_name]
   end
 
-  def search_options(opts = {})
-    build_options(opts, SEARCH_OPTIONS_FLAGS, SEARCH_OPTIONS_PARAMS)
+  def ft_sugget(dict_name, prefix,opts)
+    ['FT.SUGGET', dict_name , prefix, *serialize_options(opts, :sugget)]
   end
 
-  def build_options(opts, flags_keys, params_keys)
-    flags_keys.map do |key|
+  def serialize_options(opts, method)
+     [flags_for_method(opts, method), params_for_method(opts, method)].flatten.compact
+  end
+
+  def flags_for_method(opts, method)
+    OPTIONS_FLAGS[method].to_a.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.compact
+  end
+
+  def params_for_method(opts, method)
+    OPTIONS_PARAMS[method].to_a.map do |key|
+      [key.to_s.upcase, *opts[key]] unless opts[key].nil?
+    end.compact
   end
 
   def build_docs(results, opts = {})
     return {} if results.nil? || results[0] == 0
     results.shift
     score_offset = opts[:withscores] ? 1 : 0
-    content_offset = score_offset + 1
-    rows_per_doc = 1 + content_offset
+    content_offset = opts[:nocontent] ? 0 : 1
+    rows_per_doc = 1 + content_offset + score_offset
     nr_of_docs = results.size / rows_per_doc
     (0..nr_of_docs-1).map do |n|
-      doc = opts[:nocontent] ? {} : Hash[*results[rows_per_doc * n + content_offset]]
+      doc = opts[:nocontent] ? {} : Hash[*results[rows_per_doc * n + content_offset + score_offset]]
       doc['score'] = results[rows_per_doc * n + score_offset] if opts[:withscores]
       doc['id'] = results[rows_per_doc * n]
       doc
@@ -233,6 +309,8 @@ class RediSearch
   end
 
   def valid_command?(command)
-    command[0] =~ /^ft\./i
+    %w(FT.CREATE FT.ADD FT.ADDHASH FT.SEARCH FT.DEL FT.DROP FT.GET FT.MGET
+       FT.SUGADD FT.SUGGET FT.SUGDEL FT.SUGLEN FT.SYNADD FT.SYNUPDATE FT.SYNDUMP
+       FT.INFO FT.AGGREGATE FT.EXPLAIN FT.TAGVALS).include?(command)
   end
 end

data/lib/redisearch/version.rb

@@ -1,3 +1,3 @@
 class RediSearch
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/test/redisearch_test.rb

@@ -37,8 +37,19 @@ class RediSearchTest < Minitest::Test
 
   def test_drop_idx
     assert(@redisearch_client.create_index(@schema))
-    assert(@redisearch_client.drop_index)
+    doc = ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']
+    @redisearch_client.add_doc('id_1', doc)
+    @redisearch_client.drop_index
     assert_raises(Redis::CommandError) { @redisearch_client.info }
+    assert(@redis_client.hgetall('id_1').empty?)
+  end
+
+  def test_drop_idx_keep_documents
+    @redisearch_client.create_index(@schema)
+    doc = ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']
+    @redisearch_client.add_doc('id_1', doc)
+    @redisearch_client.drop_index({ keepdocs: true })
+    assert(@redis_client.hgetall('id_1').any?)
   end
 
   def test_add_doc
@@ -175,10 +186,28 @@ class RediSearchTest < Minitest::Test
             ['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))
-    assert_equal(1, @redisearch_client.delete_by_id('id_1'))
+    assert_equal(1, @redisearch_client.delete_by_id('id_1', { dd: false }))
+    assert_equal(1, @redisearch_client.delete_by_id('id_2', { dd: true }))
     assert_empty(@redisearch_client.search('@title:lost'))
     assert(@redisearch_client.get_by_id('id_1').any?)
+    assert(@redisearch_client.get_by_id('id_2').empty?)
     assert(@redis_client.del('id_1'))
     assert(@redisearch_client.get_by_id('id_1').empty?)
   end
+
+  def test_auto_complete_suggestions
+    dict_name = 'test_suggestions'
+    @redisearch_client.autocomplete_add(dict_name, 'foobar', 2.0)
+    @redisearch_client.autocomplete_add(dict_name, 'foowoz', 1.0)
+    @redisearch_client.autocomplete_add(dict_name, 'foomeh', 0.85)
+    @redisearch_client.autocomplete_add(dict_name, 'woowoz', 1.0)
+    assert_equal(4, @redisearch_client.autocomplete_len(dict_name))
+    results = @redisearch_client.autocomplete_get(dict_name, 'foo')
+    assert_equal(3, results.count)
+    assert_equal('foobar', results.first)
+    assert_equal(4, @redisearch_client.autocomplete_get(dict_name, 'foo', { fuzzy: true }).count)
+    assert @redisearch_client.autocomplete_del(dict_name, 'foobar').to_i > 0
+    refute @redisearch_client.autocomplete_del(dict_name, 'foozzz').to_i > 0
+    assert_equal('foowoz', @redisearch_client.autocomplete_get(dict_name, 'foo').first)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redisearch-rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Victor Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-15 00:00:00.000000000 Z
+date: 2018-11-27 00:00:00.000000000 Z
 dependencies: []
 description: |-
   A simple Ruby client library for RediSearch.