rinfo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 735e0df4987cfe914fa2b9f7db835f9ba40e150c
-  data.tar.gz: 6714c7823bbf12c1e6f5fcd84ac643d07e78d3e4
+  metadata.gz: 97bc7f55b1f7bd7e21f51a51bffaef76a9de9d5c
+  data.tar.gz: f51bd8fc84e2f0af9439b0505b367312e1e5301e
 SHA512:
-  metadata.gz: ba9767e290e354c7b14cf4018175048f793af1126d9c2d2f65f54fe16a10ced38a531df1d841d602c074099c1d4e0b97bff2d49faa660d6a4c5e38966966048f
-  data.tar.gz: e84a70886f4ed2566484d10ce3bd1d4be75a31f120ba873ac9c6037f430c4413d071584f5f104f2c4848cc9a9c312a51b78f279ce29f385f0aab9fea2c1e09dc
+  metadata.gz: e893b5cfdff8948f6d60de43bae38f4f1cb2b5af042a09a08543d59569c92579f70d62f412d8138ec52654d3255818abc814771314afd8479464f0de517666fd
+  data.tar.gz: 2e0a05faa47f7762f2f2298997a27d6c70e04b80164a227c824d23bb066daa6b919cc5662480b5b02a59759f2ec12feb00251c72b3ec66f559dc3243ed1c1294

data/README.md

@@ -1,11 +1,67 @@
 # Rinfo
 
