heroku_config_vars 0.0.2.pre → 1.0.0

data/README.md

@@ -1 +1,71 @@
-TODO
+# HerokuConfigVars
+
+[![Build Status](https://travis-ci.org/danielfone/heroku_config_vars.png?branch=master)](https://travis-ci.org/danielfone/heroku_config_vars)
+[![Dependency Status](https://gemnasium.com/danielfone/heroku_config_vars.png)](https://gemnasium.com/danielfone/heroku_config_vars)
+[![Code Climate](https://codeclimate.com/github/danielfone/heroku_config_vars.png)](https://codeclimate.com/github/danielfone/heroku_config_vars)
+
+This engine allows you to manage Heroku configuration variables from within your application.
+
+## Installation into your application
+
+1. Add `gem 'heroku_config_vars'` to your Gemfile
+2. Add `mount HerokuConfigVars::Engine => "/heroku_config_vars"` to your routes.rb
+3. Implement the method `:heroku_config_vars_authorized?` on your ApplicationController. (See [Customization](#customization))
+4. To make authorization easy, this engine inherits from your ApplicationController.
+This means that you may have to change named routes to be more specific. e.g.
+
+```diff
+ class ApplicationController < ActionController::Base
+     before_filter :authenticate
+
+     def authenticate
+-      redirect_to new_session_path unless logged_in?
++      redirect_to main_app.new_session_path unless logged_in?
+     end
+ end
+```
+
+## Setup
+
+1. Deploy your app to Heroku
+2. Visit /heroku_config_vars
+3. Enter valid Heroku credentials for your application.
+   These are stored in the Heroku configuration for this application so you don't need to enter them again.
+
+## Usage
+
+With this engine you can:
+
+* View the complete ruby ENV hash
+* View the Heroku configuration
+* Update, add and delete Heroku configuration variables
+
+
+## Customization
+
+You can change the path to the engine by changing the line in your routes.rb
+
+```ruby
+# config/routes.rb
+mount HerokuConfigVars::Engine => "/whatever_path_you_like"`
+```
+
+You can also change the name of the authorization method to call on ApplicationController.
+You may wish to do this if you already have an appropriate authorization method defined. e.g.
+
+```ruby
+# config/initializers/heroku_config_vars.rb
+HerokuConfigVars.authorization_method = :admin_logged_in?
+```
+
+A typical implementation of this method might look like:
+
+```ruby
+class ApplicationController < ActionController::Base
+  ...
+  def heroku_config_vars_authorized?
+    current_user && current_user.admin?
+  end
+  ...
+end
+```

data/app/controllers/heroku_config_vars/application_controller.rb

@@ -1,36 +1,42 @@
-class HerokuConfigVars::ApplicationController < ApplicationController
+module HerokuConfigVars
+  class ApplicationController < ::ApplicationController
 
-  before_filter :require_authenticated
-  before_filter :recommend_https, :if => :insecure?
+    before_filter :require_authenticated
+    before_filter :recommend_https, :if => :insecure? 
 
-  AUTH_METHOD = :heroku_config_authorized?
+    layout 'heroku_config_vars/application'
 
-  def env
-    @env = ENV
-  end
+    def env
+      @env = ENV
+    end
 
   private
 
     def require_authenticated
-      # This is where we shell out to ApplicationController
       # raising RoutingError will render 404 in production
-      if not respond_to? AUTH_METHOD
+      if not respond_to? HerokuConfigVars.authorization_method
         raise ActionController::RoutingError.new <<-ERROR.strip_heredoc
-          `#{AUTH_METHOD}` must be implemented in ApplicationController and return true for authorized users.
-
-          e.g.
-          class ApplicationController < ActionController::Base
-            ...
-            
-            def #{AUTH_METHOD}
-              current_user.admin?
-            end
-            
-            ...
-          end
+          `#{HerokuConfigVars.authorization_method}` must be implemented in ApplicationController and return true for authorized users.
+          
+           e.g.
+           class ApplicationController < ActionController::Base
+             ...
+             
+             def #{HerokuConfigVars.authorization_method}
+               current_user.admin?
+             end
+             
+             ...
+           end
+
+           You can change the name of this method. e.g.
+           
+           # config/initializers/heroku_config_vars.rb
+           HerokuConfigVars.authorization_method = :my_other_auth?
+           
         ERROR
-      elsif not heroku_config_authorized?
-        raise ActionController::RoutingError.new ':heroku_config_authorized? returned false'
+      elsif not send HerokuConfigVars.authorization_method
+        raise ActionController::RoutingError.new "Authorisation block returned false"
       end
     end
 
@@ -42,5 +48,5 @@ class HerokuConfigVars::ApplicationController < ApplicationController
     def insecure?
       not request.ssl? and (session[:insecure] ||= params[:insecure]) != 'ok'
     end
-
-end
+  end
+end

data/app/views/layouts/heroku_config_vars/application.html.erb

@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>HerokuConfigVars</title>
+  <title>Heroku Configuration</title>
   <%= stylesheet_link_tag    "heroku_config_vars/application", :media => "all" %>
   <%= javascript_include_tag "heroku_config_vars/application" %>
   <%= csrf_meta_tags %>
 </head>
 <body>
-  <h1>Heroku Configurator</h1>
+  <h1>Heroku Configuration</h1>
 
   <ul class="submenu">
     <li><%= menu_link 'Heroku Configuration Variables', heroku_app_path %></li>

data/lib/heroku_config_vars/version.rb

@@ -1,3 +1,3 @@
 module HerokuConfigVars
-  VERSION = "0.0.2.pre"
+  VERSION = "1.0.0"
 end

data/lib/heroku_config_vars.rb

@@ -2,4 +2,6 @@ require 'heroku-api'
 require "heroku_config_vars/engine"
 
 module HerokuConfigVars
+  mattr_accessor :authorization_method
+  self.authorization_method = :heroku_config_vars_authorized?
 end

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,8 +1,18 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
 
-  def heroku_config_authorized?
-    params[:admin] != 'false'
-  end
+  before_filter :break_inheritance
+
+  protected
+
+    def heroku_config_auth?
+      params[:admin] != 'false'
+    end
+
+  private
+
+    def break_inheritance
+      main_app.widgets_path
+    end
 
 end

data/spec/dummy/config/initializers/heroku_config_vars.rb

@@ -0,0 +1 @@
+HerokuConfigVars.authorization_method = :heroku_config_auth?

data/spec/dummy/config/routes.rb

@@ -1,4 +1,7 @@
 Rails.application.routes.draw do
 
+  resources :widgets
+
   mount HerokuConfigVars::Engine => "/heroku_config_vars"
+
 end