simple-websocket-vcr 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78b408bc5fa868fa39eadc1396ff489392afde72
-  data.tar.gz: 1efd70b10211a7b521670188ec85fbcedc6ff4fb
+  metadata.gz: 6fcc25d2e22bc79b1a5359917af80ec0f10ae45e
+  data.tar.gz: 2736b6895d6da6e42d372e478e92fbeb6bd7d14a
 SHA512:
-  metadata.gz: 9fade33794fb192e477ede4ce59bf0d759faa5894ab4f84492bf188d22ebb0926d69976f0f27a4eddcbd86dbd7a5c10921238449ce55b25fbf28473187de4eb7
-  data.tar.gz: 9062c5a2735114ab8e76e6a0f80f16184bf1d4280abf9f442a577d6119b47ec2f20e5aa510a750024b8c28d187a40d2413f0ddc3869e87bc471d0063ffdc7dd9
+  metadata.gz: 6f1e61a02a7c1796460d423406c2d870035f74b761939983292423329ccca8ace7715576b38b45f6b3e2b2ec673bace43bb1045bd12484f54b5159eafbdc11b0
+  data.tar.gz: f1a278cbb9e3dc882113e5a4e83bdf31f2a81af8fb20aaa2f72c17fd69c23d382ff00bf82eb301aae52a4f0eec4bc1c3482f3c9ba2a4339c373a9005607f2b29

data/.rubocop.yml

@@ -24,3 +24,5 @@ ModuleLength:
   Enabled: false
 Style/ClassAndModuleChildren:
   Enabled: false
+Style/ModuleFunction:
+  Enabled: false

data/CHANGES.md

@@ -3,6 +3,20 @@
 This document describes the relevant changes between releases of the
 _simple-websocket-vcr_ project.
 
-### V 0.0.1
+### 0.0.5 (not released yet)
+* 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)
 
-* First release
+### 0.0.4
+* if client waits for msg a therad is spawned and it checks the recording for consecutive read operations and translate it to the events, if write operation is on the top of the stack, the thread waits for the client to perform the write
+
+### 0.0.3
+* making it more robust
+
+### 0.0.2
+* bug fixes
+* Rubocop
+* actually, making it work with unseen scenarios
+
+### 0.0.1
+
+* First release

data/README.md

@@ -1,7 +1,6 @@
 # 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)
-
 [![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)
 
 

data/lib/simple_websocket_vcr.rb

@@ -1,103 +1,122 @@
+require 'json'
+require 'yaml'
+require 'websocket-client-simple'
 require 'simple_websocket_vcr/cassette'
 require 'simple_websocket_vcr/configuration'
 require 'simple_websocket_vcr/errors'
 require 'simple_websocket_vcr/recordable_websocket_client'
 require 'simple_websocket_vcr/version'
-require 'json'
-require 'websocket-client-simple'
+require 'simple_websocket_vcr/monkey_patch'
+
+module WebSocketVCR
+  extend self
+
+  # @return [String] the current version.
+  # @note This string also has singleton methods:
+  #
+  #   * `major` [Integer] The major version.
+  #   * `minor` [Integer] The minor version.
+  #   * `patch` [Integer] The patch version.
+  #   * `parts` [Array<Integer>] List of the version parts.
+  def version
+    @version ||= begin
+      string = WebSocketVCR::VERSION
+
+      def string.parts
+        split('.').map(&:to_i)
+      end
 
-module VCR
-  module WebSocket
-    def configure
-      yield configuration
-    end
+      def string.major
+        parts[0]
+      end
 
-    def configuration
-      @configuration ||= Configuration.new
-    end
+      def string.minor
+        parts[1]
+      end
 
-    def cassette
-      @cassette
-    end
+      def string.patch
+        parts[2]
+      end
 
-    def cassette=(v)
-      @cassette = v
+      string
     end
+  end
 
-    def disabled
-      @disabled || false
-    end
+  def configure
+    yield configuration
+  end
 
-    def disabled=(v)
-      @disabled = v
-    end
+  def configuration
+    @configuration ||= Configuration.new
+  end
 
-    def save_session
-    end
+  def cassette
+    @cassette
+  end
 
-    def use_cassette(name, _options = {})
-      fail ArgumentError, '`VCR.use_cassette` requires a block.' unless block_given?
-      self.cassette = Cassette.new(name)
-      yield
-      cassette.save
-      self.cassette = nil
-    end
+  def cassette=(v)
+    @cassette = v
+  end
 
-    def record(example, context, options = {}, &block)
-      fail ArgumentError, '`VCR.record` requires a block.' unless block_given?
-      name = filename_helper(example, context)
-      use_cassette(name, options, &block)
-    end
+  def disabled
+    @disabled || false
+  end
 
-    def turn_off!(_options = {})
-      # TODO: impl
-    end
+  def disabled=(v)
+    @disabled = v
+  end
 
-    def turned_on?
-      !@cassette.nil?
-    end
+  def save_session
+  end
 
-    def turn_on!
-      # TODO: impl
-    end
+  # Use the specified cassette for either recording the real communication or replaying it during the tests.
+  # @param name [String] the cassette
+  # @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
+  def use_cassette(name, options = {})
+    fail ArgumentError, '`VCR.use_cassette` requires a block.' unless block_given?
+    self.cassette = Cassette.new(name, options)
+    yield
+    cassette.save
+    self.cassette = nil
+  end
 
-    def live?
-      @cassette && @cassette.recording?
-    end
+  def record(example, context, options = {}, &block)
+    fail ArgumentError, '`VCR.record` requires a block.' unless block_given?
+    name = filename_helper(example, context)
+    use_cassette(name, options, &block)
+  end
 
-    private
+  def turn_off!(_options = {})
+    # TODO: impl
+  end
 
-    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
+  def turned_on?
+    !@cassette.nil?
+  end
 
-    module_function :configure, :configuration, :cassette, :cassette=, :disabled, :disabled=, :save_session,
-                    :use_cassette, :record, :turn_off!, :turned_on?, :turn_on!, :filename_helper
+  def turn_on!
+    # TODO: impl
   end
-end
 
-module WebSocket::Client::Simple
-  class << self
-    alias_method :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
+  def live?
+    @cassette && @cassette.recording?
+  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}"
   end
