tcr 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab0a471bccd0a80a5d75bec6909dc521072b2ad666af34935f1d6ab596d9f2b4
-  data.tar.gz: eb6d9817d928173edd5354dc206fe7dd3e35a0f38ffde356e0e6e233e0a58431
+  metadata.gz: 2218fe9a2c9cb0c2c5c9d92f1e22c0a537985d45a37ca97b25e75b132984225c
+  data.tar.gz: d6db4c0a7d82b531f3517f2fa47a3e12cd2f530d3442dda6cbfca0fd2b9ba50f
 SHA512:
-  metadata.gz: cedcebdd9373876a73534581ef013945ab20912ba86b71375b14de26043c135420f5140a2c1cf9d920afc9eacaa9b2f567d173c5d2525aa60db19ac97f43f606
-  data.tar.gz: d41afdda3c2d24c85e461db3247fed88ed5c9019e0929251c03b199b37dc3dc7a261796c3266041aea90ffbdf9b0c6053a2e627a9e7b7258382430db85df66a9
+  metadata.gz: c274ad83970a61cb4c15e27d399a8d2efd099463fa2fa85b69c6b193b77f64f95d60effedb01f7c88641ac49ad24c5e3039317aec19ec874a7641f4173d8a208
+  data.tar.gz: 19d781dacbba3de87fe11e94d3d0598f94ee47976eef94dacb37688dfa45c3375329397076fa3ef2be327c22fdd985a29e1a5f37a245439b68be69d25d41055d

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @SalesLoft/tcr-maintainers

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/tcr.yml

@@ -7,33 +7,27 @@ on:
 
 jobs:
   test:
-    name: Test
+    name: "Test: Ruby ${{ matrix.ruby }}"
     runs-on: ubuntu-latest
-
     strategy:
+      fail-fast: false
       matrix:
         ruby:
-          - "2.0.0"
-          - "2.1.9"
-          - "2.2.10"
-          - "2.3.7"
-          - "2.4.4"
-          - "2.5.1"
-          - "2.7.3"
-          - "3.0.1"
-
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Initial setup
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-
-      - name: Install dependencies
-        run: bundle install
-
-      - name: Run tests
+          # runs 'bundle install' and caches installed gems automatically
+          bundler-cache: true
+      - name: Ruby Version
+        run: ruby --version
+      - name: Run Tests
         run: bundle exec rspec
 
   testall:

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 /.idea
+.tool-versions

data/Gemfile

@@ -1,4 +1,9 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in tcr.gemspec
 gemspec
+
+gem "rspec"
+gem "mail"
+gem "net-imap", "0.2.2"
+gem "net-ldap"
+gem "mime-types"

data/README.md

@@ -1,6 +1,6 @@
 # TCR (TCP + VCR)
 
