rack-spyup 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13a00d09007c24f2788b9b4ec6cc1bb932229d98
+  data.tar.gz: 5080110619f8bf7b52517355f3a3506739719723
+SHA512:
+  metadata.gz: 8b5391158635c471a3df14d20ef7dc06346bbb4dff3e75fa30a232f21726d2bb407d9bdb2ff419b1cb67c10bd7a74c61029691e2e43b92bd453305f7710cdec9
+  data.tar.gz: 5232d7b4c384b333f9f69299dde0dc1e141e72f68979eceec87cae439700e73377dcc3e1d2b723665454ae392a64596bbb65efe04387321f885a68dd83341a7e

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Uchio KONDO
+
+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,50 @@
+# Rack::SpyUp
+
+Spying request and json response
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-spyup'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-spyup
+
+## Usage
+
+```ruby
+use Rack::SpyUp do |config|
+  config.logger = Logger.new(STDOUT)
+end
+```
+
+### `spyup` command
+
+rack-spyup is shipped with `spyup` command.
+You can use usual config.ru with request and response spyed:
+
+```bash
+$ spyup config.ru
+```
+
+`spyup` has the same options as `rackup` (except `--builder`),
+because she uses `Rack::Server` internally.
+
+## What you will see
+
+![Just like this](https://raw.github.com/udzura/rack-spyup/master/docs/spyup.png)
+
+
+## Contributing
+
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/spyup

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+require 'rack'
+require 'rack/server'
+
+server = Rack::Server.new
+
+builder_script = File.read(server.options.delete(:config) || 'config.ru')
+builder_script.prepend "use Rack::SpyUp\n"
+builder_script.prepend "require 'rack-spyup'\n"
+
+server.options[:builder] = builder_script
+server.start

data/examples/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rack"
+gem "rack-spyup", path: "../"
+gem "pry"

data/examples/config-spyup.ru

@@ -0,0 +1,17 @@
+require 'json'
+require 'rack-spyup'
+require 'pry'
+
+App = lambda do |env|
+  json =
+    {
+      status: "OK",
+      body: {hello: "World", rand: rand(10000)},
+      array: ["this", "is", "array"]
+    }.to_json
+  [200, {"Content-Type" => "application/json"}, [json]]
+end
+
+# spyup this file and you will get the same log
+# use Rack::SpyUp
+run App

data/examples/config.ru

@@ -0,0 +1,16 @@
+require 'json'
+require 'rack-spyup'
+require 'pry'
+
+App = lambda do |env|
+  json =
+    {
+      status: "OK",
+      body: {hello: "World", rand: rand(10000)},
+      array: ["this", "is", "array"]
+    }.to_json
+  [200, {"Content-Type" => "application/json"}, [json]]
+end
+
+use Rack::SpyUp
+run App

data/lib/rack/spyup/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class SpyUp
+    VERSION = "0.0.2"
+  end
+end

data/lib/rack/spyup.rb

@@ -0,0 +1,131 @@
+require "rack/spyup/version"
+require "logger"
+
+module Rack
+  class SpyUp
+    def initialize(app, &configure)
+      @app = app
+      configure.call(self) if block_given?
+    end
+    attr_reader :app
+    attr_accessor :logger
+
+    def call(env)
+      return @app.call(env) if ignore_case?(env)
+
+      req = Rack::Request.new(env)
+      detected_logger(env).debug format_request_output(req)
+
+      status_code, headers, body = @app.call(env)
+      res = Rack::Response.new(body, status_code, headers)
+      if res.content_type =~ /json/
+        json = ""
+        body.each{|part| json << part }
+        detected_logger(env).debug format_response_output(res, json)
+      end
+      return res.finish
+    end
+
+    private
+    def ignore_case?(env)
+      # TODO more options to omit logging
+      return true  if env["PATH_INFO"] =~ /favicon.ico$/
+      return false
+    end
+
+    # Do not cache - run detection by each call
+    def detected_logger(env)
+      _logger = logger || env['rack.logger'] || env['rack.error'] || ::Logger.new(STDOUT)
+      unless _logger.respond_to? :debug
+        def _logger.debug(str)
+          _logger.write(str)
+        end
+      end
+      _logger
+    end
+
+    def format_request_output(req)
+      body = req.body.read
+      req.body.rewind
+      <<-FORMAT % [to_request_line(req), compose_request_headers(req), body, format_cookies(req.cookies)]
+** REQUEST SPYED **
+Request:
+\t%s
+Headers:
+%s
+Body:
+\t%s
+Cookies:
+%s
+      FORMAT
+    end
+
+    def to_request_line(req)
+      "#{req.request_method} #{req.url}"
+    end
+
+    def compose_request_headers(req)
+      headers = <<-HEADERS.chomp
+Content-Type: #{req.content_type}
+Content-Length: #{req.content_length}
+Remote: #{req.env['REMOTE_ADDR']}
+      HEADERS
+      req.env.each do |key, value|
+        parts = key.scan(/^HTTP_([A-Z_]+)/).flatten.first
+        next if parts.nil?
+        _key = parts.split('_')
+          .map{|part| part.sub(/(?<=^[A-Z])[A-Z]*/) {|m| m.downcase } }
+          .join("-")
+        headers << "\n" << "#{_key}: #{value}"
+      end
+      headers
+        .gsub(/^[-a-zA-Z]+:/m, red('\0'))
+        .gsub(/^/, "\t")
+    end
+
+    def format_cookies(cookies)
+      return gray("\t<none>") if cookies.empty?
+      cookies.map{|k, v|
+        "\t#{red(k)} = #{cyan(v)}"
+      }.join("\n")
+    end
+
+    def format_response_output(res, json)
+      <<-FORMAT % [res.status, compose_response_headers(res), pretty_json(json)]
+** RESPONSE SPYED **
+Status Code: %d
+Headers:
+%s
+Body:
+%s
+      FORMAT
+    end
+
+    def pretty_json(json)
+      CodeRay.scan(JSON.pretty_unparse(JSON.parse(json)), :json)
+        .terminal
+        .gsub(/^/m, "\t")
+    end
+
+    def compose_response_headers(res)
+      res.headers.map {|k, v|
+        if v.include? "\n"
+          v = v.gsub(/\n/, "\n\t\t")
+        end
+        "\t#{red(k + ':')} #{v}"
+      }.join("\n")
+    end
+
+    def red(key)
+      "\e[31m#{key}\e[0m"
+    end
+
+    def cyan(value)
+      "\e[36m#{value}\e[0m"
+    end
+
+    def gray(value)
+      "\e[37m#{value}\e[0m"
+    end
+  end
+end

data/lib/rack-spyup.rb

@@ -0,0 +1 @@
+require 'rack/spyup'

data/rack-spyup.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/spyup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-spyup"
+  spec.version       = Rack::SpyUp::VERSION
+  spec.authors       = ["Uchio KONDO"]
+  spec.email         = ["udzura@udzura.jp"]
+  spec.description   = %q{Spying requests and responses with rack power}
+  spec.summary       = %q{Spying requests and responses with rack power, like json, msgpack, xml, and so on...}
+  spec.homepage      = "https://github.com/udzura/rack-spyup"
+  spec.license       = "MIT"
+
+  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_runtime_dependency "rack", '>= 1.4'
+  spec.add_runtime_dependency "coderay"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rack-spyup
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Uchio KONDO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: pry
+  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'
+description: Spying requests and responses with rack power
+email:
+- udzura@udzura.jp
+executables:
+- spyup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/spyup
+- docs/spyup.png
+- examples/Gemfile
+- examples/config-spyup.ru
+- examples/config.ru
+- lib/rack-spyup.rb
+- lib/rack/spyup.rb
+- lib/rack/spyup/version.rb
+- rack-spyup.gemspec
+homepage: https://github.com/udzura/rack-spyup
+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: Spying requests and responses with rack power, like json, msgpack, xml, and
+  so on...
+test_files: []