RubyGems - wamp - Versions diffs - 0.0.0 → 0.0.1 - Mend

wamp 0.0.0 → 0.0.1

Files changed (23) hide show

data/Gemfile +3 -1
data/Gemfile.lock +7 -1
data/VERSION +1 -1
data/demo/client.html +8 -3
data/demo/client.js +24 -24
data/demo/client.rb +29 -0
data/lib/wamp.rb +11 -0
data/lib/wamp/bindable.rb +16 -0
data/lib/wamp/client.rb +118 -0
data/lib/wamp/engines/memory.rb +104 -0
data/lib/wamp/protocols/version_1.rb +128 -0
data/lib/wamp/server.rb +57 -80
data/lib/wamp/socket.rb +3 -4
data/lib/wamp/topic.rb +32 -3
data/spec/lib/wamp/client_spec.rb +9 -0
data/spec/lib/wamp/engines/memory_spec.rb +118 -0
data/spec/lib/wamp/protocols/version_1_spec.rb +80 -0
data/spec/lib/wamp/server_spec.rb +5 -6
data/spec/lib/wamp/socket_spec.rb +6 -6
data/spec/lib/wamp/topic_spec.rb +1 -1
data/spec/support/dummy_socket.rb +11 -0
data/wamp.gemspec +20 -5
metadata +49 -8

data/Gemfile CHANGED Viewed

@@ -10,10 +10,12 @@ gem 'faye-websocket'
 group :development do
   gem "rspec"
   gem 'guard-rspec'
+  gem 'pry-nav'
   gem 'rb-fsevent'
   gem 'rb-inotify'
   gem 'fuubar'
-  gem "rdoc", "~> 3.12"
+  gem "yard"
+  gem 'redcarpet'
   gem "bundler"
   gem "jeweler", "~> 1.8.4"
 end

data/Gemfile.lock CHANGED Viewed

@@ -36,6 +36,8 @@ GEM
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
+    pry-nav (0.2.3)
+      pry (~> 0.9.10)
     rack (1.5.2)
     rake (10.0.4)
     rb-fsevent (0.9.3)
@@ -43,6 +45,7 @@ GEM
       ffi (>= 0.5.0)
     rdoc (3.12.2)
       json (~> 1.4)
+    redcarpet (2.2.2)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)
@@ -59,6 +62,7 @@ GEM
       eventmachine (>= 0.12.6)
       rack (>= 1.0.0)
     thor (0.18.0)
+    yard (0.8.5.2)
 PLATFORMS
   ruby
@@ -69,8 +73,10 @@ DEPENDENCIES
   fuubar
   guard-rspec
   jeweler (~> 1.8.4)
+  pry-nav
   rb-fsevent
   rb-inotify
-  rdoc (~> 3.12)
+  redcarpet
   rspec
   thin
+  yard

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.0.0
1	+ 0.0.1

data/demo/client.html CHANGED Viewed

@@ -7,9 +7,14 @@
   </head>
   <body>
     <div id="debug-data"></div>
-    <button onclick="connect();">Connect</button>
-    <input type="text" id="prefix-curie"></input><button onclick="registerPrefix()">Register Prefix</button>
-    <input type="text" id="topic-name"></input><button onclick="subscribe()">Subscribe</button><button onclick="unsubscribe()">Unsubscribe</button>
+    <button onclick="connect();">Connect</button></br>
+    <button onclick="registerPrefix('sample_topic', 'sample_topic');">Register Prefix ( sample_topic )</button></br>
+    <button onclick="subscribe('sample_topic:chat');">Subscribe Topic ( sample_topic:chat )</button></br>
+    <button onclick="unsubscribe();">Unsubscribe Topic ( sample_topic:chat )</button></br>
     <input type="text" id="simple-msg"></input><button onclick="sendSimpleMsg()">Send</button>
