websocket-td 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 549ad5df2619ccc64b9be924d85d1bb34e7d5601
+  data.tar.gz: 8e3a9c62a78aab4095f71e8fa26c0cf922127ee3
+SHA512:
+  metadata.gz: d64310c37daa3d8783c82249d76b5933e5d31c191c9b2fb837f0d49edd59a684dd5e87abe8abc0281d23459cb203f1299ae258addace1c8df3775b7dc0d00dbb
+  data.tar.gz: b17d9279fa42be544bad826b647c49ac0dd269db0379806aa53b32e42decb045b417ca9c7fcb434998951af81540e3fb1cf7834cc6f4bc6eb5c0df479e4a7d97

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+sftp-config.json
+*.iml
+.idea/
+rdoc/
+*.gem

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011-2012 MediaSift 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/README.md

@@ -0,0 +1,17 @@
+WebSocket TD
+========
+
+A standards compliant WebSocket client which offers the option of either using 'green' threads or a single threaded evented approach
+Both ws and wss protocols supported.
+
+Install Instructions
+--------------------
+
+sudo gem install websocket-td
+
+Dependencies
+------------
+
+
+gem install websocket, multi_json, rdoc, shoulda, test-unit
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/examples/demo.rb

@@ -0,0 +1,27 @@
+class Demo
+  require '../lib/websocket_td'
+
+  def initialize
+
+    client = WebsocketTD::Websocket.new('websocket.datasift.com', '/multi', 'username=zcourts&api_key=91207449dd5b89a4ff38879a770975bf')
+    puts 'I continued'
+
+    client.on_message = lambda { |message| puts "message: #{message.data}" }
+
+    client.on_open  = lambda {
+      puts 'opened'
+      client.send("{ \"action\":\"subscribe\",\"hash\":\"1f678ba99fbcad0b572011b390cf5124\"}")
+    }
+    client.on_close = lambda { |m| puts "Closed #{m}" }
+    while true
+      puts 'subscribing'
+      if client.active
+        client.send("{ \"action\":\"subscribe\",\"hash\":\"1f678ba99fbcad0b572011b390cf5124\"}")
+      end
+      sleep(1)
+    end
+    #if main thread finishes then the process exists...don't let that happen
+    client.read_thread.join
+  end
+end
+Demo.new

data/lib/errors.rb

@@ -0,0 +1,8 @@
+class WsError < StandardError
+end
+class ConnectError < WsError
+end
+class WsProtocolError < WsError
+end
+class BadMessageTypeError < WsError
+end

data/lib/websocket_td.rb

