tcr 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d304ca968d1155919b181710a474dd9a98a4f269
-  data.tar.gz: 67e7387321ce706d2b7dc1651bcbdc825ae682d1
+  metadata.gz: 228eadaf6c734a9281952492ab146d7fee17e246
+  data.tar.gz: 64045b81372a13b4d957ea02bd266b5c7c443d3a
 SHA512:
-  metadata.gz: 051e136095dcd34c387d7638124bd453b6ba7134ea06bf784e1501fb04fe2c7d1f1ed11bd64a3edae17dd9bcea54f241be985901bf958cf1652aa129df9bffae
-  data.tar.gz: e9ffe3fc3379731f11a78ed2fb017480a8372d1ff2563019df12f704e9780e61c8ef5392ebe0057cb91b05940c7b5d7d820f492a161fd351d12ad541b1f652ae
+  metadata.gz: 1210aebd2ec013acb28546caeae5b29022e8cd7ddee1cb9e7814140c86d6e8fcc351798b10b2d2637baf104b7617719d3f28001bb3cde4cfee4821fa697625a5
+  data.tar.gz: d05fc665286ace6c2b77c6f30890aff288e872344da943a2f5c09afcf468c8c7b82acbabff10f227092fc6322aabbbf9cf82a0c10cdc758b07e004533110d84f

data/lib/tcr/cassette.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module TCR
   class Cassette
     attr_reader :name
@@ -5,18 +7,16 @@ module TCR
     def initialize(name)
       @name = name
 
-      if File.exists?(filename)
-        @recording = false
-        @contents = File.open(filename) { |f| f.read }
-        @sessions = unmarshal(@contents)
-      else
-        @recording = true
+      if recording?
+        verify_cassette_path_is_writable
         @sessions = []
+      else
+        @sessions = unmarshal(File.read(filename))
       end
     end
 
     def recording?
-      @recording
+      @recording ||= !File.exists?(filename)
     end
 
     def next_session
@@ -30,9 +30,10 @@ module TCR
     end
 
     def save
-      if recording?
-        File.open(filename, "w") { |f| f.write(marshal(@sessions)) }
-      end
+      return if !recording?
+      File.write(filename, marshal(@sessions))
+    rescue Encoding::UndefinedConversionError
+      File.binwrite(filename, marshal(@sessions))
     end
 
     def check_hits_all_sessions
@@ -52,7 +53,8 @@ module TCR
       when "marshal"
         Marshal.load(content)
       else
-        raise RuntimeError.new "unrecognized format #{TCR.configuration.format}, please use `json` or `yaml`"
+        raise "unrecognized cassette format '#{TCR.configuration.format}'; " \
+              "please use one of 'json', 'yaml', or 'marshal'"
       end
     end
 
@@ -65,12 +67,18 @@ module TCR
       when "marshal"
         Marshal.dump(content)
       else
-        raise RuntimeError.new "unrecognized format #{TCR.configuration.format}, please use `json` or `yaml`"
+        raise "unrecognized cassette format '#{TCR.configuration.format}'; " \
+              "please use one of 'json', 'yaml', or 'marshal'"
       end
     end
 
     def filename
       "#{TCR.configuration.cassette_library_dir}/#{name}.#{TCR.configuration.format}"
     end
+
+    def verify_cassette_path_is_writable
+      FileUtils.mkdir_p(File.dirname(filename))
+      FileUtils.touch(filename)
+    end
   end
 end

data/lib/tcr/version.rb

@@ -1,3 +1,3 @@
 module TCR
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/tcr_spec.rb

@@ -6,11 +6,10 @@ require "net/imap"
 require "net/smtp"
 require "net/ldap"
 require "tcr/net/ldap"
-require 'thread'
 require "mail"
 
 
-describe TCR do
+RSpec.describe TCR do
   before(:each) do
     TCR.configuration.reset_defaults!
   end
@@ -37,44 +36,44 @@ describe TCR do
      it "defaults to erroring on read/write mismatch access" do
        TCR.configuration.block_for_reads.should be_falsey
      end
-     
+
      it "defaults to hit all to false" do
        TCR.configuration.hit_all.should be_falsey
      end
    end
 
