heroku_header 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # HerokuHeader
 
-TODO: Write a gem description
+Rack middleware that will insert Heroku's navigation header on a specified subdomain.
 
 ## Installation
 
@@ -18,7 +18,31 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+`HerokuHeader::MiddleWare` takes a few config options, all optional:
+
+* `:subdomain` => The subdomain to show the header on, defaults to `heroku`.
+* `:timeout` => How many seconds until the request to get the header is cancelled, default is 5. (It fails silently when it can't fetch the header).
+* `:cache` => This expects an object which conforms to the `ActiveSupport::Cache::Store` API. It is not reccomended to leave this out, in which case the header will be fetched from Heroku on each request (when required).
+* `:cache_key` => This is the key which is used to store and retrieve the header from `:cache`. Defaults to 'heroku_header_html'.
+
+### Rails
+
+```ruby
+# application.rb
+config.middleware.use HerokuHeader::MiddleWare, :subdomain => 'heroku', :timeout => 5, :cache => lambda { Rails.cache }
+```
+
+### Sinatra
+
+```ruby
+require 'sinatra'
+
+use HerokuHeader::MiddleWare, :subdomain => 'heroku', :timeout => 5
+
+get '/' do
+  ....
+end
+```
 
 ## Contributing
 

data/lib/heroku_header/middle_ware.rb

@@ -28,7 +28,7 @@ module HerokuHeader
 
     private
     def html_response?
-      @headers['Content-Type'].include?('text/html')   
+      @headers['Content-Type'] && @headers['Content-Type'].include?('text/html')   
     end
 
     def heroku_subdomain?
@@ -76,4 +76,4 @@ module HerokuHeader
     end
 
   end
-end
+end

data/lib/heroku_header/version.rb

@@ -1,3 +1,3 @@
 module HerokuHeader
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/middle_ware_spec.rb

@@ -54,6 +54,13 @@ describe HerokuHeader::MiddleWare do
       @heroku_header.send(:html_response?).should be_false
     end
 
+    it "should not crash if Content-Type is nil" do
+      @heroku_header.instance_variable_set(:@headers, {})
+      lambda {
+        @heroku_header.send(:html_response?)
+      }.should_not raise_error
+    end
+
   end
 
   context "inserting the header" do
@@ -82,4 +89,4 @@ describe HerokuHeader::MiddleWare do
 
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku_header
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000 Z
+date: 2012-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1351836858524438971
+      hash: -2037551427770845354
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1351836858524438971
+      hash: -2037551427770845354
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23