ptv_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12962ad93bc802a6ee52543a74783a9b86f164f5
+  data.tar.gz: 2c3fa04a09385c9b9f7c20730aa5b8d5058321fa
+SHA512:
+  metadata.gz: a96a3c1f8b12dbd3408533a6d0983f70eea1b694ee11ae4ac989bce367a0140c12a14a397c270c782763e8dd57f7b6ca02d726c18cdc11c65162a5b8dd6a6055
+  data.tar.gz: 56b9f454baf4cce225bf455056d8286bc1d12882a0ed3c4295b815b3a62840c466fe7d9e6609f6c2c67ce7c2c80346faf8363773610cf77ff52c2760ff387f8b

data/.gitignore

@@ -0,0 +1,3 @@
+vendor/*
+bin/*
+.bundle/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-mocks'
+end
+

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    ptv_api (0.01)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ptv_api!
+  rspec
+  rspec-mocks

data/README.md

@@ -0,0 +1 @@
+In all its ugly glory - Level 3 REST it aint.

data/lib/model/departure.rb

@@ -0,0 +1,14 @@
+class Departure
+  
+  require 'model/platform'
+  require 'model/run'
+  
+  attr_reader :platform, :run, :time
+  
+  def initialize departure
+    @platform = Platform.new(departure["platform"])
+    @run = Run.new(departure["run"])
+    @time = Time.parse(departure["time_timetable_utc"])
+  end
+  
+end

data/lib/model/direction.rb

@@ -0,0 +1,14 @@
+class Direction
+  
+  require 'model/line'
+  
+  attr_reader :line, :linedir_id, :direction_name
+  
+  def initialize direction
+    @line = Line.new(direction.delete("line"))
+    direction.each do |k,v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+  
+end

data/lib/model/line.rb

@@ -0,0 +1,14 @@
+class Line
+  
+  require 'model/transport_type'
+  
+  attr_reader :transport_type, :line_id, :line_name, :line_number
+  
+  def initialize args
+    @transport_type = TransportType.from_s args.delete("transport_type")
+    args.each do |k,v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+  
+end

data/lib/model/location.rb

@@ -0,0 +1,10 @@
+class Location
+  
+  attr_reader :lat, :long
+  
+  def initialize(lat, long)
+    @lat = lat
+    @long = long
+  end
+  
+end

data/lib/model/platform.rb

@@ -0,0 +1,12 @@
+class Platform
+  
+  require 'model/stop'
+  require 'model/direction'
+  
+  attr_reader :stop, :direction
+  
+  def initialize platform
+    @stop = Stop.new(platform["stop"])
+    @direction = Direction.new(platform["direction"])
+  end
+end

data/lib/model/run.rb

@@ -0,0 +1,14 @@
+class Run
+  
+  require 'model/transport_type'
+  
+  attr_reader :transport_type, :run_id, :destination_id, :destination_name
+  
+  def initialize run
+    @transport_type =  TransportType.from_s run.delete("transport_type")
+    run.each do |k,v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+  
+end

data/lib/model/stop.rb

@@ -0,0 +1,16 @@
+class Stop
+  
+  require 'model/transport_type'
+  require 'model/location'
+  
+  attr_reader :suburb, :transport_type, :location_name, :location, :stop_id
+  
+  def initialize(args)
+    @transport_type =  TransportType.from_s args.delete("transport_type")
+    @location = Location.new(args.delete("lat"), args.delete("long"))
+    args.each do |k,v|
+      instance_variable_set("@#{k}", v) unless v.nil?
+    end
+  end
+  
+end

data/lib/model/transport_type.rb

@@ -0,0 +1,37 @@
+class TransportType
+  
+  class Train
+    def id 
+      0 
+    end
+  end
+  
+  class Tram
+    def id 
+      1 
+    end
+  end
+  
+  class Bus
+    def id 
+      2 
+    end
+  end
+  
+  class Vline
+    def id 
+      3 
+    end
+  end
+  
+  class Nightrider
+    def id 
+      4 
+    end
+  end
+  
+  def self.from_s transport_type
+    const_get("TransportType::#{[transport_type.slice(0).capitalize, transport_type.slice(1..-1)].join}").new
+  end
+  
+end

data/lib/ptv_api.rb

@@ -0,0 +1,46 @@
+class PTVApi
+  
+  require 'open-uri'
+  require 'openssl'
+  require 'json'
+  require 'model/stop'
+  require 'model/departure'
+  
+  attr_reader :dev_id, :key
+  
+  def initialize dev_id, key
+    @dev_id = dev_id
+    @key = key
+  end
+  
+  def healthcheck
+    send_request "/v2/healthcheck"
+  end 
+  
+  def stops_near_me location
+    response = send_request "/v2/nearme/latitude/#{location.lat}/longitude/#{location.long}"
+    response.map { |result| Stop.new(result["result"]) }
+  end
+  
+  def broad_next_departures stop, number_of_results
+    response = send_request "/v2/mode/#{stop.transport_type.id}/stop/#{stop.stop_id}/departures/by-destination/limit/#{number_of_results}"
+    response["values"].map { |departure| Departure.new(departure) }
+  end
+  
+  private 
+  
+  attr_writer :dev_id, :key
+  
+  def send_request path
+    uri = URI::HTTP.build({ 
+      :scheme => "http", 
+      :host => "timetableapi.ptv.vic.gov.au", 
+      :path => path, 
+      :query => "devid=#{@dev_id}"})
+      
+    signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA1.new, @key, uri.path + "?" + uri.query)
+    uri.query = uri.query + "&signature=#{signature}"
+    JSON.parse(open(uri).read)
+  end
+  
+end

data/ptv_api.gemspec

@@ -0,0 +1,19 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "ptv_api"
+  s.version     = '0.0.2'
+  s.authors     = ["algrimes"]
+  s.email       = [""]
+  s.homepage    = "http://www.github.com/algrimes/ptv-api-ruby"
+  s.summary     = %q{Ruby client for PTV Timetable API}
+  s.description = %q{ }
+
+  s.rubyforge_project = "ptv_api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+end

data/spec/ptv_api_spec.rb

@@ -0,0 +1,64 @@
+require 'ptv_api'
+require 'json'
+require 'model/location'
+require 'model/stop'
+require 'open-uri'
+
+describe "ptv api" do
+  
+  before do
+    @devid = "my-devid"
+    @key = "my-key"
+    @api = PTVApi.new(@devid, @key)
+  end
+  
+  it "can perform the healthcheck" do
+    response = @api.healthcheck
+    expect response.include? "securityTokenOK"
+  end
+  
+  it "can get stops near you" do
+    response = double("Object", :read => [
+      {"result" => { "stop_id" => 123, "transport_type" => "tram" }},
+      {"result" => { "stop_id" => 456, "transport_type" => "train" }}
+    ].to_json)
+    
+    expect(OpenURI).to receive(:open_uri).and_return(response)
+    
+    stops = @api.stops_near_me Location.new("123.2443", "-64.432")
+    
+    expect(stops[0].transport_type).to be_a(TransportType::Tram)
+    expect(stops[0].stop_id).to be(123)
+    expect(stops[1].transport_type).to be_a(TransportType::Train)
+    expect(stops[1].stop_id).to be(456)
+  end 
+  
+  it "can get broad next departures" do
+    response = double("Object", :read => {"values" => [
+      "platform" => {
+        "stop" => {
+          "transport_type" => "train"
+        },
+        "direction" => {
+          "line" => {
+            "transport_type" => "train"              #WTF...
+          }
+        }
+      },
+      "run" => {
+        "transport_type" => "train"
+      },
+      "time_timetable_utc" => "2020-01-10T14:30Z"
+    ]}.to_json)
+    
+    expect(OpenURI).to receive(:open_uri).and_return(response)
+    
+    departures = @api.broad_next_departures Stop.new({"stop_id" => 123, "transport_type" => "tram" }), 5
+    
+    expect(departures[0].platform.stop.transport_type).to be_a(TransportType::Train)
+    expect(departures[0].platform.direction.line.transport_type).to be_a(TransportType::Train)
+    expect(departures[0].run.transport_type).to be_a(TransportType::Train)
+    expect(departures[0].time.year).to be(2020)
+  end
+  
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: ptv_api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- algrimes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-10 00:00:00.000000000 Z
+dependencies: []
+description: " "
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/model/departure.rb
+- lib/model/direction.rb
+- lib/model/line.rb
+- lib/model/location.rb
+- lib/model/platform.rb
+- lib/model/run.rb
+- lib/model/stop.rb
+- lib/model/transport_type.rb
+- lib/ptv_api.rb
+- ptv_api.gemspec
+- spec/ptv_api_spec.rb
+homepage: http://www.github.com/algrimes/ptv-api-ruby
+licenses: []
+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: ptv_api
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for PTV Timetable API
+test_files:
+- spec/ptv_api_spec.rb