eventd 1.0.4 → 1.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2E5ZmVkODExOTk5NjE2OWVkYjQ2ZWQ1Y2U4MDk3M2UxMDUwZmE4Yw==
+  data.tar.gz: !binary |-
+    M2JkZDNmZjQ1MGVlYzUxNDA2MGRjZmQxNDQzNzlkMmRmMTExYWY1OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTc4Yjc0OGMwZmQ2OGM3NGVmNmZhMjljNzZlOTRmNDEwMGEwMmM1YjhhNzI3
+    ZGIwOTM5YTljN2ZmNGQzODdjMDU4ZDlkZGY5YzY2YjlhOTRiZDg5NzY1Y2U1
+    ZWVmMWMwOGRlNjk0NWUwZjRlNjllMGIwYmRjMDFjZTJmMjI1Y2Q=
+  data.tar.gz: !binary |-
+    NjRlMWJjNWU1NzcyZGQ4OWEyNzFmYzlhNDRjOTY3NTI0NTQ1ZDU0NmU5MTA1
+    NGEwYTc3YWUxM2IwZGJlNmJhZDE1M2IxM2VlNmM4OWM4OGJkYjgwODYxYjM4
+    OWIzMTI2MzMxOWZmMWNjNzVmYjA5ZThmZDViNTZhOTlkZmJlMGQ=

data/README.md

@@ -1,61 +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 inherit from ``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
-```
+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 inherit from ``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

@@ -12,12 +12,19 @@
 require 'json'
 
 require_relative './eventd_object'
+require_relative './eventd_element'
 
 class EventdClient < EventdObject
 
 	# em-websocket socket object
 	attr_accessor :socket
 
+	# Initializer
+	#
+	# == Attributes
+	# * +socket+
+	# * +server+
+
 	def initialize(socket, server = nil)
 		super()
 		@socket = socket
@@ -25,6 +32,8 @@ class EventdClient < EventdObject
 		setup_socket unless @socket == nil
 	end
 
+	# Handle required events from the socket
+
 	def setup_socket
 		@socket.onopen do |handshake|
 			self.emit('connect', handshake, true)
@@ -50,6 +59,13 @@ class EventdClient < EventdObject
 		end
 	end
 
+	# Send an emission to the client side library
+	#
+	# == Attributes
+	# * +channel+
+	# * +data+
+	# * +local+
+
 	def emit(channel, data = nil, local = false)
 		super(channel, data)
 
@@ -59,6 +75,12 @@ class EventdClient < EventdObject
 		end
   end
 
+  # Send a broadcast to other clients
+  #
+  # == Attributes
+  # * +channel+
+  # * +data+
+
   def broadcast(channel, data = nil)
     if @server.broadcast_channel_allowed? channel
       @server.clients.each do |client| client.emit channel, data end
@@ -66,4 +88,13 @@ class EventdClient < EventdObject
       self.emit 'error', "Broadcasts are not allowed on channel: #{channel}"
     end
   end
+
+  # Instantiate a new EventdElement
+  #
+  # == Attributes
+  # * +selector+
+  
+  def element(selector)
+  	EventdElement.new(selector, self)
+  end
 end

data/lib/eventd/eventd_element.rb

@@ -0,0 +1,69 @@
+# EventdElement
+#
+# Object representation of an element on the client's page. Mimics a jQuery style API.
+#
+# 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 EventdElement < EventdObject
+	# Instance of EventdClient, which is used to trigger interface emissions
+	attr_accessor :client
+
+	# jQuery Selector associated with the element
+	attr_accessor :selector
+
+	# Initializer
+	#
+	# == Attributes
+	# * +selector+
+	# * +client+
+
+	def initialize(selector, client)
+		super()
+		@selector = selector
+		@client = client
+	end
+
+	# Handles any method called, and attempts to turn it into a valid jQuery call
+
+	def method_missing(method, *attributes, &block)
+		self.jq method, attributes
+	end
+
+	# Call a jQuery method
+	#
+	# == Attribtues
+	# * +method+
+	# * +*attributes+
+
+	def jq(method, *attributes)
+		@client.emit "eapi_jq", {
+			:selector => @selector,
+			:method => method,
+			:attributes => attributes
+		}
+	end
+
+	# Add an event listener
+	# 
+	# == Attributes
+	# * +event+
+	# * +&callback+
+
+	def on(event, &callback)
+		random_callback_id = SecureRandom.uuid
+		
+		@client.emit "eapi_event", {
+			:selector => @selector,
+			:callback => random_callback_id,
+			:event => event
+		}
+
+		@client.on random_callback_id do
+			callback.call
+		end
+
+		super(event, callback)
+	end
+end

data/lib/eventd/eventd_object.rb

@@ -1,57 +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
+# 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

@@ -75,6 +75,12 @@ class EventdServer < EventdObject
 		@run_callback = callback
   end
 
+  # Allows you to extend the functionality of a server, through a plugin
+
+  def plugin(&callback)
+    callback.call self
+  end
+
   # Allow any broadcast
 
   def allow_broadcasts

data/lib/eventd.rb

@@ -1,3 +1,3 @@
-require_relative './eventd/eventd_server'
-require_relative './eventd/eventd_client'
+require_relative './eventd/eventd_server'
+require_relative './eventd/eventd_client'
 require_relative './eventd/eventd_object'

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: eventd
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.0.5
 platform: ruby
 authors:
 - Jesse A. Dunlap
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-29 00:00:00.000000000 Z
+date: 2013-08-23 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
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: flexmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -52,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/eventd/eventd_client.rb
+- lib/eventd/eventd_element.rb
 - lib/eventd/eventd_object.rb
 - lib/eventd/eventd_server.rb
 - lib/eventd.rb
@@ -60,26 +56,25 @@ files:
 homepage: http://github.com/shot/
 licenses:
 - MIT
+metadata: {}
 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: 1.8.24
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple, clever way of adding event-based functionality to Ruby objects.
 test_files: []