proxy-server 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+.idea
+.bundle
+coverage
+pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    proxy-server (0.0.1)
+      httpclient
+      json (>= 1.4.6)
+      sinatra (>= 1.2.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    httpclient (2.2.1)
+    json (1.6.1)
+    multi_json (1.0.3)
+    rack (1.3.4)
+    rack-protection (1.1.4)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sinatra (1.3.1)
+      rack (>= 1.3.4, ~> 1.3)
+      rack-protection (>= 1.1.2, ~> 1.1)
+      tilt (>= 1.3.3, ~> 1.3)
+    tilt (1.3.3)
+    webmock (1.7.6)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  proxy-server!
+  rack-test (>= 0.5.7)
+  rake (>= 0.9.2)
+  rspec (>= 2.6.0)
+  simplecov (>= 0.4.2)
+  webmock

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+
+task :coverage do
+  require 'simplecov'
+  require 'rspec/core'
+
+  SimpleCov.start do
+    add_group "lib", "lib"
+  end
+  SimpleCov.start
+  RSpec::Core::Runner.run %w[spec]
+end
+
+
+require 'rake/clean'
+CLEAN.include %w(**/*.{log,pyc,rbc,tgz} doc)

data/examples/proxy_in_process.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'proxy-server'
+require 'rest_client' # you will need to install this via gem install rest-client / bundler etc
+require 'json'
+
+ENV.clear
+
+Thread.new do
+ ProxyManager.run! :port => 4983
+end
+
+until_proxy_is_running = 2
+sleep until_proxy_is_running # need to implement the ability to wait for the proxy to be running
+
+proxy = JSON.parse(RestClient.post 'http://localhost:4983/proxies', {:proxy => 'http://www-cache.reith.bbc.co.uk:80'})
+
+sleep until_proxy_is_running
+
+RestClient.post "http://localhost:4983/proxies/#{proxy['port']}/requests", {:track => 'google.com'}
+
+client = HTTPClient.new :proxy => "http://localhost:#{proxy['port']}"
+client.get 'http://www.google.com'
+client.get 'http://github.com'
+
+p JSON.parse(HTTPClient.get("http://localhost:4983/proxies/#{proxy['port']}/requests").body)
+
+
+

data/lib/proxy/proxy_manager.rb

@@ -0,0 +1,70 @@
+require_relative './proxy_server'
+require 'sinatra/base'
+require 'json'
+
+class ProxyManager < Sinatra::Base
+  START_PORT = 5000
+
+  attr_reader :running_proxy_servers, :assigned_proxy_ports
+  disable :show_exceptions
+
+  def initialize()
+    @running_proxy_servers = {}
+    @assigned_proxy_ports = []
+    super
+  end
+
+  get '/proxies' do
+    assigned_proxy_ports.to_json
+  end
+
+  post '/proxies' do
+    new_proxy_port = assigned_proxy_ports.max
+    new_proxy_port += 1 unless new_proxy_port.nil?
+    new_proxy_port ||= START_PORT
+
+    assigned_proxy_ports << new_proxy_port
+
+    options = {
+        :port => new_proxy_port
+    }
+
+    options[:proxy] = params[:proxy] if params[:proxy]
+    start_proxy(options)
+
+    {:port => new_proxy_port}.to_json
+  end
+
+  delete '/proxies' do
+    assigned_proxy_ports.clear
+  end
+
+  post '/proxies/:port/requests' do |port|
+    proxy_server = get_proxy(port.to_i)
+    proxy_server.track_request(params[:track])
+  end
+
+  get '/proxies/:port/requests' do |port|
+    proxy_server = get_proxy(port.to_i)
+    proxy_server.requests.to_json
+  end
+
+  post '/proxies/:port/requests/substitute' do |port|
+    proxy_server = get_proxy(port.to_i)
+    options = {}
+    options[:body] = params[:body] if params[:body]
+    options[:url] = params[:url] if params[:url]
+    proxy_server.substitute_request(params[:pattern], options)
+  end
+
+  def get_proxy(port)
+    running_proxy_servers[port]
+  end
+
+  def start_proxy(options)
+    proxy_server = ProxyServer.new(options)
+    proxy_server.run
+    running_proxy_servers[options[:port]] = proxy_server
+  end
+end
+

data/lib/proxy/proxy_server.rb

@@ -0,0 +1,104 @@
+require 'rack'
+require 'httpclient'
+
+class ProxyServer
+
+  attr_reader :upstream_proxy, :port
+  attr_reader :requests
+
+  DEFAULT_PORT = 8080
+
+  def initialize(options = {})
+    @upstream_proxy = options[:proxy]
+    @client = create_http_client
+
+    @port = options.fetch(:port, DEFAULT_PORT)
+
+    @substitute_requests = {}
+    @requests = []
+    @track_requests = []
+  end
+
+  def create_http_client
+    HTTPClient.new :proxy => @upstream_proxy
+  end
+
+  def run
+    Thread.new do
+      @handler = Rack::Handler::WEBrick
+
+      @handler.run self, :Port => self.port
+    end
+  end
+
+  def call(env)
+    log_request env
+
+    response = get_substitution(env)
+    return response unless response.nil?
+
+    method  = env['REQUEST_METHOD']
+    uri     = "http://#{env['HTTP_HOST']}#{env['PATH_INFO']}"
+    params  = get_params(env['QUERY_STRING'])
+    body    = get_request_body(env)
+    headers = get_request_headers(env)
+    response = @client.request(method, uri, params, body, headers)
+
+    [ response.status, response.headers, [response.body] ]
+  end
+
+  def get_substitution(env)
+    uri = env['REQUEST_URI'] || "http://#{env['SERVER_NAME']}#{env['PATH_INFO']}#{env['QUERY_STRING'] ? '?'+env['QUERY_STRING'] : ''}"
+    @substitute_requests.each do |pattern, options|
+      if Regexp.new(pattern) =~ uri
+        return get_substituted_response(options)
+      end
+    end
+    nil
+  end
+
+  def get_substituted_response(options)
+    if options[:body]
+      [ 200, {}, [options[:body]] ]
+    elsif options[:url]
+      response = @client.get(options[:url])
+      [ response.status, response.headers, [response.body] ]
+    end
+  end
+
+  def substitute_request(pattern, options)
+    @substitute_requests[pattern] = options
+  end
+
+  def track_request(pattern)
+    @track_requests << pattern
+  end
+
+  def get_params(query_string)
+    query_string.split('&').inject({}) do |hsh, i|
+      kv = i.split('='); hsh[kv[0]] = kv[1]; hsh
+    end unless query_string.nil? or query_string.length == 0
+  end
+
+  def log_request(env)
+
+    url = env['REQUEST_URI'] || "http://#{env['SERVER_NAME']}#{env['PATH_INFO']}#{env['QUERY_STRING'].length>0 ? '?'+env['QUERY_STRING'] : ''}"
+    @track_requests.each do |pattern|
+      @requests << url if Regexp.new(pattern) =~ url
+    end
+  end
+
+  private
+  def get_request_body(env)
+    body = ''
+    env['rack.input'].each_line {|string| body << string }
+    body
+  end
+
+  def get_request_headers(env)
+    headers = {}
+    env.each {|k,v| if k =~ /HTTP_(\w+)/ then headers[$1] = v end }
+    headers
+  end
+end
+

data/lib/proxy-server.rb

@@ -0,0 +1,2 @@
+require_relative './proxy/proxy_server'
+require_relative './proxy/proxy_manager'

data/proxy-server.gemspec

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'proxy-server'
+  s.version = '0.0.1'
+  s.authors = ["Derek Ekins"]
+  s.description = 'Proxy server'
+  s.summary = "proxy-server-#{s.version}"
+  s.email = 'derek@spathi.com'
+  s.homepage = "http://github.com/dereke/proxy-server"
+
+  s.platform = Gem::Platform::RUBY
+
+  s.add_dependency 'json', '>= 1.4.6'
+  s.add_dependency 'sinatra', '>= 1.2.6'
+  s.add_dependency 'httpclient'
+
+  s.add_development_dependency 'rake', '>= 0.9.2'
+  s.add_development_dependency 'rspec', '>= 2.6.0'
+  s.add_development_dependency 'simplecov', '>= 0.4.2'
+  s.add_development_dependency 'webmock'
+
+
+  s.add_development_dependency 'rack-test', '>= 0.5.7'
+
+  s.rubygems_version = ">= 1.6.1"
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {spec}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_path = "lib"
+end

data/spec/proxy/proxy_manager_spec.rb

@@ -0,0 +1,77 @@
+require_relative '../spec_helper'
+require_relative '../../lib/proxy/proxy_manager'
+require 'rack/test'
+require 'webmock/rspec'
+
+describe ProxyManager do
+  include Rack::Test::Methods
+
+  before do
+    @proxy_server = Object.new
+    ProxyManager.any_instance.stub(:start_proxy).with(anything()).and_return(@proxy_server)
+    ProxyManager.any_instance.stub(:get_proxy).with(anything()).and_return(@proxy_server)
+  end
+
+  let(:app) { ProxyManager.new }
+
+  it "should create a new proxy when I ask for one" do
+    response = post '/proxies'
+    proxy = JSON.parse(response.body)
+    proxy.should == {'port' => ProxyManager::START_PORT}
+  end
+
+  it "should create a new proxy with an upstream proxy when asked to" do
+    ProxyManager.any_instance.should_receive(:start_proxy).with(hash_including(:proxy => 'http://my_proxy:80'))
+    response = post '/proxies', {:proxy => 'http://my_proxy:80'}
+  end
+
+  it "should tell me about all the proxies that have been created" do
+    post '/proxies'
+    response = get '/proxies'
+    JSON.parse(response.body).should == [ProxyManager::START_PORT]
+  end
+
+  it "should remove all proxies when asked" do
+    post '/proxies'
+    delete '/proxies'
+
+    response = get '/proxies'
+    JSON.parse(response.body).should == []
+  end
+
+  it "should assign new proxy ports when more than one is asked for" do
+    first_expected_proxy = ProxyManager::START_PORT
+    second_expected_proxy = ProxyManager::START_PORT + 1
+
+    first_response = post '/proxies'
+    second_response = post '/proxies'
+
+    JSON.parse(first_response.body)['port'].should == first_expected_proxy
+    JSON.parse(second_response.body)['port'].should == second_expected_proxy
+  end
+
+  it "ads a given url to a list of them to track" do
+    track_url = 'public/.*.js'
+
+    @proxy_server.should_receive(:track_request).with(track_url)
+    post "/proxies/1111/requests", {:track => track_url}
+  end
+
+  it "ads a given url to a list of them to track" do
+    @proxy_server.stub!(:requests).and_return(['request 1', 'request 2'])
+    response = get "/proxies/1111/requests"
+    requests = JSON.parse(response.body)
+    requests.should include('request 1')
+    requests.should include('request 2')
+  end
+
+  it "can substitute a request with another body" do
+    @proxy_server.should_receive(:substitute_request).with('*.js', :body => 'alert(1);')
+    post "/proxies/1111/requests/substitute", {:pattern => '*.js', :body => 'alert(1);'}
+  end
+
+  it "can substitute a request with another url" do
+    @proxy_server.should_receive(:substitute_request).with('*.js', :url => 'http://example.com/test.js')
+    post "/proxies/1111/requests/substitute", {:pattern => '*.js', :url => 'http://example.com/test.js'}
+  end
+end

data/spec/proxy/proxy_server_spec.rb

@@ -0,0 +1,81 @@
+require_relative '../spec_helper'
+require_relative '../../lib/proxy/proxy_server'
+require 'rack/test'
+require 'webmock/rspec'
+
+describe ProxyServer do
+  include Rack::Test::Methods
+  before do
+    ENV.clear
+  end
+
+  let(:app) { ProxyServer.new }
+
+  it "can be configured with an upstream proxy" do
+    proxy_uri = 'http://test-proxy:80'
+    proxy = ProxyServer.new :proxy => proxy_uri
+    proxy.upstream_proxy.should == proxy_uri
+  end
+
+  it "can be configured to run on a specific port" do
+    proxy_port = 8080
+    proxy = ProxyServer.new :port => proxy_port
+    proxy.port.should == proxy_port
+  end
+
+  it "default the port when none is specified" do
+    proxy = ProxyServer.new
+    proxy.port.should == ProxyServer::DEFAULT_PORT
+  end
+
+  it "should allow requests" do
+    stub_request(:get, "http://www.example.com")
+
+    response = get 'http://www.example.com'
+    response.status.should == 200
+  end
+
+  it "should allow requests with query strings" do
+    stub_request(:get, "http://www.example.com?para=value")
+
+    response = get "http://www.example.com?para=value"
+    response.status.should == 200
+  end
+
+  it "can substitute the response of a request with a body of text" do
+    proxy = ProxyServer.new
+    expected_response = "this is not what you are looking for"
+    proxy.substitute_request '.*com', :body => expected_response
+
+    browser = Rack::Test::Session.new(Rack::MockSession.new(proxy))
+    response = browser.get 'http://www.google.com'
+    response.body.should == expected_response
+  end
+
+  it "can substitute the response of a request with another url to call" do
+    proxy = ProxyServer.new
+    substitute_url = "http://example.com"
+    expected_response_body = "substitute body"
+    stub_request(:get, substitute_url).to_return(:body => expected_response_body)
+    proxy.substitute_request '.*com', :url => substitute_url
+
+    browser = Rack::Test::Session.new(Rack::MockSession.new(proxy))
+    response = browser.get 'http://www.google.com'
+    response.body.should == expected_response_body
+  end
+
+  it "tracks a url that matches the pattern" do
+    proxy = ProxyServer.new
+    expected_response = "this is not what you are looking for"
+    proxy.track_request '.*com'
+
+    stub_request(:get, 'http://www.google.com/')
+    stub_request(:get, 'http://www.google.co.uk/')
+
+    browser = Rack::Test::Session.new(Rack::MockSession.new(proxy))
+    browser.get 'http://www.google.com/'
+    browser.get 'http://www.google.co.uk/'
+
+    proxy.requests.should include('http://www.google.com/')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'rspec'
+ENV['RACK_ENV'] = 'test'
+
+class String
+  alias each each_line
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: proxy-server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Derek Ekins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &12655120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *12655120
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &12654340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *12654340
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: &12653840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12653840
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &12653160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *12653160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &12652520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *12652520
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &12651940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: *12651940
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &12651440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12651440
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &12650780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.7
+  type: :development
+  prerelease: false
+  version_requirements: *12650780
+description: Proxy server
+email: derek@spathi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- examples/proxy_in_process.rb
+- lib/proxy-server.rb
+- lib/proxy/proxy_manager.rb
+- lib/proxy/proxy_server.rb
+- proxy-server.gemspec
+- spec/proxy/proxy_manager_spec.rb
+- spec/proxy/proxy_server_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dereke/proxy-server
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: proxy-server-0.0.1
+test_files: []