hostrich 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 637748f6b1009f5874056cee3fb09f09e9a3acf8
+  data.tar.gz: d68d76d257965d8ff2da09a76124ab8561c194a2
+SHA512:
+  metadata.gz: 2b61b34927dbfad8b7c8c01d1c7c290a7bf3250dfb24be333ccfba741bf2a679f3cc11596f00560d1366a603d13ae05c482ea30efb62b5d7fa7e350cef939dfe
+  data.tar.gz: 7204c9c21f1b6cef6ec948833a20834f1825fb5057157aeae305bf3520dd487aed345600ee8772a75a79bf065021d8a5d8a619008bae37d632249768a34facd7

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rafaël Blais Masson
+
+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,83 @@
+# Hostrich
+
+Hostrich is a Rack middleware that eases multi-domain web app development.
+
+## Usage
+
+Add the middleware at the top of your development stack, passing it the domain(s) your app is using:
+
+```ruby
+# Gemfile
+gem 'hostrich', group: :development
+```
+
+```ruby
+# config.ru
+
+# if using Rack::Deflater, put it here
+if ENV['RACK_ENV'] == 'development'
+  use Hostrich, ['somedomain.com', 'otherdoma.in']
+end
+# ... any other middleware ...
+
+run Your::RackApp
+```
+
+## Database-dynamic hosts
+
+If your app serves pages on hosts that depend on models, say a `Website` model with a `custom_domain` column, you can append hosts to the `Hostrich.hosts` array after your app intialization:
+
+```ruby
+# config/environments/development.rb
+
+config.after_initialize do
+  Hostrich.hosts += Website.pluck(:custom_domain).compact
+end
+```
+
+## Rationale
+
+Hostrich tricks your development environment into thinking it is serving your application from your production host (`example.com`) instead of your usual development host (`example.dev`).
+
+Thus, your application doesn’t have to know about any dev-prod hosts mapping. This makes your code simpler and less prone to errors.
+
+To make this possible, you must access your local app at `http://example.com.dev` or the like, where a suffix is added to the full production domain. This way Hostrich can extract `.dev` from the host and append it everywhere `example.com` is output in your response bodies and headers.
+
+[xip.io](http://xip.io) is Hostrich’s best friend. For complex multi-domain web apps like ours at [Medalist](http://medali.st), it’s a must. Our app responds to `medali.st`, `manage.medali.st`, `*.mli.st` and even `anydomain.com` because some of our users have custom domains. xip.io allows us to access our local app at:
+
+- **medali.st**.127.0.0.1.xip.io
+- **manage.medali.st**.127.0.0.1.xip.io
+- **mikaelkingsbury.mli.st**.127.0.0.1.xip.io
+- **mikaelkingsbury.ca**.127.0.0.1.xip.io
+
+And our application code only knows about production hosts:
+
+```ruby
+# config/routes.rb
+
+Medalist::Application.routes.draw do
+  # http://medali.st/
+  namespace :public, host: 'medali.st' do
+    # ...
+  end
+
+  # http://manage.medali.st/
+  namespace :manage, host: 'manage.medali.st' do
+    # ...
+  end
+
+  # http://usersite.mli.st/
+  # http://usersite.com/
+  namespace :usersite do
+    # ...
+  end
+end
+```
+
+## TODO
+
+- This README isn’t that great.
+
+---
+
+© 2014 [Rafaël Blais Masson](http://medali.st). Hostrich is released under the MIT license.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/hostrich.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hostrich/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hostrich'
+  spec.version       = Hostrich::VERSION
+  spec.authors       = ['Rafaël Blais Masson']
+  spec.email         = ['rafbmasson@gmail.com']
+  spec.description   = 'Hostrich is a Rack middleware that eases multi-domain web app development.'
+  spec.summary       = 'Hostrich is a Rack middleware that eases multi-domain web app development.'
+  spec.homepage      = 'http://github.com/rafBM/hostrich'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/hostrich/version.rb

@@ -0,0 +1,3 @@
+class Hostrich
+  VERSION = '0.1.0'
+end

data/lib/hostrich.rb

@@ -0,0 +1,67 @@
+require 'hostrich/version'
+
+require 'rack'
+
+class Hostrich
+  @@hosts = []
+
+  def self.hosts
+    @@hosts
+  end
+
+  def self.hosts=(array)
+    @@hosts = array
+  end
+
+  def initialize(app, hosts = [])
+    @app = app
+    @@hosts += Array(hosts)
+  end
+
+  def call(env)
+    return @app.call(env) if @@hosts.empty?
+
+    # Extract suffix from current request host.
+    match = nil
+    @@hosts.detect { |host| match = env['HTTP_HOST'].match(/#{host}(\.[\.\w-]+)?/) }
+    return @app.call(env) if match.nil?
+
+    suffix = match[1]
+
+    # Fake request host.
+    # Eg. If request is made from http://example.com.dev or http://example.com.127.0.0.1.xip.io,
+    # the Rack app will see it just as a request to http://example.com.
+    env['HTTP_HOST']   = remove_suffix(env['HTTP_HOST'], suffix)
+    env['SERVER_NAME'] = remove_suffix(env['SERVER_NAME'], suffix)
+
+    # Get regular response from Rack app
+    status, headers, body = @app.call(env)
+    body.close if body.respond_to? :close
+
+    # Add current host suffix in all response bodies, so that occurences of http://example.com
+    # appear as http://example.com.dev or http://example.com.127.0.0.1.xip.io in the browser.
+    body = Array(body.each(&:to_s)).join
+    body = [add_suffix(body, suffix)]
+
+    # Do the same in response headers. This is important for cookies and redirects.
+    headers = Hash[headers.map { |k,v| [k, add_suffix(v, suffix)] }]
+
+    # Return hacked response
+    [status, headers, body]
+  end
+
+private
+
+  def remove_suffix(input, suffix)
+    output = input.dup
+    @@hosts.each { |host| output.gsub! "#{host}#{suffix}", host }
+    output
+  end
+
+  def add_suffix(input, suffix)
+    output = input.dup
+    # Don’t add suffix when it’s already there. Prevents double-suffix redirects and stuff.
+    @@hosts.each { |host| output.gsub! /\b#{host}\b(?!#{suffix})/, "#{host}#{suffix}" }
+    output
+  end
+end

data/spec/hostrich_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Hostrich do
+  # Prevent spec mess-up after testing `Hostrich.hosts += ['...']`
+  before { Hostrich.hosts = [] }
+
+  let(:app) {
+    proc { |env|
+      case env['PATH_INFO']
+      when '/redirect'
+        [302, { 'Location' => 'http://foo.com/index.html' }, []]
+      when '/cookie'
+        [200, { 'Set-Cookie' => 'some_param=foo.com/index.html; Path=/; Domain=.foo.com' }, ['Cookie!']]
+      else
+        [200, {}, ['Welcome to foo.com or foo.com.dev, not foo.comzle, not ffoo.com and not bar.io']]
+      end
+    }
+  }
+  let(:request) { Rack::MockRequest.new(stack) }
+
+  shared_examples 'the whole deal' do
+    it 'adds host suffix in response body' do
+      response = request.get('/', 'HTTP_HOST' => 'foo.com.dev')
+      expect(response.body).to eq 'Welcome to foo.com.dev or foo.com.dev, not foo.comzle, not ffoo.com and not bar.io'
+    end
+
+    it 'adds host suffix in response headers' do
+      response = request.get('/redirect', 'HTTP_HOST' => 'foo.com.dev')
+      expect(response.headers['Location']).to eq 'http://foo.com.dev/index.html'
+
+      response = request.get('/cookie', 'HTTP_HOST' => 'foo.com.dev')
+      expect(response.headers['Set-Cookie']).to eq 'some_param=foo.com.dev/index.html; Path=/; Domain=.foo.com.dev'
+    end
+  end
+
+  context 'passing host as a string' do
+    let(:stack) { Hostrich.new(app, 'foo.com') }
+    it_behaves_like 'the whole deal'
+  end
+
+  context 'passing host as an array' do
+    let(:stack) { Hostrich.new(app, ['foo.com']) }
+    it_behaves_like 'the whole deal'
+  end
+
+  context 'passing multiple hosts as an array' do
+    let(:stack) { Hostrich.new(app, %w[foo.com foo.bar.io]) }
+    it_behaves_like 'the whole deal'
+
+    it 'adds host suffix for all hosts' do
+      response = request.get('/', 'HTTP_HOST' => 'foo.com.127.0.0.1.xip.io')
+      expect(response.body).to eq 'Welcome to foo.com.127.0.0.1.xip.io or foo.com.127.0.0.1.xip.io.dev, not foo.comzle, not ffoo.com and not bar.io'
+    end
+  end
+
+  context 'passing no host' do
+    let(:stack) { Hostrich.new(app) }
+
+    it 'does nothing' do
+      response = request.get('/', 'HTTP_HOST' => 'foo.com.dev')
+      expect(response.body).to eq 'Welcome to foo.com or foo.com.dev, not foo.comzle, not ffoo.com and not bar.io'
+    end
+
+    context 'adding hosts after initialization' do
+      before { Hostrich.hosts += ['foo.com'] }
+      it_behaves_like 'the whole deal'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'hostrich'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: hostrich
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafaël Blais Masson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Hostrich is a Rack middleware that eases multi-domain web app development.
+email:
+- rafbmasson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hostrich.gemspec
+- lib/hostrich.rb
+- lib/hostrich/version.rb
+- spec/hostrich_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rafBM/hostrich
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Hostrich is a Rack middleware that eases multi-domain web app development.
+test_files:
+- spec/hostrich_spec.rb
+- spec/spec_helper.rb