elastic_adapter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f388cfada6ca770fbeb5f7039efb9986a08c6bcd
-  data.tar.gz: 516fd85530fdf3b62561e829ff72728ef8c90f58
+  metadata.gz: 25e0579bbeba803053caee8b5986f7b02f7f719c
+  data.tar.gz: 1280437e020532bc8c67fc55555fad96ac9bd1e8
 SHA512:
-  metadata.gz: 42428a0a11237fad29bdb3f01f1ae007e23baec0da33d29ca3443a4bb8a76ea15eb61bbc42b16fbeb218d552a0463e6eea23cadd067aaa656e07cdf3aaf5f5f2
-  data.tar.gz: a71a53218c7ea5d93fe8150cb3667e9037f276bca3ac9c73bb232093e76d884b972803793d255d67e85ea1896227785ccf28c6bb5acc8baa2e1403ea3338c7f7
+  metadata.gz: 577612284345aea4de48577b3d01c462326605e0b16531947fea2366c0ec5e4e43eac8a1687ed6942db07d559a992e29b41195d89e20e24f39d4e03a0ff84a3a
+  data.tar.gz: ef247ad391ecc75e53f322f9a8fb659a26eb2de46f4cbd50354428a146a35028beccdf70687c043d1818cc1a578664b4bb45b7fdd99171634854ce59ef273840

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/kbredemeier/elastic_adatper.svg?branch=master)](https://travis-ci.org/kbredemeier/elastic_adatper) [![Code Climate](https://codeclimate.com/github/kbredemeier/elastic_adatper/badges/gpa.svg)](https://codeclimate.com/github/kbredemeier/elastic_adatper)
+[![Build Status](https://travis-ci.org/kbredemeier/elastic_adapter.svg?branch=master)](https://travis-ci.org/kbredemeier/elastic_adatper) [![Code Climate](https://codeclimate.com/github/kbredemeier/elastic_adatper/badges/gpa.svg)](https://codeclimate.com/github/kbredemeier/elastic_adatper)
 
 # ElasticAdapter
 

data/elastic_adapter.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["k.bredemeier@gmail.com"]
   spec.summary       = %q{Repository like access to elasticseach indices}
   spec.description   = %q{Repository like access to elasticseach indices}
-  spec.homepage      = "https://github.com/kbredemeier/elastic_adatper"
+  spec.homepage      = "https://github.com/kbredemeier/elastic_adapter"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/elastic_adapter/decoration/aggregation_response.rb

@@ -0,0 +1,34 @@
+module ElasticAdapter
+  module Decoration
+    # Used to decorate responses from the elasticsearch search api
+    #
+    # @attr_reader [Hash] aggregations
+    class AggregationResponse < Decorator
+      attr_reader :aggregations
+
+      # Reduces the interface
+      #
+      # @param [Hash] hash
+      # @return [Hash]
+      def alter_object(hash)
+        new_hash = {}
+        new_hash[:aggregations] = {}
+
+        hash[:aggregations].each do |key, value|
+          new_hash[:aggregations][key] = []
+
+          value[:buckets].each do |agg|
+            new_hash[:aggregations][key] << {
+              term: agg[:key],
+              count: agg[:doc_count]
+            }
+          end
+        end
+
+        @aggregations = new_hash[:aggregations]
+
+        new_hash
+      end
+    end
+  end
+end

data/lib/elastic_adapter/decoration/response_decorator_factory.rb

@@ -6,23 +6,21 @@ module ElasticAdapter
     # @see Response#decorate
     class ResponseDecoratorFactory
       class << self
-        # Takes a response and returns it with the right decorator
-        # applied
+        # Takes a response and multiple symbols and decorated response.
         #
         # @param [Hash] response a response returned by elasticsearch
+        # @param [Array<Symbol>] args the decorators the response should be decorated with.
+        #   Currently valid args are :count, :hit, :search, :validation, :suggestion
         # @return [Docorator] a decorated response
-        def decorate(response)
-          if response.key? :count
-            return CountResponse.new(response)
-          elsif response.key? :source
-            return HitDecorator.new(response)
-          elsif response.key? :hits
-            return SearchResponse.new(response)
-          elsif response.key? :valid
-            return ValidationResponse.new(response)
-          elsif suggestion?(response)
-            return SuggestionResponse.new(response)
-          end
+        def decorate(plain_response, *args)
+          response = Response.new(plain_response)
+
+          response = CountResponse.new(response) if args.include? :count
+          response = HitDecorator.new(response) if args.include? :hit
+          response = SearchResponse.new(response) if args.include? :search
+          response = ValidationResponse.new(response) if args.include? :validation
+          response = SuggestionResponse.new(response) if args.include? :suggestion
+          response = AggregationResponse.new(response) if args.include? :aggregation
 
           response
         end

data/lib/elastic_adapter/index.rb

@@ -85,7 +85,7 @@ module ElasticAdapter
     # @param [Hash] query a query to count the documents for a given query. Defaults to match all
     # @return [Decoration::CountResponse] the count
     def count(query = { query: { match_all: {} } })
-      handle_api_call do
+      handle_api_call :count do
         client.count index: name, body: query
       end
     end
@@ -125,7 +125,7 @@ module ElasticAdapter
     # @param [Integer] id
     # @return [ElasticAdapter::HitDecorator]
     def get(id)
-      handle_api_call do
+      handle_api_call :hit do
         client.get(
           index: name,
           type: document_type.name,
@@ -145,7 +145,7 @@ module ElasticAdapter
     # @param [Hash] query
     # @return [ElasticAdapter::SearchResponse]
     def search(query)
-      handle_api_call do
+      handle_api_call :search do
         client.search(
           index: name,
           body: query
@@ -164,7 +164,7 @@ module ElasticAdapter
     # @param [Hash] query
     # @return [ElasticAdapter::SuggestResponse]
     def suggest(query)
-      handle_api_call do
+      handle_api_call :suggestion do
         client.suggest(
           index: name,
           body: query
@@ -179,7 +179,7 @@ module ElasticAdapter
     # @param [Hash] query
     # @return [ElasticAdapter::ValidationResponse]
     def validate(query)
-      handle_api_call do
+      handle_api_call :validation do
         client.indices.validate_query(
           index: name,
           explain: true,
@@ -188,10 +188,23 @@ module ElasticAdapter
       end
     end
 
+    # Executes a search request and wraps the response in an AggregationResponse
+    #
+    # @param [Hash] query
+    # @return [ElasticAdapter::Decoration::AggregationResponse]
+    def aggregate(query)
+      handle_api_call :aggregation do
+        client.search(
+          index: name,
+          body: query
+        )
+      end
+    end
+
     private
 
-    def handle_api_call
-      Response.new(yield).decorate
+    def handle_api_call(*args)
+      Decoration::ResponseDecoratorFactory.decorate(yield, *args)
     rescue Elasticsearch::Transport::Transport::Error => e
       Response.new(
         exception: e

data/lib/elastic_adapter/response.rb

@@ -15,13 +15,6 @@ module ElasticAdapter
       key?(:exception)
     end
 
-    # Decorates the response with the right decorator
-    #
-    # @return [Decorator] returns the decorated response
-    def decorate
-      Decoration::ResponseDecoratorFactory.decorate(self)
-    end
-
     private
 
     # Sanitizes a nested hash. It removes leading underscores

data/lib/elastic_adapter/version.rb

@@ -1,3 +1,3 @@
 module ElasticAdapter
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/elastic_adapter.rb

@@ -8,6 +8,7 @@ require "elastic_adapter/decoration/count_response"
 require "elastic_adapter/decoration/validation_response"
 require "elastic_adapter/decoration/suggestion_response"
 require "elastic_adapter/decoration/search_response"
+require "elastic_adapter/decoration/aggregation_response"
 require "elastic_adapter/decoration/response_decorator_factory"
 require "elastic_adapter/response"
 require "elastic_adapter/index"

data/spec/cassettes/ElasticAdapter_Index/_aggregate/response/is_a_AggregationResponse.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:9200/test_index/_search
+    body:
+      encoding: UTF-8
+      string: '{"aggs":{"group":{"terms":{"field":"group"}}}}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '483'
+    body:
+      encoding: UTF-8
+      string: '{"took":7,"timed_out":false,"_shards":{"total":5,"successful":5,"failed":0},"hits":{"total":2,"max_score":1.0,"hits":[{"_index":"test_index","_type":"test_doc","_id":"AUv-oTm7Ngm7ooYjXOfD","_score":1.0,"_source":{"foo":"bar","group":"A"}},{"_index":"test_index","_type":"test_doc","_id":"AUv-n2n-Ngm7ooYjXOVX","_score":1.0,"_source":{"foo":"bar","group":"A"}}]},"aggregations":{"group":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"a","doc_count":2}]}}}'
+    http_version: 
+  recorded_at: Mon, 09 Mar 2015 13:02:38 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_aggregate.yml

@@ -0,0 +1,84 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: http://localhost:9200/test_index
+    body:
+      encoding: UTF-8
+      string: '{"mappings":{"test_doc":{"properties":{"foo":{"type":"string"},"foo_suggest":{"type":"completion"}}}},"settings":{}}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '81'
+    body:
+      encoding: UTF-8
+      string: '{"error":"IndexAlreadyExistsException[[test_index] already exists]","status":400}'
+    http_version: 
+  recorded_at: Mon, 09 Mar 2015 13:02:33 GMT
+- request:
+    method: post
+    uri: http://localhost:9200/test_index/test_doc
+    body:
+      encoding: UTF-8
+      string: '{"foo":"bar","group":"A"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '99'
+    body:
+      encoding: UTF-8
+      string: '{"_index":"test_index","_type":"test_doc","_id":"AUv-oTm7Ngm7ooYjXOfD","_version":1,"created":true}'
+    http_version: 
+  recorded_at: Mon, 09 Mar 2015 13:02:33 GMT
+- request:
+    method: delete
+    uri: http://localhost:9200/test_index
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '21'
+    body:
+      encoding: UTF-8
+      string: '{"acknowledged":true}'
+    http_version: 
+  recorded_at: Mon, 09 Mar 2015 13:23:53 GMT
+recorded_with: VCR 2.9.3

data/spec/decoration/aggregation_response_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+module ElasticAdapter
+  module Decoration
+    describe AggregationResponse do
+      let(:response){{
+        aggregations: {
+          products: {
+            doc_count_error_upper_bound: 46,
+            buckets: [
+              {
+                key: "Product A",
+                doc_count: 100
+              },
+              {
+                key: "Product Z",
+                doc_count: 52
+              }
+            ]
+          }
+        }
+      }}
+
+      subject { AggregationResponse.new(response) }
+
+      describe "#aggregations" do
+        it "counts one" do
+          expect(subject.aggregations.count).to eq 1
+        end
+
+        it "contains products" do
+          expect(subject.aggregations).to have_key :products
+        end
+
+        describe "products" do
+          it "counts two" do
+            expect(subject.aggregations[:products].count).to eq 2
+          end
+
+          it "contains Product A with it's count" do
+            expect(subject.aggregations[:products]).to include({
+              term: "Product A",
+              count: 100
+            })
+          end
+
+          it "contains Product Z with it's count" do
+            expect(subject.aggregations[:products]).to include({
+              term: "Product Z",
+              count: 52
+            })
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/decoration/response_decorator_factory_spec.rb

@@ -5,69 +5,72 @@ module ElasticAdapter
     describe ResponseDecoratorFactory do
       describe "class methods" do
         describe "#decorate" do
-          context "response with exception" do
-            let(:response) {{ exception: ArgumentError.new }}
-            let(:subject) { ResponseDecoratorFactory.decorate(response)}
-
-            it "returns the unmodified response" do
-              expect(subject).to be response
-            end
-          end
-
-          context "response with acknowledged" do
+          context "count" do
             let(:response) {{ acknowledged: true }}
-            let(:subject) { ResponseDecoratorFactory.decorate(response)}
+            subject { ResponseDecoratorFactory.decorate(response, :count) }
 
-            it "returns the unmodified response" do
-              expect(subject).to be response
+            it "returns a CountResponse" do
+              expect(subject).to be_a CountResponse
             end
           end
 
-          context "response with source" do
+          context "hit" do
             let(:response) {{ source: {} }}
-            let(:subject) { ResponseDecoratorFactory.decorate(response)}
+            subject { ResponseDecoratorFactory.decorate(response, :hit) }
 
             it "returns a HitDecorator" do
               expect(subject).to be_a HitDecorator
             end
           end
 
-          context "response with hits" do
+          context "search" do
             let(:response) {{ hits: {hits: []} }}
-            let(:subject) { ResponseDecoratorFactory.decorate(response)}
+            subject { ResponseDecoratorFactory.decorate(response, :search) }
 
             it "returns a SearchResponse" do
               expect(subject).to be_a SearchResponse
             end
           end
 
-          context "response with count" do
-            let(:response) {{ count: {count: 1} }}
-            let(:subject) { ResponseDecoratorFactory.decorate(response)}
+          context "validation" do
+            let(:response) {{ valid: true }}
+            subject { ResponseDecoratorFactory.decorate(response, :validation) }
 
-            it "returns a CountResponse" do
-              expect(subject).to be_a CountResponse
+            it "returns a ValidationResponse" do
+              expect(subject).to be_a ValidationResponse
             end
           end
 
-          context "response with options" do
+          context "suggestion" do
             let(:response) {{ foo: "bar", foo_suggestion: [{options: []}] }}
-            let(:subject) { ResponseDecoratorFactory.decorate(response)}
+            subject { ResponseDecoratorFactory.decorate(response, :suggestion) }
 
             it "returns a SuggestionResponse" do
               expect(subject).to be_a SuggestionResponse
             end
           end
 
-          context "response with everything_else" do
-            let(:response) {{ everything_else: {} }}
-            let(:subject) { ResponseDecoratorFactory.decorate(response)}
+          context "aggregation" do
+            let(:response){{
+              aggregations: {
+                products: {
+                  doc_count_error_upper_bound: 46,
+                  buckets: [
+                    {
+                      key: "Product A",
+                      doc_count: 100
+                    }
+                  ]
+                }
+              }
+            }}
 
-            it "returns a Response" do
-              expect(subject).to be_a Hash
+            subject { ResponseDecoratorFactory.decorate(response, :aggregation) }
+
+            it "returns a AggregationResponse" do
+              expect(subject).to be_a AggregationResponse
             end
           end
-
         end
       end
     end

data/spec/index/aggregation_spec.rb

@@ -0,0 +1,34 @@
+require_relative "./shared_context.rb"
+
+module ElasticAdapter
+  describe Index do
+    include_context "index context"
+
+    describe "#aggregate", :vcr do
+      before :all do
+        create_test_index
+        index_documents foo: "bar", group: "A"
+        index_documents foo: "baz", group: "A"
+        index_documents foo: "boo", group: "B"
+      end
+
+      after :all do
+        delete_test_index
+      end
+
+      describe "response" do
+        let(:query) {{
+          aggs: {
+            group: {
+              terms: { field: "group" }
+            }
+          }
+        }}
+
+        it "is a AggregationResponse" do
+          expect(subject.aggregate(query)).to be_a Decoration::AggregationResponse
+        end
+      end
+    end
+  end
+end

data/spec/response_spec.rb

@@ -32,6 +32,13 @@ module ElasticAdapter
         response = Response.new(hash)
         expect(response.object).to eq expected
       end
+
+      it "works with arrays" do
+        hash = { "foo" => ["bar", "buz"] }
+        expected = { foo: ["bar", "buz"] }
+        response = Response.new(hash)
+        expect(response.object).to eq expected
+      end
     end
 
     describe "#failure?" do
@@ -53,28 +60,5 @@ module ElasticAdapter
         end
       end
     end
-
-    describe "#decorate" do
-      context "find request" do
-        let(:document) { {foo: "bar", id: 1} }
-        let(:response_hash) do
-          {
-            "found" => true,
-            "_id" => 1,
-            "_source" => {
-              "foo" => "bar"
-            }
-          }
-        end
-
-        let(:response) do
-          response = Response.new(response_hash)
-        end
-
-        it "is the document" do
-          expect(response.decorate.to_hash).to eq document
-        end
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_adapter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kristopher Bredemeier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -154,9 +154,9 @@ files:
 - README.md
 - Rakefile
 - elastic_adapter.gemspec
-- example.env
 - examples/basic_usage.rb
 - lib/elastic_adapter.rb
+- lib/elastic_adapter/decoration/aggregation_response.rb
 - lib/elastic_adapter/decoration/count_response.rb
 - lib/elastic_adapter/decoration/decorator.rb
 - lib/elastic_adapter/decoration/hit_decorator.rb
@@ -168,6 +168,8 @@ files:
 - lib/elastic_adapter/index.rb
 - lib/elastic_adapter/response.rb
 - lib/elastic_adapter/version.rb
+- spec/cassettes/ElasticAdapter_Index/_aggregate.yml
+- spec/cassettes/ElasticAdapter_Index/_aggregate/response/is_a_AggregationResponse.yml
 - spec/cassettes/ElasticAdapter_Index/_count/empty_index.yml
 - spec/cassettes/ElasticAdapter_Index/_count/empty_index/is_a_response.yml
 - spec/cassettes/ElasticAdapter_Index/_count/empty_index/returns_the_amount_of_all_documents.yml
@@ -207,9 +209,11 @@ files:
 - spec/cassettes/ElasticAdapter_Index/_validate/invalid_query/is_false.yml
 - spec/cassettes/ElasticAdapter_Index/_validate/valid_query/is_a_response.yml
 - spec/cassettes/ElasticAdapter_Index/_validate/valid_query/is_true.yml
+- spec/decoration/aggregation_response_spec.rb
 - spec/decoration/response_decorator_factory_spec.rb
 - spec/document_type_spec.rb
 - spec/elastic_adapter_spec.rb
+- spec/index/aggregation_spec.rb
 - spec/index/count_spec.rb
 - spec/index/create_index_spec.rb
 - spec/index/delete_index_spec.rb
@@ -224,7 +228,7 @@ files:
 - spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/support/index_helper.rb
-homepage: https://github.com/kbredemeier/elastic_adatper
+homepage: https://github.com/kbredemeier/elastic_adapter
 licenses:
 - MIT
 metadata: {}
@@ -249,6 +253,8 @@ signing_key:
 specification_version: 4
 summary: Repository like access to elasticseach indices
 test_files:
+- spec/cassettes/ElasticAdapter_Index/_aggregate.yml
+- spec/cassettes/ElasticAdapter_Index/_aggregate/response/is_a_AggregationResponse.yml
 - spec/cassettes/ElasticAdapter_Index/_count/empty_index.yml
 - spec/cassettes/ElasticAdapter_Index/_count/empty_index/is_a_response.yml
 - spec/cassettes/ElasticAdapter_Index/_count/empty_index/returns_the_amount_of_all_documents.yml
@@ -288,9 +294,11 @@ test_files:
 - spec/cassettes/ElasticAdapter_Index/_validate/invalid_query/is_false.yml
 - spec/cassettes/ElasticAdapter_Index/_validate/valid_query/is_a_response.yml
 - spec/cassettes/ElasticAdapter_Index/_validate/valid_query/is_true.yml
+- spec/decoration/aggregation_response_spec.rb
 - spec/decoration/response_decorator_factory_spec.rb
 - spec/document_type_spec.rb
 - spec/elastic_adapter_spec.rb
+- spec/index/aggregation_spec.rb
 - spec/index/count_spec.rb
 - spec/index/create_index_spec.rb
 - spec/index/delete_index_spec.rb

data/example.env

@@ -1,4 +0,0 @@
-TEST_CLUSTER_NAME="elastic_adatper_test_cluster"
-TEST_CLUSTER_COMMAND="sh /path/to/elasticsearch"
-TEST_CLUSTER_PORT=9350
-TEST_CLUSTER_NODES=1