gripcontrol 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7abc023fc0faffad3040b8ce12b0c4b1b4d20e58
+  data.tar.gz: 5388924b9251ce2610310825114cb8b631d64b0d
+SHA512:
+  metadata.gz: 8d48568f8e78f118e6528c1f6c0e73a64f717b849f7a9985078275c5b30fb7b2a4c2fd2a2b1ab18659fc4011097a35136ec2a24cd654b94b0fc5f984421cd582
+  data.tar.gz: 0d19c9558e6b3c945d80f92b762f18a2e73307ff6fd02dd5c382a05063d2352426bfc3f7d70175a6c54d0f159c9bdc8bbd9738378bfcf879be4f5834d323fc27

data/lib/channel.rb

@@ -0,0 +1,17 @@
+#    channel.rb
+#    ~~~~~~~~~
+#    This module implements the Channel class.
+#    :authors: Konstantin Bokarius.
+#    :copyright: (c) 2015 by Fanout, Inc.
+#    :license: MIT, see LICENSE for more details.
+
+class Channel
+  attr_accessor :name
+  attr_accessor :prev_id
+
+	def initialize(name, prev_id=nil)
+		@name = name
+		@prev_id = prev_id
+  end
+end
+

data/lib/gripcontrol.rb

@@ -0,0 +1,144 @@
+#    gripcontrol.rb
+#    ~~~~~~~~~
+#    This module implements the GripControl class.
+#    :authors: Konstantin Bokarius.
+#    :copyright: (c) 2015 by Fanout, Inc.
+#    :license: MIT, see LICENSE for more details.
+
+require 'base64'
+require 'jwt'
+require_relative 'channel.rb'
+require_relative 'httpresponseformat.rb'
+require_relative 'httpstreamformat.rb'
+require_relative 'websocketmessageformat.rb'
+require_relative 'websocketevent.rb'
+require_relative 'grippubcontrol.rb'
+
+class GripControl
+  def self.create_hold(mode, channels, response)
+	  hold = Hash.new
+	  hold['mode'] = mode
+	  if channels.is_a?(Channel)
+		  channels = [channels]
+	  elsif channels.is_a?(String)
+		  channels = [Channel.new(channels)]
+    end
+	  raise 'channels.length equal to 0' unless channels.length > 0
+	  ichannels = []
+    channels.each do |channel|
+	    if channel.is_a?(String)
+			  channel = Channel(channel)
+      end
+		  ichannel = Hash.new
+		  ichannel['name'] = channel.name
+		  if !channel.prev_id.nil?
+			  ichannel['prev-id'] = channel.prev_id
+      end
+		  ichannels.push(ichannel)
+    end
+	  hold['channels'] = ichannels
+	  iresponse = nil
+	  if !response.nil?
+		  if response.is_a?(String)
+			  response = Response(nil, nil, nil, response)
+      end
+		  iresponse = Hash.new
+		  if !response.code.nil?
+			  iresponse['code'] = response.code
+      end
+		  if !response.reason.nil?
+			  iresponse['reason'] = response.reason
+      end
+		  if !response.headers.nil? and response.headers.length > 0
+			  iresponse['headers'] = response.headers
+      end
+		  if !response.body.nil?
+			  if response.body.encoding.name == 'ASCII-8BIT'
+				  iresponse['body'] = response.body
+			  else
+				  iresponse['body-bin'] = Base64.encode64(response.body)
+        end
+      end
+    end
+	  instruct = Hash.new
+	  instruct['hold'] = hold
+	  if !iresponse.nil?
+		  instruct['response'] = iresponse
+    end
+	  return instruct.to_json
+  end
+
+  def self.create_hold_response(channels, response=nil)
+	  return GripControl.create_hold('response', channels, response)
+  end
+
+  def self.create_hold_stream(channels, response=nil)
+	  return create_hold('stream', channels, response)
+  end
+
+  def self.validate_sig(token, key)
+		token = token.encode('utf-8')
+	  begin
+		  claim = JWT.encode(claim, @auth_jwt_key).decode(token, key,
+          verify_expiration=false)
+	  rescue
+		  return false
+    end
+	  exp = claim.get('exp')
+    if !claim.has_key?('exp')
+      return false
+    end
+	  if Time.now.utc.to_i >= claim['exp']
+		  return false
+    end
+	  return true
+  end
+
+  def self.decode_websocket_events(body)
+	  out = []
+	  start = 0
+	  while start < body.length do
+		  at = body.index('\r\n', start)
+		  if !at.nil?
+			  raise 'bad format'
+      end
+		  typeline = body[start..at - 1]
+		  start = at + 2
+		  at = typeline.index(' ')
+		  if !at.nil?
+			  etype = typeline[0..at - 1]
+			  clen = ('0x' + typeline[at + 1..-1]).to_s(16)
+			  content = body[start:start + clen - 1]
+			  start += clen + 2
+			  e = WebSocketEvent.new(etype, content)
+		  else
+			  e = WebSocketEvent.new(typeline)
+      end
+		  out.push(e)
+    end
+	  return out
+  end
+
+  def self.encode_websocket_events(events)
+	  out = ''
+    events.each do |event|
+		  if !event.content.nil?
+			  out += '%s %x\r\n%s\r\n' % [e.type, len(event.content), event.content]
+		  else
+			  out += '%s\r\n' % [e.type]
+      end
+    end
+	  return out
+  end
+
+  def self.websocket_control_message(type, args=nil)
+	  if !args.nil?
+      # REVIEW: is this deep copy workaround effective in this case?
+		  out = Marshal.load(Marshal.dump(args))
+	  else
+		  out = Hash.new
+    end
+	  out['type'] = type
+	  return out.to_json
+  end
+end

