elastic-rails 0.1.0 → 0.5.0

data/lib/elastic.rb

@@ -1,44 +1,86 @@
 require "elasticsearch"
+
 require "elastic/version"
+require "elastic/configuration"
 
-require "elastic/capabilities/aggregation_builder"
-require "elastic/capabilities/bool_query_builder"
-require "elastic/capabilities/context_handler"
+require "elastic/support/command"
+require "elastic/support/transform"
+require "elastic/support/traversable"
 
-require "elastic/index"
-require "elastic/type"
-require "elastic/query"
-require "elastic/histogram"
-require "elastic/value_transform"
-require "elastic/indexable"
-require "elastic/indexable_record"
+require "elastic/commands/import_index_documents"
+require "elastic/commands/build_query_from_params"
+require "elastic/commands/build_agg_from_params"
 
-module Elastic
-  extend self
+require "elastic/results/base"
+require "elastic/results/aggregations"
+require "elastic/results/hit"
+require "elastic/results/hit_collection"
+require "elastic/results/metric"
+require "elastic/results/bucket_collection"
+require "elastic/results/bucket"
+require "elastic/results/grouped_result"
+require "elastic/results/result_group"
+require "elastic/results/root"
 
-  def connect(_index = nil)
-    Elastic::Index.new api_client, (_index || default_index).to_s
-  end
+require "elastic/nodes/base"
+require "elastic/nodes/base_agg"
+require "elastic/nodes/search"
+require "elastic/nodes/term"
+require "elastic/nodes/range"
+require "elastic/nodes/match"
+require "elastic/nodes/and"
+require "elastic/nodes/or"
+require "elastic/nodes/boolean"
+require "elastic/nodes/function_score"
+require "elastic/nodes/nested"
+require "elastic/nodes/agg/base_metric"
+require "elastic/nodes/agg/stats"
+require "elastic/nodes/agg/average"
+require "elastic/nodes/agg/minimum"
+require "elastic/nodes/agg/maximum"
+require "elastic/nodes/agg/sum"
+require "elastic/nodes/agg/terms"
+require "elastic/nodes/agg/date_histogram"
+require "elastic/nodes/agg/top_hits"
 
-  private
+require "elastic/shims/base"
+require "elastic/shims/populating"
+require "elastic/shims/grouping"
+require "elastic/shims/reducing"
 
-  def config
-    Rails.application.config_for(:elastic)
-  end
+require "elastic/fields/value"
+require "elastic/fields/nested"
 
-  def default_index
-    config['index']
-  end
+require "elastic/core/definition"
+require "elastic/core/adaptor"
+require "elastic/core/mapping_manager"
+require "elastic/core/serializer"
+require "elastic/core/middleware"
+require "elastic/core/base_middleware"
+require "elastic/core/default_middleware"
+require "elastic/core/source_formatter"
+require "elastic/core/query_config"
+require "elastic/core/query_assembler"
 
-  def api_client
-    @api_client ||= load_api_client
+require "elastic/dsl/bool_query_builder"
+require "elastic/dsl/bool_query_context"
+require "elastic/dsl/metric_builder"
+
+require "elastic/types/base_type"
+require "elastic/types/faceted_type"
+require "elastic/types/nestable_type"
+require "elastic/type"
+require "elastic/nested_type"
+require "elastic/query"
+
+module Elastic
+  def self.configure(*_args)
+    Configuration.configure(*_args)
   end
 
-  def load_api_client
-    uri = config['url'] ? URI(config['url']) : nil
-    Elasticsearch::Client.new(
-      host: uri ? uri.host : config['host'],
-      port: uri ? uri.port : config['port']
-    )
+  def self.register_middleware(_middleware)
+    Core::Middleware.register _middleware
   end
 end
+
+require "elastic/railtie" if defined? Rails

data/lib/generators/elastic/index_generator.rb

@@ -0,0 +1,10 @@
+module Elastic
+  class IndexGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "This generator creates a new model index definition at app/indices"
+    def create_index
+      template('index.rb', "app/indices/#{file_name.underscore}_index.rb")
+    end
+  end
+end

data/lib/generators/elastic/templates/index.rb

@@ -0,0 +1,17 @@
+class <%= class_name %>Index < Elastic::Type
+  # Index model fields by adding field definitions.
+  #
+  # Some examples:
+  #
+  # fields :foo, :bar
+  # field :timestamp, type: :date
+  # field :category, type: :term
+  # field :complex, transform: -> { "#{property_1}/#{property_2}" }
+  # field :custom
+  #
+  # def custom
+  #   "foobar"
+  # end
+  #
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ignacio Baixas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,48 +27,183 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.18
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.2'
 description: Elasticsearch integration for Ruby on Rails by Platanus
 email:
 - ignacio@platan.us
@@ -78,6 +216,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -86,17 +225,84 @@ files:
 - elastic.gemspec
 - lib/elastic-rails.rb
 - lib/elastic.rb