+    <!-- <button onclick="connect();">Connect</button> -->
+    <!-- <input type="text" id="prefix-curie"></input><button onclick="registerPrefix()">Register Prefix</button> -->
+    <!-- <input type="text" id="topic-name"></input><button onclick="subscribe()">Subscribe</button><button onclick="unsubscribe()">Unsubscribe</button> -->
   </abody>
 </html>

data/demo/client.js CHANGED Viewed

@@ -1,5 +1,5 @@
 var wamp, topicName, topicPath, prefix;
-var wsuri     = "ws://localhost:9292";
+var wsuri     = "ws://local.blove.me:9292";
 debugData = function(msg){
   $("#debug-data").append(msg + '</br>')
@@ -14,20 +14,20 @@ connect = function(){
              },
              // WAMP session is gone
-            function (code, reason) {
-            	switch (code) {
-        	    case ab.CONNECTION_CLOSED:
-          	    debugData("Connection was closed properly - done.");
-                break;
-              case ab.CONNECTION_UNREACHABLE:
-                debugData("Connection could not be established.");
-                break;
-    	        case ab.CONNECTION_UNSUPPORTED:
-                debugData("Browser does not support WebSocket.");
-                break;
-              case ab.CONNECTION_LOST:
-                debugData("Connection lost - reconnecting ...");
-                break;
+             function (code, reason) {
+               switch (code) {
+               case ab.CONNECTION_CLOSED:
+          	 debugData("Connection was closed properly - done.");
+                 break;
+               case ab.CONNECTION_UNREACHABLE:
+                 debugData("Connection could not be established.");
+                 break;
+    	       case ab.CONNECTION_UNSUPPORTED:
+                 debugData("Browser does not support WebSocket.");
+                 break;
+               case ab.CONNECTION_LOST:
+                 debugData("Connection lost - reconnecting ...");
+                 break;
                }
                debugData("Session closed, code " + code + ", reason:" + reason)
@@ -35,7 +35,7 @@ connect = function(){
             );
 };
-subscribe = function(){
+subscribe = function(prefix){
   wamp.subscribe(prefix, onEvent);
 }
@@ -44,23 +44,23 @@ unsubscribe = function(){
   topicPath = null;
 }
-registerPrefix = function(){
-  prefix = $("#prefix-curie").val()
-  topicName = $("#topic-name").val();
+registerPrefix = function(prefix, topic){
+  prefix = prefix
+  topicName = topic
   topicPath = wsuri + topicName;
   wamp.prefix(prefix, topicPath);
 }
 function onEvent(topicUri, event) {
-   debugData(topicUri);
-   debugData(event);
+  debugData(topicUri);
+  debugData(event);
 }
 function sendSimpleMsg()
 {
-	msg = $("#simple-msg").val();
-	$("#simple-msg").val("");
+  msg = $("#simple-msg").val();
+  $("#simple-msg").val("");
-	wamp.publish(prefix, msg);
+  wamp.publish("sample_topic:chat", msg);
 }

data/demo/client.rb ADDED Viewed

@@ -0,0 +1,29 @@
+require '../lib/wamp'
+Client = WAMP::Client.new
+Client.bind(:connect) do |client|
+  puts "Connected to server"
+end
+Client.bind(:welcome) do |client|
+  puts "Welcome message received"
+  # client.socket.send [5, "ws://localhost:9000/some_topic"].to_json
+  client.subscribe("ws://localhost:9000/some_topic")
+  client.publish("ws://localhost:9000/some_topic", { from: client.id, to: "You", what: "Whos there?" })
+end
+Client.bind(:event) do |client, topic, payload|
+  puts "New event on #{topic}: #{payload}"
+  if payload["what"] == "Whos there?"
+    client.publish("ws://localhost:9000/some_topic", { results: "I am!" }, exclude: true)
+  end
+end
+Client.bind(:disconnect) do |client|
+  puts "Disconnected from server"
+end
+Client.start

data/lib/wamp.rb CHANGED Viewed

@@ -5,11 +5,22 @@ module WAMP
   ROOT = File.expand_path(File.dirname(__FILE__))
+  autoload :Bindable,    File.join(ROOT, "wamp", "bindable")
+  autoload :Client,      File.join(ROOT, "wamp", "client")
   autoload :Server,      File.join(ROOT, "wamp", "server")
   autoload :Socket,      File.join(ROOT, "wamp", "socket")
   autoload :Topic,       File.join(ROOT, "wamp", "topic")
   autoload :MessageType, File.join(ROOT, "wamp", "message_type")
+  module Engines
+    autoload :Memory,      File.join(ROOT, "wamp", "engines", "memory")
+  end
+  # autoload :Protocols,   File.join(ROOT, "wamp", "protocols")
+  module Protocols
+    autoload :Version1, File.join(ROOT, "wamp", "protocols", "version_1")
+  end
   class << self
     def version
       "#{MAJOR}.#{MINOR}.#{PATCH}"

data/lib/wamp/bindable.rb ADDED Viewed

@@ -0,0 +1,16 @@
+module WAMP
+  module Bindable
+    def available_bindings
+      raise NotImplementedError
+    end
+    def bind(name, &callback)
+      raise "Invalid binding: #{name}" unless available_bindings.include? name
+      callbacks[name] = callback
+    end
+    def trigger(name, *args)
+      callbacks[name].call *args if callbacks[name]
+    end
+  end
+end

data/lib/wamp/client.rb ADDED Viewed

@@ -0,0 +1,118 @@
+require 'faye/websocket'
+require 'json'
+require 'eventmachine'
+module WAMP
+  class Client
+    include WAMP::Bindable
+    attr_accessor :id, :socket, :wamp_protocol, :server_ident, :topics, :callbacks,
+                  :prefixes, :ws_server
+    # WAMP Client
+    #   Connects to WAMP server, after connection client should receve WELCOME message
+    #   from server.
+    #   Client can then register prefix, call, subscribe, unsubscribe, and publish
+    def initialize(options = {})
+      @ws_server = options[:host] || "ws://localhost:9000"
+      @id     = nil
+      @socket = nil
+      @wamp_protocol = nil
+      @server_ident  = nil
+      @prefixes  = {}
+      @topics    = []
+      @callbacks = {}
+    end
+    def available_bindings
+      [:connect, :welcome, :call_result, :call_error, :event, :disconnect]
+    end
+    def start
+      EM.run do
+        ws = Faye::WebSocket::Client.new(ws_server)
+        ws.onopen    = lambda { |event| handle_open(ws, event) }
+        ws.onmessage = lambda { |event| handle_message(event) }
+        ws.onclose   = lambda { |event| handle_close(event) }
+      end
+    end
+    def prefix(prefix, topic_uri)
+      socket.send [WAMP::MessageType[:PREFIX], prefix, topic_uri].to_json
+      prefixes[prefix] = topic_uri
+    end
+    def subscribe(topic_uri)
+      socket.send [WAMP::MessageType[:SUBSCRIBE], topic_uri].to_json
+      topics << topic_uri
+    end
+    def publish(topic_uri, payload, options = {})
+      exclude = options.fetch(:exclude, nil)
+      include = options.fetch(:include, nil)
+      socket.send [WAMP::MessageType[:PUBLISH], topic_uri, payload, exclude, include].to_json
+    end
+    def stop
+      EM.stop
+    end
+  private
+    def handle_open(websocket, event)
+      @socket = websocket
+      trigger(:connect, self)
+    end
+    def handle_message(event)
+      parsed_msg = JSON.parse(event.data)
+      msg_type   = parsed_msg[0]
+      case WAMP::MessageType[msg_type]
+      when :WELCOME
+        handle_welcome(parsed_msg)
+      when :EVENT
+        handle_event(parsed_msg)
+      else
+        handle_unknown(parsed_msg)
+      end
+    end
+    # Handle welcome message from server
+    # WELCOME data structure [0, CLIENT_ID, WAMP_PROTOCOL, SERVER_IDENTITY]
+    def handle_welcome(data)
+      @id            = data[1]
+      @wamp_protocol = data[2]
+      @server_ident  = data[3]
+      trigger(:welcome, self)
+    end
+    # Handle an event message from server
+    # EVENT data structure [8, TOPIC, PAYLOAD]
+    def handle_event(data)
+      topic   = data[1]
+      payload = data[2]
+      trigger(:event, self, topic, payload)
+    end
+    def handle_unknown(data)
+      # Do nothing
+    end
+    def handle_close(event)
+      socket = nil
+      id     = nil
+      trigger(:disconnect, self)
+    end
+  end
+end

data/lib/wamp/engines/memory.rb ADDED Viewed

@@ -0,0 +1,104 @@
+require 'securerandom'
+module WAMP
+  module Engines
+    # Engine for managing clients, and topics in system memory. This engine is
+    # best used for single servers.
+    class Memory
+      attr_reader :clients, :topics, :options
+      # Creates a new instance of the memory engine as well as some empty hashes
+      # for holding clients and topics.
+      # @param options [Hash] Optional. Options hash for the memory engine.
+      def initialize(options = {})
+        @options = options
+        @clients = {}
+        @topics  = {}
+      end
+      # Creates a new Socket object and adds it as a client.
+      # @param websocket [WebSocket] The websocket connection that belongs to the
+      #   new client
+      # @return [WebSocket] Returns the newly created socket object
+      def create_client(websocket)
+        client = new_client(websocket)
+        @clients[client.id] = client
+      end
+      # Finds clients by the given parameters. Currently only supports one
+      #   parameter. Todo: Support multiple parameters.
+      # @param args [Hash] A hash of arguments to match against the given clients
+      # @return [Array] Returns an array of all matching clients.
+      def find_clients(args = {})
+        matching_clients = clients.find_all do |id, socket|
+          socket.send(args.first[0]) == args.first[1]
+        end
+        matching_clients.flat_map { |x| x[1] }
+      end
+      # Deletes a client
+      # @param socket [WebSocket] The websocket to remove from clients
+      # @return [WAMP::Socket] The client that was removed
+      def delete_client(websocket)
+        client = find_clients(websocket: websocket).first
+        clients.delete client.id
+      end
+      # Returns an array of all connected clients
+      # @return [Array] Array of all connected clients.
+      def all_clients
+        clients.values
+      end
+      # Finds an existing topic, if non is found it will create one.
+      # @param topic_uri [String] The URI for the topic to find or create.
+      # @return [WAMP::Topic] Returns a WAMP Topic object.
+      def find_or_create_topic(topic_uri)
+        @topics[topic_uri] ||= new_topic(topic_uri)
+      end
+      # Add a client to a topic and a topic to a client
+      # @param client [WAMP::Socket] The client socket to subscribe to the topic.
+      # @param topic_uri [String] URI or CURIE the client is to subscribe to.
+      # @return [WAMP::Topic] The topic that the client subscribed to.
+      def subscribe_client_to_topic(client, topic_uri)
+        topic = find_or_create_topic(topic_uri)
+        client.add_topic(topic)
+        topic.add_client(client)
+        topic
+      end
+      # Remove a client from a topic.
+      # @param client [WAMP::Socket] The client socket to unsubscribe from the topic.
+      # @param topic_uri [String] The URI of the topic to unsubscribe from.
+      # @return [WAMP::Topic] The topic that the client unsubscribed from.
+      def unsubscribe_client_from_topic(client, topic_uri)
+        topic = find_or_create_topic(topic_uri)
+        client.remove_topic(topic)
+        topic.remove_client(client)
+        topic
+      end
+      private
+      def new_client(websocket)
+        WAMP::Socket.new(random_uuid, websocket)
+      end
+      def new_topic(uri)
+        WAMP::Topic.new(uri)
+      end
+      def random_uuid
+        SecureRandom.uuid
+      end
+    end
+  end
+end