Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clrung/wmatafetcher
CocoaPod for WMATA's API
https://github.com/clrung/wmatafetcher
cocoapods swift swift-3 wmata-api
Last synced: 21 days ago
JSON representation
CocoaPod for WMATA's API
- Host: GitHub
- URL: https://github.com/clrung/wmatafetcher
- Owner: clrung
- License: mit
- Created: 2016-08-15T19:32:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-22T13:37:33.000Z (almost 8 years ago)
- Last Synced: 2024-12-02T03:40:49.064Z (21 days ago)
- Topics: cocoapods, swift, swift-3, wmata-api
- Language: Swift
- Size: 47.9 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# WMATAFetcher  [](http://cocoapods.org/pods/WMATAFetcher) [](http://cocoapods.org/pods/WMATAFetcher) [](http://cocoapods.org/pods/WMATAFetcher)
## Description
A cross-platform [CocoaPod](https://cocoapods.org) that fetches information from [WMATA's API](https://developer.wmata.com/) and stores it in `Train` objects, which are modeled after the API's [AIMPredictionTrainInfo](https://developer.wmata.com/docs/services/547636a6f9182302184cda78/operations/547636a6f918230da855363f/console#AIMPredictionTrainInfo) object.
## Requirements
* iOS 8.0+
* macOS 10.9+
* tvOS 9.0+
* watchOS 2.0+
## Installation
WMATAFetcher is available via [CocoaPods](https://cocoapods.org). To install it, add the following to your `Podfile`:
```ruby
target 'TargetName' do
pod 'WMATAFetcher'
end
```
Next, run the following in a Terminal:
```bash
$ pod install
```
## Usage
### Instantiation
First, create a new `WMATAFetcher` object, passing it your [WMATA API key](https://developer.wmata.com/signup/):
```Swift
var wmataFetcher = WMATAFetcher(WMATA_API_KEY: "[YOUR_WMATA_KEY]")
```
#### Spaces between groups
The `isSpaceInTrainArray` `BOOL` determines if a `Station.Space` object will separate each group in the `Train` array (default: `true`).
You may initialize this value when instantiating a new `WMATAFetcher` object:
```Swift
var wmataFetcher = WMATAFetcher(WMATA_API_KEY: "[YOUR_WMATA_KEY]", isSpaceInTrainArray: false)
```
You may also change the value of `isSpaceInTrainArray` directly:
```Swift
wmataFetcher.isSpaceInTrainArray = false
```
### Fetching
Pass `wmataFetcher.getStationPredictions` a station code to get predictions. Implement `onCompleted` to handle the `TrainResponse` returned.
If `trainResponse.errorCode` is `nil`, we can safely force upwrap `trainResponse.trains?`.
```Swift
let wmataFetcher = WMATAFetcher(WMATA_API_KEY: "[API KEY HERE]")
let metroCenterStationCode = Station(description: "Metro Center")!.rawValue
wmataFetcher.getStationPredictions(stationCode: metroCenterStationCode, onCompleted: {
trainResponse in
if trainResponse.errorCode == nil {
for train in trainResponse.trains! {
print(train.debugDescription);
}
} else {
switch trainResponse.errorCode! {
case -1009:
print("Internet connection is offline")
default:
print("Prediction fetch failed (Code: \(trainResponse.errorCode!))")
}
})
```
### Error Handling
`TrainResponse.errorCode` is an `Int?` representing the [HTTP status code](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) returned by WMATA's API. If it is `nil`, the fetch was successful. The most common error codes are:
1. -1009
* The internet connection is offline
1. 401
* Unauthorized. This is likely a bad WMATA key.
## Dependencies
* [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON)
## Notable Projects
* [DC Metro Widget](https://github.com/clrung/DCMetroWidget)
* Today extension for macOS' Notification Center
* Inspiration for this `Pod`
## License
WMATAFetcher is available under the MIT license. See the LICENSE file for more info.