co-elastic-query 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68ef853b38f5e3752ae82f245326cf99f331e1e4
+  data.tar.gz: 46dd06a05d563613e4ef26298c3f81488e802b48
+SHA512:
+  metadata.gz: f009e914e70254347d8e0fea7b954fe4365176b9941cfdcf3f2288bc5054c8bd61b3de232f9ffdafa0c7dbbb931a3c4bb3e90fe2679c045c62309f7c63580ea8
+  data.tar.gz: 08a6998306551b5d9e51409f2e6fbbd09a90088817643064a0ffce304b6f45b3579e04b04bc4ab860fc2813d05b19834576fca86c59820f35032762af724e572

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 CoTag Media
+
+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,29 @@
+# Elastic::Helper
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'elastic-helper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elastic-helper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/elastic-helper/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/co-elastic-query.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'co-elastic-query/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'co-elastic-query'
+  spec.version       = CoElasticQuery::VERSION
+  spec.authors       = ['Stephen von Takach', 'Will Cannings']
+  spec.email         = ['steve@cotag.me', 'me@willcannings.com']
+  spec.summary       = 'Elasticsearch query generator'
+  spec.homepage      = 'http://cotag.me/'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency             'elasticsearch', '~> 1.0.5'
+end

data/lib/co-elastic-query.rb

