ptv_timetable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0812a3b2e0e3b1bde01c8965648fdfb0b3a1cecb
+  data.tar.gz: 98633cb2c33caad724bd482dcc3ec92ac26eb940
+SHA512:
+  metadata.gz: 0e43c49aa5d7ca56912e30697aa64e813139cdb3d07827f1ba849315877d5b0c93898141d2b949282ce7554721d420664d58571b8ddfdfc03bb756fdc9a56508
+  data.tar.gz: 7c79358dd7d869156091b5f88c0c53345be68840e44d367186a572ad0ad113d4f94eea189d14e65819cab3a856707190749945be9ef28d59cb23405455ff573d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Neil Ang
+
+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,115 @@
+# PTV Timetable Gem [![Build Status](https://secure.travis-ci.org/neilang/ptv_timetable.png?branch=master)](https://travis-ci.org/neilang/ptv_timetable)
+
+A ruby gem for interacting with the [PTV timetable API](https://www.data.vic.gov.au/raw_data/ptv-timetable-api/6056) version 2.0.
+
+## Usage
+
+To use this gem you will need to request a `devid` and `secret key`. Instructions on how to do this are available in the [API specificationn](https://www.data.vic.gov.au/raw_data/ptv-timetable-api/6056).
+
+
+For all API calls you will need a valid _devid_ and _secret_key_.
+
+```ruby
+api = PtvTimetable::API.new('devid', 'secret_key')
+
+```
+
+### Health Check
+
+The Health Check will test a number of the key services that deliver the PTV Timetable API and let you know if there are any problems with connectivity, availability or reachability.
+
+```ruby
+api.health_check
+```
+
+N.B. Calling the Health Check API at the start of each sequence of APIs flushes out any system problems.
+
+### Stops Nearby
+
+Stops Nearby returns up to 30 stops nearest to a specified coordinate.
+
+```ruby
+api.near_me(-37.82392124423254, 144.9462017431463)
+```
+
+### Transport POIs by Map
+
+Transport POIs by Map returns a set of locations consisting of stops and/or myki ticket outlets (collectively known as points of interest) within a region demarcated on a map through a set of latitude and longitude coordinates.
+
+```ruby
+api.points_of_interest(-37.82205143151239, 144.9779160007277, -37.81393456848758, 144.9859159992726)
+```
+
+### Search
+
+The Search API returns all stops and lines that match the input search text.
+
+```ruby
+api.search('Alamein')
+```
+
+### Broad Next Departures
+
+Broad Next Departures returns the next departure times at a prescribed stop irrespective of the line and direction of the service.
+
+For example, if the stop is Camberwell Station, Broad Next Departures will return the times for all three lines (Belgrave, Lilydale and Alamein) running in both directions (towards the city and away from the city).
+
+```ruby
+api.broad_next_departures(PtvTimetable::BUS, 28905)
+```
+
+# Specific Next Departures
+
+Specific Next Departures returns the times for the next departures at a prescribed stop for a specific mode, line and direction.
+
+For example, if the stop is Camberwell Station, Specific Next Departures returns only the times
+
+```ruby
+api.specific_next_departures(PtvTimetable::BUS, 5111, 2896, 28905, 515)
+```
+
+### Stopping Pattern
+
+The Stopping Pattern API returns the stopping pattern for a specific run (i.e. transport service) from a prescribed stop at a prescribed time. The stopping pattern is comprised of timetable values ordered by stopping order.
+
+```ruby
+api.stopping_pattern(PtvTimetable::BUS, 1464, 1108, '2013-11-13T05:24:25Z')
+```
+
+### Stops on a Line
+
+The Stops on a Line API returns a list of all the stops for a requested line, ordered by location name.
+
+```ruby
+api.line_stops(PtvTimetable::BUS, 1818)
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ptv_timetable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ptv_timetable
+
+
+## Contributing
+
+1. Fork it ( http://github.com/neilang/ptv_timetable/fork )
+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 new Pull Request
+
+## Disclaimer & Attribution
+
+This ruby gem and it's developers are in no way affiliated with Public Transport Victoria (PTV). Any trademarks referred to are the property of their respective trademark holders. We declare no affiliation, sponsorship, nor any partnerships with any registered trademarks.
+
+The API specification titled "Timetable API" was released under the Creative Commons license. I attribute this publication - _Source: Licensed from Public Transport Victoria under a Creative Commons Attribution 3.0 Australia Licence._

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec
+

data/lib/ptv_timetable.rb

@@ -0,0 +1,12 @@
+require 'ptv_timetable/version'
+require 'ptv_timetable/api'
+
+module PtvTimetable
+
+  TRAIN      = 0
+  TRAM       = 1
+  BUS        = 2
+  VLINE      = 3
+  NIGHTRIDER = 4
+
+end

data/lib/ptv_timetable/api.rb

@@ -0,0 +1,61 @@
+require 'httparty'
+require 'time'
+
+module PtvTimetable
+
+  class API
+    include HTTParty
+
+    base_uri 'http://timetableapi.ptv.vic.gov.au'
+
+    def initialize(devid, secret_key)
+      @devid      = devid
+      @secret_key = secret_key
+    end
+
+    def health_check(timestamp=Time.now.utc.iso8601)
+      signed_request("/v2/healthcheck?timestamp=#{timestamp}")
+    end
+
+    def near_me(latitude, longitude)
+      signed_request("/v2/nearme/latitude/#{latitude}/longitude/#{longitude}")
+    end
+
+    def points_of_interest(latitude1, longitude1, latitude2, longitude2)
+      poi        = '0,1,2,3,4,100'
+      grid_depth = 3
+      limit      = 6
+      signed_request("/v2/poi/#{poi}/lat1/#{latitude1}/long1/#{longitude1}/lat2/#{latitude2}/long2/#{latitude2}/griddepth/#{grid_depth}/limit/#{limit}")
+    end
+
+    def search(text)
+      signed_request("/v2/search/#{text}")
+    end
+
+    def broad_next_departures(mode, stop, limit=5)
+      signed_request("/v2/mode/#{mode}/stop/#{stop}/departures/by-destination/limit/#{limit}")
+    end
+
+    def specific_next_departures(mode, line, stop, direction, limit=5, utc=Time.now.utc.iso8601)
+      signed_request("/v2/mode/#{mode}/line/#{line}/stop/#{stop}/directionid/#{direction}/departures/all/limit/#{limit}?for_utc=#{utc}")
+    end
+
+    def stopping_pattern(mode, run, stop, utc=Time.now.utc.iso8601)
+      signed_request("/v2/mode/#{mode}/run/#{run}/stop/#{stop}/stopping-pattern?for_utc=#{utc}")
+    end
+
+    def line_stops(mode, line)
+      signed_request("/v2/mode/#{mode}/line/#{line}/stops-for-line")
+    end
+
+    private
+
+    def signed_request(request_path)
+      request_path += (request_path.include?('?') ? '&' : '?') + "devid=#{@devid}"
+      signature = Digest::HMAC.hexdigest(request_path, @secret_key, Digest::SHA1).upcase
+      self.class.get("#{request_path}&signature=#{signature}").parsed_response
+    end
+
+  end
+
+end

data/lib/ptv_timetable/version.rb

@@ -0,0 +1,3 @@
+module PtvTimetable
+  VERSION = "0.0.1"
+end

data/ptv_timetable.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ptv_timetable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ptv_timetable"
+  spec.version       = PtvTimetable::VERSION
+  spec.authors       = ["Neil Ang"]
+  spec.email         = ["neilang@gmail.com"]
+  spec.summary       = %q{A ruby gem for interacting with the PTV timetable API.}
+  spec.description   = %q{A ruby gem for interacting with the PTV timetable API.}
+  spec.homepage      = "https://github.com/neilang/ptv_timetable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "webmock", "~> 1.17.4"
+
+  spec.add_dependency "httparty", "~> 0.13.0"
+end

data/spec/api_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe PtvTimetable::API do
+
+  let(:subject){ PtvTimetable::API.new('devid', 'secret') }
+
+  it "should treat the devid and secret as required" do
+    expect{
+      PtvTimetable::API.new
+    }.to raise_error(ArgumentError)
+  end
+
+  it 'can request a health check' do
+    stub = stub_request(:get, "http://timetableapi.ptv.vic.gov.au/v2/healthcheck?devid=devid&signature=3258AF3DE4CB58FD54F13445D149560B6E9B923C&timestamp=2013-11-13T05:24:25Z")
+    subject.health_check('2013-11-13T05:24:25Z')
+    stub.should have_been_requested
+  end
+
+  it 'can search near me' do
+    stub = stub_request(:get, "http://timetableapi.ptv.vic.gov.au/v2/nearme/latitude/-37.82392124423254/longitude/144.9462017431463?devid=devid&signature=DA23BFC88EB80BF3EB0AC59AF5846159C0F6EFE2")
+    subject.near_me(-37.82392124423254, 144.9462017431463)
+    stub.should have_been_requested
+  end
+
+  it 'can find points of interest' do
+    stub = stub_request(:get, "http://timetableapi.ptv.vic.gov.au/v2/poi/0,1,2,3,4,100/lat1/-37.82205143151239/long1/144.9779160007277/lat2/-37.81393456848758/long2/-37.81393456848758/griddepth/3/limit/6?devid=devid&signature=F94A5E7774028E67B6684B17E1C49886C5BEFBC9")
+    subject.points_of_interest(-37.82205143151239, 144.9779160007277, -37.81393456848758, 144.9859159992726)
+    stub.should have_been_requested
+  end
+
+  it 'can perform a general search' do
+    stub = stub_request(:get, "http://timetableapi.ptv.vic.gov.au/v2/search/Alamein?devid=devid&signature=17E15574BF165335DD054E02FC5F8C5C33189262")
+    subject.search('Alamein')
+    stub.should have_been_requested
+  end
+
+  it 'can lookup broad next departures' do
+    stub = stub_request(:get, "http://timetableapi.ptv.vic.gov.au/v2/mode/2/stop/28905/departures/by-destination/limit/5?devid=devid&signature=8AB75EF37D089BDD055327FB8559350215CFBFB4")
+    subject.broad_next_departures(PtvTimetable::BUS, 28905)
+    stub.should have_been_requested
+  end
+
+  it 'can lookup specific next departures' do
+    stub = stub_request(:get, "http://timetableapi.ptv.vic.gov.au/v2/mode/2/line/5111/stop/2896/directionid/28905/departures/all/limit/515?devid=devid&for_utc=2013-11-13T05:24:25Z&signature=F373732C2A31DE7B3053FE26D3C5C8449F1C980A")
+    subject.specific_next_departures(PtvTimetable::BUS, 5111, 2896, 28905, 515, '2013-11-13T05:24:25Z')
+    stub.should have_been_requested
+  end
+
+  it 'can lookup a stopping pattern' do
+    stub = stub_request(:get, "http://timetableapi.ptv.vic.gov.au/v2/mode/2/run/1464/stop/1108/stopping-pattern?devid=devid&for_utc=2013-11-13T05:24:25Z&signature=345F61EE77EFD7D25E56672D84CFC1D37C794EF5")
+    subject.stopping_pattern(PtvTimetable::BUS, 1464, 1108, '2013-11-13T05:24:25Z')
+    stub.should have_been_requested
+  end
+
+  it 'can lookup stops on a line' do
+    stub = stub_request(:get, "http://timetableapi.ptv.vic.gov.au/v2/mode/2/line/1818/stops-for-line?devid=devid&signature=42FE7A31C9474B199DC38BE4E23ADA606878DF6A")
+    subject.line_stops(PtvTimetable::BUS, 1818)
+    stub.should have_been_requested
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'ptv_timetable'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: ptv_timetable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Neil Ang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.4
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: A ruby gem for interacting with the PTV timetable API.
+email:
+- neilang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ptv_timetable.rb
+- lib/ptv_timetable/api.rb
+- lib/ptv_timetable/version.rb
+- ptv_timetable.gemspec
+- spec/api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/neilang/ptv_timetable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A ruby gem for interacting with the PTV timetable API.
+test_files:
+- spec/api_spec.rb
+- spec/spec_helper.rb