switch_searchable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ba9fd6bd972bc10b563a5db10db7197b7f9ab3d
+  data.tar.gz: 735f1ca6f3d49405615b3125a9f6c46b3549f7a6
+SHA512:
+  metadata.gz: 077a86694dcb3ca68de0fe1e28597a10164d1286dd772035365a1faa787a0a0d052676ea7a7f9f7710e4ecfc8731e1106710cf18c3c48c4b141d0a1a333ac428
+  data.tar.gz: 9481c68b69d7e8853164f6568dbf9de2f709a7bd84e218c2ff4f09e60086a6bc75aad924cd777e6a4c5665592f2a0ec497de40059c48c54b5455aa9f164f3770

data/.gitignore

@@ -0,0 +1,13 @@
+/.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.4
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in switch_searchable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,56 @@
+# SwitchSearchable
+
+Manages multiple search engines in your Rails app. Supported are - PGSearch, AlgoliaSearch and Elasticsearch.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'switch_searchable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install switch_searchable
+
+## Usage
+
+***Make sure you have setup services with Algolia, Elasticsearch. If you are using Postgresql nothing needs to be setup.***
+
+In your AR model:
+
+```ruby
+class Lead < ActiveRecord::Base
+  include SwitchSearchable::Searchable
+
+  searchable_attributes(
+    :company_name,
+    :first_name,
+    :last_name,
+    :email,
+    {phones: [:number]}
+  )
+
+  has_may :phones
+end
+```
+
+To create an index, run:
+
+```
+Lead.reindex!
+```
+
+After that, you can now search:
+```
+Lead.search("Neil the man")
+```
+
+## 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 "switch_searchable"
+
+# 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/switch_searchable.rb

@@ -0,0 +1,11 @@
+require "pg_search"
+require "algoliasearch-rails"
+require "elasticsearch/rails"
+require "elasticsearch/model"
+require "switch_searchable/version"
+require "switch_searchable/searchable"
+require "switch_searchable/search_engine/algolia"
+require "switch_searchable/search_engine/elasticsearch"
+require "switch_searchable/search_engine/postgres"
+
+module SwitchSearchable; end

data/lib/switch_searchable/search_engine/algolia.rb

@@ -0,0 +1,109 @@
+module SwitchSearchable
+  module SearchEngine
+    module Algolia
+      class BadConfiguration < StandardError; end
+      class RequiredMethodNotDefined < StandardError; end
+
+      class << self
+        def included(klass)
+          raise_errors
+
+          klass.class_eval do
+            extend ClassMethods
+            include AlgoliaSearch
+          end
+        end
+
+        def raise_errors
+          raise(
+            BadConfiguration,
+            "Please add ALGOLIA_APP_ID in your environment variables"
+          ) unless ENV["ALGOLIA_APP_ID"]
+
+          raise(
+            BadConfiguration,
+            "Please add ALGOLIA_API_KEY in your environment variables"
+          ) unless ENV["ALGOLIA_APP_ID"]
+
+          raise(
+            BadConfiguration,
+            "Please add ALGOLIA_ENVIRONMENT in your environment variables"
+          ) unless ENV["ALGOLIA_ENVIRONMENT"]
+        end
+
+        module ClassMethods
+          def init_search_engine(*names)
+            algoliasearch index_name: "#{self.to_s}_#{ENV["ALGOLIA_ENVIRONMENT"]}" do
+              names.flatten.each do |name|
+                if name.is_a? Symbol
+                  attribute(name)
+                elsif name.is_a? Hash
+                  name.keys.each do |key|
+                    array = name[key]
+                    raise(
+                      BadDataType,
+                      "searchable_attributes associations can only have Array"
+                    ) unless array.is_a? Array
+
+                    attribute(key) do
+                      value = send(key)
+                      unless value.blank?
+                        if value.respond_to? :to_a
+                          value.map do |v|
+                            array.inject({}) do |hash, element|
+                              raise(
+                                BadDataType,
+                                "searchable_attributes associations
+                                attributes can only have Symbol"
+                              ) unless array.is_a? Array
+
+                              hash[element] = v.send(element)
+                            end
+                          end
+                        else
+                          array.inject({}) do |hash, element|
+                            raise(
+                              BadDataType,
+                              "searchable_attributes associations 
+                              attributes can only have Symbol"
+                            ) unless array.is_a? Array
+
+                            hash[element] = value.send(element)
+                          end
+                        end
+                      end
+                    end
+                  end
+                else
+                  raise(
+                    BadDataType,
+                    "searchable_attributes can only be
+                    either a Symbol or an Array"
+                  )
+                end
+              end
+
+              searchable_attrs = names.flatten.map do |name|
+                if name.is_a? Hash
+                  name.keys
+                else
+                  name
+                end
+              end.flatten
+
+              searchableAttributes(searchable_attrs)
+            end
+          end
+
+          def search(term)
+            algolia_search(term)
+          end
+
+          def reindex_search_engine!
+            algolia_reindex!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/switch_searchable/search_engine/elasticsearch.rb

