Project

weese

0.0
No commit activity in last 3 years
No release in over 3 years
API Adapter for the WMATA API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.1.a
~> 5.0
~> 12.0
~> 5.0.0

Runtime

~> 0.17.3
 Project Readme

weese

weese is a simple Ruby interface to the Washington Metropolitan Area Transit Authority API.

Contents

  • Requirements
  • Installation
  • Usage
    • Getting Started
    • Design
    • Using MetroRail
    • Using MetroBus
  • Testing
  • Dependencies
  • Contact
  • License

Requirements

  • Ruby 2.5+

Installation

Add this line to your application's Gemfile:

gem 'weese'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install weese

Usage

Getting Started

require 'weese'

client = Weese::Rail::MetroRail.new api_key

trains = client.next_trains Weese::Rail::Station::A01

Design

weese breaks the WMATA API into two components: MetroRail and MetroBus.

MetroRail

Provides access to all MetroRail related endpoints.

Using MetroRail

See Getting Started

MetroBus

Provides access to all MetroBus related endpoints.

Using MetroBus
require 'weese'

client = Weese::Rail::MetroBus.new api_key

routes = client.routes

Testing

All testing is done with vcr, and can be run with rake test.

Dependencies

  • Faraday

Contact

Feel free to email questions and comments to emma@emma.sh

License

weese is released under the MIT license. See LICENSE for details.