ddp-server 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96ce685d7db62b76f32cdd90b85c204d7893742d
-  data.tar.gz: 610b8c0c7175efb662fa4b3116c0a5f7d37d0261
+  metadata.gz: 950aa0c33840f83ddc2708dba9b8be77b6bbed71
+  data.tar.gz: 602b119c4b1c339c3f5395bc2ce23aa69d152d83
 SHA512:
-  metadata.gz: 07322599a18df3dd8e9c8c61280cc72c97d3c24afd5b95c2b8e64482d510a75c17abcbd61af5dcaac48a70130aad14f8c0bae06b398f5b6e3b1b82e684685a01
-  data.tar.gz: fa7ebf54092ca0f93e413c7e13b3dc7a600c73ab5e4a5716594da9d4d3fb3a61d341602493d2072371b92dab6f9e53a94dd2a808a4438d7a5b8e365afb9fe0d8
+  metadata.gz: 7e2a9fb98f64ed089af30ee95f06bda60d29c61d69955ef62e90b78819f6e88033c2b413fd1bf2c54a9bb39671ed77aca511a475d5ff095131a61964da132f72
+  data.tar.gz: 15cebf56397143b80badf733327f2c6a17850ed8789c1f667d8d0d53d15a01a9dd92f6c505c942f093042f03bc8951207db61c6978fd655cba118ad8f6d99695

data/.rubocop.yml

@@ -6,3 +6,5 @@ Metrics/LineLength:
     Max: 120
 Style/SignalException:
     Enabled: false
+Style/MultilineOperationIndentation:
+    Enabled: false

data/lib/ddp/ejson.rb

@@ -0,0 +1,128 @@
+require 'json'
+require 'base64'
+
+module DDP
+	# EJSON is a way of embedding more than the built-in JSON types in JSON.
+	# It supports all types built into JSON as plain JSON, plus some custom
+	# types identified by a key prefixed with '$'.
+	class EJSON
+		def self.parse(string)
+			parsed = JSON.parse string
+
+			deserialize(parsed)
+		end
+
+		def self.generate(object)
+			JSON.generate as_ejson(object)
+		end
+
+		def self.deserialize(object)
+			if object.is_a? Hash
+				deserialize_hash(object)
+			elsif object.is_a? Array
+				object.map { |e| deserialize(e) }
+			else
+				object
+			end
+		end
+
+		def self.as_ejson(object)
+			if object.respond_to? :as_ejson
+				object.as_ejson
+			elsif object.is_a? Hash
+				hash_as_ejson(object)
+			elsif object.is_a? Array
+				object.map { |i| as_ejson(i) }
+			else
+				object
+			end
+		end
+
+		# Hashes can contain keys that need to be escaped
+		def self.hash_as_ejson(hash)
+			result = hash.map do |k, v|
+				if k.is_a?(String) && k[0] == '$'
+					['$escape', { k => as_ejson(v) }]
+				else
+					[k, as_ejson(v)]
+				end
+			end
+			Hash[result]
+		end
+
+		def self.deserialize_hash(hash)
+			deserialize_operation(hash) || hash.map do |k, v|
+				[k, deserialize(v)]
+			end.to_h
+		end
+
+		def self.deserialize_operation(hash)
+			if hash['$escape']
+				return deserialize_escape(hash['$escape'])
+			elsif hash['$date']
+				return Time.at(hash['$date'] / 1000.0)
+			elsif hash['$binary']
+				return Base64.decode64(hash['$binary'])
+			elsif hash['$type']
+				return deserialize_type(hash)
+			end
+			false
+		end
+
+		def self.deserialize_escape(hash)
+			hash.map do |k, v|
+				[k, deserialize(v)]
+			end.to_h
+		end
+
+		def self.deserialize_type(hash)
+			klass = @classes[hash['$type']]
+			if klass
+				klass.from_ejson(hash['$value'])
+			else
+				raise UnknownTypeError, "Don't know how to deserialize #{hash['$type']}"
+			end
+		end
+
+		def self.add_serializable_class(klass)
+			@classes ||= {}
+			@classes[klass.name] = klass
+		end
+
+		def self.rename_serializable_class(klass, name)
+			@classes.delete(klass.name)
+			@classes[name] = klass
+		end
+
+		# Classes can include this module to be picked up by the EJSON parser
+		module Serializable
+			def self.extended(klass)
+				EJSON.add_serializable_class(klass)
+			end
+
+			def ejson_type_name(name)
+				EJSON.rename_serializable_class(self, name)
+			end
+
+			def from_ejson(_object)
+				raise InvalidSerializableClassError, "Class #{name} must override from_ejson."
+			end
+		end
+
+		# Raised when parsing an unknown type
+		class UnknownTypeError < StandardError
+		end
+
+		# Raised when serializable class does not implement from_ejson
+		class InvalidSerializableClassError < StandardError
+		end
+	end
+end
+
+# Builtin EJSON types:
+class Time
+	def as_ejson
+		# milliseconds since epoch
+		{ '$date' => (to_f * 1000).to_i }
+	end
+end

data/lib/ddp/server.rb

@@ -1,7 +1,7 @@
 require 'ddp/server/version'
 require 'ddp/server/protocol'
 require 'celluloid/websocket/rack'
-require 'json'
+require 'ddp/ejson'
 require 'securerandom'
 
 module DDP
@@ -15,11 +15,11 @@ module DDP
 			end
 
 			def read_message
-				JSON.parse read
+				EJSON.parse read
 			end
 
 			def write_message(message)
-				write JSON.generate(message)
+				write EJSON.generate(message)
 			end
 		end
 	end

data/lib/ddp/server/version.rb

@@ -1,6 +1,6 @@
 module DDP
 	# We use semantic versioning
 	module Server
-		VERSION = '0.0.4'
+		VERSION = '0.0.5'
 	end
 end

data/spec/ejson_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'ddp/ejson'
+require 'json'
+require 'base64'
+
+# Tests in DDP Module
+module DDP
+	describe EJSON do
+		describe 'generate' do
+			it 'generates normal json for simple structures' do
+				[
+					{ 'a' => 'b' },
+					['a'],
+					{ 'a' => [1] }
+				].each do |example|
+					expect(EJSON.generate(example)).to eq(JSON.generate(example))
+				end
+			end
+
+			it 'escapes keys that start with a dollar sign' do
+				example = { '$bla' => 'value' }
+				ejson = EJSON.generate(example)
+				expect(JSON.parse(ejson)['$escape']).to eq('$bla' => 'value')
+			end
+
+			it 'generates a special type for dates' do
+				time = Time.now
+				ms_since_epoch = (time.to_f * 1000).to_i
+				ejson = EJSON.generate('date' => time)
+				expect(JSON.parse(ejson)['date']).to eq('$date' => ms_since_epoch)
+			end
+		end
+
+		describe 'parse' do
+			it 'parses generic json' do
+				[
+					{ 'a' => 'b' },
+					['a'],
+					{ 'a' => [1] }
+				].each do |example|
+					json = JSON.generate(example)
+					expect(EJSON.parse(json)).to eq(example)
+				end
+			end
+
+			it 'parses an escaped ejson' do
+				example = { '$escape' => { '$date' => 'a' } }
+				ejson = JSON.generate(example)
+				expect(EJSON.parse(ejson)).to eq('$date' => 'a')
+			end
+
+			it 'parses a date ejson' do
+				time = Time.now
+				ms_since_epoch = (time.to_f * 1000).to_i
+				example = { 'date' => { '$date' => ms_since_epoch } }
+				ejson = JSON.generate(example)
+				expect(EJSON.parse(ejson)['date'].to_s).to eq(time.to_s)
+			end
+
+			it 'parses a binary ejson' do
+				example = { '$binary' => Base64.encode64('Hello World') }
+				ejson = JSON.generate(example)
+				expect(EJSON.parse(ejson)).to eq('Hello World')
+			end
+
+			it 'parses custom types' do
+				# Test class
+				class A
+					extend EJSON::Serializable
+
+					ejson_type_name 'A'
+
+					def as_ejson
+						{ '$type' => 'A', '$value' => '1234' }
+					end
+
+					def self.from_ejson(object)
+						object.to_i
+					end
+				end
+
+				ejson = EJSON.generate(A.new)
+				expect(EJSON.parse(ejson)).to eq(1234)
+			end
+
+			it 'raises an exception when parsing an unknown type' do
+				ejson = JSON.generate('$type' => 'B', '$value' => '1234')
+				expect do
+					EJSON.parse(ejson)
+				end.to raise_error(EJSON::UnknownTypeError)
+			end
+
+			it 'raises an exception when a serializable class does not override from_ejson' do
+				expect do
+					# Test class
+					class C
+						extend EJSON::Serializable
+					end
+
+					C.from_ejson(false)
+				end.to raise_error(EJSON::InvalidSerializableClassError)
+			end
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddp-server
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Tinco Andringa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,12 +68,14 @@ files:
 - Rakefile
 - ddp-server.gemspec
 - examples/rack_example.ru
+- lib/ddp/ejson.rb
 - lib/ddp/server.rb
 - lib/ddp/server/protocol.rb
 - lib/ddp/server/protocol/data.rb
 - lib/ddp/server/protocol/heartbeat.rb
 - lib/ddp/server/protocol/rpc.rb
 - lib/ddp/server/version.rb
+- spec/ejson_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/d-snp/ruby-ddp-server
 licenses:
@@ -100,4 +102,5 @@ signing_key:
 specification_version: 4
 summary: DDP Protocol server for implementing Ruby DDP backends
 test_files:
+- spec/ejson_spec.rb
 - spec/spec_helper.rb