-- lib/elastic/capabilities/aggregation_builder.rb
-- lib/elastic/capabilities/bool_query_builder.rb
-- lib/elastic/capabilities/context_handler.rb
-- lib/elastic/histogram.rb
-- lib/elastic/index.rb
-- lib/elastic/indexable.rb
-- lib/elastic/indexable_record.rb
+- lib/elastic/commands/build_agg_from_params.rb
+- lib/elastic/commands/build_query_from_params.rb
+- lib/elastic/commands/import_index_documents.rb
+- lib/elastic/configuration.rb
+- lib/elastic/core/adaptor.rb
+- lib/elastic/core/base_middleware.rb
+- lib/elastic/core/default_middleware.rb
+- lib/elastic/core/definition.rb
+- lib/elastic/core/mapping_manager.rb
+- lib/elastic/core/middleware.rb
+- lib/elastic/core/query_assembler.rb
+- lib/elastic/core/query_config.rb
+- lib/elastic/core/serializer.rb
+- lib/elastic/core/source_formatter.rb
+- lib/elastic/dsl/bool_query_builder.rb
+- lib/elastic/dsl/bool_query_context.rb
+- lib/elastic/dsl/metric_builder.rb
+- lib/elastic/fields/nested.rb
+- lib/elastic/fields/value.rb
+- lib/elastic/nested_type.rb
+- lib/elastic/nodes/agg/average.rb
+- lib/elastic/nodes/agg/base_metric.rb
+- lib/elastic/nodes/agg/date_histogram.rb
+- lib/elastic/nodes/agg/maximum.rb
+- lib/elastic/nodes/agg/minimum.rb
+- lib/elastic/nodes/agg/stats.rb
+- lib/elastic/nodes/agg/sum.rb
+- lib/elastic/nodes/agg/terms.rb
+- lib/elastic/nodes/agg/top_hits.rb
+- lib/elastic/nodes/and.rb
+- lib/elastic/nodes/base.rb
+- lib/elastic/nodes/base_agg.rb
+- lib/elastic/nodes/boolean.rb
+- lib/elastic/nodes/concerns/aggregable.rb
+- lib/elastic/nodes/concerns/boostable.rb
+- lib/elastic/nodes/concerns/bucketed.rb
+- lib/elastic/nodes/concerns/hit_provider.rb
+- lib/elastic/nodes/function_score.rb
+- lib/elastic/nodes/match.rb
+- lib/elastic/nodes/nested.rb
+- lib/elastic/nodes/or.rb
+- lib/elastic/nodes/range.rb
+- lib/elastic/nodes/search.rb
+- lib/elastic/nodes/term.rb
 - lib/elastic/query.rb
+- lib/elastic/railtie.rb
+- lib/elastic/railties/ar_helpers.rb
+- lib/elastic/railties/ar_middleware.rb
+- lib/elastic/railties/indexable_record.rb
+- lib/elastic/railties/query_extensions.rb
+- lib/elastic/railties/rspec.rb
+- lib/elastic/railties/tasks/es.rake
+- lib/elastic/railties/type_extensions.rb
+- lib/elastic/railties/utils.rb
+- lib/elastic/results/aggregations.rb
+- lib/elastic/results/base.rb
+- lib/elastic/results/bucket.rb
+- lib/elastic/results/bucket_collection.rb
+- lib/elastic/results/grouped_result.rb
+- lib/elastic/results/hit.rb
+- lib/elastic/results/hit_collection.rb
+- lib/elastic/results/metric.rb
+- lib/elastic/results/result_group.rb
+- lib/elastic/results/root.rb
+- lib/elastic/shims/base.rb
+- lib/elastic/shims/grouping.rb
+- lib/elastic/shims/populating.rb
+- lib/elastic/shims/reducing.rb
+- lib/elastic/support/command.rb
+- lib/elastic/support/transform.rb
+- lib/elastic/support/traversable.rb
 - lib/elastic/type.rb
-- lib/elastic/value_transform.rb
+- lib/elastic/types/base_type.rb
+- lib/elastic/types/faceted_type.rb
+- lib/elastic/types/nestable_type.rb
 - lib/elastic/version.rb
+- lib/generators/elastic/index_generator.rb
+- lib/generators/elastic/templates/index.rb
 homepage: https://github.com/surbtc/elastic-rails
 licenses:
 - MIT

data/lib/elastic/capabilities/aggregation_builder.rb

@@ -1,64 +0,0 @@
-module Elastic::Capabilities
-  module AggregationBuilder
-    def aggregate_in(_name)
-      set_context(:aggregate, _name)
-    end
-
-    def aggregate
-      set_context(:aggregate, nil)
-    end
-
-    def sum_of(_field)
-      with_context(:aggregate, :sum_of) do |name|
-        register_aggregation(name || _field, { "sum" => { "field" => _field } })
-      end
-    end
-
-    def minimum_for(_field)
-      with_context(:aggregate, :minimum_for) do |name|
-        register_aggregation(name || _field, { "min" => { "field" => _field } })
-      end
-    end
-
-    def maximum_for(_field)
-      with_context(:aggregate, :maximum_for) do |name|
-        register_aggregation(name || _field, { "max" => { "field" => _field } })
-      end
-    end
-
-    def average_for(_field)
-      with_context(:aggregate, :average_for) do |name|
-        register_aggregation(name || _field, { "avg" => { "field" => _field } })
-      end
-    end
-
-    def date_histogram_for(_field, resolution: '1d', &_block)
-      with_context(:aggregate, :date_histogram_for) do |name|
-        histogram = Elastic::Histogram.new _field, resolution
-        _block.call(histogram) if _block
-        register_aggregation(name || _field, histogram)
-        return histogram unless _block
-      end
-    end
-
-    private
-
-    def aggregations
-      @aggregations ||= []
-    end
-
-    def register_aggregation(_name, _definition)
-      aggregations << [_name, _definition]
-    end
-
-    def render_aggregations_to(_to)
-      return if aggregations.length == 0
-
-      _to['aggs'] = aggs = {}
-
-      aggregations.each do |name, definition|
-        aggs[name] = definition.respond_to?(:render) ? definition.render : definition
-      end
-    end
-  end
-end

