tcr 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fefcbc3629fb40e1de900a369921440783e9640b
-  data.tar.gz: ff7b6ab916e2c94f44036b5d984606d3acac0941
+  metadata.gz: d304ca968d1155919b181710a474dd9a98a4f269
+  data.tar.gz: 67e7387321ce706d2b7dc1651bcbdc825ae682d1
 SHA512:
-  metadata.gz: 0848a1a7a8fb7088db93e61e5f0fda53a391768773a7dc8591b35ceb2e71270aa17d8347997b0594ca61eaf234600c26cf58d8274a971d6c18b54b03e9d7e4d4
-  data.tar.gz: 835f96abc00e39d5dff708d51a654a7f736826ffc265a3ec35ecfe27a82ef18681ee578e901a243978a4165b17c54b4beab674ffa3dd2a506bb63fbeb00d3436
+  metadata.gz: 051e136095dcd34c387d7638124bd453b6ba7134ea06bf784e1501fb04fe2c7d1f1ed11bd64a3edae17dd9bcea54f241be985901bf958cf1652aa129df9bffae
+  data.tar.gz: e9ffe3fc3379731f11a78ed2fb017480a8372d1ff2563019df12f704e9780e61c8ef5392ebe0057cb91b05940c7b5d7d820f492a161fd351d12ad541b1f652ae

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
 rvm:
-  - "1.9.3"
   - "2.0.0"
-  - "2.1.2"
-  - "2.2.2"
-  - "2.3.1"
+  - "2.1.10"
+  - "2.2.10"
+  - "2.3.7"
+  - "2.4.4"
+  - "2.5.1"
 before_install:
   - gem install bundler
 script: bundle exec rspec

data/README.md

