hrt_bus 0.0.6 → 0.0.7

data/CHANGELOG.md

@@ -25,3 +25,7 @@
 
 * Use Haversine to calculate distance between bus and rider
 
+> 0.0.7
+
+* Added adherence attribute to Bus
+* @bus.early? @bus.ontime? @bus.late?

data/README.md

@@ -1,6 +1,6 @@
 # hrt_bus
 
-Ruby gem for public HRT bus location data
+Ruby gem for real-time Hampton Roads Transit bus location data
 
 ## Installation
 
@@ -8,7 +8,7 @@ Ruby gem for public HRT bus location data
 
 ## Examples
 
-### HRT bus as a Ruby ActiveModel object
+### A Bus as a Ruby ActiveModel object
 
     HrtBus::Rider.new(:route_id => "20", :direction => "inbound").bus
 
@@ -21,6 +21,27 @@ Ruby gem for public HRT bus location data
       attr_accessor :time = Sat, 03 Mar 2012 23:24:28 +0000,
     >
 
+### Is my bus late?
+
+    HrtBus::Rider.new(:route_id => "20", :direction => "inbound").bus.late?
+
+### Send yourself a SMS or Tweet when your bus is close!
+
+    (1..15).each do |i|
+
+      rider =  HrtBus::Rider.new(:route_id  => "2",
+                                 :direction => "inbound",
+                                 :lat       => "36.870347",
+                                 :lon       => "-76.301163" )
+
+      if rider.bus.present? && rider.distance_to_bus <= 3
+        # Do something really cool like send a SMS or Tweet!
+      end
+
+      sleep 30
+
+    end
+
 ### Generate a static Google Map for a bus
 
     HrtBus::Rider.new(:route_id => "15", :direction => "outbound").bus.static_map
@@ -55,27 +76,6 @@ Ruby gem for public HRT bus location data
     ]
     ...
 
-### Determine if a bus is valid
-
-    HrtBus::Bus.active_buses.select { |bus| bus.route_id => "2" }.first.valid?
-
-### Send yourself a SMS or Tweet when your bus is close!
-
-    (1..15).each do |i|
-
-      rider =  HrtBus::Rider.new(:route_id  => "2",
-                                 :direction => "inbound",
-                                 :lat       => "36.870347",
-                                 :lon       => "-76.301163" )
-
-      if rider.bus.present? && rider.distance_to_bus <= 3
-        # Do something really cool like send a SMS or Tweet!
-      end
-
-      sleep 30
-
-    end
-
 ## Contributing to hrt_bus
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/hrt_bus.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Brian Douglas Smith"]
   s.email       = ["m.b1205@gmail.com"]
   s.homepage    = "https://github.com/bds/hrt_bus"
-  s.summary     = %q{Ruby gem for real-time public HRT bus location data}
-  s.description = %q{Ruby gem for real-time public HRT bus location data}
+  s.summary     = %q{Real-time Hampton Roads Transit bus location data}
+  s.description = %q{Bus number, route, GPS coordiantes, early/ontime/late and more}
 
   s.rubyforge_project = "hrt_bus"
 

data/lib/hrt_bus/bus.rb

@@ -3,7 +3,7 @@ module HrtBus
     include ActiveModel::Validations
     include ActiveModel::Serializers::JSON
 
-    ATTRIBUTES = [ :id, :time, :direction, :lat, :lon, :route_id ]
+    ATTRIBUTES = [ :id, :time, :direction, :lat, :lon, :route_id, :adherence ]
 
     DIRECTIONS = { "1" => "inbound",
                    "2" => "outbound" }.freeze
@@ -13,6 +13,7 @@ module HrtBus
     validates_numericality_of :route_id, greater_than: 0
     validates_numericality_of :lat, greater_than: 0
     validates_numericality_of :lon, less_than: 0
+    validates_numericality_of :adherence
     validates :direction, :inclusion => { :in => DIRECTIONS.values }
 
     validates :id, :time, :direction, :lat, :lon, :route_id, :presence => true
@@ -38,6 +39,18 @@ module HrtBus
       send(key)
     end
 
+    def early?
+      self.adherence < 0
+    end
+
+    def ontime?
+      self.adherence == 0
+    end
+
+    def late?
+      self.adherence > 0
+    end
+
     def static_map
       map = GoogleStaticMap.new(:width => 960, :height => 640)
       map.markers << MapMarker.new(:color => "blue",
@@ -60,18 +73,26 @@ module HrtBus
       parsed = ::CSV.new(curl.body_str, { :headers => true, :skip_blanks => true })
 
       parsed.each do |row|
-        time, date, id, lat_lon, valid, route_id, direction  = row[0],
+        time, date, id, lat_lon, valid, adherence, route_id, direction  = row[0],
                                                                row[1],
                                                                row[2],
                                                                row[3],
                                                                row[4],
+                                                               row[5],
                                                                row[7],
                                                                DIRECTIONS[row[8]]
 
         time     = HrtBus::Parse.time(time, date)
         lat, lon = HrtBus::Parse.geo(lat_lon)
 
-        bus = new(:id => id, :time => time, :direction => direction, :route_id => route_id, :lat => lat, :lon => lon)
+        bus = new(:time      => time,
+                  :id        => id,
+                  :lat       => lat,
+                  :lon       => lon,
+                  :adherence => adherence,
+                  :route_id  => route_id,
+                  :route_id  => route_id,
+                  :direction => direction)
 
         buses << bus if bus.valid?
       end
@@ -91,18 +112,30 @@ module HrtBus
       parsed = ::CSV.new(curl.body_str, { :headers => true, :skip_blanks => true })
 
       parsed.each do |row|
-        time, date, id, lat_lon, valid, route_id, direction  = row[0],
+
+        time, date, id, lat_lon, valid, adherence, route_id, direction  = row[0],
                                                                row[1],
                                                                row[2],
                                                                row[3],
                                                                row[4],
+                                                               row[5],
                                                                row[7],
                                                                DIRECTIONS[row[8]]
 
+
         time     = HrtBus::Parse.time(time, date)
         lat, lon = HrtBus::Parse.geo(lat_lon)
 
-        buses << new(:id => id, :time => time, :direction => direction, :route_id => route_id, :lat => lat, :lon => lon)
+        bus = new(:time      => time,
+                  :id        => id,
+                  :lat       => lat,
+                  :lon       => lon,
+                  :adherence => adherence,
+                  :route_id  => route_id,
+                  :route_id  => route_id,
+                  :direction => direction)
+
+        buses << bus
       end
       buses
     end
@@ -110,4 +143,3 @@ module HrtBus
   end
 
 end
-

data/lib/hrt_bus/version.rb

@@ -1,3 +1,3 @@
 module HrtBus
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/factories/bus.rb

@@ -6,6 +6,7 @@ FactoryGirl.define do
     time          { Time.now }
     lat           { 36.8642501 }
     lon           { -76.2818951 }
+    adherence     { Forgery(:basic).number(:at_least => -15, :at_most => 15) }
     route_id      { SecureRandom.random_number(1e9.to_i) }
     direction     { %w(inbound outbound).sample }
   end

data/spec/models/bus/bus_attributes_spec.rb

@@ -7,4 +7,5 @@ describe HrtBus::Bus do
   it { should respond_to(:time) }
   it { should respond_to(:lat) }
   it { should respond_to(:lon) }
+  it { should respond_to(:adherence) }
 end

data/spec/models/bus/bus_methods_spec.rb

@@ -11,6 +11,7 @@ describe HrtBus::Bus do
 
       it "should return a collection of valid buses" do
         buses.should be_a_kind_of(Enumerable) 
+        buses.should_not be_empty
         buses.each { |bus| bus.should be_valid }
         buses.first.should be_a_kind_of(HrtBus::Bus) 
       end
@@ -44,4 +45,80 @@ describe HrtBus::Bus do
     end
 
   end
+
+  describe "early?" do
+
+    context "the bus is early" do
+      it "should return true" do
+        bus = Factory.build(:bus, :adherence => -2)
+        bus.early?.should be_true
+      end
+    end
+
+    context "the bus is on time" do
+      it "should return false" do
+        bus = Factory.build(:bus, :adherence => 0)
+        bus.early?.should be_false
+      end
+    end
+
+    context "the bus is late" do
+      it "should return false" do
+        bus = Factory.build(:bus, :adherence => 4)
+        bus.early?.should be_false
+      end
+    end
+
+  end
+
+  describe "ontime?" do
+
+    context "the bus is early" do
+      it "should return false" do
+        bus = Factory.build(:bus, :adherence => -2)
+        bus.ontime?.should be_false
+      end
+    end
+
+    context "the bus is on time" do
+      it "should return true" do
+        bus = Factory.build(:bus, :adherence => 0)
+        bus.ontime?.should be_true
+      end
+    end
+
+    context "the bus is late" do
+      it "should return false" do
+        bus = Factory.build(:bus, :adherence => 4)
+        bus.ontime?.should be_false
+      end
+    end
+
+  end
+
+  describe "late?" do
+
+    context "the bus is early" do
+      it "should return false" do
+        bus = Factory.build(:bus, :adherence => -2)
+        bus.late?.should be_false
+      end
+    end
+
+    context "the bus is on time" do
+      it "should return true" do
+        bus = Factory.build(:bus, :adherence => 0)
+        bus.late?.should be_false
+      end
+    end
+
+    context "the bus is late" do
+      it "should return false" do
+        bus = Factory.build(:bus, :adherence => 4)
+        bus.late?.should be_true
+      end
+    end
+
+  end
+
 end

data/spec/models/bus/bus_validations_spec.rb

@@ -72,6 +72,20 @@ describe HrtBus::Bus do
       bus.errors.messages[:route_id].first.should match(/is not a number/)
     end
 
+    it "should validate_presence_of :adherence" do
+      bus.should be_valid
+      bus.adherence = nil
+      bus.should_not be_valid
+      bus.errors.messages[:adherence].first.should match(/is not a number/)
+    end
+
+    it "should validate_numericality :adherence" do
+      bus.should be_valid
+      bus.adherence = "late"
+      bus.should_not be_valid
+      bus.errors.messages[:adherence].first.should match(/is not a number/)
+    end
+
   end
 
 end

metadata

@@ -2,7 +2,7 @@
 name: hrt_bus
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Brian Douglas Smith
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-04 00:00:00 Z
+date: 2012-03-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activemodel
@@ -155,7 +155,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id013
-description: Ruby gem for real-time public HRT bus location data
+description: Bus number, route, GPS coordiantes, early/ontime/late and more
 email: 
 - m.b1205@gmail.com
 executables: []
@@ -223,7 +223,7 @@ rubyforge_project: hrt_bus
 rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
-summary: Ruby gem for real-time public HRT bus location data
+summary: Real-time Hampton Roads Transit bus location data
 test_files: 
 - spec/factories/bus.rb
 - spec/factories/rider.rb