sarb 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+# Text-editor extra files
+*.swp
+
+# Version Manager files
+.rvmrc
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rspec"
+gem "em-websocket"
+

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.2)
+    em-websocket (0.5.0)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.5.3)
+    eventmachine (1.0.3)
+    http_parser.rb (0.5.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  em-websocket
+  rspec

data/README.md

@@ -0,0 +1,26 @@
+# Socket Action Ruby (sarb)
+
+Framework for em-websocket that uses actions and triggers for real-time communication with your app.
+
+## Example
+
+```ruby
+require "sarb"
+
+app = Sarb::Application.new
+app.action(:foo) { |session, args| session.message(:action => :bar) }
+app.run
+```
+
+On client side:
+
+```javascript
+var ws = new WebSocket("ws://127.0.0.1:8080/");
+ws.onmessage = function(message) { console.log(message) };
+ws.send(JSON.stringify({ action: "foo" }))
+```
+
+## License
+
+The MIT License - Copyright (c) 2012-2013 Craig Jackson
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "rubygems"
+require "rake"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/sarb/application.rb

@@ -0,0 +1,52 @@
+module Sarb
+  class Application
+    DEFAULTS = {
+      :host => "127.0.0.1",
+      :port => 8080
+    }
+
+    def initialize
+      @actions = {}
+      @hooks = {
+        :connection_open => [method(:connection_open)],
+        :connection_close => [method(:connection_close)]
+      }
+      @connections = []
+    end
+
+    def action(name, &block)
+      @actions[name.to_sym] = block
+    end
+
+    def hook(name, &block)
+      @hooks[name.to_sym] = [] unless @hooks.has_key?(name.to_sym)
+      @hooks[name.to_sym] << block
+    end
+
+    def new_connection(ws)
+      Connection.setup(self, ws)
+    end
+
+    def connection_open(args)
+      @connections << args[:connection]
+    end
+
+    def connection_close(args)
+      @connections.delete(args[:connection])
+    end
+
+    def run(options = {})
+      EventMachine::WebSocket.start(DEFAULTS.merge(options), &method(:new_connection))
+    end
+
+    def invoke(connection, message)
+      data = JSON.parse(message)
+      @actions[data["action"].to_sym].call(connection, data["args"])
+    end
+
+    def trigger(name, args)
+      @hooks[name.to_sym].each { |block| block.call(args) }
+    end
+  end
+end
+

data/lib/sarb/connection.rb

@@ -0,0 +1,32 @@
+module Sarb
+  class Connection
+    def initialize(app, ws)
+      @app = app
+      @ws = ws
+    end
+
+    def onopen(handshake)
+      @app.trigger :connection_open, :connection => self
+    end
+
+    def onmessage(message)
+      @app.invoke self, message
+    end
+
+    def onclose(event)
+      @app.trigger :connection_close, :connection => self
+    end
+
+    def message(message)
+      @ws.send(message.to_json)
+    end
+
+    def self.setup(app, ws)
+      connection = Connection.new(app, ws)
+      ws.onopen &connection.method(:onopen)
+      ws.onmessage &connection.method(:onmessage)
+      ws.onclose &connection.method(:onclose)
+    end
+  end
+end
+

data/lib/sarb/version.rb

@@ -0,0 +1,8 @@
+module Sarb
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY = 0
+  end
+end
+

data/lib/sarb.rb

@@ -0,0 +1,10 @@
+require "em-websocket"
+require "json"
+
+require "sarb/application"
+require "sarb/connection"
+require "sarb/version"
+
+module Sarb
+end
+

data/sarb.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = "sarb"
+  s.version     = "0.1.0"
+  s.summary     = "Socket Action Ruby"
+  s.description = "Framework for em-websocket that uses actions and triggers for real-time communication with your app."
+  s.authors     = ["Craig Jackson"]
+  s.email       = "tapocol@gmail.com"
+  s.homepage    = "https://github.com/craigjackson/sarb"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("em-websocket", ">= 0.5.0")
+end
+

data/spec/lib/sarb/application_spec.rb

@@ -0,0 +1,139 @@
+require "spec_helper"
+
+describe Sarb::Application do
+  before do
+    @app = Sarb::Application.new
+  end
+
+  context "initialize" do
+    it "should set @actions @hooks @connections" do
+      @app.instance_variable_get(:@actions).should == {}
+      @app.instance_variable_get(:@hooks).should == {
+        :connection_open => [@app.method(:connection_open)],
+        :connection_close => [@app.method(:connection_close)]
+      }
+      @app.instance_variable_get(:@connections).should == []
+    end
+  end
+
+  context "action" do
+    it "should add an action" do
+      block = Proc.new {}
+      @app.action :foo, &block
+      expected = {:foo => block}
+      @app.instance_variable_get(:@actions).should == expected
+    end
+
+    it "should add an action and convert name to sym" do
+      block = Proc.new {}
+      @app.action "foo", &block
+      expected = {:foo => block}
+      @app.instance_variable_get(:@actions).should == expected
+    end
+  end
+
+  context "hook" do
+    before do
+      @app.instance_variable_set(:@hooks, {})
+    end
+
+    it "should add a new hook" do
+      block = Proc.new {}
+      @app.hook :foo, &block
+      expected = {:foo => [block]}
+      @app.instance_variable_get(:@hooks).should == expected
+    end
+
+    it "should add a new hook and convert name to sym" do
+      block = Proc.new {}
+      @app.hook "foo", &block
+      expected = {:foo => [block]}
+      @app.instance_variable_get(:@hooks).should == expected
+    end
+
+    it "should add a new hook to the existing hooks" do
+      block1 = Proc.new { "block1" }
+      @app.instance_variable_set(:@hooks, {:foo => [block1]})
+      block2 = Proc.new { "block2" }
+      @app.hook :foo, &block2
+      expected = {:foo => [block1, block2]}
+      @app.instance_variable_get(:@hooks).should == expected
+    end
+  end
+
+  context "new_connection" do
+    it "should pass along the websocket to the Connection and set onmessage event" do
+      @connection = Sarb::Connection.new(@app, "ws")
+      Sarb::Connection.should_receive(:setup).with(@app, "ws").and_return(@connection)
+      @app.new_connection("ws").should === @connection
+    end
+  end
+
+  context "connection_open" do
+    it "should add to @connections" do
+      connection = "connection"
+      @app.connection_open({:connection => connection})
+      @app.instance_variable_get(:@connections).should == [connection]
+    end
+  end
+
+  context "connection_close" do
+    it "should remove from @connections" do
+      connection1 = "connection1"
+      connection2 = "connection2"
+      @app.instance_variable_set(:@connections, [connection1, connection2])
+      @app.connection_close({:connection => connection1})
+      @app.instance_variable_get(:@connections).should == [connection2]
+    end
+  end
+
+  context "run" do
+    it "should start an EventMachine::WebSocket with defaults" do
+      method = Proc.new {}
+      @app.stub(:method => method)
+      # TODO: Not really sure how to test &method is passed. "with" does not actually test &method.
+      EventMachine::WebSocket.should_receive(:start).with(Sarb::Application::DEFAULTS, &method)
+      @app.run
+    end
+
+    it "should start an EventMachine::WebSocket with given host and default port" do
+      method = Proc.new {}
+      @app.stub(:method => method)
+      # TODO: Not really sure how to test &method is passed. "with" does not actually test &method.
+      EventMachine::WebSocket.should_receive(:start).with(:host => "testhost", :port => Sarb::Application::DEFAULTS[:port], &method)
+      @app.run :host => "testhost"
+    end
+
+    it "should start an EventMachine::WebSocket with default host and given port" do
+      method = Proc.new {}
+      @app.stub(:method => method)
+      # TODO: Not really sure how to test &method is passed. "with" does not actually test &method.
+      EventMachine::WebSocket.should_receive(:start).with(:host => Sarb::Application::DEFAULTS[:host], :port => "testport", &method)
+      @app.run :port => "testport"
+    end
+  end
+
+  context "invoke" do
+    it "should call action's method" do
+      @ws = "ws"
+      connection = Sarb::Connection.new(@app, @ws)
+      block = Proc.new {}
+      @app.instance_variable_set(:@actions, {:action => block})
+      JSON.should_receive(:parse).with("message").and_return({"action" => "action", "args" => {"foo" => "bar"}})
+      block.should_receive(:call).with(connection, {"foo" => "bar"})
+      @app.invoke(connection, "message")
+    end
+  end
+
+  context "trigger" do
+    it "should call all hooks' methods" do
+      block1 = Proc.new { "block1" }
+      block2 = Proc.new { "block2" }
+      @app.instance_variable_set(:@hooks, {:foo => [block1, block2]})
+      block1.should_receive(:call).with({:foo => :bar})
+      block2.should_receive(:call).with({:foo => :bar})
+      @app.trigger "foo", {:foo => :bar}
+    end
+  end
+end
+

data/spec/lib/sarb/connection_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+describe Sarb::Connection do
+  before do
+    @app = Sarb::Application.new
+    @ws = EventMachine::WebSocket::Connection.new("asdf1234", {})
+    @connection = Sarb::Connection.new(@app, @ws)
+  end
+
+  context "initialize" do
+    it "should set app and ws" do
+      @connection.instance_variable_get(:@app).should === @app
+      @connection.instance_variable_get(:@ws).should === @ws
+    end
+  end
+
+  context "onopen" do
+    before do
+      @handshake = EventMachine::WebSocket::Handshake.new("asdf1234")
+    end
+
+    it "should trigger app :connection_open" do
+      @app.should_receive(:trigger).with(:connection_open, {:connection => @connection})
+      @connection.onopen(@handshake)
+    end
+  end
+
+  context "onmessage" do
+    it "should use the app's handler" do
+      @app.should_receive(:invoke).with(@connection, "message")
+      @connection.onmessage("message")
+    end
+  end
+
+  context "onclose" do
+    it "should trigger app :connection_close" do
+      @app.should_receive(:trigger).with(:connection_close, {:connection => @connection})
+      @connection.onclose({})
+    end
+  end
+
+  context "message" do
+    it "should send through ws" do
+      message = "message"
+      message.should_receive(:to_json).and_return("message_str")
+      @ws.should_receive(:send).with("message_str")
+      @connection.message(message)
+    end
+  end
+
+  context "setup" do
+    it "should create new Connection and add 'on' events" do
+      Sarb::Connection.should_receive(:new).with(@app, @ws).and_return(@connection)
+      # TODO: Putting the intended blocks in the 'with' method on the following stubs causes an error.
+      @ws.should_receive(:onopen)
+      @ws.should_receive(:onmessage)
+      @ws.should_receive(:onclose)
+      Sarb::Connection.setup(@app, @ws)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "rubygems"
+require "bundler/setup"
+
+require "sarb"
+

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: sarb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Craig Jackson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: &7758080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *7758080
+description: Framework for em-websocket that uses actions and triggers for real-time
+  communication with your app.
+email: tapocol@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/sarb.rb
+- lib/sarb/application.rb
+- lib/sarb/connection.rb
+- lib/sarb/version.rb
+- sarb.gemspec
+- spec/lib/sarb/application_spec.rb
+- spec/lib/sarb/connection_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/craigjackson/sarb
+licenses: []
+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.10
+signing_key: 
+specification_version: 3
+summary: Socket Action Ruby
+test_files: []