tire_async_index 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 787c2bf5248a7a3ac44a08e3ca0861bdd255dd04
+  data.tar.gz: 27c1075ca9d55f3c24fa08721b8d251895f9a14c
+SHA512:
+  metadata.gz: 577d09324ee37b127f7baa01e69282a0f6c173f328955ed68d8a2afb2190235e4d24cb599854263c1d33c959f286adf7611f7e0cf7c832439cf61436f8603d3d
+  data.tar.gz: 64603ddf1d0422eb8a092df54736c63c401a8a3d8d2f21afe8cf167d17db9718e45e1a646d78cb79fde0bb0e2bf6acce20099d8ed3a09a084f5d3097ea6ac3af

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format progress
+--backtrace

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sergey Efremov
+
+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,47 @@
+# TireAsyncIndex
+
+It's extension for [Tire](https://github.com/karmi/tire/) (client for the Elasticsearch search engine), which allow to update index of ActiveRecord model using background job (based on [Sidekiq](https://github.com/mperham/sidekiq) or [Resque](https://github.com/resque/resque)).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tire_async_index'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tire_async_index
+
+## Configuration
+
+You could configure TireAsyncIndex in initializer:
+    
+    TireAsyncIndex.configure do |config|
+        config.background_engine :sidekiq # or :resque
+        config.use_queue         :high    # name of your queue
+    end
+
+## Usage
+
+Just add AsyncCallbacks to your model:
+    
+    class User < ActiveRecord::Base
+        include Tire::Model::Search
+        include Tire::Model::AsyncCallbacks
+        
+        ...
+    end
+    
+That's all.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+desc 'Default: run specs'
+task :default => :spec  
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/lib/tire/model/async_callbacks.rb

@@ -0,0 +1,33 @@
+module Tire
+  module Model
+    module AsyncCallbacks
+      def self.included(base)
+        if base.respond_to?(:after_save) && base.respond_to?(:after_destroy)
+          puts "asdfadasdas"
+          base.send :after_save,    lambda { 
+            case TireAsyncIndex.engine
+            when :sidekiq
+              SidekiqUpdateIndexWorker.perform_async(base.name, id)
+            when :resque
+              Resque.enqueue(ResqueUpdateIndexJob, base.name, id)
+            else
+              tire.update_index
+            end
+            self 
+          }
+          base.send :after_destroy, lambda { tire.update_index }, :order => :first
+        end
+
+        if base.respond_to?(:before_destroy) && !base.instance_methods.map(&:to_sym).include?(:destroyed?)
+          base.class_eval do
+            before_destroy  { @destroyed = true }
+            def destroyed?; !!@destroyed; end
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/tire_async_index/configuration.rb

@@ -0,0 +1,26 @@
+module TireAsyncIndex
+  class Configuration
+    AVALAIBLE_ENGINE = [:sidekiq, :resque, :none]
+
+    attr_accessor :queue
+    attr_accessor :engine
+
+    def background_engine type
+      if AVALAIBLE_ENGINE.include?(type.to_sym)
+        @engine = type.to_sym
+      else
+        raise EngineNotFound, "Background Engine '#{type}' not found"
+      end
+    end
+
+    def use_queue name
+      @queue = name.to_sym
+    end
+
+    def initialize
+      @queue  = :normal
+      @engine = :none
+    end
+
+  end
+end

data/lib/tire_async_index/exceptions.rb

@@ -0,0 +1,3 @@
+module TireAsyncIndex
+  class EngineNotFound < StandardError; end
+end

data/lib/tire_async_index/version.rb

@@ -0,0 +1,3 @@
+module TireAsyncIndex
+  VERSION = "0.0.1"
+end

data/lib/tire_async_index/workers/resque_update_index_job.rb

@@ -0,0 +1,9 @@
+class ResqueUpdateIndexJob
+
+  @queue = TireAsyncIndex.configuration.queue
+
+  def self.perform class_name, id
+    class_name.constantize.find_by_id(id).try(:update_index)
+  end
+
+end

data/lib/tire_async_index/workers/sidekiq_update_index_worker.rb

@@ -0,0 +1,10 @@
+class SidekiqUpdateIndexWorker
+
+  include Sidekiq::Worker
+  sidekiq_options queue: TireAsyncIndex.configuration.queue
+
+  def perform class_name, id
+    class_name.constantize.find_by_id(id).try(:update_index)
+  end
+
+end

data/lib/tire_async_index.rb

@@ -0,0 +1,27 @@
+require "tire_async_index/configuration"
+require "tire_async_index/exceptions"
+require "tire_async_index/version"
+
+module TireAsyncIndex
+  extend self
+  attr_accessor :configuration
+
+  def configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def queue_name
+    self.configuration.queue
+  end
+
+  def engine
+    self.configuration.engine
+  end
+end
+
+TireAsyncIndex.configure {}
+
+require 'tire_async_index/workers/sidekiq_update_index_worker' if defined?(Sidekiq)
+require 'tire_async_index/workers/resque_update_index_job'     if defined?(Resque)
+require 'tire/model/async_callbacks'

data/spec/test_helper.rb

@@ -0,0 +1,18 @@
+require "rubygems"
+require "bundler/setup"
+require "tire"
+require 'rails'
+require 'active_record'
+require 'nulldb_rspec'
+require 'nulldb/rails'
+#include NullDB::RSpec::NullifiedDatabase
+NullDB.configure {|ndb| ndb.project_root = 'spec'}
+ActiveRecord::Base.establish_connection :adapter => :nulldb,
+                                        :schema  => 'test_schema.rb'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

data/spec/test_schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define(:version => 20130315203352) do
+  create_table "users", :force => true do |t|
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "name"
+  end
+end

data/spec/tire_async_index_spec.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+require 'tire'
+require 'sidekiq'
+require 'resque'
+require 'tire_async_index'
+
+class User < ActiveRecord::Base
+  include Tire::Model::AsyncCallbacks
+end
+
+describe TireAsyncIndex do
+  context "configurable" do
+    it "valid default config settings" do
+      TireAsyncIndex.queue_name.should eql :normal
+      TireAsyncIndex.engine.should eql :none
+    end
+
+    it "set queue name" do
+      TireAsyncIndex.configure do |config|
+        config.use_queue :high
+      end
+
+      TireAsyncIndex.queue_name.should eql :high
+    end    
+
+    it "should be able to set sidekiq as engine" do
+      TireAsyncIndex.configure do |config|
+        config.background_engine :sidekiq
+      end
+
+      TireAsyncIndex.engine.should eql :sidekiq
+    end
+
+    it "should be able to set resque as engine" do
+      TireAsyncIndex.configure do |config|
+        config.background_engine :resque
+      end
+
+      TireAsyncIndex.engine.should eql :resque
+    end
+
+    it "should not be able to set not supported engine" do
+      expect {
+        TireAsyncIndex.configure do |config|
+          config.background_engine :some_engine
+        end
+      }.to raise_error(TireAsyncIndex::EngineNotFound)
+    end
+  end
+
+  context "integration" do
+
+    it "should not start backroub on no engine" do
+      TireAsyncIndex.configure do |config|
+        config.background_engine :none
+      end
+      a = User.new
+      a.stub(:tire) { a }
+      a.should_receive(:update_index)
+      a.save
+    end
+
+    it "should start sidekiq" do
+      TireAsyncIndex.configure do |config|
+        config.background_engine :sidekiq
+      end
+
+      SidekiqUpdateIndexWorker.should_receive(:perform_async).with("User", instance_of(Fixnum))
+
+      a = User.new
+      a.save
+    end
+
+    it "should start resque" do
+      TireAsyncIndex.configure do |config|
+        config.background_engine :resque
+      end
+
+      Resque.should_receive(:enqueue).with(ResqueUpdateIndexJob, "User", instance_of(Fixnum))
+
+      a = User.new
+      a.save
+    end
+
+  end
+end

data/tire_async_index.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tire_async_index/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tire_async_index"
+  spec.version       = TireAsyncIndex::VERSION
+  spec.authors       = ["Sergey Efremov"]
+  spec.email         = ["efremov.sergey@gmail.com"]
+  spec.description   = "Update tire (elasticsearch) index async with Sidekiq or Resque"
+  spec.summary       = "Update tire (elasticsearch) index async with Sidekiq or Resque"
+  spec.homepage      = "http://github.com/EvilFaeton/tire_async_index"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "tire"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails", "~> 3.2"
+  spec.add_development_dependency "activerecord-nulldb-adapter"
+  spec.add_development_dependency "sidekiq"
+  spec.add_development_dependency "resque"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: tire_async_index
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Efremov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tire
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: activerecord-nulldb-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Update tire (elasticsearch) index async with Sidekiq or Resque
+email:
+- efremov.sergey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tire/model/async_callbacks.rb
+- lib/tire_async_index.rb
+- lib/tire_async_index/configuration.rb
+- lib/tire_async_index/exceptions.rb
+- lib/tire_async_index/version.rb
+- lib/tire_async_index/workers/resque_update_index_job.rb
+- lib/tire_async_index/workers/sidekiq_update_index_worker.rb
+- spec/test_helper.rb
+- spec/test_schema.rb
+- spec/tire_async_index_spec.rb
+- tire_async_index.gemspec
+homepage: http://github.com/EvilFaeton/tire_async_index
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Update tire (elasticsearch) index async with Sidekiq or Resque
+test_files:
+- spec/test_helper.rb
+- spec/test_schema.rb
+- spec/tire_async_index_spec.rb