jstp 1.3.4 → 1.3.5

data/README.md

@@ -1,53 +1,9 @@
 # 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.
+Server & Client reference implementation of the sketch protocol JSTP (JavaScript Serialization Transfer Protocol). 
 
-JSTP
-----
+The protocol specification can be found in the [RFC](https://github.com/Fetcher/jstp-rfc)
 
-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.
 
 API
 ---
@@ -69,7 +25,6 @@ The API of the JSTP Ruby Gem remained undocumented, mainly because right now it
 -   The engine should automatically forward ingoing dispatches that carry a different hostname from the one of this node to the corresponding node. In this way, each JSTP Node is automatically a gateway.
 -   There should be a DSL in the Controller class for creating aahnd sending a JSTP Dispatch. The library should be able to recognize when an outgoing dispatch is actually aimed at self, so it gets mapped correctly without the need to generate network activity. This DSL should provide also an easy way to switch outgoing strategies.
 -   The message as passed to the Controller's initializer should be made into a Private Class Data. In this context, I should explore a little the idea of mapping the ingoing Dispatch into a class.
--   Test implementation with Oj JSON parser/dumper.
 -   The Dispatch class should have a Writer an Reader that make it possible to log and parse dispatches from the abbreviated, similar-to-HTTP syntax.
 -   [distant future] Support for SSL/TLS.
 

data/jstp.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'discoverer'
   gem.add_dependency 'symbolmatrix'
   gem.add_dependency 'uuid'
-  gem.add_dependency 'oj'
 
   gem.add_development_dependency 'rspec', '>= 2.1.0'
   gem.add_development_dependency 'cucumber'

data/lib/jstp.rb

@@ -6,7 +6,6 @@ require 'json'
 require 'discoverer'
 require 'symbolmatrix'
 require 'uuid'
-require 'oj'
 require 'logger'
 
 require 'jstp/engine'

data/lib/jstp/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module JSTP
-  VERSION = "1.3.4"
+  VERSION = "1.3.5"
 end

data/lib/reader/jstp/dispatch.rb

@@ -12,7 +12,7 @@ module Reader
 
       # Actually, is JSON
       def string the_string
-        Oj.load(the_string).each do |key, value|
+        JSON.load(the_string).each do |key, value|
           @source[key] = value
         end
 

data/lib/writer/jstp/dispatch.rb

@@ -62,7 +62,7 @@ module Writer
       end
 
       def json
-        Oj.dump @source
+        JSON.dump @source
       end
 
       def string 
@@ -85,10 +85,10 @@ module Writer
           response += "\n"
           if @source.body.is_a? Hash
             @source.body.each do |key, value|
-              response += "#{key}: #{Oj.dump(value)}\n"
+              response += "#{key}: #{JSON.dump(value)}\n"
             end
           else
-            response += Oj.dump @source.body
+            response += JSON.dump @source.body
           end
         end
         response
@@ -98,7 +98,7 @@ module Writer
         unless @source.body
           "#{@source.method} #{@source.resource.join('/')}"
         else
-          "#{@source.method} #{@source.resource.join('/')}?#{Oj.dump(@source.body)}"
+          "#{@source.method} #{@source.resource.join('/')}?#{JSON.dump(@source.body)}"
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jstp
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-websocket
@@ -93,22 +93,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: oj
-  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
@@ -199,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Reference implementation for the sketch protocol JSTP