rack-revision 1.0.0

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+\#*
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+end

data/README.md

@@ -0,0 +1,50 @@
+# Rack::Revision
+
+Rack::Revision is a quick drop-in component to enable code revision tracking. 
+It adds `X-Revision` header with the code revision from capistrano's REVISION file.
+
+## Installation
+
+From rubygems:
+
+```
+gem install rack-revision
+```
+
+## Usage
+
+Rack::Revision is implemented as a piece of Rack middleware and can be used with
+any Rack-based application. If you have a `configu.ru` rackup file you can 
+drop the following:
+
+```ruby
+require 'rack/revision'
+
+use Rack::Revision
+
+run YourApp
+```
+
+Configuration options:
+
+- `:header` - Set a custom revision header. Default: `X-Revision`
+- `:filename` - Set a filename with revision data. Default: `REVISION`
+- `:default` - Override default `UNDEFINED` revision value
+
+## Test
+
+Execute test suite:
+
+```
+rake test
+```
+
+## License
+
+Copyright (c) 2012 Dan Sosedoff.
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.warning = false
+end

data/lib/rack/revision/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Revision
+    VERSION = '1.0.0'
+  end
+end

data/lib/rack/revision.rb

@@ -0,0 +1,39 @@
+require 'rack'
+
+module Rack
+  class Revision
+    File = ::File
+    @@revision = nil
+
+    def initialize(app, options={})
+      @options = {
+        :header   => options[:header]   || 'X-Revision',
+        :filename => options[:filename] || 'REVISION',
+        :default  => options[:default]  || 'UNDEFINED' 
+      }
+
+      @app = app
+      @file = File.join(Dir.pwd, @options[:filename])
+    end
+ 
+    def call(env)
+      status, headers, body = @app.call(env)
+      headers[@options[:header]] = revision
+      [status, headers, body]
+    end
+
+    def reset_revision
+      @@revision = nil
+    end
+ 
+    protected
+ 
+    def revision
+      @@revision ||= read_revision
+    end
+ 
+    def read_revision
+      File.exists?(@file) ? File.read(@file).strip : @options[:default]
+    end
+  end
+end

data/rack-revision.gemspec

@@ -0,0 +1,18 @@
+require File.expand_path('../lib/rack/revision/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rack-revision"
+  s.version     = Rack::Revision::VERSION
+  s.summary     = "Code ravision rack middleware"
+  s.description = "Adds an extra X-REVISION header with source code revision string (git, svn, etc)"
+  s.homepage    = "http://github.com/sosedoff/rack-revision"
+  s.authors     = ["Dan Sosedoff"]
+  s.email       = ["dan.sosedoff@gmail.com"]
+    
+  s.add_runtime_dependency 'rack', '>= 1.0'
+  
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables        = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.require_paths      = ["lib"]
+end

data/test/test_revision.rb

@@ -0,0 +1,81 @@
+require 'test/unit'
+require 'rack/test'
+require 'rack/revision'
+require 'fileutils'
+
+class TestRevision < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def default_app
+    lambda do |env|
+      headers = {'Content-Type' => "text/html"}
+      [200, headers, ["OK"]]
+    end
+  end
+
+  def app
+    @app ||= Rack::Revision.new(default_app)
+  end
+
+  def app_url
+    "http://foobar.com/"
+  end
+
+  attr_writer :app
+
+  def setup
+    FileUtils.mkdir('./test/tmp')
+  end
+
+  def teardown
+    FileUtils.rm_rf('./test/tmp')
+  end
+
+  def test_revision_request
+    self.app.reset_revision
+    get app_url
+
+    assert last_response.ok?
+  end
+
+  def test_presence
+    self.app.reset_revision
+    get app_url
+
+    assert_not_nil last_response.headers['X-REVISION']
+    assert_not_nil last_response.headers['X-Revision']
+  end
+
+  def test_default_value
+    self.app.reset_revision
+    get app_url
+
+    assert_equal "UNDEFINED", last_response.headers['X-Revision']
+  end
+
+  def test_custom_value
+    self.app = Rack::Revision.new(default_app, :default => "FOOBAR")
+    self.app.reset_revision
+
+    get app_url
+    assert_equal "FOOBAR", last_response.headers['X-Revision']
+  end
+
+  def test_custom_header
+    self.app = Rack::Revision.new(default_app, :header => "FOOBAR")
+    self.app.reset_revision
+
+    get app_url
+    assert_not_nil last_response.headers['FOOBAR']
+  end
+
+  def test_default_filename
+    File.open('./test/tmp/REVISION', 'w') { |f| f.write('qwe123') }
+
+    self.app = Rack::Revision.new(default_app, :filename => './test/tmp/REVISION')
+    self.app.reset_revision
+
+    get app_url
+    assert_equal 'qwe123', last_response.headers['X-Revision']
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: rack-revision
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Dan Sosedoff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+description: Adds an extra X-REVISION header with source code revision string (git, svn, etc)
+email: 
+- dan.sosedoff@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/rack/revision.rb
+- lib/rack/revision/version.rb
+- rack-revision.gemspec
+- test/test_revision.rb
+homepage: http://github.com/sosedoff/rack-revision
+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: Code ravision rack middleware
+test_files: 
+- test/test_revision.rb
+has_rdoc: