jstp 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jstp.gemspec
+gemspec
+
+group :debug do 
+  gem 'pry'
+end

data/JSTP.es.md

@@ -0,0 +1,41 @@
+JSTP es un protocolo de comunicación serializado en JSON montado sobre websockets que utiliza por defecto el puerto 33333. 
+
+El protocolo es simétrico: esto quiere decir que hay un solo tipo de mensajes. La acción de enviar un mensaje es un `dispatch`. Siendo que es basado en WebSockets, es también asincrónico, significando que los Dispatch no tienen porqué recibir respuesta. Para facilitar seguimiento de un hilo de comunicación, JSTP provee un encabezado `token` donde se sugiere ingresar un hash de control (similar al Etag de HTTP). El encabezado `token` es extensible a un array para contener varios tokens con distinta prioridad.
+
+La estructura de cabeceras, métodos (acciones), nombres de recursos y cuerpo de mensaje está diseñada para ser completamente compatible con REST (implicando que se puede hacer _fallback_ a HTTP regular si es necesario). Las cabeceras no necesariamente incluyen todo los mismos datos que las de HTTP regular, pero es posible incluir la misma información. Una Dispatch de ejemplo sería:
+
+    {
+      "protocol": ["JSTP", "0.1"]
+      "method": "POST", 
+      "resource": [
+        "session.manager",
+        "User"
+      ],
+      "timestamp": 1357334118,
+      "token": 3523902859084057289594,
+      "referer": [
+        "browser",
+        "Registerer"
+      ],
+      "body": {
+        "login": "xavier",
+        "email": "xavier@fetcher.com",
+        "password": "secret"
+      }
+    }
+
+Un JSTP Dispatch es representable en forma abreviada similar en un HTTP Request. De esta manera, el ejemplo de arriba se puede presentar como:
+
+    POST session.manager/User JSTP/0.1
+    timestamp: 1357334118
+    token: 3523902859084057289594
+    referer: browser/Registerer
+    
+    login: xavier
+    email: xavier@fetcher.com
+    password: secret
+
+Gateways
+-------------
+
+Todo servidor de JSTP conoce su host, que corresponde a la parte inicial del mensaje. Si el host del mensaje recibido no se corresponde con el 

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fernando Vía, Matías Domingues, Luciano Bertenasco
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# JSTP Ruby Gem
+
+Server & Client reference implementation of the sketch protocol JSTP (JavaScript Serialization Transfer Protocol). Here follows the basics of the protocol as of version 0.1.
+
+JSTP
+----
+
+JSTP is a communication protocol based on JSON serialization that works over websockets in the default TCP port `33333`. It's inspired and aimed to maintain compatibility with HTTP as used in REST architectures but using JSON as the protocol language.
+
+The protocol is symmetrical: this means that there is only one type of message, in constrast to _Request-Response_ kind of protocols such as `HTTP`. Sending a message is called `dispatch` in the JSTP vocabulary. As JSTP is built upon Web Sockets, is also by design asynchronous, meaning that a Dispatch is not necessarily follow by any kind of response by the receiver. To facilitate the follow up in communication threads, JSTP provides a `token` header which we suggest to fill with a control hash (a similar concept to HTTP's Etag header). As much of the headers, the `token` header is extensible to an array capable of containing several tokens ordered by priority (is still to be seen is all JSTP headers by default will support or not multiple values).
+
+The headers types, available protocol methods, resource taxonomy and message body are designed to be 100% compatible with REST (implying that system that make use of JSTP for their network communications may fall back to plain HTTP if technical limitations require it). Headers are not bound to include all of the same data that HTTP regular _Requests_ or _Responses_, but can.
+
+An sample Dispatch will look like:
+
+    {
+      "protocol": ["JSTP", "0.1"]
+      "method": "POST", 
+      "resource": [
+        "session.manager",
+        "User"
+      ],
+      "timestamp": 1357334118,
+      "token": 3523902859084057289594,
+      "referer": [
+        "browser",
+        "Registerer"
+      ],
+      "body": {
+        "login": "xavier",
+        "email": "xavier@fetcher.com",
+        "password": "secret"
+      }
+    }
+
+A **JSTP Dispatch** can also be formatted in a short hand notation similar to that of an HTTP Request. The previous example can be presented as follows:
+
+    POST session.manager/User JSTP/0.1
+    timestamp: 1357334118
+    token: 3523902859084057289594
+    referer: browser/Registerer
+    
+    login: xavier
+    email: xavier@fetcher.com
+    password: secret
+
+Gateways
+--------
+
+Every JSTP server knows its own hostname, which should match the first string in the resource array of the message. If the host as received in the message does not corresponds to this server, it should look up for the right server and dispatch it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jstp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jstp

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/jstp.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/jstp/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Xavier Via", "Luciano Bertenasco", "Matias Domingues"]
+  gem.email         = ["xavierviacanel@gmail.com"]
+  gem.description   = %q{Reference implementation for the sketch protocol JSTP}
+  gem.summary       = %q{Reference implementation for the sketch protocol JSTP}
+  gem.homepage      = "https://github.com/Fetcher/jstp"
+
+  gem.add_dependency 'em-websocket'
+  gem.add_dependency 'em-websocket-client'
+
+  gem.add_development_dependency 'rspec'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "jstp"
+  gem.require_paths = ["lib"]
+  gem.version       = Jstp::VERSION
+end

data/lib/jstp.rb

@@ -0,0 +1,17 @@
+require 'singleton'
+require 'em-websocket'
+require 'em-websocket-client'
+require 'json'
+
+require 'jstp/event/on_message'
+require 'jstp/connector'
+require 'jstp/api'
+require 'jstp/registry'
+require 'jstp/server'
+require 'jstp/event_machine'
+
+module JSTP
+  class << self
+    include API
+  end
+end

data/lib/jstp/api.rb

@@ -0,0 +1,9 @@
+module JSTP
+  module API
+    def dispatch &block
+      JSTP::Registry.instance.set block
+
+      ::EventMachine.run &JSTP::EventMachine
+    end
+  end
+end

data/lib/jstp/connector.rb

@@ -0,0 +1,25 @@
+module JSTP
+
+  # Handles the connection functionality for this JSTP reference implementation
+  class Connector
+    include Singleton
+
+    # Discovers the server and sends the message
+    # @param [Hash/Array] message
+    def dispatch message
+      client(message["resource"]).send_msg message.to_json
+    end
+
+    # Access to the client pool
+    # @param [Array] the resource data
+    # @return [EventMachine::WebSocketClient] the client for the address
+    def client resource
+      ::EventMachine::WebSocketClient.connect "ws://#{resource.first}:33333/#{resource[1..-1].join('/')}"
+    end
+
+    # Sets up the server to be executed within an EventMachine reactor
+    def server
+      ::EventMachine::WebSocket.start host: "0.0.0.0", port: 33333, &JSTP::Server
+    end
+  end
+end

data/lib/jstp/event/on_message.rb

@@ -0,0 +1,7 @@
+module JSTP
+  module Event
+    OnMessage = proc { |message|
+      JSTP::Registry.instance.get.call JSON.parse message
+    }
+  end
+end

data/lib/jstp/event_machine.rb

@@ -0,0 +1,5 @@
+module JSTP
+  EventMachine = proc {
+    JSTP::Connector.instance.server
+  }
+end

data/lib/jstp/registry.rb

@@ -0,0 +1,13 @@
+module JSTP
+  class Registry
+    include Singleton
+
+    def set block
+      @block = block
+    end
+
+    def get
+      @block
+    end
+  end
+end

data/lib/jstp/server.rb

@@ -0,0 +1,5 @@
+module JSTP
+  Server = proc { |websocket|
+    websocket.onmessage &Event::OnMessage
+  }
+end

data/lib/jstp/version.rb

@@ -0,0 +1,3 @@
+module Jstp
+  VERSION = "0.0.1"
+end

data/spec/jstp/api_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe JSTP::API do 
+  describe '#dispatch' do 
+    context 'a block is passed' do 
+      it 'should register the block and send JSTP::Server to the EventMachine reactor' do
+        block = proc {
+          "lalal"
+        }
+
+        JSTP::Registry.instance.should_receive(:set)
+          .with block
+
+        JSTP::EventMachine.should_receive :call
+        EventMachine.should_receive(:run)
+          .with &JSTP::EventMachine
+
+        o = Object.new
+        o.extend JSTP::API
+        o.dispatch &block
+      end
+    end
+  end
+end

data/spec/jstp/connector_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe JSTP::Connector do 
+  it 'should be a singleton' do 
+    JSTP::Connector.ancestors.should include Singleton
+  end
+
+  describe '#dispatch' do 
+    before do 
+      @message = {
+        "protocol" => ["JSTP", "0.1"],
+        "method" => "POST", 
+        "resource" => [
+          "session.manager",
+          "User"
+        ],
+        "timestamp" => 1357334118,
+        "token" => 3523902859084057289594,
+        "referer" => [
+          "browser",
+          "Registerer"
+        ],
+        "body" => {
+          "login" => "xavier",
+          "email" => "xavier@fetcher.com",
+          "password" => "secret"
+        }
+      }
+
+      @web_socket_client = stub 'web socket client'
+      @message_json = stub 'message json'
+    end
+
+    it 'should open a websocket to the correct resource in the standard port 33333 and set the callback' do 
+      JSTP::Connector.instance.should_receive(:client)
+        .with(@message["resource"])
+        .and_return @web_socket_client
+
+      @web_socket_client.should_receive(:send_msg)
+        .with(@message_json)
+      @message.should_receive(:to_json).and_return @message_json
+
+      JSTP::Connector.instance.dispatch @message
+    end
+  end
+
+  describe '#client' do 
+    context 'there is no connection for that address' do 
+      before do
+        @web_socket_client = stub 'web socket client'
+        @resource = ["localhost", "hola", "quetal"]
+      end
+
+      it 'should initialize the websocket client' do 
+        EventMachine::WebSocketClient.should_receive(:connect)
+          .with("ws://#{@resource.first}:33333/#{@resource[1..-1].join('/')}")
+          .and_return @web_socket_client
+
+        JSTP::Connector.instance
+          .client(@resource)
+          .should == @web_socket_client
+      end
+    end
+  end
+
+  describe '#server' do 
+    it 'should start a websocket server in 33333' do 
+      JSTP::Server.should_receive :call
+      EventMachine::WebSocket.should_receive(:start)
+        .with({ host: '0.0.0.0', port: 33333 }, &JSTP::Server)
+
+      JSTP::Connector.instance.server
+    end
+
+    it 'should pass the proc JSTP::Server' do
+      pending "Warning, this isn't actually testing the JSTP::Server, I don't know why"
+    end
+  end
+end

data/spec/jstp/event/on_message_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'JSTP::Event::OnMessage' do 
+  it 'should call the registered block with the parsed message' do 
+    @the_proc = stub 'the proc'
+    @message = stub 'message'
+    @parsed_message = stub 'parsed message'
+
+    JSON.should_receive(:parse).with(@message)
+      .and_return @parsed_message
+
+    JSTP::Registry.instance.should_receive(:get)
+      .and_return @the_proc
+
+    @the_proc.should_receive(:call)
+      .with @parsed_message
+
+    JSTP::Event::OnMessage.call @message
+  end
+end

data/spec/jstp/event_machine_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'JSTP::EventMachine' do 
+  it 'should ask the connector to initialize the server' do 
+    JSTP::Connector.instance.should_receive(:server)
+
+    JSTP::EventMachine.call
+  end
+end

data/spec/jstp/registry_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe JSTP::Registry do 
+  it 'should be a Singleton' do 
+    JSTP::Registry.ancestors.should include Singleton
+  end
+
+  describe '#get' do 
+    it 'should return the registered block' do 
+      @data = stub 'data'
+      JSTP::Registry.instance.set @data
+      JSTP::Registry.instance.get.should == @data
+    end
+  end
+
+  describe '#set' do 
+    it 'should set the block in the registry' do 
+      @data = stub 'data'
+      JSTP::Registry.instance.set @data
+      JSTP::Registry.instance.get.should == @data
+    end
+  end
+end

data/spec/jstp/server_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'JSTP::Server' do 
+  it 'should set JSTP::Event::OnMessage to onmessage' do
+    server = stub 'server'
+    JSTP::Event::OnMessage.stub :call
+
+    server.should_receive(:onmessage)
+      .with(&JSTP::Event::OnMessage)
+
+    JSTP::Server.call server
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'jstp'

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: jstp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Xavier Via
+- Luciano Bertenasco
+- Matias Domingues
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-05 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: em-websocket-client
+  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: rspec
+  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: Reference implementation for the sketch protocol JSTP
+email:
+- xavierviacanel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- JSTP.es.md
+- LICENSE
+- README.md
+- Rakefile
+- jstp.gemspec
+- lib/jstp.rb
+- lib/jstp/api.rb
+- lib/jstp/connector.rb
+- lib/jstp/event/on_message.rb
+- lib/jstp/event_machine.rb
+- lib/jstp/registry.rb
+- lib/jstp/server.rb
+- lib/jstp/version.rb
+- spec/jstp/api_spec.rb
+- spec/jstp/connector_spec.rb
+- spec/jstp/event/on_message_spec.rb
+- spec/jstp/event_machine_spec.rb
+- spec/jstp/registry_spec.rb
+- spec/jstp/server_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Fetcher/jstp
+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.21
+signing_key: 
+specification_version: 3
+summary: Reference implementation for the sketch protocol JSTP
+test_files:
+- spec/jstp/api_spec.rb
+- spec/jstp/connector_spec.rb
+- spec/jstp/event/on_message_spec.rb
+- spec/jstp/event_machine_spec.rb
+- spec/jstp/registry_spec.rb
+- spec/jstp/server_spec.rb
+- spec/spec_helper.rb
+has_rdoc: