bus_tracker 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [Mark Connell]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Bustracker
+
+Edinburgh BusTracker via Ruby.
+
+An attempt at providing an object-based interface for interacting with the BusTracker data.
+
+# Examples
+
+## Service Information
+Find all of the bus stops for a particular service:
+    service = BusTracker.service('N30')
+    
+    service.number
+    #=> 'N30'
+
+After fetching a service, you can also pull up information about each stop for that service:
+
+    bus_stop = service.bus_stops.first
+    
+    bus_stop.code
+    > '36232545'
+    
+    bus_stop.name
+     > 'Castle Street'
+    
+    bus_stop.latitude
+     > "55.951084136963"
+    bus_stop.longitude
+     > "-3.2017660140991"
+    
+    bus_stop.service_numbers
+     > ["1", "3", "3A", "4", "22", "25", "X25", "30", "33", "34", "44", "44A", "N22", "N25", "N30", "N44"]
+
+## Departures
+If you know the code for a bus stop you can fetch the associated departures. This is the same information that
+you'd see on the bus tracker boards, but instantiated as their own departure objects.
+    stop = BusTracker.bus_stop('36232545')
+    departure = stop.departures.first
+    
+    departure.service_number
+    #=> 30
+    departure.destination
+    #=> MUSSELBURGH
+    departure.due
+    #=> 7
+
+For any BusTracker::BusStop instance, you can fetch the latest departure times:
+    stop.fetch_departures!
+    stop.departures.first.due
+    #=> 5
+
+Copyright (c) 2010 [Mark Connell], released under the MIT license

data/lib/bus_tracker.rb

@@ -0,0 +1,24 @@
+require 'nokogiri'
+require 'open-uri'
+
+require 'bus_tracker/service'
+require 'bus_tracker/bus_stop'
+require 'bus_tracker/departure'
+
+module BusTracker
+
+  BASE_URI = 'http://mybustracker.co.uk/'
+
+  def self.service(number)
+    service = BusTracker::Service.new(number)
+    service.fetch_bus_stops!
+    service
+  end
+
+  def self.bus_stop(code)
+    bus_stop = BusTracker::BusStop.new(:code => code)
+    bus_stop.fetch_departures!
+    bus_stop
+  end
+
+end

data/lib/bus_tracker/bus_stop.rb

@@ -0,0 +1,25 @@
+module BusTracker
+  class BusStop
+    attr_accessor :name, :code, :latitude, :longitude, :service_numbers, :departures
+
+    def initialize(options = {})
+      self.service_numbers = []
+      self.departures      = []
+
+      options.each_pair do |option, value|
+        self.send("#{option}=", value) if self.respond_to? "#{option}="
+      end
+    end
+
+    def fetch_departures!
+      self.departures = []
+
+      uri  = "#{BASE_URI}getBusStopDepartures.php?refreshCount=0&clientType=b&busStopCode=#{code}"
+      uri += "&busStopDay=0&busStopService=0&numberOfPassage=4&busStopTime=&busStopDestination=0"
+      document = Nokogiri::HTML(open(uri))
+      document.xpath('//pre').each do |departure|
+        self.departures << BusTracker::Departure.new(departure.content)
+      end
+    end
+  end
+end

data/lib/bus_tracker/departure.rb

@@ -0,0 +1,17 @@
+module BusTracker
+  class Departure
+    attr_accessor :service_number, :destination, :due
+
+    def initialize(raw_string)
+      set_attributes(raw_string)
+    end
+
+    private
+    def set_attributes(raw_string)
+      attributes = raw_string.split(/(\w*\d+\w*)\s*([a-z]+\s*(?!DUE)[a-z]*\s*(?!DUE)[a-z]+)\s+((DUE|\**[0-9:]*))\s*/i) - ['']
+      self.service_number = attributes[0]
+      self.destination    = attributes[1]
+      self.due            = attributes[2]
+    end
+  end
+end

data/lib/bus_tracker/service.rb

@@ -0,0 +1,26 @@
+module BusTracker
+  class Service
+    attr_accessor :number, :bus_stops
+
+    def initialize(number)
+      self.number    = number
+      self.bus_stops = []
+    end
+
+    def fetch_bus_stops!
+      self.bus_stops = []
+
+      document  = Nokogiri::HTML(open("#{BASE_URI}getServicePoints.php?serviceMnemo=#{self.number}"))
+      bus_stops = document.xpath('//map/markers/busstop')
+      bus_stops.each do |bus_stop|
+        self.bus_stops << BusTracker::BusStop.new(
+          :code            => bus_stop.xpath('sms')[0].content,
+          :name            => bus_stop.xpath('nom')[0].content,
+          :latitude        => bus_stop.xpath('x')[0].content,
+          :longitude       => bus_stop.xpath('y')[0].content,
+          :service_numbers => bus_stop.xpath('services/service/mnemo').map {|s| s.content}
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: bus_tracker
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Mark Connell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-03 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 1
+        version: 1.4.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A ruby interface for accessing service and bus stop information provided by the BusTracker service for Edinburgh's public transport.
+email: 
+- mark@markconnell.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.md
+- lib/bus_tracker/bus_stop.rb
+- lib/bus_tracker/departure.rb
+- lib/bus_tracker/service.rb
+- lib/bus_tracker.rb
+has_rdoc: true
+homepage: http://github.com/mconnell/bus_tracker
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Access Edinburgh's bus tracker service via ruby.
+test_files: []
+