eventd 0.0.0 → 1.0.0

data/README.md

@@ -0,0 +1,61 @@
+Introduction
+------------
+
+Eventd is a web socket client and server wrapper around **em-websockets**. Eventd strives to provide an event-based
+structure, which provides the basis for web-socket enabled applications. Eventd implements a Server and a Client, which
+both implement a base ``EventdObject``.
+
+
+Installation
+------------
+
+```
+gem install eventd
+```
+
+
+EventdObject Example
+--------------------
+
+```ruby
+require 'eventd'
+
+class Dog < EventdObject
+    def initialize(name)
+        super()
+        @name = name
+    end
+
+    def bark
+        self.emit 'bark'
+    end
+end
+
+vader = Dog.new 'Vader'
+
+vader.on 'bark' do
+    puts 'Vader barked! OMGWTFBBQ!'
+end
+
+vader.bark
+```
+
+
+EventdServer Example
+---------------------
+
+```ruby
+require 'eventd'
+
+server = EventdServer.new :host => '127.0.0.1', :port => 8080
+
+server.run do
+    server.on 'connection' do |client|
+        client.on 'hello' do
+            client.emit 'hello!'
+        end
+    end
+end
+
+server.start
+```

data/lib/eventd/eventd_client.rb

@@ -0,0 +1,52 @@
+# EventdClient
+#
+# Communicates with an em-websocket web socket instance, wrapping it in an evented layer. Implements the
+# Eventd Websocket Communication Protocol described at:
+#
+# https://github.com/hydrais/shot/wiki/Eventd-Websocket-Communication-Protocol
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+require 'json'
+
+require_relative './eventd_object'
+
+class EventdClient < EventdObject
+
+	# em-websocket socket object
+	attr_accessor :socket
+
+	def initialize(socket)
+		super()
+		@socket = socket
+		setup_socket unless @socket == nil
+	end
+
+	def setup_socket
+		@socket.onopen do |handshake|
+			self.emit('connect', handshake, true)
+		end
+
+		@socket.onclose do
+			self.emit('disconnect', nil, true)
+		end
+
+		@socket.onmessage do |message|
+			self.emit('message', message, true)
+
+			emission = JSON.parse message
+			self.emit emission['channel'], emission['data']
+		end
+	end
+
+	def emit(channel, data = nil, local = false)
+		super(channel, data)
+
+		if not local
+			emission = { 'channel' => channel, 'priority' => 'normal', 'data' => data }
+			@socket.send emission.to_json
+		end
+	end
+end

data/lib/eventd/eventd_object.rb

@@ -0,0 +1,57 @@
+# EventdObject
+#
+# Implements an event-based architecture centered around the concept of *channels* and *listeners*. Each channel can
+# contain multiple listeners. An "emission" can be sent on a channel, which will be then sent to all corresponding
+# listeners on that channel. Emissions can have optional data sent with them to the listeners.
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+
+class EventdObject
+	attr_accessor :events
+
+	# Initialize the EventdObject and set up the events hash.
+	# Note:: It is important that you always call +super()+ so that the +events+ hash can be initialized
+
+	def initialize
+		@events = {}
+	end
+
+	# Add an event listener to a specified channel
+	#
+	# == Attributes
+	# * +channel+ - Channel to subscribe to
+	# * +callback+ - Callback block, which is triggered when an emission occurs on the channel
+
+	def on(channel, &callback)
+		@events[channel] = (@events[channel] or [])
+		@events[channel].push callback
+	end
+
+	# Remove all event listeners from a specified channel
+	#
+	# == Attributes
+	# * +channel+ - Channel to unsubscribe from
+
+	def off(channel)
+		@events[channel] = []
+	end
+
+	# Send an emission on a channel
+	#
+	# == Attributes
+	# * +channel+ - Channel to emit on
+	# * +data+ - Optional. Data to send along with the emission.
+
+	def emit(channel, data = nil)
+		emit 'emission', { :channel => channel, :data => data } unless channel == 'emission'
+
+		@events[channel] = (@events[channel] or [])
+
+		@events[channel].each do |callback|
+			if data == nil then callback.call else callback.call data end
+		end
+	end
+end

