websocket_sequential_client 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c86e2bfd2241079309ed7daceed67c861a0e6e27
-  data.tar.gz: f1f3b91c65126b6885bd5c6b735e44c350ada22c
+  metadata.gz: 4a9cdfa2ccc4b1defa9165cfeddf1ec01abf7825
+  data.tar.gz: c35dea58c8e676a4642500210ac907d605e9b9cd
 SHA512:
-  metadata.gz: 85b89614c39101a15684018881338f6aa747faeeb34e909f112d6fbc2762bd7000c04e9902ad42ed93bb9b35222ab668d2c84553c74adfbb42e5fba8e4f43c3c
-  data.tar.gz: e43c3706bef4b80a410ad6946958e608e59a77bff13b79a582a3a1b35b57fb0b83ba4293e254b7db59d487237ec34233c3f775f0f695b77c9c0a4fdaab32cecb
+  metadata.gz: 86696686c0fcd88d2e7e076a87a2800544b2df30c0d24c04791fc2008364ebeb9ad60f55cef242d26aa34d50eaa7fc5463531acb2a98820a18ad800d09d4af8e
+  data.tar.gz: 01c5186f40dd70ae8f2cd3dfb6e1e9ad278cda60743cbc5abcdffbda4e4daf75847243b5f818f349923e44b43b78950205928ff67f4c4cebb2d68df7a5adf203

data/.travis.yml

@@ -10,9 +10,9 @@ rvm:
   - 2.2
   - ruby-head
   - rbx
-  - jruby
+#  - jruby
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: rbx
-    - rvm: jruby
+#    - rvm: jruby

data/README.md

@@ -1,4 +1,4 @@
-# WebsocketSequentialClient [![Build Status](https://travis-ci.org/masamitsu-murase/websocket_sequential_client.svg)](https://travis-ci.org/masamitsu-murase/websocket_sequential_client)
+# WebSocketSequentialClient [![Gem Version](https://badge.fury.io/rb/websocket_sequential_client.svg)](http://badge.fury.io/rb/websocket_sequential_client) [![Build Status](https://travis-ci.org/masamitsu-murase/websocket_sequential_client.svg)](https://travis-ci.org/masamitsu-murase/websocket_sequential_client)
 
 This ruby gem library allows you to access a WebSocket server in a **sequential** way instead of an event-driven way.
 
@@ -122,6 +122,8 @@ ws.close
 
 ## Versions
 
+* 1.0.1  
+  Fix handling of optional parameters.
 * 1.0.0  
   Initial release
 

data/lib/websocket_sequential_client.rb

@@ -7,5 +7,6 @@ require "websocket_sequential_client/exception"
 module WebsocketSequentialClient
 end
 
+# <tt>WebSocketSequentialClient</tt> can be used instead of <tt>WebsocketSequentialClient</tt>.
 WebSocketSequentialClient = WebsocketSequentialClient
 

data/lib/websocket_sequential_client/exception.rb

@@ -1,15 +1,27 @@
 # -*- coding: utf-8 -*-
 
 module WebsocketSequentialClient
+  #
+  # Base errror class
+  #
   class Error < StandardError
   end
 
+  #
+  # This error is raised when <tt>recv</tt> or <tt>send</tt> is called after the socket is closed.
+  #
   class SocketAlreadyClosed < Error
   end
 
+  #
+  # This error is raised when handshake with a server failed.
+  #
   class HandshakeFailed < Error
   end
 
+  #
+  # This error is raised when a invaid data is received.
+  #
   class InvalidDataReceived < Error
   end
 end

data/lib/websocket_sequential_client/read_queue.rb

@@ -3,7 +3,7 @@
 require "thread"
 
 module WebsocketSequentialClient
-  class ReadQueue
+  class ReadQueue  #:nodoc:
     def initialize
       @mutex = Mutex.new
       @cond_var = ConditionVariable.new

data/lib/websocket_sequential_client/version.rb

@@ -1,3 +1,3 @@
 module WebsocketSequentialClient
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/websocket_sequential_client/web_socket.rb

@@ -4,15 +4,41 @@ require("socket")
 require("thread")
 
 module WebsocketSequentialClient
+  #
+  # This class provides the access to a WebSocket server.
+  #
   class WebSocket
     DEFAULT_PING_INTERVAL = 20
     DEFAULT_CLOSE_CODE = 1000
     DEFAULT_CLOSE_TIMEOUT = 20
 
-    RECV_SIZE = 1024
-
-    WS_PORT = 80
-
+    RECV_SIZE = 1024  #:nodoc:
+
+    WS_PORT = 80  #:nodoc:
+
+    #
+    # Connects to a WebSocket server and returns the connected socket.
+    #
+    # === Parameters
+    # +args+ :: See <tt>initialize</tt> method.
+    # +block+ :: If given, it will be called with the instance of WebSocket as the argument.
+    #
+    # === Examples
+    #   WebSocketSequentialClient::WebSocket.open "ws://server-url" do |ws|
+    #     ws.send "message"
+    #     puts ws.recv
+    #   end
+    #
+    #   ws = WebSocketSequentialClient::WebSocket.open "ws://server-url"
+    #   ws.send "message"
+    #   puts ws.recv
+    #   ws.close
+    #
+    #   WebSocketSequentialClient::WebSocket.open "ws://server-url", { ping: false } do |ws|
+    #     ws.send "message"
+    #     puts ws.recv
+    #   end
+    #
     def self.open *args, &block
       if block
         ws = self.new *args
@@ -26,7 +52,29 @@ module WebsocketSequentialClient
       end
     end
 
-    def initialize url, opt = { ping: true, headers: {} }
+    #
+    # Connects to a WebSocket server and returns the connected socket.
+    #
+    # === Parameters
+    # +url+ :: URL of the server.
+    # +opt+ :: Optional hash parameters.
+    #          <tt>:ping</tt> key specifies whether to enable automatic ping. You can set <tt>true</tt>, <tt>false</tt> or <tt>{ interval: 10 }</tt>. The default value is <tt>true</tt>.
+    #          <tt>:headers</tt> key specifies the additional HTTP headers. You can set <tt>{ headers: { "Cookie" => "name=value" } }</tt>. The default value is <tt>{}</tt> (empty hash).
+    #
+    # === Examples
+    #   # Connect to the server.
+    #   ws = WebSocketSequentialClient::WebSocket.new "ws://server-url"
+    #
+    #   # Disable automatic ping.
+    #   ws = WebSocketSequentialClient::WebSocket.new "ws://server-url", ping: false
+    #
+    #   # Set the ping interval to 10s and send additional HTTP headers.
+    #   opt = { ping: { interval: 10 }, headers: { "Cookie" => "name=value", "Header" => "Value" } }
+    #   ws = WebSocketSequentialClient::WebSocket.open "ws://server-url", opt
+    #
+    def initialize url, opt = {}
+      opt = { ping: true, headers: {} }.merge opt
+
       @read_queue = ReadQueue.new
       @write_queue = WriteQueue.new
 
@@ -64,11 +112,20 @@ module WebsocketSequentialClient
     end
     attr_reader :close_code, :close_reason
 
+    #
+    # Returns true if a received data is in the internal buffer.
+    #
     def available?
       @read_queue.available?
     end
     alias data_available? available?
 
+    #
+    # Returns a received data from the server.
+    # The encoding of the returned data is "UTF-8" for text messages, "ASCII-8BIT" for binary messages.
+    #
+    # This is a <b>blocking</b> method. i.e. This method is blocked until a data is received from the server.
+    #
     def recv
       data = @read_queue.pop
       raise data if data.kind_of? StandardError
@@ -84,6 +141,13 @@ module WebsocketSequentialClient
     end
     alias receive recv
 
+    #
+    # Sends a data to the server.
+    #
+    # === Parameters
+    # +data+ :: String to be sent. The encoding should be "UTF-8" for text messages, "ASCII-8BIT" for binary messages.
+    # +type+ :: Specifies <tt>:text</tt>, <tt>:binary</tt> or <tt>:guess</tt>. If <tt>:guess</tt> is specified, the type is guessed based on the encoding of <tt>data</tt>.
+    #
     def send data, type = :guess
       case type
       when :guess
@@ -111,16 +175,33 @@ module WebsocketSequentialClient
       raise result if result.kind_of? StandardError
     end
 
+    #
+    # Sends a text message.
+    # Same as <tt>send data, :text</tt>.
+    #
     def send_text data
       send data, :text
     end
 
+    #
+    # Sends a binary message.
+    # Same as <tt>send data, :binary</tt>.
+    #
     def send_binary data
       send data, :binary
     end
 
-    def close code = nil, reason = nil, opt = { timeout: DEFAULT_CLOSE_TIMEOUT, wait_for_response: true }
+    #
+    # Close the socket.
+    #
+    # === Parameters
+    # +code+ :: Code of the close frame. The default value is 1000.
+    # +reason+ :: The reason of the close frame. The default value is nil.
+    #
+    def close code = nil, reason = nil, opt = {}
       code ||= DEFAULT_CLOSE_CODE
+      opt = { timeout: DEFAULT_CLOSE_TIMEOUT, wait_for_response: true }.merge opt
+
       param = {
         code: code,
         type: :close,
@@ -129,10 +210,10 @@ module WebsocketSequentialClient
       param[:data] = reason if reason
       frame = ::WebSocket::Frame::Outgoing::Client.new(param)
 
-      @close_timeout = (opt.key?(:timeout) ? opt[:timeout] : DEFAULT_CLOSE_CODE)
+      @close_timeout = opt[:timeout]
       @write_queue.process_frame frame
 
-      wait_for_response = (opt.key?(:wait_for_response) ? opt[:wait_for_response] : true)
+      wait_for_response = opt[:wait_for_response]
       if wait_for_response
         @closed_status_mutex.synchronize do
           @closed_status_cond_var.wait @closed_status_mutex until @closed_status == :closed
@@ -158,7 +239,11 @@ module WebsocketSequentialClient
     end
 
     def start_ping_thread ping_opt
-      interval = (ping_opt[:interval] rescue DEFAULT_PING_INTERVAL)
+      if ping_opt == true
+        interval = DEFAULT_PING_INTERVAL
+      else
+        interval = (ping_opt[:interval] || DEFAULT_PING_INTERVAL)
+      end
       raise ArgumentError, "opt[:ping][:interval] must be a positive number." if interval <= 0
       @ping_th = Thread.start(interval) do |i|
         while true

data/lib/websocket_sequential_client/write_queue.rb

@@ -3,7 +3,7 @@
 require "thread"
 
 module WebsocketSequentialClient
-  class WriteQueue
+  class WriteQueue  #:nodoc:
     def initialize
       @mutex = Mutex.new
       @cond_var = ConditionVariable.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: websocket_sequential_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Masamitsu MURASE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket