eventflit-client 0.1.0

data/spec/eventflitclient_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+describe "A EventflitClient::Channels collection" do
+  before do
+    @channels = EventflitClient::Channels.new
+  end
+
+  it "should initialize empty" do
+    expect(@channels).to be_empty
+    expect(@channels.size).to eq(0)
+  end
+
+  it "should instantiate new channels added to it by name" do
+    @channels << 'TestChannel'
+    expect(@channels.find('TestChannel').class).to eq(EventflitClient::Channel)
+  end
+
+  it "should allow removal of channels by name" do
+    @channels << 'TestChannel'
+    expect(@channels['TestChannel'].class).to eq(EventflitClient::Channel)
+    @channels.remove('TestChannel')
+    expect(@channels).to be_empty
+  end
+
+  it "should not allow two channels of the same name" do
+    @channels << 'TestChannel'
+    @channels << 'TestChannel'
+    expect(@channels.size).to eq(1)
+  end
+
+end
+
+describe "A EventflitClient::Channel" do
+  before do
+    @channels = EventflitClient::Channels.new
+    @channel = @channels << "TestChannel"
+  end
+
+  it 'should not be subscribed by default' do
+    expect(@channel.subscribed).to be_falsey
+  end
+
+  it 'should not be global by default' do
+    expect(@channel.global).to be_falsey
+  end
+
+  it 'can have procs bound to an event' do
+    @channel.bind('TestEvent') {}
+    expect(@channel.callbacks.size).to eq(1)
+  end
+
+  it 'should run callbacks when an event is dispatched' do
+
+    @channel.bind('TestEvent') do
+      EventflitClient.logger.test "Local callback running"
+    end
+
+    @channel.dispatch('TestEvent', {})
+    expect(EventflitClient.logger.test_messages).to include("Local callback running")
+  end
+
+end
+
+describe "A EventflitClient::Socket" do
+  before do
+    @socket = EventflitClient::Socket.new(TEST_APP_KEY, :secret => 'secret')
+  end
+
+  it 'should not connect when instantiated' do
+    expect(@socket.connected).to be_falsey
+  end
+
+  it 'should raise ArgumentError if TEST_APP_KEY is an empty string' do
+    expect { 
+      @broken_socket = EventflitClient::Socket.new('')
+    }.to raise_error(ArgumentError)
+    expect { 
+      @broken_socket = EventflitClient::Socket.new(nil)
+    }.to raise_error(ArgumentError)
+  end
+
+  describe "...when connected" do
+    before do
+      @socket.connect
+    end
+
+    it 'should know its connected' do
+      expect(@socket.connected).to be_truthy
+    end
+
+    it 'should know its socket_id' do
+      expect(@socket.socket_id).to eq('123abc')
+    end
+
+    it 'should not be subscribed to its global channel' do
+      expect(@socket.global_channel.subscribed).to be_falsey
+    end
+
+    it 'should subscribe to a channel' do
+      @channel = @socket.subscribe('testchannel')
+      expect(@socket.channels['testchannel']).to eq(@channel)
+      expect(@channel.subscribed).to be_truthy
+    end
+
+    it 'should unsubscribe from a channel' do
+      @socket.subscribe('testchannel')
+      @socket.unsubscribe('testchannel')
+      expect(EventflitClient.logger.test_messages.last).to include('eventflit:unsubscribe')
+      expect(@socket.channels['testchannel']).to be_nil
+    end
+
+    it 'should subscribe to a private channel' do
+      @channel = @socket.subscribe('private-testchannel')
+      expect(@socket.channels['private-testchannel']).to eq(@channel)
+      expect(@channel.subscribed).to be_truthy
+    end
+
+    it 'should subscribe to a presence channel with user_id' do
+      @channel = @socket.subscribe('presence-testchannel', '123')
+      expect(@socket.channels['presence-testchannel']).to eq(@channel)
+      expect(@channel.user_data).to eq('{"user_id":"123"}')
+      expect(@channel.subscribed).to be_truthy
+    end
+
+    it 'should subscribe to a presence channel with custom channel_data' do
+      @channel = @socket.subscribe('presence-testchannel', :user_id => '123', :user_name => 'john')
+      expect(@socket.channels['presence-testchannel']).to eq(@channel)
+      expect(@channel.user_data).to eq('{"user_id":"123","user_name":"john"}')
+      expect(@channel.subscribed).to be_truthy
+    end
+
+    it 'should allow binding of global events' do
+      @socket.bind('testevent') { |data| EventflitClient.logger.test("testchannel received #{data}") }
+      expect(@socket.global_channel.callbacks.has_key?('testevent')).to be_truthy
+    end
+
+    it 'should trigger callbacks for global events' do
+      @socket.bind('globalevent') { |data| EventflitClient.logger.test("Global event!") }
+      expect(@socket.global_channel.callbacks.has_key?('globalevent')).to be_truthy
+
+      @socket.simulate_received('globalevent', 'some data', '')
+      expect(EventflitClient.logger.test_messages.last).to include('Global event!')
+    end
+
+    it 'should kill the connection thread when disconnect is called' do
+      @socket.disconnect
+      expect(Thread.list.size).to eq(1)
+    end
+
+    it 'should not be connected after disconnecting' do
+      @socket.disconnect
+      expect(@socket.connected).to be_falsey
+    end
+
+    describe "when subscribed to a channel" do
+      before do
+        @channel = @socket.subscribe('testchannel')
+      end
+
+      it 'should allow binding of callbacks for the subscribed channel' do
+        @socket['testchannel'].bind('testevent') { |data| EventflitClient.logger.test(data) }
+        expect(@socket['testchannel'].callbacks.has_key?('testevent')).to be_truthy
+      end
+
+      it "should trigger channel callbacks when a message is received" do
+        # Bind 2 events for the channel
+        @socket['testchannel'].bind('coming') { |data| EventflitClient.logger.test(data) }
+        @socket['testchannel'].bind('going')  { |data| EventflitClient.logger.test(data) }
+
+        # Simulate the first event
+        @socket.simulate_received('coming', 'Hello!', 'testchannel')
+        expect(EventflitClient.logger.test_messages.last).to include('Hello!')
+
+        # Simulate the second event
+        @socket.simulate_received('going', 'Goodbye!', 'testchannel')
+        expect(EventflitClient.logger.test_messages.last).to include('Goodbye!')
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'eventflit-client'
+
+require 'logger'
+
+TEST_APP_KEY = "TEST_APP_KEY"
+
+module EventflitClient
+  class TestLogger < Logger
+    attr_reader :test_messages
+
+    def initialize(logdev, shift_age = 0, shift_size = 1048576)
+      @test_messages = []
+      super
+    end
+    def test(msg)
+      @test_messages << msg
+      debug msg
+    end
+  end
+
+  class Socket
+    # Simulate a connection being established
+    def connect(async = false)
+      @connection_thread = Thread.new do
+        @connection = TestConnection.new
+        @global_channel.dispatch('eventflit:connection_established', JSON.dump({'socket_id' => '123abc'}))
+      end
+      @connection_thread.run
+      @connection_thread.join unless async
+      return self
+    end
+
+    def simulate_received(event_name, event_data, channel_name)
+      send_local_event(event_name, event_data, channel_name)
+    end
+  end
+
+  class TestConnection
+    def send(payload)
+      EventflitClient.logger.test("SEND: #{payload}")
+    end
+
+    def close
+    end
+  end
+
+  EventflitClient.logger = TestLogger.new('test.log')
+
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: eventflit-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eventflit
+- Logan Koester
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client for consuming WebSockets from http://eventflit.com
+email:
+- support@eventflit.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- certs/cacert.pem
+- eventflit-client.gemspec
+- examples/hello_eventflit.rb
+- examples/hello_eventflit_async.rb
+- examples/hello_eventflit_ssl.rb
+- examples/subscribe_private.rb
+- lib/eventflit-client.rb
+- lib/eventflit-client/channel.rb
+- lib/eventflit-client/channels.rb
+- lib/eventflit-client/socket.rb
+- lib/eventflit-client/version.rb
+- lib/eventflit-client/websocket.rb
+- spec/eventflitclient_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/eventflit/eventflit-websocket-ruby
+licenses:
+- MIT
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Client for consuming WebSockets from http://eventflit.com
+test_files: []