pact-support 0.5.5 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8302de9af32aa569443e49a502132233ecc0fbc6
-  data.tar.gz: d03296b6197757a59b1a8c197b375fb17e3be7d7
+  metadata.gz: 8eeb1140d12c89f3c03f855ecfbb9666259b502c
+  data.tar.gz: 8b7e7ef1dea78d0abe77c2fb0db5a17f46ee47e9
 SHA512:
-  metadata.gz: db57a82df74f57807f6514abad63b30374ebbb81d6aadac107059e9dbef23978d2e94ef2b6a5c30095d5b870a464aea05269bea1ffa96aa030305a2d595c546a
-  data.tar.gz: 9918d2bd33d4986bfcf67e41ed2a52d1d216bff694df1035f666cef2a933fbaaef37e8d5f82b9d34c3f80b5fab3a6c6434db6e06c15fc01a982bac5bf6f435da
+  metadata.gz: 9cbde3f5574d69c3be0b1e8f2fa7cd196e4c2e42133e966a7087d8a4f3796cb21906c93c7d6df5b97a445842031ed713ab1fa96de44f20110a25d3655e64fb49
+  data.tar.gz: 09d6fc96eeb2c6fcdce7269392a47a08ba3efa50e927b2fc80e9d41a21197dd4d1e37826ebe211b81ca9c79ad019761462431243385f7a34ff2514414314f71c

data/.travis.yml

@@ -3,5 +3,5 @@ rvm:
   - 2.0.0
   - 2.1.8
   - 2.2.4
-  - 2.3.0
+  - 2.3.1
   - jruby-9.0.5.0

data/CHANGELOG.md

@@ -2,20 +2,23 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)' vX.Y.Z..HEAD
 
-
-### 0.5.5 (4 November 2015)
-* e9aaff0 - Merge pull request #21 from TakatoshiMaeda/reify_support_nested_something_like (Sergei Matheson, Fri Apr 29 09:54:00 2016 +1000)
+### 0.5.7 (3 May 2016)
+* 289d4e5 - Handle loading local pact files as well as remote (Sergei Matheson, Tue May 3 12:56:51 2016 +1000)
+* 6d4e559 - Update to ruby 2.3.1 in travis (Sergei Matheson, Tue May 3 10:46:46 2016 +1000)
+
+### 0.5.6 (29 April 2016)
+* d8bc8fa - Remove pull request merge logs from changelog (Sergei Matheson, Fri Apr 29 10:06:51 2016 +1000)
+* 24ba197 - Corrected v0.5.5 release date in CHANGELOG (Sergei Matheson, Fri Apr 29 10:05:11 2016 +1000)
+* 9dcef8d - Retry reading pact file (Taiki Ono, Thu Apr 28 17:15:54 2016 +0900)
+* 61ceda1 - Re-write test with WebMock (Taiki Ono, Thu Apr 28 15:50:29 2016 +0900)
+* 62dcf66 - Use WebMock2 (Taiki Ono, Thu Apr 28 13:51:53 2016 +0900)
+
+### 0.5.5 (29 April 2016)
 * eb9aa26 - Supporting nested Pact::SomethingLike reification (Takatoshi Maeda, Thu Apr 28 02:04:58 2016 +0900)
-* 832790d - Merge pull request #20 from taiki45/dsl-without-block (Sergei Matheson, Thu Mar 24 09:36:22 2016 +1100)
 * 9e924c8 - Object supporting DSL can be built without block (Taiki Ono, Wed Mar 23 16:38:27 2016 +0900)
-* 57aa993 - Merge pull request #18 from taiki45/escape-query-string-component (Sergei Matheson, Tue Mar 15 09:24:36 2016 +1100)
 * 2b0e7b4 - Escape query string components (Taiki Ono, Mon Mar 14 15:22:29 2016 +0900)
 * a383368 - Fix indent (Taiki Ono, Mon Mar 14 15:18:26 2016 +0900)
-* fae9a14 - Merge pull request #17 from taiki45/upgrade-jruby (Ronald Holshausen, Mon Mar 14 09:56:16 2016 +1100)
 * dc54092 - Support latest jruby and drop supporting jruby 1.7 (Taiki Ono, Sun Mar 13 20:27:17 2016 +0900)
-* 22651e8 - Merge pull request #16 from taiki45/drop-supporting-ruby1.9 (Beth Skurrie, Sat Mar 12 14:04:41 2016 +1100)
-* 3dbaa38 - Merge pull request #15 from taiki45/suppress-rspec-warnings (Sergei Matheson, Fri Mar 11 09:29:26 2016 +1100)
-* 656c98a - Merge pull request #14 from taiki45/nested-query (Sergei Matheson, Fri Mar 11 09:19:58 2016 +1100)
 * 85fbb09 - Drop supporting ruby1.9 (Taiki Ono, Thu Mar 10 23:01:54 2016 +0900)
 * 966fa3a - `raise_error` should be with specific error (Taiki Ono, Thu Mar 10 22:50:13 2016 +0900)
 * 2861742 - Cosmetic change (Taiki Ono, Thu Mar 10 22:11:51 2016 +0900)

data/lib/pact/consumer_contract/pact_file.rb

@@ -1,9 +1,22 @@
-module Pact
+require 'net/http'
 
+module Pact
   module PactFile
-
     extend self
 
+    OPEN_TIMEOUT = 5
+    READ_TIMEOUT = 5
+    RETRY_LIMIT = 3
+
+    class HttpError < StandardError
+      attr_reader :uri, :response
+
+      def initialize(uri, response)
+        @uri, @response = uri, response
+        super("HTTP request failed: status=#{response.code}")
+      end
+    end
+
     def read uri, options = {}
       uri_string = uri.to_s
       pact = render_pact(uri_string, options)
@@ -22,16 +35,74 @@ module Pact
       ::File.open(Pact.configuration.tmp_dir + "/#{name}", "w") { |file|  file << pact}
     end
 
-    def render_pact uri_string, options
+    def render_pact(uri_string, options)
       uri_obj = URI(uri_string)
-      uri_user_info = uri_obj.userinfo
-      if(uri_user_info)
+      if uri_obj.userinfo
         options[:username] = uri_obj.user unless options[:username]
         options[:password] = uri_obj.password unless options[:password]
-        uri_string = uri_string.sub("#{uri_user_info}@", '')
       end
-      open_options = options[:username] ? {http_basic_authentication:[options[:username],options[:password]]} : {}
-      open(uri_string, open_options) { | file | file.read }
+      get(uri_obj, options)
+    end
+
+    private
+
+    def get(uri, options)
+      local?(uri) ?  get_local(uri, options) : get_remote_with_retry(uri, options)
+    end
+
+    def local? uri
+      !uri.host
+    end
+
+    def get_local(uri, _)
+      File.read uri.to_s
+    end
+
+    def get_remote(uri, options)
+      request = Net::HTTP::Get.new(uri)
+      request.basic_auth(options[:username], options[:password]) if options[:username]
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        http.open_timeout = options[:open_timeout] || OPEN_TIMEOUT
+        http.read_timeout = options[:read_timeout] || READ_TIMEOUT
+        http.request(request)
+      end
+    end
+
+    def get_remote_with_retry(uri, options)
+      ((options[:retry_limit] || RETRY_LIMIT) + 1).times do |i|
+        begin
+          response = get_remote(uri, options)
+          case
+          when success?(response)
+            return response.body
+          when retryable?(response)
+            raise HttpError.new(uri, response) if abort_retry?(i, options)
+            delay_retry(i + 1)
+            next
+          else
+            raise HttpError.new(uri, response)
+          end
+        rescue Timeout::Error => e
+          raise e if abort_retry?(i, options)
+          delay_retry(i + 1)
+        end
+      end
+    end
+
+    def success?(response)
+      response.code.to_i == 200
+    end
+
+    def retryable?(response)
+      (500...600).cover?(response.code.to_i)
+    end
+
+    def abort_retry?(count, options)
+      count >= (options[:retry_limit] || RETRY_LIMIT)
+    end
+
+    def delay_retry(count)
+      Kernel.sleep(2 ** count * 0.3)
     end
   end
-end
+end

data/lib/pact/support/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module Support
-    VERSION = "0.5.5"
+    VERSION = "0.5.7"
   end
 end

data/pact-support.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'thor'
 
   gem.add_development_dependency 'rake', '~> 10.0.3'
-  gem.add_development_dependency 'webmock', '~> 1.18.0'
+  gem.add_development_dependency 'webmock', '~> 2.0.0'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'fakefs', '~> 0.4'
   gem.add_development_dependency 'hashie', '~> 2.0'

data/spec/lib/pact/consumer_contract/pact_file_spec.rb

@@ -1,14 +1,36 @@
 require 'spec_helper'
+require 'tempfile'
 require 'pact/consumer_contract/pact_file'
+require 'base64' # XXX: https://github.com/bblimke/webmock/pull/611
 
 module Pact
   describe PactFile do
     describe 'render_pact' do
       let(:uri_without_userinfo) { 'http://pactbroker.com'}
       let(:pact_content) { 'api contract'}
+
+      describe 'from a local file URI' do
+        let(:temp_file) { Tempfile.new('local-pact-file') }
+        let(:file_uri) { temp_file.path }
+        let(:local_pact_content) { 'local pact content' }
+        before do
+          File.write file_uri, local_pact_content
+        end
+        after do
+          temp_file.unlink
+        end
+
+        it 'reads from the local file system' do
+          expect(PactFile.render_pact(file_uri, {})).to eq(local_pact_content)
+        end
+      end
+
       context 'without basic authentication' do
+        before do
+          stub_request(:get, uri_without_userinfo).to_return(body: pact_content)
+        end
+
         it 'should open uri to get pact file content' do
-          expect(PactFile).to receive(:open).with(uri_without_userinfo, {}).and_return(pact_content)
           expect(PactFile.render_pact(uri_without_userinfo, {})).to eq(pact_content)
         end
       end
@@ -19,29 +41,140 @@ module Pact
         let(:options) do
           { username: username, password: password }
         end