-   describe ".configure" do
-     it "configures cassette location" do
-       expect {
-         TCR.configure { |c| c.cassette_library_dir = "some/dir" }
-       }.to change{ TCR.configuration.cassette_library_dir }.from("fixtures/tcr_cassettes").to("some/dir")
-     end
+  describe ".configure" do
+    it "configures cassette location" do
+      expect {
+        TCR.configure { |c| c.cassette_library_dir = "some/dir" }
+      }.to change{ TCR.configuration.cassette_library_dir }.from("fixtures/tcr_cassettes").to("some/dir")
+    end
 
-     it "configures tcp ports to hook" do
-       expect {
-         TCR.configure { |c| c.hook_tcp_ports = [2525] }
-       }.to change{ TCR.configuration.hook_tcp_ports }.from([]).to([2525])
-     end
+    it "configures tcp ports to hook" do
+      expect {
+        TCR.configure { |c| c.hook_tcp_ports = [2525] }
+      }.to change{ TCR.configuration.hook_tcp_ports }.from([]).to([2525])
+    end
 
-     it "configures allowing a blocking read mode" do
-       expect {
-         TCR.configure { |c| c.block_for_reads = true }
-       }.to change{ TCR.configuration.block_for_reads }.from(false).to(true)
-     end
-     
-     it "configures to check if all sesstions was hit" do
-       expect {
-         TCR.configure { |c| c.hit_all = true }
-       }.to change{ TCR.configuration.hit_all }.from(false).to(true)
-     end
-   end
+    it "configures allowing a blocking read mode" do
+      expect {
+        TCR.configure { |c| c.block_for_reads = true }
+      }.to change{ TCR.configuration.block_for_reads }.from(false).to(true)
+    end
 
-   it "raises an error if you connect to a hooked port without using a cassette" do
-     TCR.configure { |c| c.hook_tcp_ports = [2525] }
-     expect {
-       tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
-     }.to raise_error(TCR::NoCassetteError)
-   end
+    it "configures to check if all sesstions was hit" do
+      expect {
+        TCR.configure { |c| c.hit_all = true }
+      }.to change{ TCR.configuration.hit_all }.from(false).to(true)
+    end
+  end
+
+  it "raises an error if you connect to a hooked port without using a cassette" do
+    TCR.configure { |c| c.hook_tcp_ports = [2525] }
+    expect {
+      tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
+    }.to raise_error(TCR::NoCassetteError)
+  end
 
   describe ".turned_off" do
     it "requires a block to call" do
@@ -151,6 +150,44 @@ describe TCR do
       }.to raise_error(ArgumentError)
     end
 
+    context "when path to cassette does not exist" do
+      let(:unique_dirname) { Dir.entries(".").sort.last.next }
+
+      around do |example|
+        expect(Dir.exist?(unique_dirname)).to be(false)
+        example.run
+        FileUtils.rm_rf(unique_dirname)
+      end
+
+      it "creates it" do
+        expect { TCR.use_cassette("#{unique_dirname}/foo/bar/test") { } }.not_to raise_error
+      end
+    end
+
+    context "when path to cassette is not writable" do
+      let(:unique_dirname) { Dir.entries(".").sort.last.next }
+
+      around do |example|
+        FileUtils.mkdir(unique_dirname)
+        FileUtils.chmod("u-w", unique_dirname)
+        expect { FileUtils.touch("#{unique_dirname}/foo") }.to raise_error(Errno::EACCES)
+        example.run
+        FileUtils.rm_rf(unique_dirname)
+      end
+
+      it "raises error BEFORE block runs" do
+        allow(TCPSocket).to receive(:open)
+
+        expect do
+          TCR.use_cassette("#{unique_dirname}/foo") do
+            TCPSocket.open("smtp.mandrillapp.com", 2525)
+          end
+        end.to raise_error(Errno::EACCES)
+
+        expect(TCPSocket).not_to have_received(:open)
+      end
+    end
+
     it "resets the cassette after use" do
       expect(TCR.cassette).to be_nil
       TCR.use_cassette("test") { }
@@ -165,57 +202,86 @@ describe TCR do
       expect(TCR.cassette).to be_nil
     end
 
