redi_searcher 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3970933331248a4f4eaf439a12dc2f035dad533bcc62ee0d0b758162a969f649
+  data.tar.gz: 152d010d2d7296910b4a579035c8c9d2ee1784e561a229d392a8d4e0fbe84f62
+SHA512:
+  metadata.gz: 7163297b6dcc1e15e48ca2648d436262768d7807aade7161a588ac6e4939dd3474886e77d498f6474bc9e8caa0ade0d0a0822304a4bcd0693170c8dc5b64a510
+  data.tar.gz: fab6459bba1d28528727c6ec6794fe53065dd0b778f5f9cc8ea1e776fcdc89a2693dc0e0a0e6f0e4f6bc5334c9a07eea266e377220886bb99cd9329d54b86bd2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Ignore all files with the .gem extension
+*.gem

data/lib/redi_searcher.rb

@@ -0,0 +1,20 @@
+require 'redi_searcher/client'
+require 'redi_searcher/client/command_base'
+
+require 'redi_searcher/schema'
+require 'redi_searcher/schema/field'
+
+require 'redi_searcher/index'
+require 'redi_searcher/document'
+
+
+
+module RediSearcher
+  DEFAULT_WEIGHT = '1.0'
+
+  class << self
+    def client
+      @client ||= Client.new
+    end
+  end
+end

data/lib/redi_searcher/client.rb

@@ -0,0 +1,37 @@
+module RediSearcher
+  class Client
+
+    def initialize(redis = {}, *args)
+      @redis = Redis.new(redis)
+    end
+
+    def generate_index(name, schema)
+      RediSearcher::Index.new(self, name, schema)
+    end
+
+    def call(command)
+      raise ArgumentError.new("unknown/unsupported command '#{command.first}'") unless valid_command?(command.first)
+      with_reconnect { @redis.call(command.flatten) }
+    end
+
+    # return true or false
+    def multi
+      with_reconnect { @redis.multi { yield } }
+    end
+
+    private
+
+    attr_accessor :redis
+
+    def with_reconnect
+      @redis.with_reconnect { yield }
+    end
+
+    def valid_command?(command)
+      %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 FT.CONFIG).include?(command)
+    end
+
+  end
+end

data/lib/redi_searcher/client/command_base.rb

@@ -0,0 +1,27 @@
+module RediSearcher
+  class Client
+    class CommandBase
+      OPTIONS_FLAGS = {}
+      OPTIONS_PARAMS = {}
+
+      private
+
+      def serialize_options(method, **options)
+        [flags_for_method(method, options), params_for_method(method, options)].flatten.compact
+      end
+
+      def flags_for_method(method, **options)
+        self.class::OPTIONS_FLAGS[method].to_a.map do |key|
+          key.to_s.upcase if options[key]
+        end.compact
+      end
+
+      def params_for_method(method, **options)
+        self.class::OPTIONS_PARAMS[method].to_a.map do |key|
+          [key.to_s.upcase, *options[key]] unless options[key].nil?
+        end.compact
+      end
+
+    end
+  end
+end

data/lib/redi_searcher/document.rb

@@ -0,0 +1,46 @@
+module RediSearcher
+  class Document < Client::CommandBase
+    OPTIONS_FLAGS = {
+      add: [:nosave, :replace, :partial],
+      del: [:dd]
+    }
+
+    OPTIONS_PARAMS = {
+      add: [:language, :payload],
+    }
+
+    attr_reader :index, :doc_id, :fields, :weight
+
+    def initialize(index, doc_id, weight = nil, **fields)
+      @index = index
+      @doc_id = doc_id
+      @fields = fields
+      @weight = weight || RediSearcher::DEFAULT_WEIGHT
+    end
+
+    def add(**options)
+      index.client.call(ft_add(options))
+    end
+
+    def del(**options)
+      index.client.call(ft_del(options))
+    end
+
+    private
+
+    def ft_add(**options)
+      ['FT.ADD', index.name , doc_id, weight, *serialize_options(:add, options), 'FIELDS', *serialize_fields]
+    end
+
+    def ft_del(**options)
+      ['FT.DEL', index.name , doc_id, *serialize_options(:del, options)]
+    end
+
+    def serialize_fields
+      fields.map do |key, value|
+        [(key.to_s rescue key) || key, value]
+      end.compact
+    end
+
+  end
+end

data/lib/redi_searcher/index.rb

@@ -0,0 +1,69 @@
+module RediSearcher
+  class Index < Client::CommandBase
+    OPTIONS_FLAGS = {
+      create: [:nooffsets, :nofreqs, :nohl, :nofields],
+      drop: [:keepdocs],
+      search: [:nocontent, :verbatim, :nostopwords, :withscores, :withsortkeys],
+    }
+
+    OPTIONS_PARAMS = {
+      create: [:stopwords],
+      search: [:filter, :return, :infields, :inkeys, :slop, :scorer, :sortby, :limit, :payload],
+    }
+
+    attr_reader :client, :name, :schema
+
+    def initialize(client, name, schema)
+      @client = client
+      @name = name
+      @schema = RediSearcher::Schema.new(schema)
+    end
+
+    def generate_document(id, fields)
+      RediSearcher::Document.new(self, id, fields)
+    end
+
+    def create(**options)
+      client.call(ft_create(schema, options))
+    end
+
+    def info
+      Hash[*client.call(ft_info)]
+    rescue Redis::CommandError
+      nil
+    end
+
+    def search(query, **options)
+      client.call(ft_search(query, options))
+    end
+
+    def exists?
+      !info.nil?
+    end
+
+    def drop
+      !client.call(ft_drop()).nil?
+    rescue Redis::CommandError
+      nil
+    end
+
+    private
+
+    def ft_create(schema, **options)
+      ['FT.CREATE', name , *serialize_options(:create, options), 'SCHEMA', *schema.serialize]
+    end
+
+    def ft_drop(**options)
+      ['FT.DROP', name, *serialize_options(:drop, options)]
+    end
+
+    def ft_search(query, **options)
+      ['FT.SEARCH', name, query, *serialize_options(:search, options)]
+    end
+
+    def ft_info
+      ['FT.INFO', name]
+    end
+
+  end
+end

data/lib/redi_searcher/schema.rb

@@ -0,0 +1,22 @@
+module RediSearcher
+  class Schema
+    attr_reader :fields
+
+    def initialize(**fields)
+      @fields = []
+      build_fields_params(fields).each do |value|
+        @fields << Field.new(*value)
+      end
+    end
+
+    def serialize
+      @fields.map(&:serialize)
+    end
+
+    private
+
+    def build_fields_params(**fields)
+      fields.map{ |key, value| [key, value.is_a?(Hash) ? value.to_a : value].flatten}
+    end
+  end
+end

data/lib/redi_searcher/schema/field.rb

@@ -0,0 +1,40 @@
+module RediSearcher
+  class Schema
+    class Field
+      OPTIONS_FLAGS = {
+        text: [:no_stem],
+        all: [:sortable, :no_index]
+      }
+
+      OPTIONS_PARAMS = {
+        text: [:phonetic, :weight],
+        tag: [:separator]
+      }
+
+      attr_reader :name, :type, :options
+
+      def initialize(name, type, **options)
+        @name = name
+        @type = type
+        @options = options
+      end
+
+      def serialize
+        [name.to_s, type.to_s.upcase, flags_for_type(type, options), params_for_type(type, options), flags_for_type(:all, options)].flatten
+      end
+
+      def flags_for_type(type, **options)
+        self.class::OPTIONS_FLAGS[type].to_a.map do |key|
+          key.to_s.upcase if options[key]
+        end.compact
+      end
+
+      def params_for_type(type, **options)
+        self.class::OPTIONS_PARAMS[type].to_a.map do |key|
+          [key.to_s.upcase, *options[key]] unless options[key].nil?
+        end.compact
+      end
+
+    end
+  end
+end

data/lib/redi_searcher/version.rb

@@ -0,0 +1,3 @@
+module RediSearcher
+  VERSION = '0.1.2'
+end

data/redi_searcher.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "redi_searcher/version"
+
+Gem::Specification.new do |s|
+  s.name        = "redi_searcher"
+  s.version     = RediSearcher::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Patricio Beckmann"]
+  s.email       = ["pato.beckmann@gmail.com"]
+  s.homepage    = "https://github.com/Ticketplus/redi_searcher"
+  s.summary     = %q{RediSearch ruby client}
+  s.description = %q{''}
+  s.required_ruby_version = '>= 2.3'
+  s.license     = 'MIT'
+
+  s.add_dependency "redis", ">= 3.0"
+
+  s.files         = `git ls-files`.split("\n").reject { |f| f.match(%r{^(spec/)}) }
+
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: redi_searcher
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Patricio Beckmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: "''"
+email:
+- pato.beckmann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- lib/redi_searcher.rb
+- lib/redi_searcher/client.rb
+- lib/redi_searcher/client/command_base.rb
+- lib/redi_searcher/document.rb
+- lib/redi_searcher/index.rb
+- lib/redi_searcher/schema.rb
+- lib/redi_searcher/schema/field.rb
+- lib/redi_searcher/version.rb
+- redi_searcher.gemspec
+homepage: https://github.com/Ticketplus/redi_searcher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: RediSearch ruby client
+test_files: []