elastic_adapter 0.0.3 → 0.0.4

data/spec/{decoration → responses}/response_decorator_factory_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 module ElasticAdapter
-  module Decoration
+  module Responses
     describe ResponseDecoratorFactory do
       describe "class methods" do
         describe "#decorate" do
@@ -14,12 +14,12 @@ module ElasticAdapter
             end
           end
 
-          context "hit" do
+          context "get" do
             let(:response) {{ source: {} }}
-            subject { ResponseDecoratorFactory.decorate(response, :hit) }
+            subject { ResponseDecoratorFactory.decorate(response, :get) }
 
-            it "returns a HitDecorator" do
-              expect(subject).to be_a HitDecorator
+            it "returns a GetResponse" do
+              expect(subject).to be_a GetResponse
             end
           end
 
@@ -42,7 +42,22 @@ module ElasticAdapter
           end
 
           context "suggestion" do
-            let(:response) {{ foo: "bar", foo_suggestion: [{options: []}] }}
+            let(:response) {{
+              my_suggest_1: [
+                {
+                  text: "amsterdma",
+                  offset: 4,
+                  length: 9,
+                  options: [
+                    {
+                      text: "amsterdam",
+                      freq: 77,
+                      score: 0.8888889
+                    }
+                  ]
+                }
+              ]
+            }}
             subject { ResponseDecoratorFactory.decorate(response, :suggestion) }
 
             it "returns a SuggestionResponse" do
@@ -71,6 +86,39 @@ module ElasticAdapter
               expect(subject).to be_a AggregationResponse
             end
           end
+
+          context "mixed aggregation and search" do
+            let(:response){{
+              hits: { hits: [] },
+              aggregations: {
+                products: {
+                  doc_count_error_upper_bound: 46,
+                  buckets: [
+                    {
+                      key: "Product A",
+                      doc_count: 100
+                    }
+                  ]
+                }
+              }
+            }}
+
+            subject { ResponseDecoratorFactory.decorate(response, :aggregation, :search) }
+
+            it "doent raise an exception" do
+              expect{
+                subject
+              }.not_to raise_error
+            end
+
+            it "behaves like a AggregationResponse" do
+              expect(subject).to respond_to :aggregations
+            end
+
+            it "behaves like a SearchResponse" do
+              expect(subject).to respond_to :count
+            end
+          end
         end
       end
     end

data/spec/responses/sanitized_response_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+module ElasticAdapter
+  module Responses
+    describe SanitizedResponse do
+      describe "symbolize keys" do
+        it "turns all strings in Hash keys to symbols" do
+          hash = {"foo" => "bar"}
+          response = SanitizedResponse.new(hash)
+          expect(response.keys.first).to be_a Symbol
+        end
+
+        it "removes all leading underscores from keys" do
+          hash = {"_foo" => {"_bar" => "baz" }}
+          expected = {foo: {bar: "baz" }}
+          response = SanitizedResponse.new(hash)
+          expect(response.object).to eq expected
+        end
+
+        it "works with arrays" do
+          hash = { "foo" => ["bar", "buz"] }
+          expected = { foo: ["bar", "buz"] }
+          response = SanitizedResponse.new(hash)
+          expect(response.object).to eq expected
+        end
+
+        it "works with hashes in arrays" do
+          hash = { boo: [ {"foo" => ["bar", "buz"] } ] }
+          expected = { boo: [ {foo: ["bar", "buz"] } ] }
+          response = SanitizedResponse.new(hash)
+          expect(response.object).to eq expected
+        end
+      end
+    end
+  end
+end

data/spec/responses/search_response_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+module ElasticAdapter
+  module Responses
+    describe SearchResponse do
+      let(:response) {{
+        shards: {
+          total: 5,
+          successful: 5,
+          failed: 0
+        },
+        hits: {
+          total: 1,
+          hits: [
+            {
+              index: "twitter",
+              type: "tweet",
+              id: "1",
+              source: {
+                user: "kimchy",
+                postDate: "2009-11-15T14:12:12",
+                message: "trying out Elasticsearch"
+              }
+            }
+          ]
+        }
+      }}
+
+      subject { SearchResponse.new(response) }
+
+      describe "hits" do
+        it "returns the hits" do
+          expect(subject.hits).to include({
+            id: "1",
+            user: "kimchy",
+            postDate: "2009-11-15T14:12:12",
+            message: "trying out Elasticsearch"
+          })
+        end
+      end
+    end
+  end
+end

