ddp-server 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f43570a710a6b121e3cf96bb30e0aa5bf666198
+  data.tar.gz: d79437183194ffa2c78477d7d3a0bc7cea34021f
+SHA512:
+  metadata.gz: 174a05bbda54f44569370e7db5fceed094892118528636805b8fe245580a86c70e4717c6fe143f982d3cb3af91d229c94d72150584cfef7c2aff6edabf08f49b
+  data.tar.gz: 12bc6b927a8d78ca61f1bbe6b62e4550f0848161470449ca26bf48fb89994db117cd64bf774cc4729071966278f1d3db48c101b4263b80709ed7d2f8e71e4437

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/.rubocop.yml

@@ -0,0 +1,8 @@
+Style/Tab:
+    Enabled: false
+Style/IndentationWidth:
+    Width: 1
+Metrics/LineLength:
+    Max: 120
+Style/SignalException:
+    Enabled: false

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+group :development do
+	gem 'rspec'
+	gem 'rspec-mocks'
+	gem 'webmock'
+	gem 'guard'
+	gem 'guard-rspec'
+	gem 'cucumber', require: false
+	gem 'guard-cucumber'
+	gem 'rubocop', require: false
+	gem 'guard-rubocop'
+	gem 'simplecov', require: false
+end
+
+# Specify your gem's dependencies in ddp-server.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,30 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec -c' do
+	watch(/^spec\/.+_spec\.rb$/) { 'spec' }
+	watch(/^lib\/.+\.rb$/) { 'spec' }
+	watch('spec/spec_helper.rb') { 'spec' }
+end
+
+guard :rubocop do
+	watch(/.+\.rb$/)
+	watch(/(?:.+\/)?\.rubocop\.yml$/) { |m| File.dirname(m[0]) }
+end
+
+guard 'cucumber' do
+	watch(/^features\/.+\.feature$/)
+	watch(%r{^features\/support\/.+$})          { 'features' }
+
+	watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|
+		Dir[File.join("**/#{m[1]}.feature")][0] || 'features'
+	end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tinco Andringa
+
+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,29 @@
+# Ddp::Server
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ddp-server'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ddp-server
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/ddp-server.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ddp/server/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = 'ddp-server'
+	spec.version       = DDP::Server::VERSION
+	spec.authors       = ['Tinco Andringa']
+	spec.email         = ['mail@tinco.nl']
+	spec.description   = 'DDP Protocol server for implementing Ruby DDP backends'
+	spec.summary       = 'DDP Protocol server for implementing Ruby DDP backends'
+	spec.homepage      = 'https://github.com/d-snp/ruby-ddp-server'
+	spec.license       = 'MIT'
+
+	spec.files         = `git ls-files`.split($RS)
+	spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+	spec.require_paths = ['lib']
+
+	spec.add_development_dependency 'bundler', '~> 1.3'
+	spec.add_development_dependency 'rake'
+
+	spec.add_dependency 'celluloid-websocket'
+end

data/examples/rack_example.ru

@@ -0,0 +1,3 @@
+require 'ddp/server/rack'
+
+run DDP::Server::Rack

data/lib/ddp/server/protocol/data.rb

@@ -0,0 +1,66 @@
+module DDP
+	module Server
+		module Protocol
+			# Protocol regarding handling data subscriptions
+			module Data
+				def handle_data
+					case @message['msg']
+					when 'sub'
+						handle_sub
+						true
+					when 'unsub'
+						handle_unsub
+						true
+					else
+						false
+					end
+				end
+
+				def handle_sub
+					raise 'Must be overridden'
+				end
+
+				def handle_unsub
+					raise 'Must be overridden'
+				end
+
+				def nosub(id, error = nil)
+					message = { msg: 'nosub', id: id }
+					message.merge!(error: error) if error
+					write_message message
+				end
+
+				def added(collection, id, fields = nil)
+					message = { msg: 'added', id: id, collection: collection }
+					message.merge!(fields: fields) if fields
+					write_message message
+				end
+
+				def changed(collection, id, fields = nil, cleared = nil)
+					message = { msg: 'changed', id: id, collection: collection }
+					message.merge!(fields: fields) if fields
+					message.merge!(cleared: cleared) if cleared
+					write_message message
+				end
+
+				def removed(collection, id)
+					write_message msg: 'removed', collection: collection, id: id
+				end
+
+				def ready(subs)
+					write_message msg: 'ready', subs: subs
+				end
+
+				def added_before(collection, id, fields = nil, before = nil)
+					message = { msg: 'addedBefore', id: id, collection: collection, before: before }
+					message.merge!(fields: fields) if fields
+					write_message message
+				end
+
+				def moved_before(collection, id, before = nil)
+					write_message msg: 'movedBefore', id: id, collection: collection, before: before
+				end
+			end
+		end
+	end
+end

data/lib/ddp/server/protocol/heartbeat.rb

@@ -0,0 +1,20 @@
+module DDP
+	module Server
+		module Protocol
+			# Protocol regarding heartbeat messages
+			module Heartbeat
+				def handle_heartbeat
+					case @message['msg']
+					when 'ping'
+						write_message msg: 'pong', id: @message['id']
+						true
+					when 'pong'
+						true
+					else
+						false
+					end
+				end
+			end
+		end
+	end
+end

