bogo-websocket 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 538a7b638863e49064d58a438df0541bda67566a
+  data.tar.gz: bbe48fd88ed074d4e58bbc41390445b69d6e9c8c
+SHA512:
+  metadata.gz: 0b460274ce5dd7f7d030e4ed7ab51464e5f6d5847e2047a760797138d0e0cf99b8b8ffeaf330b972c02020fecd51a02400306194be240cd163da77351a062a36
+  data.tar.gz: 8199bfc24c40d690ed1ffe19b2528cc27cd7e562234fcf11b1f2f06c52df91c99c2eacc72d9e3490a1d593bd1ad7fb70fa4292379e45b0856335e7a4dea2c5ec

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# v0.1.0
+* Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+## Branches
+
+### `master` branch
+
+The master branch is the current stable released version.
+
+### `develop` branch
+
+The develop branch is the current edge of development.
+
+## Pull requests
+
+* https://github.com/spox/bogo-websocket/pulls
+
+Please base all pull requests of the `develop` branch. Merges to
+`master` only occur through the `develop` branch. Pull requests
+based on `master` will likely be cherry picked.
+
+## Issues
+
+Need to report an issue? Use the github issues:
+
+* https://github.com/spox/bogo-websocket/issues

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2015 Chris Roberts
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,67 @@
+# Bogo Websocket
+
+Simple websocket library
+
+## Usage
+
+### Basic Usage
+
+```ruby
+require 'bogo-websocket'
+
+socket = Bogo::Websocket::Client.new(
+  :destination => 'ws://example.com:8080',
+  :path => '/websocket',
+  :params => {
+    :fubar => true
+  },
+  :headers => {
+    'X-WOW' => 'custom header'
+  },
+  :on_connect => proc{
+    puts 'Socket Connected'
+  },
+  :on_disconnect => proc{
+    puts 'Socket Disconnected'
+  },
+  :on_error => proc{|error|
+    puts "Error caught: #{error.class} - #{error}"
+  },
+  :on_message => proc{|msg|
+    puts "Received message: #{msg.inspect}"
+  }
+)
+socket.write('stuff')
+```
+
+### SSL Usage
+
+```ruby
+socket = Bogo::Websocket::Client.new(
+  :destination => 'wss://example.com:8080',
+  ...
+```
+
+#### SSL Usage with Client Key/Certificate
+
+```ruby
+socket = Bogo::Websocket::Client.new(
+  :destination => 'wss://example.com:8080',
+  :ssl_key => '/local/path/to/key',
+  :ssl_certificate => '/local/path/to/cert',
+  ...
+```
+
+#### SSL Usage with Custom Context
+
+```ruby
+ssl_ctx = OpenSSL::SSL::SSLContext.new
+...
+socket = Bogo::Websocket::Client.new(
+  :destination => 'wss://example.com:8080',
+  :ssl_context => ssl_ctx,
+  ...
+```
+
+## Info
+* Repository: https://github.com/spox/bogo-websocket

data/bogo-websocket.gemspec

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__)) + '/lib/'
+require 'bogo-websocket/version'
+Gem::Specification.new do |s|
+  s.name = 'bogo-websocket'
+  s.version = Bogo::Websocket::VERSION.version
+  s.summary = 'Simple websocket libraries'
+  s.author = 'Chris Roberts'
+  s.email = 'code@chrisroberts.org'
+  s.homepage = 'https://github.com/spox/bogo-websocket'
+  s.description = 'Simple websocket libraries'
+  s.require_path = 'lib'
+  s.license = 'Apache 2.0'
+  s.add_runtime_dependency 'bogo', '>= 0.1.30', '< 1.0.0'
+  s.add_runtime_dependency 'websocket', '~> 1.2.2'
+  s.add_development_dependency 'minitest'
+  s.files = Dir['lib/**/*'] + %w(bogo-websocket.gemspec README.md CHANGELOG.md CONTRIBUTING.md LICENSE)
+end

data/lib/bogo-websocket/version.rb

@@ -0,0 +1,5 @@
+module Bogo
+  module Websocket
+    VERSION = Gem::Version.new('0.1.0')
+  end
+end

data/lib/bogo-websocket/websocket.rb

@@ -0,0 +1,184 @@
+require 'openssl'
+require 'websocket'
+require 'bogo-websocket'
+
+module Bogo
+  module Websocket
+
+    # Simple websocket client
+    class Client
+
+      include Bogo::Lazy
+      include Bogo::Memoization
+
+      attribute :destination, URI, :required => true, :coerce => lambda{|v| URI.parse(v) }
+      attribute :path, String
+      attribute :params, Hash, :default => {}
+      attribute :headers, Hash, :default => {}
+      attribute :ssl_context, OpenSSL::SSL::SSLContext
+      attribute :ssl_key, String
+      attribute :ssl_certificate, String
+
+      attribute :on_connect, Proc, :default => proc{}
+      attribute :on_disconnect, Proc, :default => proc{}
+      attribute :on_error, Proc, :default => proc{|error|}
+      attribute :on_message, Proc, :default => proc{|message|}
+
+      # @return [TCPSocket, OpenSSL::SSL::SSLSocket]
+      attr_reader :connection
+      # @return [Thread]
+      attr_reader :container
+      # @return [WebSocket::Frame::Incoming::Client]
+      attr_reader :client
+      # @return [WebSocket::Handshake::Client]
+      attr_reader :handshake
+      # @return [TrueClass, FalseClass]
+      attr_reader :die
+      # @return [IO]
+      attr_reader :control_r
+      # @return [IO]
+      attr_reader :control_w
+
+      # Create a new websocket client
+      #
+      # @return [self]
+      def initialize(args={})
+        load_data(args)
+        @control_r, @control_w = IO.pipe
+        @die = false
+        setup_connection
+        perform_handshake
+        @lock = Mutex.new
+        @container = start!
+      end
+
+      # Write to socket
+      #
+      # @param line [String]
+      def write(line)
+        transmit(line, :text)
+      end
+
+      # Close the connection
+      def close
+        connection.close
+        @die = true
+        control_w.write 'closed'
+        container.join
+      end
+
+      # Start the reader
+      def start!
+        unless(@container)
+          @container = Thread.new do
+            until(die || connection.closed?)
+              begin
+                unless(die || connection.closed?)
+                  client << connection.read_nonblock(2046)
+                  if(message = client.next)
+                    handle_message(message)
+                  end
+                end
+              rescue IO::WaitReadable
+                unless(die || connection.closed?)
+                  IO.select([connection, control_r])
+                  retry
+                end
+              rescue EOFError
+                connection.close
+              rescue => error
+                on_error.call(error)
+                raise
+              end
+            end
+            @connection = nil
+          end
+        end
+      end
+
+      # Handle an incoming message
+      #
+      # @param message [WebSocket::Frame::Incoming::Client]
+      def handle_message(message)
+        case message.type
+        when :binary, :text
+          on_message.call(message.data)
+        when :ping
+          transmit(message.data, :pong)
+        when :close
+          connection.close
+          on_disconnect.call
+        end
+      end
+
+      # Send data to socket
+      #
+      # @param data [String]
+      # @param type [Symbol]
+      def transmit(data, type)
+        message = WebSocket::Frame::Outgoing::Client.new(
+          :version => handshake.version,
+          :data => data,
+          :type => type
+        )
+        result = connection.write message.to_s
+        connection.flush
+        result
+      end
+
+      # Setup the handshake and perform handshake with remote connection
+      #
+      # @return [TrueClass]
+      def perform_handshake
+        port = destination.port || destination.scheme == 'wss' ? 443 : 80
+        @handshake = WebSocket::Handshake::Client.new(
+          :host => destination.host,
+          :port => port,
+          :secure => destination.scheme == 'wss',
+          :path => path,
+          :query => URI.encode_www_form(params),
+          :headers => headers
+        )
+        connection.write handshake.to_s
+        reply = ''
+        until(handshake.finished?)
+          reply << connection.read(1)
+          if(reply.index(/\r\n\r\n/m))
+            handshake << reply
+            reply = ''
+          end
+        end
+        unless(handshake.valid?)
+          raise ArgumentError.new 'Invalid handshake. Failed to connect!'
+        end
+        @client = WebSocket::Frame::Incoming::Client.new(:version => handshake.version)
+        true
+      end
+
+      # @return [TCPSocket, OpenSSL::SSL::SSLSocket]
+      def setup_connection
+        socket = TCPSocket.new(destination.host, destination.port)
+        if(destination.scheme == 'wss')
+          socket = OpenSSL::SSL::SSLSocket.new(socket, build_ssl_context)
+          socket.connect
+        end
+        @connection = socket
+      end
+
+      # @return [OpenSSL::SSL::SSLContext]
+      def build_ssl_context
+        if(ssl_context)
+          ssl_context
+        else
+          ctx = OpenSSL::SSL::SSLContext.new
+          if(ssl_key || ssl_certificate)
+            ctx.cert = OpenSSL::X509::Certificate.new(File.read(ssl_certificate))
+            ctx.key = OpenSSL::PKey::RSA.new(File.read(ssl_key))
+          end
+          ctx
+        end
+      end
+
+    end
+  end
+end

data/lib/bogo-websocket.rb

@@ -0,0 +1,9 @@
+require 'bogo'
+
+module Bogo
+  module Websocket
+    autoload :Client, 'bogo-websocket/websocket'
+  end
+end
+
+require 'bogo-websocket/version'

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: bogo-websocket
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bogo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.30
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.30
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+description: Simple websocket libraries
+email: code@chrisroberts.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- bogo-websocket.gemspec
+- lib/bogo-websocket.rb
+- lib/bogo-websocket/version.rb
+- lib/bogo-websocket/websocket.rb
+homepage: https://github.com/spox/bogo-websocket
+licenses:
+- Apache 2.0
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple websocket libraries
+test_files: []