em-rubyserial 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9ff7490d9899a710525d8f06be80350b3ddde3c
+  data.tar.gz: 6c811ac5335b4540df4b131249239ca52a3eaa17
+SHA512:
+  metadata.gz: 8e5c06b96a41c1b67677f451a162f23b69b186c72ba185c8d49a813347b5a166bdd2f81e3902e8ba14977fe47c38db2c16980c6208f02c62efbc1679e753ce5f
+  data.tar.gz: c254e875c319f3a72e705b46438ac60b5a467092fc2fe3249b9e22b8649522a8c8a6676161ad1f44036642e6d8c5596818b1397d04bee681a550174a344da909

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.rvmrc
+*.swp
+socat.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-2
+  - jruby-head
+  - ree
+install:
+  - sudo apt-get update && sudo apt-get install --force-yes socat
+script:
+  - bundle install
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in em-rubyserial.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jesse
+
+MIT License
+
+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,50 @@
+# Em::Rubyserial
+
+EventMachine serial port functionality that should work on all* ruby flavors (including MRI, jruby; and various operating systems including linux, windows, and apple)
+
+(* for some values of all)
+
+[![Build Status](https://travis-ci.org/jcantara/em-rubyserial.svg?branch=master)](https://travis-ci.org/jcantara/em-rubyserial)
+
+Uses the following gem for serial port connectivity:
+https://github.com/hybridgroup/rubyserial
+
+Essentially copies this gem:
+https://github.com/railsbob/em-serialport
+
+but replaces the serialport gem with the rubyserial gem, and does some file descriptor handling.
+
+There is currently as of this writing no license on the em-serialport gem, so hopefully this amount of attribution is satisfactory. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'em-rubyserial'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install em-rubyserial
+
+## Usage
+
+    EM.run do
+      serial = EventMachine.open_serial('/dev/ttyS2', 9600, 8)
+      serial.send_data "foo"
+
+      serial.on_data do |data|
+        puts data
+      end
+    end
+
+## Contributing
+
+1. Fork it ( https://github.com/jcantara/em-rubyserial/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/em-rubyserial.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'em-rubyserial/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "em-rubyserial"
+  spec.version       = Em::Rubyserial::VERSION
+  spec.authors       = ["Jesse Cantara"]
+  spec.email         = ["jcantara@gmail.com"]
+  spec.summary       = %q{EventMachine serial port}
+  spec.description   = %q{EventMachine functionality for rubyserial gem that functions under a wide assortment of rubies}
+  spec.homepage      = "https://github.com/jcantara/em-rubyserial"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rubyserial"
+  spec.add_runtime_dependency "eventmachine"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3"
+end

data/lib/em-rubyserial/version.rb

@@ -0,0 +1,5 @@
+module Em
+  module Rubyserial
+    VERSION = "0.0.1"
+  end
+end

data/lib/em-rubyserial.rb

@@ -0,0 +1,83 @@
+require "em-rubyserial/version"
+
+require 'em/pure_ruby'
+require 'rubyserial'
+
+module EventMachine
+  class Connection
+    def on_data(&blk)
+      @on_data = blk
+    end
+
+    def trigger_on_data(data)
+      @on_data.call(data) if @on_data
+    end
+
+    def receive_data data
+      trigger_on_data(data)
+    end
+
+    def associate_callback_target(sig)
+      return(nil)
+    end
+  end
+end
+
+module EventMachine
+  class << self
+    def connect_serial(dev, baud, databits)
+      SerialPort.open(dev, baud, databits).uuid
+    end
+
+    def open_serial(dev, baud, databits, handler=nil)
+      klass = if(handler and handler.is_a?(Class))
+        handler
+      else
+        Class.new(Connection) {handler and include handler}
+      end
+      uuid          = connect_serial(dev, baud, databits)
+      connection    = klass.new uuid
+      @conns[uuid]  = connection
+      block_given? and yield connection
+      connection
+    end
+  end
+
+  class SerialPort < StreamObject
+    def self.open(dev, baud, databits)
+      serialport = ::Serial.new(dev, baud, databits)
+      if RUBY_PLATFORM == "java"
+        io = IO.new(FFI::IO.for_fd(serialport.instance_variable_get(:@fd)).to_i, 'r+')
+      else
+        io = IO.new(serialport.instance_variable_get(:@fd), 'r+')
+      end
+      io.instance_variable_set(:@serialport, serialport) # hang on to our serial port so it doesn't get closed and close our file descriptor
+      self.new(io)
+    end
+
+    def initialize(io)
+      super
+    end
+
+    def eventable_read
+      @last_activity = Reactor.instance.current_loop_time
+      begin
+        if io.respond_to?(:read_nonblock)
+          10.times {
+            data = io.read_nonblock(4096)
+            EventMachine::event_callback uuid, ConnectionData, data
+          }
+        else
+          data = io.sysread(4096)
+          EventMachine::event_callback uuid, ConnectionData, data
+        end
+      rescue Errno::EAGAIN, Errno::EWOULDBLOCK, EOFError
+        # no-op
+      rescue Errno::ECONNRESET, Errno::ECONNREFUSED
+        @close_scheduled = true
+        EventMachine::event_callback uuid, ConnectionUnbound, nil
+      end
+    end
+
+  end
+end

data/spec/basic_rw_spec.rb

@@ -0,0 +1,40 @@
+describe "basic reading and writing" do
+  before do
+    File.delete('socat.log') if File.file?('socat.log')
+
+    Thread.new do
+      system('socat -lf socat.log -d -d pty,raw,echo=0 pty,raw,echo=0')
+    end
+
+    @ptys = nil
+
+    loop do
+      if File.file? 'socat.log'
+        @file = File.open('socat.log', "r")
+        @fileread = @file.read
+        unless @fileread.count("\n") < 3
+          @ptys = @fileread.scan(/PTY is (.*)/)
+          break
+        end
+      end
+    end
+
+    require 'rubyserial'
+    @sp2 = Serial.new(@ptys[1][0])
+    @sp2.write('hello')
+
+                # small delay so it can write to the other port.
+    sleep 5
+  end
+
+  it "should read and write" do
+    EM.run do
+      serial = EventMachine.open_serial(@ptys[0][0], 9600, 8)
+
+      serial.on_data do |data|
+        expect(data).to eq "hello\x00"
+        EM.stop_event_loop
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+require 'bundler/setup'
+
+require 'em-rubyserial'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: em-rubyserial
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jesse Cantara
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyserial
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  prerelease: false
+  type: :development
+description: EventMachine functionality for rubyserial gem that functions under a wide assortment of rubies
+email:
+- jcantara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- em-rubyserial.gemspec
+- lib/em-rubyserial.rb
+- lib/em-rubyserial/version.rb
+- spec/basic_rw_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jcantara/em-rubyserial
+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.1.9
+signing_key:
+specification_version: 4
+summary: EventMachine serial port
+test_files:
+- spec/basic_rw_spec.rb
+- spec/spec_helper.rb