rubroxy 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dacda13e6588517e47fe078c64f2c686386b29b1
+  data.tar.gz: 1846c163cefa0eb6abb3d223c99f62302abea16d
+SHA512:
+  metadata.gz: 73436602f6f7416e4fba7052fc32f636444cba7f1605ad7a95592e52e140832fec7cdd36e7691319ab9b672695eaf28bdbf75cbd69ebd30be2396f890c1718c2
+  data.tar.gz: 46013cc3ed1d2a60fb8e7da52cac4fe64518851c5c7847c2510b3efe07ada231e850753d39e18caa638484fdffb44ddda365bd03f35df8d5c369a1737f249772

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2016 ITV PLC, licensed under the ITV Open Source Software Licence, Version 1.0 (the “Licence"). You may not use any of the files in this repository except in compliance with the Licence”.
+
+You may not use this file except in compliance with the Licence. You may obtain a copy of the Licence at http://itv.com/itv-oss-licence-v1.0.
+
+Unless required by applicable law or as otherwise agreed in writing, software distributed under the Licence is distributed on an “as is” basis, without warranties or conditions of any kind, either express or implied, including without limitation,
+any warranties or conditions as to title, non-infringement, merchantability or fitness for a particular purpose.
+Please see the Licence for the specific language governing permissions and limitations under the Licence.

data/README.md

@@ -0,0 +1,69 @@
+# Rubroxy
+
+A simple ruby proxy wrapped around WEBrick that can be integrated into any ruby script or test. The goal was to make something that solved some of my problems at work without needing too much configuration or use of many files.
+
+This can also be used as part of tests without any external scripts or dependencies beyond ruby.
+
+## Installation
+
+`gem install rubroxy`
+
+## Usage
+
+```
+require 'rubroxy'
+
+proxy = Proxy.new('localhost', 8080, 0)
+proxy.start_server
+```
+
+To filter responses and edit if needed, do something like the following:
+
+```
+proxy = Proxy.new('localhost', 8080, 0)
+
+# Creates a proc object with the logic provided in the code block
+handler = proc do |req, res|
+  res.body = 'This has been proxied!' if res['content-type'] = 'text/html'
+end
+
+proxy.add_rules(handler)
+proxy.start_server
+```
+
+You can also filter by `host`, so if you want to alter a response from a test environment as an example:
+
+```
+handler = proc do |req, res|
+  res.body = 'This has been altered' if req.host == 'something.itv.com'
+end
+```
+
+Combining this with data can give you a pretty powerful proxy ruleset! We can also alter other aspects of the request, including headers:
+
+```
+handler = proc do |req, res|
+  req['auth'] = 'auth_token' if req.host = 'www.google.com'
+end
+```
+
+The above will add the designated header to any request going to that URL.
+
+## Development
+
+### Contribution
+
+If you think you can contribute to the project, whether it's through development or testing or when there's a bug to be fixed - feel free to clone the repo and create an issue so that I'm aware. Once it's complete and tested, create a Pull Request so that it can be merged in.
+
+### Tests
+
+We're using Rspec to build the tests for Rubroxy. If you want to run the current test suite just type `rspec` when in the rubroxy repo directory after cloning. All new features must come with relevant tests.
+
+### Todos
+
+Currently, this does what I need it to do - but it would be great to expand it and generally make it better :)
+
+- An easier way to build rulesets for the proxy before initialisation. Currently you'd have to parse JSON etc yourself but I'm looking at integrating it as part of the gem.
+- Further logging, including potential reports or other ways to analyse proxy sessions
+- The ability to query the proxy for URLS that have been hit through the connection.
+- Ability to set new rules during runtime. Ideally done without the need for a restart of the server but I realise this might be impossible.

data/lib/rubroxy/proxy_core.rb

@@ -0,0 +1,40 @@
+# Main class of the proxy object, includes control methods
+class Proxy
+  attr_accessor :server
+
+  # Creates the proxy object, defines logging levels and host:port
+  #
+  # @param host [String] Hostname of the proxy (eg: localhost, 127.0.0.1 etc)
+  # @param port [Integer] The expected port number (eg: 8080)
+  # @param logger_level [Integer] Sets the detail of the logger included.
+  # @return [Proxy]
+  def initialize(host, port, logger_level = 1)
+    logger = Logger.new($stderr)
+    logger.level = logger_level
+    access_log = [] if logger.level == 3
+    @server = WEBrick::HTTPProxyServer.new(Port: port,
+                                           Logger: logger,
+                                           AccessLog: access_log,
+                                           BindAddress: host)
+  end
+
+  # Adds a Proc object to the Proxy server
+  #
+  # @param handler [Proc] The proc object to be passed into the server config
+  def add_rules(handler)
+    @server.config[:ProxyContentHandler] = handler
+  end
+
+  # Starts the server process, including traps for process termination
+  def start_server
+    Signal.trap('INT') { stop_server }
+    Signal.trap('TERM') { stop_server }
+
+    @server.start
+  end
+
+  # Shuts down the proxy server
+  def stop_server
+    @server.shutdown
+  end
+end

data/lib/rubroxy/version.rb

@@ -0,0 +1,4 @@
+#:nodoc:
+module Rubroxy
+  VERSION = '0.1.1'
+end

data/lib/rubroxy.rb

@@ -0,0 +1,4 @@
+require 'webrick'
+require 'webrick/httpproxy'
+require 'logger'
+require 'rubroxy/proxy_core.rb'

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rubroxy
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- James Prescott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.8
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: A simple ruby built proxy
+email: james.prescott@itv.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/rubroxy.rb
+- lib/rubroxy/proxy_core.rb
+- lib/rubroxy/version.rb
+homepage: https://github.com/ITV/rubroxy
+licenses:
+- GPL-3.0
+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.8
+signing_key: 
+specification_version: 4
+summary: Rubroxy
+test_files: []
+has_rdoc: