digital-transport 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1669102f928a133acaf1bfb0e6b5840aa6df31e7
-  data.tar.gz: bba0e0f506afcef5278d0883d7b93f3ac3b42a06
+  metadata.gz: ebc25beae1ce280e5b8a3c653a92a35cf3518485
+  data.tar.gz: 479c4e3741cfbedb5fa95c851aa34d90d070cb77
 SHA512:
-  metadata.gz: fe3002c1b50cb0ff33deda8c28be6f09927d6e9cc9f0396fbe25ba1de3c944d4df63dcaa9ab022c637167838b4ca52aa0fea0e056999f68b108257351a22f8a4
-  data.tar.gz: d57e9dbc17737602bfd7816a76ce65708483b307655a404d0afafa58da5940056bb5ff5834c134c1aca78a2065bc80d4f45959500b6070892fefb4cb718aaa0e
+  metadata.gz: 6014ebe51f458190fc65b3523810b21e13bf9a5bbe3cf2aec18851b86abf17872ff72b2c42b1052468de9926cf8801c46136d64613384d205e54f522bd4d785a
+  data.tar.gz: d962fea7aa632121b9f17e33274d5f349f2f6379bc2f3d41959fdfc8bbb6f6c4c45f01caf9f3ec8b74e4acfca905d5edb426215261fe5dcc56f54e60b94bda49

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
   - 2.1.2
-  - 1.9.3
   - 2.2.1
+  - head
 os:
   - linux
   - osx

data/lib/digital/transport/adapters.rb

@@ -34,12 +34,12 @@ module Digital
 
       private_constant :Tcp, :Serial
 
-      def new_tcp_adapter(ip, port)
-        Tcp.new(ip.dup.freeze, port)
+      def new_tcp_adapter(ip, port, opts = {})
+        Tcp.new(ip.dup.freeze, port, opts.dup.freeze)
       end
 
-      def new_serial_adapter(_port, _opts = {})
-        raise NotImplementedError
+      def new_serial_adapter(port, opts = {})
+        Serial.new(port, opts.dup.freeze)
       end
 
       def new_usb_adapter(_port, _opts = {})

data/lib/digital/transport/adapters/interface.rb

@@ -20,7 +20,7 @@ module Digital
           not_implemented __method__
         end
 
-        def connect(_opts = {})
+        def connect
           not_implemented __method__
         end
 

data/lib/digital/transport/adapters/serial.rb

@@ -6,8 +6,116 @@ module Digital
       class Serial
         include Digital::Transport::Errors
         include Digital::Transport::Adapters::Interface
+        include CommPort
         include Functional
 
+        DEFAULTS = {
+            timeout: 10,
+            baud_rate: CommPort::BAUD_115200,
+            data_bits: CommPort::DATA_BITS_8,
+            parity: CommPort::PAR_NONE,
+            stop_bits: CommPort::STOP_BITS_1,
+            flow_control: CommPort::FLOW_OFF
+        }.freeze
+
+        def initialize(port, opt = {})
+          @port = port.freeze
+          @opts = DEFAULTS.merge(opt.dup).freeze
+          @io = nil
+        end
+
+        # @return [Either] monad representing a value of one of two possible types
+        # 1. Exception covariant
+        # 2. Adapter interface invariant
+        #
+        # @see Adapters#new_serial_adapter
+        #
+        def connect
+          io = Rs232.new(@port)
+          io.connecting_timeout = @opts[:timeout].to_i if p.respond_to?(:connecting_timeout)
+          io.open
+          io.baud_rate = @opts[:baud_rate].to_i
+          io.data_bits = @opts[:data_bits].to_i
+          io.parity = @opts[:parity].to_i
+          io.stop_bits = @opts[:stop_bits].to_i
+          io.flow_control = @opts[:flow_control].to_i
+          @io = io
+          Either.right(self)
+        rescue Exception => ex
+          Either.left(ex)
+        end
+
+        def write(bytes)
+          raise NotConnected unless open?
+          Either.right(@io.write(bytes))
+        rescue => ex
+          Either.left(ex)
+        end
+
+        def close
+          return !open? unless open?
+          @io && @io.close
+          @io = nil
+          !open?
+        end
+
+        def flush
+          @io && @io.flush
+        end
+
+        def open?
+          @io && !@io.closed?
+        end
+
+        def read(count, blocking = false)
+          raise NotConnected unless open?
+          array = []
+
+          bytes_count = (count == -1) ? @io.available? : count
+
+          if blocking
+            bytes = read_io_until(count, count)
+            array.push bytes if bytes
+          else
+            bytes_count.times do
+              byte = @io.read(1)
+              array.push byte if byte
+            end
+          end
+          Either.right(array.empty? ? nil : array.join)
+        rescue => ex
+          Either.left(ex)
+        end
+
+        private
+
+        # @api private
+        #
+        # simulate blocking function
+        #
+        # @param [Fixnum] count
+        # @param [Fixnum] up_to
+        #
+        # no direct ruby usage
+        #
+        def block_io_until(count, up_to)
+          up_to -= 1 while @io.available? < count && up_to > 0
+          up_to > 0
+        end
+
+        # @api private
+        #
+        # simulate blocking function
+        #
+        # @param [Fixnum] count
+        # @param [Fixnum] up_to
+        #
+        # no direct ruby usage
+        #
+        def read_io_until(count, up_to)
+          sleep 0.001 until block_io_until(count, up_to)
+          read(count)
+        end
       end
     end
   end

data/lib/digital/transport/adapters/tcp.rb

@@ -10,47 +10,32 @@ module Digital
         include Digital::Transport::Errors
         include Digital::Transport::Adapters::Interface
 
-        DEFAULTS = { timeout: 10 }.freeze
+        DEFAULTS = { timeout: 10, tcp_no_delay: 1 }.freeze
 
-        def initialize(ip, port)
-          @ip = ip
+        def initialize(ip, port, opts = {})
+          @ip = ip.freeze
+          @opts = DEFAULTS.merge(opts.dup).freeze
           @port = port
           @io = nil
-          yield self if block_given?
         end
 
-        # @return [Either] either monad representing a value of one of two possible types
+        # @return [Either] monad representing a value of one of two possible types
         # 1. Exception covariant
         # 2. Adapter interface invariant
         #
-        # @example
+        # @see Adapters#new_tcp_adapter
         #
-        # include Digital::Transport::Adapters
-        #
-        # on_success = -> x {
-        #      puts "connection open? -> #{x.open?}"
-        #      x.write("Hello, World!") =>
-        #      x.read 2 #=>
-        # }
-        # on_failure = -> x { puts "Wasn't able to connect due to: #{x.message}" }
-        #
-        # maybe = new_tcp_adapter('10.0.0.250', 12000).connect
-        # maybe.either(on_failure, on_success)
-        #
-        def connect(opt = { timeout: 10, tcp_no_delay: 1 })
+        def connect
           return open? if open?
-          map = opt.dup.freeze
           Socket.new(AF_INET, SOCK_STREAM, 0).tap do |socket|
-            socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, map[:tcp_nodelay].to_i)
+            socket.setsockopt(IPPROTO_TCP, TCP_NODELAY, (@opts[:tcp_nodelay] || DEFAULTS[:tcp_no_delay]).to_i)
             return connect_nonblock(
                 socket,
                 Socket.pack_sockaddr_in(@port, @ip),
-                map[:timeout].to_i.nonzero? || DEFAULTS[:timeout])
+                @opts[:timeout].to_i.nonzero? || DEFAULTS[:timeout])
           end
         end
 
-        # @raise [Errno::ECONNRESET] if connection reset by peer
-        #
         # @return [Boolean] representing operation state
         def close
           return !open? unless open?
@@ -60,14 +45,11 @@ module Digital
           !open?
         end
 
-        # @raise [Errno::ECONNRESET] if connection reset by peer
-        # @return [Ethernet] it self
         def flush
           @io && @io.flush
         end
 
         # @param [String] string
-        # @return [Fixnum] representing amount of bytes written
         def write(string)
           raise NotConnected unless open?
           written = 0
@@ -90,10 +72,9 @@ module Digital
 
         # @param [Fixnum] count how many bytes to read
         # @param [Boolean] should_block which will simulate blocking function
-        # @return [String, nil] the String which was received or nil otherwise
         def read(count, should_block = false)
           raise NotConnected unless open?
-          Either.right @io.read_nonblock(count).tap
+          Either.right @io.read_nonblock(count)
         rescue IO::WaitReadable
           if should_block
             IO.select [@io]
@@ -111,6 +92,7 @@ module Digital
 
         private
 
+        # @api private
         def connect_nonblock(io_like, endpoint, timeout)
           io_like.connect_nonblock(endpoint)
         rescue Errno::EINPROGRESS # connection in progress, wait a bit.

data/lib/digital/transport/version.rb

@@ -1,5 +1,5 @@
 module Digital
   module Transport
-    VERSION = "0.1.0"
+    VERSION = "0.2.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: digital-transport
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Roman Lishtaba