rack-spyup 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13a00d09007c24f2788b9b4ec6cc1bb932229d98
-  data.tar.gz: 5080110619f8bf7b52517355f3a3506739719723
+  metadata.gz: 175c2c54f6ae21ef59b8775bda9aaf22f4eae6ed
+  data.tar.gz: 268aed09f1a0980a3b26fe1c068130f75ee032c9
 SHA512:
-  metadata.gz: 8b5391158635c471a3df14d20ef7dc06346bbb4dff3e75fa30a232f21726d2bb407d9bdb2ff419b1cb67c10bd7a74c61029691e2e43b92bd453305f7710cdec9
-  data.tar.gz: 5232d7b4c384b333f9f69299dde0dc1e141e72f68979eceec87cae439700e73377dcc3e1d2b723665454ae392a64596bbb65efe04387321f885a68dd83341a7e
+  metadata.gz: 2a638629936907de7a34e93e75be8cfa742bc0919e2e8b895283788e6789582e56a9c74251110e4033ab87998371f5939c6a835dd95407611cd42ddbd9c76429
+  data.tar.gz: 2afe651048012d42ad6d60ad6c29e956f9b313aad16f2bd3f729b3964ea1812e6971d4adb91c262e34624c693e68712961c337f894a2478acf8d5a5501870a3c

data/.rspec

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

data/README.md

@@ -2,6 +2,8 @@
 
 Spying request and json response
 
+[![wercker status](https://app.wercker.com/status/badde83f7252323fde185c68212600ba/m "wercker status")](https://app.wercker.com/project/bykey/badde83f7252323fde185c68212600ba)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end

data/lib/rack/spyup.rb

@@ -1,14 +1,17 @@
 require "rack/spyup/version"
+require "rack/spyup/configuration"
 require "logger"
 
 module Rack
   class SpyUp
-    def initialize(app, &configure)
+    def initialize(app, &instance_configure)
       @app = app
-      configure.call(self) if block_given?
+      @colorize = true
+      @logger   = self.class.config.logger
+      instance_configure.call(self) if block_given?
     end
     attr_reader :app
-    attr_accessor :logger
+    attr_accessor :logger, :colorize
 
     def call(env)
       return @app.call(env) if ignore_case?(env)
@@ -26,6 +29,16 @@ module Rack
       return res.finish
     end
 
+    class << self
+      def config(&global_configure)
+        @__config ||= Rack::SpyUp::Configuration.default
+        if block_given?
+          global_configure.call(@__config)
+        end
+        @__config
+      end
+    end
+
     private
     def ignore_case?(env)
       # TODO more options to omit logging
@@ -102,9 +115,10 @@ Body:
     end
 
     def pretty_json(json)
-      CodeRay.scan(JSON.pretty_unparse(JSON.parse(json)), :json)
-        .terminal
-        .gsub(/^/m, "\t")
+      formatted = JSON.pretty_unparse(JSON.parse(json))
+      formatted = CodeRay.scan(formatted, :json).terminal if colorize
+
+      formatted.gsub(/^/m, "\t")
     end
 
     def compose_response_headers(res)
@@ -117,15 +131,20 @@ Body:
     end
 
     def red(key)
+      return key unless colorize
       "\e[31m#{key}\e[0m"
     end
 
     def cyan(value)
+      return value unless colorize
       "\e[36m#{value}\e[0m"
     end
 
     def gray(value)
+      return value unless colorize
       "\e[37m#{value}\e[0m"
     end
   end
 end
+
+require "rack/spyup/railtie" if defined?(Rails)

data/lib/rack/spyup/configuration.rb

@@ -0,0 +1,15 @@
+require 'rack/spyup'
+module Rack
+  class SpyUp
+    class Configuration
+      attr_accessor :enabled_environments, :logger
+
+      def self.default
+        new.tap do |config|
+          config.enabled_environments = %w(development)
+          config.logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/rack/spyup/railtie.rb

@@ -0,0 +1,27 @@
+require 'rails/railtie'
+require 'rack/spyup'
+
+module Rack
+  class SpyUp
+    class Railtie < ::Rails::Railtie
+      config.rack_spyup = Rack::SpyUp.config
+
+      initializer "rack_spyup.initialize_middleware" do |app|
+        config = Rack::SpyUp.config
+        if Rails.env.to_s.in?(config.enabled_environments.map(&:to_s))
+          _logger = if config.logger && config.logger.respond_to?(:call)
+                      config.logger.call()
+                    elsif config.logger
+                      config.logger
+                    else
+                      Rails.logger
+                    end
+
+          app.middleware.insert 0, Rack::SpyUp do |mw|
+            mw.logger = _logger
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rack/spyup/version.rb

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

data/rack-spyup.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec", "~> 2.14.0"
+  spec.add_development_dependency "rack-test"
 end

data/spec/lib/rack-spyup_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+require 'stringio'
+require 'json'
+
+describe Rack::SpyUp do
+  describe "should not smoke" do
+    before do
+      mock_app do
+        use Rack::SpyUp do |mw|
+          mw.logger = Logger.null_logger
+        end
+        run lambda {|env| [200, {"Content-Type" => "text/html"}, ["OK"]]}
+      end
+    end
+
+    it "should be OK" do
+      expect {
+        get "/"
+      }.not_to raise_error
+    end
+
+    it "should not affect response" do
+      get "/"
+      expect(last_response.body).to eq("OK")
+    end
+  end
+
+  describe "options" do
+    before do
+      @output = StringIO.new
+    end
+
+    it "should contain colored log" do
+      _logger = Logger.new(@output)
+      mock_app do
+        use Rack::SpyUp do |mw|
+          mw.logger = _logger
+        end
+        run lambda {|env| [200, {"Content-Type" => "text/html"}, ["OK"]]}
+      end
+
+      get "/hello"
+      @output.rewind
+      expect(@output.read).to match(/\e\[\d+m/)
+    end
+
+    it "should not contain colored log when configured" do
+      _logger = Logger.new(@output)
+      mock_app do
+        use Rack::SpyUp do |mw|
+          mw.logger = _logger
+          mw.colorize = false
+        end
+        run lambda {|env| [200, {"Content-Type" => "text/html"}, ["OK"]]}
+      end
+
+      get "/hello"
+      @output.rewind
+      expect(@output.read).not_to match(/\e\[\d+m/)
+    end
+  end
+
+  describe "should display request info" do
+    before do
+      @output = StringIO.new
+      _logger = Logger.new(@output)
+
+      mock_app do
+        use Rack::SpyUp do |mw|
+          mw.logger = _logger
+          mw.colorize = false
+        end
+        run lambda {|env| [200, {"Content-Type" => "text/html"}, ["OK"]]}
+      end
+    end
+
+    it "should print request info" do
+      header "Host", "udzura.example.jp"
+      get "/hello"
+      @output.rewind
+      expect(@output.read).to match(%r|GET http://udzura.example.jp/hello|)
+    end
+
+    it "should contain custom header info" do
+      header "X-Forwarder-For", "192.0.2.1,192.0.2.2"
+      header "X-Foobar", "true"
+      get "/"
+      @output.rewind
+      printed = @output.read
+
+      expect(printed).to match(/X-Forwarder-For: 192.0.2.1,192.0.2.2/)
+      expect(printed).to match(/X-Foobar: true/)
+    end
+  end
+
+  describe "should display response info" do
+    before do
+      @output = StringIO.new
+      @logger = Logger.new(@output)
+    end
+
+    let(:body) do
+      {response: "OK"}.to_json
+    end
+
+    it "should print response info" do
+      _logger = @logger
+      _body = body
+
+      mock_app do
+        use Rack::SpyUp do |mw|
+          mw.logger = _logger
+          mw.colorize = false
+        end
+        run lambda {|env| [200, {"Content-Type" => "application/json"}, [_body]]}
+      end
+
+      get "/index.json"
+      @output.rewind
+      response = @output.read
+
+      expect(response).to match(/Content-Type: application\/json/)
+      expect(response).to match(/Content-Length: #{body.length}/)
+      expect(response).to match(/Body:\s+{\s+"response": "OK"\s+}/m)
+    end
+
+    it "should contain custom response info, such as header" do
+      _logger = @logger
+      _body = body
+
+      mock_app do
+        use Rack::SpyUp do |mw|
+          mw.logger = _logger
+          mw.colorize = false
+        end
+        run lambda {|env|
+          [200,
+            {"Content-Type" => "application/json",
+             "X-Powerd-By"  => "PHP/4.1.10"},
+            [_body]]}
+      end
+
+      get "/index.json"
+      @output.rewind
+      response = @output.read
+
+      expect(response).to match(/X-Powerd-By: PHP\/4.1.10/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'rack-spyup'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  require 'rack/test'
+  config.include Rack::Test::Methods
+  config.include Module.new {
+    def app
+      @app
+    end
+
+    def mock_app &builder
+      @app = Rack::Builder.new &builder
+    end
+  }
+end
+
+# extensions...
+def Logger.null_logger
+  Logger.new(File.open(IO::NULL, 'w'))
+end

data/wercker.yml

@@ -0,0 +1,15 @@
+box: wercker/ruby
+# Build definition
+# See the Ruby section on the wercker devcenter: 
+# http://devcenter.wercker.com/articles/languages/ruby.html
+build:
+  # The steps that will be executed on build
+  steps:
+    # A step that executes `bundle install` command
+    - bundle-install
+
+    # A custom script step, name value is used in the UI
+    # and the code value contains the command that get executed
+    - script:
+        name: Running rake spec
+        code: bundle exec rake spec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-spyup
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Uchio KONDO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-04 00:00:00.000000000 Z
+date: 2013-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -80,6 +80,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.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'
 description: Spying requests and responses with rack power
 email:
 - udzura@udzura.jp
@@ -89,6 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -100,8 +129,13 @@ files:
 - examples/config.ru
 - lib/rack-spyup.rb
 - lib/rack/spyup.rb
+- lib/rack/spyup/configuration.rb
+- lib/rack/spyup/railtie.rb
 - lib/rack/spyup/version.rb
 - rack-spyup.gemspec
+- spec/lib/rack-spyup_spec.rb
+- spec/spec_helper.rb
+- wercker.yml
 homepage: https://github.com/udzura/rack-spyup
 licenses:
 - MIT
@@ -127,4 +161,6 @@ signing_key:
 specification_version: 4
 summary: Spying requests and responses with rack power, like json, msgpack, xml, and
   so on...
-test_files: []
+test_files:
+- spec/lib/rack-spyup_spec.rb
+- spec/spec_helper.rb