-    it "creates a cassette file on use" do
-      expect {
+    context "when configured for JSON format" do
+      it "creates a cassette file on use" do
+        expect {
+          TCR.use_cassette("test") do
+            tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
+          end
+        }.to change{ File.exists?("./test.json") }.from(false).to(true)
+      end
+
+      it "records the tcp session data into the file" do
         TCR.use_cassette("test") do
           tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
+          io = Net::InternetMessageIO.new(tcp_socket)
+          line = io.readline
+          tcp_socket.close
         end
-      }.to change{ File.exists?("./test.json") }.from(false).to(true)
+        cassette_contents = File.open("test.json") { |f| f.read }
+        cassette_contents.include?("220 smtp.mandrillapp.com ESMTP").should == true
+      end
     end
 
-    it "creates a cassette file on use with yaml" do
-      TCR.configure { |c| c.format = "yaml" }
+    context "when configured for YAML format" do
+      before { TCR.configure { |c| c.format = "yaml" } }
 
-      expect {
+      it "creates a cassette file on use with yaml" do
+        expect {
+          TCR.use_cassette("test") do
+            tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
+          end
+        }.to change{ File.exists?("./test.yaml") }.from(false).to(true)
+      end
+
+      it "records the tcp session data into the yaml file" do
         TCR.use_cassette("test") do
           tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
+          io = Net::InternetMessageIO.new(tcp_socket)
+          line = io.readline
+          tcp_socket.close
         end
-      }.to change{ File.exists?("./test.yaml") }.from(false).to(true)
+        cassette_contents = File.open("test.yaml") { |f| f.read }
+        cassette_contents.include?("---").should == true
+        cassette_contents.include?("220 smtp.mandrillapp.com ESMTP").should == true
+      end
     end
 
-    it "creates a cassette file on use with marshal" do
-      TCR.configure { |c| c.format = "marshal" }
+    context "when configured for Marshal format" do
+      before { TCR.configure { |c| c.format = "marshal" } }
 
-      expect {
+      it "creates a cassette file on use with marshal" do
+        expect {
+          TCR.use_cassette("test") do
+            tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
+          end
+        }.to change{ File.exists?("./test.marshal") }.from(false).to(true)
+      end
+
+      it "records the tcp session data into the marshalled file" do
         TCR.use_cassette("test") do
           tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
+          io = Net::InternetMessageIO.new(tcp_socket)
+          line = io.readline
+          tcp_socket.close
         end
-      }.to change{ File.exists?("./test.marshal") }.from(false).to(true)
-    end
-
-    it "records the tcp session data into the file" do
-      TCR.use_cassette("test") do
-        tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
-        io = Net::InternetMessageIO.new(tcp_socket)
-        line = io.readline
-        tcp_socket.close
+        unmarshalled_cassette = Marshal.load(File.read("test.marshal"))
+        expect(unmarshalled_cassette).to be_a(Array)
+        expect(unmarshalled_cassette.first.last.last).to eq("220 smtp.mandrillapp.com ESMTP\r\n")
       end
-      cassette_contents = File.open("test.json") { |f| f.read }
-      cassette_contents.include?("220 smtp.mandrillapp.com ESMTP").should == true
-    end
 
-    it "records the tcp session data into the yaml file" do
-      TCR.configure { |c| c.format = "yaml" }
+      context "when Encoding.default_internal == Encoding::UTF_8 (as in Rails)" do
+        before { Encoding.default_internal = Encoding::UTF_8 }
+        let(:invalid_unicode_string) { "\u0001\u0001\u0004€" }
 
-      TCR.use_cassette("test") do
-        tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
-        io = Net::InternetMessageIO.new(tcp_socket)
-        line = io.readline
-        tcp_socket.close
+        it "doesn't fail on cassettes with binary content" do
+          expect do
+            TCR.use_cassette("test") do
+              TCR.cassette.instance_variable_get(:@sessions) << ["read", invalid_unicode_string]
+            end
+          end.not_to raise_error
+        end
       end
-      cassette_contents = File.open("test.yaml") { |f| f.read }
-      cassette_contents.include?("---").should == true
-      cassette_contents.include?("220 smtp.mandrillapp.com ESMTP").should == true
     end
 
     it "plays back tcp sessions without opening a real connection" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Rob Forman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec