easy_sockets 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cda3ce2892a6052d57ed242708f762febe57481
-  data.tar.gz: fa52646d15d1aede1b25c6a612aab869c767d8da
+  metadata.gz: f80b06dbbb87b666cb3b6664d405c95e1a1fc27f
+  data.tar.gz: 4494590df3d194153ccbe2ecdd530d49fac19df7
 SHA512:
-  metadata.gz: 4160e8c1d10c54a8998c4d071de8b9f91215c157925814a36f5d097cf0804db2a1e76d58a5c6bb75117ed747d9735d2b4655873438686160a312b17684745e27
-  data.tar.gz: 3324c1006ccc13d583dce4d1aa6d037a94e7e8cacadc0d58aaf411ce8a73ceb88b0f642aadb25d1abaa803c9cafd5ced03b71a2d3aa1a97b41294c1ab59b70ac
+  metadata.gz: 01bc5222921c85853927282f57c97de241dbb4ff8d7d9c25627974b3f55422030cb88c9ed9d377c3875dca2fbf08aabb7de2ead1a36339e63f46fccbc6961ac9
+  data.tar.gz: 19fe1923e0063a4f36faa055ceada93a089d322f2a3dc0aac06cd5f344aa03dc28fac7b91f067acbaae331833ae3484aa0b4c0f8ade9bf3cbb9850e5f3d2d67d

data/{CHANGELOG.rb → CHANGELOG.md}

@@ -1,4 +1,6 @@
+## 1.0.0 (2016-07-08)
+Features:
+    - Adding support to udp and unix sockets.
 ## 0.1.0 (2016-06-28)
 Features:
     - EasySockets::TcpSocket now reads and writes in a non blocking way.
-    - Adding support to unix sockets.

data/README.md

@@ -20,7 +20,7 @@
 
 ## Description
 
-Over and over I see developers struggling to implement basic sockets with featues available on ruby socket stdlib.
+Over and over I see developers struggling to implement basic sockets with features available on ruby socket stdlib.
 
 easy_sockets, takes care of basic details that usually are overlooked by developers when implementing TCP/Unix sockets from scratch.
 
@@ -191,7 +191,7 @@ Press `Ctrl+c` on the client and server terminal windows to terminate both.
 
 Open up a terminal window and type the following to start a Unix server:
 ```bash
-nc -Ul /tmp/test_socket
+nc -Ucl /tmp/test_socket
 ```
 
 On another terminal window, run the following [code](https://github.com/marcosortiz/easy_sockets/blob/master/examples/unix_socket.rb) to start the client:
@@ -263,6 +263,82 @@ Please write the message you want to send and hit ENTER, or type Ctrl+c to quit:
 
 Press `Ctrl+c` on the client and server terminal windows to terminate both. Also, type `rm -rf /tmp/test_socket` to remove the socket file.
 
+### UDP Sockets
+
+Open up a terminal window and type the following to start a TCP server:
+```bash
+nc -ukcl 2500
+```
+
+On another terminal window, run the following [code](https://github.com/marcosortiz/easy_sockets/blob/master/examples/udp_socket.rb) to start the client:
+```ruby
+require 'easy_sockets'
+
+host = ARGV[0] || '127.0.0.1'
+
+port = ARGV[1].to_i
+port = 2500 if port <= 0
+
+opts = {
+    host:      host,
+    port:      port,
+    timeout:   300,
+    separator: "\r\n",
+    logger: Logger.new(STDOUT),
+}
+s = EasySockets::UdpSocket.new(opts)
+[:INT, :QUIT, :TERM].each do |signal|
+    Signal.trap(signal) do
+        exit
+    end
+end
+
+loop do
+    puts "Please write the message you want to send and hit ENTER, or type Ctrl+c to quit:"
+    msg = gets.chomp
+    s.send_msg(msg)
+end
+```
+
+Then typing `sample_request` in the client terminal, you should see:
+```
+$ bundle exec ruby examples/udp_socket.rb 
+Please write the message you want to send and hit ENTER, or type Ctrl+c to quit:
+sample_request
+D, [2016-07-08T10:45:17.935787 #83697] DEBUG -- : Successfully connected to udp://127.0.0.1:2500.
+D, [2016-07-08T10:45:17.935893 #83697] DEBUG -- : Sending "sample_request\r\n"
+
+```
+
+And the server terminal window should display:
+```
+$ nc -ukcl 2500
+sample_request
+
+```
+
+Then type `sample_response` on the server terminal window, and you should see:
+```
+$ nc -ukcl 2500
+sample_request
+sample_response
+
+```
+
+And the client window should show:
+```
+$ bundle exec ruby examples/udp_socket.rb 
+Please write the message you want to send and hit ENTER, or type Ctrl+c to quit:
+sample_request
+D, [2016-07-08T10:45:17.935787 #83697] DEBUG -- : Successfully connected to udp://127.0.0.1:2500.
+D, [2016-07-08T10:45:17.935893 #83697] DEBUG -- : Sending "sample_request\r\n"
+D, [2016-07-08T10:45:22.086731 #83697] DEBUG -- : Got "sample_response\r\n"
+Please write the message you want to send and hit ENTER, or type Ctrl+c to quit:
+
+```
+
+Press `Ctrl+c` on the client and server terminal windows to terminate both.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/examples/tcp_socket.rb

@@ -12,7 +12,7 @@ opts = {
     separator: "\r\n",
     logger: Logger.new(STDOUT),
 }
-s = EasySockets::UnixSocket.new(opts)
+s = EasySockets::TcpSocket.new(opts)
 [:INT, :QUIT, :TERM].each do |signal|
     Signal.trap(signal) do
         exit

data/examples/udp_socket.rb

@@ -0,0 +1,26 @@
+require 'easy_sockets'
+
+host = ARGV[0] || '127.0.0.1'
+
+port = ARGV[1].to_i
+port = 2500 if port <= 0
+
+opts = {
+    host:      host,
+    port:      port,
+    timeout:   300,
+    separator: "\r\n",
+    logger: Logger.new(STDOUT),
+}
+s = EasySockets::UdpSocket.new(opts)
+[:INT, :QUIT, :TERM].each do |signal|
+    Signal.trap(signal) do
+        exit
+    end
+end
+
+loop do
+    puts "Please write the message you want to send and hit ENTER, or type Ctrl+c to quit:"
+    msg = gets.chomp
+    s.send_msg(msg)
+end

data/lib/easy_sockets.rb

@@ -1,5 +1,6 @@
 require "easy_sockets/version"
 require "easy_sockets/tcp/tcp_socket"
+require "easy_sockets/udp/udp_socket"
 require "easy_sockets/unix/unix_socket"
 
 module EasySockets

data/lib/easy_sockets/tcp/tcp_socket.rb

@@ -16,7 +16,7 @@ module EasySockets
         def initialize(opts={})
             super(opts)
             
-            @port = opts[:port].to_i || '127.0.0.1'
+            @port = opts[:port].to_i
             @port = DEFAULT_PORT if @port <= 0
             @host = opts[:host] || DEFAULT_HOST
         end

data/lib/easy_sockets/udp/udp_server.rb

@@ -0,0 +1,83 @@
+require 'logger'
+require 'socket'
+require 'easy_sockets/constants'
+require 'easy_sockets/utils/server_utils'
+
+module EasySockets
+    #
+    # This class was created for testing purposes only. It should not be used
+    # in production.
+    #
+    class UdpServer
+        include EasySockets::ServerUtils
+
+        attr_reader :connections
+        
+        DEFAULT_TIMEOUT = 0.5 # seconds
+        
+        def initialize(opts={})
+            set_opts(opts)
+            @started = false
+            @stop_requested = false
+            @connections = []
+            register_shutdown_signals
+        end
+        
+        def start
+            return if @started
+            @started = true
+            @socket = UDPSocket.new
+            @socket.bind('127.0.0.1', @port)
+            @logger.info "Listening on udp://127.0.0.1:#{@port}"
+            loop do
+                shutdown if @stop_requested
+                # connection = accept_non_block(@socket)
+                # @connections << connection
+                # handle(connection)
+                handle(@socket)
+            end
+        end
+        
+        def stop
+            return unless @started
+            @stop_requested = true
+        end
+
+        private
+        
+        def set_opts(opts)
+            @port = opts[:port].to_i
+            @port = DEFAULT_PORT if @port <= 0
+            
+            @logger = opts[:logger] || Logger.new(STDOUT)
+            
+            @separator = opts[:separator]
+            @separator ||= EasySockets::CRLF
+            
+            @sleep_time = opts[:sleep_time].to_f
+            @sleep_time = 0.0001 if @sleep_time <= 0.0
+            
+            @timeout = opts[:timeout].to_f
+            @timeout = DEFAULT_TIMEOUT if @timeout <= 0.0
+        end
+        
+        def handle(connection)
+            loop do
+                shutdown if @stop_requested
+                begin
+                    msg, addr = udp_read_non_block(connection)
+                    sleep @sleep_time
+                    unless msg.nil?
+                        connection.send(msg, 0, addr[3], addr[1])
+                        @logger.info "Sent: #{msg.inspect}"
+                    end
+                rescue EOFError, Errno::ECONNRESET
+                    connection.close
+                    @logger.info 'Client disconnected.'
+                    break
+                end
+            end
+        end
+        
+    end
+end

data/lib/easy_sockets/udp/udp_socket.rb

@@ -0,0 +1,35 @@
+require 'easy_sockets/basic_socket'
+
+module EasySockets
+    #
+    # @author Marcos Ortiz
+    # Subclass of {EasySockets::BasicSocket} that implement a UDP socket.
+    #
+    class UdpSocket < EasySockets::BasicSocket
+        
+        #
+        # @param [Hash] opts the options to create a socket with.
+        # @option opts [Integer] :port (2000) The udp port the server is running on.
+        # @option opts [String] :host ('127.0.0.1') The hostname or IP address the server is running on.
+        #
+        # It also accepts all options that {EasySockets::BasicSocket#initialize} accepts
+        def initialize(opts={})
+            super(opts)
+            
+            @port = opts[:port].to_i
+            @port = DEFAULT_PORT if @port <= 0
+            @host = opts[:host] || DEFAULT_HOST
+        end
+        
+        private
+        
+        def on_connect
+            @socket = UDPSocket.new
+            @socket.connect(@host, @port)
+            log(:debug, "Successfully connected to udp://#{@host}:#{@port}.")
+        rescue Exception => e
+            @socket.close if @socket && !@socket.closed?
+            raise e
+        end
+    end
+end

data/lib/easy_sockets/utils/server_utils.rb

@@ -37,6 +37,25 @@ module EasySockets
             msg
         end
         
+        def udp_read_non_block(connection)
+            total_msg = ''
+            addr = nil
+            begin
+                msg, addr = connection.recvfrom_nonblock(CHUNK_SIZE)
+                total_msg << msg
+                while !total_msg.end_with?(@separator) do
+                    msg, addr = connection.recvfrom_nonblock(EasySockets::CHUNK_SIZE)
+                    total_msg << msg
+                end
+                @logger.info "Got: #{total_msg.inspect}" unless total_msg.nil? || total_msg.empty?
+                total_msg.empty? ? nil : [total_msg, addr]
+            rescue IO::WaitReadable
+                if IO.select([connection], nil, nil, @timeout)
+                    retry
+                end
+            end
+        end
+        
         def write_non_block(connection, msg)
             return 0 unless msg && msg.is_a?(String)
             total_bytes = 0

data/lib/easy_sockets/version.rb

@@ -1,3 +1,3 @@
 module EasySockets
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_sockets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Marcos Ortiz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-30 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
-- CHANGELOG.rb
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -75,12 +75,15 @@ files:
 - bin/setup
 - easy_sockets.gemspec
 - examples/tcp_socket.rb
+- examples/udp_socket.rb
 - examples/unix_socket.rb
 - lib/easy_sockets.rb
 - lib/easy_sockets/basic_socket.rb
 - lib/easy_sockets/constants.rb
 - lib/easy_sockets/tcp/tcp_server.rb
 - lib/easy_sockets/tcp/tcp_socket.rb
+- lib/easy_sockets/udp/udp_server.rb
+- lib/easy_sockets/udp/udp_socket.rb
 - lib/easy_sockets/unix/unix_server.rb
 - lib/easy_sockets/unix/unix_socket.rb
 - lib/easy_sockets/utils.rb
@@ -111,3 +114,4 @@ signing_key:
 specification_version: 4
 summary: Wrapper around ruby socket stdlib to make developer's life easier'.
 test_files: []
+has_rdoc: