es_tractor 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0c7612550a240d22377140293d1360e419f7223
-  data.tar.gz: 2037664523b539a9f40c20f9a7672c7736293fe3
+  metadata.gz: 4c47c2590ee65edec76531a1d260adc2bcc9c670
+  data.tar.gz: a1cfa057e7d5b26586fb45c851e75b8fc851bc5b
 SHA512:
-  metadata.gz: eb989abd3b4a9340740f2e5c6da3a9a17779296b304bd95a823b4a44b219b5ca2c7a422e898175d99a51a338ff56ce1caee427e67bbc62b3b36c9cb80e97730c
-  data.tar.gz: ee3e75992f0fd8503b96c08f0cfa0ab2e1879f8c5e729ca68948c9e17891634e4598b78089bcc63378bf4d487634422347d920bf70d3a8b097a1d5505e723f33
+  metadata.gz: 5423eb837d7ec78e971a183a5b4d1be7afe9a7d2db7193035fe990daa818110dc08027e62fb47c321f1df52dd686509672e6dc0e00051d4ffea64b5ac7a6514f
+  data.tar.gz: 8c73c999dbec4f9726a03f3596bafeac7931edf6cd5f607dbaa52dd43c164d7e2105eee49e2241f36e8cfb17ca3bcffedc164e69152ba03eeefc560f9039169c

data/README.rdoc

@@ -1,6 +1,7 @@
 = EsTractor: Simplified data extracton from Elasticsearch
 
-home :: https://github.com/utilum/es_tractor
+home :: https://rubygems.org/gems/es_tractor
+dev  :: https://github.com/utilum/es_tractor/tree/dev
 bugs :: https://github.com/utilum/es_tractor/issues
 rdoc :: http://www.rubydoc.info/gems/es_tractor
 
@@ -12,10 +13,10 @@ without server scripting.
 
 == FEATURES/PROBLEMS:
 
-* Subset of Search APIs: count, search.
-* Most metrics aggregations without optional parameters
+* Subset of Search APIs: count, search, aggregations.
+* Supports most metrics aggregations without optional parameters.
 * Minimal DRY query builder maps root elements of a Hash argument into boolean
-  filters.
+  filters and aggregations.
 
 * TODO:
   * Aggregations: 
@@ -40,28 +41,28 @@ without server scripting.
   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",
-    #         },
-    #       },
-    #     ],
-    #   },
-    # }
+  tractor = Client.new true
+  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"=>0.0,
+          "_source"=> {
+            "my_field"=>"my precise term",
+            "timestamp"=>"2017-09-09 12:38:09.263",
+          },
+        },
+      ],
+    },
+  }
 
 == REQUIREMENTS:
 
@@ -69,6 +70,13 @@ Some environment variables are expected:
 * ES_TRACTOR_ELASTICSEARCH_HOST
 * ES_TRACTOR_ELASTICSEARCH_INDEX
 
+== INSTALL:
+
+  $ gem install es_tractor
+
+Or in your Gemfile:
+  gem 'es_tractor', '~> 0.0.3'
+
 == DEVELOPERS:
 
 After checking out the source, run:

data/Rakefile

@@ -7,7 +7,7 @@ require 'hoe'
 Hoe.plugin :yard
 
 Hoe.spec 'es_tractor' do
-  developer('oz', 'oz@utilum.com')
+  developer('utilum', 'oz@utilum.com')
 
   license 'MIT'
 

data/bin/console

@@ -4,6 +4,8 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'es_tractor'
 
+include EsTractor
+
 begin
   require 'pry'
   Pry.start

data/lib/es_tractor/client.rb

@@ -42,42 +42,102 @@ module EsTractor
     #
     # @example
     #   opts = {
-    #     match: { color: 'strawberry black' },
-    #     exists: ['flavor', 'spicy'],
+    #     match: { topping: 'fudge' },
+    #     exists: ['address', 'phone'],
     #     term: [
     #       { flavor: 'vanilla' },
