elastic_adapter 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25e0579bbeba803053caee8b5986f7b02f7f719c
-  data.tar.gz: 1280437e020532bc8c67fc55555fad96ac9bd1e8
+  metadata.gz: 1b73e1ccef696aa67e9fdb445fdad0233735e09f
+  data.tar.gz: 7798c15828d65100a7586084d0b04596fa27e8f5
 SHA512:
-  metadata.gz: 577612284345aea4de48577b3d01c462326605e0b16531947fea2366c0ec5e4e43eac8a1687ed6942db07d559a992e29b41195d89e20e24f39d4e03a0ff84a3a
-  data.tar.gz: ef247ad391ecc75e53f322f9a8fb659a26eb2de46f4cbd50354428a146a35028beccdf70687c043d1818cc1a578664b4bb45b7fdd99171634854ce59ef273840
+  metadata.gz: 136c4240dfdc3cf631706b802960e42d4b73500c248635f7330791a744fc831dd6c6e27681f55f9a2869468fe0757dc18ebe499f0b4a0a384d5a4ae6a06e577b
+  data.tar.gz: c65ce37d0765ccee7222c746e9b7ffbbfa5817426bb427f1bc41a8de307c26ccfccef0b2f08b61f27815d6df165558a567048ef2e16c958eb2a4559d9f64fdca

data/lib/elastic_adapter.rb

@@ -2,15 +2,17 @@ require "elasticsearch"
 
 require "elastic_adapter/version"
 require "elastic_adapter/document_type"
-require "elastic_adapter/decoration/decorator"
-require "elastic_adapter/decoration/hit_decorator"
-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/responses/base_response"
+require "elastic_adapter/responses/sanitized_response"
+require "elastic_adapter/responses/aggregation_response"
+require "elastic_adapter/responses/count_response"
+require "elastic_adapter/responses/get_response"
+require "elastic_adapter/responses/search_response"
+require "elastic_adapter/responses/suggestion_response"
+require "elastic_adapter/responses/validation_response"
+require "elastic_adapter/responses/response_decorator_factory"
+
 require "elastic_adapter/index"
 
 begin

data/lib/elastic_adapter/index.rb

@@ -85,9 +85,11 @@ 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 :count do
+      response = handle_api_call :count do
         client.count index: name, body: query
       end
+
+      response.count || response
     end
 
     # Indexes a Hash or anything that responds to to_hash as a document
@@ -125,7 +127,7 @@ module ElasticAdapter
     # @param [Integer] id
     # @return [ElasticAdapter::HitDecorator]
     def get(id)
-      handle_api_call :hit do
+      handle_api_call :get do
         client.get(
           index: name,
           type: document_type.name,
@@ -204,9 +206,9 @@ module ElasticAdapter
     private
 
     def handle_api_call(*args)
-      Decoration::ResponseDecoratorFactory.decorate(yield, *args)
+      Responses::ResponseDecoratorFactory.decorate(yield, *args)
     rescue Elasticsearch::Transport::Transport::Error => e
-      Response.new(
+      Responses::SanitizedResponse.new(
         exception: e
       )
     end

data/lib/elastic_adapter/{decoration → responses}/aggregation_response.rb

@@ -1,20 +1,16 @@
 module ElasticAdapter
-  module Decoration
-    # Used to decorate responses from the elasticsearch search api
-    #
-    # @attr_reader [Hash] aggregations
-    class AggregationResponse < Decorator
+  module Responses
+    class AggregationResponse < BaseResponse
       attr_reader :aggregations
 
-      # Reduces the interface
-      #
-      # @param [Hash] hash
-      # @return [Hash]
-      def alter_object(hash)
+      private
+
+      def set_instance_variables
         new_hash = {}
+
         new_hash[:aggregations] = {}
 
-        hash[:aggregations].each do |key, value|
+        object[:aggregations].each do |key, value|
           new_hash[:aggregations][key] = []
 
           value[:buckets].each do |agg|
@@ -26,8 +22,6 @@ module ElasticAdapter
         end
 
         @aggregations = new_hash[:aggregations]
-
-        new_hash
       end
     end
   end

data/lib/elastic_adapter/responses/base_response.rb

@@ -0,0 +1,28 @@
+require "delegate"
+
+module ElasticAdapter
+  module Responses
+    class BaseResponse < SimpleDelegator
+      def initialize(object)
+        __setobj__(object)
+        set_instance_variables
+      end
+
+      # Returns the underlaying object
+      #
+      # @return [Object] The underlaying object
+      def object
+        __getobj__
+      end
+
+      private
+
+      # This method is intended to set instance variables that provide
+      # access to values from the original object
+      #
+      # @param [Object] object
+      def set_instance_variables
+      end
+    end
+  end
+end

data/lib/elastic_adapter/responses/count_response.rb

@@ -0,0 +1,13 @@
+module ElasticAdapter
+  module Responses
+    class CountResponse < BaseResponse
+      attr_reader :count
+
+      private
+
+      def set_instance_variables
+        @count = object[:count]
+      end
+    end
+  end
+end

data/lib/elastic_adapter/responses/get_response.rb

@@ -0,0 +1,13 @@
+module ElasticAdapter
+  module Responses
+    class GetResponse < BaseResponse
+      attr_reader :document
+
+      private
+
+      def set_instance_variables
+        @document = object[:source].merge(id: object[:id])
+      end
+    end
+  end
+end

data/lib/elastic_adapter/{decoration → responses}/response_decorator_factory.rb

@@ -1,22 +1,20 @@
 module ElasticAdapter
-  module Decoration
-    # This class is used inside the Response and is used to determin
-    # the decorator for responses returned by elasticsearch
+  module Responses
+    # This class is used to decorate responses
     #
-    # @see Response#decorate
     class ResponseDecoratorFactory
       class << self
-        # Takes a response and multiple symbols and decorated response.
+        # Takes a response and multiple symbols and decorates the 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(plain_response, *args)
-          response = Response.new(plain_response)
+          response = SanitizedResponse.new(plain_response)
 
           response = CountResponse.new(response) if args.include? :count
-          response = HitDecorator.new(response) if args.include? :hit
+          response = GetResponse.new(response) if args.include? :get
           response = SearchResponse.new(response) if args.include? :search
           response = ValidationResponse.new(response) if args.include? :validation
           response = SuggestionResponse.new(response) if args.include? :suggestion
@@ -24,22 +22,6 @@ module ElasticAdapter
 
           response
         end
-
-        private
-
-        # Checks if the passed response is a response
-        # from the elasticsearch suggest api
-        #
-        # @param [Hash] response
-        # @return [Boolean]
-        def suggestion?(response)
-          second_key = response[response.keys[1]]
-          return false unless second_key.is_a? Array
-          return false if second_key.empty?
-          return false unless second_key.first.is_a? Hash
-          return false unless second_key.first.key? :options
-          true
-        end
       end
     end
   end

data/lib/elastic_adapter/responses/sanitized_response.rb

@@ -0,0 +1,46 @@
+module ElasticAdapter
+  module Responses
+    class SanitizedResponse < BaseResponse
+      def initialize(object)
+        super(deep_sanitize_object(object))
+      end
+
+      private
+
+      def deep_sanitize_object(object)
+        if object.is_a? Hash
+          return sanitize_hash(object)
+        elsif object.is_a? Array
+          return sanitize_array(object)
+        else
+          return object
+        end
+      end
+
+      def sanitize_hash(hash)
+        result = {}
+
+        hash.each do |key, value|
+          new_key = remove_leading_underscore(key).to_sym
+
+          if value.is_a?(Hash)
+            result[new_key] = sanitize_hash(value)
+          else
+            result[new_key] = deep_sanitize_object(value)
+          end
+        end
+
+        result
+      end
+
+      def sanitize_array(array)
+        array.map { |element| deep_sanitize_object(element) }
+      end
+
+      def remove_leading_underscore(string)
+        /^_?(.*)$/.match(string)[1]
+      end
+    end
+  end
+end
+

data/lib/elastic_adapter/responses/search_response.rb

@@ -0,0 +1,21 @@
+module ElasticAdapter
+  module Responses
+    class SearchResponse < BaseResponse
+      attr_reader :hits
+
+      private
+
+      def set_instance_variables
+        hits = []
+        object[:hits][:hits].each do |hit|
+          hits << {
+            id: hit[:id]
+          }.merge(hit[:source])
+
+        end
+
+        @hits = hits
+      end
+    end
+  end
+end

data/lib/elastic_adapter/responses/suggestion_response.rb

@@ -0,0 +1,46 @@
+module ElasticAdapter
+  module Responses
+    class SuggestionResponse < BaseResponse
+      # This class represents a search term and it's
+      # suggested options
+      class TermSuggestion
+        attr_reader :text, :options
+
+        def initialize(params)
+          @text = params[:text]
+          @options = params[:options]
+        end
+      end
+
+      # This class represents a single named suggestion
+      # returned by elaticsearch
+      class Suggestion
+        attr_reader :name, :terms
+
+        def initialize(name, suggestions)
+          @name = name
+          @terms = []
+
+          suggestions.each do |suggestion_per_term|
+            @terms << TermSuggestion.new(suggestion_per_term)
+          end
+        end
+      end
+
+      attr_reader :suggestions
+
+      private
+
+      def set_instance_variables
+        @suggestions = []
+
+        object_without_shards = object.reject { |key, value| key == :shards}
+        object_without_shards.each do |key, value|
+          # In this context key is the named suggestion
+          # returned by elasticsearch
+          @suggestions << Suggestion.new(key, value)
+        end
+      end
+    end
+  end
+end

data/lib/elastic_adapter/responses/validation_response.rb

@@ -0,0 +1,18 @@
+module ElasticAdapter
+  module Responses
+    class ValidationResponse < BaseResponse
+      attr_reader :explanations, :valid
+
+      def valid?
+        valid
+      end
+
+      private
+
+      def set_instance_variables
+        @valid = object[:valid]
+        @explanations = object[:explanations]
+      end
+    end
+  end
+end

data/lib/elastic_adapter/version.rb

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

data/spec/cassettes/ElasticAdapter_Index/_count/empty_index/is_a_fixnum.yml

@@ -0,0 +1,30 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:9200/test_index/_count
+    body:
+      encoding: UTF-8
+      string: '{"query":{"match_all":{}}}'
+    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: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '68'
+    body:
+      encoding: UTF-8
+      string: '{"error":"IndexMissingException[[test_index] missing]","status":404}'
+    http_version: 
+  recorded_at: Mon, 09 Mar 2015 18:08:20 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/ElasticAdapter_Index/_count/empty_index/number.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:9200/test_index/_count
+    body:
+      encoding: UTF-8
+      string: '{"query":{"match_all":{}}}'
+    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: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '68'
+    body:
+      encoding: UTF-8
+      string: '{"error":"IndexMissingException[[test_index] missing]","status":404}'
+    http_version: 
+  recorded_at: Mon, 09 Mar 2015 18:08:00 GMT
+- request:
+    method: get
+    uri: http://localhost:9200/test_index/_count
+    body:
+      encoding: UTF-8
+      string: '{"query":{"match_all":{}}}'
+    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: 404
+      message: Not Found
+    headers:
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '68'
+    body:
+      encoding: UTF-8
+      string: '{"error":"IndexMissingException[[test_index] missing]","status":404}'
+    http_version: 
+  recorded_at: Mon, 09 Mar 2015 18:08:02 GMT
+recorded_with: VCR 2.9.3