sha_header 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use sha_header

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/sha_header.rb

@@ -0,0 +1,3 @@
+module SHAHeader
+  autoload 'Middleware', 'sha_header/middleware'
+end

data/lib/sha_header/middleware.rb

@@ -0,0 +1,41 @@
+require 'active_support/core_ext/object/blank'
+require 'active_support/memoizable'
+
+module SHAHeader
+  class Middleware
+    extend ::ActiveSupport::Memoizable
+
+    def initialize(app, options = {})
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env).tap do |response|
+        response[1]['X-Git-SHA'] = current_git_sha
+      end
+    end
+
+
+    private
+
+
+    def on_heroku?
+      ENV['HEROKU_UPID'].present?
+    end
+
+    def revision_present?
+      ::Rails.root.join('REVISION').exist?
+    end
+
+    def current_git_sha
+      if revision_present?
+        File.read(::Rails.root.join('REVISION'))
+      elsif on_heroku?
+        ENV['COMMIT_HASH']
+      else
+        `cd "#{::Rails.root}" && git rev-parse HEAD 2>/dev/null`.strip
+      end
+    end
+    memoize :current_git_sha
+  end
+end

data/lib/sha_header/railtie.rb

@@ -0,0 +1,10 @@
+require 'sha_header'
+require 'rails'
+
+module SHAHeader
+  class Railtie < Rails::Railtie
+    initializer "sha_header.configure_rails_initialization" do |app|
+      app.middleware.use SHAHeader::Middleware
+    end
+  end
+end

data/lib/sha_header/version.rb

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

data/sha_header.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'sha_header/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'sha_header'
+  s.version     = SHAHeader::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Nathaniel Bibler']
+  s.email       = ['gem@nathanielbibler.com']
+  s.homepage    = 'https://github.com/nbibler/sha_header'
+  s.summary     = %q{Add a header to the response of your Rails 3 application containing the current commit SHA.}
+  s.description = %q{This library adds a new, custom X-Git-SHA header to your Rails 3 application's response which contains the SHA hash that your application is currently running.}
+
+  s.rubyforge_project = 'sha_header'
+
+  s.add_dependency 'rails', '~>3.0.0'
+
+  s.add_development_dependency 'rspec', '~>2.5.0'
+  s.add_development_dependency 'fakefs', '~>0.3.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/spec/models/middleware_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe SHAHeader::Middleware do
+  include FakeFS::SpecHelpers
+
+  let(:parent_app) {lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['Hello']] }}
+  let(:middleware) { SHAHeader::Middleware.new(parent_app) }
+  let(:env) { Rack::MockRequest.env_for('/hello') }
+
+  context 'the X-Git-SHA response header' do
+    subject { middleware.call(env)[1]['X-Git-SHA'] }
+
+    it 'is added' do
+      should be_present
+    end
+
+    context 'on Heroku' do
+      before(:each) { ENV['COMMIT_HASH'] = 'ABCDEFG'; ENV['HEROKU_UPID'] = '1' }
+      after(:each) { ENV['COMMIT_HASH'] = ENV['HEROKU_UPID'] = nil }
+
+      it { should == 'ABCDEFG' }
+    end
+
+    context 'with a REVISION file' do
+      use_fakefs
+
+      let(:path) { Rails.root.join('REVISION') }
+      before(:each) { File.open(path, 'w') { |file| file.write 'HIJKLMNO' }}
+      after(:each) { File.delete(path) }
+
+      it { should == 'HIJKLMNO' }
+    end
+
+    context 'when querying git' do
+      it 'returns the current HEAD SHA' do
+        middleware.should_receive(:`).
+          with(%r{git rev-parse HEAD}).
+          and_return('XYZ')
+        should == 'XYZ'
+      end
+    end
+  end
+
+
+  it 'is Rack::Lint compliant' do
+    app = Rack::Lint.new(middleware)
+    app.call(env)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.expand_path('../', __FILE__))
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rspec'
+require 'rack'
+require 'sha_header'
+
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each do |support|
+  require support
+end
+

data/spec/support/fakefs.rb

@@ -0,0 +1,18 @@
+require 'fakefs'
+
+module FakeFS::SpecHelpers
+  def use_fakefs
+    before(:each) do
+      FakeFS.activate!
+    end
+
+    after(:each) do
+      FakeFS.deactivate!
+      FakeFS::FileSystem.clear
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend FakeFS::SpecHelpers
+end

data/spec/support/rails.rb

@@ -0,0 +1,7 @@
+require 'pathname'
+
+module Rails
+  def self.root
+    Pathname.new(File.expand_path('../../../', __FILE__))
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: sha_header
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nathaniel Bibler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-31 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :development
+  version_requirements: *id003
+description: This library adds a new, custom X-Git-SHA header to your Rails 3 application's response which contains the SHA hash that your application is currently running.
+email: 
+- gem@nathanielbibler.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Rakefile
+- lib/sha_header.rb
+- lib/sha_header/middleware.rb
+- lib/sha_header/railtie.rb
+- lib/sha_header/version.rb
+- sha_header.gemspec
+- spec/models/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakefs.rb
+- spec/support/rails.rb
+has_rdoc: true
+homepage: https://github.com/nbibler/sha_header
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sha_header
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Add a header to the response of your Rails 3 application containing the current commit SHA.
+test_files: 
+- spec/models/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakefs.rb
+- spec/support/rails.rb