dcmetro 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26b4e560cc10b94ec132c545fdfbaf56ab923126
-  data.tar.gz: 10e8f6c5602fe8de59a982a6f31d4880be270623
+  metadata.gz: dc313326de3ac26b92b875af66674b2ca9a38a30
+  data.tar.gz: ac7a212cd6cec05143267728e2e7c66b5a949074
 SHA512:
-  metadata.gz: 5e321972a4fecd6ba6b16d6f3ff47ed1a199f7aebbf266fbccf8072af52ecfd979b80a2413f6b09ab522017d9c270878a838be281073f881b81a255727de1d85
-  data.tar.gz: 345a453a721b5583d19c4e96bdc7ab550d92133ddb62ecba4f00dd97df92b3fac7d6fb9ea5f54e2efd787fbe391d9f7440db4d5e9da4005f9e16309dd3946f40
+  metadata.gz: f2c0675d498fdb34f53900671a11af6442efd934e0b318804c470a26bdb3b182d82dda92e08e4fb23bbd88f6065f0c7ce4ab5e1c41177a478a00a697ee5aef8c
+  data.tar.gz: e48582d557f17e3d75cc9af0fe576f35864db2f18456c17f0f893d782aa5c835745bbec403538dad9050d69ac92f4230c8365d0e8a58ce6f0c5937ec16840466

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -11,4 +11,5 @@
 *.so
 *.o
 *.a
+*.gem
 mkmf.log

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.2.0
+
+script: 'bundle exec rake features'
+
+notifications:
+  email:
+    recipients:
+      - kcrocken@gmail.com
+    on_failure: change
+    on_success: never

data/README.md

@@ -1,4 +1,7 @@
-# DCMetro
+# DCMetro 
+[![Gem Version](https://badge.fury.io/rb/dcmetro.svg)](http://badge.fury.io/rb/dcmetro)
+[![Build Status](https://travis-ci.org/kencrocken/dcmetro.svg?branch=master)](https://travis-ci.org/kencrocken/dcmetro)
+[![Coverage Status](https://coveralls.io/repos/kencrocken/dcmetro/badge.svg?branch=master&service=github)](https://coveralls.io/github/kencrocken/dcmetro?branch=master)
 
 Rails class and a command line interface to access the Washington, D.C. Metro Rail API.  Returns the systemwide alerts, lines, stations and arrival times for the lines at each station.
 
@@ -18,6 +21,17 @@ Or install it yourself as:
 
     $ gem install dcmetro
 
+####An ENV variable must be set either in your shell for the CLI or where ever you keep such variables in your Rails apps.
+
+The variable needs to be set to `DCMETRO_KEY`
+
+It is recommended that a key is requested from https://developer.wmata.com/
+
+For the CLI, in the `.bash_profile` set the following:
+`EXPORT DCMETRO_KEY = <<replace with api key from WMATA>>`
+
+Don't forget to `source .bash_profile` after making the changes.
+
 ## Usage
 ###Rails App
 
@@ -49,9 +63,25 @@ Commands:
   dcmetro alerts          # Display DC Metro system wide alerts.
   dcmetro help [COMMAND]  # Describe available commands or one specific command
   dcmetro line COLOR      # Display metro rail lines, if COLOR, displays rail stations on the COLOR line
-  dcmetro station NAME    # Display metro station train arrival and departure times.
+  dcmetro station STARTING,DEST    # Display metro station train arrival and departure times and travel info.
   ```
   
+### CHANGELOG
+##### Changes in 0.0.2
+
+1. Updates the api calls to the new format
+2. Fixes a bug if multiple stations are returned
+3. Requires the use of an env variable for the API key
+4. Requires rest-client
+##### Changes in 0.0.3
+
+1. Adds station to station travel information
+2. Expanded test coverage
+3. Refactors code so that the Information Class merely returns information
+   Any parsing is now done in the CLI application
+
+# Bug: If no stations are returned app pukes
+# Bug: Pentagon and Pentagon City confuses app
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "DCMETRO_KEY=#{ENV['DCMETRO_KEY']} features --format pretty"
+end
+
 

data/dcmetro.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Dcmetro::VERSION
   spec.authors       = ["Ken Crocken"]
   spec.email         = ["kcrocken@gmail.com"]
-  spec.summary       = %q{Returns DC Metro information, including train schedules.}
-  spec.description   = %q{Returns DC Metro information, including train schedules.}
+  spec.summary       = %q{Returns DC Metro Rails information, including train schedules.}
+  spec.description   = %q{Washington, DC Metro Rails information, including lines, stations and arrival/departure predictions.}
   spec.homepage      = "https://github.com/kencrocken/dcmetro"
   spec.license       = "MIT"
 
@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "coveralls"
 end

data/features/alerts.feature

@@ -0,0 +1,9 @@
+Feature: check dcmetro alerts
+
+  In order to check alerts
+  When I run `dcmetro alerts` 
+  Then alerts should be display
+
+  Scenario: check alerts
+    When I run `dcmetro alerts`
+    Then the stdout should contain "***"

data/features/external.feature

@@ -0,0 +1,43 @@
+@check
+Feature: External calls to WMATA api
+
+    When I call WMATA api 
+    Then the response should be "200"
+    And should return "JSON"
+    And should contain "the desired information"
+
+
+    Scenario: Check Alerts
+        When I send a GET request for "WMATA Alerts"
+        Then the response should be "200"
+        Then should return "JSON"
+        And should contain "Incidents"
+
+    Scenario: Check Lines
+        When I send a GET request for "WMATA Lines"
+        Then the response should be "200"
+        And should return "JSON"
+        And should contain "Lines"
+
+    Scenario: Check Stations on a Line
+        When I send a GET request for "WMATA Lines Red"
+        Then the response should be "200"
+        And should return "JSON"
+        And should contain "Stations"
+
+    Scenario: Check Stations arrival/departure times
+        When I send a GET request for "WMATA Station Gallery"
+        Then the response should be "200"
+        And should return "JSON"
+        And should contain "Line"
+        And should contain "DestinationName"
+        And should contain "Min"
+        
+    @wip
+    Scenario: Check travel time, distance and fare between two stations
+        When I send a GET request for "WMATA Station Gallery College"
+        Then the response should be "200"
+        And should return "JSON"
+        And should contain "CompositeMiles"
+        And should contain "RailFare"
+        And should contain "RailTime"

data/features/lines.feature

@@ -0,0 +1,21 @@
+Feature: check dcmetro lines
+
+    In order to check lines
+    When I run `dcmetro lines`
+    Then metro lines should be displayed
+
+    Scenario: check lines
+        When I run `dcmetro line`
+        Then the stdout should contain "Green\nBlue\nSilver\nRed\nOrange\nYellow"
+
+    Scenario: check lines
+        When I run `dcmetro lines`
+        Then the stdout should contain "Green\nBlue\nSilver\nRed\nOrange\nYellow"
+
+    Scenario: check red line for Gallery Place
+        When I run `dcmetro line red`
+        Then the stdout should contain "Gallery"
+
+    Scenario: check green line for Gallery Place
+        When I run `dcmetro line green`
+        Then the stdout should contain "Gallery"

data/features/station.feature

@@ -0,0 +1,18 @@
+Feature: check dcmetro station predictions
+
+    In order to station predictions
+    When I run `dcmetro station STATION`
+    Then train predictions for STATION should be displayed
+    
+    Scenario: check gallery predictions
+        When I run `dcmetro station gallery`
+        Then the stdout should contain "===== Gallery Pl-Chinatown ====="
+
+    Scenario: check predictions from partial name
+        When I run `dcmetro station gall`
+        Then the stdout should contain "===== Gallery Pl-Chinatown ====="
+
+    Scenario: check predictions returning more than one station
+        When I run `dcmetro station g` interactively
+        And I type "5"
+        Then the stdout should contain "===== Gallery Pl-Chinatown ====="

data/features/step_definitions/api_test_steps.rb

@@ -0,0 +1,28 @@
+When(/^I send a GET request for "([^"]*)"$/) do |path|
+    case path
+    when "WMATA Alerts"
+        @last_response = X.alerts
+    when "WMATA Lines"
+        @last_response = X.line
+    when "WMATA Lines Red"
+        @last_response = X.line "Red"
+    when "WMATA Station Gallery"
+        @last_response = X.station "Gallery place"
+    when "WMATA Station Gallery College" 
+        @last_response = X.station "Gallery", "College"
+    else 
+        false
+    end
+end
+
+Then(/^the response should be "([^"]*)"$/) do |status|
+    @last_response.code == status.to_i
+end
+
+Then(/^should return "([^"]*)"$/) do |arg1|
+    valid_json?(@last_response)
+end
+
+Then(/^should contain "([^"]*)"$/) do |arg1|
+    @last_response[arg1]
+end

data/features/support/env.rb

@@ -0,0 +1,24 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'aruba/cucumber'
+require 'json'
+require 'rest-client'
+require 'dcmetro'
+
+DCMETRO_KEY=ENV['DCMETRO_KEY']
+API_KEY = DCMETRO_KEY
+BASE_URL="http://api.wmata.com"
+
+X = DCMetro::Information.new
+
+Before ("@check ") do
+    def valid_json?(json)
+        begin
+            JSON.parse(json)
+            true
+        rescue
+            false
+        end
+    end
+end

data/lib/dcmetro/cli/application.rb

@@ -1,6 +1,6 @@
 require 'thor'
 require 'json'
-require 'rest_client'
+require 'rest-client'
 
 #
 # This is the command line interface using Thor
@@ -16,7 +16,9 @@ module DCMetro
         # => *** Alert! Alert! ***
 
         x = DCMetro::Information.new
-        display_alerts x.alerts
+
+        alerts = parse_json x.alerts
+        display_alerts alerts
       end
 
       desc 'line COLOR', 'Display metro rail lines, if COLOR, displays rail stations on the COLOR line'
@@ -31,15 +33,26 @@ module DCMetro
         x = DCMetro::Information.new
 
         if !color.nil?
-          x.line(color).each { |station| puts station['Name']}
+          line = parse_json x.line(color)
+          line["Stations"].each { |station| puts station['Name']}
         else
-          x.line.each { |line| puts line["DisplayName"]}
+          lines = parse_json x.line
+          lines["Lines"].each do |line|
+            color = get_color(line['LineCode'])
+
+            puts "#{color}#{line['DisplayName']}#{COLOR_OFF}"
+          end
         end
       end
 
+      desc "lines", "invokes line method"
+      def lines color=nil
+        invoke :line
+      end
+
       desc 'station NAME', 'Display metro station train arrival and departure times.'
       method_option :alerts, :aliases => '-a', :type => :boolean,  :description => "Display Metro wide alerts."
-      def station(name)
+      def station(from, to=nil)
         #
         # $dcmetro station Greenbelt
         # => Displays the departure and arrival times at the Greenbelt Station
@@ -51,20 +64,48 @@ module DCMetro
         x = DCMetro::Information.new
 
         if options[:alerts]
-          y = x.alerts
+          y = parse_json x.alerts
           display_alerts y
         end
 
-        x = x.station(name)
-        train_time = x['Trains'].empty? ? "Sorry, there is no information for #{name}." : display_trains(x['Trains'])
-        puts train_time if !train_time.kind_of?(Array)
-        train_time
+        if to.nil?
+          x = parse_json x.station(from)
+          train_time = x['Trains'].empty? ? "Sorry, there is no information for #{from}." : display_trains(x['Trains'])
+          puts train_time if !train_time.kind_of?(Array)
+          train_time
+        else
+          x = x.station(from,to)
+          y = parse_json x
+          display_travel_info y
+
+        end
       end
 
       private
 
       no_commands do
 
+        def get_color line_code
+          case line_code
+            when "GR"
+              GREEN
+            when "BL"
+              BLUE
+            when "OR"
+              ORANGE
+            when "SV"
+              SILVER
+            when "YL"
+              YELLOW
+            else
+              RED
+          end
+        end
+        
+        def parse_json response
+          JSON.parse(response)
+        end
+
         def display_alerts alerts
           #
           # Formats the display of the alerts
@@ -87,6 +128,14 @@ module DCMetro
           end
         end
 
+        def display_travel_info information
+          information = information['StationToStationInfos'][0]
+          railFare = information['RailFare']
+          puts "Distance: #{information['CompositeMiles']} Miles\n"
+          puts "Estimate Travel Time: #{information['RailTime']} Minutes\n"
+          puts "\n*** Fare Information ***\nOff Peak Time:  $#{railFare['OffPeakTime']}\nPeak Time:  $#{railFare['PeakTime']}\nSenior/Disabled:  $#{railFare['SeniorDisabled']}"
+        end
+
       end
 
     end

data/lib/dcmetro/version.rb

@@ -1,5 +1,5 @@
 module Dcmetro
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end
 
 ### Changes in 0.0.2
@@ -10,4 +10,16 @@ end
 #
 # Requires the use of an env variable for the API key
 #
-# Requires rest-client
+# Requires rest-client
+
+### Changes in 0.0.3
+#
+# Adds station to station travel information
+#
+# Expanded test coverage
+#
+# Refactors code so that the Information Class merely returns information
+# Any parsing is now done in the CLI application
+#
+# Bug: If no stations are returned app pukes
+# Bug: Pentagon and Pentagon City confuses app

data/lib/dcmetro.rb

@@ -3,21 +3,27 @@ require_relative 'dcmetro/cli/application'
 
 module DCMetro
   class Information
-    attr_accessor :metro_incidents, :metro_lines, :metro_stations, :station_code, :metro_time
+    attr_accessor :metro_incidents, :metro_lines, :metro_stations, :station_code, :metro_time, :travel_info
+
+    BASE_URL="https://api.wmata.com"
 
     def initialize
-      @metro_incidents = JSON.parse(RestClient.get "http://api.wmata.com/Incidents.svc/json/Incidents?api_key=#{API_KEY}&subscription-key=#{API_KEY}")
-      @metro_lines = JSON.parse(RestClient.get "http://api.wmata.com/Rail.svc/json/JLines?api_key=#{API_KEY}&subscription-key=#{API_KEY}")
+      @metro_incidents = metro_incidents
+      @metro_lines = metro_lines
       @metro_stations = metro_stations
       @station_code = ""
       @metro_time = metro_time
+      @travel_info = travel_info
     end
 
     def alerts
       #
       # Makes the api call and returns the alerts
+      @metro_incidents = RestClient.get "#{BASE_URL}/Incidents.svc/json/Incidents", :params => {
+          "api_key" => API_KEY,
+          "subscription-key" => API_KEY
+      }
 
-      @metro_incidents
     end ### alerts
 
     def line(color=nil)
@@ -27,14 +33,44 @@ module DCMetro
 
       if !color.nil?
         color = color.downcase
-        @metro_stations = JSON.parse(RestClient.get "http://api.wmata.com/Rail.svc/json/jStations?LineCode=#{color}&api_key=#{API_KEY}&subscription-key=#{API_KEY}")
-        @metro_stations['Stations']
+
+        case color
+        when "red"
+          color = "RD"
+        when "green"
+          color = "GR"
+        when "yellow"
+          color = "YL"
+        when "blue"
+          color = "BL"
+        when "orange"
+          color = "OR"
+        else
+          color = "SV"
+        end
+        
+        @metro_stations = RestClient.get "#{BASE_URL}/Rail.svc/json/jStations", :params => {
+        "LineCode" => color,
+        "api_key" => API_KEY,
+        "subscription-key" => API_KEY
+        }
+
+        # @metro_stations = parse_json metro_stations
+        # @metro_stations['Stations']
       else
-        @metro_lines['Lines']
+        @metro_lines = RestClient.get "#{BASE_URL}/Rail.svc/json/JLines", :params => {
+        "api_key" => API_KEY,
+        "subscription-key" => API_KEY
+        }
+
+        # @metro_lines = metro_lines
+        # @metro_lines['Lines']
+
+        # @metro_lines = get_all_stations
       end
     end ### line
 
-    def station(name)
+    def station(source,destination=nil)
       #
       # Makes the api call to return all stations in the Metro rail system and
       # then grabs the specific station passed by the user
@@ -43,43 +79,85 @@ module DCMetro
       stations_check = []
 
       # forming the api call
-      url = "https://api.wmata.com/Rail.svc/json/jStations?api_key=#{API_KEY}&subscription-key=#{API_KEY}"
-      @metro_stations = JSON.parse(RestClient.get "#{url}")
-
-      # Iterates through the response checking if the station name passed by the user
-      # is included in the return response
-      @metro_stations['Stations'].each do |station_name|
-        if station_name['Name'].downcase.include? name.downcase
-
-          # if the names of the station matches the user's station, the station
-          # is pushed to an array
-          stations_check.push(station_name)
+      @metro_stations = JSON.parse(get_all_stations)
+
+      if destination.nil?
+        # Iterates through the response checking if the station name passed by the user
+        # is included in the return response
+        @metro_stations['Stations'].each do |station_name|
+          if station_name['Name'].downcase.include? source.downcase
+            # if the names of the station matches the user's station, the station
+            # is pushed to an array
+            stations_check.push(station_name)
+          end
         end
-      end
-
-      # Oddly, the api seems to return some stations twice - since some stations have more than
-      # one line.  Though the additional station information is contained in each instance of the 
-      # station. 
-      # We limit our array to only unique station names, hopefully limiting the array to a single item
-      stations_check.uniq! { |station| station['Name'] }
-
-      # If the array length is greater than 1, we ask the user to be more specific and 
-      # return the names of the stations
-      if stations_check.length > 1
-        puts "****Multiple stations found****"
-        stations_check.each do |station|
-          puts station['Name']
-          puts station
+        # Oddly, the api seems to return some stations twice - since some stations have more than
+        # one line.  Though the additional station information is contained in each instance of the 
+        # station. 
+        # We limit our array to only unique station names, hopefully limiting the array to a single item
+        stations_check.uniq! { |station| station['Name'] }
+
+        # If the array length is greater than 1, we ask the user to be more specific and 
+        # return the names of the stations
+        if stations_check.length > 1
+          puts "****Multiple stations found****"
+          stations_check.each_with_index do |station,i|
+            puts  "#{i} #{station['Name']}"
+          end
+          puts "****Please be more specific, enter the number below ****"
+          specific = STDIN.gets.chomp.to_i
+          station_time stations_check[specific]
+        else
+          # We pass the station the station_time method to grab the predictions
+          station_time stations_check[0]
         end
-        abort "****Please be more specific****"
       else
-        # We pass the station the station_time method to grab the predictions
-        station_time stations_check[0]
+        stations = [source, destination]
+        station_code = []
+        stations.each do |station|
+          @metro_stations['Stations'].each do |station_name|
+            if station_name['Name'].downcase.include? station.downcase
+              station_code << station_name
+            end
+          end
+        end
+        station_code.uniq! { |station| station['Name'] }
+        if station_code.length > 2
+          puts "****Multiple stations found****"
+          station_code.each_with_index do |station,i|
+            puts  "#{i} #{station['Name']}"
+          end
+          puts "****Please be more specific****"
+          puts "Enter the number of your starting station."
+          start = STDIN.gets.chomp.to_i
+          puts "Enter the number of your destination station."
+          destination = STDIN.gets.chomp.to_i
+          @travel_info = RestClient.get "#{BASE_URL}/Rail.svc/json/jSrcStationToDstStationInfo", :params => {
+            "FromStationCode" => station_code[start]['Code'],
+            "ToStationCode" => station_code[destination]['Code'],
+            "api_key" => API_KEY,
+            "subscription-key" => API_KEY
+          }
+        else
+          @travel_info = RestClient.get "#{BASE_URL}/Rail.svc/json/jSrcStationToDstStationInfo", :params => {
+            "FromStationCode" => station_code[0]['Code'],
+            "ToStationCode" => station_code[1]['Code'],
+            "api_key" => API_KEY,
+            "subscription-key" => API_KEY
+          }
+        end
       end
     end ### station
 
     private 
 
+    def get_all_stations
+      return RestClient.get "#{BASE_URL}/Rail.svc/json/jStations", :params => {
+        "api_key" => API_KEY,
+        "subscription-key" => API_KEY
+      }
+    end
+
     #
     # This makes an api call to grab the train arrival and departure predictions.
     # If more than one line is present at a station, such is concatenated and 
@@ -97,8 +175,10 @@ module DCMetro
       end
 
       # The call to the api is made and the prediction times are returned
-      url = "http://api.wmata.com/StationPrediction.svc/json/GetPrediction/#{@station_code}?api_key=#{API_KEY}&subscription-key=#{API_KEY}"
-      @metro_time = JSON.parse(RestClient.get "#{url}")  
+      @metro_time = RestClient.get "#{BASE_URL}/StationPrediction.svc/json/GetPrediction/#{@station_code}", :params => {
+        "api_key" => API_KEY,
+        "subscription-key" => API_KEY
+        }
       @metro_time
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dcmetro
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ken Crocken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2016-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -80,7 +80,36 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Returns DC Metro information, including train schedules.
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Washington, DC Metro Rails information, including lines, stations and
+  arrival/departure predictions.
 email:
 - kcrocken@gmail.com
 executables:
@@ -88,13 +117,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/dcmetro
 - dcmetro.gemspec
+- features/alerts.feature
+- features/external.feature
+- features/lines.feature
+- features/station.feature
+- features/step_definitions/api_test_steps.rb
+- features/support/env.rb
 - lib/dcmetro.rb
 - lib/dcmetro/cli/application.rb
 - lib/dcmetro/version.rb
@@ -121,5 +158,11 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Returns DC Metro information, including train schedules.
-test_files: []
+summary: Returns DC Metro Rails information, including train schedules.
+test_files:
+- features/alerts.feature
+- features/external.feature
+- features/lines.feature
+- features/station.feature
+- features/step_definitions/api_test_steps.rb
+- features/support/env.rb