rack-useful_procline 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5789281f880a804629b7efb859f4873b88a2149a
+  data.tar.gz: 0991ec2800518435f9413a7e2bb1b62342432050
+SHA512:
+  metadata.gz: c08f84c878b7016cfaa61f16cbb20d02491e33d87a133b34ad3092bb433bd72bb8f117248575bb1c52066232e9766d873cb995c9dbf0865825f2ec5adf350731
+  data.tar.gz: 6ae5560e7f5eaf1ad12ddc72d2c48d70c94d0a30e787de911c96318863fc3246e5e49f79dda1a605a22a62ec73b00e1e15ae240ecb3e4cf8945f8e1b731fe350

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-useful_procline.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aaron Wallis
+
+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,63 @@
+# Rack::UsefulProcline
+
+Make your proclines informative with some lovely middleware.
+
+Instead of
+
+```
+unicorn master -p 5200
+unicorn worker[0] -p 5200
+```
+
+See this
+
+```
+unicorn master -p 5200
+unicorn worker[0] : last status: 200. last request_uuid: 53ebb737. Waiting for req.
+unicorn worker[0] : GET : /all/the/things : cb18e336
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-useful_procline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-useful_procline
+
+## Usage
+
+### Configure
+
+Default config is:
+
+```ruby
+Rack::UsefulProcline.configure do |config|
+  config.opts[:request_uuid_key]    = 'action_dispatch.request_id'
+  config.opts[:show_request_uuid]   = true
+  config.opts[:show_request_method] = true
+  config.opts[:show_request_path]   = true
+end
+```
+
+### Use
+
+```ruby
+use Rack::UsefulProcline
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rack-useful_procline/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/rack/useful_procline.rb

@@ -0,0 +1,95 @@
+require 'rack'
+
+module Rack
+  class UsefulProcline
+    VERSION = "0.0.1"
+    
+    class << self
+      attr_accessor :config
+      
+      def configure
+        @config ||= Config.new
+        yield(config) if block_given?
+        @config
+      end
+    end
+    
+    class Config
+      attr_accessor :opts
+      
+      def initialize
+        @opts = {
+          request_uuid_key:       'action_dispatch.request_id', # Rails' default
+          show_request_uuid:      true,
+          show_request_method:    true,
+          show_request_path:      true
+        }
+      end
+    end
+    
+    attr_accessor :app, :config
+    
+    def initialize(app)
+      @app = app
+      @config = Rack::UsefulProcline.configure
+    end
+    
+    # Public
+    def call(env)
+      prefix = $0.split(']')[0] + "] "
+      procline = prefix.dup
+      procline = procline_before_request(procline, env)
+      
+      set_procline(procline[0..200])
+      
+      status, headers, body = @app.call(env)
+      
+      procline = prefix.dup
+      procline = procline_after_request(procline, env, status)
+      set_procline(procline)
+      
+      [status, headers, body]
+    end
+    
+    def set_procline(value)
+      $0 = sanitize_utf8(value)
+    end
+    
+    def sanitize_utf8(string)
+      return string.force_encoding('utf-8') if string.valid_encoding?
+      string.chars.select(&:valid_encoding?).join.force_encoding('utf-8')
+    end
+    
+    def procline_before_request(procline, env)
+      if @config.opts[:show_request_method]
+        procline.concat(" : #{env['REQUEST_METHOD']}")
+      end
+      
+      if @config.opts[:show_request_path]
+        procline.concat(" : #{env['REQUEST_PATH']}")
+      end
+      
+      if @config.opts[:show_request_uuid]
+        request_uuid = request_uuid_from(env) || "No request uuid found"
+        procline.concat(" : #{request_uuid_from(env)}")
+      end
+      
+      procline
+    end
+    
+    def request_uuid_from(env)
+      request_uuid = env[@config.opts[:request_uuid_key]]
+      request_uuid = request_uuid[0..7] if request_uuid
+      request_uuid
+    end
+    
+    def procline_after_request(procline, env, status)
+      procline.concat(": last status: #{status}.")
+      if @config.opts[:show_request_uuid]
+        request_uuid = request_uuid_from(env) || "No request uuid found"
+        procline += " last request_uuid: #{request_uuid}."
+      end
+      procline += " Waiting for req."
+    end
+  end
+end

data/rack-useful_procline.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/useful_procline'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-useful_procline"
+  spec.version       = Rack::UsefulProcline::VERSION
+  spec.authors       = ["Aaron Wallis"]
+  spec.email         = ["awallis@bleacherreport.com"]
+  spec.summary       = %q{Modify Unicorn's procline to show useful information}
+  spec.description   = %q{Rack middleware to modify Unicorn's procline to display request method, path and uuid during the request.}
+  spec.homepage      = "https://github.com/wheels/rack-useful_procline"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack", "~> 1.5.2"
+end

data/spec/rack/useful_procline_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe Rack::UsefulProcline do
+  it 'has a version number' do
+    expect(Rack::UsefulProcline::VERSION).not_to be nil
+  end
+  
+  describe 'on initialization' do
+    subject { Rack::UsefulProcline.new(rack_app) }
+  end
+end
+
+describe Rack::UsefulProcline::Config do
+  describe 'default config' do
+    subject do
+      Rack::UsefulProcline.new(rack_app).config
+    end
+    
+    it { expect(subject.opts[:request_uuid_key]).to eql('action_dispatch.request_id') }
+    it { expect(subject.opts[:show_request_uuid]).to be true }
+    it { expect(subject.opts[:show_request_method]).to be true }
+    it { expect(subject.opts[:show_request_path]).to be true }
+  end
+  
+  describe 'modified config' do
+    before(:each) do
+      Rack::UsefulProcline.configure do |config|
+        config.opts[:request_uuid_key] = 'my_request_uuid_key'
+        config.opts[:show_request_uuid] = false
+        config.opts[:show_request_method] = false
+        config.opts[:show_request_path] = false
+      end
+    end
+    
+    subject do
+      Rack::UsefulProcline.new(rack_app).config
+    end
+    
+    it { expect(subject.opts[:request_uuid_key]).to eql('my_request_uuid_key') }
+    it { expect(subject.opts[:show_request_uuid]).to be false }
+    it { expect(subject.opts[:show_request_method]).to be false }
+    it { expect(subject.opts[:show_request_path]).to be false }
+  end
+
+end
+
+describe Rack::UsefulProcline do
+  subject { Rack::UsefulProcline.new(rack_app) }
+  
+  describe '#call' do
+    subject do
+      Rack::UsefulProcline.new(rack_app).call(rack_env)
+    end
+    
+    it { expect(subject[0]).to eql("200") }
+    it { expect(subject[1]).to eql({'Content-Type' => 'text/html'}) }
+    it { expect(subject[2]).to eql(['A Rack app!']) }
+  end
+  
+  describe '#sanitize_utf8' do
+    # not sure what to do here
+  end
+  
+  describe '#set_procline' do
+    # or here
+  end
+  
+  describe '#request_uuid_from' do
+    it 'should retrieve the truncated request uuid' do
+      env = {'action_dispatch.request_id' => 'my_request_uuid'}
+      expect(subject.request_uuid_from(env).length).to eql(8)
+    end
+  end
+  
+  describe '#procline_before_request' do
+    subject do 
+      Rack::UsefulProcline.new(rack_app).procline_before_request("", rack_env)
+    end
+    
+    describe "with default config (everything true)" do
+      it { expect(subject).to include("GET") }
+      it { expect(subject).to include("/path/to/things") }
+      it { expect(subject).to include("12345678") }
+    end
+    
+    describe "with show_request_method, show_request_uuid and show_request_path turned off" do
+      subject do
+        Rack::UsefulProcline.configure do |config| 
+          config.opts[:show_request_method] = false
+          config.opts[:show_request_path] = false
+          config.opts[:show_request_uuid] = false
+        end
+        Rack::UsefulProcline.new(rack_app).procline_before_request("", rack_env)
+      end
+      
+      it do 
+        expect(subject).not_to include("GET")
+        expect(subject).not_to include("/path/to/things")
+        expect(subject).not_to include("12345678")
+      end
+    end
+    
+    describe "with custom request_uuid_key" do
+      subject do
+        key = "my_request_uuid_key"
+        Rack::UsefulProcline.configure { |config| config.opts[:request_uuid_key] = key }
+        Rack::UsefulProcline.new(rack_app).procline_before_request("", rack_env(request_uuid_key: key))
+      end
+      
+      it { expect(subject).to include("12345678") }
+    end
+  end
+  
+  describe '#procline_after_request' do
+    before(:each) do
+      def create_subject(opts = {})
+        opts[:rack_app] ||= rack_app
+        opts[:rack_env] ||= rack_env
+        Rack::UsefulProcline.new(opts[:rack_app]).procline_after_request("", opts[:rack_env], "200")
+      end
+    end
+    
+    describe "with default config (everything true)" do
+      subject { create_subject }
+      
+      it do
+        expect(subject).not_to include("GET")
+        expect(subject).not_to include("/path/to/things")
+        expect(subject).to include("12345678")
+        expect(subject).to include("last status: 200.")
+        expect(subject).to include("Waiting for req.")
+      end
+    end
+    
+    describe "with show_request_method, show_request_uuid and show_request_path turned off" do
+      subject do
+        Rack::UsefulProcline.configure do |config| 
+          config.opts[:show_request_method] = false
+          config.opts[:show_request_path] = false
+          config.opts[:show_request_uuid] = false
+        end
+        create_subject
+      end
+      
+      it do 
+        expect(subject).not_to include("GET")
+        expect(subject).not_to include("/path/to/things")
+        expect(subject).not_to include("12345678")
+        expect(subject).to include("last status: 200.")
+        expect(subject).to include("Waiting for req.")
+      end
+    end
+    
+    describe "with custom request uuid key" do
+      subject do
+        key = 'my_request_uuid_key'
+        Rack::UsefulProcline.configure { |config| config.opts[:request_uuid_key] = key }
+        env = rack_env(request_uuid_key: key)
+        create_subject(rack_env: env)
+      end
+      
+      it { expect(subject).to include("12345678") }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rack'
+require 'rack/useful_procline'
+
+RSpec.configure do |config|
+  def rack_app(opts = {})
+    status        = opts[:status] || '200'
+    content_type  = opts[:content_type] || 'text/html'
+    body          = opts[:body] || 'A Rack app!'
+    
+    Proc.new do |env|
+      [status, {'Content-Type' => content_type}, [body]]
+    end
+  end
+  
+  def rack_env(opts = {})
+    opts[:request_uuid_key] ||= 'action_dispatch.request_id'
+    {
+      opts[:request_uuid_key] => '12345678 longish string',
+      'REQUEST_METHOD' => 'GET',
+      'REQUEST_PATH' => '/path/to/things'
+    }
+  end
+  
+  config.after(:each) do
+    Rack::UsefulProcline.config = nil
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: rack-useful_procline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aaron Wallis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+description: Rack middleware to modify Unicorn's procline to display request method,
+  path and uuid during the request.
+email:
+- awallis@bleacherreport.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/useful_procline.rb
+- rack-useful_procline.gemspec
+- spec/rack/useful_procline_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wheels/rack-useful_procline
+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.14
+signing_key: 
+specification_version: 4
+summary: Modify Unicorn's procline to show useful information
+test_files:
+- spec/rack/useful_procline_spec.rb
+- spec/spec_helper.rb