weese 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e962956bc43863c94a15563930aa0d041865bc4258f0a28403781b3cdaf6f908
+  data.tar.gz: f6d9f14e0a979ffa035fc40b68857079b5b109447cd5b5139fcc7b504015da9d
+SHA512:
+  metadata.gz: 9d6f41d08c461bb0c4ccb4b342cd7d23b6ff9269c53a40319b3b52c094511f74bd8a8e70a81522af8bd57ef2033626afb9e90968b0809e753983da46ca3dc17e
+  data.tar.gz: 6c5c872fce25bc302697265a728f5c0b4c3bbc94f970ce4068d42463cb07a833673e234dfd3d225d1e765860e9621573a84b0eed797975fe624e805140c1231b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.0.pre.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at emma@emma.sh. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in weese.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    weese (1.0.0)
+      faraday (~> 0.17.3)
+      vcr (~> 5.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.17.3)
+      multipart-post (>= 1.2, < 3)
+    minitest (5.14.0)
+    multipart-post (2.1.1)
+    rake (12.3.3)
+    vcr (5.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.a)
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  weese!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Emma K Alexandra
+
+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.

data/README.md

@@ -0,0 +1,78 @@
+# weese
+weese is a simple Ruby interface to the [Washington Metropolitan Area Transit Authority API](https://developer.wmata.com).
+
+## Contents
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Usage](#usage)
+    - [Getting Started](#getting-started)
+    - [Design](#design)
+    - [Using `MetroRail`](#using-MetroRail)
+    - [Using `MetroBus`](#using-MetroBus)
+- [Testing](#testing)
+- [Dependencies](#dependencies)
+- [Contact](#contact)
+- [License](#license)
+
+## Requirements
+ - Ruby 2.5+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'weese'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install weese
+
+## Usage
+
+### Getting Started
+```ruby
+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](#getting-started)
+
+#### `MetroBus`
+Provides access to all MetroBus related endpoints.
+
+##### Using `MetroBus`
+```ruby
+require 'weese'
+
+client = Weese::Rail::MetroBus.new api_key
+
+routes = client.routes
+```
+
+## Testing
+All testing is done with [vcr](https://github.com/vcr/vcr), and can be run with `rake test`.
+
+## Dependencies
+- Faraday
+
+## Contact
+Feel free to email questions and comments to [emma@emma.sh](mailto:emma@emma.sh)
+
+## License
+weese is released under the MIT license. [See LICENSE](https://github.com/emma-k-alexandra/weese/blob/master/LICENSE) for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "weese"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/weese/bus/metro_bus.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'weese/bus/stop'
+require 'weese/bus/route'
+
+module Weese
+  # MetroBus related structures. Most important: {MetroBus}
+  module Bus
+    # MetroBus client. Used for accessing MetroBus-related WMATA APIs.
+    class MetroBus
+      include Requests::Requester
+      include Bus::RequiresStop
+      include Bus::RequiresRoute
+
+      # @return [String] WMATA API key
+      attr_accessor :api_key
+
+      #
+      # MetroBus client. Used for accessing MetroBus related endpoints
+      #
+      # @param [String] api_key WMATA API key, get one at {http://developer.wmata.com}
+      #
+      def initialize(api_key)
+        @api_key = api_key
+      end
+
+      #
+      # List of all bus route variants.
+      # {https://developer.wmata.com/docs/services/54763629281d83086473f231/operations/5476362a281d830c946a3d6a WMATA Documentation}
+      #
+      # @raise [WeeseError] If request or JSON parse fails
+      #
+      # @return [Hash] JSON Response
+      #
+      def routes
+        fetch(
+          Requests::Request.new(
+            @api_key,
+            Bus::Urls::ROUTES,
+            {}
+          )
+        )
+      end
+
+      #
+      # Nearby bus stops based on latitude, longitude, and radius.
+      # {https://developer.wmata.com/docs/services/54763629281d83086473f231/operations/5476362a281d830c946a3d6d WMATA Documentation}
+      #
+      # @param [RadiusAtCoordinates] radius_at_coordinates A radius in meters around a lat/long
+      #
+      # @raise [WeeseError] If request or JSON parse fails
+      #
+      # @return [Hash] JSON Response
+      #
+      def stops(radius_at_coordinates = nil)
+        query = radius_at_coordinates ? radius_at_coordinates.to_h : {}
+
+        fetch(
+          Requests::Request.new(
+            @api_key,
+            Bus::Urls::STOPS,
+            query
+          )
+        )
+      end
+    end
+  end
+end