redi_search_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b44c7956cc281079bd1791948a8cc4f166d4711
+  data.tar.gz: cfb12628b5f38e841fc7e045fca4576796ebd841
+SHA512:
+  metadata.gz: 7034488828576a549979c08b50227c9ec6f854c7bf449f8168f4015b8943aeca2457e60641ab0bf74ad381a935a4c5d964f7553ed9ea19b57aed6fb375adac81
+  data.tar.gz: 6196ff4ab6d475b783f4d84de6905eedcdee6d56a5b7942ac0087dc3fead2a701b54db6cdfb34f7362ff317ba494a645be74450d14f1b5882ecbf3be472bd775

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dmitrypol@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redi_search_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dmitry Polyakovsky
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# RediSearchRails
+
+This gems simplifies integration with RediSearch module (http://redisearch.io/).  This software is of Alpha quality and is provided with no warranties whatsoever.  Additionally RediSearch is still not officially released so major features may change.  
+
+## Installation
+
+Install Redis and RediSearch following instructions on http://redisearch.io/Quick_Start/.  
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redi_search_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redi_search_rails
+
+## Configuration
+
+Create **config/initializers/redi_search_rails.rb**
+
+```ruby
+REDI_SEARCH = Redis.new(host: '127.0.0.1', port: '6379')
+```
+
+## Usage
+
+```ruby
+class User < ApplicationRecord
+  include RediSearchRails
+  redisearch_schema   name: 'TEXT', email: 'TEXT', age: 'NUMERIC'
+end
+# => create index
+rails r User.ft_create
+# => populate with records
+rails r User.ft_add_all
+# => search
+rails r "User.ft_search('query here')"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.  To understand the code look in `lib/redi_search_rails`.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## TODOs
+
+* Tests
+* Support additional RediSearch API calls (SUGGADD, SUGGET, ...)
+* Support configuring SCORE
+* Rake tasks
+* ActiveModel callbacks to index records on saving
+* Support indexing fields from related models (index group name if user belongs to a group)
+* Stopwords configuration
+* Minimum keyword length to index
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dmitrypol/redi_search_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redi_search_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redi_search_rails.rb

@@ -0,0 +1,88 @@
+require "redi_search_rails/version"
+
+module RediSearchRails
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    def redisearch_schema(schema)
+      @@schema = schema.to_a.flatten
+      @@fields = schema.keys
+      @@model = self.name.constantize
+      @@index_name = @@model.to_s
+      @@score = 1
+    end
+
+    def ft_search query
+      results = REDI_SEARCH.call('FT.SEARCH', @@index_name, query,
+       #'LIMIT', 0, 1000,
+       #'NOCONTENT', #'VERBATIM',  #'WITHSCORES', #'NOSTOPWORDS', #'WITHPAYLOADS',
+      )
+      return results
+    rescue Exception => e
+      Rails.logger.error e
+      return e.message
+    end
+
+    def ft_create
+      REDI_SEARCH.call('FT.CREATE', @@index_name,
+        #'NOFIELDS', 'NOSCOREIDX', 'NOOFFSETS',
+        'SCHEMA', @@schema
+      )
+      ft_optimize
+    rescue Exception => e
+      Rails.logger.error e
+      return e.message
+    end
+
+    def ft_add_all
+      @@model.all.each {|record| ft_add(record) }
+    rescue Exception => e
+      Rails.logger.error e
+      return e.message
+    end
+
+    def ft_add record
+      fields = []
+      @@fields.each { |field| fields.push(field, record.send(field)) }
+      REDI_SEARCH.call('FT.ADD', @@index_name, record.to_global_id, @@score,
+        'REPLACE',
+        #'NOSAVE', 'PAYLOAD', record.name,
+        'FIELDS', fields
+      )
+    rescue Exception => e
+      Rails.logger.error e
+      return e.message
+    end
+
+    def ft_del doc_id
+      REDI_SEARCH.call('FT.DEL', @@index_name, doc_id)
+    rescue Exception => e
+      Rails.logger.error e
+      return e.message
+    end
+
+    def ft_optimize
+      REDI_SEARCH.call('FT.OPTIMIZE', @@index_name)
+    rescue Exception => e
+      Rails.logger.error e
+      return e.message
+    end
+
+    def ft_drop
+      REDI_SEARCH.call('FT.DROP', @@index_name)
+    rescue Exception => e
+      Rails.logger.error e
+      return e.message
+    end
+
+    def ft_info
+      ap REDI_SEARCH.call('FT.INFO', @@index_name)
+    rescue Exception => e
+      Rails.logger.error e
+      return e.message
+    end
+
+  end
+
+end

data/lib/redi_search_rails/version.rb

@@ -0,0 +1,3 @@
+module RediSearchRails
+  VERSION = "0.1.0"
+end

data/redi_search_rails.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redi_search_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redi_search_rails"
+  spec.version       = RediSearchRails::VERSION
+  spec.authors       = ["Dmitry Polyakovsky"]
+  spec.email         = ["dmitrypol@gmail.com"]
+
+  spec.summary       = %q{Simplifies integration with http://redisearch.io/.}
+  spec.description   = %q{Simplifies integration with http://redisearch.io/ and Rails applications.}
+  spec.homepage      = "https://github.com/dmitrypol/redi_search_rails"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  # =>
+  spec.add_runtime_dependency "activesupport", "~> 5.0.0"
+  spec.add_runtime_dependency "redis", "~> 3.3"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: redi_search_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitry Polyakovsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Simplifies integration with http://redisearch.io/ and Rails applications.
+email:
+- dmitrypol@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redi_search_rails.rb
+- lib/redi_search_rails/version.rb
+- redi_search_rails.gemspec
+homepage: https://github.com/dmitrypol/redi_search_rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Simplifies integration with http://redisearch.io/.
+test_files: []