@@ -6,7 +6,7 @@
 
 TCR is a *very* lightweight version of [VCR](https://github.com/vcr/vcr) for TCP sockets.
 
-Currently used for recording 'net/smtp' interactions so only a few of the TCPSocket methods are recorded out.
+Currently used for recording 'net/smtp', 'net/imap' and 'net/ldap' interactions so only a few of the TCPSocket methods are recorded out.
 
 ## Installation
 
@@ -87,6 +87,26 @@ TCR.configure do |c|
   c.hit_all = true
 end
 ```
+
+The following storage formats are supported:
+
+- JSON (default)
+- YAML
+- Marshal (recommended for binary data transfer like LDAP)
+
+You can configure them via:
+
+```ruby
+TCR.configure do |c|
+  c.format = 'json'
+  # or
+  c.format = 'yaml'
+  # or
+  c.format = 'marshal'
+end
+```
+
+
 ## Contributing
 
 1. Fork it

data/lib/tcr/cassette.rb

@@ -49,6 +49,8 @@ module TCR
         JSON.parse(content)
       when "yaml"
         YAML.load(content)
+      when "marshal"
+        Marshal.load(content)
       else
         raise RuntimeError.new "unrecognized format #{TCR.configuration.format}, please use `json` or `yaml`"
       end
@@ -60,6 +62,8 @@ module TCR
         JSON.pretty_generate(content)
       when "yaml"
         YAML.dump(content)
+      when "marshal"
+        Marshal.dump(content)
       else
         raise RuntimeError.new "unrecognized format #{TCR.configuration.format}, please use `json` or `yaml`"
       end

data/lib/tcr/net/ldap.rb

@@ -0,0 +1,19 @@
+# support LDAP(S) connections
+if defined? ::Net::LDAP
+
+  module Net::LDAP::Connection::FixSSLSocketSyncClose
+    def close
+      super
+      # see: https://github.com/ruby-ldap/ruby-net-ldap/pull/314
+      return if io.closed?
+      io.close
+    end
+  end
+
+  module TCR
+    class RecordableTCPSocket
+      include Net::LDAP::Connection::GetbyteForSSLSocket
+      include Net::BER::BERParser
+    end
+  end
+end

data/lib/tcr/recordable_tcp_socket.rb

@@ -17,7 +17,8 @@ module TCR
         @live = true
         @socket = TCPSocket.real_open(address, port)
       else
-        @live = false
+        @live   = false
+        @closed = false
       end
       @recording = cassette.next_session
     end
@@ -26,6 +27,10 @@ module TCR
       _read(:read, bytes)
     end
 
+    def getc(*args)
+      _read(:getc, *args)
+    end
+
     def gets(*args)
       _read(:gets, *args)
     end
@@ -53,13 +58,15 @@ module TCR
       if live
         @socket.closed?
       else
-        false
+        @closed
       end
     end
 
     def close
       if live
         @socket.close
+      else
+        @closed = true
       end
     end
 
@@ -86,8 +93,9 @@ module TCR
 
     def _write(method, data)
       if live
-        @socket.__send__(method, data)
-        recording << ["write", data.dup.to_s.force_encoding("UTF-8")]
+        payload = data.dup if !data.is_a?(Symbol)
+        @socket.__send__(method, payload)
+        recording << ["write", data.dup]
       else
         direction, data = recording.shift
         _ensure_direction("write", direction)
@@ -102,8 +110,9 @@ module TCR
       end
 
       if live
-          data = @socket.__send__(method, *args)
-          recording << ["read", data.to_s.force_encoding("UTF-8")]
+          data    = @socket.__send__(method, *args)
+          payload = data.dup if !data.is_a?(Symbol)
+          recording << ["read", payload]
       else
         _block_for_read_data if blocking && TCR.configuration.block_for_reads
         raise EOFError if recording.empty?

data/lib/tcr/version.rb

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

data/spec/tcr_spec.rb

@@ -4,6 +4,8 @@ require "net/protocol"
 require "net/http"
 require "net/imap"
 require "net/smtp"
+require "net/ldap"
+require "tcr/net/ldap"
 require 'thread'
 require "mail"
 
@@ -16,9 +18,11 @@ describe TCR do
   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")
     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")
   end
 
   describe ".configuration" do
@@ -179,6 +183,16 @@ describe TCR do
       }.to change{ File.exists?("./test.yaml") }.from(false).to(true)
     end
 
+    it "creates a cassette file on use with marshal" do
+      TCR.configure { |c| c.format = "marshal" }
+
+      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 file" do
       TCR.use_cassette("test") do
         tcp_socket = TCPSocket.open("smtp.mandrillapp.com", 2525)
@@ -376,4 +390,31 @@ describe TCR do
       sock.print("hello\n".freeze)
     end
   end
+
+  it "supports Net::LDAP connections" do
+    TCR.configure { |c|
+      c.hook_tcp_ports       = [389]
+      c.format               = 'marshal'
+      c.cassette_library_dir = "."
+    }
+    expect {
+      TCR.use_cassette("spec/fixtures/ldap") do
+        ldap = Net::LDAP.new(
+          host: 'ldap.forumsys.com',
+          port: 389,
+        )
+
+        ldap.auth 'cn=read-only-admin,dc=example,dc=com', 'password'
+
+        ldap.search(
+          base:          'DC=example,DC=com',
+          filter:        '(ou=mathematicians,dc=example,dc=com)',
+          scope:         Net::LDAP::SearchScope_WholeSubtree,
+          return_result: false
+        ) do |_entry|
+          break
+        end
+      end
+    }.not_to raise_error
+  end
 end

data/tcr.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
 
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcr
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob Forman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !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
@@ -84,12 +98,14 @@ files:
 - lib/tcr/cassette.rb
 - lib/tcr/configuration.rb
 - lib/tcr/errors.rb
+- lib/tcr/net/ldap.rb
 - lib/tcr/recordable_tcp_socket.rb
 - lib/tcr/version.rb
 - spec/fixtures/block_for_reads.json
 - spec/fixtures/email_with_image.eml
 - spec/fixtures/google_https.json
 - spec/fixtures/google_imap.json
+- spec/fixtures/ldap.marshal
 - spec/fixtures/mandrill_smtp.json
 - spec/fixtures/multitest-extra-smtp.json
 - spec/fixtures/multitest-smtp.json
@@ -127,6 +143,7 @@ test_files:
 - spec/fixtures/email_with_image.eml
 - spec/fixtures/google_https.json
 - spec/fixtures/google_imap.json
+- spec/fixtures/ldap.marshal
 - spec/fixtures/mandrill_smtp.json
 - spec/fixtures/multitest-extra-smtp.json
 - spec/fixtures/multitest-smtp.json