OGTraf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6791fcdbb6bee86906c6e14792a247e2daa29eb96c4bc95a443cb7c18deed138
+  data.tar.gz: bbe5d1094ea389bfa067477011c5e759faa9227734689131ddac263d2953807d
+SHA512:
+  metadata.gz: 38f6ed583d443925f144940f272d7bbcdcb7fd93199f25ca5cf6f774c43d41072f53a77c1288c2da50b287efe31d98d14fa97ef936d92ba4013fccefb7117be4
+  data.tar.gz: f0b0dbffcced85e577061ae99e699eed2c22b38b4bed086d49180e25e738f04a9891b7a572c4ebfce0ebcb789509dd328d2a58eff56fbc8145454bcb9f94262d

data/bin/ogtraf

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+require 'ogtraf'
+require 'time'
+require 'thor'
+
+# Implements the OGTraf CLI
+class OGTrafCLI < Thor
+  class_option :verbose, type: :boolean, default: false, aliases: '-v'
+
+  desc 'journey FROM TO', 'Plans a journey from FROM to TO'
+  option :walk, default: false, type: :boolean, desc: 'Is walking allowed?'
+  option :num, default: 5, type: :numeric, desc: 'Number of entries wanted',
+               aliases: '-n'
+
+  option :time, default: nil, type: :string, desc: 'Date+Time to search from',
+                aliases: '-t'
+
+  def journey(from, to)
+    from_s = OGTraf.stops(from).first
+    to_s = OGTraf.stops(to).first
+    time = Time.now
+    time = Time.parse(options[:date]) if options[:date]
+
+    puts "Next #{options[:num]} journeys from #{from_s} to #{to_s} after #{time}:"
+
+    shown = 0
+    until shown >= options[:num]
+      avail = OGTraf.journey(
+        from, to,
+        date: time,
+        span: :after,
+        walk: options[:walk],
+        verbose: options[:verbose]
+      )
+
+      avail.each do |j|
+        next if j.departure < Time.now
+
+        time_left = j.departure - Time.now
+
+        hours = (time_left / 3600).floor
+        minutes = ((time_left % 3600) / 60).floor
+
+        puts
+        puts "In #{format('%02d:%02d', hours, minutes)}:" if hours > 0
+        puts "In #{minutes} minutes:" if hours.zero?
+
+        j.connections.each do |c|
+          if c.line.walk
+            puts format('- (%s - %s) walk to %s',
+                        c.departure.strftime('%H:%M'),
+                        c.arrival.strftime('%H:%M'),
+                        c.to.to_s)
+          else
+            puts format('- (%s - %s) %s from %s to %s',
+                        c.departure.strftime('%H:%M'),
+                        c.arrival.strftime('%H:%M'),
+                        c.line.to_s,
+                        c.from.to_s,
+                        c.to.to_s)
+          end
+        end
+
+        shown += 1
+        break if shown >= options[:num]
+
+        time = j.departure
+      end
+    end
+  end
+
+  desc 'stop STOP', 'Finds a stop by the given name'
+  option :limit, default: 5, type: :numeric, desc: 'Number of entries wanted',
+                 aliases: '-l'
+  def stop(name)
+    puts 'Found stops:'
+    puts OGTraf.stops(
+      name,
+      verbose: options[:verbose]
+    ).take(options[:limit]).map(&:name)
+  end
+end
+
+OGTrafCLI.start

data/lib/ogtraf.rb

@@ -0,0 +1,141 @@
+require 'cgi'
+require 'json'
+require 'logging'
+require 'net/http'
+require 'ogtraf/connection'
+require 'ogtraf/departure'
+require 'ogtraf/deviation'
+require 'ogtraf/journey'
+require 'ogtraf/line'
+require 'ogtraf/stop'
+require 'ogtraf/version'
+require 'uri'
+
+module OGTraf
+  module Priority
+    SHORTEST_TIME = 0
+    FEWER_CHANGES = 1
+  end
+
+  def self.stops(name, options = {})
+    query = {
+      pointType: nil
+    }.merge(options)
+
+    query[:q] = CGI.escape name.to_s
+
+    uri = URI('https://rest.ostgotatrafiken.se/stops/Find')
+    uri.query = URI.encode_www_form(query)
+
+    j = run_query(uri)
+    j.map { |v| Stop.new v }
+  end
+
+  def self.departures(departure_start, options = {})
+    query = {
+      date: nil,
+      delay: 0,
+      maxNumberOfResultPerColumn: 8,
+      columnsPerPageCount: 1,
+      pagesCount: 1,
+      lines: nil,
+      trafficTypes: nil,
+      stopPoints: nil
+    }.merge(options)
+
+    departure_start = stops(departure_start).first unless departure_start.is_a? Stop
+
+    raise 'Date must be a Time' unless query[:date].is_a? Time
+
+    query.merge!(
+      date: query[:date].strftime('%Y-%m-%d+%H:%M'),
+      stopAreaId: departure_start.id
+    )
+
+    uri = URI('https://rest.ostgotatrafiken.se/stopdepartures/departures')
+    uri.query = URI.encode_www_form(query)
+
+    j = run_query(uri)
+    j[:groups].first.map { |v| Departure.new v[:Line] }
+  end
+
+  def self.journey(journey_start, journey_end, options = {})
+    query = {
+      date: Time.now,
+      direction: 0,
+      span: :default,
+      traffictypes: 0,
+      changetime: 0,
+      priority: Priority::SHORTEST_TIME,
+      walk: false
+    }.merge(options)
+
+    journey_start = stops(journey_start).first unless journey_start.is_a? Stop
+    journey_end = stops(journey_end).first unless journey_end.is_a? Stop
+
+    raise 'Date must be a Time' unless query[:date].is_a? Time
+
+    query.merge!(
+      time: query[:date].strftime('%H:%M'),
+      date: query[:date].strftime('%Y-%m-%d'),
+
+      startId: journey_start.id,
+      startType: journey_start.type,
+      startLl: journey_start.gps_ll,
+      startName: journey_start.name,
+      endId: journey_end.id,
+      endType: journey_end.type,
+      endLl: journey_end.gps_ll,
+      endName: journey_end.name
+    )
+
+    uri = URI('https://rest.ostgotatrafiken.se/journey/Find')
+    uri.query = URI.encode_www_form(query)
+
+    j = run_query(uri, error: true)
+    j[:Journeys].map { |v| Journey.new v }
+  end
+
+  def self.run_query(uri, _options = {})
+    logger.debug uri
+
+    h = Net::HTTP.new(uri.host, uri.port)
+    h.use_ssl = uri.scheme == 'https'
+
+    r = h.start do |http|
+      http.request(Net::HTTP::Get.new(uri))
+    end
+
+    logger.debug r
+
+    begin
+      j = JSON.parse(r.body, symbolize_names: true)
+
+      logger.debug j
+
+      raise j unless r.is_a? Net::HTTPSuccess
+
+      if j.is_a? Array
+        first = j.first
+        if first.key? :ErrorCode
+          raise first[:ErrorText] unless first[:ErrorCode].zero?
+        end
+      end
+
+      j
+    rescue JSON::ParserError
+      raise "HTTP #{r.code} Response with unparseable JSON."
+    end
+  end
+
+  def self.debug!
+    logger.level = :debug
+  end
+
+  def self.logger
+    @logger ||= Logging.logger[self].tap do |logger|
+      logger.add_appenders Logging.appenders.stdout
+      logger.level = :info
+    end
+  end
+end

data/lib/ogtraf/connection.rb

@@ -0,0 +1,29 @@
+require 'time'
+
+module OGTraf
+  class Connection
+    attr_reader :departure, :real_departure, :arrival, :real_arrival, :from,
+                :to, :line, :deviations
+
+    def initialize(datablock)
+      @departure = Time.parse datablock[:DepDateTime]
+      @real_departure = @departure
+
+      @arrival = Time.parse datablock[:ArrDateTime]
+      @real_arrival = @arrival
+
+      if datablock[:RealTime] && datablock[:RealTime][:RealTimeInfo]
+        datablock[:RealTime][:RealTimeInfo].each do |rti|
+          @departure += rti[:DepTimeDeviation] * 60
+          @arrival += rti[:ArrTimeDeviation] * 60
+        end
+      end
+
+      @from = Stop.new datablock[:From]
+      @to = Stop.new datablock[:To]
+
+      @line = Line.new datablock[:Line]
+      @deviations = datablock[:Deviations].map { |d| Deviation.new d }
+    end
+  end
+end

data/lib/ogtraf/departure.rb

@@ -0,0 +1,15 @@
+module OGTraf
+  #
+  class Departure
+    attr_reader :from, :to, :time, :real_time, :name, :stops
+
+    def initialize(datablock)
+      @from = datablock[:from]
+      @to = datablock[:to]
+      @time = datablock[:time]
+      @real_time = datablock[:real_time]
+      @name = datablock[:name]
+      @stops = datablock[:stops]
+    end
+  end
+end

data/lib/ogtraf/deviation.rb

@@ -0,0 +1,29 @@
+require 'time'
+
+module OGTraf
+  #
+  class Deviation
+    attr_reader :header, :summary, :details, :text, :from, :to
+
+    def initialize(datablock)
+      @header = datablock[:Header]
+      @summary = datablock[:Summary] || datablock[:PublicNote]
+      @details = datablock[:Details]
+      @text = datablock[:ShortText]
+
+      @from = Time.now
+      @to = Time.now
+
+      datablock[:DeviationScopes].each do |dev|
+        from = Time.parse dev[:FromDateTime]
+        @from = from if @from > from
+        to = Time.parse dev[:ToDateTime]
+        @to = to if @to < to
+      end
+    end
+
+    def to_s
+      @header.to_s
+    end
+  end
+end

data/lib/ogtraf/journey.rb

@@ -0,0 +1,42 @@
+require 'time'
+
+module OGTraf
+  #
+  class Journey
+    attr_reader :departure, :arrival, :from, :to,
+                :real_departure, :real_arrival,
+                :connections
+
+    def initialize(datablock)
+      @real_departure = Time.parse(datablock[:Departure])
+      @real_arrival = Time.parse(datablock[:Arrival])
+
+      @from = Stop.new datablock[:UsedStartPlace]
+      @to = Stop.new datablock[:UsedEndPlace]
+
+      @connections = datablock[:Routelinks].map { |r| Connection.new r }
+
+      @departure = @connections.first.departure
+      arrival_point = @connections.find { |c| c.to == @to }
+      @arrival = @real_arrival
+      @arrival = arrival_point.arrival unless arrival_point.nil?
+    end
+
+    def on_time?(side = :arr, allowed_drift = 60)
+      raise ArgumentError unless
+        %i[both dep departure arr arrival].include? side
+
+      if side == :both
+        return (@departure - @real_departure).abs < allowed_drift &&
+               (@arrival - @real_arrival).abs < allowed_drift
+      end
+
+      case side
+      when :dep, :departure
+        (@departure - @real_departure).abs < allowed_drift
+      when :arr, :arrival
+        (@arrival - @real_arrival).abs < allowed_drift
+      end
+    end
+  end
+end

data/lib/ogtraf/line.rb

@@ -0,0 +1,25 @@
+module OGTraf
+  #
+  class Line
+    attr_reader :name, :number, :note, :operator, :type, :towards, :train_nr,
+                :walk
+
+    def initialize(datablock)
+      @name = datablock[:LineName]
+      @number = datablock[:LineNrReal]
+      @note = datablock[:FootNote]
+      @operator = {
+        id: datablock[:OperatorId],
+        name: datablock[:OperatorName]
+      }
+      @type = datablock[:LineTypeName].to_sym
+      @towards = datablock[:Towards]
+      @train_nr = datablock[:TrainNo]
+      @walk = datablock[:IsWalk]
+    end
+
+    def to_s
+      @name.to_s
+    end
+  end
+end

data/lib/ogtraf/stop.rb

@@ -0,0 +1,32 @@
+module OGTraf
+  #
+  class Stop
+    include Comparable
+    attr_reader :name, :id, :gps, :clean_name, :type
+
+    def initialize(datablock)
+      @name = datablock[:PlaceName]
+      @id = datablock[:Id]
+      if datablock.key?(:Ll) && !datablock[:Ll].nil?
+        @gps = {
+          lon: datablock[:Ll][0],
+          lat: datablock[:Ll][1]
+        }
+      end
+      @clean_name = datablock[:OgtStopUrlSegment]
+      @type = datablock[:OgtType].to_sym
+    end
+
+    def gps_ll
+      [@gps[:lon], @gps[:lat]].join ','
+    end
+
+    def to_s
+      @name.to_s
+    end
+
+    def <=>(other)
+      @id <=> other.id
+    end
+  end
+end

data/lib/ogtraf/version.rb

@@ -0,0 +1,3 @@
+module OGTraf
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: OGTraf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander "Ace" Olofsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+description: Allows querying Östgötatrafiken's APIs
+email: ace@haxalot.com
+executables:
+- ogtraf
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/ogtraf
+- lib/ogtraf.rb
+- lib/ogtraf/connection.rb
+- lib/ogtraf/departure.rb
+- lib/ogtraf/deviation.rb
+- lib/ogtraf/journey.rb
+- lib/ogtraf/line.rb
+- lib/ogtraf/stop.rb
+- lib/ogtraf/version.rb
+homepage: 
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Östgötatrafiken
+test_files: []