data/lib/eventd/eventd_server.rb

@@ -0,0 +1,61 @@
+# EventdServer
+#
+# Wraps the em-websocket library in an event-based system. All incoming clients are also converted
+# to EventdClients, which implement the Eventd Websocket Communication Protocol described at:
+#
+# https://github.com/hydrais/shot/wiki/Eventd-Websocket-Communication-Protocol
+#
+# Shot Framework - Copyright (c) Jesse Aaron Dunlap <me@jessedunlap.me>
+# Licensed under the MIT License. For full licensing information, please
+# see LICENSE.md. http://github.com/JesseDunlap/shot/
+
+
+require 'em-websocket'
+require_relative './eventd_object'
+require_relative './eventd_client'
+
+class EventdServer < EventdObject
+	# Configuration options for em-websocket and the EventdServer
+	attr_accessor :options
+
+	# Callback block which is called when the server starts for threading purposed
+	attr_accessor :run_callback
+
+	# Initialize the EventdServer with configuration options
+	#
+	# == Attributes
+	# * +options+ - Configuration hash which will be used as the initial EventdServer configuration
+
+	def initialize(options)
+		super()
+		@options = options
+	end
+
+	# Add to the EventdServer configuration
+	#
+	# == Attributes
+	# * +options+ - Configuration hash to merge with the existing configuration
+
+	def configure(options)
+		@options.merge! options
+	end
+
+	# Start the server
+
+	def start
+		EM.run do
+			@run_callback.call
+
+			EM::WebSocket.run @options do |socket|
+				client = EventdClient.new socket
+				self.emit 'connection', client
+			end
+		end
+	end
+
+	# Special event listener which is triggered when the server runs
+
+	def run(&callback)
+		@run_callback = callback
+	end
+end

data/lib/eventd.rb

@@ -1,17 +1,3 @@
-class Eventd
-	def initialize
-		@emitters = {}
-	end
-
-	def on(emitter_name, &callback)
-		(@emitters[emitter_name] = (@emitters[emitter_name] || [])).push callback
-	end
-
-	def off(emitter_name)
-		@emitters[emitter_name] = []
-	end
-
-	def emit(emitter_name, parameters = nil)
-		(@emitters[emitter_name] || []).each do |callback| callback.call parameters end
-	end
-end
+require_relative './eventd/eventd_server'
+require_relative './eventd/eventd_client'
+require_relative './eventd/eventd_object'

metadata

@@ -1,44 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: eventd
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
-- Jesse Dunlap
+- Jesse A. Dunlap
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-18 00:00:00.000000000 Z
-dependencies: []
-description: A quick architecture that can be used to add eventing support to any
-  object
+date: 2013-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Eventd provides a clear and comprehensive structure to add evented functionality
+  to any object. Eventd also implements an event-based Web Socket server, which is
+  a wrapper around em-websockets.
 email: me@jessedunlap.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/eventd/eventd_client.rb
+- lib/eventd/eventd_object.rb
+- lib/eventd/eventd_server.rb
 - lib/eventd.rb
-homepage: ''
-licenses: []
-metadata: {}
+- LICENSE.md
+- README.md
+homepage: http://github.com/shot/
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
-summary: Add eventing support to any object!
+specification_version: 3
+summary: A simple, clever way of adding event-based functionality to Ruby objects.
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 73d3d294cf56822b928463281bb0ad466abe0de5
-  data.tar.gz: 127b2e6476bd229a1d788b282bbef8655e6c2789
-SHA512:
-  metadata.gz: a533058737df7dd30638fb25e55ec0fc7da00bfec54cfc28a2cdd270ad23175f639c9597ffd6eaf9be1a62df7d460806de379d2b1d10b00985c686aac10bcfdd
-  data.tar.gz: 78a14581e774dbee1c3c0349dbae8c623dc1dab490f2f735bfd7cd57fcc76fa6bc377d87b4a988901dc08b8ebd278c6068069ed9a4a977b796473685f11897f7