-[![Build Status](https://travis-ci.org/rafecolton/rinfo.png?branch=master)](https://travis-ci.org/rafecolton/rinfo)
+[![Gem Version](https://badge.fury.io/rb/rinfo.png)](http://badge.fury.io/rb/rinfo) [![Build Status](https://travis-ci.org/rafecolton/rinfo.png?branch=master)](https://travis-ci.org/rafecolton/rinfo) [![Dependency Status](https://gemnasium.com/rafecolton/rinfo.png)](https://gemnasium.com/rafecolton/rinfo)
 
-Usage:
+## Usage
 
-Add the `rinfo` gem to your `Gemfile`:
+Ever wish you could have quick and easy access to release information
+("rinfo") about your Rails application's latest release?  Well now you
+can!
+
+Rinfo adds the following route to your application:
+
+```ruby
+get '/rinfo.json'
+```
+
+Accessing your `rinfo.json` page will product something like this:
+
+```javascript
+{
+  Deployed By: "Rafe Colton",
+  Deployed At: "2014-03-17 15:18:35 -0700",
+  Rails Env: "development",
+  Branch: "master",
+  Rev: "018f44579795167c56066c013b4b18e196142ecb"
+}
+```
+
+It's as easy as that!
+
+## Installation
+
+To add `rinfo` to your Rails application, add the `rinfo` gem to your `Gemfile`:
 
 ```ruby
 gem 'rinfo'
 ```
+
+Then, to install the gem:
+
+```bash
+bundle install
+```
+
+## Configuring
+
+Rinfo's functionality is extremely simple, and it doesn't require any
+configuration, but should you desire, it is configurable.
+
+Your configuration file `config/initializers/rinfo.rb` would look
+something like this:
+
+```ruby
+# config/initializers/rinfo.rb
+Rinfo.env_blacklist = :staging, :production
+```
+
+The `env_blacklist` attribute is a list of environments such that if it
+includes your `RAILS_ENV`, the `/rinfo.json` route will return a `404`
+response insetad of a `JSON` blob.  The arguments provided can be a
+string, an array, or a comma separated list, and each entry can be
+either a string or a symbol.  The default blacklist is `[:prod,
+:production]`
+
+**NOTE:** There is one special value `:all`, which, if included in your
+list, will prevent `rinfo.json` from showing up entirely, regardless of
+your `RAILS_ENV`

data/app/controllers/rinfo_controller.rb

@@ -4,6 +4,8 @@ class RinfoController < ApplicationController
   include Rails.application.routes.url_helpers
 
   def info
-    render json: Rinfo.info
+    render json: Rinfo.inform!
+  rescue
+    render nothing: true, status: 404
   end
 end

data/config.ru

@@ -1,4 +1,4 @@
 # Rails.root/config.ru
 require ::File.expand_path('../config/environment',  __FILE__)
 
-run RinfoApp::Application
+run Rinfo::Application

data/lib/rinfo.rb

@@ -2,23 +2,37 @@
 
 require 'rinfo/engine'
 require 'git'
+require 'action_controller'
 
 class Rinfo
   autoload :VERSION, 'rinfo/version'
 
   class << self
-    def info
+    def inform!
+      fail ActionController::RoutingError 'Not Found' unless should_inform?
       <<-RINFO.gsub(/^ {6}/, '')
       {
         "Deployed By": "#{author}",
         "Deployed At": "#{date}",
-        "Rails Env": "#{Rails.env}",
+        "Rails Env": "#{env}",
         "Branch": "#{branch}",
         "Rev": "#{rev}"
       }
       RINFO
     end
 
+    def should_inform?
+      ([:all, env.to_sym] & env_blacklist).empty?
+    end
+
+    def env_blacklist
+      @env_blacklist ||= [:prod, :production]
+    end
+
+    def env_blacklist=(args)
+      @env_blacklist = [*args].map(&:to_sym)
+    end
+
     private
 
     def git
@@ -29,6 +43,10 @@ class Rinfo
       Rails.root
     end
 
+    def env
+      Rails.env
+    end
+
     def author
       git.config('user.name')
     end

data/lib/rinfo/version.rb

@@ -2,6 +2,6 @@
 
 unless defined?(Rinfo::VERSION)
   class Rinfo
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

data/spec/controllers/rinfo_controller_spec.rb

@@ -4,7 +4,7 @@ require 'tmpdir'
 require 'git'
 
 describe RinfoController, type: :controller do
-  before :all do
+  before(:all) do
     # create temporary directory
     @tmpdir = Dir.mktmpdir
     Dir.chdir(@tmpdir)
@@ -27,7 +27,11 @@ describe RinfoController, type: :controller do
     @date = git.log.first.date
   end
 
-  after :all do
+  before(:each) do
+    Rinfo.stub(:root).and_return(@tmpdir)
+  end
+
+  after(:all) do
     Dir.chdir(Rails.root)
     FileUtils.rm_rf(@tmpdir)
   end
@@ -39,11 +43,14 @@ describe RinfoController, type: :controller do
   let(:rev) { @rev }
 
   let(:rinfo) do
+  end
+
+  def rinfo
     <<-RINFO.gsub(/^ {4}/, '')
     {
       "Deployed By": "#{author}",
       "Deployed At": "#{deploy_time}",
-      "Rails Env": "#{rails_env}",
+      "Rails Env": "#{Rinfo.send(:env)}",
       "Branch": "#{branch}",
       "Rev": "#{rev}"
     }
@@ -51,11 +58,83 @@ describe RinfoController, type: :controller do
   end
 
   describe 'GET #info' do
-    it 'renders rinfo.json' do
-      Rinfo.stub(:root).and_return(@tmpdir)
+    let(:rails_envs) do
+      %w(test development demo stage staging prod production).map(&:to_sym)
+    end
+    let(:default_blacklist) { [:prod, :production] }
+    let(:default_whitelist) do
+      %w(test development demo stage staging).map(&:to_sym)
+    end
+    let(:custom_blacklist) { [:demo, :stage] }
+    let(:blacklist_allow_all) { [:none] }
+    let(:blacklist_allow_none) { [:all] }
+
+    context 'default blacklisted envs' do
+      it 'does not display rinfo for blacklisted envs' do
+        default_blacklist.each do |env|
+          Rinfo.stub(:env).and_return(env.to_s)
+          get 'info', format: :json
+          response.status.should == 404
+        end
+      end
+
+      it 'displays rinfo for all envs not on the blacklist' do
+        default_whitelist.each do |env|
+          Rinfo.stub(:env).and_return(env.to_s)
+          get 'info', format: :json
+          response.body.should == rinfo
+        end
+      end
+    end
+
+    context 'all envs enabled' do
+      before(:each) do
+        Rinfo.stub(:env_blacklist).and_return(blacklist_allow_all)
+      end
+
+      it 'displays rinfo for all envs' do
+        rails_envs.each do |env|
+          Rinfo.stub(:env).and_return(env.to_s)
+          get 'info', format: :json
+          response.body.should == rinfo
+        end
+      end
+    end
+
+    context 'all envs disabled' do
+      before(:each) do
+        Rinfo.stub(:env_blacklist).and_return blacklist_allow_none
+      end
+
+      it 'does not display rinfo for any envs' do
+        rails_envs.each do |env|
+          Rinfo.stub(:env).and_return(env.to_s)
+          get 'info', format: :json
+          response.status.should == 404
+        end
+      end
+    end
+
+    context 'custom blacklist' do
+      before(:each) do
+        Rinfo.stub(:env_blacklist).and_return(custom_blacklist)
+      end
+
+      it 'does not display rinfo for blacklisted envs' do
+        custom_blacklist.each do |env|
+          Rinfo.stub(:env).and_return(env.to_s)
+          get 'info', format: :json
+          response.status.should == 404
+        end
+      end
 
-      get 'info', format: :json
-      response.body.should == rinfo
+      it 'displays rinfo for non-blacklisted envs' do
+        (rails_envs - custom_blacklist).each do |env|
+          Rinfo.stub(:env).and_return(env.to_s)
+          get 'info', format: :json
+          response.body.should == rinfo
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rinfo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rafe Colton