proxy_rb 0.10.4 → 0.10.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c4140c039086f00ab14580ba60542090e9aa8fb
-  data.tar.gz: 1434c82f7819ced45e0cb8efb4a868f6fe40bbb2
+  metadata.gz: f6abcc8dc4e92962539f30a1449feae10f6c8940
+  data.tar.gz: 184e4d8e2206de5d44e86eee437fece58df3f02a
 SHA512:
-  metadata.gz: e2b8b59ca5495bdb373adea37c32de248f1011de073f1fe3e836c2512cfe926689f5370e11a2327d70768fcc158aa516158098201d2f1ff4415de713b01b6067
-  data.tar.gz: c8dd25257ffa1e7df33e505e96bc65fdd35d894f9466ca95fb9e4010d8d5091687cdcf1fb4cc6b3613d6c03ad5f2e37087b7852304e86ce501ed894e2f608def
+  metadata.gz: 9096dd8f7b0373e477354e4cfaa22621a2775fe247dba45650b06b8a8e80bed93bb2da0965f7854b90af086851ce2af8fa6d83969ff503f2f6e0b07ff8209e3b
+  data.tar.gz: a4b629292fcaa35f0bbf0942ab5f42729e41b669a141b720b2e0bd10eb1e351dd46ef12ac3c1bdb299fd415d200f0599d34d56d1cd35585c6369204dbf520661

data/History.md

@@ -4,6 +4,12 @@ Empty
 
 # RELEASED
 
+## [v0.10.5](https://github.com/fedux-org/proxy_rb/compare/v0.10.5...v0.10.5)
+
+* Fix for overwriting proxies
+* Better error messages for matchers
+* Added new announcer for http status code
+
 ## [v0.10.4](https://github.com/fedux-org/proxy_rb/compare/v0.10.3...v0.10.4)
 
 * Don't overwrite proxies set by multiple tags

data/README.md

@@ -8,6 +8,10 @@
 
 `proxy_rb` makes it easier for you to test your proxy infrastructre.
 
+**Be careful:  This documentation is always up to date and might contain
+information that is not suitable for the version you are using. All features
+flagged with "experimental" might change without any further notice.**
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/cucumber.yml

@@ -1,2 +1,2 @@
-default: -t @wip:3 -t ~@broken-external -t ~@future -t ~@broken
-all: -t ~@wip -t ~@broken-external -t ~@future -t ~@broken
+wip: -t @wip:3 -t ~@broken-external -t ~@future -t ~@broken
+default: -t ~@wip -t ~@broken-external -t ~@future -t ~@broken

data/lib/proxy_rb/announcer.rb

@@ -80,6 +80,7 @@ module ProxyRb
       output_format :resource_user, proc { |v| format('Resource User: %s', v) }
       output_format :resource, proc { |v| format('Resource: %s', v) }
       output_format :http_response_headers, proc { |v| format("<<-HTTP_RESPONSE_HEADERS\n%s\nHTTP_RESPONSE_HEADERS", SimpleTable.new(v)) }
+      output_format :status_code, proc { |v| format('HTTP Status Code: %s', v) }
     end
 
     def output_format(channel, string = '%s', &block)

data/lib/proxy_rb/api/http_proxy.rb

@@ -40,6 +40,10 @@ module ProxyRb
     module HttpProxy
       include ::Capybara::DSL
 
+      # !@attribute resource
+      #   The resource which should be visited/downloaded
+      attr_reader :resource
+
       # The proxy based on subject
       def proxy
         @proxy ||= ProxyRb::HttpProxy.new(ProxyRb::ProxyUrlParser.new(subject))
@@ -50,7 +54,7 @@ module ProxyRb
       # @param [String] url
       # rubocop:disable Metrics/AbcSize
       def visit(url, p = proxy)
-        resource = Resource.new(url)
+        @resource = Resource.new(url)
 
         proxy_rb.event_bus.notify Events::ResourceSet.new(resource.url.to_s)
         proxy_rb.event_bus.notify Events::ResourceUserSet.new(resource.credentials.to_s) unless resource.credentials.empty?

data/lib/proxy_rb/cucumber/hooks.rb

@@ -1,28 +1,18 @@
 # frozen_string_literal: true
+require 'proxy_rb/main'
+
 Before do
   setup_proxy_rb
 end
 
-%i(
-  proxy
-  proxy_user
-  resource
-  resource_user
-  http_response_headers
-).each do |announcer|
+ProxyRb::ANNOUNCERS.each do |announcer|
   Before "@announce-#{announcer.to_s.tr('_', '-')}" do
     proxy_rb.announcer.activate(announcer)
   end
 end
 
 Before '@announce' do
-  %i(
-    proxy
-    proxy_user
-    resource
-    resource_user
-    http_response_headers
-  ).each do |announcer|
+  ProxyRb::ANNOUNCERS.each do |announcer|
     proxy_rb.announcer.activate(announcer)
   end
 end

data/lib/proxy_rb/cucumber/steps.rb

@@ -16,7 +16,7 @@ Given(/^I use the user "([^"]*)"(?: with password "([^"]*)")?$/) do |user_name,
 end
 
 Given(/^I use the following proxies:$/) do |table|
-  proxies.concat table.hashes.map do |r|
+  new_proxies = table.hashes.map do |r|
     p = ProxyRb::HttpProxy.new(ProxyRb::ProxyUrlParser.new(r[:proxy]))
 
     # Hide password by using <PASSWORD> => retrieve it using fetcher
@@ -37,6 +37,8 @@ Given(/^I use the following proxies:$/) do |table|
 
     p
   end
+
+  proxies.concat new_proxies
 end
 
 Then(/the following requests are( not)? allowed to pass the proxy:/) do |forbidden, table|

data/lib/proxy_rb/http_proxy.rb

@@ -50,5 +50,13 @@ module ProxyRb
     def full_url
       ProxyUrl.build url.to_hash.merge(credentials.to_hash)
     end
+
+    # Convert proxy to string
+    #
+    # @return [String]
+    #   the proxy as string url
+    def to_s
+      full_url.to_s
+    end
   end
 end

data/lib/proxy_rb/main.rb

@@ -6,6 +6,15 @@ module ProxyRb
   @debug_mode = false
   @logger     = Logger.new($stderr)
 
+  ANNOUNCERS = %i(
+      proxy
+      proxy_user
+      resource
+      resource_user
+      http_response_headers
+      status_code
+  )
+
   class << self
     protected
 
@@ -15,6 +24,7 @@ module ProxyRb
 
     attr_reader :logger
 
+    # What kind of information can be announce while debugging
     def debug_mode_enabled?
       debug_mode == true
     end

data/lib/proxy_rb/matchers/be_forbidden.rb

@@ -2,17 +2,36 @@
 RSpec::Matchers.define :be_forbidden do
   match do |actual|
     next true if proxy_rb.config.strict == false && (actual.status_code.nil? || actual.status_code == 0)
-    require 'pry'
     sleep 0.5 # handle network latency
 
     values_match?(403, actual.status_code)
   end
 
   failure_message do |actual|
-    %(expected that response has status code 403, but has #{actual.status_code})
+    msg = []
+
+    msg << %(expected that response of "#{resource}" has status code 403, but has #{actual.status_code}.)
+
+    if proxy.nil? || proxy.empty?
+      msg << %(No proxy was used.)
+    else
+      msg << %(It was fetched via proxy "#{proxy.to_s}".)
+    end
+
+    msg.join ' '
   end
 
   failure_message_when_negated do
-    %(expected that response does not have status code 403)
+    msg = []
+
+    msg << %(expected that response of "#{resource}" does not have status code 403.)
+
+    if proxy.nil? || proxy.empty?
+      msg << %(No proxy was used.)
+    else
+      msg << %(It was fetched via proxy "#{proxy.to_s}".)
+    end
+
+    msg.join ' '
   end
 end

data/lib/proxy_rb/matchers/be_successful.rb

@@ -2,16 +2,36 @@
 RSpec::Matchers.define :be_successful do
   match do |actual|
     next true if proxy_rb.config.strict == false && (actual.status_code.nil? || actual.status_code == 0)
+    sleep 0.5 # handle network latency
 
-    sleep 0.5
     actual.status_code.to_s.start_with?('2', '3')
   end
 
   failure_message do |actual|
-    %(expected that response has status code 2xx, but has #{actual.status_code})
+    msg = []
+
+    msg << %(expected that response of "#{resource}" has status code 2xx, but has #{actual.status_code}.)
+
+    if proxy.nil? || proxy.empty?
+      msg << %(No proxy was used.)
+    else
+      msg << %(It was fetched via proxy "#{proxy.to_s}".)
+    end
+
+    msg.join ' '
   end
 
   failure_message_when_negated do
-    %(expected that response does not have status code 2xx)
+    msg = []
+
+    msg << %(expected that response of "#{resource}" does not have status code 2xx.)
+
+    if proxy.nil? || proxy.empty?
+      msg << %(No proxy was used.)
+    else
+      msg << %(It was fetched via proxy "#{proxy.to_s}".)
+    end
+
+    msg.join ' '
   end
 end

data/lib/proxy_rb/matchers/have_mime_type.rb

@@ -4,6 +4,34 @@ RSpec::Matchers.define :have_mime_type do |expected|
     @actual = actual.mime_type
     values_match?(expected, @actual)
   end
+
+  failure_message do |actual|
+    msg = []
+
+    msg << %(expected that response of "#{resource}" has mime type "#{expected}", but has "#{actual}".)
+
+    if proxy.nil? || proxy.empty?
+      msg << %(No proxy was used.)
+    else
+      msg << %(It was fetched via proxy "#{proxy.to_s}".)
+    end
+
+    msg.join ' '
+  end
+
+  failure_message_when_negated do
+    msg = []
+
+    msg << %(expected that response of "#{resource}" does not have mime type "#{expected}".)
+
+    if proxy.nil? || proxy.empty?
+      msg << %(No proxy was used.)
+    else
+      msg << %(It was fetched via proxy "#{proxy.to_s}".)
+    end
+
+    msg.join ' '
+  end
 end
 
 RSpec::Matchers.alias_matcher :be_of_mime_type, :have_mime_type

data/lib/proxy_rb/proxy_url.rb

@@ -84,6 +84,8 @@ module ProxyRb
     # @return [Hash]
     #   the converted url
     def to_hash
+      return {} if empty?
+
       url.to_hash
     end
   end

data/lib/proxy_rb/rspec.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'proxy_rb/api'
+require 'proxy_rb/main'
 
 # Main Module
 module ProxyRb
@@ -33,24 +34,12 @@ RSpec.configure do |config|
   config.before :each do |example|
     next unless self.class.include? ProxyRb::Api
 
-    %i(
-      proxy
-      proxy_user
-      resource
-      resource_user
-      http_response_headers
-    ).each do |announcer|
+    ProxyRb::ANNOUNCERS.each do |announcer|
       proxy_rb.announcer.activate(announcer) if example.metadata["announce_#{announcer}".to_sym]
     end
 
     if example.metadata[:announce]
-      %i(
-        proxy
-        proxy_user
-        resource
-        resource_user
-        http_response_headers
-      ).each do |announcer|
+      ProxyRb::ANNOUNCERS.each do |announcer|
         proxy_rb.announcer.activate(announcer)
       end
     end

data/lib/proxy_rb/setup.rb

@@ -61,6 +61,7 @@ module ProxyRb
         proc do |event|
           begin
             runtime.announcer.announce :http_response_headers, event.entity.driver.response_headers
+            runtime.announcer.announce :status_code, event.entity.driver.status_code
           rescue Capybara::NotSupportedByDriverError
             runtime.announcer.announce :http_response_headers, 'Message': format('Using #response_headers with the current driver "%s" is currently not supported', event.entity.driver.class)
           end

data/lib/proxy_rb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # Main Module
 module ProxyRb
-  VERSION = '0.10.4'
+  VERSION = '0.10.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: proxy_rb
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.10.5
 platform: ruby
 authors:
 - Max Meyer