njtransit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd302f71e7ea318a5704152bab2cb76a4e94562ec509c7e21a3c0b3aa68d65d1
+  data.tar.gz: cc4154a3674e08bac0ebd0edd2b0962377ee96aea941835826e438c490951ab7
+SHA512:
+  metadata.gz: 3c6bb8539d7b15520888030783b52415daf70a9d8b52946fbef63c7ab72155d3750d1612a4381158eed51db7a36c7430990abbe3efdd8e8e5086620eca4fa70f
+  data.tar.gz: b92982f20309a47272575d0421002ebe27607453e924bc260b4c85001ddeb8bfc03d7517b83cc53e062a491b68f9f2f223fc9e99af1c21a664fb32c9b213bbd3

data/.claude/commands/njtransit.md

@@ -0,0 +1,196 @@
+---
+description: Ask NJ Transit questions - buses, trains, light rail, schedules, real-time arrivals. Uses the njtransit gem to query live data.
+---
+
+You are an NJ Transit assistant. The user is asking a transit question from their terminal. Your job is to answer it by writing and executing Ruby code using the `njtransit` gem in this repository.
+
+## Setup
+
+The gem is in the current directory. Credentials come from environment variables. Before making any API call, run this setup:
+
+```ruby
+require "dotenv"
+Dotenv.load
+
+$LOAD_PATH.unshift(File.join(Dir.pwd, "lib"))
+require "njtransit"
+
+NJTransit.configure do |config|
+  config.username = ENV["NJTRANSIT_USERNAME"]
+  config.password = ENV["NJTRANSIT_PASSWORD"]
+end
+
+# Bus/Light Rail client (pcsdata.njtransit.com)
+client = NJTransit.client
+
+# Rail/Train client (raildata.njtransit.com)
+rail_client = NJTransit.rail_client
+```
+
+If credentials are missing, tell the user to set `NJTRANSIT_USERNAME` and `NJTRANSIT_PASSWORD` in their `.env` file. They can register at https://developer.njtransit.com/registration
+
+---
+
+## BUS API (client.bus)
+
+### Routes & Directions
+```ruby
+client.bus.routes                          # All bus routes
+client.bus.routes(mode: "ALL")             # All modes (bus + light rail)
+client.bus.routes(mode: "HBLR")            # Hudson-Bergen Light Rail only
+# Valid modes: "BUS", "NLR", "HBLR", "RL", "ALL"
+
+client.bus.directions(route: "197")
+# => [{"Direction_1"=>"New York", "Direction_2"=>"Willowbrook Mall"}]
+```
+
+### Stops
+```ruby
+client.bus.stops(route: "197", direction: "New York", enrich: false)
+client.bus.stop_name(stop_number: "19159", enrich: false)
+client.bus.stops_nearby(lat: 40.8523, lon: -74.2567, radius: 2000, enrich: false)
+# radius is in feet. mode: "ALL" includes light rail stops
+```
+
+### Real-Time Departures (most useful for "when is my bus?")
+```ruby
+client.bus.departures(stop: "PABT", enrich: false)
+# Returns trips active in next hour
+# Can filter: route: "197", direction: "New York"
+# Response: public_route, header (destination), departuretime ("in 18 mins"),
+#   lanegate, vehicle_id, passload, sched_dep_time
+```
+
+### Trip Tracking
+```ruby
+client.bus.route_trips(location: "PABT", route: "113")
+client.bus.trip_stops(internal_trip_number: "19624134", sched_dep_time: "6/22/2023 12:50:00 AM")
+client.bus.vehicles_nearby(lat: 40.8523, lon: -74.2567, radius: 5000, enrich: false)
+```
+
+### Locations (terminals/hubs)
+```ruby
+client.bus.locations           # Bus terminals
+client.bus.locations(mode: "ALL")  # All transit locations
+```
+
+---
+
+## RAIL/TRAIN API (rail_client.rail)
+
+### Station List
+```ruby
+rail_client.rail.stations
+# => [{"STATION_2CHAR"=>"NP", "STATIONNAME"=>"Newark Penn Station", ...}, ...]
+```
+
+### Station Messages & Alerts
+```ruby
+rail_client.rail.station_messages(station: "NP")  # By station code
+rail_client.rail.station_messages(line: "NE")      # By line code (NEC)
+# Returns alerts, delays, service advisories
+```
+
+### Train Schedules (most useful for "when is my train?")
+```ruby
+# Real-time schedule with full detail
+rail_client.rail.train_schedule(station: "NP")
+
+# Lighter version - next 19 departures
+rail_client.rail.train_schedule_19(station: "NP")
+
+# Full 27-hour station schedule
+rail_client.rail.station_schedule(station: "NP")
+```
+
+### Train Tracking
+```ruby
+# All stops for a specific train
+rail_client.rail.train_stop_list(train_id: "3837")
+
+# Real-time positions of all active trains
+rail_client.rail.vehicle_data
+# Returns: lat/lon, speed, next station, seconds late, train line
+```
+
+### Common Station Codes
+- **NY** -- New York Penn Station
+- **NP** -- Newark Penn Station
+- **HB** -- Hoboken Terminal
+- **SC** -- Secaucus Junction
+- **TR** -- Trenton
+- **NA** -- Newark Airport
+- **LB** -- Long Branch
+- **DO** -- Dover
+- **MP** -- Metropark
+
+### Train Line Codes
+- **NE** -- Northeast Corridor
+- **NC** -- North Jersey Coast
+- **ME** -- Morris & Essex / Gladstone
+- **ML** -- Main Line
+- **BC** -- Bergen County Line
+- **PV** -- Pascack Valley Line
+- **RV** -- Raritan Valley Line
+- **MC** -- Montclair-Boonton Line
+- **AC** -- Atlantic City Line
+- **PR** -- Princeton Branch
+
+---
+
+## GTFS-RT (real-time feeds, binary data)
+
+```ruby
+# Bus GTFS-RT (returns binary protobuf/zip data)
+client.bus_gtfs.schedule_data       # Static GTFS ZIP
+client.bus_gtfs.alerts              # Real-time alerts (protobuf)
+client.bus_gtfs.trip_updates        # Real-time trip updates (protobuf)
+client.bus_gtfs.vehicle_positions   # Real-time positions (protobuf)
+
+# Bus GTFS-RT G2 (newer version with improved data)
+client.bus_gtfs_g2.schedule_data
+client.bus_gtfs_g2.alerts
+client.bus_gtfs_g2.trip_updates
+client.bus_gtfs_g2.vehicle_positions
+
+# Rail GTFS-RT
+rail_client.rail_gtfs.schedule_data
+rail_client.rail_gtfs.alerts
+rail_client.rail_gtfs.trip_updates
+rail_client.rail_gtfs.vehicle_positions
+```
+
+---
+
+## GTFS Static Data (offline queries, requires import)
+```ruby
+gtfs = NJTransit::GTFS.new
+gtfs.stops.find_by_code("WBRK")
+gtfs.routes.find("197")
+gtfs.routes_between(from: "WBRK", to: "PABT")
+gtfs.schedule(route: "197", stop: "WBRK", date: Date.today)
+```
+
+---
+
+## How to Answer Questions
+
+1. **"When is my bus?"** -- Use `client.bus.departures` with stop and optionally route
+2. **"When is my train?"** -- Use `rail_client.rail.train_schedule_19(station: code)` for next departures
+3. **"Is my train delayed?"** -- Use `rail_client.rail.station_messages(station: code)` for alerts
+4. **"Where is train X?"** -- Use `rail_client.rail.train_stop_list(train_id: id)` or `rail_client.rail.vehicle_data`
+5. **"What stops are near me?"** -- Use `client.bus.stops_nearby` with coordinates
+6. **"What buses/trains go from X to Y?"** -- Combine station/stop lookups with route queries
+7. **Light rail questions** -- Use bus API with `mode: "HBLR"` / `"NLR"` / `"RL"`
+
+## Response Style
+
+- Be concise -- the user is in a terminal, probably in a hurry
+- Format as clean tables
+- Highlight the NEXT departure prominently
+- Show delay info when available
+- Always use `enrich: false` for bus API calls to avoid GTFS dependency
+
+## User's Question
+
+$ARGUMENTS

