travis-rollout 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e7b70d440a7f1c5df1b7cb5f8f5b9f7ebed5396
-  data.tar.gz: 9f1ba41d70a47bd4d76083463b6cac812606fc1e
+  metadata.gz: 3a2ad2f94826f209638d29b84780e8cbafd49e0f
+  data.tar.gz: 6960f014a097950b813b30ba1ce789b394eca430
 SHA512:
-  metadata.gz: 7e9ea82639e6dd032c22c86ec80ca9d333e256ad244b41c15d09edaecd14a7cf5eee6e591e593f77a105df4eb2bdfc1bdbdc2d5245bb1e639616650db8949cea
-  data.tar.gz: ad70ac68701d6c5440660309fea0c3403a510fdc569cc8ca5364ba4e4c8ff6ce6d4bca11337504332738d859c1a193b909f7955a9c01631eb39234cccfcb64ad
+  metadata.gz: b810a7a3203d644250271eaffd687477cd1cdfe2b4312aef4cf0d0f6b155a256fdb68eaa1958c5d99c0df528addf9d7dd420760826bf950642a16a2abe6434a8
+  data.tar.gz: 6636bbe4fdfa9a650e61b01a4c1409a7095094ef682227d4c80b5f85cae6222cde7a1dec8607ef8e2cb56517bf9310963e116b49a93c23ae0a185217f07f7b30

data/README.md

@@ -6,25 +6,38 @@ Enable by setting an env var `ROLLOUT` and setting `ENV` to `production` or
 ## Usage
 
 ```ruby
-args = { uid: 1, user: 'svenfuchs', repo: 'travis-hub' }
-Travis::Rollout.run(args) do
-  # reroute the message
+args = {
+  uid:  1
+  user: 'svenfuchs',
+  repo: 'travis-hub'
+}
+
+Rollout.run(:feature, args) do
+  # only runs when active
 end
 ```
 
 This will match:
 
-* uid against the percentage `ROLLOUT_PERCENT`
-* remaining arg values against the env vars `ROLLOUT_USERS` and `ROLLOUT_REPOS` (as comma separated values)
+* uid against the percentage `ROLLOUT_FEATURE_PERCENT`
+* remaining arg values against the env vars `ROLLOUT_FEATURE_USERS` and `ROLLOUT_FEATURE_REPOS` (as comma separated values)
 
-`uid` can be a string or integer. For a string it will calculate the crc32 to
-turn it into an integer.
+For example:
+
+```
+ROLLOUT=feature_foo
+ROLLOUT_FEATURE_FOO_OWNERS=joecorcoran,svenfuchs
+ROLLOUT_FEATURE_FOO_PERCENT=5
+```
+
+The `uid` passed can be a string or integer. For a string it will calculate the
+crc32 to turn it into an integer.
 
 If a redis instance is passed as an option it will additionally check redis:
 
 ```ruby
-Travis::Rollout.run(args, redis: redis) do
-  # reroute the message
+Travis::Rollout.run(feature, args.merge(redis: redis)) do
+  # only runs when active
 end
 ```
 
@@ -33,3 +46,5 @@ It will use the value of the env var `ROLLOUT` as a namespace (e.g. `sync`), and
 * enabling: `sync.rollout.enabled`
 * args: `sync.rollout.users`, `sync.rollout.repos`, `sync.rollout.owners`
 * percentage: `sync.rollout.percent`
+
+Values stored in Redis will take precedence over values stored in the ENV.

data/lib/travis/rollout.rb

@@ -2,111 +2,119 @@ require 'zlib'
 
 module Travis
   class Rollout
-    ENVS = %w(production staging)
-
-    def self.run(*all, &block)
-      rollout = new(*all, &block)
-      rollout.run if rollout.matches?
-    end
-
-    def self.matches?(*all)
-      new(*all).matches?
-    end
+    class Env < Struct.new(:name)
+      def enabled?
+        names.include?(name.to_s)
+      end
 
-    attr_reader :args, :options, :block
+      def values(key)
+        ENV["ROLLOUT_#{name.to_s.upcase}_#{key.to_s.upcase}S"].to_s.split(',')
+      end
 
-    def initialize(args = {}, options = {}, &block)
-      @args, @options, @block = args, options, block
-    end
+      def percent
+        ENV["ROLLOUT_#{name.to_s.upcase}_PERCENT"]
+      end
 
-    def run
-      block.call || true
+      def names
+        ENV['ROLLOUT'].to_s.split(',')
+      end
     end
 
