elasticsearch-autocomplete 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a632d2806037ffcbd72284c1740ffbb74e62583
+  data.tar.gz: a5886398ab278a66e506b05bcf4909352de8b745
+SHA512:
+  metadata.gz: 070583334041cff1cc3a18d207627fe25356769dcec49a885ec427b909ec7a44452f49ec0315bdb78d0c8d90a34b9810728f1e691055dd37cd13659a108b2f3c
+  data.tar.gz: 6490e715fe8d4712aed10d1586bc90f2b8b11b0543db858ffa16e7d24892505aef1836f9ff811f20463631ecdc4c0c1726c70177a9374d3de4f081a81d45001e

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.1.1
+
+- Added {field}.beginning to filters
+- Added analysis filter `ngram_beginning` for analyser `beginning`
+- Updated specs and README to reflect addition
+- Current fields for `multi_field`
+  - field, field.exact, field.beginning, field.autocomplete, field.fuzzy
+
+## 0.1.0
+
+- Initial Release

data/README.md

@@ -0,0 +1,150 @@
+# ElasticSearch Autocomplete
+[![Code Climate](https://codeclimate.com/github/spodlecki/elasticsearch-autocomplete/badges/gpa.svg)](https://codeclimate.com/github/spodlecki/elasticsearch-autocomplete)
+[![Test Coverage](https://codeclimate.com/github/spodlecki/elasticsearch-autocomplete/badges/coverage.svg)](https://codeclimate.com/github/spodlecki/elasticsearch-autocomplete/coverage)
+[![Build Status](https://travis-ci.org/spodlecki/elasticsearch-autocomplete.svg)](https://travis-ci.org/spodlecki/elasticsearch-autocomplete)
+
+Quick and simple way to perform autocomplete with ElasticSearch Servers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'elasticsearch-autocomplete'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Dependencies
+
+- [Elasticsearch::Model](https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-model)
+- [Rails > 3.2.8](http://rubyonrails.org/)
+- [Elasticsearch Server > 1.0.1](http://www.elastic.co)
+
+## Usage
+
+### Field Explaination
+
+![Quick Brown Fox](http://i57.tinypic.com/vdivie.png)
+Access each field as if they were a nested attribute (`field.fuzzy`, `field.exact`, ...).
+
+### Searching
+
+**map file**
+(**ROOT**/lib/elasticsearch/autocomplete/**TYPE**_type.rb)
+
+```
+module Elasticsearch
+  module Autocomplete
+    class ColorType < Type
+      # Value of ElasticSearch's _type
+      # => String
+      def type
+        'color'
+      end
+
+      # Search Hash
+      # This is the entire search query for ElasticSearch
+      #
+      def to_hash
+        {
+          query: { match_all: {}},
+          filter: {
+            and: [
+              { term: {_type: 'color'} }
+            ]
+          }
+        }
+      end
+
+      # Return the hash to which the result is mapped from
+      # @method mapped
+      # @param source {OpenStruct} Source value from ElasticSearch result
+      # @return Hash
+      #
+      def mapped(source)
+        {
+          id: source.id,
+          name: source.name,
+          image: image_path(source.icon),
+          type: type
+        }
+      end
+
+      # Optional to set
+      # If you intend on using any of the helpers, this will need to be set
+      #
+      def field
+        :name
+      end
+    end
+  end
+end
+```
+
+**controller**
+```
+# Search Multiple Types, each with their own query
+search = Elasticsearch::Autocomplete::Search.find(index_string, params[:term], ['actress'])
+search.results # => []
+
+# Multiple Types, with a single result set
+# @param index {String} ElasticSearch Index Name
+# @param term {String} Query String being searched
+# @param types {Array} Array of types being searched for in ElasticSearch
+# @param multisearch {Boolean} Are we splitting each type into its own query?
+# @param field {String|Symbol} If doing a single query, pass the name of the field to be searched
+search = Elasticsearch::Autocomplete::Search.find(index_string, params[:term], ['actress'], false, :name)
+search.results # => []
+```
+
+**model indexing**
+```
+# Assuming you are using Elasticsearch::Model as your indexing tool
+
+mapping do
+  # ...
+  indexes :field_name, Elasticsearch::Autocomplete::Filters.config(:field_name)
+  # ...
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Type Helper Methods
+
+```
+def image_path(image_string)
+  # => Generates an asset url for an image
+end
+```
+
+```
+# https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html
+# Quickly use the multiple fields matcher search format
+# Usage: { query: multi_match({exact: 30}) }
+#
+def multi_match(rank_overrides={})
+  ranks = {exact: 10, beginning: 7, autocomplete: 5, fuzzy: 1}.merge(rank_overrides)
+
+  {..}
+  # => returns built hash for the multi_match query
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO
+
+- Create generator for new types
+- Get codeclimate online

data/Rakefile

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

data/lib/elasticsearch.rb

@@ -0,0 +1 @@
+require 'elasticsearch/autocomplete'

data/lib/elasticsearch/autocomplete.rb

@@ -0,0 +1,16 @@
+require 'elasticsearch/autocomplete/version'
+
+require 'elasticsearch/autocomplete/filters'
+require 'elasticsearch/autocomplete/type'
+require 'elasticsearch/autocomplete/request'
+require 'elasticsearch/autocomplete/multiple_request'
+require 'elasticsearch/autocomplete/single_request'
+require 'elasticsearch/autocomplete/response'
+require 'elasticsearch/autocomplete/multiple_response'
+require 'elasticsearch/autocomplete/single_response'
+require 'elasticsearch/autocomplete/search'
+
+module Elasticsearch
+  module Autocomplete
+  end
+end

data/lib/elasticsearch/autocomplete/filters.rb

@@ -0,0 +1,72 @@
+# TODO
+# Add beginning of entire string rank
+
+module Elasticsearch
+  module Autocomplete
+    module Filters
+      module ClassMethods
+        def analysis
+          {
+            analysis: {
+              analyzer: {
+                simple: {
+                  type: "custom",
+                  tokenizer: "standard",
+                  filter: [ "standard", "lowercase", "stop" ]
+                },
+                autocomplete: {
+                  type: "custom",
+                  tokenizer: "standard",
+                  filter: [ 'asciifolding', "standard", "lowercase", "stop", "kstem", "ngram_front" ]
+                },
+                fuzzy: {
+                  type: "custom",
+                  tokenizer: "standard",
+                  filter: [ 'asciifolding', "standard", "lowercase", "stop", "kstem", "ngram_short" ]
+                },
+                beginning: {
+                  type: "custom",
+                  tokenizer: "keyword",
+                  filter: [ "lowercase", 'asciifolding', 'ngram_beginning' ]
+                }
+              },
+              filter: {
+                ngram_beginning: {
+                  type: "edgeNGram",
+                  min_gram: 2,
+                  max_gram: 30
+                },
+                ngram_front: {
+                  type: "edgeNGram",
+                  min_gram: 2,
+                  max_gram: 15
+                },
+                ngram_short: {
+                  type: "ngram",
+                  min_gram: 2,
+                  max_gram: 15
+                }
+              }
+            }
+          }
+        end
+
+        def build_config(field)
+          {
+            :type => :multi_field,
+            :fields => {
+              field.to_sym => { type: 'string' },
+              :"#{field}.exact" => { type: 'string', index_analyzer: 'simple' },
+              :"#{field}.beginning" => { type: 'string', index_analyzer: 'beginning'},
+              :"#{field}.autocomplete" => { type: 'string', index_analyzer: 'autocomplete'},
+              :"#{field}.fuzzy" => { type: 'string', index_analyzer: 'fuzzy'}
+            }
+          }
+        end
+
+        alias_method :config, :build_config
+      end
+      extend ClassMethods
+    end
+  end
+end

data/lib/elasticsearch/autocomplete/multiple_request.rb

@@ -0,0 +1,36 @@
+###
+# Returns the search body as a hash for autocomplete module
+#
+# Building the hash in a specific format is vital to developing
+# a multi-query search from elasticsearch. Results are returned in the specific
+# order you submit the query in.
+#
+# Each 'type' should have a corrisponding class.
+# Example:
+# If the type would be a 'tag'-
+# => Elasticsearch::Autocomplete::TagType
+###
+
+module Elasticsearch
+  module Autocomplete
+    class MultipleRequest < Request
+      def body
+        @body ||= begin
+          result = []
+          types.each do |t|
+            result << index_hash
+            result << t.to_hash
+          end
+
+          result
+        end
+      end
+
+    private
+
+      def index_hash
+        {:index => index}
+      end
+    end
+  end
+end

data/lib/elasticsearch/autocomplete/multiple_response.rb

@@ -0,0 +1,6 @@
+module Elasticsearch
+  module Autocomplete
+    class MultipleResponse < Response
+    end
+  end
+end

data/lib/elasticsearch/autocomplete/request.rb

@@ -0,0 +1,30 @@
+###
+# Returns the search body as a hash for autocomplete module
+#
+# Building the hash in a specific format is vital to developing
+# a multi-query search from elasticsearch. Results are returned in the specific
+# order you submit the query in.
+#
+# Each 'type' should have a corrisponding class.
+# Example:
+# If the type would be a 'tag'-
+# => Elasticsearch::Autocomplete::TagType
+###
+
+module Elasticsearch
+  module Autocomplete
+    class Request
+      attr_accessor :query, :types, :index
+
+      def initialize(index, query, types)
+        self.query = query
+        self.types = types
+        self.index = index
+      end
+
+      def body
+        {}
+      end
+    end
+  end
+end

data/lib/elasticsearch/autocomplete/response.rb

@@ -0,0 +1,53 @@
+require 'ostruct'
+require 'elasticsearch/model'
+
+module Elasticsearch
+  module Autocomplete
+    class Response
+      include Enumerable
+
+      delegate :body, to: :request
+
+      attr_accessor :types, :request, :results
+
+      def initialize(types, request)
+        self.request = request
+        self.types = types
+        self.results = search
+      end
+
+      def each(&block)
+        results.each do |result|
+          member = parse_response(result)
+
+          block.call(member)
+        end
+      end
+
+    protected
+
+      def search
+        r = Elasticsearch::Model.client.msearch(:body => body)
+        r['responses']
+      end
+
+      def parse_response(results)
+        results['hits']['hits'].map do |search_result|
+          src = search_result['_source']
+          type = search_result['_type']
+          score = search_result['_score']
+          returned_type = types.select{|t| t.type == type }.first
+
+          if returned_type
+            returned_type.mapped(
+              OpenStruct.new(src)
+            )
+          else
+            src
+          end.merge(:_score => score, :_type => type)
+        end
+      end
+
+    end
+  end
+end

data/lib/elasticsearch/autocomplete/search.rb

@@ -0,0 +1,57 @@
+module Elasticsearch
+  module Autocomplete
+    class Search
+      module ClassMethods
+        def find(index, query, types=[])
+          search = self.new(index, query, types)
+        end
+      end
+      extend ClassMethods
+
+      attr_accessor :query, :types, :index, :multisearch, :field
+
+      def initialize(index, query, types, multisearch=true, field=nil)
+        raise "Specify a field when running a single search." if multisearch == false && field.nil?
+
+        self.query = query
+        self.types = types_mapped(types)
+        self.index = index
+
+        self.multisearch = multisearch
+        self.field = field
+      end
+
+      def results
+        @results ||= begin
+          if multisearch
+            MultipleResponse.new(types, request)
+          else
+            SingleResponse.new(types, request)
+          end
+        end
+      end
+
+      def request
+        @request ||= begin
+          if multisearch
+            MultipleRequest.new(index, query, types)
+          else
+            SingleRequest.new(index, query, types, field)
+          end
+        end
+      end
+
+    private
+
+      def types_mapped(types)
+        types = Array(types)
+
+        types.map do |type|
+
+          "Elasticsearch::Autocomplete::#{type.capitalize}Type".constantize
+                                                  .new(query)
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/autocomplete/single_request.rb

@@ -0,0 +1,37 @@
+###
+# Returns the search body as a hash for autocomplete module
+#
+# Building the hash in a specific format is vital to developing
+# a multi-query search from elasticsearch. Results are returned in the specific
+# order you submit the query in.
+#
+# Each 'type' should have a corrisponding class.
+# Example:
+# If the type would be a 'tag'-
+# => Elasticsearch::Autocomplete::TagType
+###
+
+module Elasticsearch
+  module Autocomplete
+    class SingleRequest < Request
+      attr_accessor :field
+
+      def initialize(index, query, types, field)
+        super(index, query, types)
+        self.field = field
+      end
+
+      def body
+        @body ||= begin
+          {
+            :index => index,
+            :type => types.map(&:type).uniq,
+            :body => {
+              :query => Type.single_search(query, field)
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/autocomplete/single_response.rb

@@ -0,0 +1,19 @@
+module Elasticsearch
+  module Autocomplete
+    class SingleResponse < Response
+
+      def each(&block)
+        members = parse_response(results)
+        members.each do |member|
+          block.call(member)
+        end
+      end
+
+    protected
+
+      def search
+        @search ||= Elasticsearch::Model.client.search(body)
+      end
+    end
+  end
+end

data/lib/elasticsearch/autocomplete/type.rb

@@ -0,0 +1,74 @@
+require 'action_controller'
+
+module Elasticsearch
+  module Autocomplete
+    class Type
+
+      module ClassMethods
+        def single_search(query, field)
+          t = self.new(query)
+          t.send(:multi_match, {}, query, field)
+        end
+      end
+
+      extend ClassMethods
+
+      attr_accessor :query
+
+      def initialize(query)
+        self.query = query
+      end
+
+      # => String
+      def type
+        raise "Replace #type with the ElasticSearch _type"
+      end
+
+      # => Hash
+      def to_hash
+        raise "Replace #to_hash with ElasticSearch Query Hash"
+      end
+
+      # Return the hash to which the result is mapped from
+      # @param source {OpenStruct} Source value from ElasticSearch result
+      # => Hash
+      def mapped(source)
+        raise "Replace #mapped with a mapped response hash"
+      end
+
+      # The field to search on
+      # You'll only need this if you intend on using the search
+      # helpers below
+      #
+      def field
+        raise "Replace #field with the ElasticSearch field name"
+      end
+
+    protected
+
+      def image_path(img)
+        return if img.blank?
+        ActionController::Base.helpers.image_path(img)
+      end
+
+      # https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html
+      # Quickly use the multiple fields matcher search format
+      # => { query: multi_match({exact: 30}) }
+      #
+      def multi_match(rank_overrides={}, query_override=nil, field_override=nil, tie_breaker=0.3)
+        ranks = {exact: 10, beginning: 7, autocomplete: 5, fuzzy: 1}.merge(rank_overrides)
+        field_override ||= field
+        query_override ||= query
+
+        {
+          :multi_match => {
+            :query  => query_override,
+            :type   => 'most_fields',
+            :fields => ranks.map{|k,v| :"#{field_override}.#{k}^#{v}" },
+            :tie_breaker =>  tie_breaker
+          }
+        }
+      end
+    end
+  end
+end

data/lib/elasticsearch/autocomplete/version.rb

@@ -0,0 +1,5 @@
+module Elasticsearch
+  module Autocomplete
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: elasticsearch-autocomplete
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- s.podlecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Include autocomplete into your project. Base capability can perform multiple
+  queries per request.
+email:
+- s.podlecki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/elasticsearch.rb
+- lib/elasticsearch/autocomplete.rb
+- lib/elasticsearch/autocomplete/filters.rb
+- lib/elasticsearch/autocomplete/multiple_request.rb
+- lib/elasticsearch/autocomplete/multiple_response.rb
+- lib/elasticsearch/autocomplete/request.rb
+- lib/elasticsearch/autocomplete/response.rb
+- lib/elasticsearch/autocomplete/search.rb
+- lib/elasticsearch/autocomplete/single_request.rb
+- lib/elasticsearch/autocomplete/single_response.rb
+- lib/elasticsearch/autocomplete/type.rb
+- lib/elasticsearch/autocomplete/version.rb
+homepage: https://github.com/spodlecki/elasticsearch-autocomplete
+licenses: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Autocomplete Helpers and Builder
+test_files: []