simple-websocket-vcr 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fcc25d2e22bc79b1a5359917af80ec0f10ae45e
-  data.tar.gz: 2736b6895d6da6e42d372e478e92fbeb6bd7d14a
+  metadata.gz: aa78b72b8e5e63014cea6cb0b968f16cf788309a
+  data.tar.gz: ed9327485f96b7ef2833e992a6d535b944603d7d
 SHA512:
-  metadata.gz: 6f1e61a02a7c1796460d423406c2d870035f74b761939983292423329ccca8ace7715576b38b45f6b3e2b2ec673bace43bb1045bd12484f54b5159eafbdc11b0
-  data.tar.gz: f1a278cbb9e3dc882113e5a4e83bdf31f2a81af8fb20aaa2f72c17fd69c23d382ff00bf82eb301aae52a4f0eec4bc1c3482f3c9ba2a4339c373a9005607f2b29
+  metadata.gz: 216074d87f86830bc8f0838e7fa49c5dc53323a6bbc8ebc9c8d9fd40c600628e22696723f7cd38f40b6038a68fa3778e9643284933f2a8eac50541c4fa47acce
+  data.tar.gz: 79922e89ebecf2b24ffef5433e66bd75f58969b815c2132ad88574d2ba19ffda089ee0c157ceb1f2b80e2467dd03e601c725d755989f08fede0756579fa024b2

data/CHANGES.md

@@ -3,7 +3,15 @@
 This document describes the relevant changes between releases of the
 _simple-websocket-vcr_ project.
 
-### 0.0.5 (not released yet)
+### 0.0.7 (not released yet)
+
+### 0.0.6
+* Reverse substitution for cassettes that have ERB. Basically, if we are recording and these options are passed: `erb: {some_key: some_value}, reverse_substitution: true`, then when the framework is about to store the `some_value` into cassette (JSON or YAML), the `<%= some_key =>` is stored instead of the value. So it allows to record the templates.
+* increasing the code coverage
+
+### 0.0.5
+* Now, there can be ERB in the cassettes (templating)
+* YAML cassettes support
 * version is aligned with the VCR module so that coverall could do its job properly (https://travis-ci.org/Jiri-Kremser/simple-websocket-vcr/jobs/118142774#L215)
 
 ### 0.0.4

data/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://travis-ci.org/Jiri-Kremser/simple-websocket-vcr.png?branch=master)](https://travis-ci.org/Jiri-Kremser/simple-websocket-vcr)
 [![Coverage](https://coveralls.io/repos/github/Jiri-Kremser/simple-websocket-vcr/badge.svg?branch=master)](https://coveralls.io/github/Jiri-Kremser/simple-websocket-vcr?branch=master)
+[![Code Climate](https://codeclimate.com/github/Jiri-Kremser/simple-websocket-vcr/badges/gpa.svg)](https://codeclimate.com/github/Jiri-Kremser/simple-websocket-vcr)
+[![Gem Version](https://badge.fury.io/rb/simple-websocket-vcr.svg)](https://badge.fury.io/rb/simple-websocket-vcr)
 
 
 TODO: this

data/lib/simple_websocket_vcr.rb

@@ -74,6 +74,8 @@ module WebSocketVCR
   # @param options [Hash] options for the cassette
   # @option options [Symbol] :record if set to :none there will be no recording
   # @option options [Symbol] :erb a sub-hash with variables used for ERB substitution in given cassette
+  # @option options [Boolean] :reverse_substitution if true, the values of :erb hash will be replaced by their names in
+  #                                                 the cassette. It's turned-off by default.
   def use_cassette(name, options = {})
     fail ArgumentError, '`VCR.use_cassette` requires a block.' unless block_given?
     self.cassette = Cassette.new(name, options)

data/lib/simple_websocket_vcr/cassette.rb

@@ -27,7 +27,13 @@ module WebSocketVCR
 
     def next_session
       if recording?
-        @sessions.push(@using_json ? RecordedJsonSession.new([]) : RecordedYamlSession.new([]))
+        erb_variables = @options[:reverse_substitution] ? @options[:erb] : nil
+        session = if @using_json
+                    RecordedJsonSession.new([], erb_variables)
+                  else
+                    RecordedYamlSession.new([], erb_variables)
+                  end
+        @sessions.push(session)
         @sessions.last
       else
         fail NoMoreSessionsError if @sessions.empty?
@@ -81,12 +87,18 @@ module WebSocketVCR
   class RecordedSession
     attr_reader :record_entries
 
-    def initialize(entries)
+    def initialize(entries, erb_variables = nil)
       @record_entries = entries
+      @erb_variables = erb_variables
     end
 
     def store(entry)
-      hash = entry.is_a?(RecordEntry) ? entry.attributes.map(&:to_s) : entry.map { |k, v| [k.to_s, v.to_s] }.to_h
+      hash = entry.is_a?(RecordEntry) ? entry.attributes.map(&:to_s) : Hash[entry.map { |k, v| [k.to_s, v.to_s] }]
+      if !hash['data'].nil? && !@erb_variables.nil?
+        @erb_variables.each do |k, v|
+          hash['data'].gsub! v.to_s, "<%= #{k} %>"
+        end
+      end
       @record_entries << hash
     end
 

data/lib/simple_websocket_vcr/version.rb

@@ -1,3 +1,3 @@
 module WebSocketVCR
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/spec/fixtures/vcr_cassettes/EXPLICIT/some_other_template.yml

@@ -0,0 +1,7 @@
+---
+websocket_interactions:
+- - operation: read
+    type: text
+    data: <%= something %>={"sessionId":"_5_u_6hSDOVe0LlvGyx32CGR-f98iKwHQtjoQKy8"}
+  - operation: write
+    data: something_1

data/spec/fixtures/vcr_cassettes/VCR_for_WS/.gitignore

@@ -0,0 +1 @@
+should_be_able_to_store_the_recording_with_real_communication_into_*

data/spec/vcr_spec.rb

@@ -13,13 +13,14 @@ require 'json'
 
 describe 'VCR for WS' do
   HOST = 'localhost:8080'.freeze
+  ON_TRAVIS = ENV['TRAVIS'] == 'true'
 
-  let(:example) do |e|
-    e
+  RSpec.configure do |c|
+    c.filter_run_excluding skip: true
   end
 
-  let(:should_sleep) do |_|
-    !WebSocketVCR.cassette || WebSocketVCR.cassette.recording?
+  let(:example) do |e|
+    e
   end
 
   before(:each) do
@@ -35,7 +36,7 @@ describe 'VCR for WS' do
       c = WebSocket::Client::Simple.connect url do |client|
         client.on(:message, once: true, &:data)
       end
-      sleep 1 if should_sleep
+      sleep 1 if WebSocketVCR.live?
 
       expect(c).not_to be nil
       expect(c.open?).to be true
@@ -47,11 +48,12 @@ describe 'VCR for WS' do
       c.hook_uris = [HOST]
     end
     WebSocketVCR.record(example, self) do
+      puts 'we are recording..' if WebSocketVCR.live?
       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 WebSocketVCR.live?
       c.send('something 1')
       c.send('something 2')
       c.send('something 3')
@@ -66,11 +68,11 @@ describe 'VCR for WS' do
     c = WebSocket::Client::Simple.connect url do |client|
       client.on(:message, once: true, &:data)
     end
-    sleep 1 if should_sleep
+    sleep 1 if WebSocketVCR.live?
 
     expect(c).not_to be nil
     expect(c.open?).to be true
-    sleep 1 if should_sleep
+    sleep 1 if WebSocketVCR.live?
     c.close
     expect(c.open?).to be false
   end
@@ -99,20 +101,20 @@ describe 'VCR for WS' do
     c = WebSocket::Client::Simple.connect url do |client|
       client.on(:message, once: true, &:data)
     end
-    sleep 1 if should_sleep
+    sleep 1 if WebSocketVCR.live?
     c.send('something_1')
     c.on(:message, once: true, &:data)
-    sleep 1 if should_sleep
+    sleep 1 if WebSocketVCR.live?
 
     c.send('something_2')
     c.on(:message, once: true, &:data)
-    sleep 1 if should_sleep
+    sleep 1 if WebSocketVCR.live?
 
     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
+    sleep 1 if WebSocketVCR.live?
   end
 
   it 'should record complex communications for json' do
@@ -243,7 +245,7 @@ describe 'VCR for WS' do
           expect(msg.data).to include(text1)
         end
       end
-      sleep 1 if should_sleep
+      sleep 1 if WebSocketVCR.live?
       text2 ||= 'something_1'
       c.send(text2)
       c.on(:message, once: true) do |msg|
@@ -256,7 +258,7 @@ describe 'VCR for WS' do
       WebSocketVCR.configure do |c|
         c.hook_uris = [HOST]
       end
-      WebSocketVCR.use_cassette(cassette_path, erb: { something: 11_223_344 }) do
+      WebSocketVCR.use_cassette(cassette_path, erb: { something: 11_223_344 }, record: :none) do
         test_substitution '11223344'
       end
       file_path = "#{WebSocketVCR.configuration.cassette_library_dir}#{cassette_path}.yml"
@@ -273,5 +275,84 @@ describe 'VCR for WS' do
         test_substitution 'world', 'hello'
       end
     end
+
+    it 'with :erb set to {something: 11223344}, and :reverse_substitution it should record the cassette as template' do
+      cassette_path = '/EXPLICIT/some_other_template'
+      WebSocketVCR.configure do |c|
+        c.hook_uris = [HOST]
+      end
+      WebSocketVCR.use_cassette(cassette_path, erb: { something: 'WelcomeResponse' }, reverse_substitution: true) do
+        test_substitution 'unlikely_string'
+      end
+      file_path = "#{WebSocketVCR.configuration.cassette_library_dir}#{cassette_path}.yml"
+      expect(File.readlines(file_path).grep(/<%= something %>/).size).to eq(1)
+    end
+  end
+
+  describe 'version' do
+    it 'should return the major, minor and micro components correctly' do
+      expect(WebSocketVCR.version).to include(WebSocketVCR.version.major.to_s)
+      expect(WebSocketVCR.version).to include(WebSocketVCR.version.minor.to_s)
+      expect(WebSocketVCR.version).to include(WebSocketVCR.version.patch.to_s)
+    end
+  end
+
+  def checks_for_echo_ws(file_path)
+    expect(File.readlines(file_path).grep(/hello/).size).to eq(2)
+    expect(File.readlines(file_path).grep(/how/).size).to eq(2)
+    expect(File.readlines(file_path).grep(/are/).size).to eq(2)
+    expect(File.readlines(file_path).grep(/you/).size).to eq(2)
+    expect(File.readlines(file_path).grep(/write/).size).to eq(4)
+    expect(File.readlines(file_path).grep(/read/).size).to eq(4)
+    expect(File.readlines(file_path).grep(/close/).size).to eq(1)
+  end
+
+  it 'should be able to store the recording with real communication into YAML', skip: !ON_TRAVIS do
+    WebSocketVCR.configure do |c|
+      c.hook_uris = ['echo.websocket.org']
+    end
+    WebSocketVCR.record(example, self) do
+      url = 'ws://echo.websocket.org'
+      c = WebSocket::Client::Simple.connect url do |client|
+        client.on(:message, &:data)
+      end
+      sleep 5 if WebSocketVCR.live?
+      c.send('hello')
+      c.send('how')
+      c.send('are')
+      c.send('you')
+      sleep 20 if WebSocketVCR.live?
+      c.close
+      expect(c.open?).to be false
+    end
+    # check that everything was recorded in the yaml file
+    cassette_name = 'VCR_for_WS/should_be_able_to_store_the_recording_with_real_communication_into_YAML.yml'
+    file_path = "#{WebSocketVCR.configuration.cassette_library_dir}/#{cassette_name}"
+    checks_for_echo_ws file_path
+  end
+
+  it 'should be able to store the recording with real communication into JSON', skip: !ON_TRAVIS do
+    WebSocketVCR.configure do |c|
+      c.hook_uris = ['echo.websocket.org']
+      c.json_cassettes = true
+    end
+    WebSocketVCR.record(example, self) do
+      url = 'ws://echo.websocket.org'
+      c = WebSocket::Client::Simple.connect url do |client|
+        client.on(:message, &:data)
+      end
+      sleep 5 if WebSocketVCR.live?
+      c.send('hello')
+      c.send('how')
+      c.send('are')
+      c.send('you')
+      sleep 20 if WebSocketVCR.live?
+      c.close
+      expect(c.open?).to be false
+    end
+    # check that everything was recorded in the json file
+    cassette_name = 'VCR_for_WS/should_be_able_to_store_the_recording_with_real_communication_into_JSON.json'
+    file_path = "#{WebSocketVCR.configuration.cassette_library_dir}/#{cassette_name}"
+    checks_for_echo_ws file_path
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-websocket-vcr
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jirka Kremser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-04 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-client-simple
@@ -149,8 +149,10 @@ files:
 - simple-websocket-vcr.gemspec
 - 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_other_template.yml
 - spec/fixtures/vcr_cassettes/EXPLICIT/some_template.json
 - spec/fixtures/vcr_cassettes/EXPLICIT/some_template.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/.gitignore
 - 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
@@ -188,8 +190,10 @@ summary: simple_websocket_vcr is VCR add-on for websockets.
 test_files:
 - 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_other_template.yml
 - spec/fixtures/vcr_cassettes/EXPLICIT/some_template.json
 - spec/fixtures/vcr_cassettes/EXPLICIT/some_template.yml
+- spec/fixtures/vcr_cassettes/VCR_for_WS/.gitignore
 - 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