revision_plate 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b7a681b78b1521300089eec60a31ddf500e2497
+  data.tar.gz: 00b444374ae5a0364fcee8fa9b9dfada64bc30a0
+SHA512:
+  metadata.gz: 2d0a4f7068344548015eceb82d7c8273683be979cb85726f8445514a3a2e62ba9c0548737d4128b75ae57d378b4febc82a3e33bf764dbddef0b21beba3b2be4d
+  data.tar.gz: b0b47299856a9c9373a3c468c7e65d799050e2d88622fb5e59cb57c8b01059429fd485b5dc21fb5687756dc91cef43a0d6687cccc61d98b3eb49c0fc01f474a0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+cache: bundler
+sudo: false
+
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: "ruby-head"
+
+before_install:
+  - gem i bundler -v 1.8.4
+
+script:
+  - bundle exec rake
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Shota Fukumori (sora_h)
+
+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,76 @@
+# RevisionPlate
+
+Rack application and middleware that serves endpoint returns application's `REVISION`.
+
+## Detail
+
+The endpoint returns content of `REVISION`
+
+Content of the endpoint wouldn't be changed even if `REVISION` file has changed. But it'll return 404 when it has removed.
+
+This can be used for health check + remove from service by hand.
+
+This gem is used in [Cookpad](https://info.cookpad.com/).
+And seems several companies runs similar thing (e.g. [GitHub](https://github.com/blog/609-tracking-deploys-with-compare-view)).
+
+## Usage
+
+### typical Rails app
+
+``` ruby
+# Gemfile
+gem 'revision_plate', require: 'revision_plate/rails'
+```
+
+then your Rails application will handle `/site/sha`.
+
+### rack application
+
+``` ruby
+# Gemfile
+gem 'revision_plate'
+
+# config.ru (middleware)
+use RevisionPlate::Middleware, '/site/sha', "#{__dir__}/REVISION"
+
+# config.ru (mount)
+map '/site/sha' do
+  run RevisionPlate::App.new("#{__dir__}/REVISION")
+end
+```
+
+## Test
+
+```
+$ echo 'deadbeef' > REVISION
+$ (... start your app ...)
+$ curl localhost:3000/site/sha
+deadbeef
+$ rm REVISION
+$ curl localhost:3000/site/sha
+REVISION_FILE_REMOVED
+```
+
+## Advanced
+
+### I want to customize (Rails app)
+
+remove `require: 'revision_plate/rails'` from Gemfile, then initialize `RevisionPlate::App` on routes:
+
+```
+# routes.rb
+get '/site/sha' => RevisionPlate::App.new
+get '/site/sha' => RevisionPlate::App.new("/path/to/my/favorite/REVISION")
+```
+
+## Development
+
+### Testing
+
+```
+$ rake test
+```
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1,10 @@
+ENV['gem_push']='false'
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.warning = true
+end
+
+task :default => :test

data/lib/revision_plate.rb

@@ -0,0 +1,3 @@
+require "revision_plate/version"
+require "revision_plate/app"
+require 'revision_plate/middleware'

data/lib/revision_plate/app.rb

@@ -0,0 +1,43 @@
+require 'pathname'
+
+module RevisionPlate
+  class App
+    def initialize(file = nil, path: nil)
+      @file = file
+      @path = path
+      if @file
+        unless @file.kind_of?(Pathname)
+          @file = Pathname.new(@file)
+        end
+      else
+        if defined? Rails
+          @file = Rails.root.join('REVISION')
+        else
+          raise ArgumentError, "couldn't locate REVISION file"
+        end
+      end
+
+      if @file.exist?
+        @revision = @file.read.chomp
+      else
+        @revision = nil
+      end
+    end
+
+    def call(env)
+      unless env['REQUEST_METHOD'] == 'GET' && (@path ? env['PATH_INFO'] == @path : true)
+        return [404, {'Content-Type' => 'text/plain'}, []]
+      end
+
+      if @revision
+        if @file.exist?
+          [200, {'Content-Type' => 'text/plain'}, [@revision, ?\n]]
+        else
+          [404, {'Content-Type' => 'text/plain'}, ["REVISION_FILE_REMOVED\n"]]
+        end
+      else
+        [404, {'Content-Type' => 'text/plain'}, ["REVISION_FILE_NOT_FOUND\n"]]
+      end
+    end
+  end
+end

data/lib/revision_plate/middleware.rb

@@ -0,0 +1,19 @@
+require 'revision_plate/app'
+
+module RevisionPlate
+  class Middleware
+    def initialize(app, path, file = nil, options={})
+      @path = path
+      @app = app
+      @revision_app = App.new(file, **options)
+    end
+
+    def call(env)
+      if env['PATH_INFO'] == @path && env['REQUEST_METHOD'] == 'GET'
+        @revision_app.call(env)
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/revision_plate/rails.rb

@@ -0,0 +1,11 @@
+require 'revision_plate'
+
+if defined?(Rails)
+  module RevisionPlate
+    class Railtie < Rails::Railtie
+      initializer "revision_plate.rails_middleware" do |app|
+        app.middleware.use RevisionPlate::Middleware, '/site/sha'
+      end     
+    end
+  end
+end

data/lib/revision_plate/version.rb

@@ -0,0 +1,3 @@
+module RevisionPlate
+  VERSION = "0.1.1"
+end

data/revision_plate.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'revision_plate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "revision_plate"
+  spec.version       = RevisionPlate::VERSION
+  spec.authors       = ["Shota Fukumori (sora_h)"]
+  spec.email         = ["sorah@cookpad.com"]
+  spec.summary       = %q{Rack middleware and application to show deployed application's revision (commit)}
+  spec.description   = nil
+  spec.homepage      = "https://github.com/sorah/revision_plate"
+  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.add_development_dependency "bundler", ">= 1.7.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5.1"
+  spec.add_development_dependency "rack-test", "~> 0.6.3"
+
+  spec.add_dependency "rack"
+end

data/test/app_test.rb

@@ -0,0 +1,121 @@
+require_relative './test_helper'
+require 'tmpdir'
+
+require 'revision_plate/app'
+
+class AppTest < Minitest::Spec
+  include Rack::Test::Methods
+  alias_method :response, :last_response
+
+  describe 'app' do
+    let(:app) { RevisionPlate::App.new(file) }
+    let(:tmpdir) { Dir.mktmpdir('revision_plate_app_test') }
+    let(:file) { Pathname.new(tmpdir).join('REVISION') }
+
+    before do
+      File.write file.to_s, "a"
+    end
+
+    describe 'with default' do
+      let(:app) { RevisionPlate::App.new }
+
+      describe 'with Rails' do
+        before do
+          RevisionPlate.const_set :Rails, Class.new {
+            def self.root
+              @root
+            end
+            def self.root=(o)
+              @root = Pathname.new(o)
+            end
+          }.tap { |klass|
+            klass.root = tmpdir
+          }
+        end
+
+        after do
+          RevisionPlate.send :remove_const, :Rails
+        end
+
+        it 'returns RAILS_ROOT/REVISION' do
+          get '/'
+          assert_equal 200, response.status
+          assert_equal "a\n", response.body
+        end
+      end
+
+      describe 'without Rails' do
+        it "raises error" do
+          assert_raises(ArgumentError) { app }
+        end
+      end
+    end
+
+    describe 'with path' do
+      let(:app) { RevisionPlate::App.new(file, path: '/site/sha') }
+
+      it "won't respond to request to invalid path" do
+        get '/site/sha'
+        assert_equal 200, response.status
+        assert_equal "a\n", response.body
+
+        post '/site/sha'
+        assert_equal 404, response.status
+
+        get '/site/sha/a'
+        assert_equal 404, response.status
+
+        get '/'
+        assert_equal 404, response.status
+      end
+    end
+
+    it 'returns specified file' do
+      get '/'
+      assert_equal 200, response.status
+      assert_equal "a\n", response.body
+    end
+
+    it 'returns same revision even if updated' do
+      app # ensure to instantiate
+      File.write file.to_s, "b\n"
+
+      get '/'
+      assert_equal 200, response.status
+      assert_equal "a\n", response.body
+    end
+
+    it 'returns 404 for POST request' do
+      post '/'
+      assert_equal 404, response.status
+    end
+
+    it 'returns 404 if removed' do
+      app # ensure to instantiate
+      file.unlink
+
+      get '/'
+      assert_equal 404, response.status
+      assert_equal "REVISION_FILE_REMOVED\n", response.body
+    end
+
+    it 'returns 404 if not exists' do
+      file.unlink
+      app # instantiate
+
+      get '/'
+      assert_equal 404, response.status
+      assert_equal "REVISION_FILE_NOT_FOUND\n", response.body
+    end
+
+    it 'returns 404 if created but it was not existed' do
+      file.unlink
+      app # instantiate
+      File.write file.to_s, "b\n"
+
+      get '/'
+      assert_equal 404, response.status
+      assert_equal "REVISION_FILE_NOT_FOUND\n", response.body
+    end
+  end
+end

data/test/middleware_test.rb

@@ -0,0 +1,75 @@
+require_relative './test_helper'
+require 'tempfile'
+
+require 'revision_plate/middleware'
+
+module RevisionPlate
+  AppOriginal = App
+end
+
+class AppTest < Minitest::Spec
+  include Rack::Test::Methods
+  alias_method :response, :last_response
+
+  describe 'middleware' do
+    let(:tempfile) { Tempfile.new('revision_plate-middielware-test') }
+
+    let(:nextapp) { -> (env) { [200, {'Content-Type' => 'text/plain'}, ['hi']] } }
+    let(:mockapp) do
+      Class.new do
+        def self.instances
+          @instances ||= []
+        end
+
+        def initialize(file, **options)
+          @file = file
+          @options = options
+          self.class.instances << self
+        end
+
+        attr_reader :file, :options
+
+        def call(env)
+          [200, {'Content-Type' => 'text/plain'}, "deadbeef"]
+        end
+      end
+    end
+
+    let(:app) { RevisionPlate::Middleware.new(nextapp, '/site/sha', tempfile.path, opt: :option) }
+
+    before do
+      RevisionPlate.send(:remove_const, :App)
+      RevisionPlate.const_set(:App, mockapp)
+    end
+
+    after do
+      RevisionPlate.send(:remove_const, :App)
+      RevisionPlate.const_set(:App, RevisionPlate::AppOriginal)
+    end
+
+    it 'instantiates App with proper argument' do
+      app
+
+      assert_equal 1, mockapp.instances.size
+      assert_equal({opt: :option}, mockapp.instances.first.options)
+      assert_equal tempfile.path, mockapp.instances.first.file
+    end
+
+    it 'pass-through requests to nextapp' do
+      get '/'
+      assert_equal response.body, 'hi'
+      post '/'
+      assert_equal response.body, 'hi'
+      get '/site'
+      assert_equal response.body, 'hi'
+      post '/site/sha'
+      assert_equal response.body, 'hi'
+    end
+
+    it 'pass requests to RevisionPlate::App on specific path' do
+      get '/site/sha'
+      assert_equal response.body, 'deadbeef'
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest'
+require 'minitest/spec'
+require 'rack/test'
+require "minitest/autorun"

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: revision_plate
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Shota Fukumori (sora_h)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-21 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.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- sorah@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/revision_plate.rb
+- lib/revision_plate/app.rb
+- lib/revision_plate/middleware.rb
+- lib/revision_plate/rails.rb
+- lib/revision_plate/version.rb
+- revision_plate.gemspec
+- test/app_test.rb
+- test/middleware_test.rb
+- test/test_helper.rb
+homepage: https://github.com/sorah/revision_plate
+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
+signing_key: 
+specification_version: 4
+summary: Rack middleware and application to show deployed application's revision (commit)
+test_files:
+- test/app_test.rb
+- test/middleware_test.rb
+- test/test_helper.rb