rspec-cassette 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a295971bad6b1f3461dd25a592349835c0944f587d6276098e53c3ac64468267
+  data.tar.gz: 4bde9b73040304c11eef974d844f11ffc97737989eabbe0ed8c9b1a3098c32a0
+SHA512:
+  metadata.gz: ef495ef8f33774e6433f6f5bcf1a97391bf056487562e52bb44e63f04e842faed96c3b84cef48e28f920acb6fc77523b4f5b725a0f412f578725c732a3fa0562
+  data.tar.gz: a8299f4c8a17f80c80f6dc7731017b4466fdcbc0e683fca9aa255d2d94985b209bf7216f945694d9a5f46944cd95ece2bb158dcd92aa0412fd9dcc8cad9f5d20

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0 (2026-02-16)
+
+- Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Yudai Takada
+
+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,96 @@
+# rspec-cassette
+
+Replay test suite's HTTP interactions as WebMock stubs in RSpec.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add rspec-cassette
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install rspec-cassette
+```
+
+## Usage
+
+Require the RSpec integration in your `spec_helper.rb` or `rails_helper.rb`:
+
+```ruby
+require "rspec/cassette/rspec_helper"
+
+Rspec::Cassette.configure do |config|
+  config.cassettes_dir = "spec/fixtures/cassettes"
+  config.default_match_on = %i[method uri]
+end
+```
+
+Helper method style:
+
+```ruby
+describe "API client" do
+  it "fetches users" do
+    use_cassette("users/index")
+    # ...
+  end
+end
+```
+
+Metadata style:
+
+```ruby
+it "fetches users", use_cassette: "users/index" do
+  # ...
+end
+```
+
+To pass match options per example:
+
+```ruby
+it "matches body", use_cassette: "users/index", cassette_options: { match_on: %i[method uri body] } do
+  # ...
+end
+```
+
+## Migration Guide
+
+Before:
+
+```ruby
+it "fetches users" do
+  VCR.use_cassette("users/index") do
+    # ...
+  end
+end
+```
+
+After:
+
+```ruby
+it "fetches users", use_cassette: "users/index" do
+  # ...
+end
+```
+
+## Configuration Options
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `cassettes_dir` | `spec/fixtures/cassettes` | Base directory for cassette files |
+| `default_match_on` | `[:method, :uri]` | WebMock matchers to apply |
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then run `bundle exec rspec` to execute the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ydah/rspec-cassette.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rspec/cassette/cassette.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "time"
+
+module RSpec
+  module Cassette
+    class Cassette
+      attr_reader :interactions, :path
+
+      def initialize(path)
+        @path = resolve_path(path)
+        @interactions = load_interactions(@path)
+      end
+
+      private
+
+      def resolve_path(path)
+        expanded = path.end_with?(".yml") ? path : "#{path}.yml"
+        return expanded if File.exist?(expanded)
+
+        raise CassetteNotFoundError, "Cassette not found: #{expanded}"
+      end
+
+      def load_interactions(path)
+        data = YAML.safe_load(
+          File.read(path),
+          permitted_classes: [Time, Symbol],
+          aliases: true
+        )
+
+        raw_interactions = Array(data.fetch("http_interactions"))
+        raw_interactions.map { |raw| Interaction.new(raw) }
+      rescue KeyError, Psych::Exception => e
+        raise CassetteParseError, "Cassette parse error: #{e.message}"
+      end
+    end
+  end
+end

data/lib/rspec/cassette/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Cassette
+    class Configuration
+      attr_accessor :cassettes_dir, :default_match_on
+
+      def initialize
+        @cassettes_dir = "spec/fixtures/cassettes"
+        @default_match_on = %i[method uri]
+      end
+    end
+  end
+end

data/lib/rspec/cassette/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Cassette
+    class Error < StandardError; end
+    class CassetteNotFoundError < Error; end
+    class CassetteParseError < Error; end
+  end
+end

data/lib/rspec/cassette/interaction.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Cassette
+    class Interaction
+      attr_reader :request, :response
+
+      def initialize(raw_interaction)
+        @request = raw_interaction.fetch("request")
+        @response = raw_interaction.fetch("response")
+      end
+
+      def method
+        request.fetch("method").to_sym
+      end
+
+      def uri
+        request.fetch("uri")
+      end
+
+      def request_headers
+        request.fetch("headers", {}) || {}
+      end
+
+      def request_body
+        body = request.fetch("body", {}) || {}
+        body.fetch("string", "")
+      end
+
+      def status
+        response.fetch("status", {}).fetch("code")
+      end
+
+      def response_headers
+        response.fetch("headers", {}) || {}
+      end
+
+      def response_body
+        body = response.fetch("body", {}) || {}
+        body.fetch("string", "")
+      end
+    end
+  end
+end

data/lib/rspec/cassette/rspec_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "rspec/cassette"
+
+module RSpec
+  module Cassette
+    module RSpecHelper
+      def use_cassette(name, **options)
+        cassette = Cassette.new(cassette_path(name))
+        StubRegistrar.new(cassette, match_on: options[:match_on]).register!
+      end
+
+      private
+
+      def cassette_path(name)
+        base_dir = RSpec::Cassette.configuration.cassettes_dir
+        File.join(base_dir, name)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Cassette::RSpecHelper
+
+  config.around(:each) do |example|
+    cassette_name = example.metadata[:use_cassette]
+    options = example.metadata[:cassette_options] || {}
+    use_cassette(cassette_name, **options) if cassette_name
+    example.run
+  end
+end

data/lib/rspec/cassette/stub_registrar.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "webmock"
+
+module RSpec
+  module Cassette
+    class StubRegistrar
+      def initialize(cassette, match_on: nil)
+        @cassette = cassette
+        @match_on = Array(match_on || RSpec::Cassette.configuration.default_match_on)
+      end
+
+      def register!
+        grouped_interactions.each do |(method, uri), interactions|
+          stub = WebMock.stub_request(method, uri)
+          stub = apply_matchers(stub, interactions.first)
+          stub.to_return(*interactions.map { |interaction| build_response(interaction) })
+        end
+      end
+
+      private
+
+      def grouped_interactions
+        @cassette.interactions.group_by { |interaction| [interaction.method, interaction.uri] }
+      end
+
+      def apply_matchers(stub, interaction)
+        matcher_options = {}
+        matcher_options[:body] = interaction.request_body if @match_on.include?(:body)
+        matcher_options[:headers] = interaction.request_headers if @match_on.include?(:headers)
+        return stub if matcher_options.empty?
+
+        stub.with(matcher_options)
+      end
+
+      def build_response(interaction)
+        {
+          status: interaction.status,
+          body: interaction.response_body,
+          headers: interaction.response_headers
+        }
+      end
+    end
+  end
+end

data/lib/rspec/cassette/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Cassette
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/cassette.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "cassette/version"
+require_relative "cassette/errors"
+require_relative "cassette/configuration"
+require_relative "cassette/cassette"
+require_relative "cassette/interaction"
+require_relative "cassette/stub_registrar"
+
+module RSpec
+  module Cassette
+    class << self
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+    end
+  end
+end

data/sig/rspec/cassette.rbs

@@ -0,0 +1,45 @@
+module RSpec
+  module Cassette
+    VERSION: String
+    class Error < StandardError
+    end
+
+    class CassetteNotFoundError < Error
+    end
+
+    class CassetteParseError < Error
+    end
+
+    class Configuration
+      attr_accessor cassettes_dir: String
+      attr_accessor default_match_on: Array[Symbol]
+    end
+
+    def self.configuration: () -> Configuration
+    def self.configure: () { (Configuration) -> void } -> void
+
+    class Interaction
+      attr_reader request: Hash[String, untyped]
+      attr_reader response: Hash[String, untyped]
+      def initialize: (Hash[String, untyped] raw_interaction) -> void
+      def method: () -> Symbol
+      def uri: () -> String
+      def request_headers: () -> Hash[String, Array[String]]
+      def request_body: () -> String
+      def status: () -> Integer
+      def response_headers: () -> Hash[String, Array[String]]
+      def response_body: () -> String
+    end
+
+    class Cassette
+      attr_reader interactions: Array[Interaction]
+      attr_reader path: String
+      def initialize: (String path) -> void
+    end
+
+    class StubRegistrar
+      def initialize: (Cassette cassette, ?match_on: Array[Symbol] | nil) -> void
+      def register!: () -> void
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rspec-cassette
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yudai Takada
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.14'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: Load test suite's HTTP interactions and register WebMock stubs for RSpec.
+email:
+- t.yudai92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec/cassette.rb
+- lib/rspec/cassette/cassette.rb
+- lib/rspec/cassette/configuration.rb
+- lib/rspec/cassette/errors.rb
+- lib/rspec/cassette/interaction.rb
+- lib/rspec/cassette/rspec_helper.rb
+- lib/rspec/cassette/stub_registrar.rb
+- lib/rspec/cassette/version.rb
+- sig/rspec/cassette.rbs
+homepage: https://github.com/ydah/rspec-cassette
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ydah/rspec-cassette
+  source_code_uri: https://github.com/ydah/rspec-cassette
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Replay test suite's HTTP interactions as WebMock stubs in RSpec.
+test_files: []