webmock-server 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YThkYTI3MzI0MDgwZWY2YTEwZWUzOWE1M2Y1ZjU2OTljNmQxYzA5Zg==
+  data.tar.gz: !binary |-
+    ZDVhMWE4YzU4ZTMzZjc3NjQ1OGU4YjU3MTg2ZDA5OGFhNGFkY2I4MA==
+SHA512:
+  metadata.gz: !binary |-
+    YzJiNmRmYjg3OThmZTJlNTM2NGMwM2RjY2MzNTgxNTYxYTM1NWEwOGZhZDdm
+    NGFiYmIxZGZjMjI3YTkyYjIzY2E1NzE4MDhmMDA4OWZhMTA1NDdhZDhlMjll
+    ZDdkMTkzNjhiMDg1Mzc2NDViNzAwMTZmZTE3ZTJkYjNlM2Q3MTI=
+  data.tar.gz: !binary |-
+    ZmNhZDNiNTA3ZDJhNjM4ZGU2YzU0YjE1ZTcxZWM5YTRjNjM3Y2M3M2FlOThk
+    Mzc0ODAwMTdmM2RhOTVkMjQ4OTQyY2M5MzJjNGIwMDEzMzQ3ZDRmM2ZmOWRj
+    YTgyZTdhYzdhY2MwZmVmY2Y0YTJkYWYwNTViYzVjNDkxOTYxNjk=

data/.gitignore

