simple-websocket-vcr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db5656145b23681ce7430ff7033e3bbb40f2a56b
+  data.tar.gz: abd01476ee358c3a897f44d99afeee61e3bf2856
+SHA512:
+  metadata.gz: 56a331b9c80dbed37bbda8f3598886f8ac325868c6a845cd721640fea1992e002f0d4097a16c63a67b35ac92bf8cd2c815f26f0adf4c2912236ea88fc2f04a55
+  data.tar.gz: 8824ae144e9cfcb09628fcb58d94be3f88bdcf5c95d32c8e178beb1a79a5204ac5387c8b245052ba5c9fb97315bdce8e02fcc8379309714c89bd580343854adb

data/.gitignore

@@ -0,0 +1,50 @@
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# test config
+spec/endpoint.yml
+
+# IDE files
+.project
+.classpath
+.settings
+.idea
+*.ipr
+*.iml
+*.iws
+nb-configuration.xml
+
+# KDE
+.directory
+
+# OSX
+.DS_Store
+
+# Ruby
+*.gem
+*.rbc
+.bundle
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+*.gem
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,26 @@
+# possible values:
+# https://github.com/bbatsov/rubocop/blob/master/config/
+
+#
+# Overrides
+#
+CyclomaticComplexity:
+  Severity: refactor
+Metrics/LineLength:
+  Max: 120
+
+#
+# Enabled/Disabled
+#
+ClassLength:
+  Enabled: false
+Documentation:
+  Enabled: false
+MethodLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+ModuleLength:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3

data/CHANGES.md