@@ -0,0 +1,111 @@
+module SwitchSearchable
+  module SearchEngine
+    module Elasticsearch
+      class BadConfiguration < StandardError; end
+      class BadDataType < StandardError; end
+
+      class << self
+        def included(klass)
+          raise_errors
+
+          klass.class_eval do
+            extend ClassMethods
+            include ::Elasticsearch::Model
+            include ::Elasticsearch::Model::Callbacks
+          end
+        end
+
+        def raise_errors
+          raise(
+            BadConfiguration,
+            "Please add ELASTICSEARCH_HOST in your environment variables"
+          ) unless ENV["ELASTICSEARCH_HOST"]
+        end
+
+        module ClassMethods
+          def init_search_engine(*names)
+            index_name Rails.application.class.parent_name.underscore
+            document_type self.name.downcase
+
+            fields = names.flatten.inject([]) do |result_arr, name|
+              if name.is_a? Symbol
+                result_arr << name
+              elsif name.is_a? Hash
+                name.keys.each do |key|
+                  array = name[key]
+                  raise(
+                    BadDataType,
+                    "searchable_attributes associations can only have Array"
+                  ) unless array.is_a? Array
+
+                  result = array.inject([]) do |array, element|
+                    raise(
+                      BadDataType,
+                      "searchable_attributes associations
+                      attributes can only have Symbol"
+                    ) unless array.is_a? Array
+
+                    array << key.to_s + "." + element.to_s
+                  end
+
+                  result_arr << result
+                end
+              else
+                raise(
+                  BadDataType,
+                  "searchable_attributes can only be either a Symbol or an Hash"
+                )
+              end
+
+              result_arr.flatten
+            end
+
+            define_singleton_method(:call_search) do |term|
+              __elasticsearch__.search(
+                { query:
+                  { multi_match:
+                    { query: term, fields: fields}
+                  },
+                  size: 10000,
+                }
+              )
+            end
+
+            as_indexed_hash = names.flatten.inject({}) do |result_hash, name|
+              if name.is_a? Hash
+                name.keys.each do |key|
+                  array = name[key]
+                  raise(
+                    BadDataType,
+                    "searchable_attributes associations can only have Array"
+                  ) unless array.is_a? Array
+
+                  result_hash[key] = { only: array }
+                end
+              end
+
+              result_hash
+            end
+
+            define_method(:as_indexed_json) do |options|
+              self.as_json(only: names.flatten, include: as_indexed_hash)
+            end
+          end
+
+          def search(term)
+            connection
+            call_search(term).records
+          end
+
+          def reindex_search_engine!
+            puts "Creating index..."
+            __elasticsearch__.create_index! force: true
+            __elasticsearch__.refresh_index!
+            puts "Importing data..."
+            import
+          end
+        end
+      end
+    end
+  end
+end

data/lib/switch_searchable/search_engine/postgres.rb

@@ -0,0 +1,51 @@
+module SwitchSearchable
+  module SearchEngine
+    module Postgres
+      class BadConfiguration < StandardError; end
+
+      class << self
+        def included(klass)
+          raise_errors
+
+          klass.class_eval do
+            extend ClassMethods
+            include PgSearch
+          end
+        end
+
+        def raise_errors; end
+
+        module ClassMethods
+          def init_search_engine(*names)
+            trigram_threshold = {using: {trigram: {
+              threshold: 0.05
+            }}}
+
+            # there should only be one Hash in *names
+            associated_against = nil
+            against = names.flatten.inject([]) do |array, value|
+              if value.is_a? Symbol
+                array << value
+              elsif value.is_a? Hash
+                associated_against = value
+              end
+
+              array
+            end
+
+            pg_search_scope(:pg_search, {
+              against: against,
+              associated_against: associated_against,
+            }.merge(trigram_threshold))
+          end
+
+          def search(term)
+            pg_search(term)
+          end
+
+          def reindex_search_engine!; end
+        end
+      end
+    end
+  end
+end

