bus_time 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 408ccbc3ddfb388706e1736aa4679c1e21965b73f76fd621a8a2b2b0709f66f3
+  data.tar.gz: 95b079015f6b070df1217976971cc8023bc4c5387fcdb65a3b042f0c3cd80171
+SHA512:
+  metadata.gz: 06b3e3402e7bc78c2d50a8a80e3e34c80ba5ce1fcda2827213a9a344779785ec621f28a5ead0e32d43fde55150415c552d355b1283f6abc5a1357c45131e3afa
+  data.tar.gz: 2d5d5240769ee10c3b342c67cfa765bdf483bf89ead7afb425607c9a1fb5c0b7878d77262c41e735af366e92be7b0e00f5c4a8bc9af1d790bdfc8e8710235ede

data/lib/bus_time/api.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+# BusTime API interface and response handling
+class BusTime::Api
+  SUPPORTED_ACTIONS = %w[
+    gettime getroutes getdirections
+    getstops getpredictions getservicebulletins
+  ].freeze
+
+  BASE_RESPONSE_PROP = "bustime-response"
+
+  def initialize(api_key, api_url = nil)
+    @@api_key = api_key
+    @api_url = api_url || "https://ctabustracker.com/bustime/api/v2"
+  end
+
+  def fetch_time
+    request("gettime")["tm"]
+  end
+
+  def fetch_routes
+    request("getroutes")["routes"].map do |route|
+      assemble_route(route)
+    end
+  end
+
+  def fetch_route(id)
+    route = fetch_routes.find { |returned_route| returned_route.id == id }
+
+    # Get route stops
+    route.directions.each do |dir|
+      route.stops += fetch_stops(route.id, dir)
+    end
+
+    route
+  end
+
+  def fetch_directions(route_id)
+    request("getdirections", { rt: route_id })["directions"].map do |direction|
+      direction["dir"]
+    end
+  end
+
+  def fetch_stops(route_id, direction)
+    fetch_stops_by_params(rt: route_id, dir: direction)
+  end
+
+  def fetch_predictions(stop_ids)
+    request("getpredictions", { stpid: stop_ids.join(",") })["prd"].map do |prediction|
+      assemble_prediction(prediction)
+    end
+  end
+
+  def fetch_bulletins
+    request("getservicebulletins")["sb"].map do |bulletin|
+      BusTime::Bulletin.new(
+        bulletin["nm"]
+      )
+    end
+  end
+
+  def fetch_routes_and_directions_and_stops
+    routes = fetch_routes
+
+    routes.each do |route|
+      route.directions.each do |dir|
+        route.stops += fetch_stops(route.id, dir)
+      end
+    end
+
+    routes
+  end
+
+  private
+
+  def request(action, params = {})
+    require "net/http"
+    require "json"
+
+    raise ArgumentError, "Invalid action: #{action}" unless SUPPORTED_ACTIONS.include?(action)
+
+    res = Net::HTTP.get_response(
+      request_uri(action, params)
+    )
+
+    case res
+    when Net::HTTPSuccess
+      handle_request_response(res)
+    end
+  end
+
+  def request_uri(action, params = {})
+    params[:key] = @@api_key
+    params[:format] = "json"
+    params[:locale] = "en"
+
+    uri = URI.parse("#{@api_url}/#{action}")
+    uri.query = URI.encode_www_form(params)
+    uri
+  end
+
+  def fetch_stops_by_params(params)
+    request("getstops", params)["stops"].map do |stop|
+      assemble_stop(stop, params)
+    end
+  end
+
+  def handle_request_response(response)
+    processed = JSON.parse(response.body)[BASE_RESPONSE_PROP]
+    if processed["error"]
+      raise ArgumentError, "Error: #{
+        processed['error'].map { |err| err['msg'] }.join(', ')
+      }"
+    end
+
+    processed
+  end
+
+  def assemble_route(route)
+    BusTime::BusRoute.new(route["rt"], route["rtnm"])
+  end
+
+  def assemble_stop(stop, params = {})
+    BusTime::BusStop.new(stop["stpid"], stop["stpnm"],
+                         coords: [stop["lat"], stop["lon"]],
+                         direction: params[:dir],
+                         routes: [params[:rt]])
+  end
+
+  def assemble_prediction(prediction)
+    BusTime::Prediction.new(prediction["rt"], prediction["rtdir"],
+                            prediction["stpid"],
+                            prediction["prdctdn"],
+                            arrives_at: DateTime.parse(prediction["prdtm"]),
+                            destination: prediction["des"],
+                            prediction_type: prediction["typ"],
+                            delayed: prediction["dly"],
+                            stop_name: prediction["stpnm"],
+                            vehicle_id: prediction["vid"],
+                            trip_id: prediction["tatripid"],
+                            generated_at: DateTime.parse(prediction["tmstmp"]))
+  end
+end

