websocket_messaging 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad771f4dba1ca131d518f83d558582fe4289c14c
+  data.tar.gz: 1daf14710bffcd1e16079e537936683aac699468
+SHA512:
+  metadata.gz: d979edf012c16f13d11d449c1fede4792c2d7399a8b5e9ec3df85902028740a609f97b76b88666ab160a42e8acd8f8575ec0d0a37fecb76ff425322f9bb4f0fd
+  data.tar.gz: e615d6dca1838c64b1be003da02d347c474022d151346b7aff05ee84147ad21d8f3ef0ee046f37bfda702db95de6238195bce7ceb6843f4f4220910636fa0dcd

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Artur Hebda
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# WebsocketMessaging
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'websocket_messaging'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install websocket_messaging
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/websocket_messaging/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/websocket_messaging.rb

@@ -0,0 +1,5 @@
+require "websocket_messaging/version"
+require "websocket_messaging/channel"
+
+module WebsocketMessaging
+end

data/lib/websocket_messaging/channel.rb

@@ -0,0 +1,65 @@
+require 'websocket_messaging/notifier'
+
+module WebsocketMessaging
+  class Channel
+    attr_reader :notifier, :socket
+
+    def initialize(id)
+      @notifier = Notifier.new(id)
+      @handlers = {
+        before_send: ->(data) { data },
+        onmessage:   ->(data) {}
+      }
+
+      yield self if block_given?
+    end
+
+    def start(socket)
+      @socket = socket
+
+      subscribe_notifier
+      subscribe_socket_messages
+      subscribe_socket_closed
+    end
+
+    def subscribe_notifier
+      notifier.subscribe do |data|
+        send_socket_message(data)
+      end
+    end
+
+    def subscribe_socket_messages
+      socket.onmessage do |message|
+        data = JSON.parse(message)
+        receive_message(data)
+      end
+    end
+
+    def subscribe_socket_closed
+      socket.onclose do
+        notifier.unsubscribe
+      end
+    end
+
+    def onmessage(&handler)
+      @handlers[:onmessage] = handler
+    end
+
+    def before_send(&handler)
+      @handlers[:before_send] = handler
+    end
+
+    private
+
+    def send_socket_message(data)
+      to_send = @handlers[:before_send].call(data)
+      if to_send && to_send.respond_to?(:to_json)
+        socket.send_data(to_send.to_json)
+      end
+    end
+
+    def receive_message(data)
+      @handlers[:onmessage].call(data)
+    end
+  end
+end

data/lib/websocket_messaging/multicast_notifier.rb

@@ -0,0 +1,15 @@
+module WebsocketMessaging
+  class MulticastNotifier
+    attr_reader :notifiers
+
+    def initialize(channel_ids, notifier_builder)
+      @notifiers = Array(channel_ids).map do |channel_id|
+        notifier_builder.call(channel_id)
+      end
+    end
+
+    def notify(message)
+      @notifiers.each { |n| n.notify(message) }
+    end
+  end
+end

data/lib/websocket_messaging/notifier.rb

@@ -0,0 +1,50 @@
+require 'json'
+require 'websocket_messaging/multicast_notifier'
+
+module WebsocketMessaging
+  class BusConnectorNotDefinedError < StandardError; end
+
+  class Notifier < Struct.new(:channel_id)
+    def subscribe(&block)
+      @subscription = Thread.new do
+        connect_to_bus.subscribe(channel_id) do |bus|
+          bus.message do |channel, message|
+            data = JSON.parse(message)
+            block.call(data)
+          end
+        end
+      end
+    end
+
+    def multicast(channel_ids)
+      MulticastNotifier.new(channel_ids, self.class.public_method(:new))
+    end
+
+    def notify(message)
+      return unless message && message.respond_to?(:to_json)
+      connect_to_bus.publish(channel_id, message.to_json)
+    end
+
+    def unsubscribe
+      @subscription.kill
+    end
+
+    def connect_to_bus
+      self.class.bus_connector.call
+    end
+
+    def self.bus_connector=(connector)
+      @bus_connector = connector
+    end
+
+    def self.bus_connector
+      unless @bus_connector
+        raise BusConnectorNotDefinedError,
+          %[you have to define a bus connector,
+            i.e. returning a new connection to redis]
+      end
+
+      @bus_connector
+    end
+  end
+end

data/lib/websocket_messaging/version.rb

@@ -0,0 +1,3 @@
+module WebsocketMessaging
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.join(__dir__, "..", "lib"))
+
+require "rspec/its"
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+end

data/spec/websocket_messaging/channel_spec.rb

@@ -0,0 +1,154 @@
+require "spec_helper"
+require "websocket_messaging/channel"
+require "websocket_messaging/notifier"
+
+describe WebsocketMessaging::Channel do
+  describe "#new" do
+    let(:id) { 1 }
+
+    it "creates a dedicated notifier" do
+      expect(WebsocketMessaging::Notifier).to receive(:new)
+        .with(id).and_call_original
+
+      channel = described_class.new(id)
+      expect(channel.notifier).to_not be_nil
+    end
+
+    it "passes self to a block if given" do
+      config = double(call: nil)
+      channel = described_class.new(id) do |channel|
+        config.call(channel)
+      end
+
+      expect(config).to have_received(:call).with(channel)
+    end
+  end
+
+  describe "#start" do
+    let(:id)     { 1 }
+    let(:socket) { double }
+
+    subject { described_class.new(id) }
+
+    it "subscribes to notifier and socket" do
+      expect(subject).to receive(:subscribe_notifier)
+      expect(subject).to receive(:subscribe_socket_messages)
+      expect(subject).to receive(:subscribe_socket_closed)
+
+      subject.start(socket)
+    end
+  end
+
+  describe "internal notify" do
+    let(:id)          { 1 }
+    let(:parsed_data) { { "a" => 3 } }
+    let(:raw_data)    { parsed_data.to_json }
+    let(:changed_data){ parsed_data.merge("b" => 4) }
+    let(:socket)      { double("socket", send_data: nil) }
+    let(:notifier)    { double("notifier") }
+
+    subject { described_class.new(id) }
+
+    before(:each) do
+      expect(WebsocketMessaging::Notifier).to receive(:new).and_return(notifier)
+
+      expect(notifier).to receive(:subscribe) do |&handler|
+        @internal_notify = handler
+      end
+
+      allow(subject).to receive(:subscribe_socket_closed)
+      allow(subject).to receive(:subscribe_socket_messages)
+
+      subject.start(socket)
+    end
+
+    context "default handler" do
+      it "passes the received data" do
+        @internal_notify.call(parsed_data)
+        expect(socket).to have_received(:send_data).with(raw_data)
+      end
+    end
+
+    context "handler returning object that responds to :to_json" do
+      before(:each) do
+        subject.before_send do |data|
+          changed_data
+        end
+      end
+
+      it "sends returned object cast to json" do
+        @internal_notify.call(parsed_data)
+        expect(socket).to have_received(:send_data).with(changed_data.to_json)
+      end
+    end
+
+    context "handler returning false" do
+      before(:each) do
+        subject.before_send { |_| false }
+      end
+
+      it "does not send anything" do
+        @internal_notify.call(parsed_data)
+        expect(socket).to_not have_received(:send_data)
+      end
+    end
+  end
+
+  describe "message from socket" do
+    let(:id)               { 1 }
+    let(:parsed_data)      { { "a" => 3 } }
+    let(:raw_data)         { parsed_data.to_json }
+    let(:socket)           { double("socket") }
+    let(:message_received) { double(call: nil) }
+
+    subject { described_class.new(id) }
+
+    before(:each) do
+      expect(socket).to receive(:onmessage) do |&handler|
+        @incoming_socket_message = handler
+      end
+
+      allow(subject).to receive(:subscribe_notifier)
+      allow(subject).to receive(:subscribe_socket_closed)
+
+      subject.start(socket)
+    end
+
+    context "defined handler" do
+      it "gets called with parsed data" do
+        subject.onmessage do |data|
+          message_received.call(data) # simply pass through
+        end
+
+        @incoming_socket_message.call(raw_data)
+        expect(message_received).to have_received(:call).with(parsed_data)
+      end
+    end
+  end
+
+  describe "socket closed" do
+    let(:id)       { 1 }
+    let(:socket)   { double("socket") }
+    let(:notifier) { double("notifier", unsubscribe: nil) }
+
+    subject { described_class.new(id) }
+
+    before(:each) do
+      expect(WebsocketMessaging::Notifier).to receive(:new).and_return(notifier)
+
+      expect(socket).to receive(:onclose) do |&handler|
+        @socket_closed = handler
+      end
+
+      allow(subject).to receive(:subscribe_socket_messages)
+      allow(subject).to receive(:subscribe_notifier)
+
+      subject.start(socket)
+    end
+
+    it "unsubscribes from notifier" do
+      @socket_closed.call
+      expect(notifier).to have_received(:unsubscribe)
+    end
+  end
+end

data/spec/websocket_messaging/multicast_notifier_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+require "websocket_messaging/multicast_notifier"
+
+describe WebsocketMessaging::MulticastNotifier do
+  describe "#new" do
+    let(:channels) { [1, 2] }
+    let(:notifier) { double("channel notifier") }
+    let(:notifier_builder) do
+      double(call: notifier)
+    end
+
+    it "creates a notifier for each channel" do
+      multicast = described_class.new(channels, notifier_builder)
+      expect(notifier_builder).to have_received(:call).with(1)
+      expect(notifier_builder).to have_received(:call).with(2)
+      expect(multicast.notifiers).to match_array [notifier, notifier]
+    end
+  end
+
+  describe "#notify" do
+    let(:message) { "message" }
+    let(:channels) { [1, 2] }
+    let(:notifier_builder) do
+      ->(channel_id) { double(notify: nil) }
+    end
+
+    subject { described_class.new(channels, notifier_builder) }
+
+    it "notifies all channels" do
+      subject.notify(message)
+      subject.notifiers.each do |notifier|
+        expect(notifier).to have_received(:notify).with(message)
+      end
+    end
+  end
+end

data/spec/websocket_messaging/notifier_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+require 'redis'
+require 'websocket_messaging/notifier'
+require 'websocket_messaging/multicast_notifier'
+
+describe WebsocketMessaging::Notifier do
+  describe "#multicast" do
+    let(:channel_id) { 1 }
+    let(:channel_ids) { [2, 3] }
+    let(:notifier_builder) { described_class.public_method(:new) }
+
+    subject { described_class.new(channel_id) }
+
+    it "creates multicast notifier for passed channels" do
+      expect(WebsocketMessaging::MulticastNotifier).to receive(:new)
+        .with(channel_ids, notifier_builder)
+
+      subject.multicast(channel_ids)
+    end
+  end
+
+  describe "#notify" do
+    let(:bus_connection) { double("bus", publish: nil) }
+    let(:bus_connector)  { double(call: bus_connection) }
+    let(:parsed_data)    { { "a" => 3 } }
+    let(:raw_data)       { parsed_data.to_json }
+    let(:channel_id)     { 1 }
+
+    subject { described_class.new(channel_id) }
+
+    before(:each) do
+      described_class.bus_connector = bus_connector
+    end
+
+    context "message responding to :to_json" do
+      it "publishes to bus on the related channel" do
+        subject.notify(parsed_data)
+
+        expect(bus_connection).to have_received(:publish)
+          .with(channel_id, raw_data)
+      end
+    end
+
+    context "other messages" do
+      it "does not publish anything" do
+        subject.notify(nil)
+        expect(bus_connection).to_not have_received(:publish)
+      end
+    end
+  end
+
+  describe "messaging flow through bus" do
+    before(:all) do
+      described_class.bus_connector = -> { Redis.new }
+    end
+
+    let(:channel_id)  { 1 }
+    let(:parsed_data) { { "a" => 3 } }
+    let(:receiver)    { double("receiver", call: nil) }
+
+    subject { described_class.new(channel_id) }
+
+    it "allows to receive messages sent on the channel" do
+      subject.subscribe do |data|
+        receiver.call(data)
+      end
+
+      subject.notify(parsed_data)
+      subject.unsubscribe
+
+      expect(receiver).to have_received(:call).with(parsed_data)
+    end
+  end
+end

data/websocket_messaging.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'websocket_messaging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "websocket_messaging"
+  spec.version       = WebsocketMessaging::VERSION
+  spec.authors       = ["Artur Hebda"]
+  spec.email         = ["arturhebda@gmail.com"]
+  spec.summary       = %[Messaging platform for sending json data that supports many-to-many
+    connections using sockets, i.e. websockets.]
+  spec.description   = %[This gem has been extracted from chat application based on websockets.
+    It consists of basically two components: channels and notifiers. Channels are meant to handle
+    external communication through provided socket in a bidirectional manner while
+    using notifiers for internal communication. Notifiers are using a messaging bus,
+    which might be anything supporting publish/subscribe pattern across multiple threads / processes,
+    i.e. common Redis cluster. It lets you define your own handlers for receiving and sending data.]
+  spec.homepage      = "https://github.com/growthrepublic/websocket_messaging"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "redis", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0.0.rc1"
+  spec.add_development_dependency "rspec-its", "~> 1.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0.0.rc1"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: websocket_messaging
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Artur Hebda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+description: |-
+  This gem has been extracted from chat application based on websockets.
+      It consists of basically two components: channels and notifiers. Channels are meant to handle
+      external communication through provided socket in a bidirectional manner while
+      using notifiers for internal communication. Notifiers are using a messaging bus,
+      which might be anything supporting publish/subscribe pattern across multiple threads / processes,
+      i.e. common Redis cluster. It lets you define your own handlers for receiving and sending data.
+email:
+- arturhebda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/websocket_messaging.rb
+- lib/websocket_messaging/channel.rb
+- lib/websocket_messaging/multicast_notifier.rb
+- lib/websocket_messaging/notifier.rb
+- lib/websocket_messaging/version.rb
+- spec/spec_helper.rb
+- spec/websocket_messaging/channel_spec.rb
+- spec/websocket_messaging/multicast_notifier_spec.rb
+- spec/websocket_messaging/notifier_spec.rb
+- websocket_messaging.gemspec
+homepage: https://github.com/growthrepublic/websocket_messaging
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Messaging platform for sending json data that supports many-to-many connections
+  using sockets, i.e. websockets.
+test_files:
+- spec/spec_helper.rb
+- spec/websocket_messaging/channel_spec.rb
+- spec/websocket_messaging/multicast_notifier_spec.rb
+- spec/websocket_messaging/notifier_spec.rb
+has_rdoc: