activejob-retry 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dd35a0525fd3f160a488f90b9471f7058a714de
-  data.tar.gz: 3e423dbca62f4337a765a54f7c212ccd3ef237eb
+  metadata.gz: db6f767b064370ffd9a2b32630bcb21c2629ce6a
+  data.tar.gz: b8cf9fd6ca868b5acad274131906fa71046e4df6
 SHA512:
-  metadata.gz: ac1daad64696deacbfeab3d8e28e1ffff49b7e219580de47f9f02f0867ae5f0977615c019d88f8f9d2afca3561df7b551fcb56a9b3d4ce2ccdea109e117c907a
-  data.tar.gz: 74b33077ae43b9232eace312851fc9a85165e72c8ae4b1b386f97d109daab75121909fb9a9b7bcec5c7b3e70673ca0d4ab5ed5a16448d7ab7d8769b0b95a7e50
+  metadata.gz: b69605d70cced8e95f98147aebcbf132fb3600d44798ef57838febbf74bd7d7587ee9792b0f8cbf5c4682cf4ddd440f6e07dd818cccf4c6de68b0e821e072ecb
+  data.tar.gz: 44443de787c728f2e7beeb2fdc4cd62a73bf38a6b61beee1fa3d034d3d822e2b5855372c014f57014ceb288dd3e873d0de38c8c5063e41671c51208435865984

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  Include:
+    - Rakefile
+  Exclude:
+    - .*/**/*
+    - vendor/**
+    - test/**/*
+
+LineLength:
+  Max: 90
+
+Style/SignalException:
+  EnforcedStyle: 'only_raise'
+
+Metrics/MethodLength:
+  CountComments: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: trailing

data/.travis.yml

@@ -1,15 +1,30 @@
+sudo: false
+cache: bundler
+
 language: ruby
 
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
+    - rvm: jruby
     - rvm: rbx-2
 
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.1.1
-  - 2.1.2
-  - jruby-19mode
+  - 2.1
+  - 2.2
+  - jruby
   - rbx-2
+
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec
+  - bundle exec rake test
+  - bundle exec rake test:integration
+
+services:
+  - redis
+  - rabbitmq
+
+addons:
+  postgresql: "9.4"

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.1 - January 1, 2015
+
+- Initial release

data/Gemfile

@@ -1,17 +1,20 @@
 source 'https://rubygems.org'
+
 gemspec
 
-group :test do
+group :test, :integration do
+  # Queues
   gem 'resque', require: false
   gem 'resque-scheduler', require: false
   gem 'sidekiq', require: false
-  gem 'sucker_punch', require: false
   gem 'delayed_job', require: false
-  gem 'queue_classic', "< 3.0.0", require: false, platforms: :ruby
-  gem 'sneakers', '0.1.1.pre', require: false
+  gem 'delayed_job_active_record', require: false
   gem 'que', require: false
   gem 'backburner', require: false
-  gem 'qu-rails', github: "bkeepers/qu", branch: "master", require: false
-  gem 'qu-redis', require: false
   gem 'sequel', require: false
+
+  # Specs
+  gem 'sqlite3'
+  gem 'pg'
+  gem 'rails'
 end

data/Gemfile.lock

@@ -1,26 +1,19 @@
-GIT
-  remote: git://github.com/bkeepers/qu.git
-  revision: d098e2657c92e89a6413bebd9c033930759c061f
-  branch: master
-  specs:
-    qu (0.2.0)
-    qu-rails (0.2.0)
-      qu (= 0.2.0)
-      railties (>= 3.2, < 5)
-    qu-redis (0.2.0)
-      qu (= 0.2.0)
-      redis-namespace
-
 PATH
   remote: .
   specs:
-    activejob-retry (0.0.1)
+    activejob-retry (0.1.0)
       activejob (>= 4.2)
       activesupport (>= 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionmailer (4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
     actionpack (4.2.0)
       actionview (= 4.2.0)
       activesupport (= 4.2.0)
@@ -37,65 +30,78 @@ GEM
     activejob (4.2.0)
       activesupport (= 4.2.0)
       globalid (>= 0.3.0)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
     activesupport (4.2.0)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    amq-protocol (1.9.2)
+    arel (6.0.0)
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
     backburner (0.4.6)
       beaneater (~> 0.3.1)
       dante (~> 0.1.5)
     beaneater (0.3.3)
     builder (3.2.2)
-    bunny (1.1.9)
-      amq-protocol (>= 1.9.2)
-    byebug (3.5.1)
-      columnize (~> 0.8)
-      debugger-linecache (~> 1.2)
-      slop (~> 3.6)
     celluloid (0.16.0)
       timers (~> 4.0.0)
-    coderay (1.1.0)
-    columnize (0.9.0)
     connection_pool (2.1.0)
     dante (0.1.5)
-    debugger-linecache (1.2.0)
     delayed_job (4.0.6)
       activesupport (>= 3.0, < 5.0)
+    delayed_job_active_record (4.0.3)
+      activerecord (>= 3.0, < 5.0)
+      delayed_job (>= 3.0, < 4.1)
     diff-lcs (1.2.5)
     erubis (2.7.0)
     globalid (0.3.0)
       activesupport (>= 4.1.0)
+    hike (1.2.3)
     hitimes (1.2.2)
     i18n (0.7.0)
     json (1.8.1)
     loofah (2.0.1)
       nokogiri (>= 1.5.9)
-    method_source (0.8.2)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
     mini_portile (0.6.2)
     minitest (5.5.0)
     mono_logger (1.1.0)
     multi_json (1.10.1)
     nokogiri (1.6.5)
       mini_portile (~> 0.6.0)
+    parser (2.2.0.1)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
     pg (0.17.1)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    pry-byebug (2.0.0)
-      byebug (~> 3.4)
-      pry (~> 0.10)
+    powerpack (0.0.9)
     que (0.9.0)
-    queue_classic (2.2.3)
-      pg (~> 0.17.0)
     rack (1.6.0)
     rack-protection (1.5.3)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
+    rails (4.2.0)
+      actionmailer (= 4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      activemodel (= 4.2.0)
+      activerecord (= 4.2.0)
+      activesupport (= 4.2.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.0)
+      sprockets-rails
     rails-deprecated_sanitizer (1.0.3)
       activesupport (>= 4.2.0.alpha)
     rails-dom-testing (1.0.5)
@@ -109,6 +115,7 @@ GEM
       activesupport (= 4.2.0)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
+    rainbow (2.0.0)
     rake (10.4.2)
     redis (3.2.0)
     redis-namespace (1.5.1)
@@ -139,32 +146,38 @@ GEM
     rspec-mocks (3.1.3)
       rspec-support (~> 3.1.0)
     rspec-support (3.1.2)
+    rubocop (0.28.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.7, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.1)
     rufus-scheduler (3.0.9)
       tzinfo
     sequel (4.17.0)
-    serverengine (1.5.10)
-      sigdump (~> 0.2.2)
     sidekiq (3.3.0)
       celluloid (>= 0.16.0)
       connection_pool (>= 2.0.0)
       json
       redis (>= 3.0.6)
       redis-namespace (>= 1.3.1)
-    sigdump (0.2.2)
     sinatra (1.4.5)
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
     slop (3.6.0)
-    sneakers (0.1.1.pre)
-      bunny (~> 1.1.3)
-      serverengine
-      thor
-      thread
-    sucker_punch (1.3.2)
-      celluloid (~> 0.16.0)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
     thor (0.19.1)
-    thread (0.1.4)
     thread_safe (0.3.4)
     tilt (1.4.1)
     timers (4.0.1)
@@ -181,17 +194,16 @@ DEPENDENCIES
   activejob-retry!
   backburner
   delayed_job
-  pry-byebug
-  qu-rails!
-  qu-redis
+  delayed_job_active_record
+  pg
   que
-  queue_classic (< 3.0.0)
+  rails
   rake (>= 10.3)
   resque
   resque-scheduler
   rspec
   rspec-its
+  rubocop
   sequel
   sidekiq
-  sneakers (= 0.1.1.pre)
-  sucker_punch
+  sqlite3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Isaac Seymour
+Copyright (c) 2015 Isaac Seymour
 
 MIT License
 

data/README.md

@@ -1,35 +1,38 @@
-ActiveJob::Retry
+ActiveJob::Retry [![Build Status](https://travis-ci.org/gocardless/activejob-retry.svg?branch=master)](https://travis-ci.org/gocardless/activejob-retry)
 ================
 
-A DSL for automatically retrying ActiveJobs, with exponential backoff.
+**This is an alpha library** in active development, so the API may change.
+
+Automatic retry functionality for ActiveJob. Just `include ActiveJob::Retry` in your job
+class and call one of `constant_retry`, `variable_retry`, or `retry_with` to define your
+retry strategy:
 
 ```ruby
 class ProcessWebhook < ActiveJob::Base
   include ActiveJob::Retry
 
   queue_as :webhooks
-  retry_with limit: 3,                          # Attempt three times and then raise (default: 1)
-             delay: 5,                          # Wait ~5 seconds between attempts (default: 0)
-             retry_exceptions: [TimeoutError]   # Only retry when these errors are raised (default: all)
-             # Could alternatively use:
-             # fatal_exceptions: [StandardError] # Never catch these errors (default: none)
 
-  def perform(webhook)
-    webhook.process!
-  end
-end
-```
+  # Constant delay between attempts:
+  constant_retry limit: 3, delay: 5, retry_exceptions: [TimeoutError, NetworkError]
 
-With exponential backoff:
+  # Or, variable delay between attempts:
+  variable_retry delays: [1, 5, 10, 30]
 
-```ruby
-class ProcessWebhook < ActiveJob::Base
-  include ActiveJob::Retry::ExponentialBackoff
+  # You can also use a custom backoff strategy by passing an object which responds to
+  # `should_retry?(attempt, exception)`, and `retry_delay(attempt, exception)`
+  # to `retry_with`:
+  module ChaoticBackoffStrategy
+    def self.should_retry?(retry_attempt, exception)
+      [true, true, true, true, false].sample
+    end
 
-  queue_as :webhooks
-  backoff_with strategy: [1, 5, 10, 30, 60] # Delay for 1, 5, ... seconds between subsequent retries
-               min_delay_multiplier: 0.8,   # Multiply each delay by a random number between
-               max_delay_multiplier: 1.2    # 0.8 and 1.2 (rounded to nearest second)
+    def self.retry_delay(retry_attempt, exception)
+      (0..10).to_a.sample
+    end
+  end
+
+  retry_with ChaoticBackoffStrategy
 
   def perform(webhook)
     webhook.process!
@@ -37,11 +40,40 @@ class ProcessWebhook < ActiveJob::Base
 end
 ```
 
+#### `constant_retry` options
+`limit`
+:    Maximum number of times to attempt the job (default: 1).
+
+`unlimited_retries`
+:    If set to `true`, this job will be repeated indefinitely until in succeeds. Use with extreme caution.
+
+`delay`
+:    Time between attempts (default: 0).
+
+`retry_exceptions`
+:    A whitelist of exceptions to retry (default: nil, i.e. all exceptions will result in a retry).
+
+`fatal_exceptions`
+:    A blacklist of exceptions to not retry (default: []).
+
+#### `variable_retry` options
+
+`delays`
+:    __required__ An array of delays between attempts. The first attempt will occur whenever you originally enqueued the job to happen.
+
+`min_delay_multiplier`
+:    If supplied, each delay will be multiplied by a random number between this and `max_delay_multiplier`.
+
+`max_delay_multiplier`
+:    The other end of the range for `min_delay_multiplier`. If one is supplied, both must be.
+
+`retry_exceptions`
+:    Same as for `constant_retry`.
+
+`fatal_exceptions`
+:    Same as for `constant_retry`.
+
 Contributing
 ------------
 
-  * Fork the project.
-  * Make your feature addition or bug fix.
-  * Add tests for it.
-  * Document it in the CHANGELOG.md.
-  * Open a PR.
+Contributions are very welcome! Please open a PR or issue on this repo.

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rake/testtask'
 require 'rubygems/package_task'
 
-ACTIVEJOB_ADAPTERS = %w(backburner delayed_job que resque sidekiq)
+ACTIVEJOB_ADAPTERS = %w(backburner delayed_job que resque)
 
 task default: :test
 task test: 'test:default'
@@ -23,7 +23,7 @@ namespace :test do
   end
 
   task 'env:integration' do
-    ENV['AJ_INTEGRATION_TESTS'] = "1"
+    ENV['AJ_INTEGRATION_TESTS'] = '1'
   end
 
   ACTIVEJOB_ADAPTERS.each do |adapter|
@@ -35,7 +35,7 @@ namespace :test do
       t.test_files = FileList['test/cases/**/*_test.rb']
       t.verbose = true
       t.warning = true
-      t.ruby_opts = ["--dev"] if defined?(JRUBY_VERSION)
+      t.ruby_opts = ['--dev'] if defined?(JRUBY_VERSION)
     end
 
     namespace :isolated do
@@ -43,19 +43,20 @@ namespace :test do
         dir = File.dirname(__FILE__)
         Dir.glob("#{dir}/test/cases/**/*_test.rb").all? do |file|
           sh(Gem.ruby, '-w', "-I#{dir}/lib", "-I#{dir}/test", file)
-        end or raise 'Failures'
+        end || raise('Failures')
       end
     end
 
     namespace :integration do
-      Rake::TestTask.new(adapter => ["test:env:#{adapter}", 'test:env:integration']) do |t|
-        t.description = "Run integration tests for #{adapter}"
-        t.libs << 'test'
-        t.test_files = FileList['test/integration/**/*_test.rb']
-        t.verbose = true
-        t.warning = true
-        t.ruby_opts = ["--dev"] if defined?(JRUBY_VERSION)
-      end
+      Rake::TestTask.new(
+        adapter => ["test:env:#{adapter}", 'test:env:integration']) do |t|
+          t.description = "Run integration tests for #{adapter}"
+          t.libs << 'test'
+          t.test_files = FileList['test/integration/**/*_test.rb']
+          t.verbose = true
+          t.warning = true
+          t.ruby_opts = ['--dev'] if defined?(JRUBY_VERSION)
+        end
     end
   end
 end
@@ -66,7 +67,7 @@ def run_without_aborting(tasks)
   tasks.each do |task|
     begin
       Rake::Task[task].invoke
-    rescue Exception
+    rescue StandardError
       errors << task
     end
   end