rack-env-notifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 896b4bc98af31b67e3fbf0cb357d67f660335301
+  data.tar.gz: 0a5b125d74a33fb039ac2a95f0e685673ce99209
+SHA512:
+  metadata.gz: bf559b169d4e91640aa67eacf0f465f9d1e78dc47f2743bb12c1ca1febb44d48d81f9a35163e27be3c7377df04a76b74a2c1f5e4ac1b4b313c56f8a1503772f0
+  data.tar.gz: 54fa2c7e78e82d3176f37e63de8cd9b625b9f5b8631dff93beed6e9103f38ac777937237a6cc9b315d049c1ad4c7df7d851dd220c707fc5e6429fc3e995016c9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format nested
+--color

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in env_status.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'rack'
+  gem 'rspec'
+  gem 'ZenTest'
+  gem 'autotest'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Catalin Ilinca
+
+MIT License
+
+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,94 @@
+# Rack::EnvNotifier [![Build Status](https://secure.travis-ci.org/ducknorris/rack-env-notifier.png)](http://travis-ci.org/ducknorris/rack-env-notifier) [![Code Climate](https://codeclimate.com/github/ducknorris/rack-env-notifier.png)](https://codeclimate.com/github/ducknorris/rack-env-notifier)
+
+Middleware that displays the custom environment notification for every html page. Designed to work both in production and in development.
+
+![alt tag](https://raw.github.com/ducknorris/env_notifier/master/assets/preview1.png)
+
+![alt tag](https://raw.github.com/ducknorris/env_notifier/master/assets/preview2.png)
+
+![alt tag](https://raw.github.com/ducknorris/env_notifier/master/assets/preview3.png)
+
+![alt tag](https://raw.github.com/ducknorris/env_notifier/master/assets/preview4.png)
+
+![alt tag](https://raw.github.com/ducknorris/env_notifier/master/assets/preview5.png)
+
+![alt tag](https://raw.github.com/ducknorris/env_notifier/master/assets/preview6.png)
+
+![alt tag](https://raw.github.com/ducknorris/env_notifier/master/assets/preview7.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'env_notifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install env_notifier
+
+## Usage
+
+This Gem will display a custom notification on every html page. By default it will only work on Development Environment. This can be overriden like so:
+
+    Rack::EnvNotifier.notify = Rails.env.production?
+
+or
+
+    Rack::EnvNotifier.notify = true if ["12.34.56.78", "127.0.0.1"].include?(request.remote_ip)
+
+### There are several configuration options
+
+#### Position on screen
+
+Even though the "default" position is at the top of the page, the notification uses ``#env-notifer`` CSS ID. This can be customized further on, using custom CSS.
+
+    #env-notifier {
+      font-size: 16px;
+    }
+
+    /* Rack::EnvNotifier.message = 'development' */
+
+    #env-notifier.development {
+      background: #369;
+      color: #fff;
+    }
+
+    /* Rack::EnvNotifier.message = 'watch out! production environment!!!' */
+
+    #env-notifier.watch-out-production-environment {
+      background: #8a0000;
+      color: #fff;
+      font-weight: bold;
+    }
+
+
+#### Notification message
+
+    Rack::EnvNotifier.message = "development mode"
+
+For Ruby on Rails, by default the message it will be the name of the current environment. This can be overriden like so:
+
+    case Rails.env
+    when "development"
+      Rack::EnvNotifier.message = "safe environment"
+    when "staging"
+      Rack::EnvNotifier.message = "qa environment"
+    else
+      Rack::EnvNotifier.message = "hot environment"
+    end
+
+## Contributing
+
+Thanks to our [contributors](https://github.com/ducknorris/env_notifier/graphs/contributors).
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+#### Inspired by [harleyttd / miniprofiler](https://github.com/harleyttd/miniprofiler/)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/env_notifier_rails/railtie.rb

@@ -0,0 +1,11 @@
+module EnvNotifierRails
+  class Railtie < ::Rails::Railtie
+    initializer 'rack_env_notifier.initialize' do |app|
+      Rack::EnvNotifier.message = 'development'
+      Rack::EnvNotifier.notify  = Rails.env.development?
+
+      # Install the Middleware
+      app.config.middleware.use Rack::EnvNotifier
+    end
+  end
+end

data/lib/rack/env_notifier/body_injector.rb

@@ -0,0 +1,38 @@
+module Rack
+  class EnvNotifier
+    class BodyInjector
+      BODY_TAG_REGEX = /<body>|<body[^(er)][^<]*>/
+
+      attr_reader :content_length, :new_body, :notification_added
+
+      def initialize(body, text_to_be_injected)
+        @body                = body
+        @text_to_be_injected = text_to_be_injected
+      end
+
+      def inject!(env)
+        @env = env
+        @body.close if @body.respond_to?(:close)
+
+        @body = [@body] if @body.is_a? String
+
+        @new_body = []
+        @body.each { |line| @new_body << line.to_s }
+
+        @content_length     = 0
+        @notification_added = false
+
+        @new_body.each do |line|
+          if !@notification_added && line['<body']
+            line.gsub! (BODY_TAG_REGEX) {|match| %{#{match}\n#{@text_to_be_injected}} }
+
+            @notification_added = true
+          end
+
+          @content_length += line.bytesize
+        end
+        @new_body = @body
+      end
+    end
+  end
+end

data/lib/rack/env_notifier.rb

@@ -0,0 +1,64 @@
+require 'rack/env_notifier/body_injector'
+
+module Rack
+  class EnvNotifier
+    class << self
+      def message
+        @message
+      end
+
+      def message=(message)
+        @message = message
+      end
+
+      def notification
+        <<-EOF
+<!-- Notify Start -->
+<div id="env-notifier" class="#{@message.gsub(/[^a-z]/i, '-').gsub(/--*/, '-').gsub(/-$/, '')}" style="position: fixed; top: 0; right: 0; left: 0; background: rgba(150, 50, 50, .7); color: #fff; text-align: center; font-size: 16px; font-weight: bold; padding: 2px; z-index: 999999">#{@message}</div>
+<!-- Notify End -->
+        EOF
+      end
+
+      def notify?
+        @notify
+      end
+
+      def notify=(notify)
+        @notify = notify
+      end
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      status, headers, body = @app.call(env)
+
+      # inject headers, notification
+      if status == 200 and EnvNotifier.notify?
+
+        # inject notification
+        if headers['Content-Type'] =~ %r{text/html} then
+          injector = BodyInjector.new(body, EnvNotifier.notification)
+          injector.inject!(env)
+
+          # inject header
+          if injector.notification_added
+            headers['X-EnvNotifier'] = EnvNotifier.message
+          end
+
+          headers['Content-Length'] = injector.content_length.to_s
+          [status, headers, injector.new_body]
+        end
+        [status, headers, body]
+      else
+        [status, headers, body]
+      end
+    end
+  end
+end

data/lib/rack-env-notifier.rb

@@ -0,0 +1,6 @@
+require 'rack/env_notifier'
+require 'rails/railtie' if defined? ::Rails
+
+class Rack::EnvNotifier
+  VERSION = "0.0.1"
+end

data/rack-env-notifier.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack-env-notifier'
+
+Gem::Specification.new do |spec|
+  spec.name             = "rack-env-notifier"
+  spec.version          = Rack::EnvNotifier::VERSION
+  spec.authors          = ["Catalin Ilinca"]
+  spec.email            = ["c@talin.ro"]
+  spec.description      = %q{Middleware that displays the current Environment notification for every html page. Designed to work both in production and in development.}
+  spec.summary          = %q{Know your ground!}
+  spec.homepage         = "https://github.com/ducknorris/rack-env-notifier"
+  spec.license          = "MIT"
+  spec.extra_rdoc_files = [
+    "README.md",
+    "CHANGELOG.md"
+  ]
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_development_dependency "rack-test"
+
+  spec.add_runtime_dependency 'rack', '>= 1.1.3'
+end

data/spec/rack/body_injector_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Rack::EnvNotifier::BodyInjector do
+  describe 'body tag regex' do
+    let(:regex) { described_class::BODY_TAG_REGEX }
+    subject { regex }
+
+    it { should be_kind_of(Regexp) }
+
+    it 'only picks a valid <body> tag' do
+      regex.match("<body></body>").to_s.should eq('<body>')
+      regex.match("<body><h1></h1></body>").to_s.should eq('<body>')
+      regex.match("<body attribute='something'><h1></h1></body>").to_s.should eq("<body attribute='something'>")
+    end
+
+    it 'responds false when no head tag' do
+      regex.match("<html></html>").should be_false
+    end
+  end
+end

data/spec/rack/env_notifier_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Rack::EnvNotifier do
+  include Rack::Test::Methods
+
+  def app
+    @app ||= Rack::Builder.new {
+      use Rack::EnvNotifier
+      map '/some/path' do
+        run lambda { |env| [200, {'Content-Type' => 'text/html'}, <<-EOF
+<html>
+  <head>
+    <title>Test page</title>
+  </head>
+  <body>
+    <h1>Howdy</h1>
+  </body>
+</html>
+          EOF
+        ]}
+      end
+    }.to_app
+  end
+
+  describe 'with a notify set on true' do
+
+    before do
+      Rack::EnvNotifier.message = 'warning!!! hot zone!!!'
+      Rack::EnvNotifier.notify = true
+      get '/some/path'
+    end
+
+    it 'returns 200' do
+      last_response.should be_ok
+    end
+
+    it 'has the X-EnvNotifier header' do
+      last_response.headers.has_key?('X-EnvNotifier').should be_true
+    end
+
+    it 'has only one X-EnvNotifier header' do
+      h = last_response.headers['X-EnvNotifier']
+      h.should eq('warning!!! hot zone!!!')
+    end
+
+    it 'has the Notification in the body' do
+      last_response.body.include?('<div id="env-notifier" class="warning-hot-zone" style="position: fixed; top: 0; right: 0; left: 0; background: rgba(150, 50, 50, .7); color: #fff; text-align: center; font-size: 16px; font-weight: bold; padding: 2px; z-index: 999999">warning!!! hot zone!!!</div>').should be_true
+    end
+
+  end
+
+  describe 'with a notify set on false' do
+
+    before do
+      Rack::EnvNotifier.message = 'warning!!!'
+      Rack::EnvNotifier.notify = false
+      get '/some/path'
+    end
+
+    it 'returns 200' do
+      last_response.should be_ok
+    end
+
+    it 'has the X-EnvNotifier header' do
+      last_response.headers.has_key?('X-EnvNotifier').should_not be_true
+    end
+
+    it 'has the Notification in the body' do
+      last_response.body.include?('<div id="env-notifier" class="warning" style="position: fixed; top: 0; right: 0; left: 0; background: rgba(150, 50, 50, .7); color: #fff; text-align: center; font-size: 16px; font-weight: bold; padding: 2px; z-index: 999999">warning</div>').should_not be_true
+    end
+
+  end
+
+  describe 'Notification format' do
+    before do
+      Rack::EnvNotifier.message = 'notification'
+      get '/some/path'
+    end
+
+    it "does format the Notification" do
+      Rack::EnvNotifier.notification.should eq(<<-EOF
+<!-- Notify Start -->
+<div id="env-notifier" class="notification" style="position: fixed; top: 0; right: 0; left: 0; background: rgba(150, 50, 50, .7); color: #fff; text-align: center; font-size: 16px; font-weight: bold; padding: 2px; z-index: 999999">notification</div>
+<!-- Notify End -->
+      EOF
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rack-env-notifier'
+require 'rack/test'

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: rack-env-notifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Catalin Ilinca
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+description: Middleware that displays the current Environment notification for every
+  html page. Designed to work both in production and in development.
+email:
+- c@talin.ro
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/preview1.png
+- assets/preview2.png
+- assets/preview3.png
+- assets/preview4.png
+- assets/preview5.png
+- assets/preview6.png
+- assets/preview7.png
+- lib/env_notifier_rails/railtie.rb
+- lib/rack-env-notifier.rb
+- lib/rack/env_notifier.rb
+- lib/rack/env_notifier/body_injector.rb
+- rack-env-notifier.gemspec
+- spec/rack/body_injector_spec.rb
+- spec/rack/env_notifier_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ducknorris/rack-env-notifier
+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.7
+signing_key: 
+specification_version: 4
+summary: Know your ground!
+test_files:
+- spec/rack/body_injector_spec.rb
+- spec/rack/env_notifier_spec.rb
+- spec/spec_helper.rb