data/lib/ddp/server/protocol/rpc.rb

@@ -0,0 +1,38 @@
+module DDP
+	module Server
+		module Protocol
+			# Protocol regarding remote procedure calls
+			module RPC
+				def handle_rpc
+					case @message['msg']
+					when 'method'
+						handle_method
+						true
+					else
+						false
+					end
+				end
+
+				def handle_method
+					raise 'Must be overridden'
+				end
+
+				def result(id, result = nil)
+					message = { msg: 'result', id: id }
+					if result
+						if result['error']
+							message['error'] = result
+						else
+							message['result'] = result
+						end
+					end
+					write_message(message)
+				end
+
+				def updated(methods)
+					write_message msg: 'updated', methods: methods
+				end
+			end
+		end
+	end
+end

data/lib/ddp/server/protocol.rb

@@ -0,0 +1,56 @@
+require 'ddp/server/protocol/heartbeat'
+require 'ddp/server/protocol/data'
+require 'ddp/server/protocol/rpc'
+
+module DDP
+	module Server
+		# Implementation of the DDP protocol
+		# Can be included into any class that has
+		# an on_open, a read_message and a write_message method
+		module Protocol
+			include Heartbeat
+			include Data
+			include RPC
+
+			DDP_VERSION = '1'
+
+			attr_accessor :session_id
+
+			def new_session_id
+				SecureRandom.hex
+			end
+
+			def handle_connect
+				message = read_message
+
+				if message['msg'] == 'connect' && message['version'] == DDP_VERSION
+					handle_session(message)
+				else
+					write_message('msg' => 'failed', 'version' => DDP_VERSION)
+					close
+				end
+			end
+
+			def handle_session(message)
+				@session_id = message['session'] || new_session_id
+
+				write_message('msg' => 'connected', 'session' => session_id)
+
+				handle_established
+			end
+
+			def handle_established
+				loop do
+					@message = read_message
+
+					next if handle_heartbeat
+					next if handle_data
+					next if handle_rpc
+					break
+				end
+
+				close
+			end
+		end
+	end
+end

data/lib/ddp/server/rack.rb

@@ -0,0 +1,26 @@
+require 'ddp/server/version'
+require 'ddp/server/protocol'
+require 'celluloid/websocket/rack'
+require 'json'
+require 'securerandom'
+
+module DDP
+	module Server
+		# Rack middleware for running DDP
+		class Rack < Celluloid::WebSocket::Rack
+			include DDP::Server::Protocol
+
+			def on_open
+				handle_connect
+			end
+
+			def read_message
+				JSON.parse read
+			end
+
+			def write_message(message)
+				write JSON.generate(message)
+			end
+		end
+	end
+end

data/lib/ddp/server/version.rb

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

data/lib/ddp/server.rb

@@ -0,0 +1,10 @@
+require 'ddp/server/version'
+require 'celluloid/websocket/rack'
+require 'json'
+require 'securerandom'
+
+module DDP
+	# An implementation of the Meteor DDP protocol
+	module Server
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+
+def make_sockets
+	host = '127.0.0.1'
+	port = 10_151
+
+	server = TCPServer.new(host, port)
+	client = TCPSocket.new(host, port)
+	peer   = server.accept
+
+	[server, client, peer]
+end
+
+# def with_socket_pair
+# 	server, client, peer = make_sockets
+
+# 	begin
+# 		yield client, peer
+# 	ensure
+# 		server.close rescue nil
+# 		client.close rescue nil
+# 		peer.close   rescue nil
+# 	end
+# end
+
+def example_host
+	'www.example.com'
+end
+
+def example_path
+	'/example'
+end
+
+def example_url
+	"ws://#{example_host}#{example_path}"
+end
+
+def handshake_headers
+	{
+		'Host'                   => example_host,
+		'Upgrade'                => 'websocket',
+		'Connection'             => 'Upgrade',
+		'Sec-WebSocket-Key'      => 'dGhlIHNhbXBsZSBub25jZQ==',
+		'Origin'                 => 'http://example.com',
+		'Sec-WebSocket-Protocol' => 'chat, superchat',
+		'Sec-WebSocket-Version'  => '13'
+	}
+end
+
+def handshake
+	WebSocket::ClientHandshake.new(:get, example_url, handshake_headers)
+end
+
+def with_websocket_pair
+	with_socket_pair do |client, peer|
+		connection = Reel::Connection.new(peer)
+		client << handshake.to_data
+		request = connection.request
+
+		websocket = request.websocket
+
+		# Discard handshake
+		client.readpartial(4096)
+
+		yield client, websocket
+	end
+end
+
+RSpec.configure do |config|
+	config.before(:all) do
+		# nothing yet
+	end
+	config.before(:each) do
+		# nothing yet
+	end
+	config.after(:all) {}
+	config.after(:each) {}
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: ddp-server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tinco Andringa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: celluloid-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: DDP Protocol server for implementing Ruby DDP backends
+email:
+- mail@tinco.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ddp-server.gemspec
+- examples/rack_example.ru
+- 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/rack.rb
+- lib/ddp/server/version.rb
+- spec/spec_helper.rb
+homepage: https://github.com/d-snp/ruby-ddp-server
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: DDP Protocol server for implementing Ruby DDP backends
+test_files:
+- spec/spec_helper.rb