msr 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81af545812e6fab9ed1c61e8b69d1e82b961b068
-  data.tar.gz: fcd4c2cd3216794423db08a215db459739f2a7a0
+  metadata.gz: 23d6988a2d59a42e9eb5c923d392e59d1ae186ef
+  data.tar.gz: 52d9c1e5eb38d71a7bae4a114cad60e053989de6
 SHA512:
-  metadata.gz: 4179c29875a10c5d015a27ffffc80e1297a67e829385a8de3166aa903287d2640635c26242120e9982a05447bc6a3d8adb83a5af16bc698eb1851d894265aa73
-  data.tar.gz: a398a654f8304bdc7ad1dec138917d9bf29fb95fcfe34b7e4c5a86a4890f533e07ae7e06101e0e193b67f461945a302fb4e9b362dee3ce2e17e928defe616a16
+  metadata.gz: f2d87225574756678fc7b19f4deb5fe8babb5941b0160caec2b6ee3dbacc65f5e9205e1db8090ab16fa0eb597b897fa8c89af415a396311af4bb94068b5b8500
+  data.tar.gz: e0e3ac7659268b2c6e82c904b7854ab91f5b2941b92089aea468fed7fbca844b657ed3b38d3205cb2c4dfaf4924f099fad8d65b23b9680ac1fcab9876ce6ee1b

data/README.md

@@ -1,11 +1,22 @@
 msr
 ===
 
+[![Gem Version](https://badge.fury.io/rb/msr.svg)](https://badge.fury.io/rb/msr)
+
 A ruby gem for controlling magnetic stripe reader-writers (on UNIX/UNIX-likes).
 
 Uses [libmsr](https://github.com/woodruffw/libmsr).
 
-## Roadmap
+## Installation
+
+```
+$ gem install msr # make sure you have libmsr and ruby development headers
+```
+
+## Example
+
+Full documentation is
+[available on RubyDoc](http://www.rubydoc.info/gems/msr/).
 
 ```ruby
 require 'msr'
@@ -15,12 +26,21 @@ msr = MSR::MSR505C.new("/dev/ttyS0") # or your serial device
 puts "OK" if msr.linked?
 
 # control an LED on the reader
-msr.led!(:red) # :green, :yellow, :all, :off
+msr.led = :all # :green, :yellow, :red, :all, :none
 
 # get and set coercivity
 msr.coercivity # => :high, :low
 msr.coercivity = :high # :low
 
-# more to come
+tracks = msr.raw_read # => MSR::Tracks
+
+tracks.reverse!
+
+msr.raw_write tracks
 ```
 
+## License
+
+`ruby-msr` is licensed under the MIT License.
+
+For the exact terms, see the [license](./LICENSE) file.

data/ext/msr/msr206.c

@@ -33,13 +33,26 @@ static VALUE sensor_test(VALUE self);
 */
 static VALUE ram_test(VALUE self);
 
-
 /*
 	Reset the device to a ready state.
 	@note This method pauses for 100ms.
 */
 static VALUE reset(VALUE self);
 
+/*
+	Get the device's firmware version.
+	@return [String] the firmware version, in "REV?X.XX" format
+	@raise [RuntimeError] if the device returns a bad response
+*/
+static VALUE firmware(VALUE self);
+
+/*
+	Get the device's model.
+	@return [String] the model, in "MSR-206-?" format
+	@raise [RuntimeError] if the device returns a bad response
+*/
+static VALUE model(VALUE self);
+
 /*
 	Get the device's current coercivity level.
 	@return [Symbol] `:hi` if the device is in Hi-Co mode, `:lo` if Lo-Co
@@ -106,7 +119,6 @@ static VALUE raw_write(VALUE self, VALUE tks_obj);
 */
 static VALUE iso_write(VALUE self, VALUE tks_obj);
 
-
 void Init_msr_msr206()
 {
 	cMSR_MSR206 = rb_define_class_under(mMSR, "MSR206", rb_cObject);
@@ -117,6 +129,8 @@ void Init_msr_msr206()
 	rb_define_method(cMSR_MSR206, "sensor_test!", sensor_test, 0);
 	rb_define_method(cMSR_MSR206, "ram_test!", ram_test, 0);
 	rb_define_method(cMSR_MSR206, "reset!", reset, 0);
+	rb_define_method(cMSR_MSR206, "firmware", firmware, 0);
+	rb_define_method(cMSR_MSR206, "model", model, 0);
 	rb_define_method(cMSR_MSR206, "coercivity", get_coercivity, 0);
 	rb_define_method(cMSR_MSR206, "coercivity=", set_coercivity, 1);
 	rb_define_method(cMSR_MSR206, "bpi=", set_bpi, 1);
@@ -237,6 +251,40 @@ static VALUE reset(VALUE self)
 	return self;
 }
 
+static VALUE firmware(VALUE self)
+{
+	msr206_ctx_t *ctx;
+	uint8_t buf[9];
+	int ret;
+
+	Data_Get_Struct(self, msr206_ctx_t, ctx);
+
+	ret = msr_fwrev(ctx->fd, buf);
+
+	if (ret != LIBMSR_ERR_OK) {
+		rb_raise(rb_eRuntimeError, "Couldn't get device firmware (%d)", ret);
+	}
+
+	return rb_str_new_cstr(buf);
+}
+
+static VALUE model(VALUE self)
+{
+	msr206_ctx_t *ctx;
+	uint8_t buf[10];
+	int ret;
+
+	Data_Get_Struct(self, msr206_ctx_t, ctx);
+
+	ret = msr_model(ctx->fd, buf);
+
+	if (ret != LIBMSR_ERR_OK) {
+		rb_raise(rb_eRuntimeError, "Couldn't get device model (%d)", ret);
+	}
+
+	return rb_str_new_cstr(buf);
+}
+
 static VALUE get_coercivity(VALUE self)
 {
 	VALUE hi_co = ID2SYM(rb_intern("hi"));

data/ext/msr/tracks.c

@@ -30,6 +30,8 @@ void Init_msr_tracks()
 {
 	c_MSR_Tracks = rb_define_class_under(mMSR, "Tracks", rb_cObject);
 
+	rb_define_const(c_MSR_Tracks, "MAX_TRACKS", INT2NUM(MSR_MAX_TRACKS));
+
 	rb_define_method(c_MSR_Tracks, "initialize", msr_tracks_initialize, 3);
 	rb_define_method(c_MSR_Tracks, "track1", msr_tracks_track1, 0);
 	rb_define_method(c_MSR_Tracks, "track2", msr_tracks_track2, 0);

data/lib/msr.rb

@@ -5,5 +5,5 @@ require_relative "msr/msr206"
 require_relative "msr/msr505c"
 
 module MSR
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.4".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: msr
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2016-11-04 00:00:00.000000000 Z
 dependencies: []
 description: A library for controlling magnetic stripe reader/writers.
 email: william@tuffbizz.com