elasticated 1.0.0

data/spec/query_spec.rb

@@ -0,0 +1,265 @@
+require_relative 'spec_helper'
+
+module Elasticated
+  describe Query do
+
+    let(:q){ Query.new }
+
+    describe "the build method (over query conditions)" do
+
+      it "should build a 'match_all' query" do
+        expected_result = { query: { match_all: {} } }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a query with conditions" do
+        q.conditions do |c|
+          c.must{ custom my_condition: {} }
+        end
+        expected_result = { query: { my_condition: {} } }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a query with short-hand conditions" do
+        q.custom my_condition: {}
+        expected_result = { query: { my_condition: {} } }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a query with a filter" do
+        q.filter do |f|
+          f.must{ custom my_filter: {} }
+        end
+        expected_result = { query: { filtered: { filter: { my_filter: {} } } } }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a query with short-hand filters" do
+        q.filter_must{ custom my_filter: {} }
+        expected_result = { query: { filtered: { filter: { my_filter: {} } } } }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a filtered query" do
+        q.conditions{ must{ custom my_condition: {} } }.filter{ must{ custom my_filter: {} } }
+        expected_result = {
+          query: {
+            filtered: {
+              filter: {
+                my_filter: {}
+              },
+              query: {
+                my_condition: {}
+              }
+            }
+          }
+        }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a post-filtered query" do
+        q.post{ must{ custom my_filter: {} } }
+        expected_result = { query: { match_all: {} }, post_filter: { my_filter: {} } }
+        expect(q.build).to eq expected_result
+      end
+
+    end
+
+    describe "the build method (over other fields)" do
+
+      it "should build a 'match_all' query sorted by a single field" do
+        q.sort :field
+        expected_result = {
+          query: { match_all: {} },
+          sort: [ { field: { order: :asc } } ]
+        }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a 'match_all' query sorted by a single field desc" do
+        q.sort :field, :desc
+        expected_result = {
+          query: { match_all: {} },
+          sort: [ { field: { order: :desc } } ]
+        }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a 'match_all' query sorted by multiple fields" do
+        q.sort(:field).sort(:another_field)
+        expected_result = {
+          query: { match_all: {} },
+          sort: [ { field: { order: :asc } }, { another_field: { order: :asc } } ]
+        }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a 'match_all' query with max size" do
+        q.size 5
+        expected_result = {
+          query: { match_all: {} },
+          size: 5
+        }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a 'match_all' query with offset" do
+        q.from 5
+        expected_result = {
+          query: { match_all: {} },
+          from: 5
+        }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a 'match_all' query filtering a single field" do
+        q.source :field
+        expected_result = {
+          query: { match_all: {} },
+          _source: [:field]
+        }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a 'match_all' query filtering a multiple fields" do
+        q.source :field_one, :field_two
+        expected_result = {
+          query: { match_all: {} },
+          _source: [:field_one, :field_two]
+        }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build a 'match_all' query filtering a multiple fields (as an array)" do
+        q.source [:field_one, :field_two]
+        expected_result = {
+          query: { match_all: {} },
+          _source: [:field_one, :field_two]
+        }
+        expect(q.build).to eq expected_result
+      end
+
+      it "should build an aggregated search query" do
+        q.aggregations{ group :field, size: 5 }
+        expect(q.build).to eq query: { match_all: {} },
+        aggs: {
+          group_by_field: {
+            terms: { field: :field, size: 5 }
+          }
+        }
+      end
+
+      it "should build an aggregated query" do
+        q.size(10).sort(:field).source(:field).aggregations{ group :field, size: 5 }
+        expect(q.build_for_aggregations).to eq query: { match_all: {} },
+        size: 0,
+        aggs: {
+          group_by_field: {
+            terms: { field: :field, size: 5 }
+          }
+        }
+      end
+
+      it "should raise trying to build a non-aggregated query as an aggregated one" do
+        q.size(10).sort(:field).source(:field)
+        expect{ q.build_for_aggregations }.to raise_error
+      end
+
+      it "should build a 'top hits' query" do
+        q.size(10).sort(:field).source(:field)
+        expect(q.build_for_top_hits).to eq size: 10,
+        sort: [{ field: { order: :asc} }],
+        _source: [:field]
+      end
+
+    end
+
+    context "as an integration" do
+
+      it "should build a complex query" do
+        q.filter do
+          equal :last_name, 'Fernandez'
+          should do
+            equal :first_name, 'Pablo'
+            bool do
+              must do
+                equal :first_name, 'Tomas'
+                equal :second_name, 'Agustin'
+              end
+            end
+          end
+          minimum_should_match 1
+        end
+        q.conditions do
+          not_equal :city, 'CABA'
+        end
+        q.aggregations do
+          group :entry_type, size: 5 do
+            count :entry_name
+          end
+        end
+        q.size 20
+        q.from 10
+        q.fields :entry_id
+        q.post_filter do
+          with :note
+        end
+        expected_result = {
+          query: {
+            filtered: {
+              filter: {
+                bool: {
+                  must: [
+                    { terms: { last_name: ['Fernandez'] } }
+                  ],
+                  should: [
+                    { terms: { first_name: ['Pablo'] } },
+                    {
+                      bool: {
+                        must: [
+                          { terms: { first_name: ['Tomas'] } },
+                          { terms: { second_name: ['Agustin'] } }
+                        ]
+                      }
+                    }
+                  ],
+                  minimum_should_match: 1
+                }
+              },
+              query: {
+                bool: {
+                  must_not: [
+                    { terms: { city: ['CABA'] } }
+                  ]
+                }
+              }
+            }
+          },
+          size: 20,
+          from: 10,
+          _source: [:entry_id],
+          aggs: {
+            group_by_entry_type: {
+              terms: {
+                field: :entry_type, size: 5
+              },
+              aggs: {
+                count_by_entry_name: {
+                  terms: {
+                    field: :entry_name, size: 0
+                  }
+                }
+              }
+            }
+          },
+          post_filter: {
+            wildcard: { note: '*' }
+          }
+        }
+        expect(q.build).to eq expected_result
+      end
+
+    end
+
+  end
+end

