es_tractor 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c7ccbb02ef8a6f0bb4b970cc28f963c55952a2e
-  data.tar.gz: ce0bd10580ac1d4adc9d4ff0c48acf21e5bfaa0c
+  metadata.gz: b0c7612550a240d22377140293d1360e419f7223
+  data.tar.gz: 2037664523b539a9f40c20f9a7672c7736293fe3
 SHA512:
-  metadata.gz: 198ab52863d622b2fcbb9e8a9d752a72e8abe00f6846aebebd56680e7bebb707dcedc7b49629205cae656fdd8951279b115afe4a6ccdadc25b4b2e897a36b25b
-  data.tar.gz: b8e4d5d4925becc313fa08cf8eb3ebb3f42710b168ba47845646739998a6b3ac854bc2dc7f8419f99a292909e5c2a504e6a3567b2c316436dbfa4ecf51a2b7d9
+  metadata.gz: eb989abd3b4a9340740f2e5c6da3a9a17779296b304bd95a823b4a44b219b5ca2c7a422e898175d99a51a338ff56ce1caee427e67bbc62b3b36c9cb80e97730c
+  data.tar.gz: ee3e75992f0fd8503b96c08f0cfa0ab2e1879f8c5e729ca68948c9e17891634e4598b78089bcc63378bf4d487634422347d920bf70d3a8b097a1d5505e723f33

data/History.rdoc

@@ -0,0 +1,21 @@
+=== 0.0.3 / 2017-09-09
+
+* A few enhancements
+
+  * Add most metrics aggregations
+  * Specify min Ruby version
+  * Documentation cleanup
+  * History catchup
+
+=== 0.0.2 / 2017-09-04
+
+* 1 mintor enhancement
+
+  * Version bump
+
+=== 0.0.1 / 2017-08-31
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -1,8 +1,8 @@
 .autotest
 .rubocop.yml
-History.txt
+History.rdoc
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 bin/console
 lib/es_tractor.rb

data/README.rdoc

@@ -0,0 +1,104 @@
+= EsTractor: Simplified data extracton from Elasticsearch
+
+home :: https://github.com/utilum/es_tractor
+bugs :: https://github.com/utilum/es_tractor/issues
+rdoc :: http://www.rubydoc.info/gems/es_tractor
+
+== DESCRIPTION:
+
+es_tractor provides a reduced, simplified and more DRY search API to
+Elasticsearch. It aims to facilitate data extraction and preparation
+without server scripting.
+
+== FEATURES/PROBLEMS:
+
+* Subset of Search APIs: count, search.
+* Most metrics aggregations without optional parameters
+* Minimal DRY query builder maps root elements of a Hash argument into boolean
+  filters.
+
+* TODO:
+  * Aggregations: 
+    * Bucket
+    * Nesting
+    * Optional parameters
+  * Add Search APIs:
+    * Fields
+    * Sort
+    * Scroll
+  * Report formats: CSV, JSON.
+  * Extraction: Aggregation to flat records (separate project?).
+
+== SYNOPSIS:
+
+  include EsTractor
+  tractor = Client.new
+
+  tractor.count
+    # => (Integer) number of documents on the server
+
+  tractor.count(term: { my_field: 'my precise term' })
+    # => (Integer) number of documents where my_field == 'my precise term'
+
+  tractor.search(size: 1, term: { my_field: 'my precise term' })
+    # => 
+    # {
+    #   "took"=>29,
+    #   "timed_out"=>false,
+    #   "_shards"=>{"total"=>542, "successful"=>542, "failed"=>0},
+    #   "hits"=> {
+    #     "total"=>279271,
+    #     "max_score"=>0.0,
+    #     "hits"=> [
+    #       {
+    #         "_index"=>"my_index",
+    #         "_id"=>"bc596ff2-955b-11e7-a7d2-001ed3f963a9",
+    #         "_score"=>1.6272357,
+    #         "_source"=> {
+    #           "my_field"=>"my precise term",
+    #           "timestamp"=>"2017-09-09 12:38:09.263",
+    #         },
+    #       },
+    #     ],
+    #   },
+    # }
+
+== REQUIREMENTS:
+
+Some environment variables are expected:
+* ES_TRACTOR_ELASTICSEARCH_HOST
+* ES_TRACTOR_ELASTICSEARCH_INDEX
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests, and
+generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2017 FIX
+
+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/Rakefile

@@ -7,10 +7,11 @@ require 'hoe'
 Hoe.plugin :yard
 
 Hoe.spec 'es_tractor' do
-  developer('utilum', 'oz@utilum.com')
+  developer('oz', 'oz@utilum.com')
 
   license 'MIT'
 
+  require_ruby_version '~> 2.0'
   extra_deps << ['elasticsearch', '~> 5.0', '>= 5.0.4']
 
   extra_dev_deps << ['hoe-yard', '~> 0.1', '>=0.1.3']

data/lib/es_tractor/client.rb

@@ -89,6 +89,28 @@ module EsTractor
 
     private
 