@@ -0,0 +1,23 @@
+.ruby-*
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,14 @@
+---
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1
+notifications:
+  email: false
+deploy:
+  provider: rubygems
+  api_key:
+    secure: GovDViLCjDKdoGK35Y462dswcOAWnl+gB/wBJw0NzJk6cnzQDGcBBQlc/2b0p09RzvvVpjB2/p61wuatbBnJCU9sYgWNid3fz01lf3gD7KNypxbGoJBSkUTvHM0CYtdOiV1Owt2mdt8eQauRrvWvjR62rEbwB6TrJMook20YB2k=
+  on:
+    all_branches: true
+    tags: true

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 rdsubhas
+
+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,60 @@
+# WebMock::Server
+
+[![Build Status](https://travis-ci.org/rdsubhas/webmock-server.svg?branch=master)](https://travis-ci.org/rdsubhas/webmock-server)
+
+A fast, lightweight stub server using WebMock and Rack!
+
+[WebMock](https://github.com/bblimke/webmock) is a popular HTTP mocking library with great features. But it has one limitation: It mocks only at the language/framework/library level (e.g. it mocks Net::HTTP directly).
+
+This gem bridges that gap. It starts a barebones Rack application which will delegate requests to WebMock. So you get all the features of WebMock for stubbing *as well as* a running server that can return the stubbed responses. Even better, you can control the running server directly from your tests, so you can now have different stubs for different test scenarios.
+
+## Rationale
+
+#### vs [WebMock](https://github.com/bblimke/webmock)
+
+WebMock is very popular and feature packed, but as explained above, it works by patching Net::HTTP (or other language-level libraries) directly. It does not come with a real HTTP server.
+
+If you're testing a non-Ruby web app (e.g. Java) using Cucumber/Capybara, or doing black box testing, or testing a bunch of microservices - stubbing libraries is not going to work, you'll need a live server, and that's where WebMock::Server fits in.
+
+WebMock::Server is also built on top of WebMock, so you get the full power of WebMock already!
+
+#### vs [Stubby4J](https://github.com/azagniotov/stubby4j)
+
+Stubby4J runs a real HTTP server, where all the stubbing configuration is defined in simple YML files. Once you've defined the YML files, you cannot change the behavior at runtime. This can be both good and bad. If you have a `/login` endpoint, and for one test you want it to return `200` and for another you want to return `400` - it becomes difficult now since the configuration is static. So you'll end up using different *data or keywords* (e.g. username/password) just to trigger different stubs, and you have to make sure that your tests don't step on each other.
+
+Another common problem with static configuration is that, it leads to reusing same YML files for multiple tests, and this causes interdependency between tests (i.e. you change one YML and many tests get affected). And finally, you will have difficulty finding out which YML file is tied to which scenario, because its not a direct correlation.
+
+In WebMock::Server, your stubs lie right near your steps, so there are no shared files or configurations and thus no dependencies between tests. All this because WebMock::Server can be controlled at runtime. It doesn't stop you from having shared stubs if you *really* need it though (e.g. sometimes you may want some default login/logout responses to be available all the time). If you are using RSpec - setup the shared stubs under `config.before(:each)`. Or if you're using Cucumber, use `Before` hooks. So it becomes completely obvious and under your control which ones are shared and which are not.
+
+#### Other Tools
+
+* [VCR](https://github.com/vcr/vcr) with [PuffingBilly](https://github.com/oesmith/puffing-billy) are not really stub servers, but they are built to record and re-run HTTP API calls. You record actual HTTP requests that hit your real application, and then Play them back during the tests. This again can be good or bad. Its good because it hits real application code. But it leads to specific ordering and dependencies in tests. And everytime you write a new test, you have to first record against a real server, so you still need to have seeding and truncating as part of your test steps. If you're testing complex applications (like a bunch of microservices), everytime you write a new test, you have to run and manage the data in multiple instances. So while replaying tests is easy, creating new tests is more complex.
+
+* [Interfake](https://github.com/basicallydan/interfake) is very similar, and it even has a HTTP API to control the stubs (controlling HTTP over HTTP ftw). Except when it comes to actual matching of requests, its not as feature packed as WebMock.
+
+#### Other Use Cases
+
+Since WebMock::Server can be controlled at runtime, you can write your stubs in such a way that, whenever you get a call to create an entity, say `POST /users`, then you can automatically setup default responses for `GET /users/id`, `DELETE /users/id`, `PUT /users/id`, etc.
+
+`TODO: Example with automatic stubs`
+
+## Usage
+
+* Add the gem to your Gemfile
+* Start the stub server by saying `WebMock::Server.start <port>`
+* Use [WebMock](https://github.com/bblimke/webmock) to stub responses, like:
+
+        WebMock::API.stub_request("http://stubme/").to_return(status: 200, body: 'test')
+
+  * Note that we're using the same Stub URL that we specified earlier to `WebMock::Server.start`
+  * You can use the full power of WebMock such as query parameter matching, request body matching, regular expression URLs and much more!
+
+* See the `examples` folder for some partial list of examples. But remember: You can stub whatever WebMock can! So check the WebMock guide as well on how to stub.
+
+## Contributing
+
+1. Fork it ( https://github.com/rdsubhas/webmock-server/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/webmock/server.rb

@@ -0,0 +1,16 @@
+require "webmock/server/version"
+
+module WebMock
+  module Server
+    STUB_URI = 'http://stubme'
+
+    autoload :Handler, "webmock/server/handler"
+    autoload :API, "webmock/server/api"
+    autoload :Cucumber, "webmock/server/cucumber"
+
+    def self.start(port)
+      require "rack"
+      ::Rack::Handler::WEBrick.run Handler.new, Port: port
+    end
+  end
+end

data/lib/webmock/server/api.rb

@@ -0,0 +1,31 @@
+module WebMock
+  module Server
+    module API
+
+      def stub_server_request(method, uri)
+        WebMock::API.stub_request(method, stubbed_uri(uri))
+      end
+
+      def a_server_request(method, uri)
+        WebMock::API.a_request(method, stubbed_uri(uri))
+      end
+
+      private
+
+      def stubbed_uri(uri)
+        if uri.is_a? String
+          stub_uri + uri
+        elsif uri.is_a? Regexp
+          Regexp.new stub_uri + uri.source
+        elsif uri.is_a? Addressable::Template
+          Addressable::Template.new stub_uri + uri.pattern
+        end
+      end
+
+      def stub_uri
+        STUB_URI
+      end
+
+    end
+  end
+end

data/lib/webmock/server/cucumber.rb

@@ -0,0 +1,7 @@
+require 'webmock/server/api'
+
+World(WebMock::Server::API)
+
+Given /^I stub ([^ ]+) "(.+)"$/ do |method, url|
+  @stub = stub_server_request(method.downcase.to_sym, url)
+end

data/lib/webmock/server/handler.rb

@@ -0,0 +1,38 @@
+require "webmock"
+require "rack"
+
+module WebMock
+  module Server
+    class Handler
+
+      def call(env)
+        uri = stub_uri
+        uri.path = env['PATH_INFO']
+        uri.query = env['QUERY_STRING']
+
+        request = case env['REQUEST_METHOD']
+          when 'GET'
+            Net::HTTP::Get.new uri
+          when 'POST'
+            Net::HTTP::Post.new uri
+          else
+            nil
+        end
+        request.body = env['rack.input'].gets if env['rack.input']
+        request['CONTENT_TYPE'] = env['CONTENT_TYPE']
+
+        response = Net::HTTP.new(uri.host, uri.port).request(request)
+
+        headers = Hash[response.to_hash.map { |k,v| [k, v[0]] }]
+        [ response.code, headers, [ response.body ]]
+      end
+
+      private
+
+      def stub_uri
+        URI.parse STUB_URI
+      end
+
+    end
+  end
+end

data/lib/webmock/server/version.rb

@@ -0,0 +1,5 @@
+module WebMock
+  module Server
+    VERSION = "0.2.0"
+  end
+end

data/spec/get_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe 'GET' do
+  it "root" do
+    stub_server_request(:get, '/')
+      .to_return(body: 'stub body', status: 201, headers: { 'x-custom-header' => 'stub header'})
+
+    get '/'
+    expect(last_response.status).to eq(201)
+    expect(last_response.body).to eq('stub body')
+    expect(last_response.headers['x-custom-header']).to eq('stub header')
+  end
+
+  it "path" do
+    stub_server_request(:get, '/test')
+      .to_return(body: 'stub body', status: 201, headers: { 'x-custom-header' => 'stub header'})
+
+    get '/test'
+    expect(last_response.status).to eq(201)
+    expect(last_response.body).to eq('stub body')
+    expect(last_response.headers['x-custom-header']).to eq('stub header')
+  end
+
+  it "query parameters" do
+    stub_server_request(:get, '/test')
+      .with(query: hash_including(x: 'y'))
+      .to_return(body: 'stub body', status: 201, headers: { 'x-custom-header' => 'stub header'})
+
+    get '/test?x=y'
+    expect(last_response.status).to eq(201)
+    expect(last_response.body).to eq('stub body')
+    expect(last_response.headers['x-custom-header']).to eq('stub header')
+  end
+end

data/spec/post_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe 'POST' do
+  it "root" do
+    stub_server_request(:post, '/')
+      .to_return(body: 'stub body', status: 201, headers: { 'x-custom-header' => 'stub header'})
+
+    post '/'
+    expect(last_response.status).to eq(201)
+    expect(last_response.body).to eq('stub body')
+    expect(last_response.headers['x-custom-header']).to eq('stub header')
+  end
+
+  it "path" do
+    stub_server_request(:post, '/test')
+      .to_return(body: 'stub body', status: 201, headers: { 'x-custom-header' => 'stub header'})
+
+    post '/test'
+    expect(last_response.status).to eq(201)
+    expect(last_response.body).to eq('stub body')
+    expect(last_response.headers['x-custom-header']).to eq('stub header')
+  end
+
+  it "query parameters" do
+    stub_server_request(:post, '/test')
+      .with(query: hash_including(x: 'y'))
+      .to_return(body: 'stub body', status: 201, headers: { 'x-custom-header' => 'stub header'})
+
+    post '/test?x=y'
+    expect(last_response.status).to eq(201)
+    expect(last_response.body).to eq('stub body')
+    expect(last_response.headers['x-custom-header']).to eq('stub header')
+  end
+
+  it "request body" do
+    stub_server_request(:post, '/test')
+      .with(body: { x: 'y' })
+      .to_return(body: 'stub body', status: 201, headers: { 'x-custom-header' => 'stub header'})
+
+    post '/test', '{ "x" : "y" }', { 'CONTENT_TYPE' => 'application/json' }
+    expect(last_response.status).to eq(201)
+    expect(last_response.body).to eq('stub body')
+    expect(last_response.headers['x-custom-header']).to eq('stub header')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "bundler/setup"
+Bundler.setup
+
+require 'webmock'
+require 'webmock/server'
+require 'rack/test'
+
+RSpec.configure do |config|
+  config.include WebMock::Server::API
+  config.include Rack::Test::Methods
+
+  config.before :each do
+    WebMock.allow_net_connect!
+    WebMock.reset!
+  end
+
+  def app
+    WebMock::Server::Handler.new
+  end
+end

data/webmock-server.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webmock/server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webmock-server"
+  spec.version       = WebMock::Server::VERSION
+  spec.authors       = ["rdsubhas"]
+  spec.email         = ["rdsubhas@gmail.com"]
+  spec.summary       = %q{A fast, lightweight live stub server using WebMock and Rack}
+  spec.description   = %q{WebMock allows you to stub only Net::HTTP requests. This gem bridges the gap and allows you to run a live stub server where all requests are stubbed directly using WebMock API}
+  spec.homepage      = "http://github.com/rdsubhas/webmock-server"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rack-test"
+
+  spec.add_dependency "webmock"
+  spec.add_dependency "rack"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: webmock-server
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- rdsubhas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: 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'
+description: WebMock allows you to stub only Net::HTTP requests. This gem bridges
+  the gap and allows you to run a live stub server where all requests are stubbed
+  directly using WebMock API
+email:
+- rdsubhas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webmock/server.rb
+- lib/webmock/server/api.rb
+- lib/webmock/server/cucumber.rb
+- lib/webmock/server/handler.rb
+- lib/webmock/server/version.rb
+- spec/get_spec.rb
+- spec/post_spec.rb
+- spec/spec_helper.rb
+- webmock-server.gemspec
+homepage: http://github.com/rdsubhas/webmock-server
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A fast, lightweight live stub server using WebMock and Rack
+test_files:
+- spec/get_spec.rb
+- spec/post_spec.rb
+- spec/spec_helper.rb