nextbus 0.0.0

data/lib/attr_with_default.rb

@@ -0,0 +1,51 @@
+# http://snippets.dzone.com/posts/show/4382
+
+module AttrWithDefault
+  
+  module ClassMethods
+    
+    def attr_accessor(*args)
+      attrs, attrs_with_defaults = split_for_last_hash(args)
+      attrs_with_defaults.each do |name, default|
+        attr_reader_with_default name, default
+        attr_writer              name
+      end
+      
+      super(*attrs)
+    end
+    
+    def attr_reader(*args)
+      attrs, attrs_with_defaults = split_for_last_hash(args)
+      attrs_with_defaults.each do |name, default|
+        attr_reader_with_default name, default
+      end
+      
+      super(*attrs)
+    end
+    
+  private
+    
+    def attr_reader_with_default(name, default)
+      define_method(name) do
+        unless instance_variable_defined?("@#{name}")
+          instance_variable_set "@#{name}", default
+        end
+        instance_variable_get "@#{name}"
+      end
+    end
+    
+    def split_for_last_hash(args)
+      if args.last.is_a?(Hash)
+        [args[0...-1], args.last]
+      else
+        [args, {}]
+      end
+    end
+    
+  end
+  
+  def self.included(other_module)
+    other_module.extend ClassMethods
+  end
+  
+end

data/lib/instantiate_with_attrs.rb

@@ -0,0 +1,12 @@
+module InstantiateWithAttrs
+  
+  def initialize(attrs={})
+    super()
+    attrs.each do |name, value| 
+      setter = "#{name.to_s}=".to_sym
+      self.send(setter, value) if self.respond_to?(setter)
+    end
+    self
+  end
+
+end

data/lib/nextbus.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+require 'hashie'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'instantiate_with_attrs'
+require 'attr_with_default'
+
+dir = File.join(File.dirname(__FILE__), 'nextbus')
+$LOAD_PATH.unshift(dir)
+Dir[File.join(dir, "*.rb")].each {|file| require File.basename(file) }

data/lib/nextbus/agency.rb

@@ -0,0 +1,18 @@
+module Nextbus
+  class Agency
+
+    include InstantiateWithAttrs
+    include AttrWithDefault
+
+    attr_accessor :tag, :title, :short_title, :region_title, :routes => [], :vehicles => []
+
+    def self.all
+      Nextbus.client.agencies.map{|agency| new(agency) }
+    end
+
+    def self.find(id)
+      all.detect{|agency| agency.tag == id }
+    end
+
+  end
+end

data/lib/nextbus/client.rb

@@ -0,0 +1,70 @@
+require 'singleton'
+module Nextbus
+
+  def self.client
+    Nextbus::Client.instance
+  end
+
+  class Client
+
+    include Singleton
+    include HTTParty
+
+    base_uri "http://webservices.nextbus.com/service/publicXMLFeed?command="
+
+    def agencies
+      response = self.class.do_request("agencyList", {})
+      response.agency
+    end
+
+    def routes(agency_id)
+      response = self.class.do_request("routeList", {"a" => agency_id})
+      response.route
+    end
+
+    def route(agency_id, route_id)
+      response = self.class.do_request("routeConfig", {"a" => agency_id, "r" => route_id})
+      response.route
+    end
+
+    def predictions(agency_id, route_id, stop_id)
+      response = self.class.do_request("predictions", {"a" => agency_id, "r" => route_id, "s" => stop_id})
+      response.predictions.direction.prediction
+    end
+
+    def vehicles(agency_id, route_id, time=Time.now)
+      response = self.class.do_request("vehicleLocations", {"a" => agency_id, "r" => route_id, "t" => time.to_i.to_s})
+      response.vehicle
+    end
+
+    def directions(agency_id, route_id)
+      response = self.class.do_request("routeConfig", {"a" => agency_id, "r" => route_id})
+      response.route.direction
+    end
+
+    def stops(agency_id, route_id, direction_id)
+      response = self.class.do_request("routeConfig", {"a" => agency_id, "r" => route_id})
+      response.route.direction.detect{|direction| direction.tag == direction_id }.stop
+    end
+
+  protected
+
+    def self.do_request(resource, params)  
+      uri = build_uri(resource, params)
+      response = get(uri)
+      mash_response_body(response)
+    end
+
+    def self.build_uri(resource, params)
+      params = params.to_a
+      params.map!{|pair| pair.join('=') }
+      params.unshift(resource)
+      params.join('&')
+    end
+
+    def self.mash_response_body(response)
+      Hashie::Mash.new(response["body"])
+    end
+
+  end
+end