-    #       { spicy: 3 },
+    #       { scoops: 3 },
     #     ],
     #   }
     #
     #   Client.new.count(opts) # => { 'count' => 7 }
     #
     #   # Tranforms opts into the following hash, passed to Elasticsearch:
-    #     {
-    #       body:  {
-    #         query: {
-    #           bool: {
-    #             must: {
-    #               match: { flavor: 'vanilla' },
-    #             },
-    #             filter: [
-    #               { term: { flavor: 'vanilla' } },
-    #               { term: { spicy: 3 } },
-    #             ],
-    #           },
-    #         },
-    #       },
+    #   {
+    #     "query": {
+    #       "bool": {
+    #         "filter": [
+    #           { "exists": { "field": ["address", "phone"] } },
+    #           { "term": { "flavor": "vanilla" } },
+    #           { "term":{ "scoops": 3 } }
+    #         ],
+    #         "must": [
+    #           { "match": { "topping": "fudge" } }
+    #         ]
+    #       }
     #     }
+    #   }
     def count(opts = {})
       args = { body: body(opts) }
       @client.count(args)
     end
 
-    # @return [Hash] with the actual result in the 'hits'['hits'] key.
+    # Search documents, filtered by options, aggregate on special
+    # aggregations keys.
+    #
+    # Supported aggregations (avg, cardinality, extended_stats, geo_bounds,
+    # geo_centroid, max min, percentiles, stats, sum, value_count) take 
+    # a field name and are automatically named.
+    # @example
+    #   opts = {
+    #     query_string: 'flavor:vanilla AND cone:true',
+    #     avg: "scoops",
+    #   }
+    #
+    #   Client.new.search(opts)
+    #
+    #   # Tranforms opts into the following hash, passed to Elasticsearch:
+    #   {
+    #     "query": {
+    #       "bool": {
+    #         "filter":[],
+    #         "must":[
+    #           {
+    #             "query_string": {
+    #               "query":"flavor:vanilla AND cone:true"
+    #             }
+    #           }
+    #         ]
+    #       }
+    #     },
+    #     "aggs": {
+    #       "avg-intelligence": {
+    #         "avg": {
+    #           "field":"scoops"
+    #         }
+    #       }
+    #     }
+    #   }
+    #
+    # @return [Hash] with the actual results in the <tt>'hits'['hits']</tt>
+    #   key.
+    #
     # @param (see #count)
     # @option (see #count)
     # @option opts [Integer] :from
     # @option opts [Integer] :size
+    # @option opts [String] :avg
+    #   Field name on which to apply the avg aggregation
+    # @option opts [String] :cardinality
+    #   Field name on which to apply the cardinality aggregation
+    # @option opts [String] :extended_stats
+    #   Field name on which to apply the extended_stats aggregation
+    # @option opts [String] :geo_bounds
+    #   Field name on which to apply the geo_bounds aggregation
+    # @option opts [String] :geo_centroid
+    #   Field name on which to apply the geo_centroid aggregation
+    # @option opts [String] :max
+    #   Field name on which to apply the max aggregation
+    # @option opts [String] :min
+    #   Field name on which to apply the min aggregation
+    # @option opts [String] :percentiles
+    #   Field name on which to apply the percentiles aggregation
+    # @option opts [String] :stats
+    #   Field name on which to apply the stats aggregation
+    # @option opts [String] :sum
+    #   Field name on which to apply the sum aggregation
+    # @option opts [String] :value_count
+    #   Field name on which to apply the value_count aggregation
     def search(opts)
       args = {
         from: opts[:from] ? opts[:from] : 0,

data/lib/es_tractor.rb

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

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: es_tractor
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
-- oz
+- utilum
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -138,7 +138,7 @@ files:
 - test/helper.rb
 - test/test_client.rb
 - test/test_es_tractor.rb
-homepage: https://github.com/utilum/es_tractor
+homepage: https://rubygems.org/gems/es_tractor
 licenses:
 - MIT
 metadata: {}