data/lib/bus_time/bulletin.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Service bulletins, including reroutes and stop closures
+class BusTime::Bulletin
+  attr_reader :name, :subject, :url, :updated_at
+
+  def initialize(name, subject, affected, updated_at, **opts)
+    @name = name
+    @subject = subject
+    @affected = affected
+    @updated_at = updated_at
+    @url = opts[:url]
+  end
+end

data/lib/bus_time/bus_route.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Service bus routes handling, including direction and stop retrieval
+# via `BusTime::Api`
+class BusTime::BusRoute
+  attr_reader :id, :name
+
+  attr_writer :directions, :stops
+
+  def initialize(id, name)
+    @id = id
+    @name = name
+  end
+
+  def directions
+    @directions || fetch_directions
+  end
+
+  def stops
+    @stops || fetch_stops
+  end
+
+  def fetch_directions
+    @directions = BusTime.api.fetch_directions(@id)
+  end
+
+  def fetch_stops
+    @directions.each do |direction|
+      @stops = BusTime.api.fetch_stops(@id, direction)
+    end
+
+    @stops
+  end
+
+  def display_name
+    "#{@id} - #{@name}"
+  end
+
+  def nearby_stops(_lat, _lon, _radius = DEFAULT_NEARBY_DISTANCE)
+    @stops.select do |stop|
+      # stop.distanceFrom(lat, lon) <= radius
+      stop
+    end
+  end
+end

data/lib/bus_time/bus_stop.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Service bus stop handling, including prediction retrieval via `BusTime::Api`
+class BusTime::BusStop
+  attr_reader :id, :name, :lat, :lon
+
+  attr_writer :predictions
+
+  attr_accessor :direction, :routes
+
+  def initialize(id, name, coords:, direction:, routes: [])
+    @id = id
+    @name = name
+    @lat, @lon = coords
+    @direction = direction
+
+    @routes = routes
+  end
+
+  def predictions
+    @predictions || fetch_predictions
+  end
+
+  def fetch_predictions
+    @predictions = BusTime.api.fetch_predictions(@id)
+  end
+
+  def distance_from(lat, lon)
+    require "geocoder"
+
+    Geocoder::Calculations.distance_between([@lat, @lon], [lat, lon])
+  end
+
+  def nearby?(lat, lon, max_nearby_distance = BusTime.nearby_distance)
+    distance_from(lat, lon) <= max_nearby_distance
+  end
+end

data/lib/bus_time/prediction.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Service bus stop prediction handling, including prediction retrieval
+# via `BusTime::Api`
+class BusTime::Prediction
+  attr_reader :time, :prediction_type, :delayed, :generated_at,
+              :route_id, :stop_id, :stop_name, :direction, :arrival_minutes,
+              :arrives_at, :stop_name, :vehicle_id, :destination,
+              :trip_id
+
+  def initialize(route_id, direction, stop_id, arrival_minutes, **opts)
+    @route_id = route_id
+    @stop_id = stop_id
+    @direction = direction
+    @arrival_minutes = arrival_minutes
+
+    @trip_id = opts[:trip_id]
+    @vehicle_id = opts[:vehicle_id]
+
+    @destination = opts[:destination]
+    @stop_name = opts[:stop_name]
+
+    @arrives_at = opts[:arrives_at]
+    @prediction_type = opts[:prediction_type] || "arrival"
+    @delayed = opts[:delayed] || false
+
+    @generated_at = opts[:generated_at] || DateTime.now
+  end
+
+  def delayed?
+    @delayed
+  end
+end

data/lib/bus_time/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BusTime
+  VERSION = "0.3.2"
+end

data/lib/bus_time.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# BusTimings
+
+# Interact with BusTime APIs to retrieve bus routing and prediction info from transit authorities such as the Chicago Transit Authority (CTA).
+#
+# @author Glenn Turner
+module BusTime
+  DEFAULT_TS_FORMAT = "%Y%m%d %h:%m"
+  MAX_NEARBY_DISTANCE = 0.5
+
+  def self.connection(api_key, api_url = nil)
+    @connection ||= BusTime::Api.new(api_key, api_url)
+  end
+
+  def self.nearby_distance
+    @nearby_distance || MAX_NEARBY_DISTANCE
+  end
+
+  def self.nearby_distance=(distance)
+    @nearby_distance = distance
+  end
+
+  def self.api
+    @connection
+  end
+end
+
+require "date"
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: bus_time
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- G Turner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geocoder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+description: "                        A BusTime API wrapper to retrieve bus routing
+  and prediction info from transit authorities such as the Chicago Transit Authority
+  (CTA).\n"
+email:
+- contact@iamgturner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bus_time.rb
+- lib/bus_time/api.rb
+- lib/bus_time/bulletin.rb
+- lib/bus_time/bus_route.rb
+- lib/bus_time/bus_stop.rb
+- lib/bus_time/prediction.rb
+- lib/bus_time/version.rb
+homepage: https://github.com/glennturner/bus_time
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: A BusTime API wrapper to retrieve bus routing and prediction info from transit
+  authorities.
+test_files: []