eson-core 0.7.0 → 0.8.0

data/lib/eson/shared/core/index.rb

@@ -1,12 +1,21 @@
 module Eson
   module Shared
+    # Requests using this API have the following properties:
+    #
+    # {include:Index#parameters}
+    # {include:Index#source_param}
+    # {include:Index#multi_index}
+    # {include:Index#multi_types}
     module Index
       extend API
 
+      # @!macro no_multi_index
       multi_index false
       
+      # @!macro source_param
       source_param :doc
       
+      # @!macro parameters
       parameters(
         :type, 
         :id,
@@ -19,7 +28,9 @@ module Eson
         :replication,
         :consistency,
         :refresh,
-        :timeout
+        :timeout,
+        :ttl,
+        :timestamp
       )
       
       alias :document :doc
@@ -30,4 +41,4 @@ module Eson
       end
     end
   end
-end
+end

data/lib/eson/shared/core/mget.rb

@@ -1,16 +1,25 @@
 module Eson
   module Shared
+    # Requests using this API have the following properties:
+    #
+    # {include:MultiGet#parameters}
+    # {include:MultiGet#source_param}
+    # {include:MultiGet#multi_index}
+    # {include:MultiGet#multi_types}
     module MultiGet
       extend API
-      
+
+      # @!macro no_multi_index
       multi_index false
-      
+
+      # @!macro source_param
       source_param :docs,
                    :ids
                     
+      # @!macro parameters
       parameters :type,
                  :docs,
                  :ids
     end
   end
-end
+end

data/lib/eson/shared/core/more_like_this.rb

@@ -1,10 +1,18 @@
 module Eson
   module Shared
+    # Requests using this API have the following properties:
+    #
+    # @note {include:MoreLikeThis#parameters}
+    # @note {include:MoreLikeThis#source_param}
+    # @note {include:MoreLikeThis#multi_index}
+    # @note {include:MoreLikeThis#multi_types}
     module MoreLikeThis
       extend API
 
+      # @!macro no_multi_index
       multi_index false
 
+      # @!macro parameters
       parameters :id,
                  :type,
                  :mlt_fields,
@@ -35,6 +43,7 @@ module Eson
                  :version,
                  :min_score
 
+      # @!macro source_param
       source_param :timeout,
                    :from,
                    :size,
@@ -49,4 +58,4 @@ module Eson
                    :min_score
     end
   end
-end
+end

data/lib/eson/shared/core/msearch.rb

@@ -1,13 +1,22 @@
 module Eson
   module Shared
+    # Requests using this API have the following properties:
+    #
+    # @note {include:MultiSearch#parameters}
+    # @note {include:MultiSearch#source_param}
+    # @note {include:MultiSearch#multi_index}
+    # @note {include:MultiSearch#multi_types}
     module MultiSearch
       extend API
       
       attr_accessor :type
       
+      # @!macro multi_index
       multi_index true
       
+      # @!macro source_param
       source_param :msearch
+      # @!macro parameters
       parameters :msearch,
                  :types
 
@@ -34,4 +43,4 @@ module Eson
       end
     end
   end
-end
+end

data/lib/eson/shared/core/percolate.rb

@@ -1,18 +1,27 @@
 module Eson
   module Shared
+    # Requests using this API have the following properties:
+    #
+    # @note {include:Percolate#parameters}
+    # @note {include:Percolate#source_param}
+    # @note {include:Percolate#multi_index}
+    # @note {include:Percolate#multi_types}
     module Percolate
       extend API
       
+      # @!macro no_multi_index
       multi_index false
       
+      # @!macro parameters
       parameters :query,
                  :doc,
                  :prefer_local,
                  :type,
                  :index
       
+      # @!macro source_param
       source_param :doc, :query
       
     end
   end
-end
+end

data/lib/eson/shared/core/scroll.rb

@@ -0,0 +1,17 @@
+module Eson
+  module Shared
+    # Requests using this API have the following properties:
+    #
+    # {include:Scroll#parameters}
+    # {include:Scroll#source_param}
+    # {include:Scroll#multi_index}
+    # {include:Scroll#multi_types}
+    module Scroll
+      extend API
+
+      # @!macro parameters
+      parameters :scroll_id,
+                 :scroll
+    end
+  end
+end

data/lib/eson/shared/core/search.rb

@@ -1,12 +1,23 @@
 module Eson
   module Shared
+    # Requests using this API have the following properties:
+    #
+    # {include:Search#parameters}
+    # {include:Search#source_param}
+    # {include:Search#multi_index}
+    # {include:Search#multi_types}
     module Search
       extend API
 
       attr_accessor :type
 
+      # @!macro multi_index
       multi_index true
 
+      # @!macro multi_types
+      multi_types true
+
+      # @!macro source_param
       source_param :query,
                    :timeout,
                    :from,
@@ -23,6 +34,7 @@ module Eson
                    :version,
                    :min_score
 
+      # @!macro parameters
       parameters :timeout,
                  :types,
                  :routing,
@@ -39,14 +51,14 @@ module Eson
                  :facets,
                  :filter,
                  :scroll,
-                 :scroll_id,
                  :indices_boost,
                  :explain,
                  :version,
                  :min_score,
                  :q,
                  :df,
-                 :analyzer
+                 :analyzer,
+                 :lowercase_expanded_terms
 
       def types
         if @types
@@ -59,4 +71,4 @@ module Eson
       end
     end
   end
-end
+end

data/lib/eson/shared/core/simple_search.rb