data/spec/responses/suggestion_response_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+module ElasticAdapter
+  module Responses
+    describe SuggestionResponse do
+      let(:response){{
+        shards: {
+          total: 5, successful: 5, failed: 0
+        },
+        foo_suggest: [
+          {
+            text: "ba",
+            offset: 0,
+            length: 2,
+            options: [
+              {
+                text: "bar",
+                score: 1.0
+              }
+            ]
+          }
+        ]
+      }}
+
+      describe "suggestions" do
+        subject { SuggestionResponse.new(response).suggestions }
+
+        it "is an array" do
+          expect(subject).to be_an Array
+        end
+
+        describe "first suggestion" do
+          describe "#terms" do
+            it "is an Array" do
+              expect(subject.first.terms).to be_an Array
+            end
+
+            it "counts one" do
+              expect(subject.first.terms.count).to eq 1
+            end
+
+            describe "first term" do
+              describe "#text" do
+                it "equals 'ba'" do
+                  expect(subject.first.terms.first.text).to eq "ba"
+                end
+
+                describe "#options" do
+                  it "includes the options" do
+                    expect(subject.first.terms.first.options).to include({
+                      text: "bar",
+                      score: 1.0
+                    })
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/responses/validation_response_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+module ElasticAdapter
+  module Responses
+    describe ValidationResponse do
+      let(:response) {{
+        valid: false,
+        shards: {
+          total: 1,
+          successful: 1,
+          failed: 0
+        },
+        explanations: [ 
+          {
+            index: "twitter",
+            valid: false,
+            error: "some error message"
+          }
+        ]
+      }}
+
+      subject { ValidationResponse.new(response) }
+
+      describe "#valid?" do
+        it "returns false" do
+          expect(subject.valid?).to be false
+        end
+      end
+
+      describe "#explanations" do
+        it "is an Array" do
+          expect(subject.explanations).to be_an Array
+        end
+
+        it "includes the explanation" do
+          expect(subject.explanations).to include({
+            index: "twitter",
+            valid: false,
+            error: "some error message"
+          })
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elastic_adapter
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kristopher Bredemeier
@@ -156,24 +156,27 @@ files:
 - elastic_adapter.gemspec
 - 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
-- lib/elastic_adapter/decoration/response_decorator_factory.rb
-- lib/elastic_adapter/decoration/search_response.rb
-- lib/elastic_adapter/decoration/suggestion_response.rb
-- lib/elastic_adapter/decoration/validation_response.rb
 - lib/elastic_adapter/document_type.rb
 - lib/elastic_adapter/index.rb
-- lib/elastic_adapter/response.rb
+- lib/elastic_adapter/responses/aggregation_response.rb
+- lib/elastic_adapter/responses/base_response.rb
+- lib/elastic_adapter/responses/count_response.rb
+- lib/elastic_adapter/responses/get_response.rb
+- lib/elastic_adapter/responses/response_decorator_factory.rb
+- lib/elastic_adapter/responses/sanitized_response.rb
+- lib/elastic_adapter/responses/search_response.rb
+- lib/elastic_adapter/responses/suggestion_response.rb
+- lib/elastic_adapter/responses/validation_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_fixnum.yml
 - spec/cassettes/ElasticAdapter_Index/_count/empty_index/is_a_response.yml
+- spec/cassettes/ElasticAdapter_Index/_count/empty_index/number.yml
 - spec/cassettes/ElasticAdapter_Index/_count/empty_index/returns_the_amount_of_all_documents.yml
 - spec/cassettes/ElasticAdapter_Index/_count/not_empty_index.yml
+- spec/cassettes/ElasticAdapter_Index/_count/not_empty_index/is_a_fixnum.yml
 - spec/cassettes/ElasticAdapter_Index/_count/not_empty_index/is_a_response.yml
 - spec/cassettes/ElasticAdapter_Index/_count/not_empty_index/returns_1.yml
 - spec/cassettes/ElasticAdapter_Index/_create_index/index_is_present.yml
@@ -189,7 +192,7 @@ files:
 - spec/cassettes/ElasticAdapter_Index/_delete_index/index_present/repsonse/is_a_Response.yml
 - spec/cassettes/ElasticAdapter_Index/_delete_index/index_present/repsonse/is_a_ResponseElasticAdapter_Index/_delete_index/index_present/repsonse.yml
 - spec/cassettes/ElasticAdapter_Index/_get/document_exists.yml
-- spec/cassettes/ElasticAdapter_Index/_get/document_exists/response/contains_the_document.yml
+- spec/cassettes/ElasticAdapter_Index/_get/document_exists/response/document/returns_the_document.yml
 - spec/cassettes/ElasticAdapter_Index/_index/existing_document.yml
 - spec/cassettes/ElasticAdapter_Index/_index/existing_document/doesn_t_change_the_document_count.yml
 - spec/cassettes/ElasticAdapter_Index/_index/existing_document/invokes_to_hash_on_the_document.yml
@@ -206,11 +209,9 @@ files:
 - spec/cassettes/ElasticAdapter_Index/_suggest/query_ba_/returns_one_result.yml
 - spec/cassettes/ElasticAdapter_Index/_validate.yml
 - spec/cassettes/ElasticAdapter_Index/_validate/invalid_query/is_a_response.yml
-- spec/cassettes/ElasticAdapter_Index/_validate/invalid_query/is_false.yml
+- spec/cassettes/ElasticAdapter_Index/_validate/invalid_query/valid_/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
@@ -225,7 +226,15 @@ files:
 - spec/index/suggest_spec.rb
 - spec/index/unit_spec.rb
 - spec/index/validate_spec.rb
