rocket-core 0.0.2

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.rdb

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Araneo Ltd.
+
+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/Rakefile

@@ -0,0 +1,43 @@
+# -*- ruby -*-
+$:.unshift(File.expand_path('../lib', __FILE__))
+$:.unshift(File.expand_path('../../rocket/lib', __FILE__))
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+require 'rocket/version'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = %q[-I../rocket/lib -Ilib -c -b]
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rspec_opts = %q[-I../rocket/lib -Ilib -c -b]
+  t.rcov_opts = %q[-I../rocket/lib -Ilib -T -x "spec"]
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.title = "Rocket core #{Rocket.version}"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Build current version as a rubygem"
+task :build do
+  sh "gem build rocket-core.gemspec"
+  sh "mkdir -p pkg"
+  sh "mv rocket-core-*.gem pkg/"
+end
+
+desc "Relase current version to rubygems.org"
+task :release => :build do
+  sh "gem push pkg/rocket-core-#{Rocket.version}.gem"
+end
+
+desc "Perform installation via rubygems"
+task :install => :build do
+  sh "gem install pkg/rocket-core-#{Rocket.version}.gem"
+end
+
+task :default => :spec

data/lib/rocket-core.rb

@@ -0,0 +1,8 @@
+module Rocket
+
+  autoload :Helpers,   'rocket/helpers'
+  autoload :Client,    'rocket/client'
+  autoload :Channel,   'rocket/channel'
+  autoload :WebSocket, 'rocket/websocket'
+
+end # Rocket

data/lib/rocket/channel.rb

@@ -0,0 +1,21 @@
+require 'json'
+
+module Rocket
+  class Channel
+  
+    attr_reader :client
+    attr_reader :channel
+  
+    def initialize(client, channel)
+      @client  = client
+      @channel = channel
+    end
+    
+    def trigger(event, data)
+      client.connection do |socket|
+        socket.send({ :event => event, :channel => channel, :data => data }.to_json)
+      end
+    end
+    
+  end # Channel
+end # Rocket

data/lib/rocket/client.rb

@@ -0,0 +1,31 @@
+require 'json'
+
+module Rocket
+  # This Rocket client allows for triggering events via Rocket server. 
+  # 
+  #   rocket = Rocket::Client.new("ws://host.com:9772", "my-app", "my53cr37k3y")
+  #   rocket['my-channel'].trigger('event', { :hello => :world })
+  #
+  class Client
+    
+    attr_reader :url
+    attr_reader :app_id
+    attr_reader :secret
+    
+    def initialize(url, app_id, secret)
+      @url    = File.join(url, 'app', app_id) + '?secret=' + secret
+      @app_id = app_id
+    end
+    
+    def connection(&block)
+      socket = WebSocket.new(url)
+      yield(socket)
+      socket.close if socket && !socket.tcp_socket.closed?
+    end
+    
+    def [](channel)
+      Channel.new(self, channel)
+    end
+    
+  end # Client
+end # Rocket

data/lib/rocket/helpers.rb

@@ -0,0 +1,23 @@
+module Rocket
+  module Helpers
+    
+    # Hash given, returns it version with symbolized keys. 
+    #
+    #   p symbolize_keys("hello" => "world", ["Array here"] => "yup")
+    #   p symbolize_keys(:one => 1, "two" => 2)
+    #
+    # produces:
+    #
+    #  {:hello => "world", ["Array here"] => "yup"}
+    #  {:one => 1, :two => 2}
+    #
+    def symbolize_keys(hash)
+      return hash unless hash.is_a?(Hash)
+      hash.inject({}) do |options, (key, value)|
+        options[(key.to_sym if key.respond_to?(:to_sym)) || key] = value
+        options
+      end
+    end
+    
+  end # Helpers
+end # Rocket

data/lib/rocket/websocket.rb