data/lib/nextbus/direction.rb

@@ -0,0 +1,18 @@
+module Nextbus
+  class Direction
+
+    include InstantiateWithAttrs
+    include AttrWithDefault
+
+    attr_accessor :tag, :title, :name, :route, :reports => [], :stops => []
+
+    def self.all(agency_id, route_id)
+      Nextbus.client.directions(agency_id, route_id).map{|direction| new(direction) }
+    end
+
+    def self.find(agency_id, route_id, id)
+      all(agency_id, route_id).detect{|direction| direction.tag == id }
+    end
+
+  end
+end

data/lib/nextbus/mash_extensions.rb

@@ -0,0 +1,12 @@
+module Hashie
+
+  class Mash < Hashie::Hash
+
+  protected
+
+    def convert_key(key) #:nodoc:
+      key.to_s.underscore
+    end
+
+  end
+end

data/lib/nextbus/prediction.rb

@@ -0,0 +1,18 @@
+module Nextbus
+  class Prediction
+
+    include InstantiateWithAttrs
+    include AttrWithDefault
+
+    attr_accessor :time, :departure, :stop
+
+    def epoch_time=(nanosecs)
+      self.time = Time.at(nanosecs.to_i/1000)
+    end
+
+    def self.all(agency_id, route_id, stop_id)
+      Nextbus.client.predictions(agency_id, route_id, stop_id).map{|prediction| new(prediction) }
+    end
+
+  end
+end

data/lib/nextbus/report.rb

@@ -0,0 +1,10 @@
+module Nextbus
+  class Report
+
+    include InstantiateWithAttrs
+    include AttrWithDefault
+
+    attr_accessor :lat, :lon, :heading, :time, :vehicle, :direction
+
+  end
+end

data/lib/nextbus/route.rb

@@ -0,0 +1,18 @@
+module Nextbus
+  class Route
+
+    include InstantiateWithAttrs
+    include AttrWithDefault
+
+    attr_accessor :tag, :title, :agency, :directions => []
+
+    def self.all(agency_id)
+      Nextbus.client.routes(agency_id).map{|agency| new(agency) }
+    end
+
+    def self.find(agency_id, id)
+      new Nextbus.client.route(agency_id, id)
+    end
+
+  end
+end

data/lib/nextbus/stop.rb

@@ -0,0 +1,18 @@
+module Nextbus
+  class Stop
+
+    include InstantiateWithAttrs
+    include AttrWithDefault
+
+    attr_accessor :tag, :title, :lat, :lon, :id, :direction, :predictions => []
+
+    def self.all(agency_id, route_id, direction_id)
+      Nextbus.client.stops(agency_id, route_id, direction_id).map{|stop| new(stop) }
+    end
+
+    def self.find(agency_id, route_id, direction_id, id)
+      all(agency_id, route_id, direction_id).detect{|stop| stop.tag == id }
+    end
+
+  end
+end

data/lib/nextbus/string_extensions.rb

@@ -0,0 +1,16 @@
+class String
+
+  def underscore
+    self.class.underscore(self)
+  end
+
+  def self.underscore(camel_cased_word)
+    camel_cased_word.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr(" ", "_").
+      tr("-", "_").
+      downcase
+  end
+
+end

data/lib/nextbus/vehicle.rb

@@ -0,0 +1,18 @@
+module Nextbus
+  class Vehicle
+
+    include InstantiateWithAttrs
+    include AttrWithDefault
+
+    attr_accessor :id, :agency, :route, :reports => []
+
+    def self.all(agency_id, route_id)
+      Nextbus.client.vehicles(agency_id, route_id).map{|vehicle| new(vehicle) }
+    end
+
+    def self.find(agency_id, route_id, id)
+      all(agency_id, route_id).detect{|vehicle| vehicle.id == id }
+    end
+
+  end
+end

data/nextbus.gemspec

@@ -0,0 +1,106 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nextbus}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Greg Sterndale"]
+  s.date = %q{2010-02-23}
+  s.description = %q{NextBus API client}
+  s.email = %q{gsterndale@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "doc/ERM.graffle",
+     "doc/MBTA_XML_Feed_Trial_Docs_13Nov09-1.pdf",
+     "lib/attr_with_default.rb",
+     "lib/instantiate_with_attrs.rb",
+     "lib/nextbus.rb",
+     "lib/nextbus/agency.rb",
+     "lib/nextbus/client.rb",
+     "lib/nextbus/direction.rb",
+     "lib/nextbus/mash_extensions.rb",
+     "lib/nextbus/prediction.rb",
+     "lib/nextbus/report.rb",
+     "lib/nextbus/route.rb",
+     "lib/nextbus/stop.rb",
+     "lib/nextbus/string_extensions.rb",
+     "lib/nextbus/vehicle.rb",
+     "nextbus.gemspec",
+     "test/fixtures/agency_list.xml",
+     "test/fixtures/error.xml",
+     "test/fixtures/predictions.xml",
+     "test/fixtures/predictions_for_multi_stops.xml",
+     "test/fixtures/route_config.xml",
+     "test/fixtures/route_list.xml",
+     "test/fixtures/vehicle_locations.xml",
+     "test/helper.rb",
+     "test/unit/test_agency.rb",
+     "test/unit/test_attr_with_default.rb",
+     "test/unit/test_client.rb",
+     "test/unit/test_direction.rb",
+     "test/unit/test_instantiate_with_attrs.rb",
+     "test/unit/test_mash_extensions.rb",
+     "test/unit/test_nextbus.rb",
+     "test/unit/test_prediction.rb",
+     "test/unit/test_report.rb",
+     "test/unit/test_route.rb",
+     "test/unit/test_stop.rb",
+     "test/unit/test_string_extensions.rb",
+     "test/unit/test_vehicle.rb",
+     "vendor/cache/columnize-0.3.1.gem",
+     "vendor/cache/crack-0.1.6.gem",
+     "vendor/cache/hashie-0.1.8.gem",
+     "vendor/cache/httparty-0.5.2.gem",
+     "vendor/cache/linecache-0.43.gem",
+     "vendor/cache/mocha-0.9.8.gem",
+     "vendor/cache/rake-0.8.7.gem",
+     "vendor/cache/ruby-debug-0.10.3.gem",
+     "vendor/cache/ruby-debug-base-0.10.3.gem"
+  ]
+  s.homepage = %q{http://github.com/neweryankee/nextbus}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{NextBus API client}
+  s.test_files = [
+    "test/helper.rb",
+     "test/unit/test_agency.rb",
+     "test/unit/test_attr_with_default.rb",
+     "test/unit/test_client.rb",
+     "test/unit/test_direction.rb",
+     "test/unit/test_instantiate_with_attrs.rb",
+     "test/unit/test_mash_extensions.rb",
+     "test/unit/test_nextbus.rb",
+     "test/unit/test_prediction.rb",
+     "test/unit/test_report.rb",
+     "test/unit/test_route.rb",
+     "test/unit/test_stop.rb",
+     "test/unit/test_string_extensions.rb",
+     "test/unit/test_vehicle.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/fixtures/agency_list.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<body copyright="All data copyright agencies listed below and NextBus Inc 2010.">
+<agency tag="mbta" title="MBTA" regionTitle="Massachusetts"/>
+<agency tag="sf-muni" title="San Francisco Muni" shortTitle="SF Muni" regionTitle="California-Northern"/>
+</body>

data/test/fixtures/error.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<body copyright="All data copyright MBTA 2010.">
+<Error shouldRetry="false">
+  Exception occurred in XMLFeed, status=[command=vehicleLocations,agency=mbta] message: For input string: ""
+</Error>
+</body>

data/test/fixtures/predictions.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<body copyright="All data copyright MBTA 2010.">
+<predictions agencyTitle="MBTA" routeTitle="39" routeTag="39" stopTitle="105 S Huntington (Stop 22365)">
+  <direction title="Outbound">
+    <prediction seconds="745" minutes="12" epochTime="1266681828070" isDeparture="false" dirTag="out" vehicle="1041" block="S393_6"/>
+    <prediction seconds="1299" minutes="21" epochTime="1266681828075" isDeparture="false" dirTag="out" vehicle="1022" block="S393_7"/>
+    <prediction seconds="1929" minutes="32" epochTime="1266683011947" isDeparture="false" dirTag="out" vehicle="1027" block="S393_1"/>
+    <prediction seconds="2529" minutes="42" epochTime="1266683611947" isDeparture="false" dirTag="out" vehicle="1040" block="S393_2"/>
+    <prediction seconds="3129" minutes="52" epochTime="1266684211947" isDeparture="false" dirTag="out" vehicle="1037" block="S393_8"/>
+  </direction>
+</predictions>
+</body>