-- spec/response_spec.rb
+- spec/responses/aggregation_response_spec.rb
+- spec/responses/base_response_spec.rb
+- spec/responses/count_response_spec.rb
+- spec/responses/get_response_spec.rb
+- spec/responses/response_decorator_factory_spec.rb
+- spec/responses/sanitized_response_spec.rb
+- spec/responses/search_response_spec.rb
+- spec/responses/suggestion_response_spec.rb
+- spec/responses/validation_response_spec.rb
 - spec/spec_helper.rb
 - spec/support/index_helper.rb
 homepage: https://github.com/kbredemeier/elastic_adapter
@@ -256,9 +265,12 @@ 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_fixnum.yml
 - spec/cassettes/ElasticAdapter_Index/_count/empty_index/is_a_response.yml
+- spec/cassettes/ElasticAdapter_Index/_count/empty_index/number.yml
 - spec/cassettes/ElasticAdapter_Index/_count/empty_index/returns_the_amount_of_all_documents.yml
 - spec/cassettes/ElasticAdapter_Index/_count/not_empty_index.yml
+- spec/cassettes/ElasticAdapter_Index/_count/not_empty_index/is_a_fixnum.yml
 - spec/cassettes/ElasticAdapter_Index/_count/not_empty_index/is_a_response.yml
 - spec/cassettes/ElasticAdapter_Index/_count/not_empty_index/returns_1.yml
 - spec/cassettes/ElasticAdapter_Index/_create_index/index_is_present.yml
@@ -274,7 +286,7 @@ test_files:
 - spec/cassettes/ElasticAdapter_Index/_delete_index/index_present/repsonse/is_a_Response.yml
 - spec/cassettes/ElasticAdapter_Index/_delete_index/index_present/repsonse/is_a_ResponseElasticAdapter_Index/_delete_index/index_present/repsonse.yml
 - spec/cassettes/ElasticAdapter_Index/_get/document_exists.yml
-- spec/cassettes/ElasticAdapter_Index/_get/document_exists/response/contains_the_document.yml
+- spec/cassettes/ElasticAdapter_Index/_get/document_exists/response/document/returns_the_document.yml
 - spec/cassettes/ElasticAdapter_Index/_index/existing_document.yml
 - spec/cassettes/ElasticAdapter_Index/_index/existing_document/doesn_t_change_the_document_count.yml
 - spec/cassettes/ElasticAdapter_Index/_index/existing_document/invokes_to_hash_on_the_document.yml
@@ -291,11 +303,9 @@ test_files:
 - spec/cassettes/ElasticAdapter_Index/_suggest/query_ba_/returns_one_result.yml
 - spec/cassettes/ElasticAdapter_Index/_validate.yml
 - spec/cassettes/ElasticAdapter_Index/_validate/invalid_query/is_a_response.yml
-- spec/cassettes/ElasticAdapter_Index/_validate/invalid_query/is_false.yml
+- spec/cassettes/ElasticAdapter_Index/_validate/invalid_query/valid_/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
@@ -310,7 +320,15 @@ test_files:
 - spec/index/suggest_spec.rb
 - spec/index/unit_spec.rb
 - spec/index/validate_spec.rb
-- spec/response_spec.rb
+- spec/responses/aggregation_response_spec.rb
+- spec/responses/base_response_spec.rb
+- spec/responses/count_response_spec.rb
+- spec/responses/get_response_spec.rb
+- spec/responses/response_decorator_factory_spec.rb
+- spec/responses/sanitized_response_spec.rb
+- spec/responses/search_response_spec.rb
+- spec/responses/suggestion_response_spec.rb
+- spec/responses/validation_response_spec.rb
 - spec/spec_helper.rb
 - spec/support/index_helper.rb
 has_rdoc: 

data/lib/elastic_adapter/decoration/count_response.rb

@@ -1,16 +0,0 @@
-module ElasticAdapter
-  module Decoration
-    # Used to wrap responses from the elasticsearch count api
-    # After decoration the decorator will point to the actual
-    # count returned by elasticsearch
-    class CountResponse < Decorator
-      # Reduced the hash to the count returned by elasticsearch
-      #
-      # @param [Object] object
-      # @return [Integer] the count returned by elasticsearch
-      def alter_object(object)
-        object[:count]
-      end
-    end
-  end
-end

data/lib/elastic_adapter/decoration/decorator.rb

@@ -1,37 +0,0 @@
-require "delegate"
-
-module ElasticAdapter
-  module Decoration
-    # Abstract base class for response decorators
-    # @abstract
-    #
-    # @attr [Object] original_object the original unmodified object
-    class Decorator < SimpleDelegator
-      attr_reader :original_object
-
-      # Takes an object and stores it in `@original_object` and saves a
-      # altered version as the decorated object
-      #
-      # @param [Object] object
-      def initialize(object)
-        @original_object = object
-        __setobj__(alter_object(object))
-      end
-
-      # Returns the underlaying altered object
-      #
-      # @return [Object] the altered object
-      def object
-        __getobj__
-      end
-
-      # Is intended to alter the passed object to change it's interface
-      #
-      # @param [Object] object
-      # @return [Object]
-      def alter_object(_object)
-        fail NotImplementedError, "alter_object must be overriden in subclasses"
-      end
-    end
-  end
-end