+    def supported_aggs
+      metrics_aggs
+    end
+
+    def metrics_aggs
+      %i[avg cardinality extended_stats geo_bounds geo_centroid max min
+        percentiles stats sum value_count]
+    end
+
+    def aggs(opts)
+      aggregations = {}
+      (supported_aggs & opts.keys).each do |aggregation|
+        if metrics_aggs.include?(aggregation)
+          name = [aggregation, opts[aggregation]].join('-').to_sym
+          aggregations[name] = {
+            aggregation => { field: opts[aggregation] }
+          }
+        end
+      end
+      aggregations
+    end
+
     def array_or_hash(name, filter)
       case filter
       when Array
@@ -101,7 +123,9 @@ module EsTractor
     end
 
     def body(opts = {})
-      { query: query(opts) }
+      body = { query: query(opts) }
+      body[:aggs] = aggs(opts) if (supported_aggs & opts.keys).any?
+      body
     end
 
     def query(opts = {})

data/lib/es_tractor.rb

@@ -9,5 +9,5 @@ require 'client'
 # EsTractor provides tools to query Elasticsearch
 
 module EsTractor
-  VERSION = '0.0.2'
+  VERSION = '0.0.3' # :nodoc:
 end

data/test/test_client.rb

@@ -126,6 +126,39 @@ module EsTractor
 
         @tractor.send(action, opts)
       end
+
+      next unless action == 'search'
+
+      %i[avg cardinality extended_stats geo_bounds geo_centroid max min 
+         percentiles stats sum value_count].each do |aggregation|
+        define_method "test_search_with_#{aggregation}_agg" do
+          opts = {
+            query_string: 'My query string',
+            aggregation => 'grade',
+          }
+          exp = {
+            from: 0,
+            size: 0,
+            body: {
+              query: {
+                bool: {
+                  must: [query_string: { query: 'My query string' }],
+                  filter: [],
+                },
+              },
+              aggs: {
+                "#{aggregation}-grade".to_sym => {
+                  aggregation => { field: 'grade' }
+                },
+              },
+            },
+          }
+
+          @tractor.client.expects(:search).with(exp)
+
+          @tractor.search opts
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: es_tractor
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
-- utilum
+- oz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2017-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -112,22 +112,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.16'
-description: Sub-set of Search APIs with DRY query building.
+description: |-
+  es_tractor provides a reduced, simplified and more DRY search API to
+  Elasticsearch. It aims to facilitate data extraction and preparation
+  without server scripting.
 email:
 - oz@utilum.com
 executables:
 - console
 extensions: []
 extra_rdoc_files:
-- History.txt
+- History.rdoc
 - Manifest.txt
-- README.txt
+- README.rdoc
 files:
 - ".autotest"
 - ".rubocop.yml"
-- History.txt
+- History.rdoc
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - bin/console
 - lib/es_tractor.rb
@@ -135,7 +138,7 @@ files:
 - test/helper.rb
 - test/test_client.rb
 - test/test_es_tractor.rb
-homepage: 
+homepage: https://github.com/utilum/es_tractor
 licenses:
 - MIT
 metadata: {}
@@ -148,9 +151,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -161,5 +164,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Sub-set of Search APIs with DRY query building.
+summary: es_tractor provides a reduced, simplified and more DRY search API to Elasticsearch
 test_files: []

data/History.txt

@@ -1,12 +0,0 @@
-=== 0.0.1 / 2017-08-31
-
-* 1 major enhancement
-
-  * Birthday!
-
-=== 0.0.2 / 2017-09-04
-
-* 1 major enhancement
-
-  * Search, count, filter
-

data/README.txt

@@ -1,76 +0,0 @@
-# @markup markdown
-# EsTractor: Simplified data extracton from Elasticsearch
-
-[[Home]](https://github.com/utilum/es_tractor)
-
-## DESCRIPTION:
-
-Sub-set of Search APIs with DRY query building.
-
-## FEATURES/PROBLEMS:
-
-- Subset of Search APIs: count, search.
-- Minimal DRY query builder maps root elements of a Hash argument into boolean
-  filters.
-
-- TODO:
-  - Add Search APIs:
-      - Fields
-      - Sort
-      - Scroll
-  - Aggregations
-  - Report formats: CSV, JSON.
-  - Extraction: Aggregation to flat records (separate project?).
-
-## SYNOPSIS:
-
-```
-include EsTractor
-tractor = Client.new
-
-tractor.count
-  # => (Integer) number of documents on the server
-
-tractor.count(term: { my_field: 'my precise term' })
-  # => (Integer) number of documents where my_field == 'my precise term'
-```
-
-## REQUIREMENTS:
-
-Some environment variables are expected:
-- L2B_ELASTICSEARCH_HOST
-- L2B_ELASTICSEARCH_INDEX
-
-## DEVELOPERS:
-
-After checking out the source, run:
-
-  $ rake newb
-
-This task will install any missing dependencies, run the tests/specs,
-and generate the RDoc.
-
-## LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2017 FIX
-
-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.