tamashii-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 616b8acc7d50fcb48f9b8e3cd333fd664e41e9cb
-  data.tar.gz: 0c4529a5ee7eee3844f6cad3d05052d01b656526
+  metadata.gz: be044e47ec7a244c52a655253dd614914f16d9c3
+  data.tar.gz: 572050ce905a7f055a1fe2db1551731a68962779
 SHA512:
-  metadata.gz: 3e329f34d53186908f64c96143acc0ba3dcd7d657f8d85957a204bdc9c12b1cf8638a3b8611409f5fb99a16d845e22c2dbfdcaf3b0b4e8f0118bf2531700fc60
-  data.tar.gz: 11f3285f16c6d6634603cc1b82b8ebd60ebd9ee61e3e71ce60c1e62be832eb06f7353086a9937944763e9187eb6ca7f926d5560c453393dbbc2a95f0a839a0a8
+  metadata.gz: efaecb8ab11fb8facf2d0b9b6468f937699f4f5b24a4b553ac81340bdc4ab3a6c50b36712943d8c6eb079738749fc872411f0b774d29b449cbb6ef2e88d46d55
+  data.tar.gz: 8d6c7c85d20a035fd825c1c3bdd1e05e342eba5e68d282b119b5b54836153a3988864ad1f2c55af5db073caeb11e299ce66752d5b67bb678062295c05823607f

data/README.md

@@ -1,15 +1,15 @@
----
-tags: tamashii, readme
----
-
-Tamashii Client [![Gem Version](https://badge.fury.io/rb/tamashii-client.svg)](https://badge.fury.io/rb/tamashii-client) 
+Tamashii Client [![Gem Version](https://badge.fury.io/rb/tamashii-client.svg)](https://badge.fury.io/rb/tamashii-client)
 ===
 
-Tamashii Client is the client side of the WebSocket framework [Tamashii](https://github.com/tamashii-io/tamashii). It is event-driven and it provides high-level API for users to communicates with WebSocket server easily. 
+Tamashii Client is the websocket client for the  [Tamashii](https://github.com/tamashii-io/tamashii) project. It is event-driven and it provides high-level API for users to communicates with WebSocket server easily.
 
 ## Installation
 
-Add the following code to your `Gemfile`
+Add the following code to your `Gemfile`:
+
+```ruby
+gem 'tamashii-client'
+```
 
 And then execute:
 ```ruby
@@ -42,19 +42,20 @@ Tamashii::Client.config do
   # Note the current version client does not infer the port from 'use_ssl'
   # So you must explictly specifiy the port to use
   port 443
-  # the log file for internel connection log 
+  # the log file for internel connection log
   # default is STDOUT
   log_file 'tamashii.log'
 end
 
 client = Tamashii::Client::Base.new
-@server_opened = false 
+@server_opened = false
 
 # callback for server opened
 # called when the WebSocket connection is readt
-client.on(:open) do  
+client.on(:open) do
   @server_opened = true
 end
+
 # callback for receving messages
 # The data received is represented in a byte array
 # You may need to 'pack' it back to Ruby string
@@ -66,19 +67,19 @@ end
 # sending loop
 # We send a request to server every second and terminates after 10 seconds
 # In the begining, the server is not opened so the sending may fail.
-count = 0 
+count = 0
 loop do
   sleep 1
   if @server_opened # can also use 'client.opened?'
     client.transmit "Hello World! #{count}"
   else
     puts "Unable to send #{count}: server not opened"
-  end 
+  end
   count += 1
   if count >= 10
     client.close
     break
-  end 
+  end
 end
 ```
 
@@ -127,13 +128,14 @@ end
 
 ### The events and callbacks
 
-These are events in the Tamashii Client. You can use `on` method to register callbacks for them. 
+These are events in the Tamashii Client. You can use `on` method to register callbacks for them.
 - `socket_opened`
-    - When the low-level io socket (`TCPSocket` or `OpenSSL::SSL::SSLSocket`) successfully connected to the server. 
-    - Receving this event does not imply the server supports WebSocket.
+    - When the low-level io socket (`TCPSocket` or `OpenSSL::SSL::SSLSocket`) successfully connected to the server.
+    - Receving this event does not imply the server supports WebSocket. Client still cannot send messages at this moment
 - `open`
     - When the WebSocket handshake is finished and the connection is opened
-    - Client can start sending data to server after receiving this event.
+    - Client can start sending messages to server after receiving this event.
+    - Fired after `socket_opened`
 - `message`
     - When the client receives the WebSocket payload from server.
     - The message payload will be pass as the argument of the callback.
@@ -142,17 +144,18 @@ These are events in the Tamashii Client. You can use `on` method to register cal
     - This event is purely informational, you do not need to implement error recovery.
     - The error object will be pass as the argument of the callback.
 - `close`
-    - When the WebSocket is closed **normally**. 
-    - Will **NOT** be fired when the connection is closed by low-level IO error such as connection reset. 
+    - When the WebSocket is closed **normally**.
+    - Will **NOT** be fired when the connection is closed by low-level IO error such as connection reset.
+    - Fired before `socket_closed`
 - `socket_closed`
-    - When the low-level socket is closed. 
+    - When the low-level socket is closed.
     - Will be fired no matter the WebSocket is closed normally or not.
 
 
 
 ### Cooperate with Tamashii Server
 
-Above example using the [wss://echo.websocket.org](wss://echo.websocket.org) to test your client. You can also use the [Tamashii](https://github.com/tamashii-io/tamashii) server to test your client. Only thing to do is to change the `host` and `port` in the configuration into the one used by your Tamashii server. 
+Above example using the [wss://echo.websocket.org](wss://echo.websocket.org) to test your client. You can also use the [Tamashii](https://github.com/tamashii-io/tamashii) server to test your client. Only thing to do is to change the `host` and `port` in the configuration into the one used by your Tamashii server.
 
 ## Development
 

data/lib/tamashii/client/base.rb

@@ -256,7 +256,8 @@ module Tamashii
         else
           @driver.parse(incoming)
         end
-      rescue
+      rescue => e
+        logger.error "Error when reading from server: #{e.message}"
         server_gone
       end
 

data/lib/tamashii/client/version.rb

@@ -1,5 +1,5 @@
 module Tamashii
   module Client
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tamashii-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - 蒼時弦也
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-08 00:00:00.000000000 Z
+date: 2017-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver