xrbp 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a89c7310e04f3827f8252e3b4954036e6c75a703a21bb91e0a5c57e80817c495
-  data.tar.gz: 060e83ec60961220e4f62665a4464a7b7f9da11d96895828a814e7c218025b69
+  metadata.gz: 92361edaa1feff8405d57bd715093cd1211d0adb2b0175f5d3f6493542526c3c
+  data.tar.gz: a9a9d1e8a6d1c2682f8e4c685ca0c7f73da74b37bee211af2afc39ac53600cd9
 SHA512:
-  metadata.gz: 1cf32ec6375e44970df3612fce1eeede573d1d9501a83927de70643d207027b9e448b3a330522a2264a9b002b1e472d2334f02daadf6bf74814ab0a79c72bee5
-  data.tar.gz: 384f666fbfc87b752ef432aa2cbebc9b4819e92f1d627698e37e396083776e7a4aa5bb0846b0749cd1d892289cac1dc9386e205854505e6738028439ddfc596a
+  metadata.gz: 7e327415d681a20d7e9d5abdbaf5d0e052a7562124f83a8171645fda5321b2a692be042d8230881c4a3cd13c032c661aa2c6566b87574aabf16482a0d436fc8c
+  data.tar.gz: b26cfa8b7a106f15385d4210e1b8972771c3400e57721f72095f1a2f84504cd6e91d0a22fb2f2a958c17e37e22652cf6041c10196f732a58788aab72eab1497f

data/lib/xrbp/version.rb

@@ -1,3 +1,3 @@
 module XRBP
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end # module XRBP

data/spec/helpers/force_serializable.rb

@@ -0,0 +1,10 @@
+class Object
+  # XXX: allow any object to be serialzed via yaml
+  #      by overriding 'psych' serializer callback
+  def force_serializable!
+    class << self
+      def encode_with(coder)
+      end
+    end
+  end
+end

data/spec/helpers/test_handshake.rb

@@ -0,0 +1,29 @@
+module XRBP
+  # XXX need to manually set handshake,
+  #     else will be different each time,
+  #     messing up recordings
+  class TestHandshake
+    def version
+      13
+    end
+
+    def to_s
+      "GET / HTTP/1.1\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nHost: s1.ripple.com:443\r\nSec-WebSocket-Version: 13\r\nSec-WebSocket-Key: 0tTEDtzkyx8JPC2rIYYIzA==\r\n\r\n"
+    end
+
+    def finished?
+      true
+    end
+
+    def <<(r)
+    end
+  end
+
+  module WebSocket
+    class Client
+      def stub_handshake!
+        @handshake = XRBP::TestHandshake.new
+      end
+    end # class Client
+  end # module WebSocket
+end # module XRBP

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'camcorder'
+require 'camcorder/rspec'
+
+Camcorder.config.recordings_dir = 'spec/recordings'
+
+require 'xrbp'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

data/spec/xrbp/websocket/client_spec.rb

@@ -0,0 +1,120 @@
+require_relative '../../helpers/test_handshake'
+require_relative '../../helpers/force_serializable'
+
+describe XRBP::WebSocket::Client do
+  subject { described_class.new "wss://s1.ripple.com:443" }
+  let(:socket) { subject.send(:socket) }
+  let(:pool)   { subject.send(:pool)   }
+
+  before(:each) do
+    subject.stub_handshake!
+    subject.force_serializable!
+    Camcorder.intercept_constructor XRBP::WebSocket::Socket
+  end
+
+  after(:each) do
+    Camcorder.deintercept_constructor XRBP::WebSocket::Socket
+  end
+
+  describe '#connect' do
+    after(:each) do
+      pool.kill
+      pool.wait_for_termination
+    end
+
+    it "connects to client" do
+      # XXX we are recording socket, cannot add expections to it
+      socket = double
+      subject.instance_variable_set(:@socket, socket)
+      expect(socket).to receive(:connect)
+      expect(socket).to receive(:write)
+      expect(socket).to receive(:read_next)
+
+      subject.connect
+    end
+
+    it "performs handshake" do
+      expect(subject).to receive(:handshake!)
+      subject.connect
+    end
+
+    it "starts reading" do
+      expect(subject).to receive(:start_read)
+      subject.connect
+    end
+
+    it "is open" do
+      subject.connect
+      expect(subject).to be_open
+    end
+
+    context "connection error" do
+      it "is closed"
+    end
+
+    context "handshake error" do
+      it "is closed"
+    end
+
+    context "read error" do
+      it "is closed"
+    end
+  end
+
+  it 'is not opened' do
+    expect(subject).to_not be_open
+  end
+
+  it 'is closed' do
+    expect(subject).to be_closed
+  end
+
+  it 'is completed' do
+    expect(subject).to be_completed
+  end
+
+  describe "#close" do
+    it "closes connection" do
+      subject.connect
+      subject.close
+      expect(subject).to be_closed
+    end
+
+    it "results in completed connection" do
+      subject.connect
+      subject.close
+      expect(subject).to be_completed
+    end
+  end
+
+  describe "#send_data" do
+    let(:socket) { double }
+
+    before(:each) do
+      # XXX we are recording socket, cannot add expections to it
+      subject.instance_variable_set(:@socket, socket)
+
+      # XXX stub data_frame as it will contain random data
+      expect(subject).to receive(:data_frame).with("foobar", :text).and_return "frame"
+
+      # setup connection state
+      expect(subject).to receive(:handshaked?).and_return true
+      expect(subject).to receive(:closed?).and_return false
+    end
+
+    it "sends data" do
+      expect(socket).to receive(:write_nonblock).with("frame")
+
+      subject.send_data("foobar")
+    end
+
+    context "error is thrown" do
+      it "closes the connection asynchronously" do
+        expect(socket).to receive(:write_nonblock).and_raise Errno::EPIPE
+        expect(subject).to receive(:async_close).with(Errno::EPIPE)
+
+        subject.send_data("foobar")
+      end
+    end
+  end
+end

data/spec/xrbp/websocket/command_spec.rb

@@ -0,0 +1,13 @@
+describe XRBP::WebSocket::Command do
+  context "command specified" do
+    subject { described_class.new(command: 'test') } 
+
+    it 'returns command' do
+      expect(subject.requesting).to eq 'test'
+    end
+
+    it 'is requesting' do
+      expect(subject).to be_requesting('test')
+    end
+  end
+end

data/spec/xrbp/websocket/connection_spec.rb

@@ -0,0 +1,108 @@
+describe XRBP::WebSocket::Connection do
+  subject { XRBP::WebSocket::Connection.new 'wss://test.com:443' }
+  let(:client){ subject.client }
+
+  it 'is not initialized' do
+    expect(subject).to_not be_initialized
+  end
+
+  it 'is not open' do
+    expect(subject).to_not be_open
+  end
+
+  it 'is closed' do
+    expect(subject).to be_closed
+  end
+
+  it 'is completed' do
+    expect(subject).to be_completed
+  end
+
+  context "client exists" do
+    before(:each) do
+      subject.client
+    end
+
+    it "is initialized" do
+      expect(subject).to be_initialized
+    end
+  end
+
+  context "client is open" do
+    before(:each) do
+      expect(client).to receive(:open?).and_return true
+    end
+
+    it "is open" do
+      expect(subject).to be_open
+    end
+
+    it "is not closed" do
+      expect(subject).to_not be_closed
+    end
+  end
+
+  context "client is not completed" do
+    before(:each) do
+      expect(client).to receive(:completed?).and_return false
+    end
+
+    it "is not completed" do
+      expect(subject).to_not be_completed
+    end
+  end
+
+  describe "#connect" do
+    it "connects to client" do
+      expect(client).to receive(:connect)
+      subject.connect
+    end
+  end
+
+  describe "#close!" do
+    it "closes client" do
+      expect(client).to receive(:open?).and_return true
+      expect(client).to receive(:close)
+      subject.close!
+    end
+  end
+
+  describe "#close!" do
+    it "async closes client" do
+      expect(client).to receive(:open?).and_return true
+      expect(client).to receive(:async_close)
+      subject.async_close!
+    end
+  end
+
+  describe "#send_data" do
+    it "sends data via client" do
+      expect(client).to receive(:send_data).with("foo")
+      subject.send_data("foo")
+    end
+  end
+
+  describe "#add_work" do
+    it "adds work to client pool" do
+      expect(client).to receive(:add_work)
+      subject.add_work do
+      end
+    end
+  end
+
+  describe "#next_connection" do
+    context "no parent" do
+      it "returns nil" do
+        expect(subject.next_connection(nil)).to be_nil
+      end
+    end
+
+    it "returns parent's next connection" do
+      parent = double
+      expect(parent).to receive(:next_connection).with(:foo).and_return :bar
+
+      subject.parent = parent
+      expect(subject.next_connection(:foo)).to eq(:bar)
+    end
+  end
+end

data/spec/xrbp/websocket/message_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+describe XRBP::WebSocket::Message do
+  subject { described_class.new 'Test message' }
+  let(:connection) { XRBP::WebSocket::Connection.new "*" }
+
+  it 'returns message text' do
+    expect(subject.to_s).to eq 'Test message'
+  end
+
+  it 'waits for signal' do
+    expect(subject.signal).to be(subject)
+  end
+
+  it 'waits for connection close' do
+    expect(connection).to receive(:closed?).and_return true
+    subject.connection = connection
+    expect(subject.wait).to be_nil
+  end
+
+  it 'returns proc which waites for signal' do
+    expect(subject.bl.call).to be(subject)
+  end
+end

data/spec/xrbp/websocket/plugins/cmd_dispatcher_spec.rb

@@ -0,0 +1,25 @@
+#describe XRBP::WebSocket::Plugins::CommandDispatcher do
+#  let(:connection) {
+#    XRBP::WebSocket::Connection.new "wss://s1.ripple.com:443" do |c|
+#      c.add_plugin :command_dispatcher
+#    end
+#  }
+#
+#  before(:each) do
+#    #connection.client.stub_handshake!
+#    connection.client.force_serializable!
+#    Camcorder.intercept_constructor XRBP::WebSocket::Socket
+#
+#    # XXX fix random 
+#    allow(SecureRandom).to receive(:random_bytes).with(4).and_return('1234')
+#  end
+#
+#  after(:each) do
+#    Camcorder.deintercept_constructor XRBP::WebSocket::Socket
+#  end
+#
+#  it "sends command and returns response" do
+#    connection.connect
+#    puts connection.cmd XRBP::WebSocket::Cmds::ServerInfo.new
+#  end
+#end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xrbp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dev Null Productions
@@ -206,7 +206,15 @@ files:
 - lib/xrbp/websocket/plugins/message_dispatcher.rb
 - lib/xrbp/websocket/plugins/result_parser.rb
 - lib/xrbp/websocket/socket.rb
-homepage: https://devnull.network
+- spec/helpers/force_serializable.rb
+- spec/helpers/test_handshake.rb
+- spec/spec_helper.rb
+- spec/xrbp/websocket/client_spec.rb
+- spec/xrbp/websocket/command_spec.rb
+- spec/xrbp/websocket/connection_spec.rb
+- spec/xrbp/websocket/message_spec.rb
+- spec/xrbp/websocket/plugins/cmd_dispatcher_spec.rb
+homepage: https://github.com/DevNullProd/XRBP
 licenses:
 - MIT
 metadata: {}