data/lib/switch_searchable/searchable.rb

@@ -0,0 +1,65 @@
+module SwitchSearchable
+  module Searchable
+    class BadConfiguration < StandardError; end
+    class RequiredMethodNotDefined < StandardError; end
+
+    class << self
+      def included(klass)
+        check_config
+
+        klass.class_eval do
+          extend ClassMethods
+          include "SwitchSearchable::SearchEngine::#{ENV["SEARCH_ENGINE"]}".
+            constantize
+        end
+
+        check_methods(klass)
+      end
+
+      def check_config
+        raise(
+          BadConfiguration,
+          "Please add SEARCH_ENGINE in your environment variables"
+        ) unless ENV["SEARCH_ENGINE"]
+      end
+
+      def check_methods(klass)
+        raise(
+          RequiredMethodNotDefined,
+          ":raise_errors method not defined in your search engine"
+        ) unless "SwitchSearchable::SearchEngine::#{ENV["SEARCH_ENGINE"]}".
+          constantize.respond_to? :raise_errors
+
+        raise(
+          RequiredMethodNotDefined,
+          ":search method not defined in your search engine"
+        ) unless klass.respond_to? :search
+
+        raise(
+          RequiredMethodNotDefined,
+          ":reindex_search_engine! method not defined in your search engine"
+        ) unless klass.respond_to? :reindex_search_engine!
+
+        raise(
+          RequiredMethodNotDefined,
+          ":init_search_engine method not defined in your search engine"
+        ) unless klass.respond_to? :init_search_engine
+      end
+
+      module ClassMethods
+        def searchable_attributes(*names)
+          init_search_engine(names)
+        end
+
+        def search(term)
+          "SwitchSearchable::SearchEngine::#{ENV["SEARCH_ENGINE"]}".
+            constantize.search(term)
+        end
+
+        def reindex!
+          reindex_search_engine!
+        end
+      end
+    end
+  end
+end

data/lib/switch_searchable/version.rb

@@ -0,0 +1,3 @@
+module SwitchSearchable
+  VERSION = "0.0.1"
+end

data/switch_searchable.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "switch_searchable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "switch_searchable"
+  spec.version       = SwitchSearchable::VERSION
+  spec.authors       = ["Neil Marion dela Cruz"]
+  spec.email         = ["nmfdelacruz@gmail.com"]
+
+  spec.summary       = %q{Manages different search engines in a Rails app}
+  spec.description   = %q{Manages different search engines in a Rails app}
+  spec.homepage      = "https://github.com/carabao-capital/switch_searchable"
+  spec.license       = "MIT"
+
+  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_runtime_dependency "pg_search", "~> 2.1.0", ">= 2.1.0"
+  spec.add_runtime_dependency "algoliasearch-rails", "~> 1.20.1", ">= 1.20.1"
+  spec.add_runtime_dependency "elasticsearch-model", "~> 5.0.1", ">= 5.0.1"
+  spec.add_runtime_dependency "elasticsearch-rails", "~> 5.0.1", ">= 5.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: switch_searchable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Neil Marion dela Cruz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg_search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: algoliasearch-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.20.1
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: Manages different search engines in a Rails app
+email:
+- nmfdelacruz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/switch_searchable.rb
+- lib/switch_searchable/search_engine/algolia.rb
+- lib/switch_searchable/search_engine/elasticsearch.rb
+- lib/switch_searchable/search_engine/postgres.rb
+- lib/switch_searchable/searchable.rb
+- lib/switch_searchable/version.rb
+- switch_searchable.gemspec
+homepage: https://github.com/carabao-capital/switch_searchable
+licenses:
+- MIT
+metadata: {}
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Manages different search engines in a Rails app
+test_files: []