rack_toolkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 017242be2ce01950ad46eafb4c9aea3855b57dbe
+  data.tar.gz: 36138ff9218e813e4734074c118bd1606b3fd635
+SHA512:
+  metadata.gz: c2974c29604008d2446a65b7e39d6bf1d0bd344e5b26645587445db141ea3ba83cba87b3e3d84f1b1423103fd84dbc6e322363135e236855cd74ed0520ff18e5
+  data.tar.gz: a9d9ef14206965cf3d6c54940ac51c69e85a1535f86f47d107449f5422dfe416e0332f23d6ebe08d8f8b6a4ba76a1625448f37b64dea7197ccd32e5fcc4ac039

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,4 @@
+-I lib
+--format documentation
+--color
+--order random

data/.rspec-fast

@@ -0,0 +1,5 @@
+-I lib
+--format documentation
+--color
+--tag ~external
+--order random

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+  - jruby-9.1.2.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rodrigo Rosenfeld Rosas
+
+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,103 @@
+# RackToolkit [![Build Status](https://travis-ci.org/rosenfeld/rack_toolkit.svg?branch=master)](https://travis-ci.org/rosenfeld/rack_toolkit)
+
+RackToolkit will launch a Puma server in an available random port (unless one is specified) and
+will serve any Rack application, which can be changed dynamically. It's mostly useful for testing
+Rack apps, specially when an application is a mixin of several small Rack apps. It also provides
+a DSL to perform get and post requests and allows very fast integration tests with automatic
+cookies based session management (using http-cookies's CookieJar).
+
+It also supports "virtual hosts" so that you can use domain names and they would be forwarded
+to the Rack app if the domain is listed in the `virtual_hosts` option. It can also simulate
+https as if the request was coming from an HTTP proxy, like nginx, transparently if you use
+"https://..." in the requests using the DSL.
+
+The DSL can be also used to perform requests to other Internet domains.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack_toolkit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack_toolkit
+
+## Usage
+
+Create a new server (the initializer supports many options, but they can be also set later):
+
+```ruby
+require 'rack_toolkit'
+server = RackToolkit::Server.new start: true # or start it manually with server.start
+# you can stop it with server.stop
+```
+
+Set a Rack app application and perform a request:
+
+```ruby
+server.app = ->(env){ [ 200, {}, 'success!' ] }
+server.get '/'
+server.last_response.code == '200'
+server.last_response.body == 'success!'
+```
+
+`last_response` is a [Net::HTTPResponse](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/Net/HTTPResponse.html).
+
+Any cookies set by the application are stored in a cookie jar (`server.cookie_jar`).
+Use `server.reset_session!` to clear the session cookies jar and the referer information.
+
+The `default_domain` is automatically appended to the `virtual_hosts` option. Here's how to use
+them:
+
+```ruby
+server.virtual_hosts << 'my-domain.com' << 'www.my-domain.com'
+server.default_domain = 'test-app.com' # it's appended to virtual_hosts
+server.base_uri.to_s # 'http://test-app.com'
+server.post 'https://test-app.com/signin', follow_redirect: false # default is true
+server.env['HTTP_X_FORWARDED_PROTO'] == 'https'
+server.env['HTTP_HOST'] == 'test-app.com'
+server.last_response.status_code == 302 # assuming an app performing a redirect
+server.follow_redirect! # not necessary if follow_redirect: false is not specified
+server.last_response.ok? == true
+
+server.post '/signin', params: {user: 'guest', pass: 'secret'}
+
+server.post_data '/json_input', '{"json": "input"}'
+```
+
+Usually you'd start the server before the whole suite and replace the `app` as you test
+different apps. Starting Puma is really fast (less than 5ms usually) so if you prefer
+you can start it on each test file. Also, RackToolkit was designed so that you can span
+multiple servers running different apps for example if you want them to communicate to each
+other for testing SSO for example.
+
+Take a look at this project's test suite to see an example on how it can be configured and how
+it works.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec`
+to run the tests. You can also run `bin/console` for an interactive prompt that will allow
+you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a
+new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags, and push the `.gem`
+file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome [on GitHub](https://github.com/rosenfeld/rack_toolkit).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack_toolkit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack_toolkit/response_enhancer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require 'net/http'
+
+module RackToolkit
+  class Server
+    module ResponseEnhancer
+      def status_code
+        @status_code ||= code.to_i
+      end
+
+      def ok?
+        code == '200'
+      end
+
+      def redirect?
+        Net::HTTPRedirection === self
+      end
+
+      def error?
+        !(ok? || redirect?)
+      end
+
+      def headers
+        @headers ||= to_hash
+      end
+    end
+  end
+end

data/lib/rack_toolkit/server.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require 'puma'
+require 'net/http'
+require 'uri'
+require 'socket'
+require 'set'
+require 'http-cookie'
+require_relative 'response_enhancer'
+
+module RackToolkit
+  class Server
+    attr_accessor :app, :default_env, :referer, :default_headers
+    attr_reader :bind_host, :host, :server, :default_domain, :last_response, :http, :cookie_jar,
+      :env, :env_from_server, :rack_env, :virtual_hosts
+
+    def initialize(app: nil, port: nil, bind_host: '127.0.0.1', virtual_hosts: [], host: nil,
+                   dynamic_app: nil, default_env: {}, default_domain: nil, default_headers: {},
+                   start: false)
+      @app, @port, @bind_host, @default_env, @default_domain, @default_headers =
+        app, port, bind_host, default_env, default_domain, default_headers
+      @host = host || bind_host
+      @virtual_hosts = Set.new virtual_hosts
+      @virtual_hosts << default_domain if default_domain
+      @virtual_hosts << host
+      @dynamic_app = dynamic_app || default_dynamic_app
+      @request_env = {}
+      @referer = nil
+      @cookie_jar = HTTP::CookieJar.new
+      self.start if start
+    end
+
+    def start
+      @server = Puma::Server.new(@dynamic_app)
+      @server.add_tcp_listener @host, port
+      @server_thread = @server.run
+      @http = Net::HTTP.start @host, port
+    end
+    
+    def stop
+      @http.finish rescue nil # ignore errors on finish
+      @server.stop true
+    end
+
+    def default_domain=(default_domain)
+      @default_domain = default_domain
+      @virtual_hosts << default_domain if default_domain
+    end
+
+    def base_uri
+      @base_uri ||= URI("http://#{host}:#{port}")
+    end
+
+    def reset_session!
+      @cookie_jar.clear
+      self.referer = nil
+    end
+
+    # response = get('/'); body = response.body; headers = response.to_hash
+    # response['set-cookie'] # => string
+    # response.get_fields('set-cookie') # => array # same as response.to_hash['set-cookie']
+    def get(url_or_path, params: nil, headers: {}, env_override: {}, follow_redirect: true,
+            redirect_limit: 5)
+      wrap_response(url_or_path, headers, env_override, params, follow_redirect,
+                    redirect_limit) do |uri, h, http|
+        http.get(uri.path.empty? ? '/' : uri.path, h)
+      end
+    end
+
+    def post(url_or_path, params: nil, query_params: nil, headers: {}, env_override: {},
+             follow_redirect: true, redirect_limit: 5)
+      wrap_response(url_or_path, headers, env_override, params, follow_redirect,
+                    redirect_limit) do |uri, h, http|
+        req = Net::HTTP::Post.new uri, h
+        req.form_data = params if params
+        http.request req
+      end
+    end
+
+    def post_data(url_or_path, data, query_params: nil, headers: {},
+                  env_override: {}, follow_redirect: true, redirect_limit: 5)
+      wrap_response(url_or_path, headers, env_override, query_params, follow_redirect,
+                    redirect_limit) do |uri, h, http|
+        http.post(uri, data, h)
+      end
+    end
+
+    def follow_redirect!(limit: 5, env_override: {})
+      get @last_response['location'], redirect_limit: limit - 1, env_override: {}
+    end
+
+    def port
+      @port ||= find_free_tcp_port
+    end
+
+    private
+
+    def find_free_tcp_port
+      server = TCPServer.new(bind_host, 0)
+      server.addr[1]
+    ensure
+      server.close
+    end
+
+    NO_DEFINED_APP_RESPONSE =[ 500, {}, [ 'No app was defined for server' ] ].freeze
+    def default_dynamic_app
+      ->(env) do
+        return NO_DEFINED_APP_RESPONSE unless app
+        @env_from_server = env.clone
+        @env = (@rack_env = env.merge(default_env).merge(@request_env)).clone
+        app.call @rack_env
+      end
+    end
+
+    def wrap_response(url_or_path, headers, env_override, params, follow_redirect, redirect_limit)
+      uri = normalize_uri(url_or_path, params)
+      h = prepare_headers headers, env_override, uri
+      response = uri.host == host ? yield(uri, h, @http) :
+          Net::HTTP.start(uri.host, uri.port){|http| yield uri, h, http }
+      @last_response = response.extend ResponseEnhancer
+      store_cookies uri
+      self.referer = @original_uri.to_s
+      @request_env = {}
+      handle_redirect redirect_limit, env_override if follow_redirect
+      @last_response
+    end
+
+    def normalize_uri(uri, params)
+      uri = URI(uri)
+      uri.host ||= default_domain || host
+      uri.scheme ||= 'http'
+      if params and uri.query
+        raise InvalidArguments, "Do not send query params if url already contains them"
+      end
+      uri.query = URI.encode_www_form params if params
+      @original_uri = URI(uri.to_s)
+      if @virtual_hosts.include?(uri.host)
+        uri.host = host
+        uri.scheme = 'http'
+      end
+      URI(uri.to_s)
+    end
+
+    def prepare_headers(headers, env_override, uri)
+      uri = @original_uri
+      @request_env = @request_env.merge(env_override).delete_if{|k, v| v.nil? }
+      h = default_headers.merge('Cookie' => HTTP::Cookie.cookie_value(@cookie_jar.cookies uri))
+      if referer && (origin_uri = URI referer) &&
+          (origin_uri.scheme == 'http' || uri.scheme == 'https')
+        origin_uri = URI(referer)
+        origin_uri.path = ''
+        h['Origin'] = origin_uri.to_s
+        h['Referer'] = referer
+      end
+      h['X-Forwarded-Proto'] = 'https' if uri.scheme == 'https'
+      h['Host'] ||= uri.host
+      h['Host'] ||= default_domain if default_domain
+      h.merge(headers).delete_if{|k, v| v.nil? }
+    end
+
+    InfiniteRedirect = Class.new RuntimeError
+    def handle_redirect(redirect_limit, env_override)
+      return unless Net::HTTPRedirection === @last_response
+      raise InfiniteRedirect, "Redirect loop" unless redirect_limit > 0
+      @last_response = follow_redirect!(limit: redirect_limit, env_override: env_override)
+    end
+
+    def store_cookies(uri)
+      return unless cookies = @last_response.get_fields('set-cookie')
+      cookies.each do |cookie|
+        @cookie_jar.parse cookie, uri
+      end
+    end
+  end
+end

data/lib/rack_toolkit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RackToolkit
+  VERSION = '0.1.0'
+end

data/lib/rack_toolkit.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'rack_toolkit/version'
+require_relative 'rack_toolkit/server'

data/rack_toolkit.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('lib')
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative 'lib/rack_toolkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack_toolkit'
+  spec.version       = RackToolkit::VERSION
+  spec.authors       = ['Rodrigo Rosenfeld Rosas']
+  spec.email         = ['rr.rosas@gmail.com']
+
+  spec.summary       = %q{A dynamic Rack server and helper methods to help testing Rack apps.}
+  spec.description   =
+%q{This gem makes it easier to start a Puma server that will bind to a dynamic free port
+by default and provide helper methods like get and post, managing sessions automatically
+and using keep-alive to make the requests faster. Usually the server would be run when the
+test suite starts.}
+  spec.homepage      = 'https://github.com/rosenfeld/rack_toolkit'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'puma', '~> 3.5'
+  spec.add_runtime_dependency 'http-cookie', '~> 1.0.2'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: rack_toolkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodrigo Rosenfeld Rosas
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  name: puma
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  name: http-cookie
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+description: |-
+  This gem makes it easier to start a Puma server that will bind to a dynamic free port
+  by default and provide helper methods like get and post, managing sessions automatically
+  and using keep-alive to make the requests faster. Usually the server would be run when the
+  test suite starts.
+email:
+- rr.rosas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rspec-fast"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack_toolkit.rb
+- lib/rack_toolkit/response_enhancer.rb
+- lib/rack_toolkit/server.rb
+- lib/rack_toolkit/version.rb
+- rack_toolkit.gemspec
+homepage: https://github.com/rosenfeld/rack_toolkit
+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.6.4
+signing_key:
+specification_version: 4
+summary: A dynamic Rack server and helper methods to help testing Rack apps.
+test_files: []