gates 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d315c3d1a09f58d881ff8c9a8c9653bcd76bfa2
+  data.tar.gz: 8e530fdd6543793fcaa443dbb2a08305d2942ebe
+SHA512:
+  metadata.gz: 9810eed9e438a0b213f54eefa9c5e7435aec3541240caa52a7ccffc80eaa576bdd9d5c7785e1ae719a86dd35786bbace8caaf84f7d62f0946b5e728b351e7aeb
+  data.tar.gz: 17bf56e8bd2114185b8ff1817f60c3ccc8be8d9a60440fc9ef0f414d843145b559e9120aba616bd38924247480439c59dfb3935efd65a2727955b6cc180cf3b4

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 @@
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+cache: bundler
+before_script:
+  - 'echo ''gem: --no-ri --no-rdoc'' > ~/.gemrc' # skip installing docs for gems
+before_install:
+  - gem install bundler -v ">= 1.7.0" # Minimum version of bundler required
+script: 'bundle exec rspec'
+rvm:
+  - 2.1
+  - 2.2.2
+  - 2.3.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Phill Baker
+
+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,94 @@
+# Gates
+
+[![Build
+Status](https://travis-ci.org/phillbaker/gates.png?branch=master)](https://travis-ci.org/phillbaker/gates)
+
+This is an implementation of the ideas expressed in this post about Stripe's public API versioning, [Move fast, don't break your API](http://amberonrails.com/move-fast-dont-break-your-api/). The goal is to separate layers of request and response compatibility from the API logic, with two important drivers:
+ * let your customers migrate API versions at their convenience, minimize the pain of upgrades when they do upgrade.
+ * make it feasible to fix backward incompatible API schema mistakes (they will happen).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gates'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gates
+
+## Usage
+
+Check for whether a gate is enabled:
+
+```ruby
+version = request.api_version || user.api_version
+version = Gates.for(version)
+version.enabled?(:foo) # => true / false
+
+Gates.available_versions # => [<Gates::ApiVersion ...>]
+```
+
+In CI make sure to lint the version manifest:
+
+```ruby
+rake gates:lint
+```
+
+This can be combined with A/B testing or feature flipping like:
+
+```ruby
+def foo
+  return unless feature_enabled?(user, :foo) || ab_test?(:foo) || version.enabled?(:foo)
+
+  "foo"
+end
+```
+
+```yaml
+----
+versions:
+  -
+    id: 2016-01-30-1
+    gates:
+      -
+        name: reallows_amount
+        description: |
+          Just kidding. Sending amount is supported for some folks.
+  -
+    id: 2016-01-30
+    gates:
+      -
+        name: disallows_amount
+        description: |
+          Sending amount is now deprecated.
+  -
+    id: 2016-01-20
+    gates:
+      -
+        name: allows_amount
+        description: |
+          Sending amount is supported.
+```
+
+### Testing
+
+Make sure to test both paths in order to not break compatibility!
+
+## Similar projects
+
+* [multiverse in Elixir](https://github.com/Nebo15/multiverse)
+
+## Contributing
+
+1. Fork it ( https://github.com/phillbaker/gates/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/gates.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gates/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gates"
+  spec.version       = Gates::VERSION
+  spec.authors       = ["Phillip Baker"]
+  spec.email         = ["phillbaker@retrodict.com"]
+  spec.summary       = %q{Permanent backwards compatibility for changing APIs.}
+  spec.homepage      = "https://github.com/phillbaker/gates"
+  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.required_ruby_version = ">= 2.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/gates.rb

@@ -0,0 +1,26 @@
+require "yaml"
+
+require "gates/api_version"
+require "gates/gate"
+require "gates/manifest"
+require "gates/version"
+
+module Gates
+  Error = Class.new(StandardError)
+  UninitializedError = Class.new(Gates::Error)
+
+  class<<self
+    attr_accessor :manifest
+
+    def load(file_path)
+      hash = Psych.parse_file(file_path)
+      @manifest = Manifest.new(hash)
+    end
+
+    def for(version_id)
+      raise UninitializedError unless @manifest
+
+      @manifest[version_id]
+    end
+  end
+end

data/lib/gates/api_version.rb

@@ -0,0 +1,17 @@
+module Gates
+  class ApiVersion
+    attr_accessor :id, :gates, :predecessor
+
+    def enabled?(gate_name)
+      if gates.include?(gate_name)
+        true
+      elsif !predecessor.nil?
+        # recurse to check list of all gates less than or equal to this api
+        # version
+        !!predecessor.enabled?(gate_name)
+      else
+        false
+      end
+    end
+  end
+end

data/lib/gates/gate.rb

@@ -0,0 +1,9 @@
+module Gates
+  class Gate
+    attr_accessor :name
+
+    def ==(other_name)
+      name.to_s == other_name.to_s
+    end
+  end
+end

data/lib/gates/manifest.rb

@@ -0,0 +1,32 @@
+module Gates
+  class Manifest
+    attr_accessor :version_map
+
+    def initialize(manifest_hash)
+      versions = []
+      # iterate backward through the versions to be able to associate the
+      # predecessor with each
+      manifest_hash['versions'].reverse.each do |version_info|
+        version = ApiVersion.new
+        version.id = version_info['id']
+        version.gates = version_info['gates'].map do |gate_info|
+          gate = Gate.new
+          gate.name = gate_info['name']
+          gate
+        end
+        version.predecessor = versions.first
+
+        versions << version
+      end
+
+      self.version_map = {}
+      versions.each do |version|
+        version_map[version.id] = version
+      end
+    end
+
+    def [](version_id)
+      version_map[version_id]
+    end
+  end
+end

data/lib/gates/version.rb

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

data/spec/gates/api_version_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+require "spec_helper"
+
+describe Gates::ApiVersion do
+  describe "#enabled?" do
+    let(:initial_version) do
+      version = Gates::ApiVersion.new
+      version.id = "2016-01-29"
+      gate = Gates::Gate.new
+      gate.name = "allows_foo"
+      version.gates = [gate]
+      version
+    end
+    let(:later_version) do
+      version = Gates::ApiVersion.new
+      version.id = "2016-01-30"
+      gate = Gates::Gate.new
+      gate.name = "allows_bar"
+      version.gates = [gate]
+      version.predecessor = initial_version
+      version
+    end
+
+    context "without predecessor" do
+      it "is true for existing gates" do
+        expect(initial_version.enabled?("allows_foo")).to be_truthy
+      end
+
+      it "is false for non-existing gates" do
+        expect(initial_version.enabled?("allows_cat")).to be_falsey
+      end
+    end
+
+    context "with predecessor" do
+      it "is true for existing gates" do
+        expect(later_version.enabled?("allows_bar")).to be_truthy
+      end
+
+      it "is true for predecessor existing gates" do
+        expect(later_version.enabled?("allows_foo")).to be_truthy
+      end
+
+      it "is false for non-existing gates" do
+        expect(later_version.enabled?("allows_cat")).to be_falsey
+      end
+    end
+  end
+end

data/spec/gates/manifest_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Gates::Manifest do
+  describe "#initialize" do
+    let(:manifest_data) {
+      {
+        "versions" => [
+          {
+            "id" => "2016-01-30",
+            "gates" => [
+              "name" => "allows_bar"
+            ]
+          },
+          {
+            "id" => "2016-01-29",
+            "gates" => [
+              "name" => "allows_foo"
+            ]
+          },
+        ]
+      }
+    }
+    let(:manifest) { Gates::Manifest.new(manifest_data) }
+
+    it "fills the version_map" do
+      expect(manifest.version_map.size).to eq 2
+    end
+
+    it "sets the api version gates" do
+      verison = manifest.version_map["2016-01-30"]
+      expect(verison.gates.size).to eq 1
+    end
+
+    it "calculates the version predecessor" do
+      earlier_version = manifest.version_map["2016-01-30"].predecessor
+      expect(earlier_version.id).to eq "2016-01-29"
+    end
+  end
+
+  describe "#[]"
+end

data/spec/gates_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Gates do
+  it "has a version number" do
+    expect(Gates::VERSION).not_to be nil
+  end
+
+  describe ".for" do
+    let(:manifest_data) {
+      {
+        "versions" => [
+          {
+            "id" => "2016-01-30",
+            "gates" => [
+              "name" => "allows_special"
+            ]
+          },
+        ]
+      }
+    }
+    let(:manifest) { Gates::Manifest.new(manifest_data) }
+
+    it "returns an api version" do
+      Gates.manifest = manifest
+      expect(Gates.for("2016-01-30")).to be_a(Gates::ApiVersion)
+    end
+
+    it "returns nil if no api version exists"
+    it "raises on uninitialized"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'gates'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: gates
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Phillip Baker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-30 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: 
+email:
+- phillbaker@retrodict.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gates.gemspec
+- lib/gates.rb
+- lib/gates/api_version.rb
+- lib/gates/gate.rb
+- lib/gates/manifest.rb
+- lib/gates/version.rb
+- spec/gates/api_version_spec.rb
+- spec/gates/manifest_spec.rb
+- spec/gates_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/phillbaker/gates
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Permanent backwards compatibility for changing APIs.
+test_files:
+- spec/gates/api_version_spec.rb
+- spec/gates/manifest_spec.rb
+- spec/gates_spec.rb
+- spec/spec_helper.rb