capybara_mock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57a394dbe97d73967375b025383b3ae4ff760b10316793253f9b66541cd92155
+  data.tar.gz: 210ef8e8b3fecbf6c4c087802ec27c2e019bc55a55bca70c47f2e2b89e1a94ef
+SHA512:
+  metadata.gz: dcc2e3dc6243cb540d6441003339d811f65a6ba1387da2dd24511d79820f0eeb5545d2cd43618aabe0d480b4ca8ad078f69aedc39452293fac7caa47ba196256
+  data.tar.gz: aa2aaec43d65bf581dc3971fcca1301c31c63a4a81bad6226c9043c09e1c8354581632f479af9472ae927bb04da281b60b026e357b93e83343fbde06df1c6de4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,33 @@
+require: 
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+RSpec/ExampleLength:
+  Max: 50
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/Rails/InferredSpecType:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at contact@railsware.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rack', '2.2.4'
+
+gem 'capybara', '>= 3.35.0'
+gem 'cuprite', '>= 0.14.0'
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-rake', '~> 0.6', require: false
+gem 'rubocop-rspec', '~> 2.15', require: false

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    capybara_mock (0.1.0)
+      rack (>= 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    capybara (3.38.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    concurrent-ruby (1.1.10)
+    cuprite (0.14.3)
+      capybara (~> 3.0)
+      ferrum (~> 0.13.0)
+    diff-lcs (1.5.0)
+    ferrum (0.13)
+      addressable (~> 2.5)
+      concurrent-ruby (~> 1.1)
+      webrick (~> 1.7)
+      websocket-driver (>= 0.6, < 0.8)
+    json (2.6.3)
+    matrix (0.4.2)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.13.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.10-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    racc (1.6.1)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.15.0)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+    webrick (1.7.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  capybara (>= 3.35.0)
+  capybara_mock!
+  cuprite (>= 0.14.0)
+  rack (= 2.2.4)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.15)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Railsware Products Studio LLC.
+
+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,179 @@
+[![test](https://github.com/railsware/capybara_mock/actions/workflows/main.yml/badge.svg)](https://github.com/railsware/capybara_mock/actions/workflows/main.yml)
+
+# CapybaraMock
+
+Library for stubbing HTTP requests in Capybara browser. 
+
+## Features
+
+* Stubbing interface similar to [WebMock](https://github.com/bblimke/webmock)
+* Matching requests based on
+  * method
+  * url
+  * query
+  * headers
+  * body
+
+## Supported capybara drivers
+
+* [Cuprite](https://github.com/rubycdp/cuprite)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add capybara_mock
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install capybara_mock
+
+### RSpec
+
+Add the following code to `spec/spec_helper`:
+
+```ruby
+require 'capybara_mock/rspec'
+```
+
+Then ensure your capybara use `:cuprite` driver for feature specs that you want to mock browser requests.
+
+## Usage
+
+* `Capybara.stub_request` - stub external request by full url or regexp.
+* `Capybara.stub_path` - stub internal request (to your capybara application) by path.
+* `Capybara.remove_stub` - remove previously added stub to current capybara session
+* `Capybara.clear_stubs` - remove all stubs for current capybara session
+* `Capybara.save_unstubbed_requests` - save unstubbed browser requests from current capybara session. Useful for debugging.
+
+## Examples
+
+### Stub external request
+
+```ruby
+CapybaraMock.stub_request(
+  :get, 'https://api.stripe.com/v1/balance'
+).to_return(
+  status: 200,
+  headers: {'Content-Type' => 'application/json'},
+  body: {amount: 10100}.to_json
+)
+```
+
+### Stub internal request
+
+```ruby
+CapybaraMock.stub_path(
+  :get, '/api/users/me'
+).to_return(
+  status: 200,
+  headers: {'Content-Type' => 'application/json'},
+  body: {name: 'John Doe'}.to_json
+)
+```
+
+### Stub with specific query
+
+```ruby
+CapybaraMock.stub_path(
+  :get, '/api/users'
+).with(
+  query: {page: 1}
+).to_return(
+  status: 200,
+  headers: {'Content-Type' => 'application/json'},
+  body: [].to_json
+)
+```
+
+### Stub with specific header
+
+```ruby
+CapybaraMock.stub_path(
+  :get, '/api/users/1'
+).with(
+  headers: {
+    'Authorization' => 'Bearer ACCESS_TOKEN'
+  }
+).to_return(
+  status: 200,
+  headers: {'Content-Type' => 'application/json'},
+  body: {id: 1}.to_json
+)
+```
+
+### Stub with specific body
+
+```ruby
+CapybaraMock.stub_path(
+  :post, '/api/users'
+).with(
+  headers: {'Content-Type': 'application/x-www-form-urlencoded'}, 
+  body: 'first_name=John&last_name=Doe'
+).to_return(
+  status: 200,
+  headers: {'Content-Type' => 'application/json'},
+  body: {id: 1}.to_json
+)
+```
+
+```ruby
+CapybaraMock.stub_path(
+  :post, '/api/users'
+).with(
+  headers: {'Content-Type': 'application/json'}, 
+  body: '{"first_name":"John","last_name":"Doe"}'
+).to_return(
+  status: 200,
+  headers: {'Content-Type' => 'application/json'},
+  body: {id: 1}.to_json
+)
+```
+
+## Limitation
+
+Unfortunately Chrome DevTools Protocol still does not support all valid http response codes.
+Right now it [supports](https://github.com/chromium/chromium/blob/main/net/http/http_status_code_list.h) only:
+* 100, 101, 103
+* 200..206
+* 300..305, 307..308
+* 400..418, 425, 229
+* 500..505
+
+For unsupported codes cuprite interceptor will send basic code and real code in special response header `X-Mock-Response-Status`. So you you have to add interceptor for your http client.
+
+
+### AXIOS interceptor
+
+```js
+axios.interceptors.response.use(
+  (response) => response,
+  (error) => {
+    if (error.response && error.response.headers['x-mock-response-status']) {
+      const status = parseInt(error.response.headers['x-mock-response-status'])
+      error.message = `Request failed with status code ${status}`
+      error.response.status = status
+    }
+
+   return Promise.reject(error)
+ }
+```
+
+
+## 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.
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/railsware/capybara_mock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/railsware/capybara_mock/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CapybaraMock project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/railsware/capybara_mock/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/capybara_mock/interceptor/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CapybaraMock
+  module Interceptor
+    # Base interceptor class
+    class Base
+      attr_reader :stubs, :unstubbed_requests
+
+      def initialize
+        @stubs = []
+        @unstubbed_requests = []
+      end
+
+      private
+
+      def stub_for(request)
+        @stubs.find do |stub|
+          stub.match?(request)
+        end
+      end
+    end
+  end
+end

data/lib/capybara_mock/interceptor/cuprite.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'rack/utils'
+
+module CapybaraMock
+  module Interceptor
+    # Cuprite interceptor
+    class Cuprite < Base
+      # @see https://github.com/chromium/chromium/blob/main/net/http/http_status_code_list.h
+      SUPPORTED_STATUS_CODES = [
+        100,
+        101,
+        103,
+        *200..206,
+        300,
+        301,
+        302,
+        303,
+        304,
+        305,
+        307,
+        308,
+        *400..418,
+        425,
+        429,
+        *500..505
+      ].freeze
+
+      STATUS_CODE_HEADER_NAME = 'X-Mock-Response-Status'
+
+      private
+
+      def initialize(capybara_session)
+        super()
+        capybara_session.driver.browser.tap do |browser|
+          browser.network.intercept
+          browser.on(:request) { |request| call(request) }
+        end
+      end
+
+      def call(cuprite_request)
+        request = from_cuprite_request(cuprite_request)
+        stub = stub_for(request)
+        if stub
+          response = stub.call(request)
+          emulate_status_code!(response)
+          cuprite_response = to_cuprite_response(response)
+          cuprite_request.respond(**cuprite_response)
+        else
+          unstubbed_requests.push(request)
+          cuprite_request.continue
+        end
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        warn e
+        warn e.backtrace
+        raise e
+      end
+
+      def from_cuprite_request(request)
+        {
+          method: request.method,
+          url: URI(request.url).tap { |uri| uri.query = nil }.to_s,
+          query: Rack::Utils.parse_query(URI(request.url).query),
+          headers: request.headers,
+          body: request.instance_variable_get(:@request)['postData']
+        }
+      end
+
+      # Emulate status codes if it does not yet supported by CDP.
+      # It uses more generic status code and pass actual status code in header.
+      # Requires some client side middleware to finish emulation.
+      #
+      # @example
+      #   [422, {}, 'BODY'] => [400, {'X-Mock-Response-Status' => 422}, 'BODY']
+      #   [511, {}, 'BODY'] => [500, {'X-Mock-Response-Status' => 511}, 'BODY']
+      def emulate_status_code!(response)
+        status = response[0]
+        return if SUPPORTED_STATUS_CODES.include?(status)
+
+        response[0] = status.div(100) * 100
+        response[1] = response[1].merge(STATUS_CODE_HEADER_NAME => status.to_s)
+      end
+
+      def to_cuprite_response(response)
+        {
+          responseCode: response[0],
+          responseHeaders: response[1],
+          body: response[2]
+        }.compact
+      end
+    end
+  end
+end

data/lib/capybara_mock/rspec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'capybara_mock'
+
+RSpec.configure do |config|
+  config.after(:each, type: :feature) do
+    CapybaraMock.reset!
+  end
+end

data/lib/capybara_mock/stub.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'rack'
+require 'json'
+
+module CapybaraMock
+  # Stub DSL
+  class Stub
+    def initialize(method, url)
+      @method = method.to_s.upcase
+      @url = url
+      with
+      to_return
+    end
+
+    def with(query: {}, headers: {}, body: nil)
+      @query = query
+      @headers = headers
+      @body = body
+      self
+    end
+
+    def to_return(status: 200, headers: {}, body: '', &block)
+      @response = block || [status, headers, body]
+      self
+    end
+
+    def call(request)
+      if @response.respond_to?(:call)
+        @response.call(**request)
+      else
+        @response
+      end
+    end
+
+    def match?(request)
+      match_method?(request) &&
+        match_url?(request) &&
+        match_query?(request) &&
+        match_headers?(request) &&
+        match_body?(request)
+    end
+
+    def match_method?(request)
+      @method == request[:method]
+    end
+
+    def match_url?(request)
+      if @url.is_a?(Regexp)
+        @url.match?(request[:url])
+      else
+        @url == request[:url]
+      end
+    end
+
+    def match_query?(request)
+      @query == request[:query].slice(*@query.keys)
+    end
+
+    def match_headers?(request)
+      @headers == request[:headers].slice(*@headers.keys)
+    end
+
+    def match_body?(request)
+      return true unless @body
+
+      decode_body(@body) == decode_body(request[:body])
+    end
+
+    private
+
+    def decode_body(body)
+      case @headers['Content-Type']
+      when %r{application/x-www-form-urlencoded}
+        Rack::Utils.parse_nested_query(body)
+      when %r{application/json}
+        JSON.parse(body)
+      else
+        body
+      end
+    end
+  end
+end

data/lib/capybara_mock/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CapybaraMock
+  VERSION = '0.1.0'
+end

data/lib/capybara_mock.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require_relative 'capybara_mock/version'
+require_relative 'capybara_mock/stub'
+require_relative 'capybara_mock/interceptor/base'
+require_relative 'capybara_mock/interceptor/cuprite'
+
+# ## CapybaraMock
+#
+# Mock capybara browser http requests.
+#
+# @example Stub external requests using `stub_request`
+#
+#   CapybaraMock
+#     .stub_request(:get, 'http://example.com')
+#     .to_return(status: 200, headers: {}, body: 'Hello')
+#
+# @example Stub internal requests using `stub_path``
+#
+#   CapybaraMock
+#     .stub_path(:get, '/api/user/101')
+#     .to_return(status: 200, headers: {}, body: 'Hello')
+#
+# @example More strict stub
+#
+#   CapybaraMock
+#     .stub_request(:get, 'http://example.com')
+#     .with(
+#       query: {
+#         token: '12345678'
+#       },
+#       headers: {
+#         'Authorization' => 'Bearer 12345678',
+#         'Content-Type' => 'application/json'
+#       },
+#       body: {
+#         message: 'ping'
+#       }.to_json
+#     ).to_return(
+#       status: 200,
+#       headers: {
+#         'Content-Type' => 'application/json'
+#       },
+#       body: {
+#         message: 'pong'
+#       }.to_json
+#     )
+#
+# @example Dynamic stub based on actual request
+#
+#   CapybaraMock.stub_request(:get, /example/).to_return do |query:, **|
+#     state = query['state']
+#     [200, {'Location' => "http://localhost/foo?state={state}"}, '']
+#   end
+module CapybaraMock
+  class Error < StandardError; end
+
+  class << self
+    # Stub capybara request for current session using path.
+    #
+    # @param method [String]
+    # @param path [String]
+    # @return [CapybaraMock::Stub]
+    def stub_path(method, path, &block)
+      url = File.join(capybara_session.server.base_url, path)
+      stub_request(method, url, &block)
+    end
+
+    # Stub capybara request for current session using url.
+    # It also initialize interceptor for current session on first stub.
+    #
+    # @param method [String]
+    # @param url [String]
+    # @return [CapybaraMock::Stub]
+    def stub_request(method, url, &block)
+      Stub.new(method, url, &block).tap do |stub|
+        interceptor.stubs << stub
+      end
+    end
+
+    # Remove capybara stub from current session.
+    #
+    # @param stub [CapybaraMock::Stub]
+    def remove_stub(stub)
+      interceptor.stubs.delete(stub)
+    end
+
+    # Clear all current session stubs
+    def clear_stubs
+      interceptor.stubs.clear
+    end
+
+    # Save unstubbed requests to path.
+    def save_unstubbed_requests(path)
+      return false unless @interceptor && @interceptor.unstubbed_requests.present?
+
+      File.open(path, 'w') do |f|
+        @interceptor.unstubbed_requests.each do |request|
+          f.puts "#{request[:method]} #{request[:url]} #{request[:query]}"
+          request[:headers].each do |k, v|
+            f.puts "#{k}: #{v}"
+          end
+          f.puts request[:body]
+          f.puts
+        end
+      end
+
+      true
+    end
+
+    # Reset capybara mock interceptor.
+    def reset!
+      @interceptor = nil
+    end
+
+    private
+
+    def interceptor
+      @interceptor ||=
+        case capybara_session.driver.class.name
+        when 'Capybara::Cuprite::Driver'
+          CapybaraMock::Interceptor::Cuprite.new(capybara_session)
+        else
+          raise "Capybara driver is not supported: #{capybara_session.driver.class}"
+        end
+    end
+
+    def capybara_session
+      Capybara.current_session
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: capybara_mock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Railsware Products Studio LLC
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: CapybaraMock
+email:
+- support@mailtrap.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/capybara_mock.rb
+- lib/capybara_mock/interceptor/base.rb
+- lib/capybara_mock/interceptor/cuprite.rb
+- lib/capybara_mock/rspec.rb
+- lib/capybara_mock/stub.rb
+- lib/capybara_mock/version.rb
+homepage: https://github.com/railsware/capybara_mock
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/railsware/capybara_mock
+  source_code_uri: https://github.com/railsware/capybara_mock
+  changelog_uri: https://github.com/railsware/capybara_mock/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: CapybaraMock
+test_files: []