amtrak 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6b65ee543c0ab3f6c50c3f6af2d873fdb6ea8bf
-  data.tar.gz: 0bbe04375b423a44476f15dceaa7f85a293756fd
+  metadata.gz: 6be6d049d542cd9aba8849a9226b44db46bd9df4
+  data.tar.gz: fb1351d68d0cd8ca904a16f649af25914c30b758
 SHA512:
-  metadata.gz: 458227e5403222869fe87f704ee5ea19aeb61c936299fd5a4684979531ec473240fb5bec3df3bbd6bf7de963b2d0b7483d360cb0bdefed152ef333c49fe01a0e
-  data.tar.gz: 7e3ca8eea40bda322a3f5a7edefbf090e5a50cd6933726eb81a2919da430fc39b860fb276d3e7b8036f984c9715120f54482649c83e4edad33ab743e530840da
+  metadata.gz: 0396b5b99590d47f2503e089d756c5481d6d5d70502a33a76dc16d790bbcfe498d9cb3d9f92a9d88a11b7500f77b73099ad5b516bbf8df8b4566181aacf1a3db
+  data.tar.gz: 39a1aea72b92c97ef37fe6c28e6cba74d304453380d37bb77e9ea961c3933e6101ffd7d01a023760764d1d4993019e4a1f6686e552e0f77b5bb9d579a1e622fb

data/.rubocop.yml

@@ -4,3 +4,8 @@ Metrics/MethodLength:
   Max: 12
 Metrics/LineLength:
   Max: 100
+Style/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'

data/README.markdown

@@ -1,3 +1,185 @@
-# Amtrak
+## Amtrak
+### Pulls Amtrak train scheduled and estimated departure times 
+
+#### Installation
+
+Install `bundler` if you haven't already:
+
+```
+$ gem install bundler
+```
+
+Specify your dependencies in a Gemfile in your project's root:
+
+```
+source 'https://rubygems.org'
+gem 'amtrak'
+```
+
+In a terminal window, run:
+
+```
+$ bundle install
+$ git add Gemfile Gemfile.lock
+```
+
+#### Usage
+
+Require the Gem:
+
+```
+require 'amtrak'
+```
+
+Make a request:
+
+```
+Amtrak.get('NYP', 'PHL')
+```
+
+Example response:
+
+```
+[{:number=>89,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"06:02:00", :estimated_time=>nil},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"06:02:00", :estimated_time=>nil}},
+ {:number=>2107,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"07:00:00", :estimated_time=>nil},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"07:00:00", :estimated_time=>nil}},
+ {:number=>183,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"07:05:00", :estimated_time=>nil},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"07:05:00", :estimated_time=>nil}},
+ {:number=>641,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"07:17:00", :estimated_time=>nil},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"07:17:00", :estimated_time=>nil}},
+ {:number=>79,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"07:25:00", :estimated_time=>nil},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"07:25:00", :estimated_time=>nil}},
+ {:number=>2109,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"08:00:00", :estimated_time=>nil},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"08:00:00", :estimated_time=>nil}},
+ {:number=>185,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"08:10:00", :estimated_time=>nil},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"08:10:00", :estimated_time=>nil}},
+ {:number=>2151,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"09:00:00", :estimated_time=>"09:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"09:00:00", :estimated_time=>"09:00:00"}},
+ {:number=>643,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"09:30:00", :estimated_time=>"09:30:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"09:30:00", :estimated_time=>"09:30:00"}},
+ {:number=>141,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"09:35:00", :estimated_time=>"09:35:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"09:35:00", :estimated_time=>"09:35:00"}},
+ {:number=>2153,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"10:00:00", :estimated_time=>"10:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"10:00:00", :estimated_time=>"10:00:00"}},
+ {:number=>95,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"10:35:00", :estimated_time=>"10:35:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"10:35:00", :estimated_time=>"10:35:00"}},
+ {:number=>2155,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"11:00:00", :estimated_time=>"11:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"11:00:00", :estimated_time=>"11:00:00"}},
+ {:number=>43,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"10:52:00", :estimated_time=>"10:52:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"10:52:00", :estimated_time=>"10:52:00"}},
+ {:number=>91,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"11:02:00", :estimated_time=>"11:02:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"11:02:00", :estimated_time=>"11:02:00"}},
+ {:number=>125,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"11:35:00", :estimated_time=>"11:35:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"11:35:00", :estimated_time=>"11:35:00"}},
+ {:number=>2117,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"12:00:00", :estimated_time=>"12:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"12:00:00", :estimated_time=>"12:00:00"}},
+ {:number=>645,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"12:05:00", :estimated_time=>"12:05:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"12:05:00", :estimated_time=>"12:05:00"}},
+ {:number=>171,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"12:35:00", :estimated_time=>"12:35:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"12:35:00", :estimated_time=>"12:35:00"}},
+ {:number=>2159,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"13:00:00", :estimated_time=>"13:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"13:00:00", :estimated_time=>"13:00:00"}},
+ {:number=>609,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"12:54:00", :estimated_time=>"12:54:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"12:54:00", :estimated_time=>"12:54:00"}},
+ {:number=>2121,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"14:00:00", :estimated_time=>"14:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"14:00:00", :estimated_time=>"14:00:00"}},
+ {:number=>93,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"14:02:00", :estimated_time=>"14:02:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"14:02:00", :estimated_time=>"14:02:00"}},
+ {:number=>647,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"14:11:00", :estimated_time=>"14:11:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"14:11:00", :estimated_time=>"14:11:00"}},
+ {:number=>19,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"14:15:00", :estimated_time=>"14:15:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"14:15:00", :estimated_time=>"14:15:00"}},
+ {:number=>2163,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"15:00:00", :estimated_time=>"15:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"15:00:00", :estimated_time=>"15:00:00"}},
+ {:number=>649,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"14:44:00", :estimated_time=>"14:44:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"14:44:00", :estimated_time=>"14:44:00"}},
+ {:number=>85,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"15:05:00", :estimated_time=>"15:05:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"15:05:00", :estimated_time=>"15:05:00"}},
+ {:number=>97,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"15:15:00", :estimated_time=>"15:15:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"15:15:00", :estimated_time=>"15:15:00"}},
+ {:number=>173,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"15:35:00", :estimated_time=>"15:35:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"15:35:00", :estimated_time=>"15:35:00"}},
+ {:number=>2165,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"16:00:00", :estimated_time=>"16:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"16:00:00", :estimated_time=>"16:00:00"}},
+ {:number=>651,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"16:03:00", :estimated_time=>"16:03:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"16:03:00", :estimated_time=>"16:03:00"}},
+ {:number=>127,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"16:05:00", :estimated_time=>"16:05:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"16:05:00", :estimated_time=>"16:05:00"}},
+ {:number=>129,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"16:42:00", :estimated_time=>"16:42:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"16:42:00", :estimated_time=>"16:42:00"}},
+ {:number=>2167,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"17:00:00", :estimated_time=>"17:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"17:00:00", :estimated_time=>"17:00:00"}},
+ {:number=>653,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"17:10:00", :estimated_time=>"17:10:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"17:10:00", :estimated_time=>"17:10:00"}},
+ {:number=>193,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"17:39:00", :estimated_time=>"17:39:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"17:39:00", :estimated_time=>"17:39:00"}},
+ {:number=>2119,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"18:00:00", :estimated_time=>"18:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"18:00:00", :estimated_time=>"18:00:00"}},
+ {:number=>137,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"18:25:00", :estimated_time=>"18:25:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"18:25:00", :estimated_time=>"18:25:00"}},
+ {:number=>655,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"18:35:00", :estimated_time=>"18:35:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"18:35:00", :estimated_time=>"18:35:00"}},
+ {:number=>2171,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"19:00:00", :estimated_time=>"19:00:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"19:00:00", :estimated_time=>"19:00:00"}},
+ {:number=>55,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"18:45:00", :estimated_time=>"18:45:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"18:45:00", :estimated_time=>"18:45:00"}},
+ {:number=>175,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"19:40:00", :estimated_time=>"19:40:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"19:40:00", :estimated_time=>"19:40:00"}},
+ {:number=>2173,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"20:13:00", :estimated_time=>"20:13:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"20:13:00", :estimated_time=>"20:13:00"}},
+ {:number=>2175,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"21:05:00", :estimated_time=>"21:05:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"21:05:00", :estimated_time=>"21:05:00"}},
+ {:number=>187,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"21:10:00", :estimated_time=>"21:10:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"21:10:00", :estimated_time=>"21:10:00"}},
+ {:number=>177,
+  :departure=>{:date=>"2017-10-12", :scheduled_time=>"22:05:00", :estimated_time=>"22:05:00"},
+  :arrival=>{:date=>"2017-10-12", :scheduled_time=>"22:05:00", :estimated_time=>"22:05:00"}}]
+```
 
-Pulls down the train times from the Amtrak website

data/amtrak.gemspec

@@ -17,13 +17,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'mechanize', '~> 2.7'
-  spec.add_dependency 'nokogiri', '~> 1.6.4'
+  spec.add_dependency 'excon', '~> 0.59'
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rspec', '~> 3.0.0'
-  spec.add_development_dependency 'rubocop', '~> 0.25.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'simplecov', '~> 0.8.2'
   spec.add_development_dependency 'vcr', '~> 2.9.2'
   spec.add_development_dependency 'webmock', '~> 1.24'

data/lib/amtrak.rb

@@ -9,9 +9,8 @@ module Amtrak
   end
 
   def self.get(from, to, date: nil)
-    Amtrak::TrainFetcher.get(from, to, date: date).map do |html|
-      Amtrak::TrainParser.parse(html)
-    end.flatten
+    json = Amtrak::TrainFetcher.get(from, to, date: date)
+    Amtrak::TrainParser.parse(json)
   end
 end
 

data/lib/amtrak/train_fetcher.rb

@@ -1,10 +1,9 @@
-require 'mechanize'
+require 'json'
+require 'excon'
 
 module Amtrak
   # Service for getting train time HTML page from the Amtrak website
   class TrainFetcher
-    class Error < Amtrak::Error; end
-
     def self.get(*args)
       new(*args).get
     end
@@ -14,7 +13,7 @@ module Amtrak
     def initialize(from, to, date: nil)
       @from = from
       @to = to
-      @date = date
+      @date = date || Date.today
     end
 
     def check_release
@@ -22,36 +21,34 @@ module Amtrak
     end
 
     def get
-      requests = [first_page.body]
-
-      (2..total_pages).each do |page|
-        requests << Amtrak::TrainFetcher::TrainPage.get(agent, page)
-      end
-
-      requests
+      JSON.parse(response.body)
     end
 
-    def first_page
-      @first_page ||= Amtrak::TrainFetcher::MainPage.new(agent, from, to, date: date)
-    end
+    private
 
-    def total_pages
-      return @total_pages if @total_pages
-
-      total_pages = first_page.total_pages
-      Amtrak.logger.debug "Total pages: #{total_pages}"
+    def response
+      Excon.post(
+        'https://rider.amtrak.com/MobileApps/TrainStatus',
+        body: body.to_json,
+        headers: headers
+      )
+    end
 
-      @total_pages = total_pages
+    def body
+      {
+        'dateTime' => date.strftime('%Y-%0m-%d'),
+        'origin' => from.upcase,
+        'destination' => to.upcase,
+        'type' => 'A',
+        'versionNumber' => '2.2.12'
+      }
     end
 
-    def agent
-      @agent ||= Mechanize.new.tap do |m|
-        m.user_agent_alias = 'Mac Safari'
-        m.log = Amtrak.logger
-      end
+    def headers
+      {
+        'Accept' => '*/*',
+        'Content-Type' => 'application/json'
+      }
     end
   end
 end
-
-require 'amtrak/train_fetcher/main_page'
-require 'amtrak/train_fetcher/train_page'

data/lib/amtrak/train_parser.rb

@@ -1,92 +1,40 @@
-require 'nokogiri'
-
 module Amtrak
-  # Will take in an HTML document as a string and parse out the train schedule
+  # Will take in an JSON document as a hash and parse out the train schedule
   class TrainParser
     # Error raised when the parser runs into an issue
     class Error < Amtrak::Error; end
 
-    def self.parse(text)
-      new(text).parse
+    def self.parse(json)
+      new(json).parse
     end
 
-    attr_reader :document
+    attr_reader :json
 
-    def initialize(document)
-      @document = Nokogiri::HTML.parse(document)
+    def initialize(json)
+      @json = json
     end
 
     def parse
-      trains = []
-
-      while train_node = train_nodes.shift
-        cancelled = cancelled?(train_node)
-        trains << {
-          number: parse_train_number(train_node),
-          departure: parse_train(find_depart_status(train_node), cancelled),
-          arrival: parse_train(find_arrive_status(train_node), cancelled)
-        }
-      end
-
-      trains
-    rescue Nokogiri::SyntaxError => ex
-      raise Amtrak::TrainParser::Error, "#{ex.class} #{ex.message}"
-    end
-
-    def train_nodes
-      @train_nodes ||= document.search(
-        "//div[@id='train_status_resp_by_citypair']"
-      ).to_a
-    end
-
-    def cancelled?(node)
-      node.search(".//div[@class='cancelledMsg']").count > 0
-    end
-
-    def find_depart_status(node)
-      find!(node, ".//div[@id='resp_by_citypair_depart_status_details']")
-    end
-
-    def find_arrive_status(node)
-      find!(node, ".//div[@id='resp_by_citypair_arrive_status_details']")
-    end
-
-    def parse_train_number(node)
-      number = parse_train_number_25(node)
-      return number unless number.zero?
-
-      parse_train_number_22(node)
+      json['journeys']
+        .map(&method(:parse_journey))
+        .compact
     end
 
-    def parse_train_number_25(node)
-      find!(
-        node,
-        ".//div[@id='resp_by_citypair_subheading']/\
-        div[@id='resp_by_citypair_subheading_trainname']/div/text()"
-      ).to_s.to_i
-    end
+    def parse_journey(journey)
+      segment = journey['segments'].first
+      return unless segment
 
-    def parse_train_number_22(node)
-      node.search(
-        ".//div[@id='resp_by_citypair_subheading']/\
-        div[@id='resp_by_citypair_subheading_trainname']/text()"
-      ).first.to_s.to_i
+      {
+        number: segment['trainNumber'].to_i,
+        departure: find_departure_times(segment),
+        arrival: find_arrival_times(segment)
+      }
     end
 
-    def parse_train(node, cancelled) # rubocop:disable Metrics/MethodLength
-      date = find!(
-        node, ".//div[@class='arriveDepartDate']/text()"
-      ).to_s
-      if cancelled
-        estimated_time = scheduled_time = 'Cancelled'
-      else
-        scheduled_time = clean_msg(
-          find!(node, ".//div[@class='scheduledArriveDepartMsg']/text()").to_s
-        )
-        estimated_time = find(
-          node, ".//div[@class='arriveDepartTime']/text()"
-        ).to_s
-      end
+    def find_departure_times(segment)
+      date, scheduled_time = segment['originScheduledDepartureDateTime'].split('T')
+      estimated_depart = segment['originEstimatedDepartureDateTime']
+      _, estimated_time = estimated_depart.split('T') if estimated_depart
 
       {
         date: date,
@@ -95,20 +43,16 @@ module Amtrak
       }
     end
 
-    def find!(node, xpath)
-      node.search(xpath).tap { |rs| fail "#{rs.count} results" if rs.count > 1 }
-    end
-
-    def find(node, xpath)
-      find!(node, xpath)
-    rescue RuntimeError
-      nil
-    end
+    def find_arrival_times(segment)
+      date, scheduled_time = segment['originScheduledDepartureDateTime'].split('T')
+      estimated_arrival = segment['originEstimatedDepartureDateTime']
+      _, estimated_time = estimated_arrival.split('T') if estimated_arrival
 
-    def clean_msg(time_msg)
-      return unless matches = /\d+:\d+ (a|p)m/.match(time_msg)
-
-      matches[0]
+      {
+        date: date,
+        scheduled_time: scheduled_time,
+        estimated_time: estimated_time
+      }
     end
   end
 end