-[![Build Status](https://travis-ci.org/robforman/tcr.png?branch=master)](https://travis-ci.org/robforman/tcr)
+![Build Status](https://github.com/SalesLoft/tcr/actions/workflows/tcr.yml/badge.svg)
 
 
 

data/Rakefile

@@ -1,4 +1,4 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new('spec')
+RSpec::Core::RakeTask.new("spec")
 task :default => :spec

data/lib/tcr/cassette.rb

@@ -16,7 +16,7 @@ module TCR
     end
 
     def recording?
-      @recording ||= !File.exists?(filename)
+      @recording ||= !File.exist?(filename)
     end
 
     def next_session

data/lib/tcr/version.rb

@@ -1,3 +1,3 @@
 module TCR
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

data/lib/tcr.rb

@@ -40,9 +40,10 @@ module TCR
   def use_cassette(name, options = {}, &block)
     raise ArgumentError, "`TCR.use_cassette` requires a block." unless block
     TCR.cassette = Cassette.new(name)
-    yield
+    ret_val = yield
     TCR.cassette.save
     TCR.cassette.check_hits_all_sessions if options[:hit_all] || configuration.hit_all
+    ret_val
   ensure
     TCR.cassette = nil
   end
@@ -51,8 +52,9 @@ module TCR
     raise ArgumentError, "`TCR.turned_off` requires a block." unless block
     current_hook_tcp_ports = configuration.hook_tcp_ports
     configuration.hook_tcp_ports = []
-    yield
+    ret_val = yield
     configuration.hook_tcp_ports = current_hook_tcp_ports
+    ret_val
   end
 end
 
@@ -88,11 +90,11 @@ class Socket
   class << self
     alias_method :real_tcp, :tcp
 
-    def tcp(host, port, *socket_opts)
+    def tcp(host, port, *local_args, **timeout_opts)
       if TCR.configuration.hook_tcp_ports.include?(port)
         TCR::RecordableTCPSocket.new(host, port, TCR.cassette)
       else
-        real_tcp(host, port, *socket_opts)
+        real_tcp(host, port, *local_args, **timeout_opts)
       end
     end
   end

data/spec/tcr_spec.rb

@@ -15,13 +15,13 @@ RSpec.describe TCR do
   end
 
   around(:each) do |example|
-    File.unlink("test.json") if File.exists?("test.json")
-    File.unlink("test.yaml") if File.exists?("test.yaml")
-    File.unlink("test.marshal") if File.exists?("test.marshal")
+    File.unlink("test.json") if File.exist?("test.json")
+    File.unlink("test.yaml") if File.exist?("test.yaml")
+    File.unlink("test.marshal") if File.exist?("test.marshal")
     example.run
-    File.unlink("test.json") if File.exists?("test.json")
-    File.unlink("test.yaml") if File.exists?("test.yaml")
-    File.unlink("test.marshal") if File.exists?("test.marshal")
+    File.unlink("test.json") if File.exist?("test.json")
+    File.unlink("test.yaml") if File.exist?("test.yaml")
+    File.unlink("test.marshal") if File.exist?("test.marshal")
   end
 
   describe ".configuration" do
@@ -119,6 +119,10 @@ RSpec.describe TCR do
       }.to raise_error(ArgumentError)
     end
 
+    it "returns the value" do
+      expect(TCR.turned_off { :foobar }).to eq(:foobar)
+    end
+
     it "disables hooks within the block" do
       TCR.configure { |c| c.hook_tcp_ports = [2525] }
       TCR.turned_off do
@@ -150,6 +154,10 @@ RSpec.describe TCR do
       }.to raise_error(TCR::NoCassetteError)
     end
 
+    it "returns the value" do
+      expect(TCR.use_cassette("test") { :foobar }).to eq(:foobar)
+    end
+
     it "requires a block to call" do
       expect {
         TCR.use_cassette("test")
@@ -214,7 +222,7 @@ RSpec.describe TCR do
           TCR.use_cassette("test") do
             tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
           end
-        }.to change{ File.exists?("./test.json") }.from(false).to(true)
+        }.to change{ File.exist?("./test.json") }.from(false).to(true)
       end
 
       it "records the tcp session data into the file" do
@@ -237,7 +245,7 @@ RSpec.describe TCR do
           TCR.use_cassette("test") do
             tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
           end
-        }.to change{ File.exists?("./test.yaml") }.from(false).to(true)
+        }.to change{ File.exist?("./test.yaml") }.from(false).to(true)
       end
 
       it "records the tcp session data into the yaml file" do
@@ -261,7 +269,7 @@ RSpec.describe TCR do
           TCR.use_cassette("test") do
             tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
           end
-        }.to change{ File.exists?("./test.marshal") }.from(false).to(true)
+        }.to change{ File.exist?("./test.marshal") }.from(false).to(true)
       end
 
       it "records the tcp session data into the marshalled file" do
@@ -515,4 +523,18 @@ RSpec.describe TCR do
       end
     }.not_to raise_error
   end
+
+  context "when port is not in hook_tcp_ports" do
+    it "it honors Socket.tcp keyword arguments" do
+      TCR.configure { |c|
+        c.hook_tcp_ports = [8080]
+        c.cassette_library_dir = "."
+      }
+
+      TCR.use_cassette("test") do
+        sock = Socket.tcp("google.com", 80, connect_timeout: 1, resolv_timeout: 1)
+        expect(sock).to be_a(Socket)
+      end
+    end
+  end
 end

data/tcr.gemspec

@@ -16,10 +16,4 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "mail"
-  gem.add_development_dependency "net-ldap"
-  gem.add_development_dependency "mime-types", "~>2.0"
-  gem.add_development_dependency "geminabox"
 end

metadata

@@ -1,85 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: tcr
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Rob Forman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mail
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: net-ldap
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: geminabox
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2024-11-27 00:00:00.000000000 Z
+dependencies: []
 description: TCR is a lightweight VCR for TCP sockets.
 email:
 - rob@robforman.com
@@ -87,9 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/dependabot.yml"
 - ".github/workflows/tcr.yml"
 - ".gitignore"
-- ".rvmrc"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -133,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: TCR is a lightweight VCR for TCP sockets.

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.3@tcr --create