data/.mcp.json.example

@@ -0,0 +1,12 @@
+{
+  "mcpServers": {
+    "github": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-github"],
+      "env": {
+        "GITHUB_PERSONAL_ACCESS_TOKEN": "your_github_pat_here"
+      }
+    }
+  }
+}

data/.mcp.json.sample

@@ -0,0 +1,11 @@
+{
+  "mcpServers": {
+    "github": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-github"],
+      "env": {
+        "GITHUB_PERSONAL_ACCESS_TOKEN": "<your-github-token>"
+      }
+    }
+  }
+}

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,87 @@
+plugins:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"
+    - "lib/njtransit/tasks.rb"
+
+# HTTP client code tends to have longer classes/methods
+Metrics/ClassLength:
+  Exclude:
+    - "lib/njtransit/client.rb"
+    - "lib/njtransit/gtfs/database.rb"
+
+Metrics/MethodLength:
+  Exclude:
+    - "lib/njtransit/client.rb"
+
+Metrics/AbcSize:
+  Exclude:
+    - "lib/njtransit/client.rb"
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - "lib/njtransit/client.rb"
+
+Metrics/ParameterLists:
+  Exclude:
+    - "lib/njtransit/client.rb"
+    - "lib/njtransit/resources/bus.rb"
+
+Naming/VariableNumber:
+  CheckMethodNames: false
+
+# GTFS database schema is inherently verbose
+Metrics/ModuleLength:
+  Exclude:
+    - "lib/njtransit/gtfs/database.rb"
+
+# RSpec cops — relax rules that fight gem test conventions
+RSpec/SpecFilePathFormat:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 4
+
+RSpec/ExampleLength:
+  Max: 10
+
+RSpec/MultipleDescribes:
+  Enabled: false
+
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+RSpec/IdenticalEqualityAssertion:
+  Enabled: false
+
+RSpec/ScatteredLet:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.2

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [1.0.0] - 2026-03-27
+
+### Added
+
+- **Rail API** — train schedules, station messages, train stop lists, and live vehicle positions via `NJTransit.rail_client`
+- **Bus GTFS-RT** — real-time alerts, trip updates, and vehicle positions (`client.bus_gtfs`)
+- **Bus GTFS-RT G2** — newer version of bus feeds (`client.bus_gtfs_g2`)
+- **Rail GTFS-RT** — real-time rail feeds (`rail_client.rail_gtfs`)
+- **Light rail support** — `mode` parameter on bus API methods (`HBLR`, `NLR`, `RL`, `ALL`)
+- **GTFS static data** — full offline schedules via SQLite, with import/query/rake tasks
+- **Automatic enrichment** — bus API responses enriched with GTFS lat/lon and route names
+- **Token caching** — auth tokens cached across client instances to avoid hitting daily API limits
+- **Descriptive auth errors** — actual API error messages surfaced instead of generic "Authentication failed"
+- **CI pipeline** — RuboCop linting and RSpec on Ruby 3.2/3.3
+- **Automated releases** — publish to RubyGems on merge to main when version changes
+
+### Bus API
+
+- `routes`, `directions`, `stops`, `stop_name`, `departures`
+- `route_trips`, `trip_stops`, `stops_nearby`, `vehicles_nearby`
+- `locations` with mode filtering
+
+### Rail API
+
+- `stations`, `station_messages`, `station_schedule`
+- `train_schedule`, `train_schedule_19`, `train_stop_list`
+- `vehicle_data`
+
+## [0.1.0] - 2026-01-24
+
+- Initial release

data/CLAUDE.md

@@ -0,0 +1,159 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Architecture
+
+### Two Clients
+
+The gem wraps two separate NJ Transit API hosts with a single `Client` class:
+
+- **`NJTransit.client`** → `pcsdata.njtransit.com` — Bus, light rail, bus GTFS-RT
+- **`NJTransit.rail_client`** → `raildata.njtransit.com` — Rail/train, rail GTFS-RT
+
+Both use the same `Client` class with different `base_url` and `auth_path`. Authentication is token-based and handled automatically (with transparent re-auth on token expiry).
+
+### Resource Classes (`lib/njtransit/resources/`)
+
+- `Bus` — real-time bus/light rail API (departures, routes, stops, vehicles)
+- `Rail` — real-time rail API (schedules, station messages, vehicle tracking)
+- `BusGTFS` — bus GTFS-RT feeds (protobuf). Also used for G2 feeds via `api_prefix` param
+- `RailGTFS` — rail GTFS-RT feeds (protobuf)
+
+### GTFS Static Layer (`lib/njtransit/gtfs/`)
+
+SQLite-backed offline schedule data. Import from GTFS zip, then query via `NJTransit::GTFS.new`:
+- `Database` — Sequel SQLite connection and schema
+- `Importer` — parses GTFS txt files into SQLite
+- `Models` — `Stop`, `Route`
+- `Queries` — `RoutesBetween`, `Schedule`
+
+### Key Patterns
+
+- **`enrich` flag**: Bus API methods default to `enrich: true`, which joins GTFS static data (lat/lon, route names). Use `enrich: false` if GTFS isn't imported or you don't need it.
+- **`mode` parameter**: Bus methods default to `mode: "BUS"`. Pass `"HBLR"`, `"NLR"`, `"RL"`, or `"ALL"` for light rail.
+- **`stops_nearby` radius**: The radius parameter is in **feet**, not miles.
+- **Raw responses**: GTFS-RT methods (`bus_gtfs`, `rail_gtfs`) return binary protobuf data via `post_form_raw`.
+
+## Testing
+
+```bash
+bundle exec rspec              # Run all 153 specs
+bundle exec rspec spec/file.rb # Run a specific spec file
+```
+
+All API calls are stubbed — no credentials needed for tests.
+
+## Git Workflow
+
+Every change follows this process: Issue -> Branch -> Implement -> Commit -> PR -> CI -> Merge -> Release -> Cleanup.
+
+### 1. Create Issue
+
+- Create a GitHub issue describing the work
+- Add the `claude` label to issues created by Claude
+- For human-created issues: add `claude:reviewed` label after reviewing (not both labels on same issue)
+- Include a **Success Criteria** section with testable checkbox items:
+  ```markdown
+  ## Success Criteria
+  - [ ] Feature X works as described
+  - [ ] All existing tests pass
+  - [ ] New tests added for feature X
+  ```
+- Note `*Co-authored by Claude*` if applicable
+
+### 2. Create Branch
+
+Branch naming convention:
+```
+fix/<issue-number>-<brief-description>
+```
+
+Examples:
+- `fix/15-add-schedule-parsing`
+- `fix/23-fix-departure-times`
+
+### 3. Implement
+
+- Write code and tests
+- Update issue checkboxes as criteria are met
+- Bump version in `lib/njtransit/version.rb`
+- Add entry to `CHANGELOG.md` under `[Unreleased]`
+
+**Every PR must include** a version bump and changelog entry. Dependabot PRs are exempt.
+
+Follow [Semantic Versioning](https://semver.org/):
+- **PATCH** (0.0.x): Bug fixes, minor doc updates
+- **MINOR** (0.x.0): New features, new API methods
+- **MAJOR** (x.0.0): Breaking changes to public API
+
+### 4. Commit
+
+Every commit must include:
+- `Closes #<issue-number>` in the commit message body
+- Co-authorship footer:
+  ```
+  Co-Authored-By: Claude <noreply@anthropic.com>
+  ```
+
+Example:
+```
+Add user authentication with Devise
+
+Closes #12
+
+Co-Authored-By: Claude <noreply@anthropic.com>
+```
+
+### 5. Push & Create PR
+
+- Push branch to origin
+- Create PR using `gh pr create`
+- Include `*Co-authored by Claude*` in PR body
+- Always use **merge commits** (not squash)
+
+### 6. Monitor CI
+
+```bash
+bin/ci-watch <pr-number>              # Check once
+bin/ci-watch <pr-number> --poll       # Poll every 10s until done
+bin/ci-watch <pr-number> --poll 30    # Poll every 30s
+```
+
+Exit codes: `0` = all passed, `1` = failed, `2` = still in progress.
+
+- **Exit 0**: notify user and await instruction to merge
+- **Exit 1**: investigate the failure, propose a fix — do NOT merge
+- **Exit 2**: check again later
+
+Do NOT merge the PR automatically. Wait for explicit user instruction.
+
+### 7. Merge PR
+
+After CI passes and user gives explicit instruction:
+
+```bash
+gh pr merge <pr-number> --merge
+```
+
+### 8. Monitor Release
+
+If version was bumped, a release workflow runs automatically on merge to main:
+1. Runs the test suite
+2. Builds the gem
+3. Publishes to RubyGems
+4. Creates a GitHub release with the gem attached
+
+Monitor with: `gh run watch` (select the Release workflow). Confirm gem was published to rubygems.org.
+
+### 9. Cleanup (only after release is healthy)
+
+```bash
+git checkout main
+git pull origin main
+git branch -d <branch-name>
+git push origin --delete <branch-name>
+git fetch --prune
+```
+
+Do NOT delete the branch if the release failed — it may be needed for fixes.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jayrav13@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Jay Ravaliya
+
+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.