clumsy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 201ddce02cc0dd4d4e17a09db9c58b3a4a0f92a2
+  data.tar.gz: 15056852659864a130bb0f98cd2dac2eaee951a4
+SHA512:
+  metadata.gz: 457c2b1bdf27bcc21628ee43817361df4966ab6dda40e7173270b72fc9ba32dd2f986c844111289f24447c4459ae1e95792ce564800c59957003b4fcc9540108
+  data.tar.gz: 7f0a0388e18988981d42680a348d10e9cafa175c22878fad8092f48b3eb3412757ba2ee3538bef521cdc9d95b69bc1b7d514ab75717a4c061f7de15b71d76509

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.0.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Darby Frey
+
+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,127 @@
+# Clumsy
+
+An awkward tool for testing proxies with ngrok.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clumsy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clumsy
+
+## Usage
+
+Please note: This project is very new and likely has bugs. Contributions are very welcome!
+
+Clumsy is a tool for testing proxies in an end-to-end fashion. The idea for this came about around a need to build tests for API gateway tools like Apigee or Amazon API Gateway. Because of the nature of these envronments, there isn't an easy way to test the implementation without deploying a server. Clumsy works by using a deployed *test* instance of a server and piping that output back to the testing machine using [ngrok](https://ngrok.com/). This allows the test to trigger a request and receive the output within the same process.
+
+**Prerequisites:**
+
+* A running ngrok tunnel
+* A running instance of your proxy, pointing to your [ngrok](https://ngrok.com/) tunnel
+* A ruby test environment (rspec, etc.)
+* A [clumsy test](#clumsy-test-file-structure) file to describe your test
+
+With all of that in place, you can setup a test like this:
+
+```ruby
+describe 'Some Context' do
+
+  it 'does what you expect' do
+
+    test_file = Clumsy::TestFile.new('path/to/test_file')
+
+    server = Clumsy::Server.new(test_file)
+    server.start!
+
+    runner = Clumsy::TestRunner.new(server, test_file)
+    runner.process
+
+    expect(server.did_receive_request('GET http://something.ngrok.com/foo/bar')).to be true
+
+  end
+
+end
+```
+
+
+
+## Clumsy Test File Structure
+
+```json
+{
+  "request_method":"GET",
+  "request_url":"REQUEST_URL",
+  "downstream": [
+    {
+      "request": {
+        "method":"GET",
+        "url":"DOWNSTREAM_REQUEST_URL_1"
+      },
+      "response": {
+        "payload": "JSON PAYLOAD"
+      }
+    },
+    {
+      "request": {
+        "method":"GET",
+        "url":"DOWNSTREAM_REQUEST_URL_2"
+      },
+      "response":{
+        "payload": "JSON PAYLOAD"
+      }
+    },
+    {
+      "request":{
+        "method":"GET",
+        "url":"DOWNSTREAM_REQUEST_URL_3"
+      },
+      "response":{
+        "payload": "JSON PAYLOAD"
+      }
+    },
+    {
+      "request":{
+        "method":"GET",
+        "url":"DOWNSTREAM_REQUEST_URL_4"
+      },
+      "response":{
+        "payload": "JSON PAYLOAD"
+      }
+    }
+  ],
+  "response":{
+    "status":200,
+    "headers":"",
+    "body":{
+      "payload": "FINAL JSON PAYLOAD"
+    }
+  }
+}
+```
+
+
+## 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 at https://github.com/darbyfrey/clumsy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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 "clumsy"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clumsy.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clumsy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clumsy"
+  spec.version       = Clumsy::VERSION
+  spec.authors       = ["Darby Frey"]
+  spec.email         = ["darbyfrey@gmail.com"]
+
+  spec.summary       = %q{A clumsy tool for end-to-end proxy testing}
+  spec.description   = %q{A clumsy tool for end-to-end proxy testing}
+  spec.homepage      = "https://github.com/darbyfrey/clumsy"
+  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_dependency 'rack'
+  spec.add_dependency 'http'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'pry'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/clumsy.rb

@@ -0,0 +1,14 @@
+require 'clumsy/request'
+require 'clumsy/response'
+require 'clumsy/server'
+require 'clumsy/test_file'
+require 'clumsy/test_runner'
+require 'clumsy/version'
+require 'http'
+require 'hashie'
+require 'openssl'
+require 'rack'
+require 'pry'
+
+module Clumsy
+end

data/lib/clumsy/request.rb

@@ -0,0 +1,14 @@
+module Clumsy
+  class Request
+    attr_reader :uri
+
+    def initialize(env)
+      @method = env["REQUEST_METHOD"]
+      @uri    = env["REQUEST_URI"]
+    end
+
+    def to_s
+      "#{@method} #{@uri}"
+    end
+  end
+end

data/lib/clumsy/response.rb

@@ -0,0 +1,16 @@
+module Clumsy
+  class Response
+
+    def initialize(request, test_file)
+      @request    = request
+      @test_file  = test_file
+    end
+
+    def send_response
+      response = @test_file.downstream.select{|x| x.request.url == @request.uri}.first.response
+
+      ['200', {'Content-Type' => 'application/json'}, [response.to_json]]
+    end
+
+  end
+end

data/lib/clumsy/server.rb

@@ -0,0 +1,32 @@
+module Clumsy
+  class Server
+    attr_reader :inbound_requests
+
+    def initialize(test_file)
+      @test_file                = test_file
+      @inbound_requests         = Array.new
+      @inbound_request_strings  = Array.new
+      @app                      = nil
+    end
+
+    def start!
+      app = Proc.new do |env|
+        request   = Clumsy::Request.new(env)
+        response  = Clumsy::Response.new(request, @test_file)
+        @inbound_requests << request
+        @inbound_request_strings << request.to_s
+
+        response.send_response
+      end
+
+      Thread.new do
+        server = Rack::Handler::WEBrick.run app
+      end
+    end
+
+    def did_receive_request(request_string)
+      @inbound_request_strings.include?(request_string)
+    end
+
+  end
+end

data/lib/clumsy/test_file.rb

@@ -0,0 +1,30 @@
+module Clumsy
+  class TestFile
+
+    def initialize(file)
+      begin
+        @file = File.read(file)
+        @data = Hashie::Mash.new JSON.parse(@file)
+      rescue Errno::ENOENT
+        raise 'File Not Found'
+      end
+    end
+
+    def request_method
+      @data.request_method
+    end
+
+    def request_url
+      @data.request_url
+    end
+
+    def downstream
+      @data.downstream
+    end
+
+    def response
+      @data.response
+    end
+
+  end
+end

data/lib/clumsy/test_runner.rb

@@ -0,0 +1,20 @@
+module Clumsy
+  class TestRunner
+
+    attr_reader :response
+
+    def initialize(server, test_file)
+      @server     = server
+      @test_file  = test_file
+    end
+
+    def send_request
+      @response = HTTP.send(@test_file.request_method.downcase.to_sym, @test_file.request_url)
+    end
+
+    def process
+      send_request
+    end
+
+  end
+end

data/lib/clumsy/version.rb

@@ -0,0 +1,3 @@
+module Clumsy
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: clumsy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Darby Frey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-13 00:00:00.000000000 Z
+dependencies:
+- !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: http
+  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: hashie
+  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: pry
+  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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: A clumsy tool for end-to-end proxy testing
+email:
+- darbyfrey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clumsy.gemspec
+- lib/clumsy.rb
+- lib/clumsy/request.rb
+- lib/clumsy/response.rb
+- lib/clumsy/server.rb
+- lib/clumsy/test_file.rb
+- lib/clumsy/test_runner.rb
+- lib/clumsy/version.rb
+homepage: https://github.com/darbyfrey/clumsy
+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.8
+signing_key: 
+specification_version: 4
+summary: A clumsy tool for end-to-end proxy testing
+test_files: []