xmodem 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e62cc5ccbbce783916e98a6d66ec6b54f7fbb6b0
-  data.tar.gz: 769b8532fbcba742e1b9004c532cfda1092db3f1
+  metadata.gz: 6f7f3521ab6749bb39dd3e4eeea3461415202291
+  data.tar.gz: 584c4d042ecc4e33579920c2e5aad0153bed3eb8
 SHA512:
-  metadata.gz: 7cc854f7451a5e03e4a976991d746ececcd0ffb93f2727bcda8bc358ab2fbefc9d8ca7c66e1d914a91eeed21678a3003cf7f590ebebf4c93078b99d39b625874
-  data.tar.gz: 8c692ded57abbbbd37f56c3ec53d7b486e4d73561eb66dd4dae5d8b0774142ee66faf007894fe9cee8d8d37216ca71964140a7f22354358e490cd48fce47d192
+  metadata.gz: 078560c1b718c310acbd13e148cb783d4f4868ed7db0aa6da38b5ed17827732278a4288bce4f856af0b843a8a8d9e905a2b273252ad365ce9998960860957f91
+  data.tar.gz: 03cc944a4f0876bbf41dd88776e09aa14e16fd856b4de4f2d6fc03a990e6a26503c2b9d0ba690a9d6284226014450ff9b17fa3e24ff00c075adec8e565638456

data/README.md

@@ -1,5 +1,10 @@
 ## Synopsis
 
+[![Build Status](https://travis-ci.org/exsilium/xmodem.svg?branch=master)](https://travis-ci.org/exsilium/xmodem)
+[![Coverage Status](https://coveralls.io/repos/exsilium/xmodem/badge.svg)](https://coveralls.io/r/exsilium/xmodem)
+[![Dependency Status](https://gemnasium.com/exsilium/xmodem.svg)](https://gemnasium.com/exsilium/xmodem)
+[![Code Climate](https://codeclimate.com/github/exsilium/xmodem/badges/gpa.svg)](https://codeclimate.com/github/exsilium/xmodem)
+
 A pure XMODEM implementation in Ruby for sender and receiver. Compatible with Ruby 1.9.3+
 
 ## Code Example

data/lib/xmodem.rb

@@ -3,26 +3,19 @@
 #
 # License::   Mozilla Public License 1.1
 #
-# Doesn't seem to work for me using Ruby 2.0 - BORKEN unless fixed
-#
-# Public interface changes:
-# - ModemProtocols renamed to XMODEM
-# - xmodem_tx renamed to send
-# - xmodem_rx renamed to receive
-# - Logger outputs reflect the actors sender/receiver
 
 require 'log4r'
 include Log4r
 
 module XMODEM
 
-  XMODEM_BLOCK_SIZE = 128  #how many bytes (ecluding header & checksum) in each block?
   XMODEM_MAX_TIMEOUTS = 5  #how many timeouts in a row before the sender gives up?
   XMODEM_MAX_ERRORS = 10   #how many errors on a single block before the receiver gives up?
-
   XMODEM_CRC_ATTEMPTS = 3  #how many times should receiver attempt to use CRC?
   LOG_NAME='XModem'
-  @timeout_seconds = 5.0  #default timeout period
+
+  @timeout_seconds = 5.0   #default timeout period
+  @block_size = 128        #how many bytes (excluding header & checksum) in each block?
 
   #how long does the protocol wait before giving up?
   def XMODEM::timeout_seconds
@@ -30,7 +23,16 @@ module XMODEM
   end
 
   def XMODEM::timeout_seconds=(val)
-    @timeout_seconds=val
+    @timeout_seconds = val
+  end
+
+  #how long does the protocol wait before giving up?
+  def XMODEM::block_size
+    @block_size
+  end
+
+  def XMODEM::block_size=(val)
+    @block_size = val
   end
 
   # receive a file using XMODEM protocol (block size = 128 bytes)
@@ -103,7 +105,7 @@ module XMODEM
           local<<last_block
           last_block=""
         end
-        XMODEM_BLOCK_SIZE.times do
+        block_size.times do
           b=(receive_getbyte(remote))
           data<<b
           Thread.pass
@@ -161,7 +163,7 @@ module XMODEM
     current_block=""
     sent_eot=false
 
-    XMODEM_BLOCK_SIZE.times do
+    block_size.times do
       b=(local.eof? ?  FILLER : local.getc)
       current_block<<b.chr
       Thread.pass
@@ -180,7 +182,7 @@ module XMODEM
         break
       end
       tx_cmd=remote.getc.ord
-      logger.debug "sendder: got 0x#{"%x" % tx_cmd}"
+      logger.debug "sender: got 0x#{"%x" % tx_cmd}"
       if tx_cmd==ACK then
         if sent_eot then
           logger.debug "sender: got ACK of EOT"
@@ -195,7 +197,7 @@ module XMODEM
         end
         block_number=((block_number+1)%0x100)
         current_block=""
-        XMODEM_BLOCK_SIZE.times do
+        block_size.times do
           b=(local.eof? ?  FILLER : local.getc)
           current_block<<b
           Thread.pass
@@ -231,7 +233,7 @@ module XMODEM
   #calculate an 8-bit XMODEM checksum
   #this is just the sum of all bytes modulo 0x100
   def XMODEM::checksum(block)
-    raise RXChecksumError.new("checksum requested of invalid block {size should be #{XMODEM_BLOCK_SIZE}, was #{block.length}") unless block.length==XMODEM_BLOCK_SIZE
+    raise RXChecksumError.new("checksum requested of invalid block {size should be #{block_size}, was #{block.length}") unless block.length==block_size
     checksum=0
     block.each_byte do |b|
       checksum = (checksum+b) % 0x100
@@ -242,7 +244,7 @@ module XMODEM
   #calculate a 16-bit  CRC
   def XMODEM::ccitt16_crc(block)
     # cribbed from http://www.hadermann.be/blog/32/ruby-crc16-implementation/
-    raise RXChecksumError.new("checksum requested of invalid block {size should be #{XMODEM_BLOCK_SIZE}, was #{block.length}") unless block.length==XMODEM_BLOCK_SIZE
+    raise RXChecksumError.new("checksum requested of invalid block {size should be #{block_size}, was #{block.length}") unless block.length==block_size
     crc=0
     block.each_byte{|x| crc = ((crc<<8) ^ CCITT_16[(crc>>8) ^ x])&0xffff}
     crc

data/lib/xmodem/version.rb

@@ -1,3 +1,3 @@
 module XMODEM
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/test_xmodem.rb

@@ -227,7 +227,7 @@ class XmodemTests < MiniTest::Test
 
   # Test cases
   def test_version
-    assert_equal("0.1.0", ::XMODEM::VERSION)
+    assert_equal("0.1.1", ::XMODEM::VERSION)
   end
 
   def test_checksum

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xmodem
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jonno Downes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-21 00:00:00.000000000 Z
+date: 2015-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r