@@ -0,0 +1,192 @@
+require 'websocket'
+require 'socket'
+require '../lib/errors'
+
+module WebsocketTD
+  class Websocket
+    # max length bytes to try to read from a socket per attempt
+    @read_buffer = 0
+    #true when reading data from a socket
+    @active      = false
+    #the tread currently being used to read data
+    @read_thread = nil
+    @auto_pong   = true
+    ##
+    # +host+:: Host of request. Required if no :url param was provided.
+    # +path+:: Path of request. Should start with '/'. Default: '/'
+    # +query+:: Query for request. Should be in format "aaa=bbb&ccc=ddd"
+    # +secure+:: Defines protocol to use. If true then wss://, otherwise ws://. This option will not change default port - it should be handled by programmer.
+    # +port+:: Port of request. Default: nil
+    def initialize(host, path, query, secure = false, port = nil)
+      if port == nil
+        port = secure ? 443 : 80
+      end
+
+      @handshake = WebSocket::Handshake::Client.new({
+                                                        :host   => host,
+                                                        :port   => port,
+                                                        :secure => secure,
+                                                        :path   => path,
+                                                        :query  => query
+                                                    })
+
+      @read_buffer = 2048
+      @auto_pong   = true
+      @closed      = false
+      @opened      = false
+
+      @on_open    = lambda {}
+      @on_close   = lambda { |message|}
+      @on_ping    = lambda { |message|}
+      @on_error   = lambda { |error|}
+      @on_message = lambda { |message|}
+
+      tcp_socket = TCPSocket.new(host, port)
+      if secure
+        @socket = OpenSSL::SSL::SSLSocket.new(tcp_socket)
+        @socket.connect
+      else
+        @socket = tcp_socket
+      end
+
+      @socket.write @handshake.to_s
+      buf     = ''
+      headers = ''
+      reading = true
+
+      while reading
+        begin
+          if @handshake.finished?
+            init_messaging
+            #don't stop reading until after init_message to guarantee @read_thread != nil for a successful connection
+            reading = false
+            @opened =true
+            fire_on_open
+          else
+            #do non blocking reads on headers - 1 byte at a time
+            buf.concat(@socket.read_nonblock(1))
+            #\r\n\r\n i.e. a blank line, separates headers from body
+            idx = buf.index(/\r\n\r\n/m)
+            if idx != nil
+              headers = buf.slice!(0..idx + 8) #+8 to include the blank line separator
+              @handshake << headers            #parse headers
+
+              if @handshake.finished? && !@handshake.valid?
+                fire_on_error(ConnectError.new('Server responded with an invalid handshake'))
+                fire_on_close() #close if handshake is not valid
+              end
+
+              if @handshake.finished?
+                @active = true
+                buf     = '' #clean up
+                headers = ''
+              end
+            end
+          end
+        rescue IO::WaitReadable
+          # ignored
+        rescue IO::WaitWritable
+          # ignored
+        end
+      end
+      puts headers
+    end
+
+    attr_reader :read_thread, :read_buffer, :socket, :active, :auto_pong
+    attr_writer :read_buffer, :auto_pong, :on_ping, :on_error, :on_message # :on_open, :on_close
+
+    def on_open=(p)
+      @on_open = p
+      if @opened
+        fire_on_open
+      end
+    end
+
+    def on_close=(p)
+      @on_close = p
+      if @closed
+        fire_on_close
+      end
+    end
+
+    #Use one thread to perform blocking read on the socket
+    def init_messaging
+      if @read_thread == nil
+        @read_thread = Thread.new do
+          read_loop
+        end
+      end
+    end
+
+    def read_loop
+      frame = WebSocket::Frame::Incoming::Client.new(:version => @handshake.version)
+      while @active
+        if @socket.closed?
+          @active = false
+          fire_on_close
+        else
+          frame << @socket.readpartial(@read_buffer)
+          if (message = frame.next) != nil
+            #"text", "binary", "ping", "pong" and "close" (according to websocket/base.rb)
+            determine_message_type(message)
+          end
+        end
+      end
+    end
+
+    def determine_message_type(message)
+      if message.type == :binary || message.type == :text
+        fire_on_message(message)
+      elsif message.type == :ping
+        if @auto_pong
+          send(message.data, :pong)
+        end
+        fire_on_ping(message)
+      elsif message.type == :pong
+        fire_on_error(WsProtocolError.new('Invalid type pong received'))
+      elsif message.type == :close
+        fire_on_close(message)
+      else
+        fire_on_error(BadMessageTypeError.new("An unknown message type was received #{message.data}"))
+      end
+    end
+
+
+    def send(data, type = :text)
+      frame = WebSocket::Frame::Outgoing::Client.new(:version => @handshake.version, :data => data, :type => type)
+      begin
+        @socket.write frame #_nonblock
+        @socket.flush
+      rescue Errno::EPIPE => ce
+        fire_on_error(ce)
+        fire_on_close
+      rescue Exception => e
+        fire_on_error(e)
+      end
+    end
+
+    def fire_on_ping(message)
+      @on_ping.call(message) unless @on_ping == nil
+    end
+
+    def fire_on_message(message)
+      @on_message.call(message) unless @on_message == nil
+    end
+
+    def fire_on_open
+      @on_open.call() unless @on_open == nil
+    end
+
+    def fire_on_error(error)
+      @on_error.call(error) unless @on_error == nil
+    end
+
+    def fire_on_close(message = nil)
+      @active = false
+      @closed = true
+      @on_close.call(message) unless @on_close == nil
+      @socket.close
+    end
+
+  end # class
+end # module

data/websocket_td.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name        = 'websocket-td'
+  s.version     = File.open('VERSION').first
+  s.authors     = ['Courtney Robinson']
+  s.email       = ['courtney.robinson@datasift.com']
+  s.description = %q{A multi-threaded WebSocket client, i.e. without event machine}
+  s.summary     = %q{A client which will offer the option of using green threads or a single threaded evented approach}
+  s.homepage    = 'http://github.com/zcourts/websocket-td'
+  s.license     = 'BSD'
+
+  s.platform         = Gem::Platform::RUBY
+  s.rubygems_version = %q{1.3.6}
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
+
+  s.add_runtime_dependency('websocket', '~> 1.1.1')
+  s.add_development_dependency('rdoc', '> 0')
+  s.add_development_dependency('shoulda', '~> 2.11.3')
+  s.add_development_dependency('test-unit', '>= 2.5.5')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: websocket-td
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Courtney Robinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.5
+description: A multi-threaded WebSocket client, i.e. without event machine
+email:
+- courtney.robinson@datasift.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- VERSION
+- examples/demo.rb
+- lib/errors.rb
+- lib/websocket_td.rb
+- websocket_td.gemspec
+homepage: http://github.com/zcourts/websocket-td
+licenses:
+- BSD
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: A client which will offer the option of using green threads or a single threaded
+  evented approach
+test_files: []