es_tractor 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c47c2590ee65edec76531a1d260adc2bcc9c670
-  data.tar.gz: a1cfa057e7d5b26586fb45c851e75b8fc851bc5b
+  metadata.gz: c95803c8427c65509539485cdae392f49ff00373
+  data.tar.gz: 7fbf6a5eab0236b6c80bfda83fdfd6bd933a0417
 SHA512:
-  metadata.gz: 5423eb837d7ec78e971a183a5b4d1be7afe9a7d2db7193035fe990daa818110dc08027e62fb47c321f1df52dd686509672e6dc0e00051d4ffea64b5ac7a6514f
-  data.tar.gz: 8c73c999dbec4f9726a03f3596bafeac7931edf6cd5f607dbaa52dd43c164d7e2105eee49e2241f36e8cfb17ca3bcffedc164e69152ba03eeefc560f9039169c
+  metadata.gz: 4693b910db8165c76056665d562332a14217f4d7a5fa0538c93df9d80cda4c4b9cbbc0ec104be2b7dea32e0e1ddd5cd32282369f21390e4de7ef89f971da6a1b
+  data.tar.gz: 296367c0e4c487087de040ca2def83761098b14af7a3b46dbf68ab959c76a6bdc7f35b77c7b1405c326a75acba5675ef7ada3d5883ae6cbbdc7dd91c8ccf216a

data/.rubocop.yml

@@ -1,8 +1,5 @@
-Layout/EmptyLineAfterMagicComment:
-  Enabled: false
-
 AllCops:
-  TargetRubyVersion: '2.4.1'
+  TargetRubyVersion: 2.4
 Metrics/AbcSize:
   Max: 20
 Metrics/BlockLength:

data/History.rdoc

@@ -1,3 +1,11 @@
+=== 0.0.5 / 2017-10-12
+
+* Add fields and sort
+
+=== 0.0.4 / 2017-09-09
+
+* More doc
+
 === 0.0.3 / 2017-09-09
 
 * A few enhancements

data/README.rdoc

@@ -7,27 +7,50 @@ 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.
+Minimal, simple, DRY DSL for searching Elasticsearch.
+
+Takes one shallow hash argument and translates it to an elaborate one passed
+on to elasticsearch-api. The price: narrower options. The gain: succinctness.
+For example, a root <tt>:range</tt> is always a boolean filter and always 
+includes the edges:
+
+  tractor = Client.new
+  opts = { range: { timestamp: ['now-5m', 'now'] } }
+
+  tractor.search(opts) # => sends the following to Ealsticsearch:
+  {
+    "query": {
+      "bool": {
+        "filter": [
+          {
+            "range": {
+              "timestamp": {
+                "gte":"now-5m",
+                "lte":"now"
+              }
+            }
+          }
+        ],
+        "must": [],
+      }
+    }
+  }
+
 
 == FEATURES/PROBLEMS:
 
-* Subset of Search APIs: count, search, aggregations.
+* Subset of Search APIs: count, fields, search, sort, aggregations.
 * Supports most metrics aggregations without optional parameters.
-* Minimal DRY query builder maps root elements of a Hash argument into boolean
+* Query builder translates a simplified Hash argument into boolean
   filters and aggregations.
 
 * TODO:
-  * Aggregations: 
+  * Aggregations:
     * Bucket
     * Nesting
     * Optional parameters
   * Add Search APIs:
-    * Fields
-    * Sort
     * Scroll
-  * Report formats: CSV, JSON.
   * Extraction: Aggregation to flat records (separate project?).
 
 == SYNOPSIS:
@@ -42,7 +65,7 @@ without server scripting.
     # => (Integer) number of documents where my_field == 'my precise term'
 
   tractor = Client.new true
-  tractor.search(size: 1, term: { my_field: 'my precise term' }) # => 
+  tractor.search(size: 1, term: { my_field: 'my precise term' }) # =>
   {
     "took"=>29,
     "timed_out"=>false,
@@ -66,6 +89,8 @@ without server scripting.
 
 == REQUIREMENTS:
 
+* Ruby 2.0+
+
 Some environment variables are expected:
 * ES_TRACTOR_ELASTICSEARCH_HOST
 * ES_TRACTOR_ELASTICSEARCH_INDEX
@@ -75,7 +100,7 @@ Some environment variables are expected:
   $ gem install es_tractor
 
 Or in your Gemfile:
-  gem 'es_tractor', '~> 0.0.3'
+  gem 'es_tractor'
 
 == DEVELOPERS:
 
@@ -90,7 +115,7 @@ generate the RDoc.
 
 (The MIT License)
 
-Copyright (c) 2017 FIX
+Copyright (c) 2017 Oz Shelach
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -7,7 +7,7 @@ require 'hoe'
 Hoe.plugin :yard
 
 Hoe.spec 'es_tractor' do
-  developer('utilum', 'oz@utilum.com')
+  developer('Oz Shelach', 'oz@utilum.com')
 
   license 'MIT'
 
@@ -29,9 +29,9 @@ namespace :es_tractor do
   namespace :demo do
     desc 'Count all docuements since forever'
     task :count_all do
-      tractor = Client.new
+      tractor = Client.new true
       r = tractor.count
-      puts "Found #{r} documents"
+      puts "Found #{r['count']} documents"
     end
   end
 end

data/bin/console

@@ -9,7 +9,4 @@ include EsTractor
 begin
   require 'pry'
   Pry.start
-rescue LoadError
-  require 'irb'
-  IRB.start
 end

data/lib/es_tractor/client.rb

@@ -76,7 +76,7 @@ module EsTractor
     # aggregations keys.
     #
     # Supported aggregations (avg, cardinality, extended_stats, geo_bounds,
-    # geo_centroid, max min, percentiles, stats, sum, value_count) take 
+    # geo_centroid, max min, percentiles, stats, sum, value_count) take
     # a field name and are automatically named.
     # @example
     #   opts = {
@@ -154,19 +154,17 @@ module EsTractor
     end
 
     def metrics_aggs
-      %i[avg cardinality extended_stats geo_bounds geo_centroid max min
-        percentiles stats sum value_count]
+      %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
+        name = [aggregation, opts[aggregation]].join('-').to_sym
+        aggregations[name] = {
+          aggregation => { field: opts[aggregation] }
+        }
       end
       aggregations
     end
@@ -184,6 +182,8 @@ module EsTractor
 
     def body(opts = {})
       body = { query: query(opts) }
+      body[:fields] = opts[:fields] if opts[:fields]
+      body[:sort] = opts[:sort] if opts[:sort]
       body[:aggs] = aggs(opts) if (supported_aggs & opts.keys).any?
       body
     end
@@ -191,7 +191,7 @@ module EsTractor
     def query(opts = {})
       bool = { filter: [], must: [] }
 
-      (%i[exists match query_string range term] & opts.keys)
+      (%i(exists match query_string range term) & opts.keys)
         .each do |qualifier|
         case qualifier
         when :exists

data/lib/es_tractor.rb

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

data/test/test_client.rb

@@ -7,7 +7,7 @@ module EsTractor
       @tractor = Client.new
     end
 
-    %w[count search].each do |action|
+    %w(count search).each do |action|
       exp = action == 'search' ? { from: 0, size: 0 } : {}
 
       define_method "test_#{action}_with_term_hash" do
@@ -94,14 +94,14 @@ module EsTractor
       end
 
       define_method "test_#{action}_with_exists_fieldname_array" do
-        opts = { exists: %w[my_field my_other_field] }
+        opts = { exists: %w(my_field my_other_field) }
         exp[:body] = { query: {
           bool: {
             must: [],
             filter: [
               {
                 exists: {
-                  field: %w[my_field my_other_field],
+                  field: %w(my_field my_other_field),
                 },
               },
             ],
@@ -129,8 +129,10 @@ module EsTractor
 
       next unless action == 'search'
 
-      %i[avg cardinality extended_stats geo_bounds geo_centroid max min 
-         percentiles stats sum value_count].each do |aggregation|
+      %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',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: es_tractor
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
-- utilum
+- Oz Shelach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-09 00:00:00.000000000 Z
+date: 2017-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -112,10 +112,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.16'
-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.
+description: "Minimal, simple, DRY DSL for searching Elasticsearch.\n\nTakes one shallow
+  hash argument and translates it to an elaborate one passed\non to elasticsearch-api.
+  The price: narrower options. The gain: succinctness.\nFor example, a root <tt>:range</tt>
+  is always a boolean filter and always \nincludes the edges:\n\n  tractor = Client.new\n
+  \ opts = { range: { timestamp: ['now-5m', 'now'] } }\n\n  tractor.search(opts) #
+  => sends the following to Ealsticsearch:\n  {\n    \"query\": {\n      \"bool\":
+  {\n        \"filter\": [\n          {\n            \"range\": {\n              \"timestamp\":
+  {\n                \"gte\":\"now-5m\",\n                \"lte\":\"now\"\n              }\n
+  \           }\n          }\n        ],\n        \"must\": [],\n      }\n    }\n
+  \ }"
 email:
 - oz@utilum.com
 executables:
@@ -164,5 +170,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: es_tractor provides a reduced, simplified and more DRY search API to Elasticsearch
+summary: Minimal, simple, DRY DSL for searching Elasticsearch
 test_files: []