initial open-source commit

Author: samandmoore

.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+spec/examples.txt
+spec/dummy/log
+spec/dummy/db/*.sqlite3
+doc/
+.yardoc/
+Gemfile.lock

.rspec

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

.ruby-version

@@ -0,0 +1 @@
+2.3.1

.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - jruby-9.1.5.0
+before_install:
+  - gem update --system
+  - gem update bundler
+  - gem cleanup bundler
+install: "bundle install --jobs 8"

Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+gemspec
+
+platform :jruby do
+  github 'jruby/activerecord-jdbc-adapter', branch: 'rails-5' do
+    gem 'activerecord-jdbcsqlite3-adapter'
+  end
+  gem 'jdbc-sqlite3'
+end
+
+gem 'sqlite3', '~> 1.3.10', platforms: :ruby

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Betterment
+
+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.

README.md

@@ -0,0 +1,195 @@
+WebValve
+========
+
+[![Build Status](https://travis-ci.com/Betterment/webvalve.svg?token=6b6DErRMUHX47kEoBZ3t&branch=master)](https://travis-ci.com/Betterment/webvalve)
+
+WebValve is a tool for defining and registering fake implementations of
+HTTP services and toggling between the real services and the fake ones
+in non-production environments.
+
+This library is made possible by the incredible gems
+[WebMock](https://github.com/bblimke/webmock) and
+[Sinatra](https://github.com/sinatra/sinatra).
+
+## Getting Started
+
+### Network connections disabled by default
+
+The default mode in development and test is to disallow all HTTP network
+connections. This provides a clean foundation for consuming new
+services. If you add a new service integration, the first thing that you
+will be presented with when you attempt to hit it in development or test
+is a warning that the requested URL was not mocked. This behavior comes
+straight outta WebMock.
+
+```ruby
+irb(main):007:0> Net::HTTP.get(URI('http://bank.dev'))
+
+WebMock::NetConnectNotAllowedError: Real HTTP connections are disabled. Unregistered request: GET http://bank.dev/ with headers {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}
+
+You can stub this request with the following snippet:
+
+stub_request(:get, "http://bank.dev/").
+  with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+  to_return(:status => 200, :body => "", :headers => {})
+
+============================================================
+```
+
+### Creating a config file
+
+The first thing to do is run the install generator.
+
+```
+$ rails generate webvalve:install
+```
+
+This will drop a new file in your config directory.
+
+```ruby
+# config/webvalve.rb
+
+# # register services
+#
+# WebValve.register FakeBank
+# WebValve.register FakeExample, url: 'https://api.example.org'
+#
+# # whitelist urls
+#
+# WebValve.whitelist_url 'https://example.com'
+```
+
+### Registering a service
+
+Next, you will want create a `FakeService` and register
+it with the framework.
+
+This can be accomplished by running the fake service generator:
+
+```
+$ rails generate webvalve:fake_service Bank
+```
+
+This will generate a file `fake_bank.rb` in the top-level folder
+`webvalve`. This file will be autoloaded by Rails, so you can
+tweak it as you go without having to restart your application.
+
+```ruby
+# webvalve/fake_bank.rb
+
+class FakeBank < WebValve::FakeService
+  # # define your routes here
+  #
+  # get '/widgets' do
+  #   json result: 'it works!'
+  # end
+  #
+  # # toggle this service on via ENV
+  #
+  # export BANK_ENABLED=true
+end
+```
+
+And it will automatically register it in `config/webvalve.rb`
+
+```ruby
+# config/webvalve.rb
+WebValve.register FakeBank
+```
+
+You'll also want to define an environment variable for the base url of
+your service.
+
+```bash
+export BANK_API_URL='http://bank.dev'
+```
+
+That's it. Now when you hit your service again, it will route your
+request into the `FakeBank` instance.
+
+If you want to connect to the _actual_ service, all you have to do is
+set another environment variable.
+
+```bash
+export BANK_ENABLED=true
+```
+
+You will have to restart your application after making this change
+because service faking is an initialization time concern and not a
+runtime concern.
+
+## Configuring fakes in tests
+
+In order to get WebValve fake servies working properly in tests, you
+have to configure WebValve at the beginning of each test. For RSpec, there
+is a configuration provided. 
+
+```ruby
+# spec/rails_helper.rb
+require 'webvalve/rspec'
+```
+
+For any other test framework, you will just want to set up a hook before
+each test that will run `WebValve.setup`.
+
+## Setting deterministic fake results in tests
+
+Given a scenario where we want to mock a specific behavior for an
+endpoint in a test, we can just use WebMock™.
+
+```ruby
+# in an rspec test...
+
+it 'handles 404s by returning nil' do
+  fake_req = stub_request('http://bank.dev/some/url/1234')
+    .to_return(status: 404, body: nil)
+
+  response = Faraday.get 'http://bank.dev/some/url/1234'
+  expect(response.body).to be_nil
+  expect(fake_req).to have_been_requested
+end
+```
+
+In other scenarios where we don't care about the specific response from
+the endpoint, you can just lean into the behavior you've configured for
+that route in your fake service.
+
+## Overriding conventional defaults
+
+Sometimes a service integration may want to use an unconventional name
+for its environment variables. In that case, you can register the fake
+service using the optional `url:` argument.
+
+```ruby
+# config/webvalve.rb
+
+# using an ENV variable
+WebValve.register FakeBank, url: ENV.fetch("SOME_CUSTOM_API_URL")
+
+# or with a constant value
+WebValve.register FakeBank, url: "https://some-service.com"
+```
+
+## What's in a `FakeService`?
+
+The definition of `FakeService` is really simple. It's just a
+`Sinatra::Base` class. It is wired up to support returning JSON 
+responses and it will raise when a route is requested but it is 
+not registered.
+
+## How to Contribute
+
+We would love for you to contribute! Anything that benefits the majority
+of `webvalve` users—from a documentation fix to an entirely new
+feature—is encouraged.
+
+Before diving in, [check our issue
+tracker](//github.com/Betterment/webvalve/issues) and consider
+creating a new issue to get early feedback on your proposed change.
+
+### Suggested Workflow
+
+* Fork the project and create a new branch for your contribution.
+* Write your contribution (and any applicable test coverage).
+* Make sure all tests pass (`bundle exec rake`).
+* Submit a pull request.

Rakefile

@@ -0,0 +1,22 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+if Rails.env.development? || Rails.env.test?
+  if defined? Dummy
+    require 'rspec/core'
+    require 'rspec/core/rake_task'
+    RSpec::Core::RakeTask.new(:spec)
+    task default: :spec
+  end
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new

bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bundler', 'bundler')

bin/pry

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('pry', 'pry')

bin/rails

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rails' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('railties', 'rails')

bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

bin/yard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yard')

bin/yardoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'yardoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('yard', 'yardoc')