msr 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23d6988a2d59a42e9eb5c923d392e59d1ae186ef
-  data.tar.gz: 52d9c1e5eb38d71a7bae4a114cad60e053989de6
+  metadata.gz: d4eb31ded5a7a86fb1df60165558754f030223c1
+  data.tar.gz: 4474f8b073728ae16149b5ec1b8e1ef65496306a
 SHA512:
-  metadata.gz: f2d87225574756678fc7b19f4deb5fe8babb5941b0160caec2b6ee3dbacc65f5e9205e1db8090ab16fa0eb597b897fa8c89af415a396311af4bb94068b5b8500
-  data.tar.gz: e0e3ac7659268b2c6e82c904b7854ab91f5b2941b92089aea468fed7fbca844b657ed3b38d3205cb2c4dfaf4924f099fad8d65b23b9680ac1fcab9876ce6ee1b
+  metadata.gz: 8adb3783abdfb4731a671a2ddbe202fe0430992cb44dedb93ec452d4bcfa7f29083e00ac3f4823c40f90906e6be42c2b893dec06b7d67138526d49a5c39299c7
+  data.tar.gz: fd5505b6c8510bbadffd60737bfbf6260e52820f72eca3b95f2b7857a1255960164f40446ca428c1e77a73ca3b8a558ead9dcee685620431fd7e8e76008433ae

data/ext/msr/track.c

@@ -4,13 +4,13 @@
 	The data associated with the track.
 	@return [Array<Fixnum>] the track data
 */
-static VALUE msr_track_data(VALUE self);
+static VALUE msr_track_get_data(VALUE self);
 
 /*
 	The length of the track's data.
 	@return [Fixnum] the track length
 */
-static VALUE msr_track_length(VALUE self);
+static VALUE msr_track_get_length(VALUE self);
 
 /*
 	Reverse the direction of the track, returning a new object.
@@ -27,8 +27,8 @@ void Init_msr_track()
 	rb_define_const(c_MSR_Track, "MAX_TRACK_LEN", INT2NUM(MSR_MAX_TRACK_LEN));
 
 	rb_define_method(c_MSR_Track, "initialize", msr_track_initialize, 1);
-	rb_define_method(c_MSR_Track, "data", msr_track_data, 0);
-	rb_define_method(c_MSR_Track, "length", msr_track_length, 0);
+	rb_define_method(c_MSR_Track, "data", msr_track_get_data, 0);
+	rb_define_method(c_MSR_Track, "length", msr_track_get_length, 0);
 	rb_define_method(c_MSR_Track, "reverse", msr_track_reverse, 0);
 }
 
@@ -53,12 +53,12 @@ VALUE msr_track_initialize(VALUE self, VALUE tk_data_ary)
 	return self;
 }
 
-static VALUE msr_track_data(VALUE self)
+static VALUE msr_track_get_data(VALUE self)
 {
 	return rb_iv_get(self, "@data");
 }
 
-static VALUE msr_track_length(VALUE self)
+static VALUE msr_track_get_length(VALUE self)
 {
 	VALUE tk_data_ary = rb_iv_get(self, "@data");
 

data/ext/msr/tracks.c

@@ -4,19 +4,25 @@
 	The first track on the card.
 	@return [MSR::Track] the track object
 */
-static VALUE msr_tracks_track1(VALUE self);
+static VALUE msr_tracks_get_track1(VALUE self);
 
 /*
 	The second track on the card.
 	@return [MSR::Track] the track object
 */
-static VALUE msr_tracks_track2(VALUE self);
+static VALUE msr_tracks_get_track2(VALUE self);
 
 /*
 	The third track on the card.
 	@return [MSR::Track] the track object
 */
