elastify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3d823100945b0cb9a6129108a9505b2679e634c
+  data.tar.gz: 80b3798a246a0262592c94c47983a7cf26ddb949
+SHA512:
+  metadata.gz: 6b2d472e359aa8db1176980b981305cbc63c0b4789024f68836394b1b5b868b4535635fc17e8947f37ccf0d42a535b04ac366fd6b8548b3f8fb16b9f9879740d
+  data.tar.gz: d6878c1a436b7fdc189a0240964f7aab64b133235e6187305c1c766e4e0053e1124e2b32c1b01be15e23b19a1541f5bf07688f1778c99649acfb97041d388cc1

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,41 @@
+# Elastify
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/elastify`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elastify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elastify
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/elastify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elastify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elastify.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elastify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elastify"
+  spec.version       = Elastify::VERSION
+  spec.authors       = ["Bruno Bortolotti Ribeiro"]
+  spec.email         = ["b2bortolotti@gmail.com"]
+
+  spec.summary       = %q{A gem to help with ActiveRecord-ElasticSeach integration}
+  spec.description   = %q{A gem to help with ActiveRecord-ElasticSeach integration}
+  spec.homepage      = "https://github.com/brunobortolotti/elastify.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_runtime_dependency "activerecord", ">= 3.0.5"
+  spec.add_runtime_dependency "httparty", ">= 0.6.0"
+  spec.add_runtime_dependency "backgrounded", ">= 2.0.0"
+  spec.add_runtime_dependency "multi_json", ">= 1.0.0"
+  spec.add_runtime_dependency "rest-client", ["~> 2.0", ">= 2.0.1"]
+  
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "shoulda", "2.11.3"
+  spec.add_development_dependency "mocha", "0.10.0"
+  spec.add_development_dependency "pry", "0.9.9.3"
+end

data/lib/elastify.rb

@@ -0,0 +1,13 @@
+require "elastify/version"
+require "elastify/active_record_extensions"
+
+module Elastify
+    cattr_accessor :defaults
+    
+
+    class << self
+        
+    end
+
+    class ElastifyError < StandardError; end
+end

data/lib/elastify/active_record_extensions.rb

@@ -0,0 +1,94 @@
+require 'active_record'
+require 'backgrounded'
+require 'elastify/elastic_search_helper'
+
+module Elastify
+    module ActiveRecordExtensions
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+            def elastify options = {}, &block
+                include Elastify::ActiveRecordExtensions::LocalMethods
+                cattr_accessor :options, :elastify_model_block
+                attr_accessor :elastify_serialized_document
+
+                self.options = {
+                    base_url: Elastify.defaults[:base_url],
+                    index: options[:index] || Elastify.defaults[:default_index],
+                    type: options[:type] || Elastify.defaults[:default_type]
+                }
+
+                self.options.each do |key, value|
+                    if value.blank? 
+                        raise ElastifyError, "You must specify the #{key} value"
+                    end
+                end 
+
+                if block_given?
+                    self.elastify_model_block = block
+                else 
+                    self.elastify_model_block = Proc.new { |item|
+                        next Hash.new
+                    }
+                end
+            end
+
+            
+        end
+
+        module LocalMethods
+            extend ActiveSupport::Concern
+            
+            included do
+                define_model_callbacks :elastify_create
+                define_model_callbacks :elastify_update
+                define_model_callbacks :elastify_destroy
+                define_model_callbacks :elastify_sync
+                # define_model_callbacks :elastify_serialize
+
+                after_create { |item|
+                    run_callbacks(:elastify_sync) do 
+                        if not item.elastify_serialized_document.blank?
+                            run_callbacks(:elastify_create) do
+                                ElasticSearchHelper::Document.new(self.options).create(item.elastify_serialized_document)
+                            end
+                        end
+                    end
+                }
+
+                after_update { |item|
+                    run_callbacks(:elastify_sync) do 
+                        if not item.elastify_serialized_document.blank?
+                            run_callbacks(:elastify_update) do
+                                ElasticSearchHelper::Document.new(self.options).update(item.elastify_serialized_document)
+                            end
+                        end
+                    end
+                }
+
+                after_destroy { |item|
+                    run_callbacks(:elastify_sync) do 
+                        if not item.elastify_serialized_document.blank?
+                            run_callbacks(:elastify_destroy) do
+                                ElasticSearchHelper::Document.new(self.options).destroy(item.elastify_serialized_document)
+                            end
+                        end
+                    end
+                }
+
+                before_elastify_sync { |item|
+                    item.elastify_serialized_document = self.elastify_model_block.call(item)
+                }
+            end 
+
+            module ClassMethods
+                def elastifind dsl
+                    return ElasticSearchHelper::Document.new(self.options).search(dsl)
+                end
+            end
+        end
+
+    end
+end
+
+ActiveRecord::Base.send(:include, Elastify::ActiveRecordExtensions)

data/lib/elastify/elastic_search_helper.rb

@@ -0,0 +1,89 @@
+module Elastify 
+    module ElasticSearchHelper 
+        class Document
+            cattr_accessor :options
+            def initialize options = {}
+                self.options = options
+            end
+            def create model
+                Connector.create self.options, model
+            end
+            def update model
+                Connector.update self.options, model
+            end
+            def destroy model
+                Connector.destroy self.options, model
+            end
+            def search dsl
+                Connector.search self.options, dsl
+            end
+        end
+        class Connector
+            def self.create options, data
+                if data.blank?
+                    raise :elastify__create__required_data
+                end
+                if data[:id].blank?
+                    raise :elastify__create__required_data_id
+                end
+                url = "#{options[:base_url]}/#{options[:index]}/#{options[:type]}/#{data[:id]}"
+                response = JSON.parse(RestClient.put(url, data.to_json, {}))
+            end
+            def self.update options, data
+                if data.blank?
+                    raise :elastify__update__required_data
+                end
+                if data[:id].blank?
+                    raise :elastify__update__required_data_id
+                end
+                url = "#{options[:base_url]}/#{options[:index]}/#{options[:type]}/#{data[:id]}"
+                response = JSON.parse(RestClient.put(url, data.to_json, {})).to_hash
+            end
+            def self.destroy options, data
+                if data.blank?
+                    raise :elastify__delete__required_data
+                end
+                if data[:id].blank?
+                    raise :elastify__delete__required_data_id
+                end
+                url = "#{options[:base_url]}/#{options[:index]}/#{options[:type]}/#{data[:id]}"
+                response = JSON.parse(RestClient.delete(url)).to_hash
+            end
+            def self.search options, dsl 
+                if dsl.blank?
+                    raise :elastify__search__required_dsl
+                end
+                url = "#{options[:base_url]}/#{options[:index]}/#{options[:type]}/_search"
+                response = SearchResultSet.new(RestClient.post(url, dsl.to_json, {}))
+            end
+            def self.destroy_type options
+                url = "#{options[:base_url]}/#{options[:index]}/#{options[:type]}"
+                response = JSON.parse(RestClient.delete(url)).to_hash
+            end
+        end
+        class SearchResultSet
+            attr_accessor :took, :timed_out, :shards_total, :shards_successful, :shards_failed, :hits_total, :hits_maxscore, :hits
+            def initialize elasticsearch_search_result
+                esr = JSON.parse(elasticsearch_search_result)
+                self.took = esr["took"]
+                self.timed_out = esr["timed_out"]
+                self.shards_total = esr["_shards"]["total"]
+                self.shards_successful = esr["_shards"]["successful"]
+                self.shards_failed = esr["_shards"]["failed"]
+                self.hits_total = esr["hits"]["total"]
+                self.hits_maxscore = esr["hits"]["maxscore"]
+                self.hits = esr["hits"]["hits"].map{ |hit| SearchResult.new(hit) }
+            end
+        end
+        class SearchResult
+            attr_accessor :index, :type, :id, :score, :source
+            def initialize elasticsearch_search_result_hit
+                esrh = elasticsearch_search_result_hit
+                self.index = esrh["_index"]
+                self.type = esrh["_type"]
+                self.id = esrh["_id"]
+                self.source = OpenStruct.new(esrh["_source"])
+            end
+        end
+    end
+end

data/lib/elastify/version.rb

@@ -0,0 +1,3 @@
+module Elastify
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: elastify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Bortolotti Ribeiro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: backgrounded
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !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: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.9.3
+description: A gem to help with ActiveRecord-ElasticSeach integration
+email:
+- b2bortolotti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- elastify.gemspec
+- lib/elastify.rb
+- lib/elastify/active_record_extensions.rb
+- lib/elastify/elastic_search_helper.rb
+- lib/elastify/version.rb
+homepage: https://github.com/brunobortolotti/elastify.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A gem to help with ActiveRecord-ElasticSeach integration
+test_files: []