data/lib/elastic/capabilities/bool_query_builder.rb

@@ -1,74 +0,0 @@
-module Elastic::Capabilities
-  module BoolQueryBuilder
-    def minimum_should_match
-      @minimum_should_match || 1
-    end
-
-    def minimum_should_match=(_value)
-      @minimum_should_match = _value
-    end
-
-    def should_have(_field)
-      set_context(:should_have, [should_parts, _field])
-    end
-
-    def must_have(_field)
-      set_context(:must_have, [must_parts, _field])
-    end
-
-    def in(*_terms)
-      with_context([:should_have, :must_have], :in) do |context, field|
-        raise ArgumentError, 'must provide at least one term' if _terms.length == 0
-
-        _terms = _terms.map { |t| transform_input(field, t) }
-
-        context << (_terms.length > 1 ?
-          { "terms" => { field.to_s => _terms } } :
-          { "term" => { field.to_s => _terms.first } }
-        )
-      end
-    end
-
-    alias :equal_to :in
-
-    def in_range(_range)
-      with_context([:should_have, :must_have], :in_range) do |context, field|
-        options = { }
-
-        case _range
-        when Range
-          options['gte'] = _range.begin
-          options['lt'] = _range.end if _range.exclude_end?
-          options['lte'] = _range.end if !_range.exclude_end?
-        when Hash
-          [:gte, :gt, :lte, :lt].each do |opt|
-            options[opt.to_s] = _range[opt] if _range.key? opt
-          end
-        else
-          raise ArgumentError, 'must provide a range or a set of options'
-        end
-
-        context << { "range" => { field.to_s => options } }
-      end
-    end
-
-    private
-
-    def must_parts
-      @must_parts ||= []
-    end
-
-    def should_parts
-      @should_parts ||= []
-    end
-
-    def render_bool_query_to(_to)
-      return if should_parts.length == 0 && must_parts.length == 0
-
-      bool = _to['bool'] = {}
-      bool['must'] = must_parts if must_parts.length > 0
-      bool['should'] = should_parts if should_parts.length > 0
-      bool['minimum_should_match'] = minimum_should_match if should_parts.length > 0
-    end
-  end
-end

data/lib/elastic/capabilities/context_handler.rb

@@ -1,31 +0,0 @@
-module Elastic::Capabilities
-  module ContextHandler
-    private
-
-    def set_context(_name, _data)
-      unless @context_name.nil?
-        raise ArgumentError, "#{_name} should not be called right after #{@context_name}"
-      end
-
-      @context_name = _name.to_sym
-      @context_data = _data
-      self
-    end
-
-    def with_context(_names, _caller)
-      _names = [_names] unless _names.is_a? Array
-      _names = _names.map(&:to_sym)
-
-      if @context_name.nil?
-        raise ArgumentError, "#{_caller} should be called after #{_names.join(' or ')}"
-      elsif !_names.include? @context_name
-        raise ArgumentError, "#{_caller} should not be called after #{@context_name}"
-      end
-
-      yield @context_data
-      return self
-    ensure
-      @context_name = @context_data = nil
-    end
-  end
-end

data/lib/elastic/histogram.rb

@@ -1,49 +0,0 @@
-module Elastic
-  class Histogram
-    include Capabilities::ContextHandler
-    include Capabilities::AggregationBuilder
-
-    attr_accessor :resolution
-
-    def initialize(_time_field, _resolution)
-      @time_field = _time_field
-      @resolution = _resolution
-    end
-
-    def open_for(_field)
-      with_context(:aggregate, :open_for) do |name|
-        register_aggregation(name, {
-          top_hits: {
-            sort: [{ @time_field => { order: "asc" } }],
-            _source: { include: [ _field ]  },
-            size: 1
-          }
-        })
-      end
-    end
-
-    def close_for(_field)
-      with_context(:aggregate, :close_for) do |name|
-        register_aggregation(name, {
-          top_hits: {
-            sort: [{ @time_field => { order: "desc" } }],
-            _source: { include: [ _field ]  },
-            size: 1
-          }
-        })
-      end
-    end
-
-    def render
-      json = {
-        date_histogram: {
-          field: @time_field,
-          interval: @resolution,
-        }
-      }
-
-      render_aggregations_to json
-      json
-    end
-  end
-end