sidekiq-delay 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 805faf90315131ee499e200e76119ee6a192cc6c
+  data.tar.gz: cba480e68427bab5ca9356a7c7b8650b6409f329
+SHA512:
+  metadata.gz: dd1f11f8ca93f98c9624c21b59c683546619a5f0b42735aa11c1ede4413d70cd0affb87d3da7d57cbfa0bb59cccb6cc471d95d11207f308b7e3e891d00a53f55
+  data.tar.gz: 633ef9b2d2516198f9c2bed475177c322b1cd67f64b6dd73e2e0a8a253ba05bfd0eeb7cf6b7e71332cfc6f06dceb2b44f56efcd6308c42b8e82df262b5d4342a

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

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/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+services:
+  - mongodb

data/Gemfile

@@ -0,0 +1,12 @@
+# vim:set filetype=ruby:
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-delay.gemspec
+gemspec
+
+gem 'coveralls', require: false
+
+group :test do
+  gem "guard-rspec"
+  gem "rb-fsevent", require: false
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Daniel Libanori
+
+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,99 @@
+# Sidekiq::Delay
+
+- [![Build Status](https://secure.travis-ci.org/dlibanori/sidekiq-delay.png)](http://travis-ci.org/dlibanori/sidekiq-delay)
+- [![Code Climate](https://codeclimate.com/github/dlibanori/sidekiq-delay.png)](https://codeclimate.com/github/dlibanori/sidekiq-delay)
+- [![Coverage Status](https://coveralls.io/repos/dlibanori/sidekiq-delay/badge.png)](https://coveralls.io/r/dlibanori/sidekiq-delay)
+
+Wouldn't be nice if you could easily queue model method calls to Sidekiq? With **Sidekiq::Delay** you can!
+
+You have just to include a module and call `delay` before any method call. Actually, your model class have to respond to some methods, but if you are using `ActiveRecord` or `Mongoid` they already do.
+
+**NOTE**: It doesn't support `block` arguments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-delay'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-delay
+
+## Usage
+
+First you have to include `Sidekiq::Delay` at your model.
+
+```ruby
+  class Band
+    include Mongoid::Document
+    include Sidekiq::Delay
+
+    field :name
+
+    def play!
+      # it is a long task
+      sleep 3
+    end
+  end
+```
+
+Now you can `delay` method calls to a Sidekiq queue.
+
+```ruby
+  band = Band.create(name: 'Daft Punk')
+  band.delay.play!
+```
+
+## How it works
+
+It queues an job with model class, model id, method name and args. Later, at Sidekiq, it finds your model using class and id and calls method with args. Your class must respond to `find(id)` and return same model.
+
+**NOTE**: Your model must be stored at database before `delay` any call.
+
+## Custom works
+
+What if you class doesn't respond to `find` or you want to use another `Sidekiq` plugin? You can easily write an **custom worker**. You have just to set your model to use it with `worker` method.
+
+Your worker just need to include `Sidekiq::Delay::DefaultStrategy` or extend `Sidekiq::Delay::DefaultWorker`.
+
+```ruby
+  class TeamWorker
+    include Sidekiq::Worker
+    include Sidekiq::Delay::DefaultStrategy
+
+    def record(klass, id)
+      klass.custom_find(id)
+    end
+  end
+
+  class Team
+    include Mongoid::Document
+    include Sidekiq::Delay
+
+    worker TeamWorker
+
+    field :name
+
+    def self.custom_find(id)
+      find(id)
+    end
+
+    def play!
+      # it is a long task
+      sleep 3
+    end
+  end
+```
+
+## 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,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/sidekiq/delay.rb

@@ -0,0 +1,42 @@
+require "sidekiq"
+require "sidekiq/delay/version"
+require 'active_support/concern'
+
+module Sidekiq
+  module Delay
+    extend ActiveSupport::Concern
+
+    included do
+      @worker = DefaultWorker
+    end
+
+    def delay(options={})
+      Sidekiq::Extensions::Proxy.new \
+        self.class.worker,
+        [ self.class, self.id ],
+        options
+    end
+
+    module ClassMethods
+      def worker(worker=nil)
+        worker ? @worker = worker : @worker
+      end
+    end
+
+    module DefaultStrategy
+      def perfom(yml)
+        ((klass, id), method_name, args) = YAML.load(yml)
+        record.send(method_name, *args)
+      end
+
+      def record(klass, id)
+        klass.find(id)
+      end
+    end
+
+    class DefaultWorker
+      include Sidekiq::Worker
+      include DefaultStrategy
+    end
+  end
+end

data/lib/sidekiq/delay/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Delay
+    VERSION = "0.0.1"
+  end
+end

data/sidekiq-delay.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/delay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-delay"
+  spec.version       = Sidekiq::Delay::VERSION
+  spec.authors       = ["Daniel Libanori"]
+  spec.email         = ["daniellibanori@gmail.com"]
+  spec.description   = %q{Wouldn't be nice if you could directly queue your model method calls to Sidekiq? With Sidekiq::Delaty you can!}
+  spec.summary       = %q{Queue model method calls at Sidekiq}
+  spec.homepage      = "https://github.com/dlibanori/sidekiq-delay"
+  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 "sidekiq", "~> 2.12.4"
+  spec.add_dependency "activesupport", "~> 3.2.13"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mongoid"
+  spec.add_development_dependency "rspec"
+end

data/spec/app/models/band.rb

@@ -0,0 +1,12 @@
+require 'sidekiq/delay'
+
+class Band
+  include Mongoid::Document
+  include Sidekiq::Delay
+
+  def play
+    print 'Long running task...'
+    spleep 3
+    print ' done!'
+  end
+end

data/spec/app/models/team.rb

@@ -0,0 +1,23 @@
+require 'sidekiq/delay'
+
+class TeamWorker
+  include Sidekiq::Worker
+  include Sidekiq::Delay::DefaultStrategy
+
+  def record(klass, id)
+    klass.find(id)
+  end
+end
+
+class Team
+  include Mongoid::Document
+  include Sidekiq::Delay
+
+  worker TeamWorker
+
+  def play
+    print 'Long running task...'
+    spleep 3
+    print ' done!'
+  end
+end

data/spec/config/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+   default:
+     database: sidekiq_delay_test
+     hosts:
+       - localhost:27017

data/spec/sidekiq/delay_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+require 'sidekiq/testing'
+require 'app/models/band'
+require 'app/models/team'
+
+describe Sidekiq::Delay do
+  context "with default worker" do
+    let(:band) { Band.new }
+
+    it "queue an job at default queue" do
+      expect {
+        band.delay.play
+      }.to change(Sidekiq::Delay::DefaultWorker.jobs, :size).by(1)
+    end
+  end
+
+  context "with custom worker" do
+    let(:team) { Team.new }
+
+    it "queue an job at default queue" do
+      expect {
+        team.delay.play
+      }.to change(TeamWorker.jobs, :size).by(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'coveralls'
+require 'sidekiq'
+require 'mongoid'
+
+Coveralls.wear!
+
+Mongoid.configure do |config|
+  config.connect_to('sidekiq_delay_test', consistency: :strong)
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-delay
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Libanori
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !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: mongoid
+  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: Wouldn't be nice if you could directly queue your model method calls
+  to Sidekiq? With Sidekiq::Delaty you can!
+email:
+- daniellibanori@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/delay.rb
+- lib/sidekiq/delay/version.rb
+- sidekiq-delay.gemspec
+- spec/app/models/band.rb
+- spec/app/models/team.rb
+- spec/config/mongoid.yml
+- spec/sidekiq/delay_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dlibanori/sidekiq-delay
+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.2
+signing_key: 
+specification_version: 4
+summary: Queue model method calls at Sidekiq
+test_files:
+- spec/app/models/band.rb
+- spec/app/models/team.rb
+- spec/config/mongoid.yml
+- spec/sidekiq/delay_spec.rb
+- spec/spec_helper.rb