data/spec/results_spec.rb

@@ -0,0 +1,69 @@
+require_relative 'spec_helper'
+
+module Elasticated
+  describe Results do
+
+    def open_response(name)
+      JSON.parse File.read "spec/#{name}.json"
+    end
+
+    it "should parse an 'search' response" do
+      response = open_response 'elasticsearch_response_1'
+      results = Results.from_elasticsearch_response response
+      expect(results.took).to eq 106
+      expect(results.timed_out).to eq false
+      expect(results.shards.total).to eq 3
+      expect(results.shards.successful).to eq 3
+      expect(results.shards.failed).to eq 0
+      expect(results.hits.total).to eq 1
+      expect(results.hits.max_score).to eq 15.003607
+      expect(results.documents.count).to eq 1
+      expect(results.documents.first).to be_a Document
+    end
+
+    it "allow to access documents as an array" do
+      response = open_response 'elasticsearch_response_1'
+      results = Results.from_elasticsearch_response response
+      expect(results).to be_an Array
+      expect(results.count).to eq 1
+    end
+
+    it "should parse an 'search_aggregated' response" do
+      response = open_response 'elasticsearch_response_2'
+      query = Query.build do
+        aggregations do
+          nested('ads'){ group 'ads.adgroups', size: 1, as: 'group_by_adgroup' }
+        end
+      end
+      results = Results.from_elasticsearch_response response, query
+      expect(results.took).to eq 140
+      expect(results.timed_out).to eq false
+      expect(results.shards.total).to eq 3
+      expect(results.shards.successful).to eq 3
+      expect(results.shards.failed).to eq 0
+      expect(results.hits.total).to eq 340
+      expect(results.hits.max_score).to eq 7.6152167
+      expect(results.documents.count).to eq 1
+      expect(results.documents.first).to be_a Document
+      expect(results.aggregations).not_to be_nil
+      expect(results.aggregations['ads']['count']).to eq 259
+      expect(results.aggregations['ads']['group_by_adgroup']['6023316427914']['count']).to eq 1
+    end
+
+    it "should not parse aggregations on an 'search_aggregated' response if no query is provided" do
+      response = open_response 'elasticsearch_response_2'
+      results = Results.from_elasticsearch_response response
+      expect(results.took).to eq 140
+      expect(results.timed_out).to eq false
+      expect(results.shards.total).to eq 3
+      expect(results.shards.successful).to eq 3
+      expect(results.shards.failed).to eq 0
+      expect(results.hits.total).to eq 340
+      expect(results.hits.max_score).to eq 7.6152167
+      expect(results.documents.count).to eq 1
+      expect(results.documents.first).to be_a Document
+      expect(results.aggregations).to be_nil
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require_relative '../lib/elasticated'

data/spec/term_field_delimiter_spec.rb

@@ -0,0 +1,39 @@
+require_relative 'spec_helper'
+
+module Elasticated
+  module Delimiters
+    describe TermFieldDelimiter do
+
+      let :delimiter do
+        TermFieldDelimiter.new field: :account_id, as: :account
+      end
+
+      it "should not delimit anything" do
+        params = delimiter.build_strategy_params
+        expect(params).to be_empty
+      end
+
+      it "should delimit by one term" do
+        delimiter.add_term :account_id, 'nombre1'
+        params = delimiter.build_strategy_params
+        expect(params).to eq account: ['nombre1']
+      end
+
+      it "should delimit by multiple terms" do
+        delimiter.add_term :account_id, 'nombre1'
+        delimiter.add_term :account_id, 'nombre2'
+        params = delimiter.build_strategy_params
+        expect(params).to eq account: ['nombre1', 'nombre2']
+      end
+
+      it "should ignore duplicated terms" do
+        delimiter.add_term :account_id, 'nombre2'
+        delimiter.add_term :account_id, 'nombre2'
+        delimiter.add_term :account_id, 'nombre1'
+        params = delimiter.build_strategy_params
+        expect(params).to eq account: ['nombre2', 'nombre1']
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: elasticated
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pablo Fernandez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hash_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: ''
+email:
+- psfutn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- elasticated.gemspec
+- lib/elasticated.rb
+- lib/elasticated/aggregation.rb
+- lib/elasticated/aggregations/cardinality_aggregation.rb
+- lib/elasticated/aggregations/count_aggregation.rb
+- lib/elasticated/aggregations/count_distinct_aggregation.rb
+- lib/elasticated/aggregations/count_filtered_aggregation.rb
+- lib/elasticated/aggregations/custom_aggregation.rb
+- lib/elasticated/aggregations/date_histogram_aggregation.rb
+- lib/elasticated/aggregations/filter_aggregation.rb
+- lib/elasticated/aggregations/filter_aggregation_evaluator.rb
+- lib/elasticated/aggregations/group_aggregation.rb
+- lib/elasticated/aggregations/histogram_aggregation.rb
+- lib/elasticated/aggregations/nested_aggregation.rb
+- lib/elasticated/aggregations/range_aggregation.rb
+- lib/elasticated/aggregations/range_aggregation_evaluator.rb
+- lib/elasticated/aggregations/ranges_builder.rb
+- lib/elasticated/aggregations/single_value_aggregation.rb
+- lib/elasticated/aggregations/subaggregated.rb
+- lib/elasticated/aggregations/sum_distinct_aggregation.rb
+- lib/elasticated/aggregations/terms_aggregation.rb
+- lib/elasticated/aggregations/top_hits_aggregation.rb
+- lib/elasticated/block_evaluation.rb
+- lib/elasticated/boolean_clause.rb
+- lib/elasticated/client.rb
+- lib/elasticated/clonable.rb
+- lib/elasticated/conditions/custom_condition.rb
+- lib/elasticated/conditions/exists_condition.rb
+- lib/elasticated/conditions/missing_condition.rb
+- lib/elasticated/conditions/nested_condition.rb
+- lib/elasticated/conditions/range_condition.rb
+- lib/elasticated/conditions/script_condition.rb
+- lib/elasticated/conditions/standard_condition.rb
+- lib/elasticated/conditions/terms_condition.rb
+- lib/elasticated/conditions/wildcard_condition.rb
+- lib/elasticated/conditions_builder.rb
+- lib/elasticated/configurable.rb
+- lib/elasticated/configuration.rb
+- lib/elasticated/default_logger.rb
+- lib/elasticated/delimiters/date_field_delimiter.rb
+- lib/elasticated/delimiters/standard_field_delimiter.rb
+- lib/elasticated/delimiters/term_field_delimiter.rb
+- lib/elasticated/document.rb
+- lib/elasticated/helpers.rb
+- lib/elasticated/index_selector.rb
+- lib/elasticated/inspectionable.rb
+- lib/elasticated/mapping.rb
+- lib/elasticated/mapping/builder.rb
+- lib/elasticated/mapping/fields_builder.rb
+- lib/elasticated/mapping/nested_builder.rb
+- lib/elasticated/mapping/object_builder.rb
+- lib/elasticated/mapping/partial.rb
+- lib/elasticated/mapping/type_builder.rb
+- lib/elasticated/partitioned_repository.rb
+- lib/elasticated/query.rb
+- lib/elasticated/query_aggregations.rb
+- lib/elasticated/query_conditions.rb
+- lib/elasticated/repositories/monthly_partitioned_repository.rb
+- lib/elasticated/repository.rb
+- lib/elasticated/results.rb
+- lib/version.rb
+- spec/aggregation_spec.rb
+- spec/date_field_delimiter_spec.rb
+- spec/document_spec.rb
+- spec/elasticsearch_hit_1.json
+- spec/elasticsearch_response_1.json
+- spec/elasticsearch_response_2.json
+- spec/elasticsearch_top_hits_response.json
+- spec/integration_spec.rb
+- spec/mapping_spec.rb
+- spec/monthly_partitioned_repository_spec.rb
+- spec/query_aggregations_spec.rb
+- spec/query_conditions_spec.rb
+- spec/query_spec.rb
+- spec/results_spec.rb
+- spec/spec_helper.rb
+- spec/term_field_delimiter_spec.rb
+homepage: http://github.com/pablo31/elasticated
+licenses:
+- ''
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Elasticsearch Wrapper, with Query & Mapping Builders
+test_files:
+- spec/aggregation_spec.rb
+- spec/date_field_delimiter_spec.rb
+- spec/document_spec.rb
+- spec/elasticsearch_hit_1.json
+- spec/elasticsearch_response_1.json
+- spec/elasticsearch_response_2.json
+- spec/elasticsearch_top_hits_response.json
+- spec/integration_spec.rb
+- spec/mapping_spec.rb
+- spec/monthly_partitioned_repository_spec.rb
+- spec/query_aggregations_spec.rb
+- spec/query_conditions_spec.rb
+- spec/query_spec.rb
+- spec/results_spec.rb
+- spec/spec_helper.rb
+- spec/term_field_delimiter_spec.rb