capybara-webmock 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1511010285eeb520105986a627bf40f2957fcaa
-  data.tar.gz: a12bff84fc592bfb31774cd2c3eeb9d691d074f9
+  metadata.gz: 81553b5b1145d09248402a0c1b895df288b5e51c
+  data.tar.gz: 64dc84c9c2b55c7eb70f447be825fa58f6e17f43
 SHA512:
-  metadata.gz: 6861262f85e84d138a83dca1c8152b601506cd702af8c58ca6cebf0b75b8c695953f53ae25338c43f253192f908bc72b2c52c31d7155f539cfed6eb400ae9799
-  data.tar.gz: af780a9538de5a69a5a1686d4b7b8c144f17d0939b6511dfc3912611d81734c43e143207724600d174c621fa70bd42eb6ed826383d44492169531f2346ae6fb1
+  metadata.gz: 399fa5e03d96661d9b1370b8d0be2709a6d9ca923532fceee1ed683df95f78452a4115c95a94d2685c198614f8b6a2e710a759043163f5333cac0c4040de45be
+  data.tar.gz: d2558a7df70f91d5dbd6db30afa2c7fece4c0d544d2686cc4782700560257348051a0eac3f3ee882943b7d791e4881272d3fb1c3b669ea3395b024e57b9ed833

data/.circleci/config.yml

@@ -0,0 +1,9 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - checkout
+      - run: bundle install
+      - run: rake

data/README.md

@@ -18,10 +18,10 @@ Use of this gem can significantly speed up the test suite. No more waiting on
 irrelevant external requests.
 
 `localhost`, `127.0.0.1`, `*.lvh.me`, and `lvh.me` are the only whitelisted
-domains. Custom domain support is a planned feature.
+domains.
 
-This gem currently supports Ruby on Rails applications
-using the Selenium Firefox and Chrome drivers.
+This gem currently supports Ruby on Rails applications using the Selenium
+Firefox and Chrome drivers.
 
 ### Installation
 
@@ -37,7 +37,7 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
+Or install it via the command line:
 
 ```
 $ gem install capybara-webmock
@@ -57,8 +57,10 @@ Then in your RSpec configuration:
 # spec/spec_helper.rb
 
 RSpec.configure do |config|
-  config.before(:suite) do
-    Capybara::Webmock.start
+  config.before(:each) do |example|
+    if example.metadata[:type] == :feature
+      Capybara::Webmock.start
+    end
   end
 
   config.after(:suite) do
@@ -67,18 +69,6 @@ RSpec.configure do |config|
 end
 ```
 
-Or, your Cucumber configuration:
-
-```ruby
-# features/support/env.rb
-
-Capybara::Webmock.start
-
-at_exit do
-  Capybara::Webmock.stop
-end
-```
-
 Then use the `capybara_webmock` JavaScript driver:
 
 ```ruby
@@ -109,17 +99,48 @@ with the following configuration:
 Capybara::Webmock.port_number = 8080
 ```
 
+During each test, you can inspect the list of proxied requests:
+
+```ruby
+it 'makes a request to /somewhere when the user visits the page' do
+  visit "/some-page"
+  expect(Capybara::Webmock.proxied_requests.any?{|req| req.path == "/somewhere" }).to be
+end
+```
+
 ### Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`rake spec` to run the tests. You can also run `bin/console` for an interactive
