webmock-net-http-pipeline 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 397983d8f69cd968e08f3ce2656502d535efe32e
+  data.tar.gz: 73e9b87762c31b999c59532fddd8dfa4bf004852
+SHA512:
+  metadata.gz: ddad97f62dd128f21c63ea22908eb3a48c6ceb4454a1bf1ee60ddc5b8e8e88920b1e1312be739923473648acbd84d7de072001b4bf70966576795b3a5e29e858
+  data.tar.gz: a3b9890f8752df0d882cbfe04485d5f24659cc1c36a0f3a5d7718ae085b7621f2e51a6aa1b69597ec79ba025e84416642b27d9e568539b30c2176128aeb194bf

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Global Personals Ltd.
+
+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,65 @@
+# WebMock + Net::HTTP::Pipeline
+
+Use WebMock to test your use of pipelined HTTP requests.
+
+[WebMock][webmock] is a great tool for stubbing HTTP requests in tests.
+[net-http-pipeline][nhp] is an HTTP/1.1 pipelining implementation build on top
+of Net::HTTP, used for making batches of HTTP calls more efficient.  The only
+problem is that the two don't play well together: net-http-pipeline bypasses
+the hooks that WebMock sets in place to provide its behaviour.
+
+This library mimics the -pipeline behaviour within WebMock's version of
+`Net::HTTP#request` to allow you to test your pipelined HTTP calls.
+
+## Installation
+
+Add this line to your application"s Gemfile:
+
+```ruby
+gem "webmock-net-http-pipeline"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install webmock-net-http-pipeline
+```
+
+## Usage
+
+Simply `require` this gem after requiring `webmock`, and start mocking and
+testing your pipelined requests.
+
+
+```ruby
+require "webmock"
+require "webmock/net/http/pipeline"
+
+include WebMock::API
+
+host = "www.example.com"
+stub_request(:any, host)
+
+http      = Net::HTTP.start(host, 80).tap { |http| http.pipelining = true }
+requests  = (1..3).map { Net::HTTP::Get.new("/") }
+responses = http.pipeline(requests)
+
+p responses   #=> [#<Net::HTTPOK 200  readbody=true>, ...]
+```
+
+## Contributing
+
+1. Fork it: http://github.com/globaldev/webmock-net-http-pipeline/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 new Pull Request
+
+[webmock]: https://github.com/bblimke/webmock
+[nhp]: https://github.com/drbrain/net-http-pipeline

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/webmock/net/http/pipeline.rb

@@ -0,0 +1,25 @@
+require "webmock/net/http/pipeline/version"
+require "webmock"
+
+module WebMock
+  module NetHTTPPipeline
+
+    def pipeline(requests)
+      responses = []
+      requests.reject! do |req|
+        response = request(req)
+        yield response if block_given?
+        responses << response
+      end
+      responses
+    end
+
+    # Not actually used, but keeps the interface consistent with -pipeline
+    attr_accessor :pipelining
+
+  end
+end
+
+WebMock::HttpLibAdapters::NetHttpAdapter.instance_variable_get(:@webMockNetHTTP).class_eval do
+  include WebMock::NetHTTPPipeline
+end

data/lib/webmock/net/http/pipeline/version.rb

@@ -0,0 +1,5 @@
+module WebMock
+  module NetHTTPPipeline
+    VERSION = "1.0.0"
+  end
+end

data/test/test_webmock_net_http_pipeline.rb

@@ -0,0 +1,71 @@
+require "minitest/autorun"
+require "webmock/net/http/pipeline"
+
+class TestPipeliningBehaviour < MiniTest::Unit::TestCase
+
+  class MockedResponse < Struct.new(:request); end
+  class MockedClient
+    include WebMock::NetHTTPPipeline
+    def request(req)
+      MockedResponse.new(req)
+    end
+  end
+
+  def setup
+    @client = MockedClient.new
+  end
+
+  def test_pipelines_zero_requests
+    assert_empty @client.pipeline([])
+  end
+
+  def test_pipelines_one_request
+    requests = [:one]
+    responses = @client.pipeline(requests.dup)
+    assert_equal 1, responses.length
+    assert_same requests.first, responses.first.request
+  end
+
+  def test_pipelines_multiple_requests
+    requests = [:one, :two, :three]
+    responses = @client.pipeline(requests.dup)
+    responses.each { |res| assert_includes requests, res.request }
+  end
+
+  def test_returns_responses_in_order
+    requests = [:one, :two, :three]
+    responses = @client.pipeline(requests.dup)
+    assert requests == responses.map { |r| r.request }
+  end
+
+  def test_removes_successfully_pipelined_requests
+    requests = [:one, :two, :three]
+    assert_equal 3, @client.pipeline(requests).size
+    assert_empty requests
+  end
+
+  def test_yields_each_response_if_block_given
+    requests, responses = [:one, :two, :three], []
+    @client.pipeline(requests.dup) { |res| responses << res.request }
+    assert requests == responses
+  end
+end
+
+class TestWebMockInclusion < MiniTest::Unit::TestCase
+  def setup
+    klass = WebMock::HttpLibAdapters::NetHttpAdapter
+    @client = klass.instance_variable_get(:@webMockNetHTTP).new(nil)
+  end
+
+  def test_net_http_adapter_responds_to_pipeline
+    assert_respond_to @client, :pipeline
+  end
+
+  def test_net_http_adapter_responds_to_pipelining
+    assert_respond_to @client, :pipelining
+  end
+
+  def test_net_http_adapter_responds_to_pipelining=
+    assert_respond_to @client, :pipelining=
+  end
+end

data/webmock-net-http-pipeline.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webmock/net/http/pipeline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webmock-net-http-pipeline"
+  spec.version       = WebMock::NetHTTPPipeline::VERSION
+  spec.authors       = ["Tim Blair", "Mat Sadler"]
+  spec.email         = ["tim@bla.ir", "mat@sourcetagsandcodes.com"]
+  spec.summary       = %q{Use WebMock to test your use of pipelined HTTP requests.}
+  spec.description   = %q{Mimics net-http-pipeline's behaviour within WebMock's Net::HTTP implementation, allowing you to mock and test your pipelined HTTP calls.}
+  spec.homepage      = "http://github.com/globaldev/webmock-net-http-pipeline"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "webmock", "~> 1.7"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: webmock-net-http-pipeline
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tim Blair
+- Mat Sadler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: 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'
+description: Mimics net-http-pipeline's behaviour within WebMock's Net::HTTP implementation,
+  allowing you to mock and test your pipelined HTTP calls.
+email:
+- tim@bla.ir
+- mat@sourcetagsandcodes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/webmock/net/http/pipeline.rb
+- lib/webmock/net/http/pipeline/version.rb
+- test/test_webmock_net_http_pipeline.rb
+- webmock-net-http-pipeline.gemspec
+homepage: http://github.com/globaldev/webmock-net-http-pipeline
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Use WebMock to test your use of pipelined HTTP requests.
+test_files:
+- test/test_webmock_net_http_pipeline.rb