-static VALUE msr_tracks_track3(VALUE self);
+static VALUE msr_tracks_get_track3(VALUE self);
+
+/*
+	All tracks on the card, as an array.
+	@return [Array<MSR::Track>] all card tracks
+*/
+static VALUE msr_tracks_get_tracks(VALUE self);
 
 /*
 	Reverse the direction of the tracks, returning a new object.
@@ -33,14 +39,17 @@ void Init_msr_tracks()
 	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);
-	rb_define_method(c_MSR_Tracks, "track3", msr_tracks_track3, 0);
+	rb_define_method(c_MSR_Tracks, "track1", msr_tracks_get_track1, 0);
+	rb_define_method(c_MSR_Tracks, "track2", msr_tracks_get_track2, 0);
+	rb_define_method(c_MSR_Tracks, "track3", msr_tracks_get_track3, 0);
+	rb_define_method(c_MSR_Tracks, "tracks", msr_tracks_get_tracks, 0);
 	rb_define_method(c_MSR_Tracks, "reverse", msr_tracks_reverse, 0);
 }
 
 VALUE msr_tracks_initialize(VALUE self, VALUE tk1, VALUE tk2, VALUE tk3)
 {
+	VALUE tks_ary = rb_ary_new();
+
 	if (CLASS_OF(tk1) != c_MSR_Track) {
 		rb_raise(rb_eArgError, "expected track object for track 1");
 	}
@@ -53,26 +62,33 @@ VALUE msr_tracks_initialize(VALUE self, VALUE tk1, VALUE tk2, VALUE tk3)
 		rb_raise(rb_eArgError, "expected track object for track 3");
 	}
 
-	rb_iv_set(self, "@track1", tk1);
-	rb_iv_set(self, "@track2", tk2);
-	rb_iv_set(self, "@track3", tk3);
+	rb_ary_push(tks_ary, tk1);
+	rb_ary_push(tks_ary, tk2);
+	rb_ary_push(tks_ary, tk3);
+
+	rb_iv_set(self, "@tracks", tks_ary);
 
 	return self;
 }
 
-static VALUE msr_tracks_track1(VALUE self)
+static VALUE msr_tracks_get_track1(VALUE self)
+{
+	return rb_ary_entry(rb_iv_get(self, "@tracks"), 0);
+}
+
+static VALUE msr_tracks_get_track2(VALUE self)
 {
-	return rb_iv_get(self, "@track1");
+	return rb_ary_entry(rb_iv_get(self, "@tracks"), 1);
 }
 
-static VALUE msr_tracks_track2(VALUE self)
+static VALUE msr_tracks_get_track3(VALUE self)
 {
-	return rb_iv_get(self, "@track2");
+	return rb_ary_entry(rb_iv_get(self, "@tracks"), 2);
 }
 
-static VALUE msr_tracks_track3(VALUE self)
+static VALUE msr_tracks_get_tracks(VALUE self)
 {
-	return rb_iv_get(self, "@track3");
+	return rb_iv_get(self, "@tracks");
 }
 
 static VALUE msr_tracks_reverse(VALUE self)

data/lib/msr.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../ext/msr/msr"
 require_relative "msr/track"
 require_relative "msr/tracks"
@@ -5,5 +7,5 @@ require_relative "msr/msr206"
 require_relative "msr/msr505c"
 
 module MSR
-  VERSION = "0.0.4".freeze
+  VERSION = "0.1.0"
 end

data/lib/msr/msr206.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MSR
   # Represents a connection to an MSR206 (or MSR206-compatible device).
   class MSR206

data/lib/msr/msr505c.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MSR
   # Alias MSR505C to MSR206, since the two are firmware compatible.
   # @see MSR206

data/lib/msr/track.rb

@@ -1,22 +1,36 @@
+# frozen_string_literal: true
+
 module MSR
   # Represents a single track from a magnetic stripe card.
   class Track
+    # Whether or not the track contains any data.
+    # @return [Boolean] `true` if empty, `false` otherwise
+    def empty?
+      data.empty?
+    end
+
     # Reverse the direction of the track, in place.
     # @return [MSR::Tracks] the current instance
     def reverse!
-      reversed = self.reverse
-
-      @data = reversed.data
+      @data = reverse.data
 
       self # return ourself, just for convenience
     end
 
+    # Return a string representation of the track's data.
+    # @note May or may not be human readable.
+    # @return [String] a string representation of track data
+    def to_s
+      data.map(&:chr).join
+    end
+
     # Compare two tracks for equality. Two tracks are said to be equal if they
     # contain the same data, in the same order.
+    # @param other [Track] the track to compare to
     # @return [Boolean] `true` if the two are equal, `false` otherwise
-    def ==(o)
-      return unless o.is_a?(self.class)
-      data == o.data
+    def ==(other)
+      return unless other.is_a?(self.class)
+      data == other.data
     end
   end
 end

data/lib/msr/tracks.rb

@@ -1,24 +1,29 @@
+# frozen_string_literal: true
+
 module MSR
   # Represents (up to) three tracks from a magnetic stripe card.
   class Tracks
+    # Whether or not all tracks are empty.
+    # @return [Boolean] `true` if all tracks are empty, `false` otherwise
+    def empty?
+      tracks.all?(&:empty?)
+    end
+
     # Reverse the direction of the tracks, in place.
     # @return [MSR::Tracks] the current instance
     def reverse!
-      reversed = self.reverse
-
-      @track1 = reversed.track1
-      @track2 = reversed.track2
-      @track3 = reversed.track3
+      @tracks = reverse.tracks
 
       self # return ourself, just for convenience
     end
 
     # Compare two sets of tracks for equality. Two sets are said to be equal
     # if all of their corresponding pairs are equal.
+    # @param other [Tracks] the tracks to compare to
     # @return [Boolean] `true` if the two are equal, `false` otherwise
-    def ==(o)
-      return unless o.is_a?(self.class)
-      track1 == o.track1 && track2 == o.track2 && track3 == o.track3
+    def ==(other)
+      return unless other.is_a?(self.class)
+      track1 == other.track1 && track2 == other.track2 && track3 == other.track3
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: msr
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-04 00:00:00.000000000 Z
+date: 2017-07-20 00:00:00.000000000 Z
 dependencies: []
 description: A library for controlling magnetic stripe reader/writers.
 email: william@tuffbizz.com
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: msr - magnetic stripe reader/writer library.