digital-transport 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1669102f928a133acaf1bfb0e6b5840aa6df31e7
+  data.tar.gz: bba0e0f506afcef5278d0883d7b93f3ac3b42a06
+SHA512:
+  metadata.gz: fe3002c1b50cb0ff33deda8c28be6f09927d6e9cc9f0396fbe25ba1de3c944d4df63dcaa9ab022c637167838b4ca52aa0fea0e056999f68b108257351a22f8a4
+  data.tar.gz: d57e9dbc17737602bfd7816a76ce65708483b307655a404d0afafa58da5940056bb5ff5834c134c1aca78a2065bc80d4f45959500b6070892fefb4cb718aaa0e

data/.gitignore

@@ -0,0 +1,13 @@
+/*.gems
+/*.idea
+/*.iml
+/.yardoc
+/Gemfile.lock
+/algorithm.iml
+/atlassian-ide-plugin.xml
+/coverage
+/debugger.rb
+/doc
+/pkg
+/rspec.xml
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+  Max: 120
+Style/IndentHash:
+  Enabled: false
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - bin/**/*
+    - doc/**/*

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 1.9.3
+  - 2.2.1
+os:
+  - linux
+  - osx
+before_install: gem install bundler -v 1.11.2

data/.yardopts

@@ -0,0 +1,12 @@
+--protected
+--no-private
+--embed-mixin ClassMethods
+--tag yard.signature:"YARD Tag Signature"
+--tag valid_values:"Valid values"
+--tag default_value:"Default value"
+--type-name-tag yard.tag:"YARD Tag"
+--type-name-tag yard.directive:"YARD Directive"
+--hide-tag yard.tag
+--hide-tag yard.directive
+--hide-tag yard.signature
+-

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at roman@lishtaba.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Roman Lishtaba
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+[![Build Status](https://travis-ci.org/rlishtaba/ruby-digital-transport.svg?branch=master)](https://travis-ci.org/rlishtaba/ruby-digital-transport)
+
+# Digital::Transport
+
+Unified interface to TCP, Serial & USB communication adapters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'digital-transport'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install digital-transport
+
+## Usage
+
+```ruby
+    require 'digital/transport'
+    
+    include Digital::Transport::Adapters
+    
+    connected = -> x {
+         x.write("Hello, World!") #=> either monad
+         x.read 2                 #=> either monad
+    }
+    
+    failed = -> x {
+         # perform exceptional situation handling
+         # x will be yielded in to function as an Exception covariant interface.
+         puts "Wasn't able to connect due to: #{x.message}. Handling failure."
+    }
+    
+    maybe = new_tcp_adapter('10.0.0.250', 6789).connect
+    
+    maybe.either(failed, connected)
+```    
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/digital-transport. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,35 @@
+require 'bundler/gem_tasks'
+require 'rake/clean'
+
+CLEAN.include(
+  'pkg',
+  'doc',
+  'coverage',
+  '*.gem'
+)
+
+desc 'Run all tests and collect code coverage'
+task :cov do
+  ENV['SIMPLECOV'] = 'features'
+  Rake::Task['default'].invoke
+end
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.fork = true
+  t.profile = :default
+end
+
+task cucumber: :features
+
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new do |t|
+  t.fail_on_error = false
+  t.verbose = true
+  t.rspec_opts = '--format RspecJunitFormatter  --out rspec.xml --tag ~wip'
+end
+
+task default: [:spec]

data/cucumber.yml

@@ -0,0 +1,24 @@
+<%
+
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format progress features" : "--format pretty #{rerun}"
+std_opts = "--format pretty features --tags ~@wip -r features --strict"
+
+
+wip_opts = "--color -r features --tags @wip:3,@wip-new-core"
+wip_opts << ",@wip-jruby:3" if defined?(JRUBY_VERSION)
+
+legacy_opts = ''
+legacy_opts << " --tags ~@wire" if defined?(JRUBY_VERSION)
+legacy_opts << " --tags ~@wip-jruby" if defined?(JRUBY_VERSION)
+
+%>
+
+default: <%= std_opts %> --tags ~@jruby features
+windows_mri: <%= std_opts %> --tags ~@jruby
+
+ruby_1_9: <%= std_opts %> --tags ~@jruby
+ruby_2_0: <%= std_opts %> --tags ~@jruby
+wip: --wip <%= wip_opts %> features
+none: --format pretty
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip --tag ~@wip-new-core

data/digital-transport.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'digital/transport/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'digital-transport'
+  spec.version = Digital::Transport::VERSION
+  spec.authors = ['Roman Lishtaba']
+  spec.email = ['roman@lishtaba.com']
+
+  spec.summary = %q{interface between multiple transport adapters}
+  spec.description = %q{Library intended to unify interface between multiple transport adapters}
+  spec.homepage = 'http://www.lishtaba.com'
+  spec.license = 'MIT'
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'cucumber', '=1.3.20'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'simplecov', '=0.9.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  spec.add_dependency 'functional-ruby'
+  spec.add_dependency 'rs_232', '~> 2.0', '>= 2.0.5' unless RUBY_PLATFORM === /java/
+end

data/lib/digital/transport.rb

@@ -0,0 +1,8 @@
+require 'digital/transport/version'
+
+module Digital
+  module Transport
+    autoload :Errors, 'digital/transport/errors'
+    autoload :Adapters, 'digital/transport/adapters'
+  end
+end

data/lib/digital/transport/adapters.rb

@@ -0,0 +1,50 @@
+require 'functional'
+
+module Digital
+  module Transport
+    # @example
+    #
+    # require 'digital/transport'
+    #
+    # include Digital::Transport::Adapters
+    #
+    # @see Proc#new
+    # connected = -> x {
+    #      x.write("Hello, World!") #=> either monad
+    #      x.read 2                 #=> either monad
+    # }
+    #
+    # @see Proc#new
+    # failed = -> x {
+    #      # perform exceptional situation handling
+    #      # x will be yielded in to function as an Exception covariant interface.
+    #      puts "Wasn't able to connect due to: #{x.message}. Handling failure."
+    # }
+    #
+    # @see Tcp#connect
+    # maybe = new_tcp_adapter('10.0.0.250', 6789).connect
+    #
+    # @see Either#either
+    # maybe.either(failed, connected)
+    #
+    module Adapters
+      require 'digital/transport/adapters/interface'
+      autoload :Tcp, 'digital/transport/adapters/tcp'
+      autoload :Serial, 'digital/transport/adapters/serial'
+
+      private_constant :Tcp, :Serial
+
+      def new_tcp_adapter(ip, port)
+        Tcp.new(ip.dup.freeze, port)
+      end
+
+      def new_serial_adapter(_port, _opts = {})
+        raise NotImplementedError
+      end
+
+      def new_usb_adapter(_port, _opts = {})
+        raise NotImplementedError
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'functional'
+
+module Digital
+  module Transport
+    module Adapters
+      module Interface
+        def open?
+          not_implemented __method__
+        end
+
+        def write(_message)
+          not_implemented __method__
+        end
+
+        def read(_bytes, _should_block = false)
+          not_implemented __method__
+        end
+
+        def close
+          not_implemented __method__
+        end
+
+        def connect(_opts = {})
+          not_implemented __method__
+        end
+
+        private
+
+        def not_implemented(message)
+          Functional::Either.left(NotImplementedError.new(message))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'rs_232'
+
+module Digital
+  module Transport
+    module Adapters
+      class Serial
+        include Digital::Transport::Errors
+        include Digital::Transport::Adapters::Interface
+        include Functional
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+require 'socket'
+require 'functional'
+
+module Digital
+  module Transport
+    module Adapters
+      class Tcp
+        include Functional
+        include Socket::Constants
+        include Digital::Transport::Errors
+        include Digital::Transport::Adapters::Interface
+
+        DEFAULTS = { timeout: 10 }.freeze
+
+        def initialize(ip, port)
+          @ip = ip
+          @port = port
+          @io = nil
+          yield self if block_given?
+        end
+
+        # @return [Either] either monad representing a value of one of two possible types
+        # 1. Exception covariant
+        # 2. Adapter interface invariant
+        #
+        # @example
+        #
+        # 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 })
+          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)
+            return connect_nonblock(
+                socket,
+                Socket.pack_sockaddr_in(@port, @ip),
+                map[: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?
+          flush
+          @io && @io.close
+          @io = nil
+          !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
+          while 0 < string.bytesize
+            begin
+              written = @io.write_nonblock(string)
+            rescue IO::WaitReadable
+              IO.select([@io])
+              retry
+            rescue IO::WaitWritable
+              IO.select(nil, [@io])
+              retry
+            end
+            string = string.byteslice(written..-1)
+          end
+          Either.right(written)
+        rescue => ex
+          Either.left(ex)
+        end
+
+        # @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
+        rescue IO::WaitReadable
+          if should_block
+            IO.select [@io]
+            retry
+          end
+          Either.right(nil)
+        rescue => ex
+          Either.left(ex)
+        end
+
+        # @return [Boolean] connection state predicate
+        def open?
+          @io && !@io.closed?
+        end
+
+        private
+
+        def connect_nonblock(io_like, endpoint, timeout)
+          io_like.connect_nonblock(endpoint)
+        rescue Errno::EINPROGRESS # connection in progress, wait a bit.
+          IO.select(nil, [io_like], nil, timeout) ? retry : nil
+        rescue Errno::EISCONN # The socket is already connected.
+          @io = io_like
+          Either.right(self)
+        rescue => ex
+          Either.left(ex)
+        end
+      end
+    end
+  end
+end

data/lib/digital/transport/errors.rb

@@ -0,0 +1,7 @@
+module Digital
+  module Transport
+    module Errors
+      NotConnected = Class.new(RuntimeError)
+    end
+  end
+end

data/lib/digital/transport/version.rb

@@ -0,0 +1,5 @@
+module Digital
+  module Transport
+    VERSION = "0.1.0"
+  end
+end

data/script/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'digital/transport'
+
+require 'irb'
+require 'irb/completion'
+
+IRB.start

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: digital-transport
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman Lishtaba
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.20
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: functional-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rs_232
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+description: Library intended to unify interface between multiple transport adapters
+email:
+- roman@lishtaba.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cucumber.yml
+- digital-transport.gemspec
+- lib/digital/transport.rb
+- lib/digital/transport/adapters.rb
+- lib/digital/transport/adapters/interface.rb
+- lib/digital/transport/adapters/serial.rb
+- lib/digital/transport/adapters/tcp.rb
+- lib/digital/transport/errors.rb
+- lib/digital/transport/version.rb
+- script/console
+homepage: http://www.lishtaba.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: interface between multiple transport adapters
+test_files: []