-    def matches?
-      production? and enabled? and (by_owner? or by_repo? or by_user? or by_percent?)
+    class RedisNoop
+      def get(*); end
+      def smembers(*); [] end
     end
 
-    private
-
-      def production?
-        ENVS.include?(ENV['ENV'])
-      end
-
+    class Redis < Struct.new(:name, :redis)
       def enabled?
-        !!ENV['ROLLOUT'] && (!redis || redis.get(:"#{name}.rollout.enabled") == '1')
+        redis.get(:"#{name}.rollout.enabled") == '1'
       end
 
-      def by_owner?
-        !!owner && owners.include?(owner)
+      def percent
+        redis.get(:"#{name}.rollout.percent")
       end
 
-      def owner
-        args[:owner]
+      def values(key)
+        redis.smembers(:"#{name}.rollout.#{key}s")
       end
 
-      def owners
-        read_collection('rollout', 'owners')
+      def redis
+        super || self.redis = RedisNoop.new
       end
+    end
 
-      def by_repo?
-        !!repo && repos.include?(repo)
+    class ByValue < Struct.new(:name, :key, :value, :env, :redis)
+      def matches?
+        !!value && values.include?(value)
       end
 
-      def repo
-        args[:repo]
+      def values
+        values = redis.values(key)
+        values = env.values(key) unless values.any?
+        values
       end
+    end
 
-      def repos
-        read_collection('rollout', 'repos')
+    class ByPercent < Struct.new(:name, :value, :env, :redis)
+      def matches?
+        !!value && value % 100 < percent
       end
 
-      def by_user?
-        !!user && users.include?(user)
+      def percent
+        percent = env.percent || redis.percent || -1
+        percent.to_i
       end
+    end
 
-      def user
-        args[:user]
-      end
 
-      def users
-        read_collection('rollout', 'users')
-      end
+    def self.run(*all, &block)
+      rollout = new(*all, &block)
+      rollout.run if rollout.matches?
+    end
 
-      def by_percent?
-        !!uid && uid % 100 < percent
-      end
+    def self.matches?(*all)
+      new(*all).matches?
+    end
 
-      def uid
-        uid = args[:uid]
-        uid.is_a?(String) ? Zlib.crc32(uid).to_i & 0x7fffffff : uid
-      end
+    attr_reader :name, :args, :block, :redis, :env
 
-      def percent
-        percent = ENV['ROLLOUT_PERCENT'] || redis && redis.get(:"#{name}.rollout.percent") || -1
-        percent.to_i
+    def initialize(name, args, &block)
+      @name  = name
+      @args  = args
+      @block = block
+      @redis = Redis.new(name, args.delete(:redis) )
+      @env   = Env.new(name)
+    end
+
+    def run
+      block.call || true
+    end
+
+    def matches?
+      enabled? and (by_value? or by_percent?)
+    end
+
+    private
+
+      def enabled?
+        env.enabled? || redis.enabled?
       end
 
-      def name
-        ENV['ROLLOUT'].to_s.split('.').first
+      def by_value?
+        by_values.map(&:matches?).inject(&:|)
       end
 
-      def redis
-        options[:redis]
+      def by_values
+        args.map { |key, value| ByValue.new(name, key, value, env, redis) }
       end
 
-      def camelize(string)
-        string.to_s.sub(/./) { |char| char.upcase }
+      def by_percent?
+        ByPercent.new(name, uid, env, redis).matches?
       end
 
-      def read_collection(*path)
-        redis_path = path.map(&:downcase).join('.')
-        env_key = path.map(&:upcase).join('_')
-        if redis
-          redis_collection = redis.smembers(:"#{name}.#{redis_path}")
-          return redis_collection if redis_collection.any?
-        end
-        ENV.fetch(env_key, '').to_s.split(',')
+      def uid
+        uid = args[:uid]
+        uid.is_a?(String) ? Zlib.crc32(uid).to_i & 0x7fffffff : uid
       end
   end
 end

data/lib/travis/rollout/version.rb

@@ -2,6 +2,6 @@ require 'travis/rollout'
 
 module Travis
   class Rollout
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/rollout_spec.rb

@@ -3,16 +3,15 @@ require 'travis/rollout'
 
 describe Travis::Rollout do
   let(:redis) { Redis.new }
