sidekiq-canary 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1d70babb0731334a12b32373daf2ec13ca6c1e5
-  data.tar.gz: 459773c95cf6d8315d9cd378acc0b5045c55381d
+  metadata.gz: 4bbe12a582fdcf9139fe6e92078034cc5ba57512
+  data.tar.gz: b6586e2fe81e62b9e8102e1bc6c4f655d49bcd82
 SHA512:
-  metadata.gz: 18b96079386ac88bf0cc2d933eb48dac506e2eb729caa8318540d1660de213f3b5f5e2f6c9ba32ac342766dca2a232e3403ddf433a183c4d6a361a6d830e37c4
-  data.tar.gz: fdcc0401f4f20cb6b5ef4584f89b4c5b962cb2ba20144254e80f342fcda72767ccdf05ac0de2aa8594c8cd372de97b95573b28cb56797b1480cb9dd75696e317
+  metadata.gz: 36d9c309b57fa512848c0f550428566bcf5b66a5f900eab4aa9724ea2dd75345a21afcaa18bf7aa2340657926cd6db79b6a90421e434b7c2a5fca6fcbfd20b86
+  data.tar.gz: ce5bb550463bae5c871d89d0b3c754d47b5abbcb9195224ff33fb4057fdb538cadc829c76094f292e39c64683a2320ad3de37b9400978a94386df03e40db4417

data/.gitignore

@@ -1,2 +1,2 @@
 .bundle
-
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 2.3.1

data/README.md

@@ -2,3 +2,50 @@
 [![Build Status](https://travis-ci.org/dmathieu/sidekiq-canary.svg?branch=master)](https://travis-ci.org/dmathieu/sidekiq-canary)
 
 Deploy sidekiq sensitive changes in canaries
+
+## Installation
+
+Add the gem to your Gemfile
+
+```ruby
+gem 'sidekiq-canary'
+```
+
+Extend your workers with it
+
+```ruby
+class MyAwesomeWorker
+  include Sidekiq::Worker
+  extend Sidekiq::Canary
+
+  def perform
+    # Do something awesome
+  end
+end
+```
+
+## Usage
+
+Sidekiq Canary will allow you to randomly push workers to a queue or another.
+That means if you deploy a new version of your worker in another app, running
+the canary queue, only a random subset of them will run the new version.
+
+All other ones will keep running as before. If a failure happens, the same
+randomizer will be applied again.
+
+In order to do that, you need two apps. Your main one will run the default queue.
+The second one will run a `default_canary` queue.
+
+when deploying a sensitive change, you need to deploy the canary app only, and
+set the `default_canary_percent` environment variable on the app which triggers
+the job.
+
+Once this is done, all jobs will have the specified percentage number of
+chances of being picked to run in the canary instead of the main app.
+
+When your experiment is over, you can bring back the canary percentage to zero
+and deploy your changes to your main app.
+
+## Demo
+
+![demo](demo.gif)

data/lib/sidekiq/canary/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Canary
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/sidekiq-canary.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'sidekiq', '~> 3.0'
+  gem.add_dependency 'sidekiq'
 
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-canary
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Damien Mathieu
@@ -14,16 +14,30 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        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
@@ -46,11 +60,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- demo.gif
 - lib/sidekiq-canary.rb
 - lib/sidekiq/canary.rb
 - lib/sidekiq/canary/version.rb

data/Gemfile.lock

@@ -1,64 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sidekiq-canary (0.0.1)
-      sidekiq (~> 3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    celluloid (0.17.3)
-      celluloid-essentials
-      celluloid-extras
-      celluloid-fsm
-      celluloid-pool
-      celluloid-supervision
-      timers (>= 4.1.1)
-    celluloid-essentials (0.20.5)
-      timers (>= 4.1.1)
-    celluloid-extras (0.20.5)
-      timers (>= 4.1.1)
-    celluloid-fsm (0.20.5)
-      timers (>= 4.1.1)
-    celluloid-pool (0.20.5)
-      timers (>= 4.1.1)
-    celluloid-supervision (0.20.5)
-      timers (>= 4.1.1)
-    connection_pool (2.2.0)
-    diff-lcs (1.2.5)
-    hitimes (1.2.4)
-    json (1.8.3)
-    redis (3.3.0)
-    redis-namespace (1.5.2)
-      redis (~> 3.0, >= 3.0.4)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    sidekiq (3.5.4)
-      celluloid (~> 0.17.2)
-      connection_pool (~> 2.2, >= 2.2.0)
-      json (~> 1.0)
-      redis (~> 3.2, >= 3.2.1)
-      redis-namespace (~> 1.5, >= 1.5.2)
-    timers (4.1.1)
-      hitimes
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rspec
-  sidekiq-canary!
-
-BUNDLED WITH
-   1.12.1