@@ -1,12 +1,20 @@
 module Eson
   module Shared
+    # Requests using this API have the following properties:
+    #
+    # {include:SimpleSearch#parameters}
+    # {include:SimpleSearch#source_param}
+    # {include:SimpleSearch#multi_index}
+    # {include:SimpleSearch#multi_types}
     module SimpleSearch
       extend API
       
+      # @!macro multi_index
       multi_index true
       
       attr_accessor :type
       
+      # @!macro parameters
       parameters :timeout, 
                  :types, 
                  :q,
@@ -32,4 +40,4 @@ module Eson
        end
     end
   end
-end
+end

data/lib/eson/shared/core/update.rb

@@ -0,0 +1,33 @@
+module Eson
+  module Shared
+    # Requests using this API have the following properties:
+    #
+    # {include:Update#parameters}
+    # {include:Update#source_param}
+    # {include:Update#multi_index}
+    # {include:Update#multi_types}
+    module Update
+      extend API
+      
+      # @!macro no_multi_index
+      multi_index false
+      
+      # @!macro parameters
+      parameters :timeout, 
+                 :type, 
+                 :routing,
+                 :parent,
+                 :id,
+                 :consistency,
+                 :percolate,
+                 :refresh,
+                 :script,
+                 :params,
+                 :retry_on_conflict
+      
+      # @!macro source_param
+      source_param :script,
+                   :params
+    end
+  end
+end

data/lib/eson/shared/core/validate.rb

@@ -0,0 +1,50 @@
+module Eson
+  module Shared
+    # Requests using this API have the following properties:
+    #
+    # {include:Validate#parameters}
+    # {include:Validate#source_param}
+    # {include:Validate#multi_index}
+    # {include:Validate#multi_types}
+    module Validate
+      extend API
+
+      attr_accessor :type
+
+      # @!macro multi_index
+      multi_index false
+
+      # @!macro multi_types
+      multi_types false
+
+      # @!macro source_param
+      source_param :query
+
+      # @!macro parameters
+      parameters :timeout,
+                 :types,
+                 :routing,
+                 :query,
+                 :from,
+                 :size,
+                 :search_type,
+                 :sort,
+                 :track_scores,
+                 :highlight,
+                 :fields,
+                 :script_fields,
+                 :preference,
+                 :facets,
+                 :filter,
+                 :scroll,
+                 :indices_boost,
+                 :explain,
+                 :version,
+                 :min_score,
+                 :q,
+                 :df,
+                 :analyzer,
+                 :lowercase_expanded_terms
+    end
+  end
+end

data/lib/eson/shared/indices/aliases.rb

@@ -1,24 +1,52 @@
 module Eson
   module Shared
+    # Requests using this API have the following properties:
+    #
+    # {include:Aliases#parameters}
+    # {include:Aliases#source_param}
+    # {include:Aliases#multi_index}
+    # {include:Aliases#multi_types}
     module Aliases
       extend API
-      
+
       no_indices true
-      
+
+      # @!macro parameters
       parameters :actions
+      # @!macro source_param
       source_param [:actions]
-      
-      def add(index, aka)
-        actions << {"add" => { "index" => index, "alias" => aka}}
+
+      # Adds an alias to the alias request. The aliased index and the alias 
+      # are given directly, while further options can be provided in the
+      # options hash.
+      #
+      # @param index [String,Symbol] The index name.
+      # @param aka [String, Symbol] The aliased name.
+      # @options options [String, Symbol] :routing
+      #   The routing parameter that should be used on all requests.
+      # @options options [String, Symbol] :search_routing
+      #   Like routing, but only for search requests
+      # @options options [String, Symbol] :index_routing
+      #   Like routing, but only for index requests
+      # @options options [Hash] :filter
+      #   A filter definition to use on this alias
+      def add(index, aka, options = {})
+        actions << {:add => { :index => index, :alias => aka}.merge!(options)}
       end
-      
+
+      # Removes an alias. To remove and alias, both the original index and
+      # the alias have to be given.
+      #
+      # @param index [String,Symbol] The index name.
+      # @param aka [String, Symbol] The aliased name.
       def remove(index, aka)
-        actions << {"remove" => { "index" => index, "alias" => aka}}
+        actions << {:remove => { :index => index, :alias => aka}}
       end
-      
+
+      #@api private
       def actions
         @actions ||= []
       end
     end
   end
-end
+end

data/lib/eson/shared/indices/analyze.rb

@@ -1,11 +1,18 @@
 module Eson
   module Shared
+    # Requests using this API have the following properties:
+    #
+    # {include:Analyze#parameters}
+    # {include:Analyze#source_param}
+    # {include:Analyze#multi_index}
+    # {include:Analyze#multi_types}
     module Analyze
       extend API
       
+      # @!macro no_multi_index
       multi_index false
       
-      attr_accessor :text, :analyzer, :format
+      attr_accessor :text, :analyzer, :format, :tokenizer, :field
     end
   end
-end
+end

data/lib/eson/shared/indices/clear_cache.rb

@@ -1,13 +1,21 @@
 module Eson
   module Shared
+    # Requests using this API have the following properties:
+    #
+    # {include:ClearCache#parameters}
+    # {include:ClearCache#source_param}
+    # {include:ClearCache#multi_index}
+    # {include:ClearCache#multi_types}
     module ClearCache
       extend API
       
+      # @!macro multi_index
       multi_index true
       
+      # @!macro parameters
       parameters :filter, 
                  :field_data,
                  :bloom
     end
   end
-end
+end