rack-translating_proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 794652ff10fbf63964576fba30599ee1d5c34f67
+  data.tar.gz: fae17b5582bba5f993ad85bcd29d5212b45d5fde
+SHA512:
+  metadata.gz: 2d9db4752f01be1054c5f95d0e42e1f4b99fa999dc271e7887121f9de0f58562a6a08f3c91d69231475d6386ac20f016ad248a0a6e042b4999dfbdd000eaa78c
+  data.tar.gz: 3629f9946d3e9739322fa13a04d9b61f5fa46fa1dc52a12fb651d6f9ddb079b1e5b6f7bda318d9741fff016af0644028494ef341a7c67fa2672c64c86b736e8d

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/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rspec'
+gem 'rspec-its'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mike Nicholaides
+
+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,30 @@
+# Rack::TranslatingProxy
+
+A Proxy that `gsub`s the contents of the requests and responses in order to make a mostly transparent proxy.
+Its purpose is to aid in development and testing of integration with external services, especially when the browser has to interact with those services directly.
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-translating_proxy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-translating_proxy
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/rack-translating_proxy/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 new Pull Request

data/Rakefile

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

data/lib/rack/translating_proxy.rb

@@ -0,0 +1,100 @@
+require 'rack/proxy'
+
+module Rack
+  class TranslatingProxy < Rack::Proxy
+    def rewrite_env(env)
+      rewrite_request_url          env
+      rewrite_request_body         env
+      rewrite_request_query_string env
+      rewrite_request_path         env
+
+      env
+    end
+
+    def rewrite_request_url(env)
+      env['HTTP_HOST']       = _target_host.host
+      env['SERVER_PORT']     = _target_host.port
+      env['rack.url_scheme'] = _target_host.scheme
+    end
+
+    def rewrite_request_body(env)
+      rewritten_input = rewrite_request_string(io(env['rack.input']).read)
+
+      env['rack.input']     = io(rewritten_input)
+      env['CONTENT_LENGTH'] = rewritten_input.size
+    end
+
+    def rewrite_request_string(str)
+      rewrite_string(str, request_mapping, URI.method(:encode_www_form_component))
+    end
+
+    def rewrite_request_query_string(env)
+      env['QUERY_STRING'] = rewrite_request_string(env['QUERY_STRING'])
+    end
+
+    def rewrite_request_path(env)
+      env['REQUEST_URI']  = rewrite_request_string(env['REQUEST_URI'])
+    end
+
+    def rewrite_string(string, mapping, transform = proc { |x| x })
+      mapping = mapping.map do |source, target|
+        [transform[source], transform[target]]
+      end
+
+      mapping.each do |source, target|
+        string = string.gsub(source, target)
+      end
+
+      string
+    end
+
+    def io(stringy_thing)
+      if stringy_thing.respond_to?(:read)
+        stringy_thing
+      else
+        StringIO.new(stringy_thing)
+      end
+    end
+
+    def rewrite_response(triplet)
+      status, headers, body = triplet
+      rewrite_response_location headers
+      remove_interfering_response_headers headers
+      [status, headers, body]
+    end
+
+    def rewrite_response_location(headers)
+      if headers['location']
+        headers['location'] = headers['location'].map do |location|
+          rewrite_string(location, _response_mapping)
+        end
+      end
+    end
+
+    def remove_interfering_response_headers(headers)
+      headers.reject! do |key, _|
+        %w[status connection transfer-encoding].include?(key)
+      end
+    end
+
+    def request_mapping
+      fail 'Not implemented'
+    end
+
+    def _request_mappping
+      @_request_mappping ||= request_mappping
+    end
+
+    def _response_mapping
+      @_response_mapping ||= request_mapping.invert
+    end
+
+    def _target_host
+      @_target_host ||= URI(target_host)
+    end
+
+    def target_host
+      fail 'Not implemented'
+    end
+  end
+end

data/rack-translating_proxy.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-translating_proxy"
+  spec.version       = '0.1.0'
+  spec.authors       = ["Mike Nicholaides"]
+  spec.email         = ["mike.nicholaides@gmail.com"]
+  spec.summary       = 'Proxy that translates strings'
+  spec.description   = 'Proxy that translates strings'
+  spec.homepage      = ""
+  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_dependency 'rack-proxy', '~> 0.5'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end
+
+require 'rspec/its'
+
+require 'rack/translating_proxy'

data/spec/translating_proxy_spec.rb

@@ -0,0 +1,90 @@
+class ExampleTranslatingProxy < Rack::TranslatingProxy
+  def target_host
+    'https://target-host.url'
+  end
+
+  def request_mapping
+    {
+      'http://proxy.url:1234' => 'https://target.url:4321',
+      'http://proxy.url:5678' => 'https://target.url:8765',
+      'a word'                => 'another word'
+    }
+  end
+end
+
+describe ExampleTranslatingProxy do
+  let(:app) { described_class.new }
+
+  describe "#rewrite_env" do
+    subject { app.rewrite_env(Hash.new { '' }.merge(env)) }
+    let(:env) { {} }
+
+    describe "rewriting the uri" do
+      its(['HTTP_HOST'])       { is_expected.to eq 'target-host.url' }
+      its(['SERVER_PORT'])     { is_expected.to eq 443 }
+      its(['rack.url_scheme']) { is_expected.to eq 'https' }
+    end
+
+    describe "rewriting the path" do
+      let(:env) { { 'REQUEST_URI' => '/path/with/a+word' } }
+      its(['REQUEST_URI']) { is_expected.to eq '/path/with/another+word' }
+    end
+
+    describe "rewriting the query string" do
+      let(:env) { { 'QUERY_STRING' => 'a+word&something-else' } }
+      its(['QUERY_STRING']) { is_expected.to eq 'another+word&something-else' }
+    end
+
+    describe "rewriting the body" do
+      context 'when it is a string' do
+        let(:env) { { 'rack.input' => 'my+string+with+a+word' } }
+        specify do
+          expect(subject['rack.input'].read).to eq 'my+string+with+another+word'
+        end
+
+        its(['CONTENT_LENGTH']) { is_expected.to eq 27 }
+      end
+
+      context 'when it is a StringIO' do
+        let(:env) { { 'rack.input' => StringIO.new('my+string+with+a+word') } }
+        specify do
+          expect(subject['rack.input'].read).to eq 'my+string+with+another+word'
+        end
+
+        its(['CONTENT_LENGTH']) { is_expected.to eq 27 }
+      end
+    end
+  end
+
+  describe "#rewrite_response" do
+    subject { app.rewrite_response(triplet) }
+
+    let(:triplet) { [given_status, given_headers, given_body] }
+    let(:given_status)  { double }
+    let(:given_body)    { double }
+    let(:given_headers) do
+      {
+        'location' => %w(
+          https://target.url:4321/path
+          https://target.url:8765/path
+        ),
+
+        'status'            => ["302 Found"],
+        'connection'        => ['close'],
+        'transfer-encoding' => ["chunked"]
+      }
+    end
+
+    let(:rewritten_status)  { subject[0] }
+    let(:rewritten_headers) { subject[1] }
+    let(:rewritten_body)    { subject[2] }
+
+    specify { expect(rewritten_body).to eq given_body }
+    specify { expect(rewritten_status).to eq given_status }
+
+    specify do
+      expect(rewritten_headers).to eq \
+        'location' => %w(http://proxy.url:1234/path http://proxy.url:5678/path)
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rack-translating_proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Nicholaides
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Proxy that translates strings
+email:
+- mike.nicholaides@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/translating_proxy.rb
+- rack-translating_proxy.gemspec
+- spec/spec_helper.rb
+- spec/translating_proxy_spec.rb
+homepage: ''
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Proxy that translates strings
+test_files:
+- spec/spec_helper.rb
+- spec/translating_proxy_spec.rb