@@ -0,0 +1,225 @@
+# Copyright: Hiroshi Ichikawa <http://gimite.net/en/>
+# Lincense: New BSD Lincense
+# Reference: http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol
+
+require "socket"
+require "uri"
+require "digest/md5"
+require "openssl"
+
+module Rocket
+  class WebSocket
+
+    class Error < RuntimeError; end
+
+    class << self
+      attr_accessor :debug
+    end
+
+    attr_reader :header
+    attr_reader :path
+
+    def initialize(arg, params = {})
+      uri = arg.is_a?(String) ? URI.parse(arg) : arg
+
+      if uri.scheme == "ws"
+        default_port = 80
+      elsif uri.scheme = "wss"
+        default_port = 443
+      else
+        raise(WebSocket::Error, "unsupported scheme: #{uri.scheme}")
+      end
+
+      @path = (uri.path.empty? ? "/" : uri.path) + (uri.query ? "?" + uri.query : "")
+      host = uri.host + (uri.port == default_port ? "" : ":#{uri.port}")
+      origin = params[:origin] || "http://#{uri.host}"
+      key1 = generate_key()
+      key2 = generate_key()
+      key3 = generate_key3()
+
+      socket = TCPSocket.new(uri.host, uri.port || default_port)
+
+      if uri.scheme == "ws"
+        @socket = socket
+      else
+        @socket = ssl_handshake(socket)
+      end
+
+      write(
+        "GET #{@path} HTTP/1.1\r\n" +
+        "Upgrade: WebSocket\r\n" +
+        "Connection: Upgrade\r\n" +
+        "Host: #{host}\r\n" +
+        "Origin: #{origin}\r\n" +
+        "Sec-WebSocket-Key1: #{key1}\r\n" +
+        "Sec-WebSocket-Key2: #{key2}\r\n" +
+        "\r\n" +
+        "#{key3}")
+      flush()
+
+      line = gets().chomp()
+      raise(WebSocket::Error, "bad response: #{line}") if !(line =~ /\AHTTP\/1.1 101 /n)
+      read_header()
+      if @header["Sec-WebSocket-Origin"] != origin
+        raise(WebSocket::Error,
+          "origin doesn't match: '#{@header["WebSocket-Origin"]}' != '#{origin}'")
+      end
+      reply_digest = read(16)
+      expected_digest = security_digest(key1, key2, key3)
+      if reply_digest != expected_digest
+        raise(WebSocket::Error,
+          "security digest doesn't match: %p != %p" % [reply_digest, expected_digest])
+      end
+      @handshaked = true
+      @closing_started = false
+    end
+
+    def send(data)
+      if !@handshaked
+        raise(WebSocket::Error, "call WebSocket\#handshake first")
+      end
+      data = force_encoding(data.dup(), "ASCII-8BIT")
+      write("\x00#{data}\xff")
+      flush()
+    end
+
+    def receive()
+      if !@handshaked
+        raise(WebSocket::Error, "call WebSocket\#handshake first")
+      end
+      packet = gets("\xff")
+      return nil if !packet
+      if packet =~ /\A\x00(.*)\xff\z/nm
+        return force_encoding($1, "UTF-8")
+      elsif packet == "\xff" && read(1) == "\x00" # closing
+        if @server
+          @socket.close()
+        else
+          close()
+        end
+        return nil
+      else
+        raise(WebSocket::Error, "input must be either '\\x00...\\xff' or '\\xff\\x00'")
+      end
+    end
+
+    def tcp_socket
+      return @socket
+    end
+
+    def host
+      return @header["Host"]
+    end
+
+    def origin
+      return @header["Origin"]
+    end
+
+    # Does closing handshake.
+    def close()
+      return if @closing_started
+      write("\xff\x00")
+      @socket.close() if !@server
+      @closing_started = true
+    end
+
+    def close_socket()
+      @socket.close()
+    end
+
+    private
+
+    NOISE_CHARS = ("\x21".."\x2f").to_a() + ("\x3a".."\x7e").to_a()
+
+    def read_header()
+      @header = {}
+      while line = gets()
+        line = line.chomp()
+        break if line.empty?
+        if !(line =~ /\A(\S+): (.*)\z/n)
+          raise(WebSocket::Error, "invalid request: #{line}")
+        end
+        @header[$1] = $2
+      end
+      if @header["Upgrade"] != "WebSocket"
+        raise(WebSocket::Error, "invalid Upgrade: " + @header["Upgrade"])
+      end
+      if @header["Connection"] != "Upgrade"
+        raise(WebSocket::Error, "invalid Connection: " + @header["Connection"])
+      end
+    end
+
+    def gets(rs = $/)
+      line = @socket.gets(rs)
+      $stderr.printf("recv> %p\n", line) if WebSocket.debug
+      return line
+    end
+
+    def read(num_bytes)
+      str = @socket.read(num_bytes)
+      $stderr.printf("recv> %p\n", str) if WebSocket.debug
+      return str
+    end
+
+    def write(data)
+      if WebSocket.debug
+        data.scan(/\G(.*?(\n|\z))/n) do
+          $stderr.printf("send> %p\n", $&) if !$&.empty?
+        end
+      end
+      @socket.write(data)
+    end
+
+    def flush()
+      @socket.flush()
+    end
+
+    def security_digest(key1, key2, key3)
+      bytes1 = websocket_key_to_bytes(key1)
+      bytes2 = websocket_key_to_bytes(key2)
+      return Digest::MD5.digest(bytes1 + bytes2 + key3)
+    end
+
+    def generate_key()
+      spaces = 1 + rand(12)
+      max = 0xffffffff / spaces
+      number = rand(max + 1)
+      key = (number * spaces).to_s()
+      (1 + rand(12)).times() do
+        char = NOISE_CHARS[rand(NOISE_CHARS.size)]
+        pos = rand(key.size + 1)
+        key[pos...pos] = char
+      end
+      spaces.times() do
+        pos = 1 + rand(key.size - 1)
+        key[pos...pos] = " "
+      end
+      return key
+    end
+
+    def generate_key3()
+      return [rand(0x100000000)].pack("N") + [rand(0x100000000)].pack("N")
+    end
+
+    def websocket_key_to_bytes(key)
+      num = key.gsub(/[^\d]/n, "").to_i() / key.scan(/ /).size
+      return [num].pack("N")
+    end
+
+    def force_encoding(str, encoding)
+      if str.respond_to?(:force_encoding)
+        return str.force_encoding(encoding)
+      else
+        return str
+      end
+    end
+
+    def ssl_handshake(socket)
+      ssl_context = OpenSSL::SSL::SSLContext.new()
+      ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
+      ssl_socket.sync_close = true
+      ssl_socket.connect()
+      return ssl_socket
+    end
+  end # WebSocket
+end # Rocket