@@ -0,0 +1,8 @@
+## Changes
+
+This document describes the relevant changes between releases of the
+_simple-websocket-vcr_ project.
+
+### V 0.0.1
+
+* First release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple-websocket-vcr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,5 @@
+# Simple websocket VCR
+
+[![Build Status](https://travis-ci.org/Jiri-Kremser/simple-websocket-vcr.png?branch=master)](https://travis-ci.org/Jiri-Kremser/simple-websocket-vcr)
+
+TODO: this

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task default: :spec

data/lib/vcr.rb

@@ -0,0 +1,99 @@
+require 'vcr/cassette'
+require 'vcr/configuration'
+require 'vcr/errors'
+require 'vcr/recordable_websocket_client'
+require 'vcr/version'
+require 'json'
+require 'websocket-client-simple'
+
+module VCR
+  module WebSocket
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def cassette
+      @cassette
+    end
+
+    def cassette=(v)
+      @cassette = v
+    end
+
+    def disabled
+      @disabled || false
+    end
+
+    def disabled=(v)
+      @disabled = v
+    end
+
+    def save_session
+    end
+
+    def use_cassette(name, _options = {})
+      raise ArgumentError, '`VCR.use_cassette` requires a block.' unless block_given?
+      self.cassette = Cassette.new(name)
+      yield
+      cassette.save
+      self.cassette = nil
+    end
+
+    def record(example, context, options = {}, &block)
+      raise ArgumentError, '`VCR.record` requires a block.' unless block_given?
+      name = filename_helper(example, context)
+      use_cassette(name, options, &block)
+    end
+
+    def turn_off!(options = {})
+      # TODO: impl
+    end
+
+    def turned_on?
+      # TODO: impl
+    end
+
+    def turn_on!
+      # TODO: impl
+    end
+
+    private
+
+    def filename_helper(example, context)
+      if context.class.metadata[:parent_example_group].nil?
+        example_name = example.description.gsub(/\s+/, '_')
+        directory = context.class.metadata[:description].gsub(/\s+/, '_')
+      else
+        example_name = "#{context.class.metadata[:description]}_#{example.description}".gsub(/\s+/, '_')
+        directory = context.class.metadata[:parent_example_group][:description].gsub(/\s+/, '_')
+      end
+      "#{directory}/#{example_name}.json"
+    end
+
+    module_function :configure, :configuration, :cassette, :cassette=, :disabled, :disabled=, :save_session,
+                    :use_cassette, :record, :turn_off!, :turned_on?, :turn_on!, :filename_helper
+  end
+end
+
+module WebSocket::Client::Simple
+  class << self
+    alias real_connect connect
+
+    def connect(url, options = {})
+      if VCR::WebSocket.configuration.hook_uris.any? { |u| url.include?(u) }
+        cassette = VCR::WebSocket.cassette
+        live = cassette.recording?
+        real_client = real_connect(url, options) if live
+        fake_client = VCR::WebSocket::RecordableWebsocketClient.new(cassette, live ? real_client : nil)
+        yield fake_client if block_given?
+        fake_client
+      else
+        real_connect(url, options)
+      end
+    end
+  end
+end

data/lib/vcr/cassette.rb

@@ -0,0 +1,51 @@
+require 'vcr/errors'
+require 'fileutils'
+
+module VCR
+  module WebSocket
+    include Errors
+
+    class Cassette
+      attr_reader :name, :recording
+
+      alias recording? recording
+
+      def initialize(name)
+        @name = name
+
+        if File.exist?(filename)
+          @recording = false
+          @contents = File.open(filename, &:read)
+          @sessions = JSON.parse(@contents)
+        else
+          @recording = true
+          @sessions = []
+        end
+      end
+
+      def next_session
+        if recording?
+          @sessions << []
+          @sessions.last
+        else
+          raise NoMoreSessionsError if @sessions.empty?
+          @sessions.shift
+        end
+      end
+
+      def save
+        if recording?
+          dirname = File.dirname(filename)
+          FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+          File.open(filename, 'w') { |f| f.write(JSON.pretty_generate(@sessions)) }
+        end
+      end
+
+      protected
+
+      def filename
+        "#{VCR::WebSocket.configuration.cassette_library_dir}/#{name}"
+      end
+    end
+  end
+end

data/lib/vcr/configuration.rb

@@ -0,0 +1,16 @@
+module VCR
+  module WebSocket
+    class Configuration
+      attr_accessor :cassette_library_dir, :hook_uris
+
+      def initialize
+        reset_defaults!
+      end
+
+      def reset_defaults!
+        @cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+        @hook_uris = []
+      end
+    end
+  end
+end

data/lib/vcr/errors.rb

@@ -0,0 +1,11 @@
+module VCR
+  module WebSocket
+    module Errors
+      class VCRError < StandardError; end
+      class OperationMismatchError < VCRError; end
+      class DataMismatchError < VCRError; end
+      class NoCassetteError < VCRError; end
+      class NoMoreSessionsError < VCRError; end
+    end
+  end
+end

data/lib/vcr/recordable_websocket_client.rb

@@ -0,0 +1,112 @@
+require 'delegate'
+require 'websocket-client-simple'
+require 'base64'
+require 'vcr/errors'
+
+module VCR
+  module WebSocket
+    include Errors
+
+    class RecordableWebsocketClient
+      include EventEmitter
+
+      attr_reader :live, :client
+      attr_accessor :recording, :open
+
+      def initialize(cassette, real_client)
+        raise NoCassetteError 'specify the cassette' unless cassette
+
+        if cassette.recording?
+          @live = true
+          @client = real_client
+        else
+          @live = false
+          @open = true
+        end
+        @recording = cassette.next_session
+      end
+
+      def send(data_param, opt = { type: :text })
+        data = data_param.dup
+        data = Base64.encode64(data) if opt[:type] != :text
+        _write(:send, data, opt)
+      end
+
+      # or on
+      def on(event, params = {}, &block)
+        _read(:add_listener, event, params, &block)
+      end
+
+      def emit(event, *data)
+        @recording << { operation: 'read', data: data } if live
+        super(event, *data)
+      end
+
+      def open?
+        if live
+          @client.open?
+        else
+          @open
+        end
+      end
+
+      def close
+        if live
+          @recording << { operation: 'close' }
+          @client.close
+        else
+          record = @recording.shift
+          _ensure_operation('close', record['operation'])
+          @open = false
+        end
+      end
+
+      private
+
+      def _write(method, data, opt)
+        if live
+          @client.__send__(method, data, opt)
+          @recording << { operation: 'write', data: data }
+        else
+          record = @recording.shift
+          _ensure_operation('write', record['operation'])
+          _ensure_data(data, record['data'])
+        end
+      end
+
+      def _read(method, event, params, &block)
+        if live
+          rec = @recording
+          @client.on(event, params) do |msg|
+            msg = Base64.decode64(msg) if msg.type != :text
+            rec << { operation: 'read', type: msg.type, data: msg }
+            yield(msg)
+          end
+          @client.__send__(method, event, params, &block)
+        else
+          raise EOFError if @recording.empty?
+          record = _take_first_read
+          return if record.nil?
+          _ensure_operation('read', record['operation'])
+          data = record['data']
+          data = Base64.decode64(msg) if record['type'] != 'text'
+          emit(event, data)
+        end
+      end
+
+      def _take_first_read
+        @recording.delete_at(@recording.index { |record| record['operation'] == 'read' } || @recording.length)
+      end
+
+      def _ensure_operation(desired, actual)
+        string = "Expected to '#{desired}' but next in recording was '#{actual}'"
+        raise OperationMismatchError string unless desired == actual
+      end
+
+      def _ensure_data(desired, actual)
+        string = "Expected data to be '#{desired}' but next in recording was '#{actual}'"
+        raise DataMismatchError string unless desired == actual
+      end
+    end
+  end
+end

data/lib/vcr/version.rb

@@ -0,0 +1,5 @@
+module VCR
+  module WebSocket
+    VERSION = '0.0.1'.freeze
+  end
+end

data/simple-websocket-vcr.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vcr/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'simple-websocket-vcr'
+  gem.version       = VCR::WebSocket::VERSION
+  gem.authors       = ['Jirka Kremser']
+  gem.email         = ['jkremser@redhat.com']
+  gem.description   = 'Websocket VCR add-on'
+  gem.summary       = 'simple-websocket-vcr is VCR add-on for websockets.'
+  gem.homepage      = 'https://github.com/Jiri-Kremser/simple-websocket-vcr'
+  gem.license       = 'Apache-2.0'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency('rspec-rails', '~> 3.0')
+  gem.add_development_dependency('websocket-client-simple', '~> 0.3')
+end

data/spec/fixtures/vcr_cassettes/EXPLICIT/some_explicitly_specified_cassette.json

@@ -0,0 +1,30 @@
+[
+  [
+    {
+      "operation": "read",
+      "type": "text",
+      "data": "WelcomeResponse={\"sessionId\":\"GmAOS1avTLE0453s0l3o8HkLUCmVMlRlIBHqK2cN\"}"
+    },
+    {
+      "operation": "write",
+      "data": "something_1"
+    },
+    {
+      "operation": "read",
+      "type": "text",
+      "data": "GenericErrorResponse={\"errorMessage\":\"Failed to process message [?]\",\"stackTrace\":\"java.lang.IllegalArgumentException: Cannot deserialize: [something_1]\\n\\tat org.hawkular.cmdgw.api.ApiDeserializer.fromHawkularFormat(ApiDeserializer.java:68)\\n\\tat org.hawkular.cmdgw.api.ApiDeserializer.deserialize(ApiDeserializer.java:84)\\n\\tat org.hawkular.cmdgw.command.ws.server.AbstractGatewayWebSocket.onMessage(AbstractGatewayWebSocket.java:213)\\n\\tat sun.reflect.GeneratedMethodAccessor544.invoke(Unknown Source)\\n\\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)\\n\\tat java.lang.reflect.Method.invoke(Method.java:497)\\n\\tat io.undertow.websockets.jsr.annotated.BoundMethod.invoke(BoundMethod.java:87)\\n\\tat io.undertow.websockets.jsr.annotated.AnnotatedEndpoint$2$1.run(AnnotatedEndpoint.java:150)\\n\\tat io.undertow.websockets.jsr.ServerWebSocketContainer.invokeEndpointMethod(ServerWebSocketContainer.java:553)\\n\\tat io.undertow.websockets.jsr.annotated.AnnotatedEndpoint$2.onMessage(AnnotatedEndpoint.java:145)\\n\\tat io.undertow.websockets.jsr.FrameHandler$7.run(FrameHandler.java:283)\\n\\tat io.undertow.websockets.jsr.ServerWebSocketContainer.invokeEndpointMethod(ServerWebSocketContainer.java:553)\\n\\tat io.undertow.websockets.jsr.ServerWebSocketContainer$5.run(ServerWebSocketContainer.java:538)\\n\\tat io.undertow.websockets.jsr.OrderedExecutor$ExecutorTask.run(OrderedExecutor.java:67)\\n\\tat java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)\\n\\tat java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)\\n\\tat java.lang.Thread.run(Thread.java:745)\\n\"}"
+    },
+    {
+      "operation": "write",
+      "data": "something_2"
+    },
+    {
+      "operation": "read",
+      "type": "text",
+      "data": "GenericErrorResponse={\"errorMessage\":\"Failed to process message [?]\",\"stackTrace\":\"java.lang.IllegalArgumentException: Cannot deserialize: [something_2]\\n\\tat org.hawkular.cmdgw.api.ApiDeserializer.fromHawkularFormat(ApiDeserializer.java:68)\\n\\tat org.hawkular.cmdgw.api.ApiDeserializer.deserialize(ApiDeserializer.java:84)\\n\\tat org.hawkular.cmdgw.command.ws.server.AbstractGatewayWebSocket.onMessage(AbstractGatewayWebSocket.java:213)\\n\\tat sun.reflect.GeneratedMethodAccessor544.invoke(Unknown Source)\\n\\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)\\n\\tat java.lang.reflect.Method.invoke(Method.java:497)\\n\\tat io.undertow.websockets.jsr.annotated.BoundMethod.invoke(BoundMethod.java:87)\\n\\tat io.undertow.websockets.jsr.annotated.AnnotatedEndpoint$2$1.run(AnnotatedEndpoint.java:150)\\n\\tat io.undertow.websockets.jsr.ServerWebSocketContainer.invokeEndpointMethod(ServerWebSocketContainer.java:553)\\n\\tat io.undertow.websockets.jsr.annotated.AnnotatedEndpoint$2.onMessage(AnnotatedEndpoint.java:145)\\n\\tat io.undertow.websockets.jsr.FrameHandler$7.run(FrameHandler.java:283)\\n\\tat io.undertow.websockets.jsr.ServerWebSocketContainer.invokeEndpointMethod(ServerWebSocketContainer.java:553)\\n\\tat io.undertow.websockets.jsr.ServerWebSocketContainer$5.run(ServerWebSocketContainer.java:538)\\n\\tat io.undertow.websockets.jsr.OrderedExecutor$ExecutorTask.run(OrderedExecutor.java:67)\\n\\tat java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)\\n\\tat java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)\\n\\tat java.lang.Thread.run(Thread.java:745)\\n\"}"
+    },
+    {
+      "operation": "close"
+    }
+  ]
+]

data/spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child1.json

@@ -0,0 +1,3 @@
+[
+
+]

data/spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child2.json

@@ -0,0 +1,3 @@
+[
+
+]

data/spec/fixtures/vcr_cassettes/VCR_for_WS/automatically_picked_cassette_name_is_ok,_when_using_context_foo_and_example_bar.json

@@ -0,0 +1,3 @@
+[
+
+]

data/spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_also_the_outgoing_communication.json

@@ -0,0 +1,21 @@
+[
+  [
+    {
+      "operation": "read",
+      "type": "text",
+      "data": "WelcomeResponse={\"sessionId\":\"-gGp6ATYH0bEfiOtumWEnieSFNgRtHL3i0RAndui\"}"
+    },
+    {
+      "operation": "write",
+      "data": "something 1"
+    },
+    {
+      "operation": "write",
+      "data": "something 2"
+    },
+    {
+      "operation": "write",
+      "data": "something 3"
+    }
+  ]
+]

data/spec/fixtures/vcr_cassettes/VCR_for_WS/should_record_the_closing_event.json

@@ -0,0 +1,12 @@
+[
+  [
+    {
+      "operation": "read",
+      "type": "text",
+      "data": "WelcomeResponse={\"sessionId\":\"QDPovsVv6q8eZx4ARSa6tdU4PJDJH1Bo4j45u3SQ\"}"
+    },
+    {
+      "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.json

@@ -0,0 +1,9 @@
+[
+  [
+    {
+      "operation": "read",
+      "type": "text",
+      "data": "WelcomeResponse={\"sessionId\":\"_f8ZS9Q2r_Tn9BVdz5vGoJueZ-dl4pbv6erAM8am\"}"
+    }
+  ]
+]

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.order = 'random'
+end

data/spec/vcr_spec.rb

@@ -0,0 +1,162 @@
+require 'vcr'
+require 'thread'
+require 'websocket-client-simple'
+require 'json'
+
+describe 'VCR for WS' do
+  HOST = 'localhost:8080'.freeze
+
+  let(:example) do |e|
+    e
+  end
+
+  before(:each) do
+    VCR::WebSocket.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|
+      c.hook_uris = [HOST]
+    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
+
+      expect(c).not_to be nil
+      expect(c.open?).to be true
+    end
+  end
+
+  it 'should record also the outgoing communication' do
+    VCR::WebSocket.configure do |c|
+      c.hook_uris = [HOST]
+    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
+      c.send('something 1')
+      c.send('something 2')
+      c.send('something 3')
+
+      expect(c).not_to be nil
+      expect(c.open?).to be true
+    end
+  end
+
+  it 'should record the closing event' do
+    VCR::WebSocket.configure do |c|
+      c.hook_uris = [HOST]
+    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
+
+      expect(c).not_to be nil
+      expect(c.open?).to be true
+      sleep 1
+      c.close
+      expect(c.open?).to be false
+    end
+  end
+
+  it 'should record complex communications' do
+    VCR::WebSocket.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
+      c.send('something_1')
+      c.on(:message, once: true, &:data)
+      sleep 1
+
+      c.send('something_2')
+      c.on(:message, once: true, &:data)
+      sleep 1
+
+      expect(c).not_to be nil
+      expect(c.open?).to be true
+      c.close
+      expect(c.open?).to be false
+      sleep 1
+    end
+
+    # check that everything was recorded in the json file
+    file_path = VCR::WebSocket.configuration.cassette_library_dir + cassette_path
+    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)
+    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
+        # nothing
+      end
+      prefix = VCR::WebSocket.configuration.cassette_library_dir
+      name = 'automatically_picked_cassette_name_is_ok,_when_using_context_foo_and_example_bar.json'
+      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
+        # nothing
+      end
+      prefix = VCR::WebSocket.configuration.cassette_library_dir
+      name = 'automatically_picked_cassette_name_is_ok,_when_describing_parent_and_example_child1.json'
+      expect(File.exist?(prefix + '/VCR_for_WS/' + name)).to be true
+    end
+
+    it 'and example child2' do
+      VCR::WebSocket.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'
+      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')
+    end
+
+    it 'has an empty list of hook ports by default' do
+      expect(VCR::WebSocket.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 }
+        .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'])
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: simple-websocket-vcr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jirka Kremser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: Websocket VCR add-on
+email:
+- jkremser@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vcr.rb
+- lib/vcr/cassette.rb
+- lib/vcr/configuration.rb
+- lib/vcr/errors.rb
+- lib/vcr/recordable_websocket_client.rb
+- lib/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/spec_helper.rb
+- spec/vcr_spec.rb
+homepage: https://github.com/Jiri-Kremser/simple-websocket-vcr
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.2
+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/spec_helper.rb
+- spec/vcr_spec.rb