+
+  module_function :configure, :configuration, :cassette, :cassette=, :disabled, :disabled=, :save_session,
+                  :use_cassette, :record, :turn_off!, :turned_on?, :turn_on!, :filename_helper
 end

data/lib/simple_websocket_vcr/cassette.rb

@@ -1,50 +1,129 @@
 require 'simple_websocket_vcr/errors'
 require 'fileutils'
 
-module VCR
-  module WebSocket
-    include Errors
-
-    class Cassette
-      attr_reader :name, :recording
-
-      alias_method :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
+module WebSocketVCR
+  include Errors
+
+  class Cassette
+    attr_reader :name, :options, :recording, :sessions
+
+    alias_method :recording?, :recording
+
+    def initialize(name, options)
+      @name = name
+      @options = options
+      @using_json = WebSocketVCR.configuration.json_cassettes
+      @name += @using_json ? '.json' : '.yml'
+
+      if File.exist?(filename)
+        @recording = false
+        @sessions = initialize_sessions filename
+      else
+        fail "No cassette '#{name}' found and recording has been turned off" if @options[:record] == :none
+        @recording = true
+        @sessions = []
       end
+    end
 
-      def next_session
-        if recording?
-          @sessions << []
-          @sessions.last
-        else
-          fail NoMoreSessionsError if @sessions.empty?
-          @sessions.shift
-        end
+    def next_session
+      if recording?
+        @sessions.push(@using_json ? RecordedJsonSession.new([]) : RecordedYamlSession.new([]))
+        @sessions.last
+      else
+        fail NoMoreSessionsError if @sessions.empty?
+        @sessions.shift
       end
+    end
 
-      def save
-        return unless recording?
-        dirname = File.dirname(filename)
-        FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
-        File.open(filename, 'w') { |f| f.write(JSON.pretty_generate(@sessions)) }
+    def save
+      return unless recording?
+      dirname = File.dirname(filename)
+      # make sure the directory structure is there
+      FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+      if @using_json
+        text = JSON.pretty_generate(@sessions.map(&:record_entries))
+      else
+        text = { 'websocket_interactions' => @sessions.map(&:record_entries) }.to_yaml(Indent: 8)
       end
+      File.open(filename, 'w') { |f| f.write(text) }
+    end
+
+    protected
+
+    def filename
+      "#{WebSocketVCR.configuration.cassette_library_dir}/#{name}"
+    end
+
+    private
 
-      protected
+    def initialize_sessions(filename)
+      file_content = File.open(filename, &:read)
 
-      def filename
-        "#{VCR::WebSocket.configuration.cassette_library_dir}/#{name}"
+      # do the ERB substitution
+      unless @options[:erb].nil?
+        require 'ostruct'
+        namespace = OpenStruct.new(@options[:erb])
+        file_content = ERB.new(file_content).result(namespace.instance_eval { binding })
       end
+
+      # parse JSON/YAML
+      if @using_json
+        parsed_content = JSON.parse(file_content)
+        sessions = RecordedJsonSession.load(parsed_content)
+      else
+        parsed_content = YAML.load(file_content)
+        sessions = RecordedYamlSession.load(parsed_content)
+      end
+      sessions
+    end
+  end
+
+  class RecordedSession
+    attr_reader :record_entries
+
+    def initialize(entries)
+      @record_entries = entries
+    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
+      @record_entries << hash
+    end
+
+    def next
+      RecordEntry.parse(@record_entries.shift)
+    end
+
+    def head
+      @record_entries.empty? ? nil : RecordEntry.parse(@record_entries.first)
+    end
+
+    def method_missing(method_name, *args, &block)
+      @record_entries.__send__(method_name, *args, &block)
+    end
+  end
+
+  class RecordedJsonSession < RecordedSession
+    def self.load(json)
+      json.map { |session| RecordedJsonSession.new(session) }
+    end
+  end
+
+  class RecordedYamlSession < RecordedSession
+    def self.load(yaml)
+      yaml['websocket_interactions'].map { |session| RecordedYamlSession.new(session) }
+    end
+  end
+
+  class RecordEntry
+    attr_accessor :operation, :type, :data
+
+    def self.parse(obj)
+      record_entry = RecordEntry.new
+      record_entry.operation = obj['operation']
+      record_entry.type = obj['type'] if obj['type']
+      record_entry.data = obj['data'] if obj['data']
+      record_entry
     end
   end
 end

data/lib/simple_websocket_vcr/configuration.rb

@@ -1,16 +1,19 @@
-module VCR
-  module WebSocket
-    class Configuration
-      attr_accessor :cassette_library_dir, :hook_uris
+module WebSocketVCR
+  class Configuration
+    attr_accessor :cassette_library_dir, :hook_uris, :json_cassettes
 
-      def initialize
-        reset_defaults!
-      end
+    def initialize
+      reset_defaults!
+    end
+
+    def reset_defaults!
+      @cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+      @hook_uris = []
+      @json_cassettes = false
+    end
 
-      def reset_defaults!
-        @cassette_library_dir = 'spec/fixtures/vcr_cassettes'
-        @hook_uris = []
-      end
+    def method_missing(method_name, *_args, &_block)
+      puts 'unknown method: ' + method_name.to_s
     end
   end
 end