passages 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47e75e77bbe676fe75044de45fd56441e7c11a2b
-  data.tar.gz: f6d446dab10cf91edbd16cacb326d75a70bfa5f3
+  metadata.gz: f37c423eff6bfd9da867704180a01ca6abcc650f
+  data.tar.gz: e9689b0ea723de0b76c90e9e10ae59f429ec4840
 SHA512:
-  metadata.gz: 7bc750e7f13b7ee420c77c129095c69193b6f35a1bc481925431244fbccaca33ae993ee5c3e416b880b0855156630e73240eb8fdc6b83bafb5b8b9824c9db32d
-  data.tar.gz: 01bd77ac13587d13301a5a31bbddc8b8cf0e9da4616233e1da1f779bf16854f2747c65f3c2bcf851a720eb97c6ddd56cf7d9cb0f513eca506f03be2cd8d8ddda
+  metadata.gz: 743b38a9e68e39887fa93529191793d70af8721e8df2113929a6daf95357ae423c4f07ae903f18e4f6dd93c10d92942b5265d0ad49277e705b8a5f37129edf73
+  data.tar.gz: eac0cf7983556bf5383b6372928fb84df773ba3bcd4db2b309a912f36a87ea12bda5d50d6efdd546c21b2b6a63f488685e549a6e97269c1dad431187b0386772

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,12 @@
-## Roots
+## Passages
 
-![Build Status](https://travis-ci.org/yez/roots.svg?branch=master)
+![Build Status](https://travis-ci.org/yez/passages.svg?branch=master)
 
-Route display and search for Ruby on Rails applications.
+## Purpose
+
+This Rails Engine adds the ability to search over different attributes of Ruby on Rails routes within an application.
+
+For example, an internal (or very permissive external) API can now expose a single page that will answer simple questions like: *"What was the HTTP verb for the `/users/clear_password` route?"* or *"Does a v2 or v3 version for this route exist?"*.
 
 ## Install
 
@@ -10,11 +14,23 @@ In your `Gemfile`
 
 ```ruby
 source 'https://rubygems.org'
-gem 'roots'
+gem 'passages'
 ```
 
 `bundle install`
 
-The `Roots` engine will **prepend** a `/roots` route to the application
+The `Passages` engine will **prepend** a `/passages` route to the application's routes.
+
+Visiting `/passages` will display a search box and list of all known routes in an application.
+
+## Authorization
+
+Since there is no environment dependent checks, the `/passages` page uses configurable http basic authentication.
+
+Default username: **username**
+
+Default password: **password**
+
+## Contributing
 
-Visiting `/roots` will
+Please feel free to fork and contribute your own changes to the Passages project. Single commits are preferred with a description of why the contribution is useful.

data/app/controllers/passages/routes_controller.rb

@@ -6,6 +6,8 @@ require 'passages/engine_route_collection'
 
 module Passages
   class RoutesController < ActionController::Base
+    http_basic_authenticate_with name: Passages.username, password: Passages.password
+
     layout false
 
     def routes

data/config/initializers/basic_auth.rb

@@ -0,0 +1,11 @@
+module Passages
+  def username
+    ENV['passages_username'] || 'username'
+  end
+
+  def password
+    ENV['passages_password'] || 'password'
+  end
+
+  module_function :username, :password
+end

data/lib/passages.rb

@@ -1,5 +1,12 @@
-require 'passages/engine'
-require 'controllers/passages/routes_controller'
+$LOAD_PATH << File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH << File.dirname(__FILE__) + '/../config'
 
 module Passages
 end
+
+require 'initializers/basic_auth'
+
+if defined? Rails
+  require 'passages/engine'
+  require 'controllers/passages/routes_controller'
+end

data/passages.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.description   = %q{Rails Engine to make internal routes searchable and discoverable for more than just the name of the route. All aspects of a route are searchable from the HTTP verb to the paramters a route supports.}
   s.authors       = ['Jake Yesbeck']
   s.email         = 'yesbeckjs@gmail.com'
-  s.homepage      = 'https://github.com/yez/roots'
+  s.homepage      = 'https://github.com/yez/passages'
   s.license       = 'MIT'
 
   s.require_paths = %w(lib app)

data/spec/config/initializers/basic_auth_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Passages do
+  describe '.username' do
+    context 'when the ENV variable is set' do
+      let(:username) { 'thisisausername' }
+      before do
+        allow(ENV).to receive(:[]).with('passages_username') { username }
+      end
+
+      it 'uses the ENV var' do
+        expect(described_class.username).to eq(username)
+      end
+    end
+
+    context 'when the ENV variable is not set' do
+      it 'uses the default value' do
+        expect(described_class.username).to eq('username')
+      end
+    end
+  end
+
+  describe '.password' do
+    context 'when the ENV variable is set' do
+      let(:password) { 'thisisapassword' }
+      before do
+        allow(ENV).to receive(:[]).with('passages_password') { password }
+      end
+
+      it 'uses the ENV var' do
+        expect(described_class.password).to eq(password)
+      end
+    end
+
+    context 'when the ENV variable is not set' do
+      it 'uses the default value' do
+        expect(described_class.password).to eq('password')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,3 +2,4 @@ require 'action_dispatch/routing'
 require 'action_dispatch/routing/inspector'
 require 'active_support'
 require 'action_controller'
+require './lib/passages'

data/version.rb

@@ -1,6 +1,6 @@
 module Passages
   MAJOR = 0
-  MINOR = 1
+  MINOR = 2
   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: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jake Yesbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,6 +59,7 @@ files:
 - app/views/passages/routes/_routes_header.html.erb
 - app/views/passages/routes/routes.html.erb
 - config/initializers/assets.rb
+- config/initializers/basic_auth.rb
 - config/routes.rb
 - lib/passages.rb
 - lib/passages/engine.rb
@@ -68,6 +69,7 @@ files:
 - lib/passages/route.rb
 - lib/passages/route_collection.rb
 - passages.gemspec
+- spec/config/initializers/basic_auth_spec.rb
 - spec/controllers/passages/routes_controller_spec.rb
 - spec/lib/passages/engine_route_collection_spec.rb
 - spec/lib/passages/mount_route_spec.rb
@@ -84,7 +86,7 @@ files:
 - vendor/assets/stylesheets/bootstrap-theme.min.css
 - vendor/assets/stylesheets/bootstrap.min.css
 - version.rb
-homepage: https://github.com/yez/roots
+homepage: https://github.com/yez/passages
 licenses:
 - MIT
 metadata: {}
@@ -110,6 +112,7 @@ signing_key:
 specification_version: 4
 summary: Display and search capabilities for Ruby on Rails routes
 test_files:
+- spec/config/initializers/basic_auth_spec.rb
 - spec/controllers/passages/routes_controller_spec.rb
 - spec/lib/passages/engine_route_collection_spec.rb
 - spec/lib/passages/mount_route_spec.rb