rom-elasticsearch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ea7ae9dbc43c75ca9583e5df195db789ea28430
+  data.tar.gz: 2d1b2523c9acc5c248b1841685588c73943e8990
+SHA512:
+  metadata.gz: 887ffb629635a427b714a6e66cc8f4ba54251efa5b17ec8c70d1f8704f9b79de460b30402c437b38bb0da75b09d860e1ae5048f6feda933d5560b029f85fae9d
+  data.tar.gz: 46b872af00f24af35f1ea18cfbcda7dc5d2b2fedbdeea110c08c142c7199424d80218a7deab7c65e3fdfab90271320a2e6fa25eaf9e219856465a8f76ec9bc60

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order random
+--require ./spec/spec_helper.rb

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+sudo: false
+cache: bundler
+services:
+  - elasticsearch
+bundler_args: --without yard guard benchmarks tools
+before_script:
+  - curl -XPUT http://localhost:9200/rom-test
+script: "bundle exec rake ci"
+rvm:
+  - 2.3.4
+  - 2.4.1
+  - jruby-9.1.12.0
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+    - COVERAGE='true'
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/39e1225f489f38b0bd09
+    on_success: change
+    on_failure: always
+    on_start: false

data/.yardopts

@@ -0,0 +1,7 @@
+--plugin junk
+--query '@api.text != "private"'
+--embed-mixins
+-r README.md
+--markup-provider=redcarpet
+--markup=markdown
+--files CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0 2017-11-17
+
+First public release

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discourse.rom-rb.org](https://discourse.rom-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discourse.rom-rb.org](http://discourse.rom-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/rom-rb/rom-rb.org](https://github.com/rom-rb/rom-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.rom-rb.org](https://discourse.rom-rb.org).

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rom-elasticsearch.gemspec
+gemspec
+
+gem 'rom', git: 'https://github.com/rom-rb/rom', branch: 'master' do
+  gem 'rom-core'
+  gem 'rom-mapper'
+end
+
+gem 'codeclimate-test-reporter', require: false
+gem 'simplecov', require: false
+
+gem 'pry-byebug', platform: :mri
+gem 'pry', platform: :jruby
+gem 'elasticsearch-dsl'
+
+group :tools do
+  gem 'kramdown' # for yard
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) rom-rb team
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+[gem]: https://rubygems.org/gems/rom-elasticsearch
+[travis]: https://travis-ci.org/rom-rb/rom-elasticsearch
+[gemnasium]: https://gemnasium.com/rom-rb/rom-elasticsearch
+[codeclimate]: https://codeclimate.com/github/rom-rb/rom-elasticsearch
+[inchpages]: http://inch-ci.org/github/rom-rb/rom-elasticsearch
+
+# rom-elasticsearch
+
+[![Gem Version](https://badge.fury.io/rb/rom-elasticsearch.svg)][gem]
+[![Build Status](https://travis-ci.org/rom-rb/rom-elasticsearch.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/rom-rb/rom-elasticsearch.svg)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/rom-rb/rom-elasticsearch/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/rom-rb/rom-elasticsearch/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/rom-rb/rom-elasticsearch.svg?branch=master)][inchpages]
+
+ElasticSearch support for [rom-rb](https://github.com/rom-rb/rom).
+
+Resources:
+
+- [API Documentation](http://api.rom-rb.org/rom-elasticsearch)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rom-elasticsearch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rom-elasticsearch
+
+## License
+
+See `LICENSE` file.

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: [:ci]
+
+desc "Run CI tasks"
+task ci: [:spec]
+
+begin
+  require "rubocop/rake_task"
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << "--display-cop-names"
+  end
+rescue LoadError
+end

data/lib/rom-elasticsearch.rb

@@ -0,0 +1 @@
+require 'rom/elasticsearch'

data/lib/rom/elasticsearch.rb

@@ -0,0 +1,8 @@
+require 'rom'
+
+require 'rom/elasticsearch/version'
+require 'rom/elasticsearch/gateway'
+require 'rom/elasticsearch/relation'
+require 'rom/elasticsearch/commands'
+
+ROM.register_adapter(:elasticsearch, ROM::Elasticsearch)

data/lib/rom/elasticsearch/attribute.rb

@@ -0,0 +1,30 @@
+require 'rom/attribute'
+
+module ROM
+  module Elasticsearch
+    # ES-specific attribute types for schemas
+    #
+    # @api public
+    class Attribute < ROM::Attribute
+      INTERNAL_META_KEYS = %i[name source primary_key].freeze
+
+      # Return ES mapping properties
+      #
+      # @return [Hash]
+      #
+      # @api public
+      memoize def properties
+        type.meta.reject { |k, _| INTERNAL_META_KEYS.include?(k) }
+      end
+
+      # Return if an attribute has any ES mappings
+      #
+      # @return [Bool]
+      #
+      # @api public
+      def properties?
+        properties.size > 0
+      end
+    end
+  end
+end

data/lib/rom/elasticsearch/commands.rb

@@ -0,0 +1,49 @@
+require 'rom/commands'
+
+module ROM
+  module Elasticsearch
+    # ElasticSearch relation commands
+    #
+    # @api public
+    class Commands
+      # Create command
+      #
+      # @api public
+      class Create < ROM::Commands::Create
+        # @api private
+        def execute(attributes)
+          tuple = input[attributes]
+
+          result =
+            if _id
+              dataset.params(id: tuple.fetch(_id)).put(tuple)
+            else
+              dataset.put(tuple)
+            end
+          [relation.get(result['_id']).one]
+        end
+
+        private
+
+        # @api private
+        def dataset
+          relation.dataset
+        end
+
+        def _id
+          relation.schema.primary_key_name
+        end
+      end
+
+      # Delete command
+      #
+      # @api public
+      class Delete < ROM::Commands::Delete
+        # @api private
+        def execute
+          relation.dataset.delete
+        end
+      end
+    end
+  end
+end

data/lib/rom/elasticsearch/dataset.rb

@@ -0,0 +1,219 @@
+require 'rom/initializer'
+
+require 'rom/elasticsearch/query_methods'
+require 'rom/elasticsearch/errors'
+
+module ROM
+  module Elasticsearch
+    # Elasticsearch dataset
+    #
+    # Uses an elasticsearch client object provided by the gateway, holds basic
+    # params with information about index name and type, and optional body for
+    # additional queries.
+    #
+    # Dataset object also provide meta information about indices, like custom
+    # settings and mappings.
+    #
+    # @api public
+    class Dataset
+      extend Initializer
+
+      include QueryMethods
+
+      # Default query options
+      ALL = { query: { match_all: EMPTY_HASH } }.freeze
+
+      # The source key in raw results
+      SOURCE_KEY = '_source'.freeze
+
+      # @!attribute [r] client
+      #   @return [::Elasticsearch::Client] configured client from the gateway
+      param :client
+
+      # @!attribute [r] params
+      #   @return [Hash] default params
+      option :params, default: -> { EMPTY_HASH }
+
+      # @!attribute [r] client
+      #   @return [Hash] default body
+      option :body, default: -> { EMPTY_HASH }
+
+      # Put new data under configured index
+      #
+      # @param [Hash] data
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def put(data)
+        client.index(**params, body: data)
+      end
+
+      # Return index settings
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def settings
+        client.indices.get_settings[index.to_s]['settings']['index']
+      end
+
+      # Return index mappings
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def mappings
+        client.indices.get_mapping[index.to_s]['mappings'][type.to_s]
+      end
+
+      # Delete everything matching configured params and/or body
+      #
+      # If body is empty it *will delete everything**
+      #
+      # @return [Hash] raw response hash from the client
+      #
+      # @api public
+      def delete
+        if body.empty? && params[:id]
+          client.delete(params)
+        elsif body.empty?
+          client.delete_by_query(params.merge(body: body.merge(ALL)))
+        else
+          client.delete_by_query(params.merge(body: body))
+        end
+      end
+
+      # Materialize the dataset
+      #
+      # @return [Array<Hash>]
+      #
+      # @api public
+      def to_a
+        to_enum.to_a
+      end
+
+      # Materialize and iterate over results
+      #
+      # @yieldparam [Hash]
+      #
+      # @raise [SearchError] in case of the client raising an exception
+      #
+      # @api public
+      def each
+        return to_enum unless block_given?
+        view.each do |result|
+          yield(result[SOURCE_KEY])
+        end
+      rescue ::Elasticsearch::Transport::Transport::Error => e
+        raise SearchError.new(e, options)
+      end
+
+      # Map dataset tuples
+      #
+      # @yieldparam [Hash]
+      #
+      # @return [Array]
+      #
+      # @api public
+      def map(&block)
+        to_a.map(&block)
+      end
+
+      # Return configured type from params
+      #
+      # @return [Symbol]
+      #
+      # @api public
+      def type
+        params[:type]
+      end
+
+      # Return configured index name
+      #
+      # @return [Symbol]
+      #
+      # @api public
+      def index
+        params[:index]
+      end
+
+      # Return a new dataset with new body
+      #
+      # @param [Hash] new New body data
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def body(new = nil)
+        if new.nil?
+          @body
+        else
+          with(body: body.merge(new))
+        end
+      end
+
+      # Return a new dataset with new params
+      #
+      # @param [Hash] new New params data
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def params(new = nil)
+        if new.nil?
+          @params
+        else
+          with(params: params.merge(new))
+        end
+      end
+
+      # Refresh index
+      #
+      # @return [Dataset]
+      #
+      # @api public
+      def refresh
+        client.indices.refresh(index: index)
+        self
+      end
+
+      # Create an index
+      #
+      # @param [Hash] opts ES options
+      #
+      # @api public
+      #
+      # @return [Hash]
+      def create_index(opts = EMPTY_HASH)
+        client.indices.create(params.merge(opts))
+      end
+
+      # Delete an index
+      #
+      # @param [Hash] opts ES options
+      #
+      # @api public
+      #
+      # @return [Hash]
+      def delete_index(opts = EMPTY_HASH)
+        client.indices.delete(params.merge(opts))
+      end
+
+      private
+
+      # Return results of a query based on configured params and body
+      #
+      # @return [Array<Hash>]
+      #
+      # @api private
+      def view
+        if params[:id]
+          [client.get(params)]
+        else
+          client.search(**params, body: body).fetch('hits').fetch('hits')
+        end
+      end
+    end
+  end
+end