gated_release 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76ee56e30f5bec17b5b0b170ae36c54c1890eae0
+  data.tar.gz: 11a70be7aed859789307ccf302bd5423efac9a75
+SHA512:
+  metadata.gz: 92d02bd595b2df90cbdf2f826f20433f16d41409f8ea1d58499edf9a6aa0f7c82b8553a8f9f9648d3cc02cae3f9de8499a1e24e07c52dcb6d41b733654160db8
+  data.tar.gz: fe7ac538785a7247b5a5bdc7c5dea596a549afe665f85fe5a29bd3cf81edaf5d8724c5fb7092a7768104fbb71ef156a357ffe52838869dc92f102ce5483b31fe

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.14.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at david.carlin@redbubble.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    gated_release (0.1.0)
+      activerecord (>= 4.0, < 6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
+      arel (~> 7.0)
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    database_cleaner (1.5.3)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    generator_spec (0.9.3)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    i18n (0.8.1)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    method_source (0.8.2)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nokogiri (1.7.0.1)
+      mini_portile2 (~> 2.1.0)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    sqlite3 (1.3.13)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  database_cleaner (~> 1.5)
+  gated_release!
+  generator_spec (~> 0.9.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3 (~> 1.3)
+
+BUNDLED WITH
+   1.14.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 David Carlin
+
+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,75 @@
+# GatedRelease
+
+This gem allows you to easily manage split code paths in your application without redeploys.
+
+## Installation
+
+### Gem
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gated_release', '0.1.0' # see semver.org
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gated_release
+
+### Setup
+
+Generate and migrate the installation database migration
+
+```
+$ bundle exec rails generate gated_release:install
+$ bundle exec rake db:migrate
+```
+
+## Usage
+
+```ruby
+GatedRelease::Gate.get('gate-name').run(
+  open: -> { code_to_run_for_open_gate },
+  closed: -> { code_to_run_for_closed_gate }
+)
+```
+
+To open the gate:
+```ruby
+GatedRelease::Gate.get('gate-name').open!
+```
+
+To close the gate
+```ruby
+GatedRelease::Gate.get('gate-name').close!
+```
+
+To put the gate into a limited state, and allow a set number of code executions to go through the open gate before closing.
+```ruby
+GatedRelease::Gate.get('gate-name').limit!.allow_more!(10)
+```
+
+To put the gate into 'percentage' state, where a set percentage of code executions will go throught he open gate.
+```ruby
+GatedRelease::Gate.get('gate-name').percentage!(10)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/redbubble/gated_release. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/gated_release.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gated_release/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gated_release"
+  spec.version       = GatedRelease::VERSION
+  spec.authors       = ["David Carlin", "Gonzalo Bulnes Guilpain"]
+  spec.email         = ["davich@gmail.com", "gon.bulnes@gmail.com"]
+  spec.summary       = %q{Allow split code paths.}
+  spec.description   = %q{Gated releases will let you launch your new feature behind a toggle switch that doesn't require a redeploy.}
+  spec.homepage      = "http://www.github.com/redbubble/gated_release"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|vendor|bin)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 4.0", "< 6"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "database_cleaner", "~> 1.5"
+  spec.add_development_dependency "generator_spec", "~> 0.9.0"
+end

data/lib/gated_release.rb

@@ -0,0 +1,6 @@
+require "gated_release/version"
+require "gated_release/gate"
+require "generators/install_generator"
+
+module GatedRelease
+end

data/lib/gated_release/gate.rb

@@ -0,0 +1,87 @@
+require "active_record"
+
+module GatedRelease
+  class Gate < ActiveRecord::Base
+    self.table_name = "gated_release_gates"
+
+    OPEN = 'open'
+    CLOSED = 'closed'
+    LIMITED = 'limited'
+    PERCENTAGE = 'percentage'
+    STATES = [OPEN, CLOSED, LIMITED, PERCENTAGE]
+
+    validates_uniqueness_of :name
+    validates :state, inclusion: { in: STATES }
+    validates :percent_open, :inclusion => 0..100
+
+    def self.get(name)
+      find_or_create_by(name: name)
+    end
+
+    def allow_more!(count)
+      increment!(:max_attempts, count)
+      self
+    end
+
+    def open!
+      update_attributes!(state: OPEN)
+      self
+    end
+
+    def close!
+      update_attributes!(state: CLOSED)
+      self
+    end
+
+    def limit!
+      update_attributes!(state: LIMITED)
+      self
+    end
+
+    def percentage!(value)
+      update_attributes!(state: PERCENTAGE, percent_open: value)
+      self
+    end
+
+    def run(args)
+      if self.state == OPEN
+        run_open_code(args)
+      elsif self.state == PERCENTAGE && Kernel.rand(100) < self.percent_open
+        run_open_code(args)
+      elsif self.state == LIMITED && self.attempts < self.max_attempts
+        increment_attempts
+        run_open_code(args)
+      else
+        get_closed_code(args).call
+      end
+    end
+
+    private
+
+    def run_open_code(args)
+      get_open_code(args).call
+    rescue StandardError, ScriptError => e
+      close! if args[:close_on_error]
+      raise
+    end
+
+    def get_open_code(args)
+      get_arg(args, :open)
+    end
+
+    def get_closed_code(args)
+      get_arg(args, :closed)
+    end
+
+    def get_arg(args, key)
+      unless args.has_key?(key)
+        raise KeyError.new("key not found: :#{key} for gated release: #{name}")
+      end
+      args[key]
+    end
+
+    def increment_attempts
+      increment!(:attempts, 1)
+    end
+  end
+end

data/lib/gated_release/version.rb

@@ -0,0 +1,3 @@
+module GatedRelease
+  VERSION = "0.1.0"
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,23 @@
+require 'active_record'
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module GatedRelease
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "Add the migrations for GatedRelease"
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_migrations
+        migration_template "create_gated_release_gates.rb",
+          "db/migrate/create_gated_release_gates.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/create_gated_release_gates.rb

@@ -0,0 +1,14 @@
+class CreateGatedReleaseGates < ActiveRecord::Migration
+  def change
+    create_table :gated_release_gates do |t|
+      t.string :name
+      t.string :state, default: 'limited'
+      t.integer :attempts, default: 0
+      t.integer :max_attempts, default: 0
+      t.integer :percent_open, default: 0
+
+      t.timestamps
+    end
+    add_index :gated_release_gates, :name
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: gated_release
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Carlin
+- Gonzalo Bulnes Guilpain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Gated releases will let you launch your new feature behind a toggle switch
+  that doesn't require a redeploy.
+email:
+- davich@gmail.com
+- gon.bulnes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- gated_release.gemspec
+- lib/gated_release.rb
+- lib/gated_release/gate.rb
+- lib/gated_release/version.rb
+- lib/generators/install_generator.rb
+- lib/generators/templates/create_gated_release_gates.rb
+homepage: http://www.github.com/redbubble/gated_release
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Allow split code paths.
+test_files: []