data/lib/grippubcontrol.rb

@@ -0,0 +1,47 @@
+#    grippubcontrol.rb
+#    ~~~~~~~~~
+#    This module implements the GripPubControl class.
+#    :authors: Konstantin Bokarius.
+#    :copyright: (c) 2015 by Fanout, Inc.
+#    :license: MIT, see LICENSE for more details.
+
+require 'pubcontrol'
+
+class GripPubControl < PubControl
+  alias super_publish publish
+  alias super_publish_async publish_async
+
+	def publish_http_response(channel, http_response, id=nil, prev_id=nil)
+		if http_response.is_a?(String)
+			http_response = HttpResponseFormat.new(nil, nil, nil, http_response)
+    end
+		item = Item.new(http_response, id, prev_id)
+		super_publish(channel, item)
+  end
+
+	def publish_http_response_async(channel, http_response, id=nil,
+      prev_id=nil, callback=nil)
+		if http_response.is_a?(String)
+			http_response = HttpResponseFormat.new(nil, nil, nil, http_response)
+    end
+		item = Item.new(http_response, id, prev_id)
+		super_publish_async(channel, item, callback)
+  end
+
+	def publish_http_stream(channel, http_stream, id=nil, prev_id=nil)
+		if http_stream.is_a?(String)
+			http_stream = HttpStreamFormat.new(http_stream)
+    end
+		item = Item.new(http_stream, id, prev_id)
+		super_publish(channel, item)
+  end
+
+	def publish_http_stream_async(channel, http_stream, id=nil,
+      prev_id=nil, callback=nil)
+		if http_stream.is_a?(String)
+			http_stream = HttpStreamFormat.new(http_stream)
+    end
+		item = Item.new(http_stream, id, prev_id)	
+		super_publish_async(channel, item, callback)
+  end
+end

data/lib/httpresponseformat.rb

@@ -0,0 +1,49 @@
+#    httpresponseformat.rb
+#    ~~~~~~~~~
+#    This module implements the HttpResponseFormat class.
+#    :authors: Konstantin Bokarius.
+#    :copyright: (c) 2015 by Fanout, Inc.
+#    :license: MIT, see LICENSE for more details.
+
+require 'base64'
+require 'pubcontrol'
+
+class HttpResponseFormat < Format
+  attr_accessor :code
+  attr_accessor :reason
+  attr_accessor :headers
+  attr_accessor :body
+
+	def initialize(code=nil, reason=nil, headers=nil, body=nil)
+		@code = code
+		@reason = reason
+		@headers = headers
+		@body = body
+  end
+
+	def name
+		return 'http-response'
+  end
+
+	def export
+		out = Hash.new
+		if !@code.nil?
+			out['code'] = @code
+    end
+		if !@reason.nil?
+			out['reason'] = @reason
+    end
+		if !@headers.nil? and @headers.length > 0
+			out['headers'] = @headers
+    end
+		if !@body.nil?
+      # REVIEW is this the right way to check for binary encoding?
+			if @body.encoding.name == 'ASCII-8BIT'
+				out['body-bin'] = Base64.encode64(@body)
+			else
+				out['body'] = @body
+      end
+    end
+		return out
+  end
+end

data/lib/httpstreamformat.rb

@@ -0,0 +1,41 @@
+#    httpstreamformat.rb
+#    ~~~~~~~~~
+#    This module implements the HttpStreamFormat class.
+#    :authors: Konstantin Bokarius.
+#    :copyright: (c) 2015 by Fanout, Inc.
+#    :license: MIT, see LICENSE for more details.
+
+require 'base64'
+require 'pubcontrol'
+
+class HttpStreamFormat < Format
+  attr_accessor :content
+  attr_accessor :close
+
+	def initialize(content=nil, close=false)
+		@content = content
+		@close = close
+		if !@close and @content.nil?
+			raise 'Content not set'
+    end
+  end
+
+	def name
+		return 'http-stream'
+  end
+
+	def export
+		out = Hash.new
+		if @close
+			out['action'] = 'close'
+		else
+			if @content.encoding.name == 'ASCII-8BIT'
+				out['body-bin'] = Base64.encode64(@content)
+			else
+				out['body'] = @content
+      end
+    end
+		return out
+  end
+end
+

data/lib/websocketevent.rb

@@ -0,0 +1,16 @@
+#    websocketevent.rb
+#    ~~~~~~~~~
+#    This module implements the WebSocketEvent class.
+#    :authors: Konstantin Bokarius.
+#    :copyright: (c) 2015 by Fanout, Inc.
+#    :license: MIT, see LICENSE for more details.
+
+class WebSocketEvent
+  attr_accessor :type
+  attr_accessor :content
+
+	def initialize(type, content=nil)
+		@type = type
+		@content = content
+  end
+end

data/lib/websocketmessageformat.rb

@@ -0,0 +1,32 @@
+#    websocketmessageformat.rb
+#    ~~~~~~~~~
+#    This module implements the WebSocketMessageFormat class.
+#    :authors: Konstantin Bokarius.
+#    :copyright: (c) 2015 by Fanout, Inc.
+#    :license: MIT, see LICENSE for more details.
+
+require 'base64'
+require 'pubcontrol'
+
+class WebSocketMessageFormat < Format
+  attr_accessor :content
+
+	def initialize(content)
+		@content = content
+  end
+
+	def name
+		return 'ws-message'
+  end
+
+	def export
+		out = Hash.new
+			if @content.encoding.name == 'ASCII-8BIT'
+				out['body-bin'] = Base64.encode64(@content)
+			else
+				out['body'] = @content
+      end
+		return out
+  end
+end
+

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: gripcontrol
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Konstantin Bokarius
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-04 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby convenience library for using the GRIP protocol
+email: bokarius@comcast.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/channel.rb
+- lib/gripcontrol.rb
+- lib/grippubcontrol.rb
+- lib/httpresponseformat.rb
+- lib/httpstreamformat.rb
+- lib/websocketevent.rb
+- lib/websocketmessageformat.rb
+homepage: http://rubygems.org/gems/gripcontrol
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.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: GRIP library for Ruby
+test_files: []