rack-git_sha 0.0.1 → 1.0.0

data/README.md

@@ -1,12 +1,16 @@
 # Rack::GitSha
 
-TODO: Write a gem description
+Tiny rack application that serves up the currently deployed git commit SHA.
+
+Inspired by [https://github.com/site/sha](https://github.com/site/sha)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'rack-git_sha'
+```ruby
+gem 'rack-git_sha'
+```
 
 And then execute:
 
@@ -18,7 +22,51 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+If your using rails 3.0+ you can mount the app in your `routes.rb` file.
+
+```ruby
+MyApp::Application.routes.draw do
+  mount Rack::GitSha.new => '/sha'
+end
+```
+
+If your using rack then you can map the middleware in your `config.ru`.
+
+```ruby
+require 'rack/git_sha'
+
+map '/sha' do
+  run Rack::GitSha.new
+end
+
+map '/' do
+  run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['Homepage']] }
+end
+```
+
+The argument that is given to `#new` is the path to the current project,
+it will default to `Dir.pwd` if none is given.
+
+After restarting your app, visiting `/sha` should give you the current
+git revision.
+
+## Tips
+
+Once you've got your application serving the current SHA you can do some
+fun stuff from the command line.
+
+### Currently deployed SHA
+
+    cd example-app
+    curl -s http://app.example.com/sha
+    git diff $(curl -fsSL http://app.example.com/sha)
+
+This will do a diff against the deployed sha, showing you what is still
+pending (much like capistrano's `cap deploy:pending:diff`).
+
+## Known issues
+
+* Does not work with Heroku.
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,8 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/lib/rack/git_sha/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class GitSha
-    VERSION = "0.0.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/rack/git_sha.rb

@@ -3,10 +3,21 @@ require 'pathname'
 
 module Rack
   class GitSha
+
+    # Public: Initialize a new GitSha app.
+    #
+    # root - The String path to application root.
+    #
+    # Returns the instance of GitSha.
     def initialize(root = Dir.pwd)
       @root = Pathname.new(root)
     end
 
+    # Public: Rack interface, run when the application is requested.
+    #
+    # env - The Hash environment of the incoming request.
+    #
+    # Returns an Array `[status, headers, [body]]` for Rack.
     def call(env)
       if revision_file.exist?
         ok revision_file.read
@@ -19,26 +30,49 @@ module Rack
 
   private
 
+    # Get a reference to the `REVISION` file in the root of the app, this is
+    # for Capistrano compatibility.
+    #
+    # Returns the Pathname to a possible REVISION file.
     def revision_file
       @root.join('REVISION')
     end
 
+    # Check if the application root is a git repository.
+    #
+    # Returns a Boolean.
     def git_repository?
       @root.join('.git').directory?
     end
 
+    # Get the current git commit SHA.
+    #
+    # Returns the String of the SHA.
     def git_current_commit_sha
       `git rev-parse HEAD`
     end
 
+    # Easy way to get a rack 200 OK response.
+    #
+    # response - The String to return as the body.
+    #
+    # Returns a Rack compatible response array.
     def ok(response)
       [200, headers, [response]]
     end
 
+    # Easy way to get a rack 404 response.
+    #
+    # response - The String to return as the body.
+    #
+    # Returns a Rack compatible response array.
     def not_found(response)
       [404, headers, [response]]
     end
 
+    # Get the headers for the response.
+    #
+    # Returns a Hash of the response headers.
     def headers
       {'Content-Type' => 'text/plain'}
     end

data/rack-git_sha.gemspec

@@ -17,4 +17,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rspec', '~> 2.8.0'
   gem.add_development_dependency 'rack-test', '~> 0.6.1'
+  gem.add_development_dependency 'rake', '~> 0.9.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-git_sha
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-18 00:00:00.000000000 Z
+date: 2012-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70309363854700 !ruby/object:Gem::Requirement
+  requirement: &70263737936820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70309363854700
+  version_requirements: *70263737936820
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70309363854180 !ruby/object:Gem::Requirement
+  requirement: &70263737936300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,18 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *70309363854180
+  version_requirements: *70263737936300
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70263737935840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70263737935840
 description: Serve up the current git commit SHA from rack
 email:
 - self@hecticjeff.net