redisearch-rb 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '01498d9fe5aeb06096b245b7045bc558d66edfb7'
-  data.tar.gz: 659c1c312134ec3acba593feaa8ab1597d21611f
+  metadata.gz: 1184cc3821b5bee90dcb18d41ad3b6ea9a93b750
+  data.tar.gz: 11ac50692f0cfc629e4283baa588e20cba18d854
 SHA512:
-  metadata.gz: a672c99130602f2461208d94f50e659d77f4e9b38b9b2149ed5e28665b1a5a3283fe6217a4322cdfba4af990849f09bd51fa2b9791f889bdea570458c3d86205
-  data.tar.gz: a283066a539ead576d84dd83265f911d090fbc86b340a1f9b26d033305c5943fece67a7fbd51374c59c2ae86984752341ae39a2d551dee7fbbb29d814ceb1baa
+  metadata.gz: c0e51193c7b3d7989f973472e5cdc4335f3ed428fa73c56ddbefa271023c053c85107639fc6f05bf0dee00820e4eb729cea3782ab7f0d62cb197d3587e7da624
+  data.tar.gz: ab05d37fe0469216d05dff6fa0223dd7530832b0a945226352a67a270a2e5239376111418793b7ccff8c2245b68916d46cc71fcba486c8a3f9b48c96d9b30904

data/.travis.yml

@@ -7,12 +7,14 @@ before_install:
 - gem install bundler -v 1.14.6
 - git clone --depth 10 https://github.com/antirez/redis.git
 - cd redis
-- git fetch origin 4.0.1
-- git checkout ae43e164d4b09d7753e27bb7cba6f7f4f85326b3
+- git fetch && git fetch --tags
+- git checkout 4.0.6
 - make
 - cd ..
 - git clone --depth 1 https://github.com/RedisLabsModules/RediSearch.git
-- cd RediSearch/src
+- cd RediSearch
+- git fetch && git fetch --tags
+- git checkout v1.0.4
 - make all
-- ls -la *.so
 - cd ..
+

data/Gemfile

@@ -2,10 +2,11 @@ source 'https://rubygems.org'
 
 ruby '2.4.1'
 
-gem 'redis', '~> 4.0.0.rc1'
+gem 'redis', '~> 4.0.1'
 
 group :development, :test do
   gem 'dotenv'
+  gem 'rake'
   gem 'subprocess'
   gem 'minitest', '~> 5.0'
 end

data/README.md

@@ -10,8 +10,8 @@ http://redisearch.io/
 
 First of all, you need to install RediSearch, if you haven't yet:
 
-1. Install Redis 4.0.1 https://github.com/antirez/redis/releases/tag/4.0.1
-2. Install RediSearch http://redisearch.io/Quick_Start/
+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/
 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:

data/lib/redisearch.rb

@@ -12,12 +12,13 @@ class RediSearch
   #
   # { verbatim: true, withscores: true, withsortkey: false }
 
-  CREATE_OPTIONS_FLAGS = [:nooffsets, :nofreqs, :noscoreidx, :nofields]
-  ADD_OPTIONS_FLAGS = [:nosave, :replace]
+  CREATE_OPTIONS_FLAGS = [:nooffsets, :nofreqs, :nohl, :nofields]
+  ADD_OPTIONS_FLAGS = [:nosave, :replace, :partial]
   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'] }
+  CREATE_OPTIONS_PARAMS = [:stopwords]
   ADD_OPTIONS_PARAMS = [:language]
   SEARCH_OPTIONS_PARAMS = [:filter, :return, :infields, :inkeys, :slop, :scorer, :sortby, :limit]
 
@@ -36,11 +37,11 @@ class RediSearch
 
   # Create new index with the given `schema`
   # @param [Array] schema
-  #
+  # @param [Hash] opts options
   # Example:
   #
   #   redisearch = RediSearch.new('my_idx')
-  #   redisearch.create_idx(['title', 'TEXT', 'WEIGHT', '2.0', 'director', 'TEXT', 'WEIGHT', '1.0'])
+  #   redisearch.create_idx(['title', 'TEXT', 'WEIGHT', '2.0', 'director', 'TEXT', 'WEIGHT', '1.0', 'year', 'NUMERIC', 'SORTABLE'])
   #
   # See http://redisearch.io/Commands/#ftcreate
   #
@@ -87,22 +88,25 @@ class RediSearch
   # See http://redisearch.io/Commands/#ftadd
   # @return [String] "OK" on success
   def add_docs(docs, opts = {})
-    multi { docs.each { |doc_id, fields| @redis.call(ft_add(doc_id, fields, opts)) } }
+    docs.each { |doc_id, fields| call(ft_add(doc_id, fields, opts))}
   end
 
   # Search the index with the given `query`
   # @param [String] query text query, see syntax here http://redisearch.io/Query_Syntax/
   # @param [Hash] opts options for the query
   #
-  #@return [Array] documents matching the query
+  # @return [Array] documents matching the query
   def search(query, opts = {})
-    results_to_hash(call(ft_search(query, opts)), opts)
+    build_docs(call(ft_search(query, opts)), opts)
   end
 
   # Fetch a document by id
-  def get_by_id(id)
-    Hash[with_reconnect { @redis.hgetall(id) } || []]
-      .tap { |doc| doc['id'] = id unless doc.empty? }
+  #
+  # @param [String] doc_id id assigned to the document
+  # @return [Hash] Hash containing document
+  def get_by_id(doc_id)
+    Hash[*call(ft_get(doc_id))]
+      .tap { |doc| doc['id'] = doc_id unless doc.empty? } || {}
   end
 
   # Return information and statistics on the index.
@@ -112,6 +116,36 @@ class RediSearch
     Hash[*call(ft_info)]
   end
 
+  # Deletes a document from the index
+  #
+  # See http://redisearch.io/Commands/#ftdel
+  #
+  # @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))
+  end
+
+  # Deletes all documents returned by 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))
+    end.sum
+  end
+
+  # Execute arbitrary command. 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)
+    @redis.with_reconnect { @redis.call(command.flatten) }
+  end
+
   private
 
   def with_reconnect
@@ -122,10 +156,6 @@ class RediSearch
     @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
@@ -146,10 +176,26 @@ class RediSearch
     ['FT.ADD', @idx_name , doc_id, weight || DEFAULT_WEIGHT, *add_options(opts), 'FIELDS', *fields]
   end
 
+  def ft_add_hash(doc_id, opts = {}, weight =  nil)
+    ['FT.ADDHASH', @idx_name , doc_id, weight || DEFAULT_WEIGHT, *add_options(opts)]
+  end
+
   def ft_search(query, opts)
     ['FT.SEARCH', @idx_name, *query, *search_options(opts)].flatten
   end
 
+  def ft_get(doc_id)
+    ['FT.GET', @idx_name , doc_id]
+  end
+
+  def ft_mget(doc_ids)
+    ['FT.MGET', @idx_name , *doc_ids]
+  end
+
+  def ft_del(doc_id)
+    ['FT.DEL', @idx_name , doc_id]
+  end
+
   def create_options(opts = {})
     build_options(opts, CREATE_OPTIONS_FLAGS, [])
   end
@@ -166,22 +212,27 @@ class RediSearch
     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
+      params_keys.map do |key|
+        [key.to_s.upcase, *opts[key]] unless opts[key].nil?
+      end.compact
   end
 
-  def results_to_hash(results, opts = {})
+  def build_docs(results, opts = {})
     return {} if results.nil? || results[0] == 0
     results.shift
-    offset = opts[:withscores] ? 1 : 0
-    rows_per_doc = 2 + offset
-    nr_of_docs = results.size / (2 + offset)
+    score_offset = opts[:withscores] ? 1 : 0
+    content_offset = score_offset + 1
+    rows_per_doc = 1 + content_offset
+    nr_of_docs = results.size / rows_per_doc
     (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 = opts[:nocontent] ? {} : Hash[*results[rows_per_doc * n + content_offset]]
+      doc['score'] = results[rows_per_doc * n + score_offset] if opts[:withscores]
       doc['id'] = results[rows_per_doc * n]
       doc
     end
   end
+
+  def valid_command?(command)
+    command[0] =~ /^ft\./i
+  end
 end

data/lib/redisearch/version.rb

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

data/redisearch-rb.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
                         RediSearch is a Redis powered search engine, developed by RedisLabs. http://redisearch.io/"
   spec.homepage      = "https://github.com/vruizext/redisearch-rb"
   spec.license       = "MIT"
-
+  spec.required_ruby_version = '> 2.4.0'
   spec.files         = `git ls-files`.split("\n")
   spec.test_files    = `git ls-files -- {test}/*`.split("\n")
 end

data/test/redisearch_test.rb

@@ -10,6 +10,7 @@ class RediSearchTest < Minitest::Test
     @redisearch_client = RediSearch.new('test_idx', @redis_client)
     @schema = ['title', 'TEXT', 'WEIGHT', '2.0',
                'director', 'TEXT', 'WEIGHT', '1.0',
+               'genre', 'TAG',
                'year', 'NUMERIC', 'SORTABLE']
 
   end
@@ -166,4 +167,18 @@ class RediSearchTest < Minitest::Test
     assert_equal 1, info['max_doc_id'].to_i
     assert_equal 5, info['num_terms'].to_i
   end
+
+  def test_delete_by_id
+    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))
+    assert_equal(1, @redisearch_client.delete_by_id('id_1'))
+    assert_empty(@redisearch_client.search('@title:lost'))
+    assert(@redisearch_client.get_by_id('id_1').any?)
+    assert(@redis_client.del('id_1'))
+    assert(@redisearch_client.get_by_id('id_1').empty?)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redisearch-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Victor Ruiz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-16 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies: []
 description: |-
   A simple Ruby client library for RediSearch.
@@ -43,9 +43,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="