@@ -0,0 +1,248 @@
+require 'elasticsearch'
+
+class Elastic
+    class Query
+        def initialize(params)
+            query = params.permit(:q, :limit, :offset)
+
+            @filters = nil
+            @search = query[:q]
+
+            @limit = query[:limit] || 20
+            @limit = @limit.to_i
+            @limit = 50 if @limit > 50
+
+            @offset = query[:offset] || 0
+            @offset = offset.to_i
+            @offset = 10000 if offset > 10000
+        end
+
+
+        attr_accessor :offset
+        attr_accessor :limit
+        attr_accessor :sort
+
+        def raw_filter(filter)
+            @raw_filter = filter
+        end
+
+
+        # filters is in the form {fieldname1: ['var1','var2',...], fieldname2: ['var1','var2'...]}
+        # NOTE:: may overwrite an existing filter in merge
+        def filter(filters)
+            @filters ||= {}
+            @filters.merge!(filters)
+        end
+
+        # Like filter however all keys are OR's instead of AND's
+        def or_filter(filters)
+            @orFilter ||= {}
+            @orFilter.merge!(filters)
+        end
+
+        def range(filter)
+            @rangeFilter ||= []
+            @rangeFilter << filter
+        end
+
+        # Call to add fields that should be missing
+        # Effectively adds a filter that ensures a field is missing
+        def missing(*fields)
+            @missing ||= Set.new
+            @missing.merge(fields)
+        end
+
+        # The opposite of filter
+        def not(filters)
+            @nots ||= {}
+            @nots.merge!(filters)
+        end
+
+        def build
+            if @filters
+                fieldfilters = []
+
+                @filters.each do |key, value|
+                    fieldfilter = { :or => [] }
+                    build_filter(fieldfilter[:or], key, value)
+
+                    # TODO:: Discuss this - might be a security issue
+                    unless fieldfilter[:or].empty?
+                        fieldfilters.push(fieldfilter)
+                    end
+                end
+            end
+
+            if @orFilter
+                fieldfilters ||= []
+                fieldfilter = { :or => [] }
+                orArray = fieldfilter[:or]
+
+                @orFilter.each do |key, value|
+                    build_filter(orArray, key, value)
+                end
+
+                unless orArray.empty?
+                    fieldfilters.push(fieldfilter)
+                end
+            end
+
+            if @rangeFilter
+                fieldfilters ||= []
+
+                @rangeFilter.each do |value|
+                    fieldfilters.push({range: value})
+                end
+            end
+
+            if @nots
+                fieldfilters ||= []
+
+                @nots.each do |key, value|
+                    fieldfilter = { :not => { :or => [] } }
+                    build_filter(fieldfilter[:not][:or], key, value)
+                    unless fieldfilter[:not].empty?
+                        fieldfilters.push(fieldfilter)
+                    end
+                end
+            end
+
+            if @missing
+                fieldfilters ||= []
+
+                @missing.each do |field|
+                    fieldfilters.push({
+                        missing: { field: field }
+                    })
+                end
+            end
+
+            if @raw_filter
+                fieldfilters = @raw_filter
+            end
+
+            if @search.present?
+                # HACK:: This is such a hack.
+                # TODO:: join('* ') + '*' (i.e fix ES tokeniser and then match start of words)
+                {
+                    query: {
+                        query_string: {
+                            query: '*' + @search.scan(/[a-zA-Z0-9]+/).join('* *') + '*'
+                        }
+                    },
+                    filters: fieldfilters,
+                    offset: @offset,
+                    limit: @limit
+                }
+            else
+                {
+                    sort: @sort || [{created_at: 'desc'}],
+                    filters: fieldfilters,
+                    query: {
+                        match_all: {}
+                    },
+                    offset: @offset,
+                    limit: @limit
+                }
+            end
+        end
+
+
+        #protected
+
+
+        def build_filter(filters, key, values)
+            values.each { |var|
+                if var.nil?
+                    filters.push({
+                        missing: { field: key }
+                    })
+                else
+                    filters.push({
+                        :term => {
+                            key => var
+                        }
+                    })
+                end
+            }
+        end
+    end
+
+
+    HOST = if ENV['ELASTIC']
+        ENV['ELASTIC'].split(' ').map {|item| "#{item}:9200"}
+    else
+        ['localhost:9200']
+    end
+
+    @@client ||= Elasticsearch::Client.new hosts: HOST, reload_connections: true
+    def self.search *args
+        @@client.search *args
+    end
+
+    HITS = 'hits'.freeze
+    TOTAL = 'total'.freeze
+    ID = '_id'.freeze
+    SCORE = '_score'.freeze
+    INDEX = (ENV['ELASTIC_INDEX'] || 'default').freeze
+
+    def initialize(klass, index = INDEX)
+        @klass = klass
+        @filter = klass.design_document
+        @index = index
+    end
+
+    # Safely build the query
+    def query(params, filters = nil)
+        builder = ::Elastic::Query.new(params)
+        builder.filter(filters) if filters
+        builder
+    end
+
+    def search(builder, &block)
+        opt = builder.build
+
+        sort = opt[:sort] || []
+        sort << SCORE
+
+        queries = opt[:queries] || []
+        queries.unshift(opt[:query])
+
+        filters = opt[:filters] || []
+        filters.unshift({term: {type: @filter}})
+
+        query = {
+            index: @index,
+            body: {
+                sort: sort,
+                query: {
+                    filtered: {
+                        query: {
+                            bool: {
+                                must: queries
+                            }
+                        },
+                        filter: {
+                            bool: {
+                                must: filters
+                            }
+                        }
+                    }
+                },
+                from: opt[:offset],
+                size: opt[:limit]
+            }
+        }
+
+        # if a formatter block is supplied, each loaded record is passed to it
+        # allowing annotation/conversion of records using data from the model
+        # and current request (e.g groups are annotated with 'admin' if the
+        # currently logged in user is an admin of the group)
+        result = Elastic.search(query)
+        records = @klass.find_by_id(result[HITS][HITS].map {|entry| entry[ID]}) || []
+        {
+            total: result[HITS][TOTAL] || 0,
+            results: block_given? ? records.map {|record| yield record} : records
+        }
+    end
+end

data/lib/co-elastic-query/version.rb

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

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: co-elastic-query
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stephen von Takach
+- Will Cannings
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+description: 
+email:
+- steve@cotag.me
+- me@willcannings.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- co-elastic-query.gemspec
+- lib/co-elastic-query.rb
+- lib/co-elastic-query/version.rb
+homepage: http://cotag.me/
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Elasticsearch query generator
+test_files: []
+has_rdoc: