sidekiq-kawai 0.1.6

data/.gitignore

@@ -0,0 +1,6 @@
+log
+TODO
+locks
+*.gem
+*.log
+.bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-kawai (0.1.6)
+      activesupport
+      sidekiq (>= 2.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    celluloid (0.11.1)
+      timers (>= 1.0.0)
+    connection_pool (0.9.2)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    redis (3.0.1)
+    redis-namespace (1.2.1)
+      redis (~> 3.0.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    sidekiq (2.2.0)
+      celluloid (~> 0.11.1)
+      connection_pool (~> 0.9.2)
+      multi_json (~> 1)
+      redis (~> 3)
+      redis-namespace
+    timers (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  sidekiq-kawai!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Makarchev K
+
+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,84 @@
+Sidekiq Kawai
+============
+
+Syntax sugar for Sidekiq consumers. Each consumer is a class, with clean interface, and custom logger.
+Usefull when count of different events ~100 and more.
+
+``` ruby
+gem 'sidekiq-kawai'
+```
+
+    rails generate sk:add bla
+
+And add to config/application.rb
+
+    config.autoload_paths += %W( #{config.root}/app/models/sidekiq )
+
+Consumer
+--------
+app/workers/sk_bla.rb
+
+``` ruby
+class SkBla < SkQueue
+
+  def some_method1(a, b, c)
+    logger.info "async called some_method1 with #{[a, b, c].inspect}"
+  end
+
+  def some_method2(x)
+    logger.info "async called some_method2 with #{x.inspect}"
+  end
+
+end
+```
+
+Insert event into queue like this:
+
+    SkBla.some_method1(1, 2, 3)
+
+    or
+
+    SkBla.add_event(:some_method2, some_x)
+
+
+Logger for this consumer: Rails.root/log/workers/bla.log
+
+
+
+### Options
+
+``` ruby
+class SkBla < RkQueue
+
+  # specify custom logger
+  sidekiq_options :logger_path => "#{Rails.root}/log/bla.log"
+
+  # enables benchmark for each event (into logger)
+  sidekiq_options :benchmark => true
+
+end
+```
+
+
+### Proxy method to consumer
+Usefull in specs
+
+``` ruby
+  SkBla.proxy(:some_method1)
+```
+
+When code call SkBla.some_method1(a,b,c) this would be convert into SkBla.new.some_method1(a,b,c)
+
+
+
+### Insert events with scheduler
+
+``` ruby
+SkBla.add_event_in(10.seconds, :some_method1, 1, 2, 3)
+
+SkBla.enqueue_in(10.seconds, :some_method1, 1, 2, 3)
+
+SkBla.some_method2_in(2.minutes.from_now, "call instance method on Worker sheduled async")
+
+SkBla.some_method2_at(2.minutes.from_now, "call instance method on Worker sheduled async")
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec)

data/lib/generators/sk/add_generator.rb

@@ -0,0 +1,29 @@
+# for Rails 3
+if Rails::VERSION::MAJOR >= 3
+
+  module Sk
+    class AddGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      def add_files
+        template "consumer.rb", "app/workers/sk_#{file_path}.rb"
+        template "spec.rb", "spec/workers/sk_#{file_path}_spec.rb"
+      end
+    end
+  end
+
+end
+
+# for Rails 2.3
+if Rails::VERSION::MAJOR == 2
+
+  class SkAddGenerator < Rails::Generator::NamedBase
+    def manifest
+      record do |m|
+        m.template "consumer.rb", "app/workers/sk_#{file_path}.rb"
+        m.template "spec.rb", "spec/workers/sk_#{file_path}_spec.rb"
+      end
+    end
+  end
+
+end

data/lib/generators/sk/templates/consumer.rb

@@ -0,0 +1,9 @@
+class Sk<%= class_name %> < SkQueue
+
+  # insert event like: Sk<%= class_name %>.some_event("haha")
+
+  def some_event(h)
+    logger.info "async called event with #{h.inspect}"
+  end
+
+end

data/lib/generators/sk/templates/spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Sk<%= class_name %> do
+  before :each do
+    @sk = Sk<%= class_name %>.new
+  end
+
+  it "should not raise" do
+    @sk.some_event(1)
+  end
+
+end

data/lib/sidekiq-kawai.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/sk_queue'

data/lib/sk_queue.rb

@@ -0,0 +1,118 @@
+# -*- encoding : utf-8 -*-
+require 'active_support'
+require 'active_support/inflector' unless ''.respond_to?(:underscore)
+require 'sidekiq'
+
+class SkQueue
+  include Sidekiq::Worker
+
+  sidekiq_options :retry => true, :benchmark => false
+
+  def self.extract_queue_name
+    name.gsub(/^Sk/, '').underscore.gsub('/', '-').to_sym rescue :default
+  end
+
+  def self.inherited(subclass)
+    subclass.class_eval do
+      sidekiq_options :queue => extract_queue_name
+      sidekiq_options :logger_path => File.expand_path("log/workers/#{queue_name}.log")
+    end
+  end
+
+  def perform(method_name, args)
+    start_time = benchmark ? Time.now : nil
+    
+    self.send(method_name, *args)
+    
+    logger.info "done #{method_name}, #{"%.6f" % (Time.now - start_time)} s" if benchmark
+    
+  rescue => ex
+    logger.error "!Failed event: #{method_name} => #{ex.message}, #{args.inspect}"
+    self.class.notify_about_error(ex)    
+    raise ex
+  end
+
+  def self.benchmark
+    get_sidekiq_options['benchmark']
+  end
+
+  def self.benchmark=(val)
+    sidekiq_options :benchmark => val
+  end
+
+  def benchmark
+    self.class.benchmark
+  end
+
+  def self.queue_name
+    get_sidekiq_options['queue']
+  end
+
+  def queue_name
+    self.class.queue_name
+  end
+
+  def self.set_queue_name(val)
+    sidekiq_options :queue => val
+  end
+
+
+  def self.logger_path
+    get_sidekiq_options['logger_path']
+  end
+
+  def logger_path
+    self.class.logger_path
+  end
+
+
+
+
+  def self.add_event(method_name, *args)
+    client_push('class' => self, 'args' => [method_name, args])
+  end
+
+  def self.enqueue(method_name, *args)
+    add_event method_name, *args
+  end
+
+  def self.add_event_in(interval, method_name, *args)
+    perform_in(interval, method_name, args)
+  end
+
+  def self.enqueue_in(interval, method_name, *args)
+    add_event_in(interval, method_name, *args)
+  end
+  
+  # Worker.some_method("call new method on Worker async")
+  # Worker.some_method_in(2.minutes.from_now,"call new method on Worker sheduled async")
+  # Worker.some_method_at(2.minutes.from_now,"call new method on Worker sheduled async")
+  def self.method_missing(method_name, *args)    
+    if method_name.to_s[/\A(\w*)_((at)|(in))\z/]
+      add_event_in(args.shift, $1.to_s.to_sym, *args)
+    else
+      add_event(method_name, *args)
+    end
+  end
+
+
+
+
+  def logger
+    @logger ||= Logger.new(logger_path).tap do |logger|
+      logger.formatter = lambda { |s, d, p, m| "#{d.strftime("%d.%m.%Y %H:%M:%S")} #{m}\n" }
+    end
+  end
+
+  def self.proxy(method_name)
+    self.should_receive(method_name) do |*data|
+      x = Sidekiq.load_json(Sidekiq.dump_json(data))
+      self.new.send(method_name, *x)
+    end.any_number_of_times
+  end
+  
+  def self.notify_about_error(exception)
+    # stub
+  end
+
+end

data/lib/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding: utf-8 -*-
+module Sk
+  VERSION = "0.1.6"
+end

data/sidekiq-kawai.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.dirname(__FILE__) + "/lib/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{sidekiq-kawai}
+  s.version = Sk::VERSION
+
+  s.authors = ["Makarchev Konstantin", "Damir Sharipov"]
+
+  s.description = %q{Syntax sugar for Sidekiq workers. Each consumer is a class, with clean interface, and custom logger. Usefull when count of different events ~100 and more.}
+  s.summary = %q{Syntax sugar for Sidekiq consumers. Each consumer is a class, with clean interface, and custom logger. Usefull when count of different events ~100 and more.}
+  s.email = %q{dammer2k@gmail.com}
+  s.homepage = %q{https://github.com/kostya/sidekiq-kawai}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activesupport'
+  s.add_dependency 'sidekiq', '>= 2.1.0'
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+
+end

data/spec/sk_queue_spec.rb

@@ -0,0 +1,127 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/test_class'
+
+describe "main queue" do
+
+  it "queue" do
+    SkTest.queue_name.should == :test
+  end
+
+  it "queue name A::B::C" do
+    A::B::C.queue_name.should == :'a-b-c'
+  end
+
+  it "aliases for queues" do
+    SkTest.queue_name.should == :test
+    SkTest.new.queue_name.should == :test
+  end
+
+  it "set queue_name" do
+    SkTest.set_queue_name :haha
+    SkTest.queue_name.should == :haha
+    SkTest.new.queue_name.should == :haha
+  end
+
+  it "set queue name inside class" do
+    class Sk2 < SkTest
+      set_queue_name :jopa
+    end
+
+    Sk2.queue_name.should == :jopa
+  end
+
+  it "should enqueue defined event" do
+    SkTest.should_receive(:client_push).with('class' => SkTest, 'args' => [:bla, [1, 'a', []]])
+    SkTest.bla(1, 'a', [])
+  end
+
+  it "insert empty event" do
+    SkTest.should_receive(:client_push).with('class' => SkTest, 'args' => [:bla, []])
+    SkTest.bla
+  end
+
+ it "should enqueue undefined event" do
+   SkTest.should_receive(:client_push).with('class' => SkTest, 'args' => [:bl, [1]])
+   SkTest.bl(1)
+ end
+
+  it "should enqueue undefined event" do
+    SkTest.should_receive(:client_push).with('class' => SkTest, 'args' => [:bl2, [{}]])
+    SkTest.bl2({})
+  end
+
+  it "should insert event with custom method" do
+    SkTest.should_receive(:client_push).with('class' => SkTest, 'args' => [:super, [1,2,3]])
+    SkTest.add_event(:super, 1, 2, 3)
+  end
+
+  it "should insert event with custom method" do
+    SkTest.should_receive(:client_push).with('class' => SkTest, 'args' => [:super, [[1,2,3]]])
+    SkTest.add_event(:super, [1, 2, 3])
+  end
+
+  it "should insert event with custom method enqueue" do
+    SkTest.should_receive(:client_push).with('class' => SkTest, 'args' => [:super, [1,2,3]])
+    SkTest.enqueue(:super, 1, 2, 3)
+  end
+
+  it "enqueue in" do
+    SkTest.should_receive(:perform_in).with(10, :super, [1, 2, 3])
+    SkTest.enqueue_in(10, :super, 1, 2, 3)
+  end
+
+  it "add event in" do
+    SkTest.should_receive(:perform_in).with(10, :super, [1, 2, 3])
+    SkTest.add_event_in(10, :super, 1, 2, 3)
+  end
+  
+  it "abstract enqueue in" do
+    SkTest.should_receive(:perform_in).with(10, :bla, [1, 2, 3])
+    SkTest.bla_in(10, 1, 2, 3)    
+  end
+  
+  it "abstract enqueue at" do
+    SkTest.should_receive(:perform_in).with(10, :bla, [1, 2, 3])
+    SkTest.bla_at(10, 1, 2, 3)            
+  end
+
+  describe "consume" do
+    before :each do
+      @bla = SkTest.new
+    end
+
+    it "should call our event" do
+      @bla.should_receive(:bla).with(1, 'a', [])
+      @bla.perform(:bla, [1, 'a', []])
+    end
+
+    it "should call our another event" do
+      @bla.should_receive(:bl).with(1)
+      @bla.perform('bl', [1])
+    end
+
+    it "should call our another event" do
+      @bla.should_receive(:bl2).with({})
+      @bla.perform('bl2', [{}])
+    end
+
+    it "should call our another event" do
+      @bla.should_receive(:bl2).with([1,2,3])
+      @bla.perform('bl2', [[1,2,3]])
+    end
+
+    it "raised when method undefined" do
+      lambda do
+        SkTest.new.perform('blasdfds', [1])
+      end.should raise_error
+    end
+  end
+
+  it "should proxy consumer" do
+    SkTest.proxy(:ptest)
+    SkTest.ptest(111, 'abc').should == 10
+    $a.should == 111
+    $b.should == 'abc'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require "bundler/setup"
+
+ENV['RAILS_ENV'] ||= 'test'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'sk_queue'

data/spec/test_class.rb

@@ -0,0 +1,28 @@
+class SkTest < SkQueue
+
+  sidekiq_options :logger_path => "test.log"
+  sidekiq_options :benchmark => true
+
+  def bla(a, b, c)
+    @hah = [a, b, c]
+    logger.info "bla #{@hah.inspect}"
+  end
+
+  def ptest(a, b)
+    $a = a
+    $b = b
+    10
+  end
+  
+  def self.to_ary
+    super
+  end
+
+end
+
+module A
+  module B
+    class C < SkQueue
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-kawai
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+  prerelease: 
+platform: ruby
+authors:
+- Makarchev Konstantin
+- Damir Sharipov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Syntax sugar for Sidekiq workers. Each consumer is a class, with clean
+  interface, and custom logger. Usefull when count of different events ~100 and more.
+email: dammer2k@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/sk/add_generator.rb
+- lib/generators/sk/templates/consumer.rb
+- lib/generators/sk/templates/spec.rb
+- lib/sidekiq-kawai.rb
+- lib/sk_queue.rb
+- lib/version.rb
+- sidekiq-kawai.gemspec
+- spec/sk_queue_spec.rb
+- spec/spec_helper.rb
+- spec/test_class.rb
+homepage: https://github.com/kostya/sidekiq-kawai
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4705233
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4705233
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Syntax sugar for Sidekiq consumers. Each consumer is a class, with clean
+  interface, and custom logger. Usefull when count of different events ~100 and more.
+test_files: []