rack-client_spec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de9e5964309bcddf739863f1e58aa0f7ca6c248c
+  data.tar.gz: 62edd421cfb14b26b66848b5abec62d325e42b95
+SHA512:
+  metadata.gz: 59459a7f8c6056ba7ff9390327bc9cab83e9ddccd69a397155f02a13a02495bde6da706a02e47b6241b3948c155ab2b6f5cec29d3682d87eee7252ce383878d9
+  data.tar.gz: 90e1a37bc3ff6c65c59501ceaef054609761002d18b5d9b7140607d17360708c3d906c0b6356b3ffd5983a68626ae4fae8176fb65d9f10f09e5eb8c51ba459a8

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 harukasan
+
+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,70 @@
+# Rack::ClientSpec
+
+Rack::ClientSpec can test your client.
+
+## TODO
+
+Current implementation is "it just works" for prototyping, not enough for release.
+
+- request flow
+- run multiple test methods
+- non-existence test
+- bug fix
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-client_spec'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Write your client spec like below (this code is included in [lib/lobster_spec.rb](https://github.com/harukasan/rack-client_spec/blob/master/lib/lobster_spec.rb)):
+
+```lobster_spec.rb
+require 'rack/client_spec'
+
+class LobsterSpec < Rack::ClientSpec::TestCase # <-- test case
+  def test_flip_referer # <-- test method
+    get '/' do |req, res| # <-- expect request
+      assert { res.status == 200 } # <-- assertion
+    end
+
+    get '/?flip=left' do |req, res| # <-- expect request
+      assert { req['HTTP_REFERER'] == 'http://localhost:9292/' } # <-- assertion
+    end
+
+    get '/?flip=right' do |req, res| # <-- expect request
+      assert { req['HTTP_REFERER'] == 'http://localhost:9292/?flip=left' }
+    end
+  end
+end
+```
+
+Then, use ClientSpec in your config.ru:
+
+```lobster.ru
+require 'rack'
+require 'rack/lobster'
+require 'rack/client_spec'
+require 'lobster_spec'
+
+use Rack::ClientSpec, LobsterSpec
+run Rack::Lobster.new
+```
+
+Finally, rackup your server, and you can test a client (eg. your favorite web browser).
+
+## Contributing
+
+1. [Fork it](https://github.com/harukasan/rack-client_spec/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,2 @@
+require "bundler/gem_tasks"
+

data/examples/lobster.ru

@@ -0,0 +1,7 @@
+require 'rack'
+require 'rack/lobster'
+require 'rack/client_spec'
+require 'lobster_spec'
+
+use Rack::ClientSpec, LobsterSpec
+run Rack::Lobster.new

data/lib/lobster_spec.rb

@@ -0,0 +1,18 @@
+require 'rack/client_spec'
+
+class LobsterSpec < Rack::ClientSpec::TestCase # <-- test case
+  def test_flip # <-- test method
+    get '/' do |req, res| # <-- expect request
+      assert { res.status == 200 } # <-- assertion
+    end
+
+    get '/?flip=left' do |req, res| # <-- expect request
+      assert { req['HTTP_REFERER'] == 'http://localhost:9292/' } # <-- assertion
+    end
+
+    get '/?flip=right' do |req, res| # <-- expect request
+      assert { req['HTTP_REFERER'] == 'http://localhost:9292/?flip=left' }
+    end
+  end
+end
+

data/lib/rack/client_spec/assertions.rb

@@ -0,0 +1,19 @@
+require 'power_assert'
+
+module Rack
+  class ClientSpec
+    class Assertion < Exception
+    end
+
+    module Assertions
+      def assert(&block)
+        PowerAssert.start(block, assertion_method: __callee__) do |pa|
+          unless pa.yield
+            raise Assertion, pa.message_proc.call
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/rack/client_spec/expect_request.rb

@@ -0,0 +1,33 @@
+module Rack
+  class ClientSpec
+    class ExpectRequest
+      attr_reader :path, :env
+
+      def initialize(method, path, env = {})
+        env["REQUEST_METHOD"] = method
+        @path = path
+        @env = env
+      end
+
+      def match?(env)
+        match_path?(env) && match_env?(env)
+      end
+
+      def match_path?(env)
+        path = [env['PATH_INFO'], env['QUERY_STRING']].join '?'
+        path = path.chop if path[-1] == "?"
+        @path === path
+      end
+
+      def match_env?(env)
+        !@env.each{|k, v| break unless env[k] == v}.nil?
+      end
+
+      def desc
+        "#{@env['REQUEST_METHOD']} #{@path}"
+      end
+    end
+  end
+end
+
+

data/lib/rack/client_spec/got_request.rb

@@ -0,0 +1,33 @@
+module Rack
+  class ClientSpec
+    class GotRequest
+      class Response
+        def inspect
+          "#<Response>"
+        end
+        def initialize(response)
+          @response = response
+        end
+        def status
+          @response[0]
+        end
+        def headers
+          @response[1]
+        end
+        def body
+          @response[2]
+        end
+        def [](i)
+          @response[i]
+        end
+      end
+
+      attr_reader :env, :response
+
+      def initialize(env, response)
+        @env = env
+        @response = Response.new(response)
+      end
+    end
+  end
+end

data/lib/rack/client_spec/printer.rb

@@ -0,0 +1,44 @@
+require 'ansi'
+
+module Rack
+  class ClientSpec
+    module Printer
+      def print_initialized
+        puts ANSI.white_on_blue{ " ClientSpec " } + ANSI.black_on_green{ " version #{Rack::ClientSpec::VERSION} " } 
+      end
+
+      def print_states(states)
+        puts ANSI.white_on_blue{ " ClientSpec " } + ANSI.black_on_yellow{ " EXPECT REQUEST SEQUENCE (#{states.size}) " } 
+        states.each do |name, sequence|
+          state = ""
+          sequence.each do |req|
+            state += ANSI.yellow{ " -> " }
+            if req[:passed]
+              state += ANSI.black_on_green { req[:request].desc }
+            else
+              state += ANSI.white { req[:request].desc }
+            end
+          end
+          puts " - #{name}:#{state}"
+        end
+
+        puts ""
+      end
+
+      def print_success(name)
+        puts ANSI.black_on_green{ " SUCCESS " } + " #{name}"
+      end
+
+      def print_fail(name, result)
+        puts ANSI.black_on_red{ " FAIL " } + " #{name}"
+        puts result.error.to_s
+      end
+
+      module_function :print_initialized
+      module_function :print_states
+      module_function :print_success
+      module_function :print_fail
+    end
+  end
+end
+

data/lib/rack/client_spec/request_trace.rb

@@ -0,0 +1,53 @@
+module Rack
+  class ClientSpec
+    class RequestTrace
+      attr_reader :match
+
+      def initialize(sequences)
+        @pointers = {}
+        @sequences = {}
+        @match = nil
+        sequences.each do |name, sequence|
+          set_sequence name, sequence
+        end
+      end
+
+      def set_sequence(name, sequence)
+        @sequences[name] = sequence
+        @pointers[name] = 0
+      end
+
+      def reset(name)
+        @pointers[name] = 0
+      end
+
+      def trace(env)
+        @sequences.each do |name, sequence|
+          next unless sequence[@pointers[name]].match?(env)
+          @pointers[name] += 1
+          if @pointers[name] == sequence.length
+            @match = name
+            break
+          end
+        end
+        !@match.nil?
+      end
+
+      def states
+        states = {}
+        @sequences.each do |name, sequence|
+          states[name] = []
+          sequence.each_with_index do |request, i|
+            states[name] << {
+              passed: @pointers[name] > i,
+              request: request,
+            }
+          end
+        end
+
+        states
+      end
+    end
+  end
+end
+

data/lib/rack/client_spec/result.rb

@@ -0,0 +1,17 @@
+
+module Rack
+  class ClientSpec
+    class Result
+      attr_reader :error
+
+      def initialize(error = nil)
+        @error = error
+      end
+
+      def success?
+        @error.nil?
+      end
+    end
+  end
+end
+

data/lib/rack/client_spec/test_case.rb

@@ -0,0 +1,89 @@
+require 'power_assert'
+require 'rack/client_spec/assertions'
+require 'rack/client_spec/expect_request'
+require 'rack/client_spec/result'
+
+module Rack
+  class ClientSpec
+    class TestCase
+      include Rack::ClientSpec::Assertions
+
+      def self.make_sequences()
+        sequences = {}
+        self.instance_methods.grep(/^test_/).map do |name|
+          sequences[name] = self.new(nil).call_test_method(name, test: false).sequence
+        end
+        sequences
+      end
+
+      def self.run_sequence(name, sequence)
+        r = nil
+        begin
+          self.new(sequence).call_test_method(name, test: true)
+        rescue Assertion => e
+          r = e
+        end
+        Result.new r
+      end
+
+      attr_reader :sequence
+
+      def initialize(got_sequence = nil)
+        @got_sequence = got_sequence
+        @run_test = !got_sequence.nil?
+        @sequence = []
+      end
+
+      def assert_request(expect_request, &block)
+        got = @got_sequence.shift
+        unless expect_request.match? got.env
+          raise ArgumentError, "Request is not matched with the expected request"
+        end
+        block.yield got.env, got.response
+      end
+
+      def call_test_method(name, test: nil)
+        @run_test = test unless test.nil?
+        setup if respond_to? :setup
+        send name
+        self
+      end
+
+      def route(method, path, env, &block)
+        request = ExpectRequest.new(method, path, env)
+        @sequence << request
+        assert_request request, &block if @run_test
+      end
+
+      def get(path, **env, &block)
+        route "GET", path, env, &block
+      end
+      def head(path, **env, &block)
+        route "HEAD", path, env, &block
+      end
+      def put(path, **env, &block)
+        route "PUT", path, env, &block
+      end
+      def post(path, **env, &block)
+        route "POST", path, env, &block
+      end
+      def delete(path, **env, &block)
+        route "DELETE", path, env, &block
+      end
+      def options(path, **env, &block)
+        route "OPTIONS", path, env, &block
+      end
+      def patch(path, **env, &block)
+        route "PATCH", path, env, &block
+      end
+      def link(path, **env, &block)
+        route "LINK", path, env, &block
+      end
+      def unlink(path, **env, &block)
+        route "UNLINK", path, env, &block
+      end
+
+      private :get, :head, :put, :post, :delete, :options, :patch, :link, :unlink
+    end
+  end
+end

data/lib/rack/client_spec/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class ClientSpec
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack/client_spec.rb

@@ -0,0 +1,47 @@
+require 'rack/client_spec/version'
+require 'rack/client_spec/test_case'
+require 'rack/client_spec/request_trace'
+require 'rack/client_spec/got_request'
+require 'rack/client_spec/printer'
+
+module Rack
+  class ClientSpec
+    def initialize(app, test_case)
+      @app = app
+      @test_case = test_case
+      @tracer = RequestTrace.new(test_case.make_sequences)
+      @sequence = []
+      Printer.print_initialized
+      Printer.print_states @tracer.states
+    end
+
+    def call(env)
+      response = @app.call(env)
+      begin
+        do_test(env, response)
+      rescue => e
+        p e # TODO error inspection
+      end
+      return response
+    end
+
+    def do_test(env, response)
+      @sequence << GotRequest.new(env, response)
+      matched = @tracer.trace(env)
+      if matched
+        match_function = @tracer.match
+        result = @test_case.run_sequence(match_function, @sequence)
+        @tracer.reset(match_function)
+      end
+
+      Printer.print_states @tracer.states
+      if result
+        if result.success?
+          Printer.print_success match_function
+        else
+          Printer.print_fail match_function, result
+        end
+      end
+    end
+  end
+end

data/lib/rack.rb

@@ -0,0 +1,3 @@
+module Rack
+  autoload :ClientSpec, 'rack/client_spec'
+end

data/rack-client_spec.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/client_spec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-client_spec"
+  spec.version       = Rack::ClientSpec::VERSION
+  spec.authors       = ["harukasan"]
+  spec.email         = ["harukasan@me.com"]
+  spec.summary       = %q{Rack middleware for test client behavior}
+  spec.description   = %q{Rack middleware for test client behavior. It can test client request to your rack applications. }
+  spec.homepage      = "https://github.com/harukasan/rack-client_spec"
+  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_dependency "rack", "~> 1.5"
+  spec.add_dependency "power_assert", "~> 0.2"
+  spec.add_dependency "ansi", "~> 1.4.3"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: rack-client_spec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- harukasan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-17 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: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+description: 'Rack middleware for test client behavior. It can test client request
+  to your rack applications. '
+email:
+- harukasan@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/lobster.ru
+- lib/lobster_spec.rb
+- lib/rack.rb
+- lib/rack/client_spec.rb
+- lib/rack/client_spec/assertions.rb
+- lib/rack/client_spec/expect_request.rb
+- lib/rack/client_spec/got_request.rb
+- lib/rack/client_spec/printer.rb
+- lib/rack/client_spec/request_trace.rb
+- lib/rack/client_spec/result.rb
+- lib/rack/client_spec/test_case.rb
+- lib/rack/client_spec/version.rb
+- rack-client_spec.gemspec
+homepage: https://github.com/harukasan/rack-client_spec
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rack middleware for test client behavior
+test_files: []