rubyserial 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 768694b356264952b50a41408e6aecd0e2bd0f74
-  data.tar.gz: 6e88db468ceb626d7d66c48687873a42afb994ad
+  metadata.gz: 8b3a8a0b1d1fce547d243e5444499f534277d695
+  data.tar.gz: bfccd64bec3eb198a4f61a01a6865c4325bf4df3
 SHA512:
-  metadata.gz: e8610224155564d6a8acc8f3f922c3ce5ed0cc7fbcde57ff3aca9ccda649f24b53bbd1df5e1986d4175f4489f5a8ff48dd48f47ab3df2cbeefa075d53943376b
-  data.tar.gz: 6f8974af626202bb8a7f67ae28a5e25a62487cde2b06000dfcfab18d8b9fc39949dd7fcd0793ef474365c46f5f9186894abf2151c9bbe3078c06456cfe5da92c
+  metadata.gz: 57000058b5000c5982869e718263ee36fcf0e3cf75df50616a52e1dec3950aafc404219c85e6c9cd3e9a386600e0b9084c54e1e45e425403fdf0992a963cc8b4
+  data.tar.gz: a3c2e84d223ed23794f5e0f99334407b67bcd8098add2d800f379e3cf19dd82c944a3a4bf9bff7ca6666272dee0af4450cf5c574c7b461f62af407020b4248f4

data/.gitignore

@@ -1,3 +1,4 @@
 .bundle
 /vendor
 Gemfile.lock
+socat.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+  - jruby
+  - jruby-head
+  - rbx-2.2.10
+install:
+  - sudo apt-get update && sudo apt-get install --force-yes socat
+script:
+  - bundle install
+  - bundle exec rspec

data/Gemfile

@@ -2,3 +2,4 @@
 source "http://rubygems.org"
 
 gemspec
+gem 'rspec', '~> 3.0.0'

data/README.md

@@ -1,27 +1,42 @@
 # rubyserial
 
-A simple ruby gem which allows you to read and write from a serial port.
+RubySerial is a simple RubyGem for reading from and writing to serial ports.
+
+[![Build Status](https://travis-ci.org/hybridgroup/rubyserial.svg)](https://travis-ci.org/hybridgroup/rubyserial)
+
+## Installation
+
+    $ gem install rubyserial
+
+## Usage
 
-Usage:
 ```ruby
 require 'rubyserial'
-s = Serial.new("/dev/ttyACM0", 57600)
+serialport = Serial.new '/dev/ttyACM0', 57600
 ```
 
-#####write(string) -> int
-```
-  returns the number of bytes written.
-  RubySerial::Exception on error.
-```
-######read(length) -> string
-```
- returns a string up to "length".   
- read is not guarenteed to return the entire "length" specified.
- returns "" on no data
- RubySerial::Exception on error.
-```
+## Methods
 
-######RubySerial::Exception
-```
-  returns the underlying system error code
-```
+**write(data : String) -> Int**
+
+Returns the number of bytes written.
+Emits a `RubySerial::Exception` on error.
+
+**read(length : Int) -> String**
+
+Returns a string up to `length` long. It is not guaranteed to return the entire
+length specified, and will return an empty string if no data is
+available. Emits a `RubySerial::Exception` on error.
+
+**getbyte -> Fixnum or nil**
+
+Returns an 8 bit byte or nil if no data is available. 
+Emits a `RubySerial::Exception` on error.
+
+**RubySerial::Exception**
+
+A wrapper exception type, that returns the underlying system error code.
+
+## License
+
+Apache 2.0. See `LICENSE` for more details.

data/lib/rubyserial/posix.rb

@@ -64,6 +64,20 @@ class Serial
     buff.get_bytes(0, i)
   end
 
+  def getbyte
+    buff = FFI::MemoryPointer.new :char, 1
+    i = RubySerial::Posix.read(@fd, buff, 1)
+    if i == -1
+      raise RubySerial::Exception, RubySerial::Posix::ERROR_CODES[FFI.errno]
+    end
+
+    if i == 0
+      nil
+    else
+      buff.read_string.unpack('C').first
+    end
+  end
+
   private
 
   def build_config(baude_rate, data_bits)

data/lib/rubyserial/version.rb

@@ -1,5 +1,5 @@
 module RubySerial
   unless const_defined?('VERSION')
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/rubyserial/windows.rb

@@ -50,6 +50,21 @@ class Serial
     buff.get_bytes(0, count.read_string.unpack('H4').join().to_i(16))
   end
 
+  def getbyte
+    buff = FFI::MemoryPointer.new :char, 1
+    count = FFI::MemoryPointer.new :uint32, 1
+    err = RubySerial::Win32.ReadFile(@fd, buff, size, count, nil)
+    if err == 0
+      raise RubySerial::Exception, RubySerial::Win32::ERROR_CODES[FFI.errno]
+    end
+
+    if count.read_string.unpack('H4').join().to_i(16) == 0
+      nil
+    else
+      buff.read_string.unpack('C').first
+    end
+  end
+
   def write(data)
     buff = FFI::MemoryPointer.from_string(data.to_s)
     count = FFI::MemoryPointer.new :uint32, 1

data/rubyserial.gemspec

@@ -4,8 +4,8 @@ require "rubyserial/version"
 Gem::Specification.new do |s|
   s.name        = "rubyserial"
   s.version     = RubySerial::VERSION
-  s.summary     = "ffi ruby serialport gem"
-  s.description = "ffi ruby serialport gem"
+  s.summary     = "FFI Ruby library for RS-232 serial port communication"
+  s.description = "FFI Ruby library for RS-232 serial port communication"
   s.homepage    = "https://github.com/hybridgroup/rubyserial"
   s.authors     = ["Adrian Zankich", "Theron Boerner", "Javier Cervantes"]
   s.platform    = Gem::Platform::RUBY

data/spec/basic_rw_spec.rb

@@ -0,0 +1,35 @@
+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])
+    @sp = Serial.new(@ptys[0][0])
+    @sp2.write('hello')
+
+		# small delay so it can write to the other port.
+    sleep 0.1
+  end
+
+  it "should read and write" do
+    check = @sp.read(5)
+    expect(check).to eql('hello')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+# 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, make a
+# separate helper file that requires this one and then use it only in the specs
+# 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|
+# 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
+
+  # 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
+
+  # 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|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  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|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyserial
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Adrian Zankich
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -26,13 +26,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.9.3
-description: ffi ruby serialport gem
+description: FFI Ruby library for RS-232 serial port communication
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -45,6 +47,8 @@ files:
 - lib/rubyserial/windows.rb
 - lib/rubyserial/windows_constants.rb
 - rubyserial.gemspec
+- spec/basic_rw_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/hybridgroup/rubyserial
 licenses:
 - Apache 2.0
@@ -68,5 +72,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: ffi ruby serialport gem
+summary: FFI Ruby library for RS-232 serial port communication
 test_files: []