redisearch-rb 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea52a309430c3f6fbed50c64e43e8a6158606584
-  data.tar.gz: 0bcfe47c805b649f14cefed4772526f7004f2173
+  metadata.gz: 9df8fe8e4d7c7a3624eee798a3a495296e244a1c
+  data.tar.gz: 704632f558f90028067c76ca1ee994ea6d08d70e
 SHA512:
-  metadata.gz: c3d38b1b71012fa9acd1bb7d14a7e71db16c7d840a3ec934f93f1167b5fb4e86440fc6be916ab17bfe77757b1f4617d2f25d92b490ef3eeed734177edf18605a
-  data.tar.gz: 2f80306e5c404618a47ed90aee72c42e77ee343559f2ce54539ef4f74e61d575f3a851761c22ef6520994bde9a04d9ff84269da2da0560efa4d98f0f23d26666
+  metadata.gz: a9cb8486726435e3832f6b598e9cd8a3addde0623c5371db1d5bca9641d67d0189d2ca4c180aaf3ff53c2c63450930b00536b520668fcbb31e2ab7e7994f6275
+  data.tar.gz: 6a4d206b73dd350c6a240b805cbf82dcde7ca536492815b2ff6719a5b617ee73ed191e625bdadbfa68ac1cc3cd09e617c47a9a7c2889db3bc77c2c3fac074d34

data/README.md

@@ -11,7 +11,7 @@ http://redisearch.io/
 First of all, you need to install RediSearch, if you haven't yet:
 
 1. Install Redis 4.0.1 or highger https://github.com/antirez/redis/releases/tag/4.0.1
-2. Install RediSearch 1.0.4 or higher http://redisearch.io/Quick_Start/
+2. Install RediSearch 1.2.0 or higher http://redisearch.io/Quick_Start/
 3. Edit your `redis.conf` file and add a `loadmodule` directive to load the RediSearch module built in the step 2.
 
 To install this gem, add this line to your application's Gemfile:
@@ -43,7 +43,7 @@ In order to run the tests, it's necessary to set some env variables (see .env.ex
 ```ruby
 require 'redisearch-rb'
 
-redis = Redis.new(REDIS_URL)
+redis = Redis.new(url: REDIS_URL)
 redisearch_client = RediSearch.new('test_idx', redis)
 
 schema = ['title', 'TEXT', 'WEIGHT', '2.0',

data/lib/redisearch.rb

@@ -14,6 +14,7 @@ class RediSearch
 
   OPTIONS_FLAGS = {
     add: [:nosave, :replace, :partial],
+    addhash: [:replace],
     create: [:nooffsets, :nofreqs, :nohl, :nofields],
     del: [:dd],
     drop: [:keepdocs],
@@ -26,6 +27,7 @@ class RediSearch
   #  { limit: ['0', '50'], sortby: ['year', 'desc'], return: ['2', 'title', 'year'] }
   OPTIONS_PARAMS = {
     add: [:language, :payload],
+    addhash: [:language],
     create: [:stopwords],
     search: [:filter, :return, :infields, :inkeys, :slop, :scorer, :sortby, :limit, :payload],
     sugget: [:max],
@@ -71,6 +73,7 @@ class RediSearch
   #
   # @param [String] doc_id id assigned to the document
   # @param [Array] fields name-value pairs to be indexed
+  # @param [Float] weight asigned by the user to the document
   # @param [Hash] opts optional parameters
   # Example:
   #
@@ -79,8 +82,8 @@ class RediSearch
   #
   # See http://redisearch.io/Commands/#ftadd
   # @return [String] "OK" on success
-  def add_doc(doc_id, fields, opts = {})
-    call(ft_add(doc_id, fields, opts))
+  def add_doc(doc_id, fields, opts = {}, weight = nil)
+    call(ft_add(doc_id, fields, opts, weight))
   end
 
   # Add a set of docs to the index. Uses redis `multi` to make a single bulk insert.
@@ -90,14 +93,30 @@ class RediSearch
   # Example:
   #
   #   redisearch = RediSearch.new('my_idx')
-  #   docs = [['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola'],
-  #           ['id_2', ['title', 'Ex Machina', 'director', 'Alex Garland']]
+  #   docs = [['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola'], 0.75],
+  #           ['id_2', ['title', 'Ex Machina', 'director', 'Alex Garland'], 0.95]
   #   redisearch.add_docs(docs)
   #
   # See http://redisearch.io/Commands/#ftadd
   # @return [String] "OK" on success
   def add_docs(docs, opts = {})
-    docs.each { |doc_id, fields| call(ft_add(doc_id, fields, opts))}
+    docs.map { |doc_id, fields, weight| call(ft_add(doc_id, fields, opts, weight))}
+  end
+
+  # Adds a document to the index from an existing HASH key `doc_id` in Redis.
+  #
+  # @param [String] doc_id HASH key holding the fields that need to be indexed
+  # @param [Hash] opts optional parameters
+  # @param [Float]weight asigned by the user to the document
+  # Example:
+  #
+  #   redisearch = RediSearch.new('my_idx')
+  #   redisearch.add_hash('id_1', { weight: true })
+  #
+  # See http://redisearch.io/Commands/#ftadd
+  # @return [String] "OK" on success
+  def add_hash(doc_id, opts = {}, weight = nil)
+    call(ft_addhash(doc_id, opts, weight))
   end
 
   # Search the index with the given `query`
@@ -109,6 +128,16 @@ class RediSearch
     build_docs(call(ft_search(query, opts)), opts)
   end
 
+  # Fetch the contents of multiple documents
+  #
+  # @param [Array] doc_ids ids assigned to the document
+  # @return [Array] documents found for the ids given
+  def get_by_ids(doc_ids)
+    call(ft_mget(doc_ids)).map.with_index do |doc, i|
+      { 'id' => doc_ids[i] }.merge(Hash[*doc]) unless doc.empty?
+    end.compact
+  end
+
   # Fetch a document by id
   #
   # @param [String] doc_id id assigned to the document
@@ -233,7 +262,7 @@ class RediSearch
     ['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)
+  def ft_addhash(doc_id, opts = {}, weight =  nil)
     ['FT.ADDHASH', @idx_name , doc_id, weight || DEFAULT_WEIGHT, *serialize_options(opts, :add)]
   end
 
@@ -294,7 +323,7 @@ class RediSearch
   end
 
   def build_docs(results, opts = {})
-    return {} if results.nil? || results[0] == 0
+    return [] if results.nil? || results[0] == 0
     results.shift
     score_offset = opts[:withscores] ? 1 : 0
     content_offset = opts[:nocontent] ? 0 : 1

data/lib/redisearch/version.rb

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

data/test/redisearch_test.rb

@@ -84,6 +84,14 @@ class RediSearchTest < Minitest::Test
     assert_includes(search_result.to_s, 'Ex Machina')
   end
 
+  def test_add_hash
+    assert(@redisearch_client.create_index(@schema))
+    doc = ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']
+    @redis_client.hmset('id_1', *doc)
+    assert(@redisearch_client.add_hash('id_1'))
+    assert_includes(@redis_client.call(['FT.SEARCH', 'test_idx', '@title:lost']).to_s, 'Lost in translation')
+  end
+
   def test_get_by_id
     assert(@redisearch_client.create_index(@schema))
     docs = [['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']],
@@ -94,6 +102,18 @@ class RediSearchTest < Minitest::Test
     assert_equal('Lost in translation', doc['title'])
   end
 
+  def test_get_by_ids
+    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))
+    docs = @redisearch_client.get_by_ids(['id_1', 'id_2'])
+    assert_equal('id_1', docs[0]['id'])
+    assert_equal('Lost in translation', docs[0]['title'])
+    assert_equal('id_2', docs[1]['id'])
+    assert_equal('Ex Machina', docs[1]['title'])
+  end
+
   def test_search_simple_query
     assert(@redisearch_client.create_index(@schema))
     docs = [['id_1', ['title', 'Lost in translation', 'director', 'Sofia Coppola', 'year', '2004']],
@@ -104,6 +124,7 @@ class RediSearchTest < Minitest::Test
     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 }
+    assert_equal([], @redisearch_client.search('foobarwozzz'))
   end
 
   def test_search_field_selector

metadata

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