simple-websocket-vcr 0.0.4 → 0.0.5

data/spec/fixtures/vcr_cassettes/VCR_for_WS/{should_record_the_closing_event.json → should_record_the_closing_event(json).json}

@@ -3,7 +3,7 @@
     {
       "operation": "read",
       "type": "text",
-      "data": "WelcomeResponse={\"sessionId\":\"2EmXcWEVbBBotTuwusO2-WJRX1oAuDEH9YdCd_Y5\"}"
+      "data": "WelcomeResponse={\"sessionId\":\"rfynzN_MQHaFvhedHpqiQj1zFo0hBHsiICU4pmX-\"}"
     },
     {
       "operation": "close"

data/spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_closing_event(yaml).yml

@@ -0,0 +1,6 @@
+---
+websocket_interactions:
+- - operation: read
+    type: text
+    data: WelcomeResponse={"sessionId":"3CEro9B5w8IUD4DAaVxRocyKm-rMVXLMlECNwfgD"}
+  - operation: close

data/spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_very_first_message_caught_on_the_client_yielded_by_the_connect_method.yml

@@ -0,0 +1,5 @@
+---
+websocket_interactions:
+- - operation: read
+    type: text
+    data: WelcomeResponse={"sessionId":"g-YqmCVcqkDqG7KkgzSzhd0qbeoM0fsVheOJ5jx8"}

data/spec/vcr_spec.rb

@@ -7,7 +7,7 @@ require 'json'
 #   alias real_sleep sleep
 #
 #   def sleep(*args)
-#     real_sleep(*args) if !VCR::WebSocket.cassette || VCR::WebSocket.cassette.recording?
+#     real_sleep(*args) if !WebSocketVCR.cassette || WebSocketVCR.cassette.recording?
 #   end
 # end
 
@@ -19,18 +19,18 @@ describe 'VCR for WS' do
   end
 
   let(:should_sleep) do |_|
-    !VCR::WebSocket.cassette || VCR::WebSocket.cassette.recording?
+    !WebSocketVCR.cassette || WebSocketVCR.cassette.recording?
   end
 
   before(:each) do
-    VCR::WebSocket.configuration.reset_defaults!
+    WebSocketVCR.configuration.reset_defaults!
   end
 
   it 'should record the very first message caught on the client yielded by the connect method' do
-    VCR::WebSocket.configure do |c|
+    WebSocketVCR.configure do |c|
       c.hook_uris = [HOST]
     end
-    VCR::WebSocket.record(example, self) do
+    WebSocketVCR.record(example, self) do
       url = "ws://#{HOST}/hawkular/command-gateway/ui/ws"
       c = WebSocket::Client::Simple.connect url do |client|
         client.on(:message, once: true, &:data)
@@ -43,10 +43,10 @@ describe 'VCR for WS' do
   end
 
   it 'should record also the outgoing communication' do
-    VCR::WebSocket.configure do |c|
+    WebSocketVCR.configure do |c|
       c.hook_uris = [HOST]
     end
-    VCR::WebSocket.record(example, self) do
+    WebSocketVCR.record(example, self) do
       url = "ws://#{HOST}/hawkular/command-gateway/ui/ws"
       c = WebSocket::Client::Simple.connect url do |client|
         client.on(:message, once: true, &:data)
@@ -61,53 +61,72 @@ describe 'VCR for WS' do
     end
   end
 
-  it 'should record the closing event' do
-    VCR::WebSocket.configure do |c|
-      c.hook_uris = [HOST]
+  def test_closing
+    url = "ws://#{HOST}/hawkular/command-gateway/ui/ws"
+    c = WebSocket::Client::Simple.connect url do |client|
+      client.on(:message, once: true, &:data)
     end
-    VCR::WebSocket.record(example, self) do
-      url = "ws://#{HOST}/hawkular/command-gateway/ui/ws"
-      c = WebSocket::Client::Simple.connect url do |client|
-        client.on(:message, once: true, &:data)
-      end
-      sleep 1 if should_sleep
+    sleep 1 if should_sleep
 
-      expect(c).not_to be nil
-      expect(c.open?).to be true
-      sleep 1 if should_sleep
-      c.close
-      expect(c.open?).to be false
+    expect(c).not_to be nil
+    expect(c.open?).to be true
+    sleep 1 if should_sleep
+    c.close
+    expect(c.open?).to be false
+  end
+
+  it 'should record the closing event(json)' do
+    WebSocketVCR.configure do |c|
+      c.hook_uris = [HOST]
+      c.json_cassettes = true
+    end
+    WebSocketVCR.record(example, self) do
+      test_closing
     end
   end
 
-  it 'should record complex communications' do
-    VCR::WebSocket.configure do |c|
+  it 'should record the closing event(yaml)' do
+    WebSocketVCR.configure do |c|
       c.hook_uris = [HOST]
     end
-    cassette_path = '/EXPLICIT/some_explicitly_specified_cassette.json'
-    VCR::WebSocket.use_cassette(cassette_path) do
-      url = "ws://#{HOST}/hawkular/command-gateway/ui/ws"
-      c = WebSocket::Client::Simple.connect url do |client|
-        client.on(:message, once: true, &:data)
-      end
-      sleep 1 if should_sleep
-      c.send('something_1')
-      c.on(:message, once: true, &:data)
-      sleep 1 if should_sleep
+    WebSocketVCR.record(example, self) do
+      test_closing
+    end
+  end
 
-      c.send('something_2')
-      c.on(:message, once: true, &:data)
-      sleep 1 if should_sleep
+  def test_complex
+    url = "ws://#{HOST}/hawkular/command-gateway/ui/ws"
+    c = WebSocket::Client::Simple.connect url do |client|
+      client.on(:message, once: true, &:data)
+    end
+    sleep 1 if should_sleep
+    c.send('something_1')
+    c.on(:message, once: true, &:data)
+    sleep 1 if should_sleep
 
-      expect(c).not_to be nil
-      expect(c.open?).to be true
-      c.close
-      expect(c.open?).to be false
-      sleep 1 if should_sleep
+    c.send('something_2')
+    c.on(:message, once: true, &:data)
+    sleep 1 if should_sleep
+
+    expect(c).not_to be nil
+    expect(c.open?).to be true
+    c.close
+    expect(c.open?).to be false
+    sleep 1 if should_sleep
+  end
+
+  it 'should record complex communications for json' do
+    WebSocketVCR.configure do |c|
+      c.hook_uris = [HOST]
+      c.json_cassettes = true
+    end
+    cassette_path = '/EXPLICIT/some_explicitly_specified_json_cassette'
+    WebSocketVCR.use_cassette(cassette_path) do
+      test_complex
     end
 
     # check that everything was recorded in the json file
-    file_path = VCR::WebSocket.configuration.cassette_library_dir + cassette_path
+    file_path = "#{WebSocketVCR.configuration.cassette_library_dir}#{cassette_path}.json"
     expect(File.readlines(file_path).grep(/WelcomeResponse/).size).to eq(1)
     # once in the client message and once in the GenericErrorResponse from the server
     expect(File.readlines(file_path).grep(/something_1/).size).to eq(2)
@@ -115,60 +134,144 @@ describe 'VCR for WS' do
     expect(File.readlines(file_path).grep(/close/).size).to eq(1)
   end
 
+  it 'should record complex communications for yaml' do
+    WebSocketVCR.configure do |c|
+      c.hook_uris = [HOST]
+    end
+    cassette_path = '/EXPLICIT/some_explicitly_specified_yaml_cassette'
+    WebSocketVCR.use_cassette(cassette_path) do
+      test_complex
+    end
+
+    # check that everything was recorded in the yaml file
+    file_path = "#{WebSocketVCR.configuration.cassette_library_dir}#{cassette_path}.yml"
+    expect(File.readlines(file_path).grep(/WelcomeResponse/).size).to eq(1)
+    expect(File.readlines(file_path).grep(/something_1/).size).to eq(2)
+    expect(File.readlines(file_path).grep(/something_2/).size).to eq(2)
+    expect(File.readlines(file_path).grep(/close/).size).to eq(1)
+  end
+
   context 'automatically picked cassette name is ok, when using context foo' do
     it 'and example bar' do
-      VCR::WebSocket.record(example, self) do
+      WebSocketVCR.record(example, self) do
         # nothing
       end
-      prefix = VCR::WebSocket.configuration.cassette_library_dir
-      name = 'automatically_picked_cassette_name_is_ok,_when_using_context_foo_and_example_bar.json'
+      prefix = WebSocketVCR.configuration.cassette_library_dir
+      name = 'automatically_picked_cassette_name_is_ok,_when_using_context_foo_and_example_bar.yml'
       expect(File.exist?(prefix + '/VCR_for_WS/' + name)).to be true
     end
   end
 
   describe 'automatically picked cassette name is ok, when describing parent' do
     it 'and example child1' do
-      VCR::WebSocket.record(example, self) do
+      WebSocketVCR.record(example, self) do
         # nothing
       end
-      prefix = VCR::WebSocket.configuration.cassette_library_dir
-      name = 'automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child1.json'
+      prefix = WebSocketVCR.configuration.cassette_library_dir
+      name = 'automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child1.yml'
       expect(File.exist?(prefix + '/VCR_for_WS/' + name)).to be true
     end
 
     it 'and example child2' do
-      VCR::WebSocket.record(example, self) do
+      WebSocketVCR.record(example, self) do
         # nothing
       end
-      prefix = VCR::WebSocket.configuration.cassette_library_dir
-      name = 'automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child2.json'
+      prefix = WebSocketVCR.configuration.cassette_library_dir
+      name = 'automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child2.yml'
+      expect(File.exist?(prefix + '/VCR_for_WS/' + name)).to be true
+    end
+
+    it 'and example child2 for json' do
+      WebSocketVCR.configure do |c|
+        c.json_cassettes = true
+      end
+      WebSocketVCR.record(example, self) do
+        # nothing
+      end
+      prefix = WebSocketVCR.configuration.cassette_library_dir
+      name = 'automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child2_for_json.json'
       expect(File.exist?(prefix + '/VCR_for_WS/' + name)).to be true
     end
   end
 
   describe '.configuration' do
     it 'has a default cassette location configured' do
-      expect(VCR::WebSocket.configuration.cassette_library_dir).to eq('spec/fixtures/vcr_cassettes')
+      expect(WebSocketVCR.configuration.cassette_library_dir).to eq('spec/fixtures/vcr_cassettes')
     end
 
     it 'has an empty list of hook ports by default' do
-      expect(VCR::WebSocket.configuration.hook_uris).to eq([])
+      expect(WebSocketVCR.configuration.hook_uris).to eq([])
     end
   end
 
   describe '.configure' do
     it 'configures cassette location' do
       expect do
-        VCR::WebSocket.configure { |c| c.cassette_library_dir = 'foo/bar' }
-      end.to change { VCR::WebSocket.configuration.cassette_library_dir }
+        WebSocketVCR.configure { |c| c.cassette_library_dir = 'foo/bar' }
+      end.to change { WebSocketVCR.configuration.cassette_library_dir }
         .from('spec/fixtures/vcr_cassettes')
         .to('foo/bar')
     end
 
     it 'configures URIs to hook' do
       expect do
-        VCR::WebSocket.configure { |c| c.hook_uris = ['127.0.0.1:1337'] }
-      end.to change { VCR::WebSocket.configuration.hook_uris }.from([]).to(['127.0.0.1:1337'])
+        WebSocketVCR.configure { |c| c.hook_uris = ['127.0.0.1:1337'] }
+      end.to change { WebSocketVCR.configuration.hook_uris }.from([]).to(['127.0.0.1:1337'])
+    end
+
+    it 'has an empty list of hook ports by default' do
+      expect(WebSocketVCR.configuration.hook_uris).to eq([])
+    end
+  end
+
+  context 'with cassette options' do
+    it 'with :record set to :none and no cassette, it should fail' do
+      prefix = WebSocketVCR.configuration.cassette_library_dir
+      cassette_path = '/EXPLICIT/something_nonexistent'
+      expect do
+        WebSocketVCR.use_cassette(cassette_path, record: :none) do
+          fail 'this code should not be reachable'
+        end
+      end.to raise_error(RuntimeError)
+      expect(File.exist?(prefix + cassette_path + '.yml')).to be false
+    end
+
+    def test_substitution(text1, text2 = nil)
+      url = "ws://#{HOST}/hawkular/command-gateway/ui/ws"
+      c = WebSocket::Client::Simple.connect url do |client|
+        client.on(:message, once: true) do |msg|
+          expect(msg.data).to include(text1)
+        end
+      end
+      sleep 1 if should_sleep
+      text2 ||= 'something_1'
+      c.send(text2)
+      c.on(:message, once: true) do |msg|
+        expect(msg.data).to include("Cannot deserialize: [#{text2}]")
+      end
+    end
+
+    it 'with :erb set to {something: 11223344}, it should replace the variable in yaml cassette' do
+      cassette_path = '/EXPLICIT/some_template'
+      WebSocketVCR.configure do |c|
+        c.hook_uris = [HOST]
+      end
+      WebSocketVCR.use_cassette(cassette_path, erb: { something: 11_223_344 }) do
+        test_substitution '11223344'
+      end
+      file_path = "#{WebSocketVCR.configuration.cassette_library_dir}#{cassette_path}.yml"
+      expect(File.readlines(file_path).grep(/<%= something %>/).size).to eq(1)
+    end
+
+    it 'with :erb set to {something: world, bar: hello}, it should replace the variables in json cassette' do
+      cassette_path = '/EXPLICIT/some_template'
+      WebSocketVCR.configure do |c|
+        c.hook_uris = [HOST]
+        c.json_cassettes = true
+      end
+      WebSocketVCR.use_cassette(cassette_path, erb: { something: 'world', bar: 'hello' }) do
+        test_substitution 'world', 'hello'
+      end
     end
   end
 end

metadata

@@ -1,127 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: simple-websocket-vcr
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jirka Kremser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: websocket-client-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.3.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 0.34.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 0.34.2
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.34.2
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.34.2
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: websocket-client-simple
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 description: Websocket VCR add-on
 email:
 - jkremser@redhat.com
@@ -143,16 +143,22 @@ files:
 - lib/simple_websocket_vcr/cassette.rb
 - lib/simple_websocket_vcr/configuration.rb
 - lib/simple_websocket_vcr/errors.rb
+- lib/simple_websocket_vcr/monkey_patch.rb
 - lib/simple_websocket_vcr/recordable_websocket_client.rb
 - lib/simple_websocket_vcr/version.rb
 - simple-websocket-vcr.gemspec
-- spec/fixtures/vcr_cassettes/EXPLICIT/some_explicitly_specified_cassette.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child1.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child2.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_using_context_foo_and_example_bar.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_also_the_outgoing_communication.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_closing_event.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_very_first_message_caught_on_the_client_yielded_by_the_connect_method.json
+- spec/fixtures/vcr_cassettes/EXPLICIT/some_explicitly_specified_json_cassette.json
+- spec/fixtures/vcr_cassettes/EXPLICIT/some_explicitly_specified_yaml_cassette.yml
+- spec/fixtures/vcr_cassettes/EXPLICIT/some_template.json
+- spec/fixtures/vcr_cassettes/EXPLICIT/some_template.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child1.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child2.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child2_for_json.json
+- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_using_context_foo_and_example_bar.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_also_the_outgoing_communication.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_closing_event(json).json
+- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_closing_event(yaml).yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_very_first_message_caught_on_the_client_yielded_by_the_connect_method.yml
 - spec/spec_helper.rb
 - spec/vcr_spec.rb
 homepage: https://github.com/Jiri-Kremser/simple-websocket-vcr
@@ -180,13 +186,18 @@ signing_key:
 specification_version: 4
 summary: simple_websocket_vcr is VCR add-on for websockets.
 test_files:
-- spec/fixtures/vcr_cassettes/EXPLICIT/some_explicitly_specified_cassette.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child1.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child2.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_using_context_foo_and_example_bar.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_also_the_outgoing_communication.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_closing_event.json
-- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_very_first_message_caught_on_the_client_yielded_by_the_connect_method.json
+- spec/fixtures/vcr_cassettes/EXPLICIT/some_explicitly_specified_json_cassette.json
+- spec/fixtures/vcr_cassettes/EXPLICIT/some_explicitly_specified_yaml_cassette.yml
+- spec/fixtures/vcr_cassettes/EXPLICIT/some_template.json
+- spec/fixtures/vcr_cassettes/EXPLICIT/some_template.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child1.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child2.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child2_for_json.json
+- spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_using_context_foo_and_example_bar.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_also_the_outgoing_communication.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_closing_event(json).json
+- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_closing_event(yaml).yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_very_first_message_caught_on_the_client_yielded_by_the_connect_method.yml
 - spec/spec_helper.rb
 - spec/vcr_spec.rb
 has_rdoc: