resque-async 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 555fdeb1336e28605c85c5f7dbf18f9404268b68
+  data.tar.gz: 943b9de28b6b313eab38095af0409ef66d9e283f
+SHA512:
+  metadata.gz: cd4638a92cd91566c94f69ec7010649b427ea65c5e1d54443e821700bb711e8e3740a8249f10089d03ea54a1a6e3413e81d5d01145b7ac5a2a65161633beee13
+  data.tar.gz: bc7bffbe9b6690a889065ea235d6f43a0b7b3236bd567c12e03011491d6aac0f97025607b45c19438f8fad141eb62a6c87a8106bbfedd40523901612ea3d991f

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Greg Dean
+
+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,54 @@
+# ResqueAsync
+
+A simple way to invoke methods asynchronously using Resque. There are a few gems that provide similar functionality.
+However We like the more declarative syntax with this implementation. As it gives the caller control over the invocation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque-async'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-async
+
+## Usage
+
+Supports Class Methods and ActiveRecord instance methods
+
+```ruby
+MyObject.async(:high).slow_class_method
+record_instance.async(:medium).slow_instance_method
+```
+
+Support high, medium, low priority out of the box. As well as custom work/queue
+
+```ruby
+MyObject.async(:high).high_priority
+MyObject.async(:medium).medium_priority
+MyObject.async(:low).low_priority
+```
+OR
+```ruby
+class MyCustomerWorker
+    extend ResqueAsync::Workers::AsyncClassWorker
+    @queue :crazy
+end 
+MyObject.async(MyCustomerWorker).crazy_priority
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/resque-async/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/resque-async/enqueuers.rb

@@ -0,0 +1,55 @@
+require 'resque'
+
+module ResqueAsync
+  module Enqueuers
+
+    class ClassEnqueuer
+      attr_reader :host_class, :priority
+      def initialize(host_class, priority)
+        @host_class = host_class
+        @priority = priority
+      end
+
+      def method_missing(methId, *args)
+        # call super unless the host responds to the method
+        return super unless @host_class.respond_to?(methId.id2name.to_sym)
+
+        case @priority
+          when Class
+            worker = @priority
+          when :high
+            worker = Workers::HighPriorityClassMethod
+          when :medium
+            worker = Workers::MediumPriorityClassMethod
+          when :low
+            worker = Workers::LowPriorityClassMethod
+          else
+            raise StandardError('Unknown priority')
+        end
+        # enqueue
+        Resque.enqueue(worker, @host_class.name, methId.id2name, args)
+      end
+    end
+
+    class ActiveRecordEnqueuer < ClassEnqueuer
+      def initialize(host_class, priority, id)
+        super(host_class, priority)
+        @id = id
+      end
+
+      def method_missing(methId, *args)
+        return super(methId, args) unless @host_class.method_defined?(methId)
+        self.class::async(@priority).find_and_send(@host_class.name, @id, methId.id2name, args)
+      end
+
+      def self.find_and_send(class_name, id, method_name, args)
+        record = class_name.constantize.find(id)
+        if args.empty?
+          record.send(method_name)
+        else
+          record.send(method_name, *args)
+        end
+      end
+    end
+  end
+end

data/lib/resque-async/integrations.rb

@@ -0,0 +1,17 @@
+require 'resque-async/enqueuers'
+
+module ResqueAsync
+  module Integrations
+    module ActiveRecord
+      def async(priority)
+        Enqueuers::ActiveRecordEnqueuer.new(self.class, priority, self.id)
+      end
+    end
+
+    module Core
+      def async(priority)
+        Enqueuers::ClassEnqueuer.new(self, priority)
+      end
+    end
+  end
+end

data/lib/resque-async/version.rb

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

data/lib/resque-async/workers.rb

@@ -0,0 +1,29 @@
+module ResqueAsync
+  module Workers
+
+    module AsyncClassWorker
+      def perform(klass, method, args = [])
+        if args.empty?
+          klass.constantize.send(method)
+        else
+          klass.constantize.send(method, *args)
+        end
+      end
+    end
+
+    class HighPriorityClassMethod
+      extend AsyncClassWorker
+      @queue = :high
+    end
+
+    class LowPriorityClassMethod
+      extend AsyncClassWorker
+      @queue = :low
+    end
+
+    class MediumPriorityClassMethod
+      extend AsyncClassWorker
+      @queue = :medium
+    end
+  end
+end

data/lib/resque-async.rb

@@ -0,0 +1,20 @@
+require 'resque-async/version'
+require 'resque-async/integrations'
+require 'resque-async/workers'
+
+
+module ResqueAsync
+
+end
+
+class Module
+  include ResqueAsync::Integrations::Core
+end
+
+if defined? ::ActiveRecord
+  class ActiveRecord::Base
+    include ResqueAsync::Integrations::ActiveRecord
+  end
+end
+
+

data/resque-async.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque-async/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-async"
+  spec.version       = ResqueAsync::VERSION
+  spec.authors       = ["Greg Dean"]
+  spec.email         = ["dean.greg@gmail.com"]
+  spec.summary       = %q{Simple way of invoking methods asynchronously using resque.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "resque"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "resque_spec"
+end

data/spec/active_record_spec.rb

@@ -0,0 +1,6 @@
+require 'support/async'
+
+describe ActiveRecord::Base do
+  it_behaves_like 'async'
+  it { expect(subject.async(:anything)).to be_kind_of(ResqueAsync::Enqueuers::ActiveRecordEnqueuer)}
+end

data/spec/enqueuers_spec.rb

@@ -0,0 +1,10 @@
+require 'support/enqueur'
+require 'support/mock_host'
+
+describe 'Enqueuers' do
+  describe ResqueAsync::Enqueuers::ClassEnqueuer do
+    it_behaves_like 'enqueuer' do
+      subject{ ResqueAsync::Enqueuers::ClassEnqueuer.new(MockHost, :high)}
+    end
+  end
+end

data/spec/module_spec.rb

@@ -0,0 +1,6 @@
+require 'support/async'
+
+describe Module do
+  it_behaves_like 'async'
+  it { expect(subject.async(:anything)).to be_kind_of(ResqueAsync::Enqueuers::ClassEnqueuer)}
+end

data/spec/spec_helper.rb

@@ -0,0 +1,106 @@
+
+# This is kind of an ugly way to mock ActiveRecord for specs
+# The real ActiveRecord comes with tons of dependencies that are hard to mock.
+# For our purposes this seems like a reasonable compromise
+# NOTE: I tried with no avail to mock rails and db dependencies
+module ActiveRecord
+  class Base
+    def id
+      0
+    end
+  end
+end
+
+
+require 'resque-async'
+require 'resque_spec'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/async.rb

@@ -0,0 +1,3 @@
+shared_examples 'async' do
+  it { expect(subject).to respond_to(:async) }
+end

data/spec/support/enqueur.rb

@@ -0,0 +1,4 @@
+shared_examples 'enqueuer' do
+  it { expect{ subject.not_a_method }.to raise_error(NoMethodError)}
+  it { expect{ subject.async_class_method }.to_not raise_error }
+end

data/spec/support/mock_host.rb

@@ -0,0 +1,5 @@
+class MockHost
+  def self.async_class_method
+
+  end
+end

data/spec/support/worker.rb

@@ -0,0 +1,3 @@
+shared_examples 'worker' do
+  it { expect(described_class).to respond_to(:perform)}
+end

data/spec/workers_spec.rb

@@ -0,0 +1,17 @@
+require 'support/worker'
+
+describe 'Workers' do
+
+  describe ResqueAsync::Workers::HighPriorityClassMethod do
+    it_behaves_like 'worker'
+    it { expect(Resque.queue_from_class(described_class)).to be(:high)}
+  end
+  describe ResqueAsync::Workers::MediumPriorityClassMethod do
+    it_behaves_like 'worker'
+    it { expect(Resque.queue_from_class(described_class)).to be(:medium)}
+  end
+  describe ResqueAsync::Workers::LowPriorityClassMethod do
+    it_behaves_like 'worker'
+    it { expect(Resque.queue_from_class(described_class)).to be(:low)}
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: resque-async
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Greg Dean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque_spec
+  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: 
+email:
+- dean.greg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resque-async.rb
+- lib/resque-async/enqueuers.rb
+- lib/resque-async/integrations.rb
+- lib/resque-async/version.rb
+- lib/resque-async/workers.rb
+- resque-async.gemspec
+- spec/active_record_spec.rb
+- spec/enqueuers_spec.rb
+- spec/module_spec.rb
+- spec/spec_helper.rb
+- spec/support/async.rb
+- spec/support/enqueur.rb
+- spec/support/mock_host.rb
+- spec/support/worker.rb
+- spec/workers_spec.rb
+homepage: ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Simple way of invoking methods asynchronously using resque.
+test_files:
+- spec/active_record_spec.rb
+- spec/enqueuers_spec.rb
+- spec/module_spec.rb
+- spec/spec_helper.rb
+- spec/support/async.rb
+- spec/support/enqueur.rb
+- spec/support/mock_host.rb
+- spec/support/worker.rb
+- spec/workers_spec.rb
+has_rdoc: