howard 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b93ca32d3707f8669c83c4ed074b2fecf9eb397a
+  data.tar.gz: 590de621e247af17ed39da0935723a4b87564508
+SHA512:
+  metadata.gz: fcf0862b0049593f9e9deb6fb95435025d6f7e2735ef9edcb9a8eea0f465e2e4916395ae80120cc06e3008043eaf7aa1cad7962a7876f6201e8284f13e436969
+  data.tar.gz: 897d4764deca4845249bb855288e5270175d46a7ee01a1b394b6ab2030b7a69a42fd600b069f047b75dc915291721a2d07da9d01dc5453c4f6ea1486dbba06d0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--order rand
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+- 2.1.2
+- 2.0.0
+- 1.9.3
+- jruby-19mode
+- rbx-2

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthew Patterson
+
+MIT License
+
+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,50 @@
+# Howard
+
+Unofficial client library for the Chicago Transit Authority's Train Tracker API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'howard'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install howard
+
+## Usage
+
+### Train Tracker API Key
+
+In order to use the Train Tracker API, you will need to [apply for an API key](http://www.transitchicago.com/developers/traintracker.aspx).
+
+Once you have your API key, configure it like so:
+
+```ruby
+Howard.api_keys do |key|
+  key.train_tracker = "your API key here"
+end
+```
+
+### Train Arrivals
+
+See train arrivals for a given station or stop.
+
+```ruby
+arrivals = Howard.arrivals(stop: 41400, max: 5)
+arrivals.first.route.full_name # => "Brown Line"
+arrivals.first.train.run # => "419"
+arrivals.first.train.latitude # => 41.97776
+arrivals.first.delayed? # => false
+arrivals.first.eta.to_s # => "2 min"
+```
+
+## Fine Print
+
+This library is not affiliated with or endorsed by the Chicago Transit Authority.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError; end

data/howard.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'howard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "howard"
+  spec.version       = Howard::VERSION
+  spec.authors       = ["Matthew Patterson"]
+  spec.email         = ["matthew.s.patterson@gmail.com"]
+  spec.summary       = %q{Unofficial client for the CTA Train Tracker API}
+  spec.description   = %q{Unofficial client library for the Chicago Transit Authority's Train Tracker API}
+  spec.homepage      = "https://github.com/matthewpatterson/howard"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.13"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/lib/howard.rb

@@ -0,0 +1,27 @@
+require "howard/arrival"
+require "howard/arrivals_resource"
+require "howard/time_to_arrival"
+require "howard/train"
+require "howard/train_tracker_gateway"
+require "howard/version"
+
+module Howard
+  def self.api_keys
+    keys = key_struct.new
+    yield keys
+    @@train_tracker_api_key = keys.train_tracker
+  end
+
+  def self.train_tracker_api_key
+    @@train_tracker_api_key
+  end
+
+  def self.arrivals(params={})
+    Howard::ArrivalsResource.new(params)
+  end
+
+  private
+  def self.key_struct
+    Struct.new(:train_tracker)
+  end
+end

data/lib/howard/arrival.rb

@@ -0,0 +1,46 @@
+require "time"
+
+module Howard
+  class Arrival
+    def initialize(api_response)
+      @api_response = api_response
+    end
+
+    def train
+      @train ||= Train.new(@api_response)
+    end
+
+    def prediction_time
+      Time.strptime(@api_response["prdt"], "%Y%m%d %H:%M:%S")
+    end
+
+    def arrival_time
+      Time.strptime(@api_response["arrT"], "%Y%m%d %H:%M:%S")
+    end
+
+    def eta
+      @eta ||= TimeToArrival.new(self)
+    end
+
+    def approaching?
+      @api_response.fetch("isApp", "0") == "1"
+    end
+    alias_method :due?, :approaching?
+
+    def scheduled?
+      @api_response.fetch("isSch", "0") == "1"
+    end
+
+    def live?
+      !scheduled?
+    end
+
+    def fault?
+      @api_response.fetch("isFlt", "0") == "1"
+    end
+
+    def delayed?
+      @api_response.fetch("isDly", "0") == "1"
+    end
+  end
+end

data/lib/howard/arrivals_resource.rb

@@ -0,0 +1,36 @@
+module Howard
+  class ArrivalsResource
+    include Enumerable
+
+    attr_reader :params
+
+    def initialize(params={})
+      @params = arrivals_params(params)
+    end
+
+    def each
+      Array(xml_response["ctatt"]["eta"])
+        .map { |eta| Arrival.new(eta) }
+        .each { |arrival| yield arrival }
+    end
+
+    def gateway
+      @gateway ||= TrainTrackerGateway.new(Howard.train_tracker_api_key)
+    end
+
+    def xml_response
+      @xml_resonse ||= gateway
+        .arrivals(query: params)
+        .parsed_response
+    end
+
+    def arrivals_params(params)
+      {
+        mapid: params[:mapid] || params[:station],
+        stpid: params[:stpid] || params[:stop],
+        max: params[:max],
+        rt: params[:rt] || params[:route],
+      }.reject { |_, val| val.nil? }
+    end
+  end
+end

data/lib/howard/time_to_arrival.rb

@@ -0,0 +1,23 @@
+module Howard
+  class TimeToArrival
+    attr_reader :arrival
+
+    def initialize(arrival)
+      @arrival = arrival
+    end
+
+    def minutes
+      (arrival.arrival_time.to_i - arrival.prediction_time.to_i) / 60
+    end
+
+    def to_s(format = "%d min")
+      if arrival.delayed?
+        "Delayed"
+      elsif arrival.approaching?
+        "Due"
+      else
+        format % minutes
+      end
+    end
+  end
+end

data/lib/howard/train.rb

@@ -0,0 +1,23 @@
+module Howard
+  class Train
+    def initialize(api_response)
+      @api_response = api_response
+    end
+
+    def heading
+      @api_response.fetch("heading", "").to_i
+    end
+
+    def latitude
+      @api_response.fetch("lat", "").to_f
+    end
+
+    def longitude
+      @api_response.fetch("lon", "").to_f
+    end
+
+    def run
+      @api_response["rn"]
+    end
+  end
+end

data/lib/howard/train_tracker_gateway.rb

@@ -0,0 +1,16 @@
+require "httparty"
+
+module Howard
+  class TrainTrackerGateway
+    include HTTParty
+    base_uri "http://lapi.transitchicago.com"
+
+    def initialize(api_key)
+      self.class.default_params(key: api_key)
+    end
+
+    def arrivals(params)
+      self.class.get("/api/1.0/ttarrivals.aspx", params)
+    end
+  end
+end

data/lib/howard/version.rb

@@ -0,0 +1,3 @@
+module Howard
+  VERSION = "0.0.1"
+end

data/spec/howard/arrival_spec.rb

@@ -0,0 +1,134 @@
+require "spec_helper"
+
+RSpec.describe Howard::Arrival do
+  describe "#train" do
+    it "returns a Howard::Train instance" do
+      arrival = Howard::Arrival.new("rn" => "419")
+      expect(arrival.train).to be_a(Howard::Train)
+    end
+
+    it "provides the train run number" do
+      arrival = Howard::Arrival.new("rn" => "419")
+      expect(arrival.train.run).to eq("419")
+    end
+
+    it "provides the latitude of the train" do
+      arrival = Howard::Arrival.new("lat" => "41.97776")
+      expect(arrival.train.latitude).to eq(41.97776)
+    end
+
+    it "provides the longitude of the train" do
+      arrival = Howard::Arrival.new("lon" => "-87.77567")
+      expect(arrival.train.longitude).to eq(-87.77567)
+    end
+
+    it "provides the heading of the train" do
+      arrival = Howard::Arrival.new("heading" => "299")
+      expect(arrival.train.heading).to eq(299)
+    end
+  end
+
+  describe "#prediction_time" do
+    it "returns the date/time of the prediction" do
+      arrival = Howard::Arrival.new("prdt" => "20110618 23:26:12")
+      expect(arrival.prediction_time.year).to eq(2011)
+      expect(arrival.prediction_time.month).to eq(6)
+      expect(arrival.prediction_time.day).to eq(18)
+      expect(arrival.prediction_time.hour).to eq(23)
+      expect(arrival.prediction_time.min).to eq(26)
+      expect(arrival.prediction_time.sec).to eq(12)
+    end
+  end
+
+  describe "#arrival_time" do
+    it "returns the date/time of the predicted arrival" do
+      arrival = Howard::Arrival.new("arrT" => "20110618 23:26:12")
+      expect(arrival.arrival_time.year).to eq(2011)
+      expect(arrival.arrival_time.month).to eq(6)
+      expect(arrival.arrival_time.day).to eq(18)
+      expect(arrival.arrival_time.hour).to eq(23)
+      expect(arrival.arrival_time.min).to eq(26)
+      expect(arrival.arrival_time.sec).to eq(12)
+    end
+  end
+
+  describe "#eta" do
+    it "returns a Howard::TimeToArrival instance" do
+      arrival = Howard::Arrival.new(
+        "prdt" => "20110618 23:26:12",
+        "arrT" => "20110618 23:28:12",
+      )
+
+      expect(arrival.eta).to be_a(Howard::TimeToArrival)
+    end
+
+    it "shows the number time until the train arrives" do
+      arrival = Howard::Arrival.new(
+        "prdt" => "20110618 23:26:12",
+        "arrT" => "20110618 23:28:12",
+      )
+
+      expect(arrival.eta.to_s).to eq("2 min")
+    end
+  end
+
+  describe "#approaching?" do
+    it "is true when the train is approaching" do
+      arrival = Howard::Arrival.new("isApp" => "1")
+      expect(arrival.approaching?).to be_truthy
+    end
+
+    it "is false when the train is not approaching" do
+      arrival = Howard::Arrival.new("isApp" => "0")
+      expect(arrival.approaching?).to be_falsey
+    end
+  end
+
+  describe "#scheduled?" do
+    it "is true when the train arrival is based on the schedule" do
+      arrival = Howard::Arrival.new("isSch" => "1")
+      expect(arrival.scheduled?).to be_truthy
+    end
+
+    it "is false when the train arrival is based on a live prediction" do
+      arrival = Howard::Arrival.new("isSch" => "0")
+      expect(arrival.scheduled?).to be_falsey
+    end
+  end
+
+  describe "#live?" do
+    it "is true when the train arrival is based on a live prediction" do
+      arrival = Howard::Arrival.new("isSch" => "0")
+      expect(arrival.live?).to be_truthy
+    end
+
+    it "is false when the train arrival is based on the schedule" do
+      arrival = Howard::Arrival.new("isSch" => "1")
+      expect(arrival.live?).to be_falsey
+    end
+  end
+
+  describe "#fault?" do
+    it "is true when a fault has been detected" do
+      arrival = Howard::Arrival.new("isFlt" => "1")
+      expect(arrival.fault?).to be_truthy
+    end
+
+    it "is false when a fault has not been detected" do
+      arrival = Howard::Arrival.new("isFlt" => "0")
+      expect(arrival.fault?).to be_falsey
+    end
+  end
+
+  describe "#delayed?" do
+    it "is true when a train is delayed" do
+      arrival = Howard::Arrival.new("isDly" => "1")
+      expect(arrival.delayed?).to be_truthy
+    end
+
+    it "is false when a train is not delayed" do
+      arrival = Howard::Arrival.new("isDly" => "0")
+      expect(arrival.delayed?).to be_falsey
+    end
+  end
+end

data/spec/howard/arrivals_resource_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+RSpec.describe Howard::ArrivalsResource do
+  let(:arrivals) { Howard::ArrivalsResource.new }
+
+  describe "#each" do
+    before(:each) do
+      @api_response = {"ctatt" => {"eta" => [{"rn" => "419"}, {"rn" => "519"}]}}
+      allow(arrivals).to receive(:xml_response) { @api_response }
+    end
+
+    it "can iterate over arrivals" do
+      expect(arrivals.count).to eq(2)
+    end
+
+    it "returns Howard::Arrival objects" do
+      arrivals.each do |arrival|
+        expect(arrival).to be_a(Howard::Arrival)
+      end
+    end
+  end
+end

data/spec/howard/time_to_arrival_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+RSpec.describe Howard::TimeToArrival do
+  describe "#to_s" do
+    it "shows minutes to arrival" do
+      arrival = Howard::Arrival.new(
+        "prdt" => "20110618 23:26:12",
+        "arrT" => "20110618 23:28:47",
+        "isDly" => "0",
+        "isApp" => "0",
+      )
+      eta = Howard::TimeToArrival.new(arrival)
+
+      expect(eta.to_s).to eq("2 min")
+    end
+
+    it "respects the format provided" do
+      arrival = Howard::Arrival.new(
+        "prdt" => "20110618 23:26:12",
+        "arrT" => "20110618 23:28:47",
+        "isDly" => "0",
+        "isApp" => "0",
+      )
+      eta = Howard::TimeToArrival.new(arrival)
+
+      expect(eta.to_s("about %d minutes")).to eq("about 2 minutes")
+    end
+
+    it "shows 'Delayed' when a train is delayed" do
+      arrival = Howard::Arrival.new(
+        "prdt" => "20110618 23:26:12",
+        "arrT" => "20110618 23:28:47",
+        "isDly" => "1",
+        "isApp" => "0",
+      )
+      eta = Howard::TimeToArrival.new(arrival)
+
+      expect(eta.to_s).to eq("Delayed")
+    end
+
+    it "shows 'Due' when a train is arriving" do
+      arrival = Howard::Arrival.new(
+        "prdt" => "20110618 23:26:12",
+        "arrT" => "20110618 23:28:47",
+        "isDly" => "0",
+        "isApp" => "1",
+      )
+      eta = Howard::TimeToArrival.new(arrival)
+
+      expect(eta.to_s).to eq("Due")
+    end
+  end
+
+  describe "#minutes" do
+    it "returns the number of minutes until a train arrives as an integer" do
+      arrival = Howard::Arrival.new(
+        "prdt" => "20110618 23:26:12",
+        "arrT" => "20110618 23:28:47",
+        "isDly" => "0",
+        "isApp" => "0",
+      )
+      eta = Howard::TimeToArrival.new(arrival)
+
+      expect(eta.minutes).to eq(2)
+    end
+  end
+end

data/spec/howard/train_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+RSpec.describe Howard::Train do
+  describe "#heading" do
+    it "returns the heading of the train" do
+      train = Howard::Train.new("heading" => "299")
+      expect(train.heading).to eq(299)
+    end
+  end
+
+  describe "#latitude" do
+    it "returns the latitudinal position of the train" do
+      train = Howard::Train.new("lat" => "41.97776")
+      expect(train.latitude).to eq(41.97776)
+    end
+  end
+
+  describe "#longitude" do
+    it "returns the longitudinal position of the train" do
+      train = Howard::Train.new("lon" => "-87.77567")
+      expect(train.longitude).to eq(-87.77567)
+    end
+  end
+
+  describe "#run" do
+    it "returns the train run number" do
+      train = Howard::Train.new("rn" => "419")
+      expect(train.run).to eq("419")
+    end
+  end
+end

data/spec/howard_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+require "securerandom"
+
+RSpec.describe Howard do
+  describe ".api_keys" do
+    it "sets the Train Tracker API key" do
+      api_key = SecureRandom.hex(8)
+      Howard.api_keys { |key| key.train_tracker = api_key }
+      expect(Howard.train_tracker_api_key).to eq(api_key)
+    end
+  end
+
+  describe ".arrivals" do
+    it "returns an ArrivalsResource" do
+      expect(Howard.arrivals).to be_a(Howard::ArrivalsResource)
+    end
+
+    it "does not make any HTTP calls" do
+      Howard.api_keys { |key| key.train_tracker = SecureRandom.hex(8) }
+      expect(Howard::TrainTrackerGateway).to receive(:get).never
+      Howard.arrivals
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "howard"
+
+RSpec.configure do |c|
+  c.disable_monkey_patching!
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: howard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Unofficial client library for the Chicago Transit Authority's Train Tracker
+  API
+email:
+- matthew.s.patterson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- howard.gemspec
+- lib/howard.rb
+- lib/howard/arrival.rb
+- lib/howard/arrivals_resource.rb
+- lib/howard/time_to_arrival.rb
+- lib/howard/train.rb
+- lib/howard/train_tracker_gateway.rb
+- lib/howard/version.rb
+- spec/howard/arrival_spec.rb
+- spec/howard/arrivals_resource_spec.rb
+- spec/howard/time_to_arrival_spec.rb
+- spec/howard/train_spec.rb
+- spec/howard_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/matthewpatterson/howard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Unofficial client for the CTA Train Tracker API
+test_files:
+- spec/howard/arrival_spec.rb
+- spec/howard/arrivals_resource_spec.rb
+- spec/howard/time_to_arrival_spec.rb
+- spec/howard/train_spec.rb
+- spec/howard_spec.rb
+- spec/spec_helper.rb