onebusaway 0.1.0

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rcov
+  shoulda
+
+METADATA
+  version: 1.0.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jeff Ching
+
+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.markdown

@@ -0,0 +1,37 @@
+OneBusAway API
+--------------
+
+Unofficial Ruby library for interacting with the [OneBusAway API](http://code.google.com/p/onebusaway/wiki/OneBusAwayApiReference)
+
+### Documentation & Requirements
+* REXML
+
+### Examples
+
+Basic usage:
+
+    require 'rubygems'
+    require 'onebusaway'
+
+    Onebusaway.api_key = 'YOUR_API_KEY'
+
+    # find a stop by id - returns a Onebusaway::Stop instance
+    stop = Onebusaway.stop_by_id(:id => "1_10020")
+
+    # find a route by id - returns a Onebusaway::Route instance
+    route = Onebusaway.route_by_id(:id => "1_30")
+
+    # find stops nearby a given latitude and longitude
+    #   - returns an array of Onebusaway::Stop instances
+    stops = Onebusaway.stops_for_location(:lat => "47.66", :lon => "-122.29")
+
+    # find routes nearby a given latitude and longitude
+    #   - returns an array of Onebusaway::Route instances
+    routes = Onebusaway.routes_for_location(:lat => "47.66", :lon => "-122.29")
+
+    # find stops for a route - returns an array of Onebusaway::Stop instances
+    stops = Onebusaway.stops_for_route(:id => "1_30")
+
+    # find arrivals/departures for a given stop 
+    #   - returns an array of Onebusaway::ArrivalAndDeparture instances
+    arrivals = Onebusaway.arrivals_and_departures_for_stop(:id => "1_570")

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "onebusaway"
+  gem.homepage = "http://github.com/chingor13/onebusaway"
+  gem.license = "MIT"
+  gem.summary = %Q{Unofficial Ruby library for interacting with the OneBusAway API}
+  gem.description = %Q{Unofficial Ruby library for interacting with the OneBusAway API. See http://code.google.com/p/onebusaway/wiki/OneBusAwayRestApi}
+  gem.email = "ching.jeff@gmail.com"
+  gem.authors = ["Jeff Ching"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "onebusaway #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/onebusaway.rb

@@ -0,0 +1,181 @@
+module Onebusaway
+
+  API_BASE = "http://api.onebusaway.org/api/where/"
+
+  class << self
+    def api_key=(key)
+      @api_key = key
+    end
+
+    def stop_by_id(params)
+      raise if params[:id].nil?
+
+      xml = request('stop', params)
+      stop = Stop.from_xml(xml)
+    end
+
+    def route_by_id(params)
+      raise if params[:id].nil?
+
+      xml = request('route', params)
+      route = Route.from_xml(xml)
+    end
+
+    def stops_for_location(params)
+      raise if params[:lat].nil? || params[:lon].nil?
+
+      doc = request('stops-for-location', params)
+      stops = []
+      doc.elements.each("stops/stop") do |stop_el|
+        stops << Stop.from_xml(stop_el)
+      end
+      stops
+    end
+
+    def routes_for_location(params)
+      raise if params[:lat].nil? || params[:lon].nil?
+
+      doc = request('routes-for-location', params)
+      routes = []
+      doc.elements.each("routes/route") do |route_el|
+        routes << Route.from_xml(route_el)
+      end
+      routes
+    end
+
+    def stops_for_route(params)
+      raise if params[:id].nil?
+
+      doc = request('stops-for-route', params)
+      stops = []
+      doc.elements.each("stops/stop") do |stop_el|
+        stops << Stop.from_xml(stop_el)
+      end
+      stops
+    end
+
+    def arrivals_and_departures_for_stop(params)
+      raise if params[:id].nil?
+
+      doc = request('arrivals-and-departures-for-stop', params)
+      arrivals = []
+      doc.elements.each("arrivalsAndDepartures/arrivalAndDeparture") do |arrival_el|
+        arrivals << ArrivalAndDeparture.from_xml(arrival_el)
+      end
+      arrivals
+    end
+
+    private
+
+    def api_url(call, options = {})
+      url = API_BASE + call
+      id = options.delete(:id)
+      if id
+        url += "/" + id
+      end
+      url += ".xml?"
+      options[:key] = @api_key
+      url += options.to_a.map{|pair| "#{pair[0]}=#{pair[1]}"}.join("&")
+      url
+    end
+
+    def request(call, url_options)
+      url = api_url(call, url_options)
+
+      doc = REXML::Document.new(open(url))
+      root = doc.root
+      status_code = root.elements["code"].text
+      status_text = root.elements["text"].text
+
+      # failed status
+      unless /2\d{2}/.match(status_code)
+        raise "Request failed (#{status_code}): #{status_text}"
+      end
+
+      return root.elements["data"]
+    end
+
+  end
+ 
+  class Base
+    def self.from_xml(xml_or_data)
+      xml_or_data = REXML::Document.new(xml_or_data).root if xml_or_data.is_a?(String)
+      self.parse(xml_or_data)
+    end
+
+    def self.parse(data)
+      raise "not implemented"
+    end
+  end
+ 
+  class Agency < Base
+    attr_accessor :id, :name, :url, :timezone, :lang, :phone
+    def self.parse(data)
+      agency = self.new
+      [:id, :name, :url, :timezone, :lang, :phone].each do |attr|
+        value = data.elements[attr.to_s]
+        agency.send("#{attr}=", value.text) if value
+      end
+      agency
+    end
+  end
+
+  class ArrivalAndDeparture < Base
+    attr_accessor :routeId, :routeShortName, :tripId, :tripHeadsign, :stopId, :predictedArrivalTime, :scheduledArrivalTime, :predictedDepartureTime, :scheduledDepartureTime, :status
+    def self.parse(data)
+      arrival = self.new
+      [:routeId, :routeShortName, :tripId, :tripHeadsign, :stopId, :predictedArrivalTime, :scheduledArrivalTime, :predictedDepartureTime, :scheduledDepartureTime, :status].each do |attr|
+        value = data.elements[attr.to_s]
+        arrival.send("#{attr}=", value.text) if value
+      end
+      arrival
+    end
+
+    def minutes_from_now
+      @minutes_from_now ||= begin
+        at = predictedArrivalTime.to_i
+        if at == 0
+          # no predicted time, use scheduled
+          (scheduledArrivalTime.to_i/1000 - Time.now.to_i) / 60
+        else
+          (predictedArrivalTime.to_i/1000 - Time.now.to_i) / 60
+        end
+      end
+      @minutes_from_now
+    end
+  end
+
+  class EncodedPolyline < Base
+    attr_accessor :points, :length, :levels
+  end
+
+  class Route < Base
+    attr_accessor :id, :shortName, :longName, :description, :type, :url, :agency
+    def self.parse(data)
+      route = self.new
+      [:id, :shortName, :longName, :description, :type, :url].each do |attr|
+        value = data.elements[attr.to_s]
+        route.send("#{attr}=", value.text) if value
+      end
+      route.agency = Agency.parse(data.elements["agency"])
+      route
+    end
+  end
+
+  class Stop < Base
+    attr_accessor :id, :lat, :lon, :direction, :name, :code, :locationType, :routes
+    def self.parse(data)
+      stop = self.new
+      [:id, :lat, :lon, :direction, :name, :code, :locationType].each do |attr|
+        value = data.elements[attr.to_s]
+        stop.send("#{attr}=", value.text) if value
+      end
+      stop.routes ||= []
+      data.elements.each("routes/route") do |route_el|
+        stop.routes << Route.parse(route_el)
+      end
+      stop
+    end
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'onebusaway'
+
+class Test::Unit::TestCase
+end

data/test/sample_data.rb

@@ -0,0 +1,76 @@
+module Onebusaway
+  module SampleData
+    STOP_DATA = <<EOS
+<response>
+  <version>1.0</version>
+  <code>200</code>
+  <text>OK</text>
+  <data class="stop">
+    <id>1_10020</id>
+    <lat>47.6685829</lat>
+    <lon>-122.2883</lon>
+    <direction>W</direction>
+    <name>NE 55th St &amp; 37th Ave NE</name>
+    <code>10020</code>
+    <locationType>0</locationType>
+    <routes>
+      <route>
+        <id>1_30</id>
+        <shortName>30</shortName>
+        <description>Sandpoint/U-Dist/Seattle Center</description>
+        <type>3</type>
+        <url>http://metro.kingcounty.gov/tops/bus/schedules/s030_0_.html</url>
+        <agency>
+          <id>1</id>
+          <name>Metro Transit</name>
+          <url>http://metro.kingcounty.gov</url>
+          <timezone>America/Los_Angeles</timezone>
+          <lang>en</lang>
+          <phone>206-553-3000</phone>
+        </agency>
+      </route>
+      <route>
+        <id>1_74</id>
+        <shortName>74</shortName>
+        <description>Sandpoint/U-Dist/CPS</description>
+        <type>3</type>
+        <url>http://metro.kingcounty.gov/tops/bus/schedules/s074_0_.html</url>
+        <agency>
+          <id>1</id>
+          <name>Metro Transit</name>
+          <url>http://metro.kingcounty.gov</url>
+          <timezone>America/Los_Angeles</timezone>
+          <lang>en</lang>
+          <phone>206-553-3000</phone>
+        </agency>
+      </route>
+    </routes>
+  </data>
+</response>
+EOS
+    ROUTE_DATA = <<EOS
+<response>
+  <version>1.0</version>
+  <code>200</code>
+  <text>OK</text>
+  <data class="route">
+    <id>1_30</id>
+    <shortName>30</shortName>
+
+    <description>Sandpoint/U-Dist/Seattle Center</description>
+    <type>3</type>
+    <url>http://metro.kingcounty.gov/tops/bus/schedules/s030_0_.html</url>
+    <agency>
+      <id>1</id>
+      <name>Metro Transit</name>
+
+      <url>http://metro.kingcounty.gov</url>
+      <timezone>America/Los_Angeles</timezone>
+      <lang>en</lang>
+      <phone>206-553-3000</phone>
+    </agency>
+  </data>
+</response>
+EOS
+  end
+end

data/test/unit/test_onebusaway.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestOnebusaway < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    #flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: onebusaway
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeff Ching
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-17 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  type: :development
+description: Unofficial Ruby library for interacting with the OneBusAway API. See http://code.google.com/p/onebusaway/wiki/OneBusAwayRestApi
+email: ching.jeff@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- lib/onebusaway.rb
+- test/helper.rb
+- test/sample_data.rb
+- test/unit/test_onebusaway.rb
+has_rdoc: true
+homepage: http://github.com/chingor13/onebusaway
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Unofficial Ruby library for interacting with the OneBusAway API
+test_files: 
+- test/helper.rb
+- test/sample_data.rb
+- test/unit/test_onebusaway.rb