tcr 0.0.1 → 0.0.2

data/lib/tcr/cassette.rb

@@ -0,0 +1,40 @@
+module TCR
+  class Cassette
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+
+      if File.exists?(filename)
+        @recording = false
+        @contents = File.open(filename) { |f| f.read }
+        @sessions = JSON.parse(@contents)
+      else
+        @recording = true
+        @sessions = []
+      end
+    end
+
+    def recording?
+      @recording
+    end
+
+    def next_session
+      session = @sessions.shift
+      raise NoMoreSessionsError unless session
+      session
+    end
+
+    def append(session)
+      raise "Can't append session unless recording" unless recording?
+      @sessions << session
+      File.open(filename, "w") { |f| f.write(JSON.pretty_generate(@sessions)) }
+    end
+
+    protected
+
+    def filename
+      "#{TCR.configuration.cassette_library_dir}/#{name}.json"
+    end
+  end
+end

data/lib/tcr/errors.rb

@@ -1,5 +1,6 @@
 module TCR
   class TCRError < StandardError; end
   class NoCassetteError < TCRError; end
+  class NoMoreSessionsError < TCRError; end
   class DirectionMismatchError < TCRError; end
 end

data/lib/tcr/recordable_tcp_socket.rb

@@ -1,28 +1,29 @@
 module TCR
   class RecordableTCPSocket
-    attr_reader :live, :recording_file
-    attr_accessor :recordings
+    attr_reader :live, :cassette
+    attr_accessor :recording
 
-    def initialize(address, port, recording_file)
-      @recording_file = recording_file
+    def initialize(address, port, cassette)
+      raise TCR::NoCassetteError.new unless TCR.cassette
 
-      if File.exists?(recording_file)
-        @live = false
-        @recordings = JSON.parse(File.open(recording_file, "r") { |f| f.read })
-      else
+      if cassette.recording?
         @live = true
-        @recordings = []
         @socket = TCPSocket.real_open(address, port)
+        @recording = []
+      else
+        @live = false
+        @recording = cassette.next_session
       end
+      @cassette = cassette
     end
 
     def read_nonblock(bytes)
       if live
         data = @socket.read_nonblock(bytes)
-        recordings << ["read", data]
+        recording << ["read", data]
       else
-        direction, data = recordings.shift
-        raise DirectionMismatchError("Expected to 'read' but next in recording was 'write'") unless direction == "read"
+        direction, data = recording.shift
+        raise TCR::DirectionMismatchError.new("Expected to 'read' but next in recording was 'write'") unless direction == "read"
       end
 
       data
@@ -31,10 +32,10 @@ module TCR
     def write(str)
       if live
         len = @socket.write(str)
-        recordings << ["write", str]
+        recording << ["write", str]
       else
-        direction, data = recordings.shift
-        raise DirectionMismatchError("Expected to 'write' but next in recording was 'read'") unless direction == "write"
+        direction, data = recording.shift
+        raise TCR::DirectionMismatchError.new("Expected to 'write' but next in recording was 'read'") unless direction == "write"
         len = data.length
       end
 
@@ -58,7 +59,7 @@ module TCR
     def close
       if live
         @socket.close
-        File.open(recording_file, "w") { |f| f.write(JSON.pretty_generate(recordings)) }
+        cassette.append(recording)
       end
     end
   end

data/lib/tcr/version.rb

@@ -1,3 +1,3 @@
 module TCR
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/tcr.rb

@@ -1,3 +1,4 @@
+require "tcr/cassette"
 require "tcr/configuration"
 require "tcr/errors"
 require "tcr/recordable_tcp_socket"
@@ -17,23 +18,23 @@ module TCR
     @configuration ||= Configuration.new
   end
 
-  def current_cassette
-    raise TCR::NoCassetteError unless @current_cassette
-    @current_cassette
+  def cassette
+    @cassette
+  end
+
+  def cassette=(v)
+    @cassette = v
+  end
+
+  def save_session
   end
 
   def use_cassette(name, options = {}, &block)
     raise ArgumentError, "`TCR.use_cassette` requires a block." unless block
-    set_cassette(name)
+    TCR.cassette = Cassette.new(name)
     yield
     @current_cassette = nil
   end
-
-  protected
-
-  def set_cassette(name)
-    @current_cassette = "#{TCR.configuration.cassette_library_dir}/#{name}.json"
-  end
 end
 
 
@@ -44,7 +45,7 @@ class TCPSocket
 
     def open(address, port)
       if TCR.configuration.hook_tcp_ports.include?(port)
-        TCR::RecordableTCPSocket.new(address, port, TCR.current_cassette)
+        TCR::RecordableTCPSocket.new(address, port, TCR.cassette)
       else
         real_open(address, port)
       end

data/spec/fixtures/google_smtp.json

@@ -0,0 +1,8 @@
+[
+  [
+    [
+      "read",
+      "220 mx.google.com ESMTP x3si2474860qas.18 - gsmtp\r\n"
+    ]
+  ]
+]

data/spec/fixtures/multitest-smtp.json

@@ -0,0 +1,46 @@
+[
+  [
+    [
+      "read",
+      "220 mx.google.com ESMTP d8si2472149qai.124 - gsmtp\r\n"
+    ],
+    [
+      "write",
+      "EHLO localhost\r\n"
+    ],
+    [
+      "read",
+      "250-mx.google.com at your service, [54.227.243.167]\r\n250-SIZE 35882577\r\n250-8BITMIME\r\n250-STARTTLS\r\n250 ENHANCEDSTATUSCODES\r\n"
+    ],
+    [
+      "write",
+      "QUIT\r\n"
+    ],
+    [
+      "read",
+      "221 2.0.0 closing connection d8si2472149qai.124 - gsmtp\r\n"
+    ]
+  ],
+  [
+    [
+      "read",
+      "220 mta1579.mail.gq1.yahoo.com ESMTP YSmtpProxy service ready\r\n"
+    ],
+    [
+      "write",
+      "EHLO localhost\r\n"
+    ],
+    [
+      "read",
+      "250-mta1579.mail.gq1.yahoo.com\r\n250-8BITMIME\r\n250-SIZE 41943040\r\n250 PIPELINING\r\n"
+    ],
+    [
+      "write",
+      "QUIT\r\n"
+    ],
+    [
+      "read",
+      "221 mta1579.mail.gq1.yahoo.com\r\n"
+    ]
+  ]
+]

data/spec/fixtures/multitest.json

@@ -0,0 +1,14 @@
+[
+  [
+    [
+      "read",
+      "220 mx.google.com ESMTP h5si2286277qec.54 - gsmtp\r\n"
+    ]
+  ],
+  [
+    [
+      "read",
+      "220 mta1009.mail.gq1.yahoo.com ESMTP YSmtpProxy service ready\r\n"
+    ]
+  ]
+]

data/spec/tcr_spec.rb

@@ -1,6 +1,7 @@
 require "spec_helper"
 require "tcr"
 require "net/protocol"
+require "net/smtp"
 
 describe TCR do
   before(:each) do
@@ -44,10 +45,10 @@ describe TCR do
         c.hook_tcp_ports = [25]
         c.cassette_library_dir = "."
       }
-      File.unlink("./test.json") if File.exists?("./test.json")
+      File.unlink("test.json") if File.exists?("test.json")
     }
     after(:each) {
-      File.unlink("./test.json") if File.exists?("./test.json")
+      File.unlink("test.json") if File.exists?("test.json")
     }
 
     it "requires a block to call" do
@@ -72,8 +73,65 @@ describe TCR do
         line = io.readline
         tcp_socket.close
       end
-      file_contents = File.open("./test.json") { |f| f.read }
-      file_contents.include?("220 mx.google.com ESMTP").should == true
+      cassette_contents = File.open("test.json") { |f| f.read }
+      cassette_contents.include?("220 mx.google.com ESMTP").should == true
+    end
+
+    it "plays back tcp sessions without opening a real connection" do
+      expect(TCPSocket).to_not receive(:real_open)
+
+      TCR.use_cassette("spec/fixtures/google_smtp") do
+        tcp_socket = TCPSocket.open("aspmx.l.google.com", 25)
+        io = Net::InternetMessageIO.new(tcp_socket)
+        line = io.readline.should include("220 mx.google.com ESMTP")
+      end
+    end
+
+    it "raises an error if the recording gets out of order (i.e., we went to write but it expected a read)" do
+      expect {
+        TCR.use_cassette("spec/fixtures/google_smtp") do
+          tcp_socket = TCPSocket.open("aspmx.l.google.com", 25)
+          io = Net::InternetMessageIO.new(tcp_socket)
+          io.write("hi")
+        end
+      }.to raise_error(TCR::DirectionMismatchError)
+    end
+
+
+    context "multiple connections" do
+      it "records multiple sessions per cassette" do
+        TCR.use_cassette("test") do
+          smtp = Net::SMTP.start("aspmx.l.google.com", 25)
+          smtp.finish
+          smtp = Net::SMTP.start("mta6.am0.yahoodns.net", 25)
+          smtp.finish
+        end
+        cassette_contents = File.open("test.json") { |f| f.read }
+        cassette_contents.include?("google.com ESMTP").should == true
+        cassette_contents.include?("yahoo.com ESMTP").should == true
+      end
+
+      it "plays back multiple sessions per cassette in order" do
+        TCR.use_cassette("spec/fixtures/multitest") do
+          tcp_socket = TCPSocket.open("aspmx.l.google.com", 25)
+          io = Net::InternetMessageIO.new(tcp_socket)
+          line = io.readline.should include("google.com ESMTP")
+
+          tcp_socket = TCPSocket.open("mta6.am0.yahoodns.net", 25)
+          io = Net::InternetMessageIO.new(tcp_socket)
+          line = io.readline.should include("yahoo.com ESMTP")
+        end
+      end
+
+      it "raises an error if you try to playback more sessions than you previously recorded" do
+        expect {
+          TCR.use_cassette("spec/fixtures/multitest-smtp") do
+            smtp = Net::SMTP.start("aspmx.l.google.com", 25)
+            smtp = Net::SMTP.start("mta6.am0.yahoodns.net", 25)
+            smtp = Net::SMTP.start("mta6.am0.yahoodns.net", 25)
+          end
+        }.to raise_error(TCR::NoMoreSessionsError)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tcr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -57,10 +57,14 @@ files:
 - README.md
 - Rakefile
 - lib/tcr.rb
+- lib/tcr/cassette.rb
 - lib/tcr/configuration.rb
 - lib/tcr/errors.rb
 - lib/tcr/recordable_tcp_socket.rb
 - lib/tcr/version.rb
+- spec/fixtures/google_smtp.json
+- spec/fixtures/multitest-smtp.json
+- spec/fixtures/multitest.json
 - spec/spec_helper.rb
 - spec/tcr_spec.rb
 - tcr.gemspec
@@ -89,5 +93,8 @@ signing_key:
 specification_version: 3
 summary: TCR is a lightweight VCR for TCP sockets.
 test_files:
+- spec/fixtures/google_smtp.json
+- spec/fixtures/multitest-smtp.json
+- spec/fixtures/multitest.json
 - spec/spec_helper.rb
 - spec/tcr_spec.rb