ionian 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0202d93f529470e60e92b50e01f597ccab404c4
-  data.tar.gz: 897b8ece8bff0033b42ef8c88644fb1b60e84ba2
+  metadata.gz: a88970a3a13a5af34bc6e86e58aadd8bc9e629be
+  data.tar.gz: e208410ce513ad567203e65175116709c7649878
 SHA512:
-  metadata.gz: 09e1bd456fc049d6ef46df54f4e24712c53a31996a596ecf3f53d65653513099c867db157e463f1cb1e2ef8477fdc8c6ea29f041727133809013e68c92f6fbd8
-  data.tar.gz: d0ae317598bf5c1f74759fc0cde0f5cd61b11faeaacf94390311347c759fd05044540b04a4a506191c36cbe13c9183bc19c6b8bfdf6de66062c55a2843102768
+  metadata.gz: 8a5886de7263e48d699a212e180d8d5199116e46a2c2ff70f64b0aea5b150ad11200ae2c09e1be7e357828a5d6993d4ad4e9bd8df1ac5bd4c8a6f02c13dace7d
+  data.tar.gz: 6991f614d839b36c2573ce77262f941bdc55c42c6cbb5422b2bd75b80e7b26d36f17e2673a6614fa8c7487d61512b2610555d30e0b1f08f4397472420f3594c7

data/README.md

@@ -0,0 +1,63 @@
+# Ionian
+
+[![Gem Version](https://badge.fury.io/rb/ionian.png)](http://badge.fury.io/rb/ionian)
+
+
+A Ruby library to simplify interaction with IO streams. This includes network sockets, file sockets, and serial streams like the console and RS232. Features regular expression matching and notification of received data.
+
+
+## Supported Ruby Versions
+
+- MRI >= 2.0.0
+
+
+## Installation
+
+	gem install ionian
+
+
+## Code Examples
+
+### Creating A Socket
+
+``` ruby
+socket = Ionian::Socket.new host: '127.0.0.1', port: 23
+```
+
+### Sending And Receiving Data
+
+``` ruby
+socket = Ionian::Socket.new host: 'google.com', port: 80
+socket.write "GET / HTTP/1.1\r\n\r\n"
+socket.read_match { |match| p match; puts '' }
+```
+
+### Match Expressions And Named Captures
+
+``` ruby
+# A simple IRC client.
+
+socket = Ionian::Socket.new \
+  host: 'chat.freenode.net',
+  port: 6667,
+  # Break up the matches into named captures so it's easier
+  # to sort through the server's responses.
+  expression: /:(?<server>.*?)\s*:(?<msg>.*?)[\r\n]+/
+
+# Log on to IRC and send a message.
+socket.write "NICK ionian-demo\r\nUSER ionian-demo ionian-demo chat.freenode.net :ionian-demo"
+socket.write "PROTOCL NAMESX\r\n"
+socket.write "JOIN #ionian-demo\r\n"
+socket.write "PRIVMSG #ionian-demo :this is a test\r\n"
+
+
+loop do
+  socket.read_match do |match|
+  	# Print the body of the server's responses.
+    puts match.msg
+    
+    # Exit when the server has caught up.
+    exit if match.msg.include? 'End of /NAMES list.'
+  end
+end
+```