rack-xrevision 0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michal Wrobel
+
+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,46 @@
+# rack-xrevision
+
+  Rack middleware, that adds X-Rev header with revision id (git commit id)
+
+  By default it looks for REVISON file that capistrano adds during deploy,
+  if it doesn't find it, then it tries to run git, and get the latest commit
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-xrevision'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-xrevision
+
+## Usage
+
+in config/application.rb
+
+    config.middleware.use Rack::Xrevision, :app_path => Rails.root
+
+
+in config.ru
+
+    use Rack::Xrevision, :app_path => Dir.pwd
+
+
+### Options:
+
+  :app_path - Specify app directory, by default it's Dir.pwd 
+
+  :file_name - File with revision number, default is 'REVISION'
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rack-xrevision.rb

@@ -0,0 +1 @@
+require 'rack/xrevision'

data/lib/rack/xrevision.rb

@@ -0,0 +1,41 @@
+module Rack
+  class Xrevision
+    REVISION_FILE_NAME = 'REVISION'
+    def initialize(app, options={})
+      @app = app
+      @app_path = options[:app_path] || Dir.pwd
+      @revision_file_name = options[:file_name] || REVISION_FILE_NAME
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+      headers['X-Rev'] = rev_id if rev_id
+      [status, headers, response]
+    end
+
+    def rev_id
+      @rev_id ||= begin
+        load_from_file || load_from_git
+      end
+    end
+
+    def revision_file_path
+      "#{@app_path}/#{@revision_file_name}"
+    end
+
+    private
+    def load_from_file
+      return nil unless ::File.exists?(revision_file_path)
+
+      ::File.read(revision_file_path)
+    end
+
+    def load_from_git
+      return '' unless system('which git 1> /dev/null')
+
+      Dir.chdir @app_path do
+        %x[(git rev-list master | head -n 1) 2> /dev/null]
+      end
+    end
+  end
+end

data/lib/rack/xrevision/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Xrevision
+    VERSION = '0.1'
+  end
+end

data/spec/xrevision_spec.rb

@@ -0,0 +1,81 @@
+require 'fileutils'
+require 'rack/builder'
+require 'rack/mock'
+require_relative '../lib/rack-xrevision'
+
+describe Rack::Xrevision do
+  let(:app_path) { "/tmp/test_app_#{Time.now.to_i}" }
+  let(:app) {
+    lambda { |env| [200, {}, ['hello, this is dog']] }
+  }
+
+  before do
+    FileUtils.mkdir app_path
+  end
+
+  after do
+    FileUtils.remove_dir app_path
+  end
+
+  let(:env) { Hash.new }
+
+  it 'checks if X-Rev header is present' do
+    path = app_path
+    app = Rack::Builder.new do
+      use Rack::Xrevision, :app_path => path
+      run lambda { |env|
+        [
+          200,
+          { 'Content-Type' => 'text/html' },
+          ["<html><head></head><body>Hello, yes this is dog</body></html>"]
+        ]
+      }
+    end
+    response = Rack::MockRequest.new(app).get('/')
+
+    response.headers.should include('X-Rev')
+  end
+
+  context 'when there is a REVISION file' do
+    let(:xrevision) { Rack::Xrevision.new(app, :app_path => app_path) }
+    let(:rev_id) { "ff9429886dd39e4c765881673de9ca8c5bdb6f84" }
+    let(:revision_file_path) { "#{app_path}/REVISION" }
+
+    before do
+      File.open(revision_file_path, 'w') do |file|
+        file.write rev_id
+      end
+    end
+
+    it 'adds x-commit-id header to response' do
+      status, headers, body = xrevision.call(env)
+      headers['X-Rev'].should_not be_nil
+      headers['X-Rev'].should == rev_id
+    end
+  end
+
+  context 'when there is no REVISION file' do
+    let(:xrevision) { Rack::Xrevision.new(app, :app_path => app_path) }
+
+    context 'and app is not in git repo' do
+      it 'doesn\' add X-commit-id header' do
+        status, headers, body = xrevision.call(env)
+        headers['X-Rev'].should == ''
+      end
+    end
+
+    context 'and app is in git repo' do
+      before do
+        Dir.chdir app_path do
+          `git init && touch foo && git add . && git commit -m 'initial commit'`
+          @rev_id = %x[git rev-list master | head -n 1]
+        end
+      end
+
+      it 'call git command to get latest commit id' do
+        status, headers, body = xrevision.call(env)
+        headers['X-Rev'].should == @rev_id
+      end
+    end
+  end
+end

data/xrevision.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/xrevision/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rack-xrevision"
+  gem.version       = Rack::Xrevision::VERSION
+  gem.authors       = ["Michal Wrobel"]
+  gem.email         = ["sparrovv@gmail.com"]
+  gem.description   = %q{Rack middleware that puts revision id into response headers}
+  gem.summary       = %q{Rack middleware that puts revision id into response headers }
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency('rack')
+  gem.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: rack-xrevision
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Michal Wrobel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack middleware that puts revision id into response headers
+email:
+- sparrovv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-xrevision.rb
+- lib/rack/xrevision.rb
+- lib/rack/xrevision/version.rb
+- spec/xrevision_spec.rb
+- xrevision.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack middleware that puts revision id into response headers
+test_files:
+- spec/xrevision_spec.rb
+has_rdoc: