local-subdomain 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 637b348da01a0eb3479c53f691fb09b3f784d34d
+  data.tar.gz: d323c0cc013e1e78b15392ca9fdce0fde6da1749
+SHA512:
+  metadata.gz: 190e2b4d886db70c1828db6cc7ae4ebe88bd32ed28d620b1d5057840ae2f9680aa4d8a0c14b31637a5bb5e239bef72e91be4fa89c0e72120caa885e7eaf55da4
+  data.tar.gz: 35c1ad006d4fc3c59619395ada5e2387f3093000042c2d7c7abeba1572ad94fe99e3a3fac9caac98ea22b6041f46035f6314a014585b3397363d2ed4336e7e37

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Manuel van Rijn
+
+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,57 @@
+# local-subdomain: Subdomain support for localhost
+
+## Description
+
+This gem helps out when your application depends on subdomain support and you don't want to modify you `/etc/hosts` file all the time for your `development` environment.
+
+## Installation
+
+1. Add the gem to your `Gemfile`
+
+```
+gem 'local-subdomain'
+```
+
+2. Run `bundle install`
+3. Include the `LocalSubdomain` module into your `application_controller.rb` (or the controllers that requires subdomain support)
+
+```ruby
+class ApplicationController < ActionController::Base
+  include LocalSubdomain
+  ....
+end
+```
+
+**NOTE:** Do not force the gem only to be included in the `development` group. Because of the inclusion of the module `LocalSubdomain`, you'll need to have the gem available in every environment.
+The gem itself contains guards to only perform changes when the environment is `development`, so no worries or check it out yourself:
+
+- [rack/handler.rb](/lib/local-subdomain/rack/handler.rb#L18)
+- [filters/local_subdomain.rb](/lib/local-subdomain/filters/local_subdomain.rb#L9)
+
+## What it does
+
+Basically it does two things:
+
+1. Extends the `Rack::Handler` to make sure we bind to `0.0.0.0` instead of `localhost`
+2. Adds the `LocalSubdomain` module which executes a `before_filter` to redirect to `http://lvh.me:<port>`
+
+### Rack::Handler
+
+This gem uses the domain [http://lvh.me](http://lvh.me) to handle our requests for our subdomain(s). Request to the domain redirects all to `127.0.0.1`.
+This give's us the ability to browse to [http://subsub.lvh.me:3000](http://subsublvh.me:3000) and be handle `request.subdomain` from our controllers.
+
+Because we're going to use the external domain [http://lvh.me](http://lvh.me) which redirects to `127.0.0.1` we have to make our server not to bind to `localhost` only.
+
+### LocalSubdomain module
+
+This module includes a `before_filter` which will check if the request is served by [http://lvh.me](http://lvh.me). If not it will redirect to the domain.
+
+So when we browse to [http://localhost:3000](http://localhost:3000) it will redirect you to [http://lvh.me:3000](http://lvh.me:3000)
+
+## Supported ruby servers
+
+I've tested the gem with:
+
+* [WEBrick](https://rubygems.org/gems/webrick)
+* [Puma](http://puma.io/)
+* [Thin](http://code.macournoyer.com/thin/)

data/Rakefile

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

data/lib/local-subdomain.rb

@@ -0,0 +1,6 @@
+require 'local-subdomain/version'
+require 'local-subdomain/filters/local_subdomain'
+require 'local-subdomain/rack/handler'
+
+module LocalSubdomain
+end

data/lib/local-subdomain/filters/local_subdomain.rb

@@ -0,0 +1,18 @@
+module LocalSubdomain
+  extend ActiveSupport::Concern
+
+  included do
+    before_filter :redirect_to_lvh_me
+  end
+
+  def redirect_to_lvh_me
+    return unless Rails.env.development?
+    served_by_lvh_me = !request.env['SERVER_NAME'][/lvh.me$/].nil?
+    return if served_by_lvh_me
+
+    http = request.env['rack.url_scheme']
+    port = request.env['SERVER_PORT']
+    path = request.env['ORIGINAL_FULLPATH']
+    redirect_to "#{http}://lvh.me:#{port}#{path}"
+  end
+end

data/lib/local-subdomain/rack/handler.rb

@@ -0,0 +1,34 @@
+# Override the Rack::Handler to bind to 0.0.0.0 which is required to support
+# http://lvh.me redirects
+
+module Rack
+  module Handler
+    class << self
+      alias_method :orig_default, :default
+    end
+
+    def self.default(options = {})
+      orig_default.instance_eval do
+        class << self
+          alias_method :orig_run, :run
+        end
+
+        def self.run(app, options = {})
+          env = (options[:environment] || Rails.env)
+          if options[:Host] == 'localhost' && env == 'development'
+            message(options[:Port])
+            options.merge!(Host: '0.0.0.0')
+          end
+          orig_run(app, options)
+        end
+
+        def self.message(port)
+          puts '****************************************************************************************'
+          puts "* Override binding 'localhost' to '0.0.0.0' for http://lvh.me:#{port}/ support"
+          puts '****************************************************************************************'
+        end
+      end
+      orig_default
+    end
+  end
+end

data/lib/local-subdomain/version.rb

@@ -0,0 +1,3 @@
+module LocalSubdomain
+  VERSION = '1.0.0'
+end

data/local-subdomain.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'local-subdomain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'local-subdomain'
+  spec.version       = LocalSubdomain::VERSION
+  spec.authors       = ['Manuel van Rijn']
+  spec.email         = ['manuel@manuelvanrijn.nl']
+
+  spec.summary       = 'subdomain support in your development environment'
+  spec.description   = "This gem helps out when your application depends on subdomain support and you don't want to modify you /etc/hosts file all the time for your development environment."
+  spec.homepage      = 'https://github.com/manuelvanrijn/local-subdomain'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: local-subdomain
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Manuel van Rijn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This gem helps out when your application depends on subdomain support
+  and you don't want to modify you /etc/hosts file all the time for your development
+  environment.
+email:
+- manuel@manuelvanrijn.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/local-subdomain.rb
+- lib/local-subdomain/filters/local_subdomain.rb
+- lib/local-subdomain/rack/handler.rb
+- lib/local-subdomain/version.rb
+- local-subdomain.gemspec
+homepage: https://github.com/manuelvanrijn/local-subdomain
+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.4.5
+signing_key: 
+specification_version: 4
+summary: subdomain support in your development environment
+test_files: []