elasticated 2.5.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34aaec873567c3de5edbd386329dd360e23367b1
-  data.tar.gz: d6f933aabaef089340d584edc22ab152438ef726
+  metadata.gz: eefc3eab5d4fd7000cb959f921e9d1622769c7df
+  data.tar.gz: 4cb4baa5ad341834938c175bffdad61669b63695
 SHA512:
-  metadata.gz: 64db33fc483ffa746f8b94cfd80e77d721e2c7ad261b44ee5f5c98f271f926008bed2fa4b3bb53d040bc3d90970d667e46db86a3583b68fb76bae6e30178909b
-  data.tar.gz: c9127b2363ab80dba4fb306e3cc43990b1384861bf04d492dd9bf43b35a3c7b45437acdd74768fc2a0631bb8b6ae13cdc9639c0dce4a7b2469209e92a738e1d7
+  metadata.gz: 62b3e29e6aa0e3c6406d65b7ecb041ac7ab4762f92007e6f63f2f830527b41df33e619f0078c886701b465b27ada8f390dec6963eb9d35522e56ba1dcd9adff5
+  data.tar.gz: 57691483ddb1372257bf5bba74da566d8e7a6259ebc3c59f107b77e8a8b4780b64bce4d30d5926a34477e7072110d80a684dc37e35e4f09f423abad66783975c

data/README.md

@@ -50,7 +50,7 @@ repository.delete_by query
 repository.exists? query
 ```
 
-**HOW TO** build a document, index or update it
+**HOW TO** build a document and index it
 ```ruby
 document = Document.create do |doc|
   doc.id = 'my_unique_id'
@@ -60,7 +60,39 @@ document = Document.create do |doc|
 end
 repository = Repository.new
 repository.index_document document
-repository.update_document document
+```
+
+**HOW TO** build a document and (partially) update it
+```ruby
+repository = Repository.new
+repository.update_document 'my_unique_id', type: 'mytype', index: 'myindex', source: { new_field: 'New data' }
+```
+
+**HOW TO** get a document (or multiple documents) by id
+```ruby
+repository = Repository.new
+document = repository.get_document 'my_unique_id', type: 'mytype', index: 'myindex'
+documents = repository.get_documents ['id1', 'id2', 'id3'], type: 'mytype', index: 'myindex'
+```
+
+**HOW TO** delete a document by id
+```ruby
+repository = Repository.new
+repository.delete_document 'my_unique_id', type: 'mytype', index: 'myindex'
+```
+
+**HOW TO** execute a bulk request
+```ruby
+repository = Repository.new
+document = Document.create id: 'my_id', type: 'my_type', index: 'my_index', source: { name: 'Pablo' }
+bulk_request = repository.prepare_bulk do
+  index_document d
+  delete_document 'my_id', type: 'my_type', index: 'my_index'
+  upsert_document 'my_id', type: 'my_type', index: 'my_index', source: { name: 'Santiago' }
+  update_document 'my_id', type: 'my_type', index: 'my_index', source: { age: 24 }
+  create_document d # this one will return error individually
+end
+response = repository.execute_bulk bulk_request
 ```
 
 **HOW TO** start a *resumable* scroll
@@ -103,6 +135,7 @@ mapping = Elasticated::Mapping.build do
     end
   end
 end
+mapping.to_h
 ```
 
 **HOW TO** configure the gem

data/Rakefile

@@ -3,4 +3,55 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task :default => :spec
+
+namespace :elasticsearch do
+  
+  require 'elasticsearch'
+  require 'elasticsearch/extensions/test/cluster'
+  require 'socket'
+
+  task :prepare_env do
+    hostname = Socket.gethostname rescue Time.now.to_i
+    ENV['TEST_CLUSTER_COMMAND']       ||= '/usr/share/elasticsearch/bin/elasticsearch'
+    ENV['TEST_CLUSTER_NAME']          ||= "elasticated-#{hostname}"
+    ENV['TEST_CLUSTER_PORT']          ||= '9250'
+    ENV['TEST_CLUSTER_NODES']         ||= '1'
+    # ENV['TEST_CLUSTER_NODE_NAME']     ||= 'node'
+    # ENV['TEST_CLUSTER_DATA']          ||= '/tmp/elasticsearch_test'
+    # ENV['TEST_CLUSTER_TMP']           ||= '/tmp'
+    # ENV['TEST_CLUSTER_LOGS']          ||= '/tmp/log/elasticsearch'
+    # ENV['TEST_CLUSTER_PARAMS']        ||= ''
+    # ENV['TEST_CLUSTER_MULTICAST']     ||= 'true'
+    # ENV['TEST_CLUSTER_TIMEOUT']       ||= 30
+    # ENV['TEST_CLUSTER_NETWORK_HOST']  ||= __default_network_host
+    # ENV['QUIET']                      ||= 'true'
+  end
+
+  desc 'Start Elasticsearch test cluster (See TEST_CLUSTER_* env vars)'
+  task start: :prepare_env do
+    Elasticsearch::Extensions::Test::Cluster.start unless Elasticsearch::Extensions::Test::Cluster.running?
+  end
+
+  desc 'Stop Elasticsearch test cluster'
+  task stop: :prepare_env do
+    Elasticsearch::Extensions::Test::Cluster.stop if Elasticsearch::Extensions::Test::Cluster.running?
+  end
+
+  desc 'Restart Elasticsearch test cluster'
+  task restart: :prepare_env do
+    Rake::Task['elasticsearch:stop'].invoke
+    Rake::Task['elasticsearch:start'].invoke
+  end
+
+  desc 'Show Elasticsearch test cluster status'
+  task status: :prepare_env do
+    puts Elasticsearch::Extensions::Test::Cluster.running? ? 'Running' : 'Stopped'
+  end
+
+  desc 'Show Elasticsearch test cluster environment variables'
+  task env: :prepare_env do
+    ENV.select { |k,v| k.start_with? 'TEST_CLUSTER_' }.each { |k,v| puts "#{k}=#{v}" }
+  end
+
+end

data/elasticated.gemspec

@@ -19,9 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rspec', '3.0.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'elasticsearch-extensions'
 
   spec.add_runtime_dependency 'elasticsearch'
   spec.add_runtime_dependency 'hash_ext', '~> 0.1.1'

data/lib/elasticated.rb

@@ -7,15 +7,19 @@ require_relative 'elasticated/loggers/silent_logger'
 require_relative 'elasticated/loggers/default_logger'
 
 require_relative 'elasticated/helpers'
-require_relative 'elasticated/block_evaluation'
-require_relative 'elasticated/clonable'
-require_relative 'elasticated/inspectionable'
+require_relative 'elasticated/enum'
+
+require_relative 'elasticated/mixins/block_evaluation'
+require_relative 'elasticated/mixins/clonable'
+require_relative 'elasticated/mixins/inspectionable'
+require_relative 'elasticated/mixins/configurable'
+
 require_relative 'elasticated/configuration'
-require_relative 'elasticated/configurable'
 
 # query conditions
 
 require_relative 'elasticated/conditions/standard_condition'
+require_relative 'elasticated/conditions/term_condition'
 require_relative 'elasticated/conditions/terms_condition'
 require_relative 'elasticated/conditions/wildcard_condition'
 require_relative 'elasticated/conditions/exists_condition'
@@ -30,10 +34,6 @@ require_relative 'elasticated/conditions/custom_condition'
 require_relative 'elasticated/delimiters/standard_field_delimiter'
 require_relative 'elasticated/delimiters/term_field_delimiter'
 require_relative 'elasticated/delimiters/date_field_delimiter'
-require_relative 'elasticated/term_delimiter_factory'
-require_relative 'elasticated/date_delimiter_factory'
-require_relative 'elasticated/delimiter_visitor'
-require_relative 'elasticated/strategy_params_for_query_service'
 
 # query components
 
@@ -83,6 +83,18 @@ require_relative 'elasticated/aggregations/top_hits_aggregation'
 
 require_relative 'elasticated/aggregations/custom_aggregation'
 
+# bulk requests
+
+require_relative 'elasticated/bulk_request'
+require_relative 'elasticated/bulk_request/response'
+require_relative 'elasticated/bulk_request/response_item'
+require_relative 'elasticated/bulk_actions/standard_action'
+require_relative 'elasticated/bulk_actions/index_action'
+require_relative 'elasticated/bulk_actions/create_action'
+require_relative 'elasticated/bulk_actions/update_action'
+require_relative 'elasticated/bulk_actions/upsert_action'
+require_relative 'elasticated/bulk_actions/delete_action'
+
 # repository
 
 require_relative 'elasticated/document'
@@ -116,20 +128,4 @@ module Elasticated
     block.call Configuration
   end
 
-  def self.date_delimiter_factory
-    @date_delimiter_factory ||= DateDelimiterFactory.new
-  end
-
-  def self.term_delimiter_factory
-    @term_delimiter_factory ||= TermDelimiterFactory.new
-  end
-
-  def self.delimiter_visitor
-    @delimiter_visitor ||= DelimiterVisitor.new
-  end
-
-  def self.strategy_params_for_query_service
-    @strategy_params_for_query_service ||= StrategyParamsForQueryService.new
-  end
-
 end

data/lib/elasticated/aggregation.rb

@@ -6,8 +6,9 @@ module Elasticated
     # child must implement 'build'
     # child must implement 'parse(response)'
 
-    include BlockEvaluation
-    include Clonable
+    include Mixins::Clonable
+    include Mixins::BlockEvaluation
+    include Mixins::Inspectionable
 
     attr_accessor :field, :alias_name, :extra_params
 
@@ -32,9 +33,5 @@ module Elasticated
       end
     end
 
-    def accept_visitor(visitor)
-      visitor.visit_aggregation(self)
-    end
-
   end
 end

data/lib/elasticated/aggregations/date_histogram_aggregation.rb

@@ -2,16 +2,21 @@ module Elasticated
   class DateHistogramAggregation < HistogramAggregation
     include Subaggregated
 
-    attr_accessor :format
+    attr_accessor :format, :offset
 
     def initialize(field, opts={}, &block)
       self.format = opts.delete(:format) || 'yyyy-MM-dd'
       interval = opts.delete(:interval) || 'day'
+      self.offset = opts.delete(:offset)
       super field, interval, opts, &block
     end
 
     def build
       terms = { field: field, interval: interval, format: format }
+      if offset # '1.4 style'
+        terms.merge! pre_offset: offset
+        terms.merge! post_offset: offset
+      end
       terms.merge! extra_params
       aggregation_struct = { date_histogram: terms }
       aggregation_struct.merge! build_subaggregations

data/lib/elasticated/aggregations/filter_aggregation.rb

@@ -2,13 +2,13 @@ module Elasticated
   class FilterAggregation < Aggregation
     include Subaggregated
 
-    attr_accessor :_evaluator, :_filter_name, :compact, :include_count
+    attr_accessor :_evaluator, :_filter_name, :compact
 
     def initialize(filter_name, *args, &block)
       self._filter_name  = filter_name
       super
       self.compact       = extra_params.delete(:compact) { false }
-      self.include_count = extra_params.delete(:include_count) { true }
+      raise "The 'include_count' parameter was removed in filter aggregations" if extra_params.has_key? :include_count
       initialize_subaggregations FilterAggregationEvaluator.new, &block
     end
 
@@ -26,19 +26,15 @@ module Elasticated
 
     def parse(response)
       count = response['doc_count']
-
-      if _subaggregations.empty?
-        compact ? count : { 'count' => count }
+      if compact && _subaggregations.empty?
+        count
       else
-        parse_subaggregations(response).tap do |h|
-          h['count'] = count if include_count
-        end
+        raise "Compact is not a valid parameter on a subaggregated 'filter' aggregation" if compact
+        body = { 'count' => count }
+        body.merge! parse_subaggregations(response)
+        body
       end
     end
 
-    def accept_visitor(visitor)
-      visitor.visit_filter_aggregation(self)
-    end
-
   end
 end

data/lib/elasticated/aggregations/filter_aggregation_evaluator.rb

@@ -1,7 +1,7 @@
 module Elasticated
   class FilterAggregationEvaluator < QueryAggregations
 
-    include BlockEvaluation
+    include Mixins::BlockEvaluation
 
     attr_accessor :_conditions
 

data/lib/elasticated/aggregations/group_aggregation.rb

@@ -2,12 +2,13 @@ module Elasticated
   class GroupAggregation < TermsAggregation
     include Subaggregated
 
-    attr_accessor :compact, :include_count
+    attr_accessor :compact, :key_as_string
 
     def initialize(field, *args, &block)
       super
       self.compact       = extra_params.delete(:compact) { false }
-      self.include_count = extra_params.delete(:include_count) { true }
+      self.key_as_string = extra_params.delete(:key_as_string) { false }
+      raise "The 'include_count' parameter was removed in group aggregations" if extra_params.has_key? :include_count
       initialize_subaggregations &block
     end
 
@@ -21,16 +22,18 @@ module Elasticated
 
     def parse(response)
       response['buckets'].each_with_object({}) do |bucket, hash|
+        key = bucket['key']
         count = bucket['doc_count']
-
-        hash[bucket['key']] =
-          if _subaggregations.empty?
-            compact ? count : { 'count' => count }
-          else
-            parse_subaggregations(bucket).tap do |h|
-              h['count'] = count if include_count
-            end
-          end
+        key_as_str = bucket['key_as_string']
+        hash[key] = if compact && _subaggregations.empty?
+          count
+        else
+          raise "Compact is not a valid parameter on a subaggregated 'terms' aggregation" if compact
+          body = { 'count' => count }
+          body.merge! 'key_as_string' => key_as_str if key_as_string
+          body.merge! parse_subaggregations bucket
+          body
+        end
       end
     end
 

data/lib/elasticated/aggregations/range_aggregation.rb

@@ -2,12 +2,12 @@ module Elasticated
   class RangeAggregation < Aggregation
     include Subaggregated
 
-    attr_accessor :_conditions, :compact, :include_count
+    attr_accessor :_conditions, :compact
 
     def initialize(field, *args, &block)
       super
       self.compact = extra_params.delete(:compact) { false }
-      self.include_count = extra_params.delete(:include_count) { true }
+      raise "The 'include_count' parameter was removed in range aggregations" if extra_params.has_key? :include_count
       initialize_subaggregations RangeAggregationEvaluator.new, &block
     end
 
@@ -28,15 +28,14 @@ module Elasticated
     def parse(response)
       response['buckets'].each_with_object({}) do |(key_name, values), hash|
         count = values['doc_count']
-
-        hash[key_name] =
-          if _subaggregations.empty?
-            compact ? count : { 'count' => count }
-          else
-            parse_subaggregations(values).tap do |h|
-              h['count'] = count if include_count
-            end
-          end
+        hash[key_name] = if compact && _subaggregations.empty?
+          count
+        else
+          raise "Compact is not a valid parameter on a subaggregated 'range' aggregation" if compact
+          body = { 'count' => count }
+          body.merge! parse_subaggregations(values)
+          body
+        end
       end
     end
 

data/lib/elasticated/aggregations/range_aggregation_evaluator.rb

@@ -1,7 +1,7 @@
 module Elasticated
   class RangeAggregationEvaluator < QueryAggregations
 
-    include BlockEvaluation
+    include Mixins::BlockEvaluation
 
     attr_accessor :_ranges_builder
 

data/lib/elasticated/aggregations/ranges_builder.rb

@@ -1,8 +1,8 @@
 module Elasticated
   class RangesBuilder
 
-    include Clonable
-    include BlockEvaluation
+    include Mixins::Clonable
+    include Mixins::BlockEvaluation
 
     attr_accessor :_ranges
 

data/lib/elasticated/aggregations/safe_date_histogram_aggregation.rb

@@ -4,9 +4,10 @@ module Elasticated
 
     DEFAULT_INTERVAL  = '1d'
 
-    attr_accessor :time_zone, :points, :compact, :include_count
+    attr_accessor :offset, :time_zone, :points, :compact, :include_count
 
     def initialize(field, opts={}, &block)
+      self.offset    = opts.delete(:offset)
       self.time_zone = opts.delete(:time_zone)
       self.points    = opts.fetch(:points)
       opts.delete(:points)
@@ -18,6 +19,10 @@ module Elasticated
 
     def build
       terms = { field: field, interval: safe_interval.to_s }
+      if offset # '1.4 style'
+        terms.merge! pre_offset: offset
+        terms.merge! post_offset: offset
+      end
       if time_zone
         terms.merge! time_zone: time_zone
       end
@@ -43,7 +48,7 @@ module Elasticated
         else
           parsed_subaggregations = parse_subaggregations(bucket)
           hash[key] = value_for(parsed_subaggregations, hash, key).tap do |h|
-            h['count'] = count if include_count
+            h['count'] = count #if include_count
           end
         end
       end