passages 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91ad2eb2bfd8de3cb90f430b52679748b6458249
-  data.tar.gz: 2dc1db09ec74c6815f2d5b5b3c236d714b952ee5
+  metadata.gz: e97a75c881bbc4231d06586a70743f9aabe9e23b
+  data.tar.gz: 48147ce8dab999ba0b281aff172c5b1c12878118
 SHA512:
-  metadata.gz: 4aab33a5ca1ade95fa46865311fd94d9f4bae52fb2079a3dbb78df90ad7a99879e0ba2edba6542fd92c2693b344f234acba823273734cc261253806319673989
-  data.tar.gz: bd078de0461d8dd8367848ebd25a6fdcafd8c19f270282edcf693dd2c348a8563f9518aff855e6cfd6b1f64d3dfdd5a5c25423b8addedc2a0536fe673d84dc49
+  metadata.gz: d81bac070a968f9fed29694502dbbacb63c49118793981351c55b2d9e31675a6fdc49450818171fd9020d449a610b3bc645cc14389aa07a30de2bd5765322901
+  data.tar.gz: 9a29c7f74cc21601f974b51373766ed57f34cce3ce4387e5964d0570f154f908d77d058596d021ad287a485534b37997796079dcde5f569a2cd67820bb2f08a6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    passages (0.2.0)
+    passages (1.0.0)
       rails (~> 4.0)
 
 GEM

data/README.md

@@ -23,17 +23,45 @@ gem 'passages'
 
 `bundle install`
 
-The `Passages` engine will **prepend** a `/passages` route to the application's routes. This means that if a project's `routes.rb` specifically defines a `/passages` route, the `Passages` Engine will not overwrite that.
+By default, the `Passages` Engine must be mounted in your `routes.rb` file.
 
-Visiting `/passages` will display a search box and list of all known routes in an application.
+Example:
+
+*routes.rb*
+
+```ruby
+Rails.application.routes.draw do
+  mount Passages::Engine, at: '/passages'
+end
+```
+
+*Alternatively*, an initializer can be created that will allow the `Passages` Engine to mount itself.
+
+Create a new file: `initializers/passages.rb` and add the following:
+
+```ruby
+Passages.configure do |config|
+  config.automount = true
+end
+```
+
+With the Engine mounted at `/passages`, the rendered page will display a search box and list of all known routes within the application.
 
 ## Authorization
 
 Since there are no environment dependent checks, the `/passages` page uses configurable http basic authentication.
 
-Default username: **username**
+To set a `username` and `password` in the `Passages` Engine, add an `ENV` variable for each value.
+
+`ENV['passages_username']` should be the desired `username` and `ENV['passages_password']` should be the desired `password`
+
+By default these values are:
+
+username: **username**
+
+password: **password**
 
-Default password: **password**
+`ENV` variables can prefix a Ruby server command from the command line interface, set with a helper `.ENV` file for systems like `foreman` or set through a web interface on platforms like `heroku`.
 
 ## Contributing
 

data/config/config.rb

@@ -0,0 +1,15 @@
+module Passages
+  class Config
+    attr_accessor :automount
+  end
+
+  def config
+    @config ||= Config.new
+  end
+
+  def configure
+    yield config
+  end
+
+  module_function :config, :configure
+end

data/config/initializers/basic_auth.rb

@@ -1,10 +1,10 @@
 module Passages
   def username
-    ENV['passages_username'] || 'username'
+    ENV['passages_username'] || ENV['PASSAGES_USERNAME'] || 'username'
   end
 
   def password
-    ENV['passages_password'] || 'password'
+    ENV['passages_password'] || ENV['PASSAGES_PASSWORD'] || 'password'
   end
 
   def no_auth=(no_auth)

data/lib/passages/engine.rb

@@ -1,10 +1,12 @@
 module Passages
   class Engine < ::Rails::Engine
-     isolate_namespace Passages
+    isolate_namespace Passages
 
-     initializer 'passages', before: :load_config_initializers do |app|
-      Rails.application.routes.prepend do
-        mount Passages::Engine, at: '/passages'
+    initializer 'passages', after: :load_config_initializers do |app|
+      if Passages.config.automount
+        Rails.application.routes.prepend do
+          mount Passages::Engine, at: '/passages'
+        end
       end
     end
   end

data/lib/passages.rb

@@ -5,6 +5,7 @@ module Passages
 end
 
 require 'initializers/basic_auth'
+require 'config'
 
 if defined? Rails
   require 'passages/engine'

data/spec/config/initializers/basic_auth_spec.rb

@@ -11,6 +11,18 @@ describe Passages do
       it 'uses the ENV var' do
         expect(described_class.username).to eq(username)
       end
+
+      context 'uppercase' do
+        let(:upper_username) { 'THISISANUPPERUSERNAME' }
+        before do
+          allow(ENV).to receive(:[]).with('passages_username') { nil }
+          allow(ENV).to receive(:[]).with('PASSAGES_USERNAME') { upper_username }
+        end
+
+        it 'uses the ENV var' do
+          expect(described_class.username).to eq(upper_username)
+        end
+      end
     end
 
     context 'when the ENV variable is not set' do
@@ -30,6 +42,18 @@ describe Passages do
       it 'uses the ENV var' do
         expect(described_class.password).to eq(password)
       end
+
+      context 'uppercase' do
+        let(:upper_password) { 'THISISANUPPERPASSWORD' }
+        before do
+          allow(ENV).to receive(:[]).with('passages_password') { nil }
+          allow(ENV).to receive(:[]).with('PASSAGES_PASSWORD') { upper_password }
+        end
+
+        it 'uses the ENV var' do
+          expect(described_class.password).to eq(upper_password)
+        end
+      end
     end
 
     context 'when the ENV variable is not set' do

data/version.rb

@@ -1,6 +1,6 @@
 module Passages
   MAJOR = 1
-  MINOR = 0
+  MINOR = 1
   TINY = 0
 
   VERSION = [MAJOR, MINOR, TINY].join('.').freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passages
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jake Yesbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-10 00:00:00.000000000 Z
+date: 2016-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,6 +58,7 @@ files:
 - app/views/passages/routes/_route.html.erb
 - app/views/passages/routes/_routes_header.html.erb
 - app/views/passages/routes/routes.html.erb
+- config/config.rb
 - config/initializers/assets.rb
 - config/initializers/basic_auth.rb
 - config/routes.rb