sequel-elasticsearch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1b9f57743a4f411f924497691250d65ef79dcec
+  data.tar.gz: cca07116bde1f723925469d8587a2cf8e303cb36
+SHA512:
+  metadata.gz: c099502b9b552e0399d9861ac24db496af9436a550a94d36561df4406af49b7567cad8c8e9b242e4240b075de1fb74255d33a1957deaa09e3d8839befee7a89b
+  data.tar.gz: 2bdc291308bda70e04a01ee04fc138417b73a37c4430f78495a194d3906f803ae7760813c46dadfa174dc18edf1a0dddf619d6ef84bef0f7969a26af1f3721da

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.*.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Metrics/LineLength:
+  Max: 120
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,29 @@
+sudo: false
+language: ruby
+rvm:
+- 2.3.6
+- 2.4.3
+- 2.5.0
+gemfile: Gemfile.ci
+env:
+  global:
+  - CC_TEST_REPORTER_ID=f35fd15664b071c621a239733eb3b063caf333ac7e795d3a20690942f64caf62
+before_install:
+- gem install bundler -v 1.13.6
+before_script:
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+  > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
+after_script:
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+deploy:
+  provider: rubygems
+  gem: sequel-elasticsearch
+  on:
+    tags: true
+    repo: jrgns/sequel-elasticsearch
+  api_key:
+    secure: xP8zLfBbDTTUpJP8DUL9llfGIGwuTkifmySfoTo7YHOoEC9hFhviT2+PdeoTLywjAIsIwjvghzB2rBERcAPkbu1ahVow9+/0n3jV4UmgRNm2bFcAlIEb8j2gSUlK/ETrIXRBUTUnMg60qhaxIIPd5VQY4eOv2EbmujUqfJgN6xJTTQkiuN4G/UK6Cbhi9d1YDcviY/un9XKIRZQuUvkHQ9vBpK2xJEmisymg0ljK/uj9/dAjKUtyZ7c3QKjcTcQeZ/YKxkKuwaTO5TyHTfKkzUS6M9wS280zbHj3KS98xYX1NTGqDTlq1YPPKAtedhh1+xiCoT50BcIFHmOAymTfvMeGrRQp4fxGOaLMV3q9hP91PAY/Eul3B4gJrAulDahc5xy4TECvM+GdIitNHWpXchH3iE70vWybjFFOTRrf4ftjh20BbeaGJG2FVLD4haC8Y73B6Q8Yf2/qu9Wc+vyXkCXRwiGBl+x1N1gmRoF2w5jyMfEnAJ/7wN4sTcLRvN8PViOKbZ9cNyjgsdwoJoqcH045HJhyRALl5pXeoTANzyPw7Dm2yGyzw2Rnv3TqJD4eeJr8dQyQgR83P7yl/GDrG493QY0Mkl8iMEmS/GFTX6L4p7qqiJqDYBtIuW4/XET2Ui7HrV/5midzTiC5nGNZdHkQkLNMlkIvaSpROXV058I=
+after_success:
+- bundle exec codeclimate-test-reporter

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequel-elasticsearch.gemspec
+gemspec

data/Gemfile.ci

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in proxes.gemspec
+gemspec
+
+gem 'sqlite3'

data/Gemfile.dev

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'elasticsearch'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'sequel'
+gem 'simplecov'
+gem 'webmock'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jurgens du Toit
+
+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,78 @@
+# Sequel::Elasticsearch
+
+Sequel::Elasticsearch allows you to transparently mirror your database, or specific tables, to Elasticsearch. It's especially useful if you want the power of search through Elasticsearch, but keep the sanity and structure of a relational database.
+
+[![Build Status](https://travis-ci.org/jrgns/sequel-elasticsearch.svg?branch=master)](https://travis-ci.org/jrgns/sequel-elasticsearch)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ff453fe81303a2fa7c02/maintainability)](https://codeclimate.com/github/jrgns/sequel-elasticsearch/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ff453fe81303a2fa7c02/test_coverage)](https://codeclimate.com/github/jrgns/sequel-elasticsearch/test_coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel-elasticsearch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-elasticsearch
+
+## Usage
+
+You firstly need an Elasticsearch cluster to sync your data to. By default the gem will try to connect to `http://localhost:9200`. Set the `ELASTICSEARCH_URL` ENV variable to the URL of your cluster.
+
+This is a Sequel plugin, so you can enable it DB wide:
+
+```ruby
+Sequel::Model.plugin :elasticsearch
+
+```
+
+Or per model:
+
+```ruby
+Sequel::Model.plugin Sequel::Elasticsearch
+
+# or
+
+class Node < Sequel::Model
+  plugin :elasticsearch
+end
+```
+
+There's a couple of options you can set:
+
+```ruby
+Sequel::Model.plugin :elasticsearch,
+  elasticsearch: { log: true }, # Options to pass the the Elasticsearch ruby client
+  index: 'all-my-data', # The index in which the data should be stored. Defaults to the table name associated with the model
+  type: 'is-mine' # The type in which the data should be stored.
+```
+
+And that's it! Just transact as you normally would, and your records will be created and updated in the Elasticsearch cluster.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jrgns/sequel-elasticsearch.
+
+Features that needs to be built:
+
+- [ ] Asynchronous workers so that the updates can be processed in the background.
+- [ ] An `es` method to search through the data on the cluster.
+- [ ] A rake task to create or suggest mappings for a table.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+libdir = File.expand_path(File.dirname(__FILE__) + '/lib')
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'bundler/gem_tasks'
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  puts 'Did not load RSpec'
+end
+
+task default: :spec

data/lib/sequel/plugins/elasticsearch.rb

@@ -0,0 +1,72 @@
+require 'elasticsearch'
+
+module Sequel
+  module Plugins
+    module Elasticsearch
+      def self.apply(model, _opts = OPTS)
+        model.instance_variable_set(:@elasticsearch_opts, {})
+        model.instance_variable_set(:@elasticsearch_index, nil)
+        model.instance_variable_set(:@elasticsearch_type, 'sync')
+        model
+      end
+
+      def self.configure(model, opts = OPTS)
+        model.elasticsearch_opts = opts[:elasticsearch] || {}
+        model.elasticsearch_index = (opts[:index] || model.table_name).to_sym
+        model.elasticsearch_type = (opts[:type] || :sync).to_sym
+        model
+      end
+
+      module ClassMethods
+        attr_accessor :elasticsearch_opts, :elasticsearch_index, :elasticsearch_type
+      end
+
+      module InstanceMethods
+        def after_create
+          super
+          index_document
+        end
+
+        def after_destroy
+          super
+          destroy_document
+        end
+
+        def after_update
+          super
+          index_document
+        end
+
+        def es_client
+          @es_client = ::Elasticsearch::Client.new self.class.elasticsearch_opts
+        end
+
+        private
+
+        def document_id
+          doc_id = pk
+          doc_id = doc_id.join('_') if doc_id.is_a? Array
+          doc_id
+        end
+
+        def document_path
+          {
+            index: self.class.elasticsearch_index,
+            type: self.class.elasticsearch_type,
+            id: document_id
+          }
+        end
+
+        def index_document
+          params = document_path
+          params[:body] = values
+          es_client.index params
+        end
+
+        def destroy_document
+          es_client.delete document_path
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/elasticsearch/version.rb

@@ -0,0 +1,5 @@
+module Sequel
+  module Elasticsearch
+    VERSION = '0.1.0'.freeze
+  end
+end

data/sequel-elasticsearch.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel/plugins/elasticsearch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sequel-elasticsearch'
+  spec.version       = Sequel::Elasticsearch::VERSION
+  spec.authors       = ['Jurgens du Toit']
+  spec.email         = ['jrgns@jadeit.co.za']
+
+  spec.summary       = 'A plugin for the Sequel gem to sync data to Elasticsearch.'
+  spec.description   = 'A plugin for the Sequel gem to sync data to Elasticsearch.'
+  spec.homepage      = 'https://github.com/jrgns/sequel-elasticsearch'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'elasticsearch', '~> 6.0'
+  spec.add_dependency 'sequel', '~> 5.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'simplecov', '~> 0.15'
+  spec.add_development_dependency 'webmock', '~> 3.2'
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: sequel-elasticsearch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jurgens du Toit
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+description: A plugin for the Sequel gem to sync data to Elasticsearch.
+email:
+- jrgns@jadeit.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.ci
+- Gemfile.dev
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequel/plugins/elasticsearch.rb
+- lib/sequel/plugins/elasticsearch/version.rb
+- sequel-elasticsearch.gemspec
+homepage: https://github.com/jrgns/sequel-elasticsearch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A plugin for the Sequel gem to sync data to Elasticsearch.
+test_files: []