heroku_header 0.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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ben McRedmond
+
+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,29 @@
+# HerokuHeader
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'heroku_header'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heroku_header
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--color'
+end

data/heroku_header.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/heroku_header/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ben McRedmond"]
+  gem.email         = ["ben@benmcredmond.com"]
+  gem.description   = %q{A piece of Rack middleware that inserts the Heroku header on a particular subdomain and caches it.}
+  gem.summary       = gem.description
+  gem.homepage      = "http://github.com/intercom/heroku_header"
+
+  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.name          = "heroku_header"
+  gem.require_paths = ["lib"]
+  gem.version       = HerokuHeader::VERSION
+
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('rack-test')
+  gem.add_development_dependency('pry')
+  gem.add_development_dependency('sinatra')
+end

data/lib/heroku_header/middle_ware.rb

@@ -0,0 +1,79 @@
+module HerokuHeader
+  class MiddleWare
+
+    HEADER_LOCATION = URI.parse("http://nav.heroku.com/v1/providers/header")
+
+    def initialize(app, options = {})
+      @app = app
+      @subdomain = options[:subdomain] || 'heroku'
+      @timeout = options[:timeout] || 5
+      @cache = options[:cache] # An ActiveSupport::Cache::Store instance
+      @cache_key = options[:cache_key] || 'heroku_header_html'
+    end
+
+    def call(env)
+      @env = env
+      @status, @headers, @response = @app.call(@env)
+
+      [@status, @headers, self]
+    end
+
+    def each(&block)
+      return @response.each(&block) if !html_response? || !heroku_subdomain?
+
+      @response.each do |resp|
+        yield resp.gsub(%r{<body[^<]*>}, '\\0' + heroku_header.to_s)
+      end
+    end
+
+    private
+    def html_response?
+      @headers['Content-Type'].include?('text/html')   
+    end
+
+    def heroku_subdomain?
+      @env['HTTP_HOST'] && (!!@env['HTTP_HOST'].match(/#{@subdomain}\..+/))
+    end
+
+    def heroku_header
+      Timeout::timeout(@timeout) do
+        retry_block :on => [Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError] do
+          cache_fetch_or_http_get_heroku_header
+        end
+      end
+    rescue Timeout::Error
+      ""
+    end
+
+    def retry_block(options = {})
+      options[:max_attempts] ||= 5
+
+      attempts = 0
+
+      begin
+        return yield
+      rescue *(options[:on])
+        attempts += 1
+        sleep(0.5) and retry if attempts <= options[:max_attempts]
+      end
+
+      nil
+    end
+
+    def cache_fetch_or_http_get_heroku_header
+      cache(@cache_key, (60 * 60 * 24 * 7)) do
+        response = Net::HTTP.get_response(HEADER_LOCATION) 
+        raise unless response.code == '200'
+        raise unless response.body
+
+        response.body
+      end
+    end
+
+    def cache(key, ttl, &block)
+      return yield if !@cache || !@cache.call.respond_to?(:fetch)
+      @cache.call.fetch(key, :expires_in => ttl, &block)
+    end
+
+  end
+end

data/lib/heroku_header/version.rb

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

data/lib/heroku_header.rb

@@ -0,0 +1,6 @@
+require 'net/http'
+require 'uri'
+require 'timeout'
+
+require 'heroku_header/version'
+require 'heroku_header/middle_ware'

data/spec/middle_ware_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe HerokuHeader::MiddleWare do
+
+  include Rack::Test::Methods
+
+  after :each do
+    HerokuHeader::MiddleWare.any_instance.rspec_reset
+    HerokuHeader::MiddleWare.rspec_reset
+  end
+
+
+  context "heroku_subdomain?" do
+
+    before :each do
+      @heroku_header = HerokuHeader::MiddleWare.new(nil)
+    end
+
+    it "should return true when the subdomain is == @subdomain" do
+      @heroku_header.instance_variable_set(:@env, {'HTTP_HOST' => 'heroku.intercom.io'})
+      @heroku_header.send(:heroku_subdomain?).should be_true
+    end
+
+    it "should return false when the subdomain is != @subdomain" do
+      @heroku_header.instance_variable_set(:@env, {'HTTP_HOST' => 'blah.intercom.io'})
+      @heroku_header.send(:heroku_subdomain?).should be_false
+    end
+
+    it "should return false when HTTP_HOST is nil" do
+      @heroku_header.instance_variable_set(:@env, {'HTTP_HOST' => nil})
+      @heroku_header.send(:heroku_subdomain?).should be_false
+    end
+
+    it "should return false when HTTP_HOST is ''" do
+      @heroku_header.instance_variable_set(:@env, {'HTTP_HOST' => ''})
+      @heroku_header.send(:heroku_subdomain?).should be_false
+    end
+
+  end
+
+  context "http_response?" do
+
+    before :each do
+      @heroku_header = HerokuHeader::MiddleWare.new(nil)
+    end
+
+    it "should return true if Content-Type is text/html" do
+      @heroku_header.instance_variable_set(:@headers, {'Content-Type' => 'text/html'})
+      @heroku_header.send(:html_response?).should be_true
+    end
+
+    it "should return false if Content-Type is not text/html" do
+      @heroku_header.instance_variable_set(:@headers, {'Content-Type' => 'text/xml'})
+      @heroku_header.send(:html_response?).should be_false
+    end
+
+  end
+
+  context "inserting the header" do
+
+    before :each do
+      HerokuHeader::MiddleWare.any_instance.stub(:cache_fetch_or_http_get_heroku_header) {
+        'HEROKU HEADER' 
+      }
+    end
+
+    def app
+      make_app { use HerokuHeader::MiddleWare }
+    end
+    
+    it "should not insert anything if we are not on a heroku subdomain" do
+      get 'http://intercom.io/'
+      last_response.body.should == TestApp::DEFAULT_BODY
+    end
+
+    it "should insert the header if we are on a heroku subdomain" do
+      get 'http://heroku.intercom.io/'
+      last_response.body.should == "<html><body>HEROKU HEADERHello world</body></html>"
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'rspec'
+require 'heroku_header'
+require 'rack/test'
+require 'sinatra/base'
+require 'pry'
+
+# Inspired by Heroku's heroku-nav specs
+class TestApp < Sinatra::Base
+
+  DEFAULT_BODY = "<html><body>Hello world</body></html>"
+
+  get '/' do
+    params[:body] || DEFAULT_BODY
+  end
+
+end
+
+def make_app(&block)
+  handler = Class.new(TestApp)
+  handler.class_eval(&block)
+  handler
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: heroku_header
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben McRedmond
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-26 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: A piece of Rack middleware that inserts the Heroku header on a particular
+  subdomain and caches it.
+email:
+- ben@benmcredmond.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- heroku_header.gemspec
+- lib/heroku_header.rb
+- lib/heroku_header/middle_ware.rb
+- lib/heroku_header/version.rb
+- spec/middle_ware_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/intercom/heroku_header
+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'
+      segments:
+      - 0
+      hash: 1013909249883803082
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1013909249883803082
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A piece of Rack middleware that inserts the Heroku header on a particular
+  subdomain and caches it.
+test_files:
+- spec/middle_ware_spec.rb
+- spec/spec_helper.rb