gobart 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8d18e0bb8ff3dfda30f8ce6e455a8ea3e418b26
+  data.tar.gz: a9ef7ba60d975f745de80b0913504b4c8fc81ef6
+SHA512:
+  metadata.gz: b5b08fba3377ad6c413d019abf44af9fdc7ac8e92c2a154aa9d09d7b30843236de39129b73db255dc2fa983b537825358a40e1f32fc7c9cc180023f96d575d3b
+  data.tar.gz: 5c2c187faaab7457dfb2478a71ab6fe5de1927780b75ab7d0644b7762ff8d1f0c76903db56e0f0aa34234cb747cc70e226634e43dae9a127e021005847ef5c10

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.14.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bentonwong@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gobart.gemspec
+gem 'pry'
+gem 'nokogiri', '1.6.6.2'
+gem 'rspec'
+gem 'rake'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 bentonwong
+
+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,46 @@
+# Gobart
+
+This gem will provide a simple and quick way to get real time departures and individual station information from a CLI interface for every station in the Bay Area Rapid Transit (BART) system.
+
+The data is pulled directly from api.bart.gov.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gobart'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gobart
+
+## Usage
+
+To use the program:
+
+1. Install the gem.
+2. Type "gobart" to start the program.
+3. Enter the 4 letter station code for the station you want to get information on.
+4. Enter "i" if you want more information about the station.
+5. Optional: you can check other stations.  Your search history for the session is saved and displayed for your convenience.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bentonwong/gobart. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gobart"
+require "pry"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/gobart

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../lib/gobart.rb"
+
+Controller.new.run

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gobart.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gobart/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gobart"
+  spec.version       = Gobart::VERSION
+  spec.authors       = ["Benton Wong"]
+  spec.email         = ["bentonwong@gmail.com"]
+
+  spec.summary       = %q{Real time BART.gov departure information from CLI interface.}
+  spec.description   = %q{This gem will provide a simple and quick way to get real time departures and individual station information from a CLI interface for every station in the Bay Area Rapid Transit (BART) system.}
+  spec.homepage      = "https://github.com/bentonwong/gobart"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  #spec.bindir        = "exe"
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/gobart.rb

@@ -0,0 +1,4 @@
+require_relative "./gobart/version"
+require_relative "./gobart/controller"
+require_relative "./gobart/station"
+require_relative "./gobart/scraper"

data/lib/gobart/controller.rb

@@ -0,0 +1,174 @@
+require_relative "../gobart/scraper.rb"
+require_relative "../gobart/station.rb"
+require 'nokogiri'
+require 'pry'
+
+class Controller
+
+  attr_accessor :name, :advisories, :station_instance
+
+  STATIONS = [{:code => "12th", :station => "12th St. Oakland City Center"},
+          {:code => "16th", :station => "16th St. Mission (SF)"},
+          {:code => "19th", :station => "19th St. Oakland"},
+          {:code => "24th", :station => "24th St. Mission (SF)"},
+          {:code => "ashb", :station => "Ashby (Berkeley)"},
+          {:code => "balb", :station => "Balboa Park (SF)"},
+          {:code => "bayf", :station => "Bay Fair (San Leandro)"},
+          {:code => "cast", :station => "Castro Valley"},
+          {:code => "civc", :station => "Civic Center (SF)"},
+          {:code => "cols", :station => "Coliseum"},
+          {:code => "colm", :station => "Colma"},
+          {:code => "conc", :station => "Concord"},
+          {:code => "daly", :station => "Daly City"},
+          {:code => "dbrk", :station => "Downtown Berkeley"},
+          {:code => "dubl", :station => "Dublin/Pleasanton"},
+          {:code => "deln", :station => "El Cerrito del Norte"},
+          {:code => "plza", :station => "El Cerrito Plaza"},
+          {:code => "embr", :station => "Embarcadero (SF)"},
+          {:code => "frmt", :station => "Fremont"},
+          {:code => "ftvl", :station => "Fruitvale (Oakland)"},
+          {:code => "glen", :station => "Glen Park (SF)"},
+          {:code => "hayw", :station => "Hayward"},
+          {:code => "lafy", :station => "Lafayette"},
+          {:code => "lake", :station => "Lake Merritt (Oakland)"},
+          {:code => "mcar", :station => "MacArthur (Oakland)"},
+          {:code => "mlbr", :station => "Millbrae"},
+          {:code => "mont", :station => "Montgomery St. (SF)"},
+          {:code => "nbrk", :station => "North Berkeley"},
+          {:code => "ncon", :station => "North Concord/Martinez"},
+          {:code => "oakl", :station => "Oakland Int'l Airport"},
+          {:code => "orin", :station => "Orinda"},
+          {:code => "pitt", :station => "Pittsburg/Bay Point"},
+          {:code => "phil", :station => "Pleasant Hill"},
+          {:code => "powl", :station => "Powell St. (SF)"},
+          {:code => "rich", :station => "Richmond"},
+          {:code => "rock", :station => "Rockridge (Oakland)"},
+          {:code => "sbrn", :station => "San Bruno"},
+          {:code => "sfia", :station => "San Francisco Int'l Airport"},
+          {:code => "sanl", :station => "San Leandro"},
+          {:code => "shay", :station => "South Hayward"},
+          {:code => "ssan", :station => "South San Francisco"},
+          {:code => "ucty", :station => "Union City"},
+          {:code => "warm", :station => "Warm Springs/South Fremont"},
+          {:code => "wcrk", :station => "Walnut Creek"},
+          {:code => "wdub", :station => "West Dublin"},
+          {:code => "woak", :station => "West Oakland"}]
+
+  def display_stations #displays stations and codes upon request by user
+    STATIONS.each do |info|
+      puts "#{info[:station]} (#{info[:code]})"
+    end
+  end
+
+#--------------------------------------------------------
+  def welcome #provides a nice welcome message with the current time.
+    puts "\nReal Time BART.gov Train Departures"
+    puts "\nCurrent time is #{Time.now}"
+  end
+#--------------------------------------------------------
+  def get_input #returns valid BART station code; for complete list, go to http://api.bart.gov/docs/overview/abbrev.aspx
+    if !Station.all.empty?
+      print "\n(Recent searches: #{Station.all.collect {|x| x.name}})\n"
+    end
+
+    valid_station = false #sets the flag for the loop below
+
+    while valid_station == false #checks to make sure the user is entering a valid station
+      puts "\nEnter departure station code (e.g. \'woak\' for West Oakland) for real time departure information (type 'list' for codes):"
+      station = gets.strip.downcase
+      if station == "list"
+        display_stations
+      elsif STATIONS.detect {|x| x[:code] == station} #validates response using chart above
+        valid_station = true
+      else
+        puts "\n ALERT! Invalid station code -> try again"
+      end
+    end
+    station #returns the station value
+  end
+#-----------------------------------------------------------
+  def handle_request #controls the fulfillment of the query; because the fulfillment process is complex, this method was written to simplify and better manage the calls to the various processes.
+    done = false
+    while done == false
+      station = get_input
+      process_request(station)
+      display_results(station)
+      done = check_if_done
+    end
+  end
+
+  def process_request(station) #determines if the station request already has an instance; if it does, it does not create another one. regardless of the outcome, a call is made to the station class to get updates from the BART api
+    if !Station.all.detect {|x| x.instance_variable_get("@name") == station}
+      @station_instance = Station.new(station) #creates a new station instance if it does not already exist in the Station.all
+    else
+      @station_instance = Station.all.detect {|x| x.instance_variable_get("@name") == station}
+    end
+      station_instance.call(station)
+  end
+
+  def converter(status_data) #converts the status data into a more user friendly, easier to read format
+    status_data.each do |x|
+      puts ">>Destination: #{x[:destination]} (#{x[:abbreviation]})" #displays destination info
+
+      combined_array = x[:arrivals].zip(x[:cars]) #combines the arrivals and cars arrays so they can be displayed together below
+      combined_array.each do |x|
+        puts "#{x[0]} min (#{x[1]} cars)" #displays the arrivals and cars information
+      end
+    end
+  end
+
+  def display_results(station) #displays real time station data returned from the station instance
+    puts "\n#{station.upcase} departures as of #{Time.now}\n"
+    converter(station_instance.status)
+    puts "\n*** Station Advisory ***\n"
+    puts station_instance.advisories
+    puts "\nThere are #{Scraper.scrape_train_count} trains running systemwide at this time.\n"
+    puts ""
+    puts "Data provided by BART.gov. Real time train departure data available at https://www.bart.gov/schedules/eta."
+  end
+
+  def check_if_done #checks if the user is done with this session and checks for valid responses
+    input_validator = false
+    info_request = false
+    while input_validator == false && info_request == false
+      puts "\nCheck another station? [\'y\'/\'n\' or \'i\' for above station information]"
+
+      check = gets.strip.downcase
+      if check == 'y' || check == 'n'
+        input_validator = true
+      elsif check == 'i'
+        puts "\n#{station_instance.info}"
+        done = false
+      else
+        puts "\nALERT! Invalid response --> type \'y\'/\'n\' or \'i\'"
+      end
+    end
+
+    if check == 'y'
+      done = false
+    else
+      done = true
+    end
+    done
+  end
+
+#----------------------------------------------------------------------
+
+  def goodbye #prints search history for the session and leaves user with pleasant wishes
+
+    if !Station.all.empty?
+      print "\n(Search history for this session: #{Station.all.collect {|x| x.name}})\n"
+    end
+
+    puts "\nHave a safe and pleasant journey!\n"
+  end
+
+#-----------------------------------------------------------------------
+
+  def run #entry point into the controller from the bin file
+    welcome
+    handle_request
+    goodbye
+  end
+
+end

data/lib/gobart/scraper.rb

@@ -0,0 +1,57 @@
+require "pry"
+require "open-uri"
+require "Nokogiri"
+
+class Scraper
+
+KEY = "ZKZB-PQE6-92VT-DWE9" #BART.gov API Developer Key required to access its APIs
+
+  def self.scrape_api(station_code) #used by self.get_line_destinations & self.get_train_status
+    edt_api = "http://api.bart.gov/api/etd.aspx?cmd=etd&orig=#{station_code}&key=#{KEY}"
+    doc = Nokogiri::HTML(open(edt_api))
+  end
+
+  def self.get_line_destinations(station_code) #gets the real time updates
+    doc = Scraper.scrape_api(station_code)
+    doc.css("station etd").css("abbreviation").collect {|x| x.text}
+  end
+
+  def self.get_train_status(station_code) #gets real time departure times
+    doc = Scraper.scrape_api(station_code)
+    output = doc.css('station etd').map do |etd|
+      {
+        destination: etd.css('destination').text,
+        abbreviation: etd.css('abbreviation').text,
+        arrivals: reformat(etd.css('estimate').map { |e| e.css('minutes').text.to_i }),
+        cars: (etd.css('estimate').map { |e| e.css('length').text.to_i })
+      }
+    end
+    output
+  end
+
+  def self.reformat(eta) #reformats the minutes data to show 'now' when it is 0
+     eta.map do |time|
+       time == 0 ? 'now' : "#{time}"
+     end
+  end
+
+  def self.get_station_info(station_code) #get station info as provided by BART
+    stnt_info_api = "http://api.bart.gov/api/stn.aspx?cmd=stnaccess&orig=#{station_code}&l=1&key=#{KEY}"
+    doc = Nokogiri::HTML(open(stnt_info_api))
+    output = doc.css("//stations").text
+    output
+  end
+
+  def self.scrape_advisory(station_code) #gets system advisories
+    adv_api = "http://api.bart.gov/api/bsa.aspx?cmd=bsa&orig=#{station_code}&key=#{KEY}"
+    doc = Nokogiri::XML(open(adv_api))
+    advisories = doc.search('description').children.find{|e| e.cdata?}.text
+  end
+
+  def self.scrape_train_count #gets the current count of the trains currently running in the system
+    tc_api = "http://api.bart.gov/api/bsa.aspx?cmd=count&key=#{KEY}"
+    doc = Nokogiri::HTML(open(tc_api))
+    count = doc.css("traincount").text
+  end
+
+end

data/lib/gobart/station.rb

@@ -0,0 +1,34 @@
+require 'pry'
+
+class Station
+
+attr_accessor :name, :info, :status, :advisories
+
+@@all =[]
+
+  def initialize(station) #creates a new instance of a station
+    @name = station
+    @info = Scraper.get_station_info(station)
+    @status = {}
+    @advisories = ""
+    @@all << self
+  end
+
+  def call(station) #initiates instance methods after initialization of the instance
+    get_train_status(station)
+    update_advisories(station)
+  end
+
+  def get_train_status(station) #triggers a call to the BART api for train status and returns that data
+    @status = Scraper.get_train_status(station)
+  end
+
+  def update_advisories(station) #triggers a call to the BART api for system advisories and returns that data
+    @advisories = Scraper.scrape_advisory(station)
+  end
+
+  def self.all #displays all the created instance for stations which is used to display search history; future development could include using this to suggest to the user nearby stations to search
+    @@all
+  end
+
+end

data/lib/gobart/version.rb

@@ -0,0 +1,3 @@
+module Gobart
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: gobart
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benton Wong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem will provide a simple and quick way to get real time departures
+  and individual station information from a CLI interface for every station in the
+  Bay Area Rapid Transit (BART) system.
+email:
+- bentonwong@gmail.com
+executables:
+- console
+- gobart
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/gobart
+- bin/setup
+- gobart.gemspec
+- lib/gobart.rb
+- lib/gobart/controller.rb
+- lib/gobart/scraper.rb
+- lib/gobart/station.rb
+- lib/gobart/version.rb
+homepage: https://github.com/bentonwong/gobart
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Real time BART.gov departure information from CLI interface.
+test_files: []