elasticsearch-query-builder 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8c6cdabbdf9ce5180f8b57853ee52debea67d35c60e69d29e0152da6b051394
-  data.tar.gz: 0ca050497247bb073fe8ef40534b8df3bb35bd49041fb3e537665d02efdddf0f
+  metadata.gz: 02eaa67325bd4f1ae203bc2fbc5761fe2debf49b1a68684437a3e5a42f2b267d
+  data.tar.gz: 1ea45b1264b8279cf07cc0d82154e3b0588a461b87fa50e25e2d2d2d1a0736a6
 SHA512:
-  metadata.gz: 67a8891288c94e10bad8d29f0d992b4e2fa1d379d58e48babce035840706db87fa2d0296116e734697b7e285cccf74061dd78942d4f0e29292e6193ecdd97a01
-  data.tar.gz: 6a8ffd829c2430059344c255a7faf7a702e86d3877219864d4af4a7ed5fb81c68eb115e0d77657787b121b00315c5e7382880c100d846ff8fdd8bb20ff92c2a1
+  metadata.gz: 3d8ebd9affc58191305a3156596770a6324f95d2220b8cbbadaecc92ab5a06dbeca2529d7a336020cc2700ce88ad887a25ca104d089768180a489b2d4594e1f9
+  data.tar.gz: '02087d0d55fffbd233e60fe10795a8764bb66b1200c346bea56659eadf065e29e5d83c17b19b3282820107d13d09b5d28ff1e4178f9d1a7150dd7feb131ca0e3'

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ 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 ale@goprebo.com. All
+reported by contacting the project team at support@goprebo.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.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    elasticsearch-query-builder (0.1.5)
+    elasticsearch-query-builder (0.1.7)
 
 GEM
   remote: https://rubygems.org/

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 TODO: Write your name
+Copyright (c) 2019 Prebo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,8 +1,6 @@
-# Elasticsearch::QueryBuilder
+# Ruby Elasticsearch::QueryBuilder
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/elasticsearch/query_builder`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby gem for building complex ElasticSearch queries using clauses as methods. Supports query and function_score builders, as well as clients to fetch results.
 
 ## Installation
 
@@ -22,17 +20,262 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Instantiate the class
 
-## Development
+```ruby
+elastic_query = ElasticSearch::QueryBuilder.new(opts: {}, client: nil, function_score: false)
+```
+
+### Initialize parameters
+
+| Parameter      | Type    | Default | Description                                                                                                                                              |
+|----------------|---------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
+| opts           | Hash    | {}      | Optional. Initial query. Each method will add a clause to the @opts object.                                                                              |
+| client         | Object  | nil     | Optional. Client to fetch results from ElasticSearch. elasticsearch-model clients is an useful gem for this.                                             |
+| function_score | Boolean | false   | Optional. Whether to include clauses inside a function_score path and therefore be able to use .functions() methods to calculate custom document scores. |
+
+### Behaviour
+
+#### Methods definition
+
+Available methods and paths are:
+
+- must: [ query bool must ],
+- must_not: [ query bool must_not ],
+- should: [ query bool should ],
+- functions: [ functions ],
+- ids: [ query terms _id ],
+- size: [ size ],
+- fields: [ _source ],
+- range: [ bool must range ],
+- sort: [ sort ],
+- aggs: [ aggs ]
+
+Once the class is loaded, each method is defined and path **query function_score** is appended if class was initialized with **function_score: true** and original path starts with **query**.
+
+#### init_path
+
+Each path is initialized if not added previously to the query. If already added, it's appended to existing path preserving all previous clauses.
+
+#### exclude_opposite
+
+**must** and **must_not** are exclusive paths. The QueryBuilder do its best to recognize if an opposite clauses was previously added and remove it preserving only the last exclusive clause.
+
+#### add_clause
+
+Once the path is built and the opposite is excluded, the clause is merged with all the other clauses.
+
+### Methods
+
+#### .must([clauses])
+
+Receives an array of clauses and insert them in **query: { bool: { must: [] } }** path. If clause was previously added with .must_not() it is replaced.
+
+**Example**
+```ruby
+elastic_query.must([ { range: { sign_in_count: { gte: 3 } } } ])
+
+# elastic_query.send(:opts)
+{
+    query: {
+        bool: {
+            must: [
+                range: {
+                    sign_in_count: { gte: 3 }
+                }
+            ]
+        }
+    }
+}
+```
+
+#### .must_not([clauses])
+
+Receives an array of clauses and insert them in **query: { bool: { must_not: [] } }** path. If clause was previously added with .must() it is replaced.
+
+**Example**
+```ruby
+elastic_query.must_not([ { range: { sign_in_count: { gte: 3 } } } ])
+
+# elastic_query.send(:opts)
+{
+    query: {
+        bool: {
+            must_not: [
+                range: {
+                    sign_in_count: { gte: 3 }
+                }
+            ]
+        }
+    }
+}
+```
+
+#### .should([clauses])
+
+Receives an array of clauses and insert them in **query: { bool: { should: [] } }** path.
+
+**Example**
+```ruby
+elastic_query.should([ { range: { sign_in_count: { gte: 3 } } } ])
+
+# elastic_query.send(:opts)
+{
+    query: {
+        bool: {
+            should: [
+                range: {
+                    sign_in_count: { gte: 3 }
+                }
+            ]
+        }
+    }
+}
+```
+
+#### .functions([functions])
+
+Receives an array of functions to calculate document score. .functions() is overridden if .sort() method is called. Functions are inserted in **query: { function_score: { functions: [] } }** path.
+
+**Example**
+```ruby
+elastic_query.functions([ { script_score: { script: "1 - ( 1.0 / ( doc['popularity'].value == 0 ? 1 : doc['popularity'].value ))" }, weight: 1 } ])
+
+# elastic_query.send(:opts)
+{
+    query: {
+        function_score: {
+            functions: [
+                { script_score: { script: "1 - ( 1.0 / ( doc['popularity'].value == 0 ? 1 : doc['popularity'].value ))" }, weight: 1 }
+            ]
+        }
+    }
+}
+```
+
+#### .ids([array of ids])
+
+Receives an array of ids to retrieve. Ids are inserted in **query: { terms: { _id: [] } }** path.
 
-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.
+**Example**
+```ruby
+elastic_query.ids([1, 4, 6])
+
+# elastic_query.send(:opts)
+{
+    query: {
+        terms: {
+            _id: [
+                1,
+                4
+                6
+            ]
+        }
+    }
+}
+```
 
-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).
+#### .size(Integer)
+
+Receives an integer representing the number of documents to retrieve. Size is a root attribute in **size: size** path. Each time .size() method is called, size attribute is overridden.
+
+.size(0) returns all metadata but documents.
+
+**Example**
+```ruby
+elastic_query.size(200)
+
+# elastic_query.send(:opts)
+{
+    query: {
+    },
+    size: 200
+}
+```
+
+#### .fields([fields])
+
+Receives an array of fields to retrieve for each document. Each field is appended to **_source** path.
+
+**Example**
+```ruby
+elastic_query.fields([:name, :category, :created_at])
+
+# elastic_query.send(:opts)
+{
+    query: {
+    },
+    _source: [:name, :category, :created_at]
+}
+```
+
+#### .range([body])
+
+Subtype of .must() method. Receives an array of clauses representing ranges of fields. Each clause is appended to **query bool must range** path.
+
+**Example**
+```ruby
+elastic_query.range([{ sign_in_count: { gte: 3 } }])
+
+# elastic_query.send(:opts)
+{
+    query: {
+        bool: {
+            must: [
+                range: [
+                    {
+                        sign_in_count: { gte: 3 }
+                    }
+                ]
+            ]
+        }
+    }
+}
+```
+
+#### .sort(field)
+
+Receives a field to sort query results by. Each time .sort() method is called, sort attribute is overridden. It also disables .functions() score.
+
+**Example**
+```ruby
+elastic_query.sort([popularity: { order: :desc }])
+
+# elastic_query.send(:opts)
+{
+    query: {
+    },
+    sort: [
+        { popularity: { order: :desc } }
+    ]
+}
+```
+
+#### .aggs([aggs fields])
+
+Receives an array of fields to aggregate results count by. If body is not needed, .size(0) will still return aggregated count.
+
+**Example**
+```ruby
+elastic_query.sort([aggs: { ages: { terms: { field: 'median_age' } } }])
+
+# elastic_query.send(:opts)
+{
+    query: {
+    },
+    aggs: [
+        { ages: { terms: { field: 'median_age' } } }
+    ]
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on BitBucket at https://bitbucket.org/kickser/elasticsearch-query-builder. 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.
+Bug reports and pull requests are welcome on Gituhub at https://github.com/goprebo/elasticsearch-query-builder. 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
 
@@ -40,4 +283,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Elasticsearch::QueryBuilder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/elasticsearch-query_builder/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Elasticsearch::QueryBuilder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/goprebo/elasticsearch-query-builder/blob/master/CODE_OF_CONDUCT.md).
+
+## Contact
+
+You may contact Prebo at support@goprebo.com or in https://www.goprebo.com/

data/elasticsearch-query-builder.gemspec

@@ -7,14 +7,14 @@ require 'elastic_search/query_builder/version'
 Gem::Specification.new do |spec|
   spec.name          = 'elasticsearch-query-builder'
   spec.version       = ElasticSearch::QueryBuilder::VERSION
-  spec.authors       = ['Kickser']
-  spec.email         = ['support@goprebo.com']
-  spec.summary       = 'ElasticSearch query builder with clauses as methods'
+  spec.authors       = ['Kickser', 'Federico Farina', 'Alejo Zárate', 'Nicolás Vázquez']
+  spec.email         = ['support@goprebo.com', 'federico@goprebo.com', 'ale@goprebo.com', 'nico@goprebo.com']
+  spec.summary       = 'Ruby gem to build complex ElasticSearch queries with clauses as methods'
   spec.license       = 'MIT'
-  spec.homepage      = 'https://bitbucket.org/kickser/elasticsearch-query_builder'
-  spec.metadata['homepage_uri'] = 'https://bitbucket.org/kickser/elasticsearch-query_builder'
-  spec.metadata['source_code_uri'] = 'https://bitbucket.org/kickser/elasticsearch-query-builder'
-  spec.metadata['changelog_uri'] = 'https://bitbucket.org/kickser/elasticsearch-query-builder'
+  spec.homepage      = 'https://github.com/goprebo/elasticsearch-query-builder'
+  spec.metadata['homepage_uri'] = 'https://github.com/goprebo/elasticsearch-query-builder'
+  spec.metadata['source_code_uri'] = 'https://github.com/goprebo/elasticsearch-query-builder'
+  spec.metadata['changelog_uri'] = 'https://github.com/goprebo/elasticsearch-query-builder'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/elastic_search/query_builder.rb

@@ -14,7 +14,7 @@ module ElasticSearch
       ids: %i[query terms _id],
       size: [:size],
       fields: %i[_source],
-      range: %i[bool must range],
+      range: %i[query bool must range],
       sort: %i[sort],
       aggs: [:aggs]
     }.freeze

data/lib/elastic_search/query_builder/version.rb

@@ -2,6 +2,6 @@
 
 module ElasticSearch
   class QueryBuilder
-    VERSION = '0.1.6'
+    VERSION = '0.1.7'
   end
 end

metadata

@@ -1,14 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-query-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Kickser
+- Federico Farina
+- Alejo Zárate
+- Nicolás Vázquez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2019-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,6 +58,9 @@ dependencies:
 description: 
 email:
 - support@goprebo.com
+- federico@goprebo.com
+- ale@goprebo.com
+- nico@goprebo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -75,13 +81,13 @@ files:
 - lib/elastic_search/query_builder.rb
 - lib/elastic_search/query_builder/version.rb
 - lib/elasticsearch-query-builder.rb
-homepage: https://bitbucket.org/kickser/elasticsearch-query_builder
+homepage: https://github.com/goprebo/elasticsearch-query-builder
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://bitbucket.org/kickser/elasticsearch-query_builder
-  source_code_uri: https://bitbucket.org/kickser/elasticsearch-query-builder
-  changelog_uri: https://bitbucket.org/kickser/elasticsearch-query-builder
+  homepage_uri: https://github.com/goprebo/elasticsearch-query-builder
+  source_code_uri: https://github.com/goprebo/elasticsearch-query-builder
+  changelog_uri: https://github.com/goprebo/elasticsearch-query-builder
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -101,5 +107,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: ElasticSearch query builder with clauses as methods
+summary: Ruby gem to build complex ElasticSearch queries with clauses as methods
 test_files: []