Gitingest

Include files under: 50kB

Private Repository NEW

Summary

Repository: shokai/websocket-client-simple
Files analyzed: 18

Estimated tokens: 4.2k

Download

Directory Structure

Directory structure:

└── shokai-websocket-client-simple/

    ├── README.md

    ├── circle.yml

    ├── Gemfile

    ├── History.txt

    ├── LICENSE.txt

    ├── Rakefile

    ├── websocket-client-simple.gemspec

    ├── lib/

    │   ├── websocket-client-simple.rb

    │   └── websocket-client-simple/

    │       ├── client.rb

    │       └── version.rb

    ├── sample/

    │   ├── client.rb

    │   ├── echo_server.rb

    │   └── webbrowser/

    │       ├── index.html

    │       └── main.js

    └── test/

        ├── echo_server.rb

        ├── test_connect_block.rb

        ├── test_helper.rb

        └── test_websocket_client_simple.rb

Files Content

================================================
FILE: README.md
================================================
websocket-client-simple
=======================

:warning: Important notice :warning:
------------------------------------

The development of this repository has moved to [ruby-jp/websocket-client-simple](https://github.com/ruby-jp/websocket-client-simple).

-------------

Simple WebSocket Client for Ruby

- https://github.com/shokai/websocket-client-simple
- https://rubygems.org/gems/websocket-client-simple

[![Circle CI](https://circleci.com/gh/shokai/websocket-client-simple.svg?style=svg)](https://circleci.com/gh/shokai/websocket-client-simple)

Installation
------------

    gem install websocket-client-simple


Usage
-----
```ruby
require 'rubygems'
require 'websocket-client-simple'

ws = WebSocket::Client::Simple.connect 'ws://example.com:8888'

ws.on :message do |msg|
  puts msg.data
end

ws.on :open do
  ws.send 'hello!!!'
end

ws.on :close do |e|
  p e
  exit 1
end

ws.on :error do |e|
  p e
end

loop do
  ws.send STDIN.gets.strip
end
```

`connect` runs a given block before connecting websocket

```ruby
WebSocket::Client::Simple.connect 'ws://example.com:8888' do |ws|
  ws.on :open do
    puts "connect!"
  end

  ws.on :message do |msg|
    puts msg.data
  end
end
```


Sample
------
[websocket chat](https://github.com/shokai/websocket-client-simple/tree/master/sample)


Test
----

    % gem install bundler
    % bundle install
    % export WS_PORT=8888
    % rake test


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



================================================
FILE: circle.yml
================================================
machine:
  ruby:
    version: "2.2.2"



================================================
FILE: Gemfile
================================================
source 'https://rubygems.org'

# Specify your gem's dependencies in websocket-client-simple.gemspec
gemspec



================================================
FILE: History.txt
================================================
=== 0.3.0 2016-02-20

* "connect" method runs a given block before connecting WebSocket  #12
  * thank you for suggestion @codekitchen

=== 0.2.5 2016-02-18

* bugfixed sending when broken pipe  #15
* add :verify_mode option for SSL Context  #14
  * thank you for contributing @michaelvilensky

=== 0.2.4 2015-11-12

* support handshake headers  #11
  * thank you for contributing @mathieugagne

=== 0.2.3 2015-10-26

* kill thread at end of method
  * thank you for contributing @hansy

=== 0.2.2 2014-11-18

* add :ssl_version option to specify version of SSL/TLS
  * thank you for contributing @tonybyrne

=== 0.2.1 2014-10-19

* bugfix socket reading

=== 0.2.0 2014-06-07

* SSL support with wss:// and https:// scheme
  * thank you for contributing @mallowlabs

=== 0.1.0 2014-05-08

* add accessor Client#handshake  #5
* bugfix socket reading

=== 0.0.9 2014-04-03

* emit "error" in receive thread
* rescue only Errno::EPIPE, not all Errors

=== 0.0.8 2014-01-29

* bugfix Client#close  #4

=== 0.0.7 2014-01-29

* send CLOSE frame in Client#close  #4

=== 0.0.6 2014-01-17

* add function Client#open?

=== 0.0.5 2013-03-23

* kill read thread on close

=== 0.0.4 2013-03-23

* fix sample and README

=== 0.0.3 2013-03-23

* :type => :text option in send

=== 0.0.2 2013-03-22

* remove unnecessary sleep

=== 0.0.1 2013-03-22

* release



================================================
FILE: LICENSE.txt
================================================
Copyright (c) 2013-2014 Sho Hashimoto

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.



================================================
FILE: Rakefile
================================================
require "bundler/gem_tasks"
require "rake/testtask"

Rake::TestTask.new do |t|
  t.pattern = "test/test_*.rb"
end

task :default => :test



================================================
FILE: websocket-client-simple.gemspec
================================================
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'websocket-client-simple/version'

Gem::Specification.new do |spec|
  spec.name          = "websocket-client-simple"
  spec.version       = WebSocket::Client::Simple::VERSION
  spec.authors       = ["Sho Hashimoto"]
  spec.email         = ["hashimoto@shokai.org"]
  spec.description   = %q{Simple WebSocket Client for Ruby}
  spec.summary       = spec.description
  spec.homepage      = "https://github.com/shokai/websocket-client-simple"
  spec.license       = "MIT"

  spec.files         = `git ls-files`.split($/).reject{|f| f == "Gemfile.lock" }
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]

  spec.add_development_dependency "bundler", "~> 1.3"
  spec.add_development_dependency "rake"
  spec.add_development_dependency "minitest"
  spec.add_development_dependency "websocket-eventmachine-server"
  spec.add_development_dependency "eventmachine"

  spec.add_dependency "websocket"
  spec.add_dependency "event_emitter"
end



================================================
FILE: lib/websocket-client-simple.rb
================================================
require 'event_emitter'
require 'websocket'
require 'socket'
require 'openssl'
require 'uri'

require 'websocket-client-simple/version'
require 'websocket-client-simple/client'

module WebSocket
  module Client
    module Simple
    end
  end
end



================================================
FILE: lib/websocket-client-simple/client.rb
================================================
module WebSocket
  module Client
    module Simple

      def self.connect(url, options={})
        client = ::WebSocket::Client::Simple::Client.new
        yield client if block_given?
        client.connect url, options
        return client
      end

      class Client
        include EventEmitter
        attr_reader :url, :handshake

        def connect(url, options={})
          return if @socket
          @url = url
          uri = URI.parse url
          @socket = TCPSocket.new(uri.host,
                                  uri.port || (uri.scheme == 'wss' ? 443 : 80))
          if ['https', 'wss'].include? uri.scheme
            ctx = OpenSSL::SSL::SSLContext.new
            ctx.ssl_version = options[:ssl_version] || 'SSLv23'
            ctx.verify_mode = options[:verify_mode] || OpenSSL::SSL::VERIFY_NONE #use VERIFY_PEER for verification
            cert_store = OpenSSL::X509::Store.new
            cert_store.set_default_paths
            ctx.cert_store = cert_store
            @socket = ::OpenSSL::SSL::SSLSocket.new(@socket, ctx)
            @socket.connect
          end
          @handshake = ::WebSocket::Handshake::Client.new :url => url, :headers => options[:headers]
          @handshaked = false
          @pipe_broken = false
          frame = ::WebSocket::Frame::Incoming::Client.new
          @closed = false
          once :__close do |err|
            close
            emit :close, err
          end

          @thread = Thread.new do
            while !@closed do
              begin
                unless recv_data = @socket.getc
                  sleep 1
                  next
                end
                unless @handshaked
                  @handshake << recv_data
                  if @handshake.finished?
                    @handshaked = true
                    emit :open
                  end
                else
                  frame << recv_data
                  while msg = frame.next
                    emit :message, msg
                  end
                end
              rescue => e
                emit :error, e
              end
            end
          end

          @socket.write @handshake.to_s
        end

        def send(data, opt={:type => :text})
          return if !@handshaked or @closed
          type = opt[:type]
          frame = ::WebSocket::Frame::Outgoing::Client.new(:data => data, :type => type, :version => @handshake.version)
          begin
            @socket.write frame.to_s
          rescue Errno::EPIPE => e
            @pipe_broken = true
            emit :__close, e
          end
        end

        def close
          return if @closed
          if !@pipe_broken
            send nil, :type => :close
          end
          @closed = true
          @socket.close if @socket
          @socket = nil
          emit :__close
          Thread.kill @thread if @thread
        end

        def open?
          @handshake.finished? and !@closed
        end

      end

    end
  end
end



================================================
FILE: lib/websocket-client-simple/version.rb
================================================
module WebSocket
  module Client
    module Simple
      VERSION = "0.3.0"
    end
  end
end



================================================
FILE: sample/client.rb
================================================
#!/usr/bin/env ruby
$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
require 'rubygems'
require 'websocket-client-simple'

puts "websocket-client-simple v#{WebSocket::Client::Simple::VERSION}"

url = ARGV.shift || 'ws://localhost:8080'

ws = WebSocket::Client::Simple.connect url

ws.on :message do |msg|
  puts ">> #{msg.data}"
end

ws.on :open do
  puts "-- websocket open (#{ws.url})"
end

ws.on :close do |e|
  puts "-- websocket close (#{e.inspect})"
  exit 1
end

ws.on :error do |e|
  puts "-- error (#{e.inspect})"
end

loop do
  ws.send STDIN.gets.strip
end



================================================
FILE: sample/echo_server.rb
================================================
#!/usr/bin/env ruby
require 'eventmachine'
require 'websocket-eventmachine-server'

PORT = (ARGV.shift || 8080).to_i

EM::run do
  @channel = EM::Channel.new

  puts "start websocket server - port:#{PORT}"

  WebSocket::EventMachine::Server.start(:host => "0.0.0.0", :port => PORT) do |ws|
    ws.onopen do
      sid = @channel.subscribe do |mes|
        ws.send mes
      end
      puts "<#{sid}> connect"

      @channel.push "hello new client <#{sid}>"

      ws.onmessage do |msg|
        puts "<#{sid}> #{msg}"
        @channel.push "<#{sid}> #{msg}"
      end

      ws.onclose do
        puts "<#{sid}> disconnected"
        @channel.unsubscribe sid
        @channel.push "<#{sid}> disconnected"
      end
    end
  end

end



================================================
FILE: sample/webbrowser/index.html
================================================
<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" content="text/html" http-equiv="Content-Type">
    <title>websocket chat</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
    <script src="./main.js"></script>
  </head>
  <body>
    <h1>websocket chat</h1>
    <div>
      <input id="name" size="15" type="text" value="NAME">
      <input id="message" size="80" type="text" value="hello hello">
      <input id="btn_post" type="button" value="post">
    </div>
    <ul id="chat"></ul>
    <div id="footer">
      <hr>
      <a href="https://github.com/shokai/websocket-client-simple">https://github.com/shokai/websocket-client-simple</a>
    </div>
  </body>
</html>



================================================
FILE: sample/webbrowser/main.js
================================================
var ws = new WebSocket("ws://localhost:8080");

ws.onmessage = function(e){
  print(e.data);
};

ws.onopen = function(e){
  log("websocket open");
  console.log(e);
};

ws.onclose = function(e){
  log("websocket close");
  console.log(e);
};

$(function(){
  $("#btn_post").click(post);
  $("#message").keydown(function(e){
    if(e.keyCode == 13) post();
  });
});

var post = function(){
  var name = $("#name").val();
  var mes = $("#message").val();
  ws.send(name+" : "+mes);
  $("input#message").val("");
};

var log = function(msg){
  console.log(msg);
  $("#chat").prepend($("<li>").text("[log] "+msg));
};

var print = function(msg){
  $("#chat").prepend($("<li>").text(msg));
};



================================================
FILE: test/echo_server.rb
================================================
module EchoServer
  def self.start
    WebSocket::EventMachine::Server.start(:host => "0.0.0.0", :port => self.port) do |ws|
      @channel = EM::Channel.new
      ws.onopen do
        sid = @channel.subscribe do |mes|
          ws.send mes  # echo to client
        end
        ws.onmessage do |msg|
          @channel.push msg
        end
        ws.onclose do
          @channel.unsubscribe sid
        end
      end
    end
  end

  def self.port
    (ENV['WS_PORT'] || 18080).to_i
  end

  def self.url
    "ws://localhost:#{self.port}"
  end
end



================================================
FILE: test/test_connect_block.rb
================================================
require File.expand_path 'test_helper', File.dirname(__FILE__)

class TestWebSocketClientSimple < MiniTest::Test
  
  def test_onopen
    
    EM::run{
      
      EchoServer.start

      res = nil

      EM::add_timer 1 do
        WebSocket::Client::Simple.connect EchoServer.url do |client|
          client.on :open do
            client.send "hello world"
          end

          client.on :message do |msg|
            res = msg.to_s
          end
        end
      end

      EM::add_timer 2 do
        assert_equal res, "hello world"
        EM::stop_event_loop
      end
    }
    
  end
  
end



================================================
FILE: test/test_helper.rb
================================================
require 'rubygems'
require 'bundler'
require 'minitest/autorun'
require 'websocket-client-simple'
require 'eventmachine'
require 'websocket-eventmachine-server'
require_relative 'echo_server'

$:.unshift File.expand_path '../lib', File.dirname(__FILE__)



================================================
FILE: test/test_websocket_client_simple.rb
================================================
require_relative 'test_helper'

class TestWebSocketClientSimple < MiniTest::Test

  def test_echo
    msgs = ['foo','bar','baz']
    res1 = []
    res2 = []

    EM::run{
      EchoServer.start

      ## client1 --> server --> client2
      EM::add_timer 1 do
        client1 = WebSocket::Client::Simple.connect EchoServer.url
        client2 = WebSocket::Client::Simple.connect EchoServer.url
        assert_equal client1.open?, false
        assert_equal client2.open?, false

        client1.on :message do |msg|
          res1.push msg
        end

        client2.on :message do |msg|
          res2.push msg
        end

        client1.on :open do
          msgs.each do |m|
            client1.send m
          end
        end

        client1.on :close do
          EM::stop_event_loop
        end

        client2.on :close do
          EM::stop_event_loop
        end

        EM::add_timer 3 do
          assert_equal client1.open?, true
          assert_equal client2.open?, true
          client1.close
          client2.close
          EM::stop_event_loop
        end
      end
    }

    assert_equal msgs.size, res1.size
    assert_equal msgs.size, res2.size

    msgs.each_with_index do |msg,i|
      assert_equal msg, res1[i].to_s
      assert_equal msg, res2[i].to_s
    end

  end

end