-prompt that will allow you to experiment.
+After pulling down the repo, install dependencies:
+
+```
+$ bin/setup
+```
+
+Then, run the tests:
+
+```
+$ rake spec
+```
+
+For an interactive prompt that will allow you to experiment, run:
+
+```
+$ bin/console
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+To install your development gem onto your local machine, run:
+
+```
+$ bundle exec rake install
+```
+
+To release a new version, update the version number in `version.rb`, then
+update the git tag, push commits and tags, and publish the gem to
+[rubygems.org](https://rubygems.org) with:
+
+```
+$ bundle exec rake release
+```
 
 ### Contributing
 

data/lib/capybara/webmock.rb

@@ -1,26 +1,59 @@
+require 'open3'
+require 'fileutils'
+require 'socket'
 require 'capybara'
 require 'selenium-webdriver'
 require 'capybara/webmock/version'
 require 'capybara/webmock/proxy'
+require 'capybara/webmock/proxied_request'
 
 module Capybara
   module Webmock
     class << self
-
-      attr_accessor :port_number
+      attr_accessor :port_number, :pid_file, :kill_timeout, :start_timeout
 
       def start
-        log_file   = File.join('log', 'test.log')
-        gem_path   = File.dirname(__FILE__)
-        proxy_file = File.join(gem_path, 'webmock', 'config.ru')
-        IO.popen("PROXY_PORT_NUMBER=#{port_number} rackup #{proxy_file} >> #{log_file} 2>&1")
+        if @pid.nil?
+          kill_old_process
+          gem_path   = File.dirname(__FILE__)
+          proxy_file = File.join(gem_path, 'webmock', 'config.ru')
+          stdin, stdout, wait_thr = Open3.popen2e({ "PROXY_PORT_NUMBER" => port_number.to_s }, "rackup", proxy_file)
+          stdin.close
+          @stdout = stdout
+          @pid = wait_thr[:pid]
+          write_pid_file
+          wait_for_proxy_start
+        end
+
+        reset
       end
 
-      def stop
-        if File.exist?(Capybara::Webmock::Proxy::PID_FILE)
-          rack_pid = File.read(Capybara::Webmock::Proxy::PID_FILE).to_i
-          Process.kill('HUP', rack_pid)
+      def reset
+        get_output_nonblocking
+        @output_buf = ""
+      end
+
+      def proxied_requests
+        @output_buf += get_output_nonblocking
+
+        matches = @output_buf.sub(/\n[^\n]+\z/, '').split("\n").map do |line|
+          match = /\A(.+) -> (.+)\Z/.match(line)
+          next nil unless match
+          match.captures
         end
+
+        matches.compact.map{ |raw_referrer, raw_uri| ProxiedRequest.new(raw_referrer, raw_uri) }
+      end
+
+      def stop
+        return if @pid.nil?
+
+        @stdout.close
+        kill_process(@pid)
+        remove_pid_file
+
+        @pid = nil
+        @stdout = nil
       end
 
       def firefox_profile
@@ -35,26 +68,103 @@ module Capybara
       end
 
       def chrome_options
-        ::Selenium::WebDriver::Chrome::Options.new.tap do |options|
-          options.add_argument("--proxy-server=127.0.0.1:#{port_number}")
-        end
+        { args: "proxy-server=127.0.0.1:#{port_number}" }
       end
 
       def phantomjs_options
         ["--proxy=127.0.0.1:#{port_number}"]
       end
+
+      private
+
+      def wait_for_proxy_start
+        connected = false
+        (1..start_timeout).each do
+          begin
+            Socket.tcp("127.0.0.1", port_number, connect_timeout: 1) {}
+            connected = true
+            break
+          rescue => e
+            sleep 1
+          end
+        end
+
+        unless connected
+          raise "Unable to connect to capybara-webmock proxy on #{port_number}"
+        end
+      end
+
+      def get_output_nonblocking
+        buf = ""
+
+        while true
+          begin
+            output = @stdout.read_nonblock(1024)
+            break if output == ""
+            buf += output
+          rescue IO::WaitReadable
+            break
+          end
+        end
+
+        buf
+      end
+
+      def kill_old_process
+        return unless File.exists?(pid_file)
+        old_pid = File.read(pid_file).to_i
+        kill_process(old_pid) if old_pid > 1
+        remove_pid_file
+      end
+
+      def kill_process(pid)
+        Process.kill('HUP', pid) if process_alive?(pid)
+
+        (1..kill_timeout).each do
+          sleep(1) if process_alive?(pid)
+        end
+
+        Process.kill('KILL', pid) if process_alive?(pid)
+
+        (1..kill_timeout).each do
+          sleep(1) if process_alive?(pid)
+        end
+
+        if process_alive?(pid)
+          raise "Unable to kill capybara-webmock process with PID #{pid}"
+        end
+      end
+
+      def process_alive?(pid)
+        !!Process.kill(0, pid) rescue false
+      end
+
+      def write_pid_file
+        raise "Pid file #{pid_file} already exists" if File.exists?(pid_file)
+        FileUtils.mkdir_p(File.dirname(pid_file))
+        File.write(pid_file, @pid.to_s)
+      end
+
+      def remove_pid_file
+        File.delete(pid_file) if File.exists?(pid_file)
+      end
     end
   end
 end
 
 Capybara::Webmock.port_number ||= 9292
+Capybara::Webmock.pid_file ||= File.join('tmp', 'pids', 'capybara_webmock_proxy.pid')
+Capybara::Webmock.kill_timeout ||= 5
+Capybara::Webmock.start_timeout ||= 30
 
 Capybara.register_driver :capybara_webmock do |app|
   Capybara::Selenium::Driver.new(app, browser: :firefox, profile: Capybara::Webmock.firefox_profile)
 end
 
 Capybara.register_driver :capybara_webmock_chrome do |app|
-  Capybara::Selenium::Driver.new(app, browser: :chrome, options: Capybara::Webmock.chrome_options)
+  Capybara::Selenium::Driver.new(app, browser: :chrome, desired_capabilities: {
+    chromeOptions: Capybara::Webmock.chrome_options
+  })
 end
 
 Capybara.register_driver :capybara_webmock_poltergeist do |app|

data/lib/capybara/webmock/config.ru

@@ -1,12 +1,5 @@
 require 'rack'
 require 'capybara/webmock/proxy'
 
-at_exit { Capybara::Webmock::Proxy.remove_pid }
-
-trap('SIGHUP') {
-  Capybara::Webmock::Proxy.remove_pid
-  exit!
-}
-
 app = Capybara::Webmock::Proxy.new(Process.pid)
 Rack::Handler::WEBrick.run(app, Port: ENV.fetch('PROXY_PORT_NUMBER', 9292))

data/lib/capybara/webmock/proxied_request.rb

@@ -0,0 +1,25 @@
+require 'uri'
+
+module Capybara
+  module Webmock
+    class ProxiedRequest
+      attr_reader :referrer, :uri
+
+      def initialize(raw_referrer, raw_uri)
+        @referrer = raw_referrer == "-" ? nil : URI.parse(raw_referrer)
+        @uri = URI.parse(raw_uri)
+      end
+
+      def fragment; @uri.fragment; end
+      def host; @uri.host; end
+      def hostname; @uri.hostname; end
+      def password; @uri.password; end
+      def path; @uri.path; end
+      def port; @uri.port; end
+      def query; @uri.query; end
+      def scheme; @uri.scheme; end
+      def user; @uri.user; end
+      def userinfo; @uri.userinfo; end
+    end
+  end
+end

data/lib/capybara/webmock/proxy.rb

@@ -2,12 +2,7 @@ require 'rack/proxy'
 require 'capybara/webmock'
 
 class Capybara::Webmock::Proxy < Rack::Proxy
-  PID_FILE = File.join('tmp', 'pids', 'capybara_webmock_proxy.pid')
-
-  def initialize(pid)
-    write_pid(pid)
-    ensure_log_exists
-  end
+  ALLOWED_HOSTS = allowed_hosts = ['127.0.0.1', 'localhost', /(.*\.|\A)lvh.me/]
 
   def call(env)
     @streaming = true
@@ -16,49 +11,30 @@ class Capybara::Webmock::Proxy < Rack::Proxy
 
   def perform_request(env)
     request = Rack::Request.new(env)
-    allowed_urls = ['127.0.0.1', 'localhost', %r{(.*\.|\A)lvh.me}]
 
-    if allowed_url?(allowed_urls, request.host)
+    if allowed_host?(request.host)
       super(env)
     else
-      ['200', {'Content-Type' => 'text/html'}, ['']]
+      headers = {
+        'Content-Type' => 'text/html',
+        'Access-Control-Allow-Origin' => '*',
+        'Access-Control-Allow-Methods' => '*',
+        'Access-Control-Allow-Headers' => '*'
+      }
+      ['200', headers, ['']]
     end
   end
 
-  def self.remove_pid
-    File.delete(PID_FILE) if File.exist?(PID_FILE)
-  end
-
-  def rewrite_response(triplet)
-    status, headers, body = triplet
-    headers.delete "transfer-encoding"
-    triplet
-  end
-
   private
 
-  def allowed_url?(urls, host)
-    case urls
-    when Array
-      urls.any? { |url| allowed_url?(url, host) }
-    when Regexp
-      urls =~ host
-    when String
-      urls == host
+  def allowed_host?(host)
+    ALLOWED_HOSTS.any? do |allowed_host|
+      case allowed_host
+      when Regexp
+        allowed_host =~ host
+      when String
+        allowed_host == host
+      end
     end
   end
-
-  def write_pid(pid)
-    tmp_dir = 'tmp'
-    pid_dir = File.join(tmp_dir, 'pids')
-    Dir.mkdir(tmp_dir) unless Dir.exist?(tmp_dir)
-    Dir.mkdir(pid_dir) unless Dir.exist?(pid_dir)
-    File.write(PID_FILE, pid)
-  end
-
-  def ensure_log_exists
-    log_file = File.join('log', 'test.log')
-    Dir.mkdir('log') unless Dir.exist?('log')
-    File.open(log_file, 'a') { |f| f.write "" }
-  end
 end

data/lib/capybara/webmock/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Webmock
-    VERSION = '0.4.4'
+    VERSION = '0.5.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-webmock
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Jake Worth
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2018-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -150,6 +150,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - CODE_OF_CONDUCT.md
@@ -162,6 +163,7 @@ files:
 - capybara-webmock.gemspec
 - lib/capybara/webmock.rb
 - lib/capybara/webmock/config.ru
+- lib/capybara/webmock/proxied_request.rb
 - lib/capybara/webmock/proxy.rb
 - lib/capybara/webmock/version.rb
 homepage: https://github.com/hashrocket/capybara-webmock