dcmetro 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90891b8942382cbf830daf11826f4d4d019931a9
-  data.tar.gz: 18fcafc5a952ae46cc8264404e8a459841398307
+  metadata.gz: 26b4e560cc10b94ec132c545fdfbaf56ab923126
+  data.tar.gz: 10e8f6c5602fe8de59a982a6f31d4880be270623
 SHA512:
-  metadata.gz: 9203bd85d858944c7f9729f98b5d4b3d2b85937c60d676701b3f1ff616d3960b960a5d5fe411d7be5db5196efac575b3157dd36eb6d8a01c7b8d0e7c24f52428
-  data.tar.gz: 82a9046f638381d1e2f808cb819a7d523184d1f2fdf72fae2e3846304f4499928ff00cdde1e3040b3291c73b5245877d588e00079d6cf3f3f114e73734f79f5f
+  metadata.gz: 5e321972a4fecd6ba6b16d6f3ff47ed1a199f7aebbf266fbccf8072af52ecfd979b80a2413f6b09ab522017d9c270878a838be281073f881b81a255727de1d85
+  data.tar.gz: 345a453a721b5583d19c4e96bdc7ab550d92133ddb62ecba4f00dd97df92b3fac7d6fb9ea5f54e2efd787fbe391d9f7440db4d5e9da4005f9e16309dd3946f40

data/bin/dcmetro

@@ -1,7 +1,16 @@
 #!/usr/bin/env ruby
 
-API_KEY="n2z9aq3redes6k7jekjfzk8q"   #"kfgpmgvfgacx98de9q3xazww"  #developer's key
+# You need to set an ENV variable in the shell which will be the Api Key.
+# It is free from WMATA, https://developer.wmata.com/
+# Referenced below was the old generic key used for testing the API on WMATA's site.
+# Since api keys are free I would suggest registering for one, the rate limit is
+# 10 calls/second, 50,000 calls/day which is pretty good.  The generic key below had
+# significant limits
+#
+#
+API_KEY=ENV['DCMETRO_KEY'] #generic developer's key "kfgpmgvfgacx98de9q3xazww"
 
+# The below colors are for experimenting with providing color
 # Color Reset
 COLOR_OFF="\033[0m"       # Text Reset
 
@@ -14,6 +23,5 @@ YELLOW="\033[0;93m"       # IYellow
 BLUE="\033[0;94m"         # IBlue
 
 require 'dcmetro'
-# require_relative "dcmetro/cli/application"
 
 DCMetro::Cli::Application.start(ARGV)

data/dcmetro.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ken Crocken"]
   spec.email         = ["kcrocken@gmail.com"]
   spec.summary       = %q{Returns DC Metro information, including train schedules.}
-  # spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = ""
+  spec.description   = %q{Returns DC Metro information, including train schedules.}
+  spec.homepage      = "https://github.com/kencrocken/dcmetro"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'thor', '~> 0.18'
   spec.add_dependency 'json'
-  spec.add_dependency 'rest_client'
+  spec.add_dependency 'rest-client'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/lib/dcmetro/cli/application.rb

@@ -2,18 +2,32 @@ require 'thor'
 require 'json'
 require 'rest_client'
 
+#
+# This is the command line interface using Thor
+
 module DCMetro
   module Cli
     class Application < Thor
 
       desc 'alerts', 'Display DC Metro system wide alerts.'
       def alerts
+        #
+        # $dcmetro alerts
+        # => *** Alert! Alert! ***
+
         x = DCMetro::Information.new
         display_alerts x.alerts
       end
 
       desc 'line COLOR', 'Display metro rail lines, if COLOR, displays rail stations on the COLOR line'
       def line color=nil
+        #
+        # $dcmetro line
+        # => Orange, Blue, Silver, Red, etc ...
+        #
+        # $dcmetro line Red
+        # => Displays the stations on the Red Line
+
         x = DCMetro::Information.new
 
         if !color.nil?
@@ -26,6 +40,14 @@ module DCMetro
       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)
+        #
+        # $dcmetro station Greenbelt
+        # => Displays the departure and arrival times at the Greenbelt Station
+        #
+        # $dcmetro station Greenbelt -a
+        # => Displays the alerts, departure and arrival times at the Greenbelt Station
+        #
+
         x = DCMetro::Information.new
 
         if options[:alerts]
@@ -37,7 +59,6 @@ module DCMetro
         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
-
       end
 
       private
@@ -45,6 +66,9 @@ module DCMetro
       no_commands do
 
         def display_alerts alerts
+          #
+          # Formats the display of the alerts
+          
           if alerts['Incidents'].empty?
             puts "*** No alerts reported. ***"
           else 
@@ -54,6 +78,9 @@ module DCMetro
         end
 
         def display_trains trains
+          #
+          # Formats the display of the train arrival and departures
+
           puts  "===== #{trains[0]['LocationName']} ====="
           trains.each do |prediction|
             puts "Line: #{prediction['Line']} | Towards: #{prediction['DestinationName']} | Arriving: #{prediction['Min']}"

data/lib/dcmetro/version.rb

@@ -1,3 +1,13 @@
 module Dcmetro
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end
+
+### Changes in 0.0.2
+#
+# Updates the api calls to the new format
+#
+# Fixes a bug if multiple stations are returned
+#
+# Requires the use of an env variable for the API key
+#
+# Requires rest-client

data/lib/dcmetro.rb

@@ -6,21 +6,28 @@ module DCMetro
     attr_accessor :metro_incidents, :metro_lines, :metro_stations, :station_code, :metro_time
 
     def initialize
-      @metro_incidents = JSON.parse(RestClient.get "http://api.wmata.com/Incidents.svc/json/Incidents?api_key=#{API_KEY}")
-      @metro_lines = JSON.parse(RestClient.get "http://api.wmata.com/Rail.svc/json/JLines?api_key=#{API_KEY}")
+      @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_stations = metro_stations
       @station_code = ""
       @metro_time = metro_time
     end
 
     def alerts
+      #
+      # Makes the api call and returns the alerts
+
       @metro_incidents
     end ### alerts
 
     def line(color=nil)
+      #
+      # Makes the api call and returns either the stations on a particular line or
+      # if no color is passed, returns the metro lines
+
       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}")
+        @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']
       else
         @metro_lines['Lines']
@@ -28,21 +35,59 @@ module DCMetro
     end ### line
 
     def station(name)
-      url = "http://api.wmata.com/Rail.svc/json/jStations?api_key=#{API_KEY}"
+      #
+      # Makes the api call to return all stations in the Metro rail system and
+      # then grabs the specific station passed by the user
+
+      # instantiates a new array to help check for multiple matching stations
+      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
-          x = station_time station_name
-          return x
+
+          # 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
+
+      # 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
+        end
+        abort "****Please be more specific****"
+      else
+        # We pass the station the station_time method to grab the predictions
+        station_time stations_check[0]
+      end
     end ### station
 
     private 
 
+    #
+    # 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 
+    # the call is made on all lines.
+
     def station_time(station)
 
-      # puts station['Code']
+      # If a station has multiple stations codes we join the codes together
       @station_code = station['Code']
       if !station['StationTogether1'].empty?
         @station_code += ",#{station['StationTogether1']}"
@@ -50,18 +95,13 @@ module DCMetro
       if !station['StationTogether2'].empty?
         @station_code += ",#{station['StationTogether2']}"
       end
-      # p @station_code.class
-      # @station_code = @station_code[1].nil? ? @station_code[0] : @station_code.join(",")
 
-      # p @station_code
-      url = "http://api.wmata.com/StationPrediction.svc/json/GetPrediction/#{@station_code}?api_key=#{API_KEY}"
-      # p url
+      # 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}")  
-      # p @metro_time 
       @metro_time
     end
 
-
   end ### Information
 
 end ### Metro

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dcmetro
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ken Crocken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest_client
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Returns DC Metro information, including train schedules.
 email:
 - kcrocken@gmail.com
 executables:
@@ -98,7 +98,7 @@ files:
 - lib/dcmetro.rb
 - lib/dcmetro/cli/application.rb
 - lib/dcmetro/version.rb
-homepage: ''
+homepage: https://github.com/kencrocken/dcmetro
 licenses:
 - MIT
 metadata: {}
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Returns DC Metro information, including train schedules.