data/rocket-core.gemspec

@@ -0,0 +1,22 @@
+# -*- ruby -*-
+$:.unshift(File.expand_path('../lib', __FILE__))
+$:.unshift(File.expand_path('../../rocket/lib', __FILE__))
+require 'rocket/version'
+
+Gem::Specification.new do |s|
+  s.name               = 'rocket-core'
+  s.version            = Rocket.version
+  s.homepage           = 'http://github.com/araneo/rocket'
+  s.email              = ['chris@nu7hat.ch']
+  s.authors            = ['Araneo Ltd.', 'Chris Kowalik']
+  s.summary            = %q{Rocket core package.}
+  s.description        = %q{Core utils used by various Rocket components.}
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths      = %w[lib]
+  s.extra_rdoc_files   = %w[LICENSE README.md]
+
+  s.add_runtime_dependency     'json',           ['>= 1.4']
+  s.add_development_dependency 'rspec',          ["~> 2.0"]
+  s.add_development_dependency 'mocha',          [">= 0.9"]
+end

data/spec/helpers_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+class HelpersPoweredClass
+  include Rocket::Helpers
+end
+
+describe Rocket::Helpers do
+  subject do
+    HelpersPoweredClass.new
+  end
+  
+  describe "#symbolize_keys" do
+    it "should return given object when it's not a Hash" do
+      subject.symbolize_keys(obj = Object.new).should == obj
+    end
+    
+    it "should symbolize given hash keys" do
+      subject.symbolize_keys({"hello" => "world"}).should == {:hello => "world"}
+    end
+  end
+end

data/spec/rocket_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Rocket do
+  subject do
+    Rocket
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'mocha'
+require 'rspec'
+require 'rocket'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: rocket-core
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Araneo Ltd.
+- Chris Kowalik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id003
+description: Core utils used by various Rocket components.
+email: 
+- chris@nu7hat.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- lib/rocket-core.rb
+- lib/rocket/channel.rb
+- lib/rocket/client.rb
+- lib/rocket/helpers.rb
+- lib/rocket/websocket.rb
+- rocket-core.gemspec
+- spec/helpers_spec.rb
+- spec/rocket_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/araneo/rocket
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rocket core package.
+test_files: []
+