bus-o-matic 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 400fd1cb7e0e96c2dc0fee2cd937f188a2f3e572
-  data.tar.gz: da750c8cdc0260fcecd5687cd7863ed8d0713efe
+  metadata.gz: e7a886fce58da346faaf023ea93d7119dc101bce
+  data.tar.gz: b25ace7e55ca30109cc5d65712257139a7928168
 SHA512:
-  metadata.gz: b41fd9f133f7a8194ca712774ca6404497cdf8d6117b5bece4603d4bc17e703273c083f7f107f0b148ff2e99d817dd2bdfcb50745becf6adbb282c88316e965c
-  data.tar.gz: 3f58618a70c0b7bfaec1854653890a25dab4bff8c35e6afa51bea17ff31fe1c85ffcb3383842e56be57b869bf584d3b0f1a3704662a815ece290750b6bc40f63
+  metadata.gz: 4277dbcc6bb94b238992d5272bbbac69971ea72099f2e440bf9544bd6af46e10d3a02086612cd22362d6500e081868c444a95262a578ddf983d49b6d136bb84f
+  data.tar.gz: 0bf32c7ca5f84195ed5f337b3978ef7dc97bc55606768df7cd461369eb3a5ec7c511f4b63f29375bd1dd2381044eb02ac6a9f7d40ce1bd2c80a6be9ba08ec72b

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bus_rat.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2015 Matt Cone
+
+Copyright (c) 2013 fbonetti
+
+MIT License
+
+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,155 @@
+# Bus-o-matic
+
+Bus-o-matic is a simple Ruby wrapper for the [Pittsburgh Port Authority API] 
+(http://www.portauthority.org/paac/CompanyInfoProjects/DeveloperResources.aspx).
+This gem allows you to retrieve real-time information about vehicles, routes, 
+stops, and predicted arrival times for buses in Pittsburgh, Pennsylvania.
+This gem borrows heavily from [cta-api] (https://github.com/fbonetti/cta-api)
+by [Frank Bonetti] (https://github.com/fbonetti). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bus-o-matic'
+```
+
+## Setup
+
+Before using Bus-o-matic, you'll need to request an API key from the [Port 
+Authority] (http://www.portauthority.org/paac/CompanyInfoProjects/DeveloperResources.aspx). 
+Require the gem and add your Port Authority API key. This can be put in an initializer.
+
+```ruby
+require 'bus-o-matic'
+
+key = "xxxxxxxxxxxxxxxxxxxx"
+PIT::Busomatic.key = key
+```
+
+## Usage
+
+The following examples illustrate how you can use Bus-o-matic.
+
+### Routes and Stops
+
+Bus-o-matic can list all of the routes availabe in the Port Authority API. 
+You can also get the directions for a particular route, and a list all of 
+the stops on a route.
+
+```ruby
+
+# Retrieve a list of all available routes
+PIT::Busomatic.routes
+
+# Retrieve the available directions for the specified route (INBOUND, OUTBOUND, etc.)
+PIT::Busomatic.directions :rt => 16
+
+# Retrieve the stops for Route 16 heading Inbound
+PIT::Busomatic.stops :rt => 16, :dir => :INBOUND
+```
+
+Note that the available directions (INBOUND, etc.) appear to be case sensitive. 
+
+### Patterns
+
+Bus-o-matic can retrieve a set of geo-positional points for a route, something 
+known as a "pattern." Patterns can be used to outline routes on maps.
+
+```ruby
+# Retrieve the pattern for Route 16
+PIT::Busomatic.patterns :rt => 16
+```
+
+### Vehicles
+
+Bus-o-matic can find all of the vehicles that are currently active on a route, 
+or retrieve information about a specific vehicle. The first step is finding 
+the active vehicles on a route.
+
+```ruby
+# Returns an array of vehicles that are active on Route 16.
+PIT::Busomatic.vehicles :rt => 16
+```
+
+You can retrieve information for vehicles on more than one route. Up to 10 
+routes can be specified at once.
+
+```ruby
+# Returns an array of vehicles that are active on Routes 13, 16, and 17.
+PIT::Busomatic.vehicles :rt => ["16","17","13"]
+```
+
+You can also find information about one or more vehicles that are currently
+active. Up to 10 vehicle IDs can be specified at once.
+
+```ruby
+# Returns information about a specific vehicle.
+PIT::Busomatic.vehicles :vid => 6013
+
+# Returns information about multiple vehicles.
+PIT::Busomatic.vehicles :vid => ["6013","6001"]
+```
+
+Note that you cannot combine both `rt` and `vid` parameters in a single request.
+
+### Predicted Arrival Times
+
+Bus-o-matic can return predicted arrival times for one or more buses. Up to 10 
+vehicle IDs can be specified at once. Note that you cannot combine both `vid` 
+and `stpid` parameters in a single request.
+
+```ruby
+# Returns predictions for a single vehicle.
+PIT::Busomatic.predictions :vid => 5629
+
+# Returns predictions for multiple vehicles. 
+PIT::Busomatic.predictions :vid => ["5629","5604"]
+```
+
+You can also retrieve predictions for one or more stops. Up to 10 stop IDs can 
+be specified at once. You can combine the `stpid` and `rt` parameters, as shown
+below.
+
+```ruby
+
+# Returns predictions for all buses on all applicable routes for single stop.
+PIT::Busomatic.predictions :stpid => 1326
+
+# Returns predictions for multiple stops.
+PIT::Busomatic.predictions :stpid => ["1326","18320","18563"]
+
+# Returns predictions for all buses on Route 16 for a single stop 
+PIT::Busomatic.predictions :stpid => 1326, :rt => 16
+
+# Returns predictions for buses on Routes 13, 16, and 17 for Stop 1326.
+PIT::Busomatic.predictions :stpid => 1326, :rt => ["13","16","17"]
+```
+
+### System Time
+
+Returns the official Port Authority API system time. 
+
+```ruby
+PIT::Busomatic.time
+```
+
+
+## Contributing
+
+This is my first Ruby gem, so I'd appreciate you reporting issues or creating 
+pull requests. 
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## License
+
+Copyright (c) 2015 Matt Cone and 2013 fbonetti.
+
+The MIT License (MIT). See the LICENSE.txt file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bus-o-matic.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+
+  s.name          = "bus-o-matic"
+  s.version       = "0.0.3"
+  s.authors       = ["Matt Cone"]
+  s.email         = ["matt@macinstruct.com"]
+  s.summary       = %q{A wrapper for the Pittsburgh Port Authority TrueTime Bus API}
+  s.description   = %q{A wrapper for the Pittsburgh Port Authority TrueTime Bus API}
+  s.homepage      = "https://github.com/mattcone/bus-o-matic"
+  s.license       = "MIT"
+  s.platform = Gem::Platform::RUBY
+  
+  s.require_paths = ['lib']
+  s.files = Dir.glob("**/*").reject { |x| File.directory?(x) }
+  s.add_dependency "httparty", '~> 0.10.2'
+  s.add_dependency "hashie", '~> 2.0'
+end

data/lib/bus-o-matic.rb

@@ -0,0 +1,133 @@
+require 'httparty'
+require 'hashie'
+require 'time'
+  
+class Array
+  def self.wrap(object)
+    if object.nil?
+      []
+    elsif object.respond_to?(:to_ary)
+      object.to_ary || [object]
+    else
+      [object]
+    end
+  end
+end
+
+module PIT
+  class Busomatic
+    include HTTParty
+    base_uri 'http://realtime.portauthority.org/bustime/api/v2/'
+    format :xml
+    @@key = nil
+    
+    def self.time(options={})
+      options.merge!({
+        :key => @@key
+      })
+      response = get("/gettime", :query => options)['bustime_response']
+      check_for_errors response['error']
+
+      Time.parse response['tm']
+    end
+    
+    def self.vehicles(options={})
+      options.merge!({
+        :key => @@key
+      })
+      options[:vid] = options[:vid].join(',') if options[:vid].kind_of?(Array)
+      options[:rt] = options[:rt].join(',') if options[:rt].kind_of?(Array)
+
+      response = get("/getvehicles", :query => options)['bustime_response']
+      check_for_errors response['error']
+
+      results = Array.wrap response['vehicle']
+      results.map { |result| Hashie::Mash.new result } unless results.nil?
+    end
+    
+    def self.routes(options={})
+      options.merge!({
+        :key => @@key
+      })
+      response = get("/getroutes", :query => options)['bustime_response']
+      check_for_errors response['error']
+
+      results = Array.wrap response['route']
+      Hash[ results.map { |result| [result['rt'], result['rtnm']] } ] unless results.nil?
+    end
+
+    def self.directions(options={})
+      options.merge!({
+        :key => @@key
+      })
+      response = get("/getdirections", :query => options)['bustime_response']
+      check_for_errors response['error']
+
+      results = Array.wrap response['dir']
+      results.map { |direction| direction.split(/ /)[0] } unless results.nil?
+    end
+    
+    def self.stops(options={})
+      options.merge!({
+        :key => @@key
+      })
+      response = get("/getstops", :query => options)['bustime_response']
+      check_for_errors response['error']
+
+      results = Array.wrap response['stop']
+      results.map { |result| Hashie::Mash.new result } unless results.nil?
+    end
+    
+    def self.patterns(options={})
+      options.merge!({
+        :key => @@key
+      })
+      options['pid'] = options['pid'].join(',') if options['pid'].kind_of?(Array)
+
+      response = get("/getpatterns", :query => options)['bustime_response']
+      check_for_errors response['error']
+
+      results = Array.wrap response['ptr']
+      results.map { |result| Hashie::Mash.new result } unless results.nil?
+    end
+    
+    def self.predictions(options={})
+      options.merge!({
+        :key => @@key
+      })
+      options[:stpid] = options[:stpid].join(',') if options[:stpid].kind_of?(Array)
+      options[:rt] = options[:rt].join(',') if options[:rt].kind_of?(Array)
+      options[:vid] = options[:vid].join(',') if options[:vid].kind_of?(Array)
+
+      response = get("/getpredictions", :query => options)['bustime_response']
+      check_for_errors response['error']
+
+      results = Array.wrap response['prd']
+      results.map { |result| Hashie::Mash.new result } unless results.nil?
+    end
+    
+    def self.bulletins(options={})
+      options.merge!({
+        :key => @@key
+      })
+      options['rt'] = options['rt'].join(',') if options['rt'].kind_of?(Array)
+      options['stpid'] = options['stpid'].join(',') if options['stpid'].kind_of?(Array)
+
+      response = get("/getservicebulletins", :query => options)['bustime_response']
+      check_for_errors response['error']
+
+      results = Array.wrap response['sb']
+      results.map { |result| Hashie::Mash.new result } unless results.nil?
+    end
+
+    def self.key=(key)
+      @@key = key
+    end
+    
+    private
+
+    def self.check_for_errors(error)
+      puts "API ERROR: #{error['msg']}" if error
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bus-o-matic
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Matt Cone
@@ -44,7 +44,15 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bus-o-matic-0.0.1.gem
+- bus-o-matic-0.0.2.gem
+- bus-o-matic.gemspec
+- lib/bus-o-matic.rb
 homepage: https://github.com/mattcone/bus-o-matic
 licenses:
 - MIT