RubyGems - websocket-gui - Versions diffs - 0.0.1 → 0.0.2 - Mend

websocket-gui 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f9b2ada3cef153c8ebd85ff255e143068f21dcd
-  data.tar.gz: 0d95a12c9c9fdf239b5f9f4ca26d598766a600cd
+  metadata.gz: 810ab8cd2d4babe30b454e23331a26ca3157098a
+  data.tar.gz: 7c52fdad5960f6f53b9edd756e1f8619d890371e
 SHA512:
-  metadata.gz: b1ba9084cbfcd657ea4e3cda19fbf071ce5497925d2537ca5d219b30b7038eb4c225dfbe4efbb1a7fe753df9721953b8d110a4843fb2a5776e4aed2efe289fc8
-  data.tar.gz: 7bf16018e44381dded3b25ea882ed0155d9339b6bdc631ff832ec8c8078ae9e927ab04270d47150dfbbe2f8e0d031225c075e71be51a49207d4b8a7c5ccc05f5
+  metadata.gz: 8580c9917dc555e4a3e04debbe011a9dfcd51051705f2ad10ae52d2fde2f905c3db2fecf4af7c04b6b1088a7ce64b43d10739ad6c3fe2946404b2048a279a9ea
+  data.tar.gz: 695ae7d48e95d493b0d7feffea44e66b03227b6b05beba145f5a2efddf09728b68ba0afd95c11c44fb5ce47537b38c8a1b25c4282f32e65a4731d880e05228ad

data/README.md CHANGED Viewed

@@ -1,5 +1,5 @@
 #	Websocket Gui
-This gem uses Sinatra, EventMachine, and Web Sockets to make it easy to use the browser as a GUI for Ruby apps that
+This gem uses Sinatra, EventMachine, and WebSockets to make it easy to use the browser as a GUI for Ruby apps that
 would otherwise be stuck in the console.
@@ -9,12 +9,12 @@ To use this gem, make a class that extends WebsocketGui::Base and a HTML/JS file
 ### Configuration
 The following configuration options are available:
-	:socket_port 	(8080)
-	:socket_host 	(127.0.0.1)
-	:http_port		(3000)
-	:http_host		(127.0.0.1)
-	:view			(:index)
-	:tick_interval	(nil)
+* :socket\_port 		(8080)
+* :socket\_host 		(127.0.0.1)
+* :http\_port		(3000)
+* :http\_host		(127.0.0.1)
+* :view			(:index)
+* :tick\_interval	(nil)
 The options can be set in several ways, each level overriding the previous:
 1 In declaring your subclass of WebsocketGui::Base (like tick\_interval below)
@@ -22,7 +22,7 @@ The options can be set in several ways, each level overriding the previous:
 1 By passing an options hash to the run! method
-###	project-root/app.rb
+###	Sample Code: project-root/app.rb
 	require 'websocket-gui'
 	class App < WebsocketGui::Base
@@ -57,6 +57,16 @@ The options can be set in several ways, each level overriding the previous:
 		on_socket_close do
 			puts "Socket closed."
 		end
+		#	custom handler
+		#	trigger by sending JSON like this from the client:
+		#	{ event: 'custom_buttom_click', params: { ...} }
+		on_custom_button_click do |params|
+			socket_send "Custom event triggered! Params provided were:"
+			params.each do |k,v|
+				socket_send "#{k} = #{v}"
+			end
+		end
 	end
 	#	specify options in the constructor and/or the run method.
@@ -65,7 +75,7 @@ The options can be set in several ways, each level overriding the previous:
-###	project-root/index.erb
+###	Sample Code: project-root/index.erb
 	<!doctype html>
 	<html>
@@ -93,6 +103,12 @@ The options can be set in several ways, each level overriding the previous:
 					var writeMessage = function (msg) {
 						$("<li></li>").text (msg).appendTo ($("#output"));
 					};
+					var sendEvent = function (event, params) {
+						socket.send (JSON.stringify ({
+							event: event,
+							params: params
+						}));
+					};
 					socket.onmessage = function (evt) {
 						writeMessage (evt.data);
 					};
@@ -115,6 +131,13 @@ The options can be set in several ways, each level overriding the previous:
 							input.val ('');
 						}
 					});
+					$("#custom").on ('click', function () {
+						sendEvent('custom_button_click', {
+							a: 1,
+							b: "Two",
+							c: "III"
+						});
+					});
 				}
 				$("#connect").on ('click', function () { connect (); } );
 				$("#disconnect").on ('click', function () { socket.close (); });
@@ -137,7 +160,3 @@ The options can be set in several ways, each level overriding the previous:
 	This will start the socket server and sinatra, and launch a browser with your view.
-## todo
-* Create a small JS library that wraps the native websocket and makes it easy to post events to the server.
-* Expand event handlers so you can write events like `on_start do |params|` instead of having to do parse raw strings and do everything in on\_socket\_recv

data/examples/example.rb CHANGED Viewed

@@ -22,6 +22,14 @@ class ExampleWebSocketApp < WebsocketGui::Base
 	on_socket_close do
 		puts "Socket closed."
 	end
+	#	custom handler
+	on_custom_button_click do |params|
+		socket_send "Custom event triggered! Params provided were:"
+		params.each do |k,v|
+			socket_send "#{k} = #{v}"
+		end
+	end
 end
 if __FILE__ == $0

data/examples/index.erb CHANGED Viewed

@@ -13,11 +13,19 @@
 	<body>
 		<div id="connectedContainer" style="display:none;">
-			<textarea id="input"></textarea>
-			<input type="button" id="send" value="Send" />
+			<textarea id="input" rows="4" cols="40"></textarea>
+			<p>
+				<input type="button" id="send" value="Send" />
+			</p>
+			<p>
+				<input type="button" id="custom" value="Send Custom Event" />
+			</p>
 			<ul id="output"></ul>
-			<input type="button" id="disconnect" value="Disconnect" />
+			<p>
+				<input type="button" id="disconnect" value="Disconnect" />
+			</p>
 		</div>
 		<div id="notConnectedContainer">
 			<input type="button" id="connect" value="Connect" />
@@ -30,6 +38,12 @@
 				var writeMessage = function (msg) {
 					$("<li></li>").text (msg).appendTo ($("#output"));
 				};
+				var sendEvent = function (event, params) {
+					socket.send (JSON.stringify ({
+						event: event,
+						params: params
+					}));
+				};
 				socket.onmessage = function (evt) {
 					writeMessage (evt.data);
 				};
@@ -52,6 +66,13 @@
 						input.val ('');
 					}
 				});
+				$("#custom").on ('click', function () {
+					sendEvent('custom_button_click', {
+						a: 1,
+						b: "Two",
+						c: "III"
+					});
+				});
 			}
 			$("#connect").on ('click', function () { connect (); } );

data/lib/websocket-gui/base.rb CHANGED Viewed

@@ -45,7 +45,7 @@ module WebsocketGui
 					end
 					socket.onmessage do |msg|
-						socket_trigger(:on_socket_recv, msg)
+						process_message(msg)
 					end
 					socket.onclose do
@@ -72,8 +72,31 @@ module WebsocketGui
 		private
+		def handler_exists?(method)
+			@config[method].kind_of? Proc
+		end
 		def socket_trigger(method, *args)
-			self.instance_exec(*args, &@config[method]) if @config[method].kind_of? Proc
+			self.instance_exec(*args, &@config[method]) if handler_exists? method
+		end
+		def process_message(msg)
+			begin
+				data = JSON.parse(msg)
+				if data && data['event'] && data['params']
+					event_method = ('on_' + data['event']).to_sym
+					if handler_exists? event_method
+						socket_trigger(event_method, data['params'])
+						return
+					end
+				end
+				rescue JSON::ParserError
+					#	fall through to trigger :on_socket_recv
+			end
+			socket_trigger(:on_socket_recv, msg)
 		end
 	end
 end

data/lib/websocket-gui/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module WebsocketGui
-	VERSION = '0.0.1'
+	VERSION = '0.0.2'
 end

data/lib/websocket-gui.rb CHANGED Viewed

@@ -4,6 +4,7 @@ require "em-websocket"
 require "sinatra"
 require "thin"
 require "launchy"
+require "json"
 require "websocket-gui/base"
 require "websocket-gui/sinatra_wrapper"

data/websocket-gui.gemspec CHANGED Viewed

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Use the browser as a GUI for local Ruby apps.}
   spec.homepage      = ""
   spec.license       = "MIT"
+  spec.homepage		 = "https://github.com/grossvogel/websocket-gui"
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -28,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'sinatra', '~> 1.4.3'
   spec.add_runtime_dependency 'thin', '>= 1.5.1'
   spec.add_runtime_dependency 'launchy', '~> 2.3.0'
+  spec.add_runtime_dependency 'json', '>= 1.7.7'
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket-gui
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jason Pollentier
@@ -108,6 +108,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
 description: |
   Use Sinatra, Websockets, and EventMachine to create
     an event-based GUI for Ruby projects that would otherwise be stuck in the console.
@@ -132,7 +146,7 @@ files:
 - spec/base_spec.rb
 - spec/spec_helper.rb
 - websocket-gui.gemspec
-homepage: ''
+homepage: https://github.com/grossvogel/websocket-gui
 licenses:
 - MIT
 metadata: {}