-  let(:env)   { %w(ENV ROLLOUT ROLLOUT_OWNERS ROLLOUT_REPOS ROLLOUT_USERS ROLLOUT_PERCENT) }
+  let(:env)   { %w(ENV ROLLOUT ROLLOUT_#{name.upcase}_OWNERS ROLLOUT_#{name.upcase}_REPOS ROLLOUT_#{name.upcase}_USERS ROLLOUT_#{name.upcase}_PERCENT) }
 
-  before  { redis.set("#{name}.rollout.enabled", '1') }
   after   { redis.flushall }
   after   { env.each { |key| ENV.delete(key) } }
   subject { rollout.matches? }
 
   shared_examples_for 'matches by owner name' do
     context 'matches if the given owner name matches the OWNERS env var' do
-      before { ENV['ROLLOUT_OWNERS'] = owner }
+      before { ENV["ROLLOUT_#{name.upcase}_OWNERS"] = owner }
       it { should eq true }
     end
 
@@ -24,7 +23,7 @@ describe Travis::Rollout do
 
   shared_examples_for 'does not match by owner name' do
     context 'does not match even if the given owner name matches the OWNERS env var' do
-      before { ENV['ROLLOUT_OWNERS'] = owner }
+      before { ENV["ROLLOUT_#{name.upcase}_OWNERS"] = owner }
       it { should eq false }
     end
 
@@ -36,7 +35,7 @@ describe Travis::Rollout do
 
   shared_examples_for 'matches by repo slug' do
     context 'matches if the given repo slug matches the REPOS env var' do
-      before { ENV['ROLLOUT_REPOS'] = repo }
+      before { ENV["ROLLOUT_#{name.upcase}_REPOS"] = repo }
       it { should eq true }
     end
 
@@ -48,7 +47,7 @@ describe Travis::Rollout do
 
   shared_examples_for 'does not match by repo slug' do
     context 'does not match even if the given repo slug matches the REPOS env var' do
-      before { ENV['ROLLOUT_REPOS'] = repo }
+      before { ENV["ROLLOUT_#{name.upcase}_REPOS"] = repo }
       it { should eq false }
     end
 
@@ -60,7 +59,7 @@ describe Travis::Rollout do
 
   shared_examples_for 'matches by user name' do
     context 'matches if the given user name matches the REPOS env var' do
-      before { ENV['ROLLOUT_USERS'] = user }
+      before { ENV["ROLLOUT_#{name.upcase}_USERS"] = user }
       it { should eq true }
     end
 
@@ -72,7 +71,7 @@ describe Travis::Rollout do
 
   shared_examples_for 'does not match by user name' do
     context 'does not match even if the given user slug matches the REPOS env var' do
-      before { ENV['ROLLOUT_USERS'] = user }
+      before { ENV["ROLLOUT_#{name.upcase}_USERS"] = user }
       it { should eq false }
     end
 
@@ -84,7 +83,7 @@ describe Travis::Rollout do
 
   shared_examples_for 'matches by percentage' do
     context 'matches if the given id matches the ROLLOUT_PERCENT env var' do
-      before { ENV['ROLLOUT_PERCENT'] = '100' }
+      before { ENV["ROLLOUT_#{name.upcase}_PERCENT"] = '100' }
       it { should eq true }
     end
 
@@ -96,7 +95,7 @@ describe Travis::Rollout do
 
   shared_examples_for 'does not match by percentage' do
     context 'does not match even if the given id matches the ROLLOUT_PERCENT env var' do
-      before { ENV['ROLLOUT_PERCENT'] = '100' }
+      before { ENV["ROLLOUT_#{name.upcase}_PERCENT"] = '100' }
       it { should eq false }
     end
 
@@ -107,26 +106,23 @@ describe Travis::Rollout do
   end
 
   shared_examples_for 'matches by' do |type|
-    context 'with ROLLOUT being set in production' do
-      before  { ENV['ENV'] = 'production' }
-      before  { ENV['ROLLOUT'] = name }
-      include_examples "matches by #{type}"
+    context 'with ROLLOUT being set to another name' do
+      before { ENV['ROLLOUT'] = 'something_else' }
+      include_examples "does not match by #{type}"
     end
 
-    context 'with ROLLOUT being set in staging' do
-      before  { ENV['ENV'] = 'production' }
-      before  { ENV['ROLLOUT'] = name }
+    context 'with ROLLOUT being set to another name, but [name].rollout.enabled being set in redis' do
+      before { ENV['ROLLOUT'] = 'something_else' }
+      before { redis.set("#{name}.rollout.enabled", '1') }
       include_examples "matches by #{type}"
     end
 
-    context 'with ROLLOUT being set in development' do
-      before  { ENV['ENV'] = 'development' }
-      before  { ENV['ROLLOUT'] = name }
-      include_examples "does not match by #{type}"
+    context 'with ROLLOUT being set' do
+      before { ENV['ROLLOUT'] = name }
+      include_examples "matches by #{type}"
     end
 
-    context 'with ROLLOUT not set in production' do
-      before  { ENV['ENV'] = 'production' }
+    context 'with ROLLOUT not being set' do
       include_examples "does not match by #{type}"
     end
   end
@@ -137,7 +133,7 @@ describe Travis::Rollout do
     let(:id)      { '517be336-f16d-45cf-aa9b-a429547af6ad' }
     let(:owner)   { 'carlad' }
     let(:repo)    { 'travis-ci/travis-hub' }
-    let(:rollout) { described_class.new({ uid: id, owner: owner, repo: repo }, redis: redis) }
+    let(:rollout) { described_class.new(name, uid: id, owner: owner, repo: repo, redis: redis) }
 
     include_examples 'matches by', 'owner name'
     include_examples 'matches by', 'repo slug'
@@ -151,7 +147,7 @@ describe Travis::Rollout do
     describe 'in the user sync worker' do
       let(:id)      { 1 }
       let(:user)    { 'carlad' }
-      let(:rollout) { described_class.new({ uid: id, user: user }, redis: redis) }
+      let(:rollout) { described_class.new(name, uid: id, user: user, redis: redis) }
 
       include_examples 'matches by', 'user name'
       include_examples 'matches by', 'percentage'
@@ -160,7 +156,7 @@ describe Travis::Rollout do
     describe 'in the repo branches sync worker' do
       let(:id)      { 1 } # user id
       let(:owner)   { 'carlad' }
-      let(:rollout) { described_class.new({ uid: id, owner: owner }, redis: redis) }
+      let(:rollout) { described_class.new(name, uid: id, owner: owner, redis: redis) }
 
       include_examples 'matches by', 'owner name'
       include_examples 'matches by', 'percentage'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: travis-rollout
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Travis CI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2017-07-26 00:00:00.000000000 Z
 dependencies: []
 description: Small helper class for rolling out apps.
 email: contact@travis-ci.org
@@ -20,14 +20,13 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
-- exercise.md
 - lib/travis/rollout.rb
 - lib/travis/rollout/version.rb
 - spec/rollout_spec.rb
 - spec/spec_helper.rb
-- travis-rollout.gemspec
 homepage: https://github.com/travis-ci/travis-rollout
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -45,9 +44,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Small helper class for rolling out apps
 test_files: []
-has_rdoc: 

data/exercise.md

@@ -1,25 +0,0 @@
-Refactor the class `Travis::Rollout` and remove the duplication of the methods
-`by_[owner|repo|user]?`, `[owner|repo|user]s` etc.
-
-Doing so also allow arbirary `args` hash to be passed:
-
-```
-args = {
-  uid:  1
-  user: 'carlad',
-  repo: 'travis-hub'
-  foo:  'bar'
-}
-
-Rollout.reroute(args) do
-  # reroute the message
-end
-
-```
-
-This would:
-
-* Match the `uid` against the percentage.
-* Not match the `uid` against the env var `ROLLOUT_UID` (i.e. ignore this case)
-* Match the strings `carlad`, `travis-hub` and `bar` against the respective env
-  vars `ROLLOUT_USERS`, `ROLLOUT_REPOS`, and `ROLLOUT_FOOS`

data/travis-rollout.gemspec

@@ -1,18 +0,0 @@
-# encoding: utf-8
-
-$:.unshift File.expand_path('../lib', __FILE__)
-require 'travis/rollout/version'
-
-Gem::Specification.new do |s|
-  s.name          = 'travis-rollout'
-  s.version       = Travis::Rollout::VERSION
-  s.authors       = ['Travis CI']
-  s.email         = 'contact@travis-ci.org'
-  s.homepage      = 'https://github.com/travis-ci/travis-rollout'
-  s.summary       = 'Small helper class for rolling out apps'
-  s.description   = "#{s.summary}."
-
-  s.files         = Dir['{lib/**/*,spec/**/*,[A-Z]*}']
-  s.platform      = Gem::Platform::RUBY
-  s.require_paths = ['lib']
-end