+        before do
+          stub_request(:get, uri_without_userinfo).with(basic_auth: [username, password]).to_return(body: pact_content)
+        end
+
         context 'when userinfo is specified in the option' do
           it 'should open uri to get pact file content with userinfo in the options' do
-            expect(PactFile).to receive(:open).with(uri_without_userinfo, {http_basic_authentication:[username, password]})
-                                .and_return(pact_content)
             expect(PactFile.render_pact(uri_without_userinfo, options)).to eq(pact_content)
           end
+
           let(:uri_with_userinfo) { 'http://dummyuser:dummyps@pactbroker.com'}
+
           it 'should use userinfo in options which overwrites userinfo in url' do
-            expect(PactFile).to receive(:open).with(uri_without_userinfo, {http_basic_authentication:[username, password]})
-                                .and_return(pact_content)
             expect(PactFile.render_pact(uri_with_userinfo, options)).to eq(pact_content)
           end
         end
 
         context 'when user info is specified in url' do
           let(:uri_with_userinfo) { "http://#{username}:#{password}@pactbroker.com"}
+
           it 'should open uri to get pact file content with userinfo in the uri' do
-            expect(PactFile).to receive(:open).with(uri_without_userinfo, {http_basic_authentication:[username, password]})
-                                .and_return(pact_content)
             expect(PactFile.render_pact(uri_with_userinfo, {})).to eq(pact_content)
           end
         end
       end
+
+      describe 'retry feature' do
+        before { allow(PactFile).to receive(:delay_retry).with(kind_of(Integer)) }
+
+        def render_pact(options = {})
+          PactFile.render_pact(uri_without_userinfo, options)
+        end
+
+        context 'with client error' do
+          before { stub_request(:get, uri_without_userinfo).to_return(status: 400) }
+
+          it 'raises client error without retrying' do
+            expect(PactFile).not_to receive(:delay_retry)
+            expect { render_pact }.to raise_error(PactFile::HttpError, /status=400/)
+          end
+        end
+
+        context 'with single server error' do
+          before do
+            stub_request(:get, uri_without_userinfo).to_return(status: 500).
+              then.to_return(status: 200, body: pact_content)
+          end
+
+          it 'retries and succeeds' do
+            expect(render_pact).to eq(pact_content)
+          end
+        end
+
+        context 'with continuous server errors' do
+          before { stub_request(:get, uri_without_userinfo).to_return(status: 500) }
+
+          it 'retries but failed by retry limit' do
+            expect { render_pact }.to raise_error(PactFile::HttpError, /status=500/)
+          end
+        end
+
+        context 'with single open timeout' do
+          before do
+            stub_request(:get, uri_without_userinfo).to_raise(Net::OpenTimeout).
+              then.to_return(status: 200, body: pact_content)
+          end
+
+          it 'retries and succeeds' do
+            expect(render_pact).to eq(pact_content)
+          end
+        end
+
+        context 'with continuous open timeouts' do
+          before { stub_request(:get, uri_without_userinfo).to_raise(Net::OpenTimeout) }
+
+          it 'retries but failed by retry limit' do
+            expect { render_pact }.to raise_error(Net::OpenTimeout)
+          end
+        end
+
+        context 'with single read timeout' do
+          before do
+            stub_request(:get, uri_without_userinfo).to_raise(Net::ReadTimeout).
+              then.to_return(status: 200, body: pact_content)
+          end
+
+          it 'retries and succeeds' do
+            expect(render_pact).to eq(pact_content)
+          end
+        end
+
+        context 'with continuous read timeout' do
+          before { stub_request(:get, uri_without_userinfo).to_raise(Net::ReadTimeout) }
+
+          it 'retries but failed by retry limit' do
+            expect { render_pact }.to raise_error(Net::ReadTimeout)
+          end
+        end
+
+        context 'with retry_limit option and server error' do
+          before do
+            stub_request(:get, uri_without_userinfo).to_return(status: 500).
+              then.to_return(status: 200, body: pact_content)
+          end
+
+          it 'retries and succeeds' do
+            expect { render_pact(retry_limit: 0) }.to raise_error(PactFile::HttpError, /status=500/)
+          end
+        end
+
+        context 'with retry_limit option and open timeout error' do
+          before do
+            stub_request(:get, uri_without_userinfo).to_raise(Net::OpenTimeout).
+              then.to_return(status: 200, body: pact_content)
+          end
+
+          it 'retries and succeeds' do
+            expect { render_pact(retry_limit: 0) }.to raise_error(Net::OpenTimeout)
+          end
+        end
+
+        context 'with retry_limit option which is greater than default retry limit' do
+          before do
+            stub_request(:get, uri_without_userinfo).to_return(status: 500).
+              then.to_return(status: 500).
+              then.to_return(status: 500).
+              then.to_return(status: 500).
+              then.to_return(status: 200, body: pact_content)
+          end
+
+          it 'retries and succeeds' do
+            expect(render_pact(retry_limit: 4)).to eq(pact_content)
+          end
+        end
+      end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-support
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.7
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -146,14 +146,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement