esearch 0.2.0

data/lib/esearch/presenter/aspect/term.rb

@@ -0,0 +1,19 @@
+module Esearch
+  class Presenter
+    class Aspect
+
+      # Aspect of a term facet
+      class Term < self
+
+        # Return value of aspect
+        #
+        # @return [String]
+        #
+        # @api private
+        #
+        expose_primitive(:term, :value)
+
+      end
+    end
+  end
+end

data/lib/esearch/presenter/cluster.rb

@@ -0,0 +1,84 @@
+module Esearch
+  class Presenter
+    # Base class for cluster presenters
+    class Cluster < self
+
+      # Presenter for cluster health
+      class Health < self
+
+        # Return cluster name
+        #
+        # @return [String]
+        #
+        # @api private
+        #
+        expose_primitive('name')
+
+        # Return status string
+        #
+        # @return [String]
+        #
+        # @api private
+        #
+        expose_primitive('status')
+
+        # Return number of nodes
+        #
+        # @return [String]
+        #
+        # @api private
+        #
+        expose_primitive('number_of_nodes')
+
+        # Return number of data nodes
+        #
+        # @return [Fixnum]
+        #
+        # @api private
+        #
+        expose_primitive('number_of_data_nodes')
+
+        # Return number of active primary shards
+        #
+        # @return [Fixnum]
+        #
+        # @api private
+        #
+        expose_primitive('active_primary_shards')
+
+        # Return number of active shards
+        #
+        # @return [Fixnum]
+        #
+        # @api private
+        #
+        expose_primitive('active_shards')
+
+        # Return number of relocating shards
+        #
+        # @return [Fixnum]
+        #
+        # @api private
+        #
+        expose_primitive('relocating_shards')
+
+        # Return number of initializing shards
+        #
+        # @return [Fixnum]
+        #
+        # @api private
+        #
+        expose_primitive('initializing_shards')
+
+        # Return number of unassigned shards
+        #
+        # @return [Fixnum]
+        #
+        # @api private
+        #
+        expose_primitive('unassigned_shards')
+
+      end
+    end
+  end
+end

data/lib/esearch/presenter/document.rb

@@ -0,0 +1,102 @@
+module Esearch
+  class Presenter
+    # Base class result of document command presenters
+    class Document < self
+
+      # Return index name
+      #
+      # @return [String]
+      #
+      # @api private
+      #
+      expose_primitive(:_index, :index)
+
+      # Return type name
+      #
+      # @return [String]
+      #
+      # @api private
+      #
+      expose_primitive(:_type, :type)
+
+      # Return id
+      #
+      # @return [String]
+      #
+      # @api private
+      #
+      expose_primitive(:_id, :id)
+
+      # Return version
+      #
+      # @return [Fixnum]
+      #
+      # @api private
+      #
+      expose_primitive(:_version, :version)
+
+      # Base class for document operations
+      class Operation < self
+
+        # Test for successful operation
+        #
+        # @return [true]
+        #   if successful
+        #
+        # @return [false]
+        #   otherwise
+        #
+        # @api private
+        #
+        expose_primitive(:ok, :ok?)
+
+        # Index operation
+        class Index < self
+        end
+
+        # Update operation
+        class Update < self
+        end
+
+        # Delete operation
+        class Delete < self
+
+          # Test if document was found
+          #
+          # @return [true]
+          #   if document was found
+          #
+          # @return [false]
+          #   otherwise
+          #
+          # @api private
+          #
+          expose_primitive(:found, :found?)
+
+        end
+      end
+
+      # Presenter for document get result
+      class Get < self
+
+        # Return source document
+        #
+        # @return [Hash]
+        # 
+        # @api private
+        #
+        expose_primitive(:_source, :source)
+
+        # Return requested fields
+        #
+        # @return [Hash]
+        # 
+        # @api private
+        #
+        expose_primitive(:fields)
+
+      end
+
+    end
+  end
+end

data/lib/esearch/presenter/facet.rb

@@ -0,0 +1,72 @@
+module Esearch
+  class Presenter
+
+    # Base class for facets in results
+    class Facet < self
+
+      TYPE_KEY = '_type'.freeze
+
+      # Build facet from raw
+      #
+      # @param [Hash] raw
+      #
+      # @return [Facet]
+      #
+      # @api private
+      #
+      def self.build(raw)
+        type = raw.fetch(TYPE_KEY)
+        get(type).new(raw)
+      end
+
+      # Get class for type
+      #
+      # @param [String] type
+      #
+      # @return [Class:Facet]
+      #
+      # @api private
+      #
+      def self.get(type)
+        REGISTRY.fetch(type) do
+          raise "Facet with type #{type.inspect} is not known"
+        end
+      end
+      private_class_method :get
+
+      # Enumerate aspects
+      #
+      # @return [Enumerable<Aspect>]
+      #
+      # @api private
+      #
+      def aspects
+        util = self.class
+        raw.fetch(util::FACET_KEY).map do |item|
+          util::ASPECT_CLASS.new(item)
+        end
+      end
+      memoize :aspects
+
+    private
+
+      # Facet that returns range counts
+      class Range < self
+        ASPECT_CLASS = Aspect::Range
+        FACET_KEY = 'ranges'.freeze
+      end
+
+      # Facet that returns term counts
+      class Terms < self
+        ASPECT_CLASS = Aspect::Term
+        FACET_KEY = 'terms'.freeze
+      end
+
+      REGISTRY = {
+        'range' => Range,
+        'terms' => Terms
+      }.freeze
+
+    end
+  end
+end

data/lib/esearch/presenter/hit.rb

@@ -0,0 +1,70 @@
+module Esearch
+  class Presenter
+
+    # Presenter for an hit
+    class Hit < self
+  
+      # Return source field if present
+      #
+      # @return [Hash] 
+      #   if present
+      #
+      # @return [nil]
+      #   otherwise
+      #
+      # @api private
+      #
+      def source
+        raw['_source']
+      end
+  
+      # Return fields if present
+      #
+      # @return [Hash] 
+      #   if present
+      #
+      # @return [nil]
+      #   otherwise
+      #
+      # @api private
+      #
+      def fields
+        raw['fields']
+      end
+
+      # Return index name
+      #
+      # @return [String]
+      #
+      # @api private
+      #
+      expose_primitive(:_index, :index_name)
+
+      # Return type name
+      #
+      # @return [Type]
+      #
+      # @api private
+      #
+      expose_primitive(:_type, :type_name)
+
+      # Return id
+      #
+      # @return [String]
+      #
+      # @api private
+      #
+      expose_primitive(:_id, :id)
+
+      # Return score
+      #
+      # @return [Float]
+      #
+      # @api private
+      #
+      expose_primitive(:_score, :score)
+
+    end
+  end
+end
+

data/lib/esearch/presenter/hits.rb

@@ -0,0 +1,60 @@
+module Esearch
+  class Presenter
+
+    # Presenter for elasticsearch result hits
+    class Hits < self
+      include Enumerable
+
+      # Enumerate contents
+      #
+      # @return [self]
+      #   if block given
+      #
+      # @return [Enumerator<Hit>]
+      #   otherwise
+      #
+      # @api private
+      #
+      def each(&block)
+        return to_enum unless block_given?
+
+        hits.each do |hit|
+          yield Hit.new(hit)
+        end
+        
+        self
+      end
+
+      # Return amount of hits in this request
+      #
+      # @return [Fixnum]
+      #
+      # @api private
+      #
+      def size
+        hits.size
+      end
+      
+      # Return total amount of hits in the query
+      #
+      # @return [Fixnum]
+      #
+      # @api private
+      #
+      expose_primitive('total')
+
+    private
+
+      # Return raw hits
+      #
+      # @return [Array]
+      #
+      # @api private
+      #
+      expose_primitive(:hits)
+      private :hits
+
+    end
+  end
+end
+

data/lib/esearch/presenter/index.rb

@@ -0,0 +1,23 @@
+module Esearch
+  class Presenter
+
+    # Base class for index operation result presenters
+    class Index < self
+
+      # Create operation presenter
+      class Create < self
+        expose_primitive :ok, :ok?
+      end
+
+      # Delete operation presenter
+      class Delete < self
+        expose_primitive :ok, :ok?
+      end
+      
+      # Refresh operation presenter
+      class Refresh < self
+      end
+
+    end
+  end
+end

data/lib/esearch/presenter/search.rb

@@ -0,0 +1,32 @@
+module Esearch
+  class Presenter
+    # Presenter for search result
+    class Search < self
+
+      # Return facets
+      #
+      # @return [Hash]
+      #
+      # @api private
+      #
+      def facets
+        raw.fetch('facets', {}).each_with_object({}) do |(name, body), hash|
+          hash[name] = Facet.build(body)
+        end
+      end
+      memoize :facets
+
+      # Return hits
+      #
+      # @return [Enumerable<Hash>]
+      #
+      # @api private
+      #
+      def hits
+        Hits.new(raw.fetch('hits'))
+      end
+      memoize :hits
+
+    end
+  end
+end