elasticband 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af49e433d1512419bc8c9b383a2b0cb61fe968f4
+  data.tar.gz: d6c0940f96228c7e203969232ed7ed4f3e236157
+SHA512:
+  metadata.gz: d545e4df0a47007b785292f55b29bc6e9a02e7fc3fdf2059c95c9fab1c5fb4b0081d0a241f2373a7f9304f408b7d3eee1b0fdff80bbf9869dddac0906443a43f
+  data.tar.gz: 0e7665259f56491b1c876934f7ac584b50a46022de13c2c02dca468fe3d0fe076bb919abf4da28f5bf8641dc5aab431cd9aba75993dda15e60111ca7b1e7ea97

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+.env
+.rspec_persistence
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 110

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2
+  - ruby-head
+git:
+  depth: 1
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+addons:
+  code_climate:
+    repo_token: 217146fc082e87b5e4b2352141a8832d0da78d66a9d22cb0b5189344648e821e

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Love Mondays
+
+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,34 @@
+# Elasticband
+[![Build Status](https://travis-ci.org/LoveMondays/elasticband.svg)](https://travis-ci.org/LoveMondays/elasticband) [![Code Climate](https://codeclimate.com/github/LoveMondays/elasticband/badges/gpa.svg)](https://codeclimate.com/github/LoveMondays/elasticband) [![Test Coverage](https://codeclimate.com/github/LoveMondays/elasticband/badges/coverage.svg)](https://codeclimate.com/github/LoveMondays/elasticband/coverage)
+
+Query builder for [elasticsearch-rails gem](https://github.com/elastic/elasticsearch-rails)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elasticband'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elasticband
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/LoveMondays/elasticband/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,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/elasticband.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'elasticband/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'elasticband'
+  s.version     = Elasticband::VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  s.date        = '2015-06-26'
+  s.summary     = 'Query builder for elasticsearch-rails'
+  s.homepage    = 'https://github.com/LoveMondays/elasticband'
+  s.license     = 'MIT'
+
+  s.authors     = ['Glauber Campinho', 'Rubens Minoru Andako Bueno']
+  s.email       = ['ggcampinho@gmail.com', 'rubensmabueno@hotmail.com']
+  s.files       = `git ls-files -z`.split("\x0")
+
+  s.add_dependency 'activesupport'
+
+  s.add_development_dependency 'dotenv'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3.3.0'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'codeclimate-test-reporter'
+end

data/lib/elasticband/aggregation/nested.rb

@@ -0,0 +1,18 @@
+module Elasticband
+  class Aggregation
+    class Nested < Aggregation
+      attr_accessor :root_aggregation, :nested_aggregation
+
+      def initialize(root_aggregation, nested_aggregation)
+        self.root_aggregation = root_aggregation
+        self.nested_aggregation = nested_aggregation
+      end
+
+      def to_h
+        root_aggregation.to_h.tap do |h|
+          h[root_aggregation.name].merge!(aggs: nested_aggregation.to_h)
+        end
+      end
+    end
+  end
+end

data/lib/elasticband/aggregation/terms.rb

@@ -0,0 +1,23 @@
+module Elasticband
+  class Aggregation
+    class Terms < Aggregation
+      attr_accessor :field, :options
+
+      def initialize(name, field, options = {})
+        super(name)
+        self.field = field.to_sym
+        self.options = options
+      end
+
+      def to_h
+        super(aggregation_hash)
+      end
+
+      private
+
+      def aggregation_hash
+        { terms: { field: field }.merge!(options) }
+      end
+    end
+  end
+end

data/lib/elasticband/aggregation/top_hits.rb

@@ -0,0 +1,26 @@
+module Elasticband
+  class Aggregation
+    class TopHits < Aggregation
+      attr_accessor :root_aggregation, :size, :from, :options
+
+      def initialize(name, root_aggregation, size, options = {})
+        super(name)
+        self.root_aggregation = root_aggregation
+        self.size = size
+        self.options = options
+      end
+
+      def to_h
+        root_aggregation.to_h.tap do |h|
+          h[root_aggregation.name].merge!(aggs: super(top_hits_hash))
+        end
+      end
+
+      private
+
+      def top_hits_hash
+        { top_hits: { size: size }.merge!(options) }
+      end
+    end
+  end
+end

data/lib/elasticband/aggregation.rb

@@ -0,0 +1,56 @@
+require 'elasticband/aggregation/nested'
+require 'elasticband/aggregation/terms'
+require 'elasticband/aggregation/top_hits'
+
+module Elasticband
+  class Aggregation
+    attr_accessor :name
+
+    def initialize(name)
+      self.name = name.to_sym
+    end
+
+    def to_h(aggregation_hash = {})
+      { name => aggregation_hash }
+    end
+
+    class << self
+      # Parses some options to a Elasticsearch syntax
+      #
+      # #### Options
+      #
+      # * `group_by:` Count results by the value of an attribute using `terms` filter.
+      #   It can receive an array with some attributes:
+      #   * `top_hits:` A number of results that should be return inside the group ranked by score.
+      #   * `size:` Size of the results calculated in each shard (https://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-aggregations-bucket-terms-aggregation.html#_size)
+      #
+      # #### Examples
+      # ```
+      # Aggregation.parse(group_by: :status)
+      # => { status: { terms: { field: :status } } }
+      #
+      # Aggregation.parse(group_by: [:status, size: 5, top_hits: 3])
+      # => { status: { terms: { field: :status, size: 5 }, aggs: { top_status: { top_hits: 3 } } } }
+      def parse(options)
+        parse_group_by(options[:group_by]).to_h
+      end
+
+      private
+
+      def parse_group_by(options_group_by)
+        return {} if options_group_by.blank?
+
+        options_group_by = Array.wrap(options_group_by)
+        options = options_group_by.extract_options!
+        field = options_group_by.first
+
+        aggregation = Aggregation::Terms.new(field, field, options.except(:top_hits))
+        if options[:top_hits]
+          aggregation = Aggregation::TopHits.new(:"top_#{field}", aggregation, options[:top_hits])
+        end
+
+        aggregation
+      end
+    end
+  end
+end

data/lib/elasticband/filter/and.rb

@@ -0,0 +1,24 @@
+module Elasticband
+  class Filter
+    class And < Filter
+      attr_accessor :filters, :options
+
+      def initialize(filters, options = {})
+        self.filters = Array.wrap(filters)
+        self.options = options
+      end
+
+      def to_h
+        { and: filter_hash }
+      end
+
+      private
+
+      def filter_hash
+        return filters.map(&:to_h) if options.blank?
+
+        { filter: filters.map(&:to_h) }.merge!(options)
+      end
+    end
+  end
+end

data/lib/elasticband/filter/not.rb

@@ -0,0 +1,24 @@
+module Elasticband
+  class Filter
+    class Not < Filter
+      attr_accessor :other_filter, :options
+
+      def initialize(other_filter, options = {})
+        self.other_filter = other_filter
+        self.options = options
+      end
+
+      def to_h
+        { not: filter_hash }
+      end
+
+      private
+
+      def filter_hash
+        return other_filter.to_h if options.blank?
+
+        { filter: other_filter.to_h }.merge!(options)
+      end
+    end
+  end
+end

data/lib/elasticband/filter/query.rb

@@ -0,0 +1,24 @@
+module Elasticband
+  class Filter
+    class Query < Filter
+      attr_accessor :query, :options
+
+      def initialize(query, options = {})
+        self.query = query
+        self.options = options
+      end
+
+      def to_h
+        return query_hash if options.blank?
+
+        { fquery: query_hash.merge!(options) }
+      end
+
+      private
+
+      def query_hash
+        { query: query.to_h }
+      end
+    end
+  end
+end

data/lib/elasticband/filter/term.rb

@@ -0,0 +1,23 @@
+module Elasticband
+  class Filter
+    class Term < Filter
+      attr_accessor :filter, :field, :options
+
+      def initialize(filter, field, options = {})
+        self.filter = filter
+        self.field = field.to_sym
+        self.options = options
+      end
+
+      def to_h
+        { term: filter_hash }
+      end
+
+      private
+
+      def filter_hash
+        { field => filter }.merge!(options)
+      end
+    end
+  end
+end

data/lib/elasticband/filter/terms.rb

@@ -0,0 +1,23 @@
+module Elasticband
+  class Filter
+    class Terms < Filter
+      attr_accessor :filters, :field, :options
+
+      def initialize(filters, field, options = {})
+        self.filters = Array.wrap(filters)
+        self.field = field.to_sym
+        self.options = options
+      end
+
+      def to_h
+        { terms: filter_hash }
+      end
+
+      private
+
+      def filter_hash
+        { field => filters }.merge!(options)
+      end
+    end
+  end
+end

data/lib/elasticband/filter.rb

@@ -0,0 +1,13 @@
+require 'elasticband/filter/and'
+require 'elasticband/filter/not'
+require 'elasticband/filter/query'
+require 'elasticband/filter/term'
+require 'elasticband/filter/terms'
+
+module Elasticband
+  class Filter
+    def to_h
+      { match_all: {} }
+    end
+  end
+end

data/lib/elasticband/query/filtered.rb

@@ -0,0 +1,25 @@
+module Elasticband
+  class Query
+    class Filtered < Query
+      attr_accessor :query, :filter, :options
+
+      def initialize(filter, query = nil, options = {})
+        self.filter = filter
+        self.query = query
+        self.options = options
+      end
+
+      def to_h
+        { filtered: query_hash }
+      end
+
+      private
+
+      def query_hash
+        return { filter: filter.to_h }.merge!(options) if query.blank?
+
+        { query: query.to_h, filter: filter.to_h }.merge!(options)
+      end
+    end
+  end
+end

data/lib/elasticband/query/function_score.rb

@@ -0,0 +1,44 @@
+module Elasticband
+  class Query
+    class FunctionScore < Query
+      attr_accessor :query_or_filter, :function, :options
+
+      def initialize(query_or_filter, function, options = {})
+        self.query_or_filter = query_or_filter
+        self.function = function
+        self.options = options
+      end
+
+      def to_h
+        { function_score: function_score_hash }
+      end
+
+      private
+
+      def function_score_hash
+        query_or_filter_hash.merge!(function_hash).merge!(options)
+      end
+
+      def query_or_filter_hash
+        if query_or_filter.is_a?(Query)
+          { query: query_or_filter.to_h }
+        else
+          { filter: query_or_filter.to_h }
+        end
+      end
+
+      def function_hash
+        if function.is_a?(Enumerable)
+          { functions: function.map(&:to_h) }
+        else
+          function_hash = function.to_h
+          if function_hash.key?(:filter)
+            { functions: [function_hash] }
+          else
+            function_hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticband/query/match.rb

@@ -0,0 +1,25 @@
+module Elasticband
+  class Query
+    class Match < Query
+      attr_accessor :query, :field, :options
+
+      def initialize(query, field = nil, options = {})
+        self.query = query
+        self.field = (field || :_all).to_sym
+        self.options = options
+      end
+
+      def to_h
+        { match: { field => query_hash } }
+      end
+
+      private
+
+      def query_hash
+        return query if options.blank?
+
+        { query: query }.merge!(options)
+      end
+    end
+  end
+end

data/lib/elasticband/query/multi_match.rb

@@ -0,0 +1,23 @@
+module Elasticband
+  class Query
+    class MultiMatch < Query
+      attr_accessor :query, :fields, :options
+
+      def initialize(query, fields = [:_all], options = {})
+        self.query = query
+        self.fields = Array.wrap(fields).map(&:to_sym)
+        self.options = options
+      end
+
+      def to_h
+        { multi_match: query_hash }
+      end
+
+      private
+
+      def query_hash
+        { query: query }.merge!(options).merge!(fields: fields)
+      end
+    end
+  end
+end

data/lib/elasticband/query/score_function/boost_factor.rb

@@ -0,0 +1,17 @@
+module Elasticband
+  class Query
+    class ScoreFunction
+      class BoostFactor < ScoreFunction
+        attr_accessor :boost
+
+        def initialize(boost)
+          self.boost = boost
+        end
+
+        def to_h
+          { boost_factor: boost }
+        end
+      end
+    end
+  end
+end

data/lib/elasticband/query/score_function/field_value_factor.rb

@@ -0,0 +1,24 @@
+module Elasticband
+  class Query
+    class ScoreFunction
+      class FieldValueFactor < ScoreFunction
+        attr_accessor :field, :options
+
+        def initialize(field, options = {})
+          self.field = field.to_sym
+          self.options = options
+        end
+
+        def to_h
+          { field_value_factor: function_hash }
+        end
+
+        private
+
+        def function_hash
+          { field: field }.merge!(options)
+        end
+      end
+    end
+  end
+end

data/lib/elasticband/query/score_function/filtered.rb

@@ -0,0 +1,19 @@
+module Elasticband
+  class Query
+    class ScoreFunction
+      class Filtered < ScoreFunction
+        attr_accessor :filter, :score_function, :options
+
+        def initialize(filter, score_function, options = {})
+          self.filter = filter
+          self.score_function = score_function
+          self.options = options
+        end
+
+        def to_h
+          { filter: filter.to_h }.merge!(score_function.to_h).merge(options)
+        end
+      end
+    end
+  end
+end

data/lib/elasticband/query/score_function/script_score.rb

@@ -0,0 +1,24 @@
+module Elasticband
+  class Query
+    class ScoreFunction
+      class ScriptScore < ScoreFunction
+        attr_accessor :script, :options
+
+        def initialize(script, options = {})
+          self.script = script
+          self.options = options
+        end
+
+        def to_h
+          { script_score: script_score_hash }
+        end
+
+        private
+
+        def script_score_hash
+          { script: script }.merge!(options)
+        end
+      end
+    end
+  end
+end

data/lib/elasticband/query/score_function.rb

@@ -0,0 +1,14 @@
+require 'elasticband/query/score_function/boost_factor'
+require 'elasticband/query/score_function/field_value_factor'
+require 'elasticband/query/score_function/filtered'
+require 'elasticband/query/score_function/script_score'
+
+module Elasticband
+  class Query
+    class ScoreFunction
+      def to_h
+        {}
+      end
+    end
+  end
+end