request_interceptor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a7e5effe2f0a9cd010dab836e26e21a3fa27926
+  data.tar.gz: 8bfddbba2c833abc8f795a78d313d5359ce4bba6
+SHA512:
+  metadata.gz: 2837e6e5bb2a5bce1d3aa80beec3048af324153244bd0fe95bc2191398a98c610e47fa38c37a637b7b1339d196e9fa7fb9ddc442fb789f55794bd845104c871e
+  data.tar.gz: a4bf84df00666296fc4ed166c2d9475ff6fa5052198297ed3b501088898713307f94773577931f9aa3180f298c0c34c937c164e05fa104e4dc93f7782ec06bb9

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Konstantin Tennhard
+
+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,77 @@
+# Request Interceptor
+
+Request interceptor is a library for simulating foreign APIs using Sinatra applcations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'request_interceptor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install request_interceptor
+
+## Usage
+
+Once installed, request interceptors can be defined as follows:
+
+```ruby
+app = RequestInterceptor.define do
+  get "/" do
+    content_type "text/plain"
+    "Hello World"
+  end
+end
+```
+
+By default, request interceptors are `Sinatra` applications, but any `Rack` compatible application works.
+To intercept HTTP requests, the code performing the request must be wrapped in an `RequestInterceptor#run` block:
+
+```ruby
+interceptor = RequestInterceptor.new(/.*example\.com$/ => app)
+interceptor.run do
+  Net::HTTP.get(URI("http://example.com/")) # => "Hello World"
+end
+```
+
+`RequestInterceptor` instances are initialized with hash mapping hostname patterns to applications.
+The patterns are later matched against the hostname of the URI associated with a particular request.
+In case of a match, the corresponding application is used to serve the request.
+Otherwise, a real HTTP request is performed.
+
+For the sake of convenience, the code above can be shortened using `RequestInterceptor.run`:
+
+```ruby
+log = RequestInterceptor.run(/.*example\.com$/ => app) do
+  Net::HTTP.get(URI("http://example.com/")) # => "Hello World"
+end
+```
+
+In both cases, the result is a transaction log.
+Each entry in the transaction log is a `RequestInterceptor::Transaction`.
+A transaction is simply request/response pair.
+The request can be obtained using the equally named `#request` method.
+The `#response` method returns the response that corresponds to the particular request.
+The code above would result in a transaction log with one entry:
+
+```ruby
+log.count # => 1
+log.first.request # => Rack::MockRequest
+log.first.response # => Rack::MockResponse
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at (t6d/request_interceptor)[https://github.com/t6d/request_interceptor].
+
+## 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,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "request_interceptor"
+
+require "pry"
+Pry.start
+

data/bin/setup

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

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.2.2

data/lib/request_interceptor/application.rb

@@ -0,0 +1,8 @@
+require "sinatra/base"
+
+class RequestInterceptor::Application < Sinatra::Base
+  configure do
+    disable :show_exceptions
+    enable :raise_errors
+  end
+end

data/lib/request_interceptor/status.rb

@@ -0,0 +1,34 @@
+require 'rack/utils'
+
+class RequestInterceptor::Status < Struct.new(:value, :description)
+  STATUSES = Rack::Utils::HTTP_STATUS_CODES
+
+  def self.from_code(code, description = nil)
+    description = STATUSES.fetch(code.to_i, "Unknown") if description.nil?
+    new(code.to_s, description)
+  end
+
+  def response_class
+    self.class.response_class(value)
+  end
+
+  def self.response_class(code)
+    @response_classes ||=
+      begin
+        wrapped_classes = Hash.new {  Net::HTTPUnknownResponse }
+        Net::HTTPResponse::CODE_TO_OBJ.inject(wrapped_classes) do |classes, (code, original_class)|
+          new_class = Class.new(original_class) do
+            attr_accessor :body
+          end
+
+          new_class.define_singleton_method(:name) { original_class.name }
+          new_class.define_singleton_method(:to_s) { original_class.name }
+
+          classes[code] = new_class
+          classes
+        end
+      end
+
+    @response_classes[code]
+  end
+end

data/lib/request_interceptor/version.rb

@@ -0,0 +1,3 @@
+class RequestInterceptor
+  VERSION = "0.1.0"
+end

data/lib/request_interceptor.rb

@@ -0,0 +1,184 @@
+require "request_interceptor/version"
+
+require "net/http"
+require "rack/mock"
+
+class RequestInterceptor
+  class Transaction < Struct.new(:request, :reponse); end
+
+  GET = "GET".freeze
+  POST = "POST".freeze
+  PUT = "PUT".freeze
+  DELETE = "DELETE".freeze
+
+  def self.template=(template)
+    @template =
+      case template
+      when Proc
+        Class.new(Application, &template)
+      else
+        template
+      end
+  end
+
+  def self.template
+    @template || Application
+  end
+
+  def self.define(super_class = nil, &application_definition)
+    Class.new(super_class || template, &application_definition)
+  end
+
+  def self.run(*args, &simulation)
+    new(*args).run(&simulation)
+  end
+
+  attr_reader :applications
+  attr_reader :transactions
+
+  def initialize(applications)
+    @applications = {}
+    @transactions = []
+
+    applications.each { |pattern, application| self[pattern] = application }
+  end
+
+  def [](pattern)
+    @applications[pattern]
+  end
+
+  def []=(pattern, application)
+    @applications[pattern] = application
+  end
+
+  def run(&simulation)
+    clear_transaction_log
+    cache_original_net_http_methods
+    override_net_http_methods
+    simulation.call
+    transactions
+  ensure
+    restore_net_http_methods
+  end
+
+  def request(http_context, request, body, &block)
+    # use Net::HTTP set_body_internal to
+    # keep the same behaviour as Net::HTTP
+    request.set_body_internal(body)
+    response = nil
+
+    if mock_request = mock_request_for_application(http_context, request)
+      mock_response = dispatch_mock_request(request, mock_request)
+
+      # create response
+      status = RequestInterceptor::Status.from_code(mock_response.status)
+      response = status.response_class.new("1.1", status.value, status.description)
+
+      # copy header to response
+      mock_response.original_headers.each do |k, v|
+        response.add_field(k, v)
+      end
+
+      # copy uri
+      response.uri = request.uri
+
+      # copy body to response
+      response.body = mock_response.body
+
+      # replace Net::HTTP::Response#read_body
+      def response.read_body(_, &block)
+        block.call(@body) unless block.nil?
+        @body
+      end
+
+      # yield the response because Net::HTTP#request does
+      block.call(response) unless block.nil?
+    else
+      response = real_request(http_context, request, body, &block)
+    end
+
+    log_transaction(request, response)
+
+    response
+  end
+
+
+  private
+
+  def clear_transaction_log
+    @transactions = []
+  end
+
+  def cache_original_net_http_methods
+    @original_request_method = Net::HTTP.instance_method(:request)
+    @original_start_method = Net::HTTP.instance_method(:start)
+    @original_finish_method = Net::HTTP.instance_method(:finish)
+  end
+
+  def override_net_http_methods
+    runner = self
+
+    Net::HTTP.class_eval do
+      def start
+        @started = true
+        return yield(self) if block_given?
+        self
+      end
+
+      def finish
+        @started = false
+        nil
+      end
+
+      define_method(:request) do |request, body = nil, &block|
+        runner.request(self, request, body, &block)
+      end
+    end
+  end
+
+  def restore_net_http_methods(instance = nil)
+    if instance.nil?
+      Net::HTTP.send(:define_method, :request, @original_request_method)
+      Net::HTTP.send(:define_method, :start, @original_start_method)
+      Net::HTTP.send(:define_method, :finish, @original_finish_method)
+    else
+      instance.define_singleton_method(:request, @original_request_method)
+      instance.define_singleton_method(:start, @original_start_method)
+      instance.define_singleton_method(:finish, @original_finish_method)
+    end
+  end
+
+  def mock_request_for_application(http_context, request)
+    _, application = applications.find { |pattern, _| pattern === http_context.address }
+    Rack::MockRequest.new(application) if application
+  end
+
+  def dispatch_mock_request(request, mock_request)
+    rack_env = request.to_hash
+
+    case request.method
+    when GET
+      mock_request.get(request.path, rack_env)
+    when POST
+      mock_request.post(request.path, rack_env.merge(input: request.body))
+    when PUT
+      mock_request.put(request.path, rack_env.merge(input: request.body))
+    when DELETE
+      mock_request.delete(request.path, rack_env)
+    else
+      raise NotImplementedError, "Simulating #{request.method} is not supported"
+    end
+  end
+
+  def real_request(http_context, request, body, &block)
+    restore_net_http_methods(http_context)
+    http_context.request(request, body, &block)
+  end
+
+  def log_transaction(request, response)
+    transactions << RequestInterceptor::Transaction.new(request, response)
+  end
+end
+
+require "request_interceptor/application"
+require "request_interceptor/status"

data/request_interceptor.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'request_interceptor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "request_interceptor"
+  spec.version       = RequestInterceptor::VERSION
+  spec.authors       = ["Konstantin Tennhard", "Kevin Hughes"]
+  spec.email         = ["me@t6d.de", "kevinhughes27@gmail.com"]
+
+  spec.summary       = %q{Sinatra based foreign API simulation}
+  spec.homepage      = "http://github.com/t6d/request_interceptor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "sinatra"
+  spec.add_runtime_dependency "rack"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: request_interceptor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Konstantin Tennhard
+- Kevin Hughes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: rack
+  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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '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: 
+email:
+- me@t6d.de
+- kevinhughes27@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/request_interceptor.rb
+- lib/request_interceptor/application.rb
+- lib/request_interceptor/status.rb
+- lib/request_interceptor/version.rb
+- request_interceptor.gemspec
+homepage: http://github.com/t6d/request_interceptor
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Sinatra based foreign API simulation
+test_files: []
+has_rdoc: