rails-local_subdomain 1.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abd6e2c68158f9413a0051cb5c0123fdb2d1a16a
+  data.tar.gz: d4cff48ed2674d063e5e4985aff428d7e4785dd6
+SHA512:
+  metadata.gz: d49ff3c038f882f02d4cccdcf49bf0303e62063248fcfee207f7b40c9d6d78807d06d378c6f6a3b59520cf3a79799535ef93955ab1debd470bd5b7dee7d59496
+  data.tar.gz: 7ed32ed4e9e41838a869c212576cfc911bf0bd0af6c1a9e72b67b2520a7fb26718d9c649187cc74c1b0a544bcdb4e5c45ac5834e7487caee6d42cb155f8d6222

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+# Please see the following for configuration options:
+#   https://github.com/bbatsov/rubocop
+#   https://github.com/nevir/rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.3
+
+Rails:
+  Enabled: true
+
+Style/MultilineMethodCallBraceLayout:
+  EnforcedStyle: same_line
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented

data/.ruby-gemset

@@ -0,0 +1 @@
+rails-local_subdomain

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+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) 2016 Kyle Whittington
+
+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,97 @@
+# Rails::LocalSubdomain
+Rails localhost subdomain support.
+
+## Description
+
+`Rails::LocalSubdomain` enables the developer access to routes within a
+`Rails` subdomain (e.g. testing, Q.A.). It should work out of the box.
+
+Almost all of the work was completed by https://github.com/manuelvanrijn
+(https://github.com/manuelvanrijn/local-subdomain). I only
+wanted to add the ability to configure which environments will have `Rails`
+subdomain support. Specifically, I was trying to test a Rails application via
+`Capybara` and had to modify the original gem source to let us access
+subdomains during tests.
+
+## Installation
+
+1. Add the gem to your `Gemfile`, preferably outside of any group.
+
+```ruby
+gem 'rails-local_subdomain', group: :test # bad
+
+gem 'rails-local_subdomain' # good
+```
+
+2. Run `bundle install`
+3. Include the `Rails::LocalSubdomain` module into a controller
+   (usually `ApplicationController`)
+
+```ruby
+require 'rails/local_subdomain'
+
+class ApplicationController < ActionController::Base
+  include Rails::LocalSubdomain
+  ....
+end
+```
+
+Subdomains should now be accessible in all `Rails` environments white listed in
+`Rails::LocalSubdomain.enabled_environments`.
+
+## Configuration
+
+Configuration can be easily done via `Rails` initializers, simply monkey-patch
+in whatever values you wish to customize:
+
+```ruby
+# ./config/initializers/rails/local_subdomain.rb
+
+module Rails
+  module LocalSubdomain
+    def self.enabled_environments
+      %w(develop test)
+    end
+  end
+end
+```
+
+## How does it work?
+
+### Rack::Handler
+
+`Rails::LocalSubdomain` monkey-patches `Rack::Handler` to bind to `0.0.0.0`
+rather than `localhost`.
+
+By default, this gem uses the domain [http://lvh.me](http://lvh.me) to handle
+our requests for our subdomain(s). Request to the domain `lvh.me` redirects all
+requests to `127.0.0.1`.
+
+This give's us the ability to browse to
+[http://subdomain.lvh.me:3000](http://subdomain.lvh.me:3000) and 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_action` 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/)
+
+## Credits
+
+Thanks to https://github.com/manuelvanrijn/local-subdomain for coming up with
+the original gem. It's helped my development a lot!

data/Rakefile

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'

data/lib/rails/local_subdomain.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require 'rails/local_subdomain/version'
+require 'rails/local_subdomain/rack/handler'
+
+module Rails
+  # Redirects to a specified domain (or `'lvh.me'` if not provided) when Rails
+  # is running in an LocalSubdomain.enabled_environments environment.
+  module LocalSubdomain
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :redirect_to_lvh_me
+    end
+
+    # Should be monkey-patched to configure which Rails environments
+    # will have lvh.me subdomain support.
+    def self.enabled_environments
+      %w(development test)
+    end
+
+    def self.enabled_in?(env)
+      enabled_environments.include?(env)
+    end
+
+    def lvh_me_domain
+      'lvh.me'
+    end
+
+    def lvh_me_path
+      request.env['ORIGINAL_FULLPATH']
+    end
+
+    def lvh_me_port
+      request.env['SERVER_PORT']
+    end
+
+    def lvh_me_protocol
+      request.env['rack.url_scheme']
+    end
+
+    def lvh_me_url
+      "#{lvh_me_protocol}://#{lvh_me_domain}"\
+      "#{lvh_me_port == '80' ? '' : ':' + lvh_me_port}#{lvh_me_path}"
+    end
+
+    def redirect_to_lvh_me
+      return unless LocalSubdomain.enabled_in?(Rails.env)
+      return if served_by_lvh_me?
+
+      redirect_to(lvh_me_url)
+    end
+
+    def served_by_lvh_me?
+      !request.env['SERVER_NAME'][/#{lvh_me_domain}$/].nil?
+    end
+  end
+end

data/lib/rails/local_subdomain/rack/handler.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require 'logger'
+require 'rails/local_subdomain'
+
+module Rack
+  # Override the Rack::Handler to bind to 0.0.0.0 which is required to support
+  # http://lvh.me redirects.
+  module Handler
+    class << self
+      alias orig_default default
+    end
+
+    # rubocop: disable Metrics/MethodLength
+    def self.default(_options = {})
+      orig_default.instance_eval do
+        class << self
+          alias orig_run run
+        end
+
+        def self.run(app, options = {})
+          env = (options[:environment] || Rails.env)
+
+          if options[:Host] == 'localhost' &&
+             Rails::LocalSubdomain.enabled_in?(env)
+            message(options[:Port])
+            options[:Host] = '0.0.0.0'
+          end
+          orig_run(app, options)
+        end
+
+        def self.message(port)
+          ::Logger.new(STDOUT).info(
+            "Binding 'localhost' to '0.0.0.0' for "\
+            "http://lvh.me:#{port}/ support")
+        end
+      end
+      orig_default
+    end
+    # rubocop: enable Metrics/MethodLength
+  end
+end

data/lib/rails/local_subdomain/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rails
+  module LocalSubdomain
+    VERSION = '1.0.9'
+  end
+end

data/rails-local_subdomain.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails/local_subdomain/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rails-local_subdomain'
+  spec.version = Rails::LocalSubdomain::VERSION
+  spec.authors = ['Manuel van Rijn', 'Kyle Whittington']
+  spec.email = ['kyle.thomas.whittington@gmail.com']
+
+  spec.summary = 'subdomain support in your development environment'
+  spec.description = 'A Rails-specific solution to enable subdomain requests '\
+                     'in a local development or test environment.'
+  spec.homepage = 'https://github.com/kWhittington/rails-local_subdomain'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  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'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rails-local_subdomain
+version: !ruby/object:Gem::Version
+  version: 1.0.9
+platform: ruby
+authors:
+- Manuel van Rijn
+- Kyle Whittington
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-01 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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: A Rails-specific solution to enable subdomain requests in a local development
+  or test environment.
+email:
+- kyle.thomas.whittington@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rubocop.yml
+- .ruby-gemset
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails/local_subdomain.rb
+- lib/rails/local_subdomain/rack/handler.rb
+- lib/rails/local_subdomain/version.rb
+- rails-local_subdomain.gemspec
+homepage: https://github.com/kWhittington/rails-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.0.14.1
+signing_key: 
+specification_version: 4
+summary: subdomain support in your development environment
+test_files: []