PGA_Tour_Reader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ceef849d0cb2a835f53442ed7a27788d19cca3609fc6c4c027e8c31011843f67
+  data.tar.gz: 216e10d37856a44868ba699a6427f145e1fa6ff49cb86d36248d0d91d45a1792
+SHA512:
+  metadata.gz: 6157912ffdc4297137c06fd68fd963d5933bebb8a4176e4aa8e8d647451f7b10871ba565bb219c693ca71bd39a0d84f157c8ce5591ff006d80614bc3750f9fb0
+  data.tar.gz: 73446c0f19a7b0195e004fc1594dcfaf834e40da12d696dabed3815bc88c6ce142430009071b9cbdcd4c8f1a42010dda3cd0a424ba831fb69f41d8be10aa3bac

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 'taylor@thewilliams.net'. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in PGA_Tour_Reader.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    PGA_Tour_Reader (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.3)
+      mini_portile2 (~> 2.3.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  PGA_Tour_Reader!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 'Taylor Williams'
+
+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/PGA_Tour_Reader.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "PGA_Tour_Reader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "PGA_Tour_Reader"
+  spec.version       = PGATourReader::VERSION
+  spec.authors       = ["'Taylor Williams'"]
+  spec.email         = ["'taylor@thewilliams.net'"]
+
+  spec.summary       = %q{PGATourReader scrapes information from the PGATour website and loads the information into a CLI}
+  spec.homepage      = "https://github.com/Taylor-Williams/PGA_Tour_Reader"
+  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"] = "rubygems.org"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/README.md

@@ -0,0 +1,43 @@
+# PGATourReader
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/PGA_Tour_Reader`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'PGA_Tour_Reader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install PGA_Tour_Reader
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/'Taylor-Williams'/PGA_Tour_Reader. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PGATourReader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/'Taylor-Williams'/PGA_Tour_Reader/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/PGA_Tour_Reader

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+
+require './lib/PGA_Tour_Reader'
+
+PGATourReader::CLI.new.call

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "PGA_Tour_Reader"
+
+# 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"
+require 'nokogiri'
+require 'open-uri'
+IRB.start(__FILE__)

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/lib/PGA_Tour_Reader.rb

@@ -0,0 +1,10 @@
+require_relative "./PGA_Tour_Reader/version"
+require_relative "./PGA_Tour_Reader/cli.rb"
+require_relative "./PGA_tournament.rb"
+require_relative "./PGA_season.rb"
+require_relative "./PGA_Tour_scraper.rb"
+require_relative "./PGA_Tour_parser.rb"
+require_relative "./PGA_Tour_Reader/cli_helper.rb"
+require 'date'
+require 'open-uri'
+require 'nokogiri'

data/lib/PGA_Tour_Reader/cli.rb

@@ -0,0 +1,38 @@
+class PGATourReader::CLI
+
+  def call
+    puts "Welcome to the PGA Tour Reader!"
+    prompt
+  end
+
+  def prompt
+    puts ""
+    puts "say \"list\" to list all the tournaments for the current PGA Tour season"
+    puts "for all the tournaments of a specific month type the month number (1-12)"
+    puts "for a specific tournament list any date it was played (mm/dd)"
+    puts "say \"exit\" to quit from PGA_Tour_Reader"
+    puts ""
+    get_requested_info(gets.strip.downcase)
+  end
+
+  def get_requested_info(request)
+    unless request == "exit"
+      case
+      when request == "list"
+        PGATourReader::PGA_Tour_Scraper.new()
+        PGATourReader::PGA_Season.get_season_by_year(Time.now.strftime("%Y")).list_all_for_season
+      when PGATourReader::CLI_Helper.is_month_day?(request)
+        PGATourReader::CLI_Helper.select_tournament(PGATourReader::PGA_Season.get_tournament(request))
+      when PGATourReader::CLI_Helper.is_month?(request)
+        puts ""
+        PGATourReader::PGA_Season.get_tournaments_by_month(request).each{|tournament| tournament.print_date_name}
+        puts ""
+      else
+        puts "I'm not sure what you said can you please give me a"
+        puts "request in the format requested, case insensitive."
+      end
+      prompt
+    end
+  end
+
+end

data/lib/PGA_Tour_Reader/cli_helper.rb

@@ -0,0 +1,44 @@
+class PGATourReader::CLI_Helper
+
+  def self.is_month_day?(request)
+    date = request.split("/") if /\A\d\d?\/\d\d?\z/ =~ request
+    date[0].to_i.between?(1,12) && date[1].to_i.between?(1,31) if date
+  end
+
+  def self.is_month?(request)
+    /\A\d\d?\z/ =~ request && request.to_i.between?(1,12)
+  end
+
+  def self.select_tournament(tournament)
+    if tournament
+      puts "you have selected the following tournament:"
+      puts ""
+      tournament.print_date_name
+      puts ""
+      puts "If you want a specific attribute type one of the below:"
+      tournament.list_attributes
+      puts ""
+      puts "If you want a list of all the information type \"list\""
+      puts "If you want to exit this menu type \"exit\""
+      puts ""
+      input = gets.strip.downcase
+      unless input == "exit"
+        case
+        when input == "list"
+          puts ""
+          tournament.print_attributes
+          puts ""
+        when tournament.is_attribute?(input)
+          puts ""
+          tournament.get_attribute(input)
+          puts ""
+        else
+          puts "please list a valid attribute or type \"list\" or \"exit\""
+        end
+        self.select_tournament(tournament)
+      end
+    else
+      puts "you didn't input the date of an official PGA tournament"
+    end
+  end
+end

data/lib/PGA_Tour_Reader/version.rb

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

data/lib/PGA_Tour_parser.rb

@@ -0,0 +1,43 @@
+class PGATourReader::PGA_Tour_Parser
+
+  #returns array of 2 dates, start at [0] end at [1]
+  def self.date_parser(month, days)
+    if /\d/ =~ month #when tourny weekend spans end of month
+      start_date = Date.parse("#{month} #{@year}")
+      end_date = Date.parse("#{days} #{@year}")
+    else #when tourny weekend starts and ends same month
+      days = days.split(" - ")
+      start_date = Date.parse("#{month} #{days[0]} #{@year}")
+      end_date = Date.parse("#{month} #{days[1]} #{@year}")
+    end
+    [self.set_year(start_date), self.set_year(end_date)]
+  end
+
+  #corrects the year for tournaments at the beginning of season
+  def self.set_year(date)
+    date.month.between?(10,12) ? date << 12 : date #new seasons start in oct (month 10)
+  end
+
+  #retuns hash of name, course, location (always) and purse, url if available
+  def self.attribute_parser(tournament_info)
+    attribute_text = tournament_info.children[4].text.split(/\s{2,}/)
+    attribute_text.shift
+    attributes = {
+      :name => tournament_info.children[1].children[0].text,
+      :url => self.url_parser(tournament_info),
+      :course => attribute_text[0].split(",")[0],
+      :location => "#{attribute_text[1]}#{attribute_text[2]}"[0..-2]
+    }
+    attributes[:purse] = "#{attribute_text[3].split(":")[1].strip}" if attribute_text.length == 4
+    attributes
+  end
+
+  #returns standardized url (if there is one) into https:// format
+  def self.url_parser(tournament_info)
+    url = tournament_info.children[1].attributes["href"]
+    if url
+      url.value.start_with?("/") ? url = "https://www.pgatour.com#{url.value}" : url = url.value
+    end
+  end
+
+end

data/lib/PGA_Tour_scraper.rb

@@ -0,0 +1,33 @@
+class PGATourReader::PGA_Tour_Scraper
+
+  attr_accessor :path, :year, :season
+
+  def initialize(year = Time.now.strftime("%Y"), path = "https://www.pgatour.com/tournaments/schedule.html")
+    @path = path
+    @year = year
+    @season = PGATourReader::PGA_Season.new(@year)
+    scrape_tour_page
+  end
+
+  #scrapes parses and zips all tournaments and their attributes for a season
+  def scrape_tour_page
+    page = Nokogiri::HTML(open("#{@path}"))
+    date_scraper(page) #instantiates all tournaments from this season by dates
+    tournament_attributes = attribute_scraper(page)
+    #zips together tournament attributes with tournament objects
+    @season.tournaments.each_with_index {|tournament, index| tournament.add_attributes(tournament_attributes[index])}
+  end
+
+  #scrapes all dates for a given season and returns an array of created Tournaments
+  def date_scraper(page)
+    page.css('.num-date').each do |date_info|
+      dates = PGATourReader::PGA_Tour_Parser.date_parser(date_info.children[1].children.text, date_info.children[3].children.text.strip)
+      @season.tournaments << PGATourReader::PGA_Tournament.new(dates[0], dates[1], @season)
+    end
+  end
+
+  #scrapes name location course url and purse data and returns them in a hash
+  def attribute_scraper(page)
+    page.css(".tournament-text").map {|tournament_info| PGATourReader::PGA_Tour_Parser.attribute_parser(tournament_info)}
+  end
+end

data/lib/PGA_season.rb

@@ -0,0 +1,61 @@
+class PGATourReader::PGA_Season
+
+  attr_accessor :year, :tournaments
+
+  @@all = []
+
+  def initialize(year, tournaments = [])
+    @year = year
+    @tournaments = tournaments
+    save
+  end
+
+  def self.all
+    @@all
+  end
+
+  def save
+    self.class.all << self
+  end
+
+  def list_all_for_season()
+    @tournaments.each do |tournament|
+      tournament.print_date_name
+    end
+  end
+
+  def self.get_season_by_year(year)
+    season = self.all.detect{|season| season.year == year}
+    season ? season : PGATourReader::PGA_Tour_Scraper.new(year).season
+  end
+
+  def self.get_tournaments_by_month(month_number, year = Time.now.strftime("%Y"))
+    season = self.get_season_by_year(year)
+    if season
+      season.tournaments.select {|tournament| tournament.start_date.month == month_number.to_i || tournament.end_date.month == month_number.to_i}
+    else
+      puts ""
+      puts "------------------------------------------------------------"
+      puts "I don't have the #{year} season on file let me load the data"
+      puts "------------------------------------------------------------"
+      puts ""
+      PGATourReader::PGA_Tour_Scraper.new(year)
+      self.get_tournaments_by_month(month_number, year)
+    end
+  end
+
+  def self.get_tournament(date, year = Time.now.strftime("%Y"))
+    dates = date.split("/")
+    puts ""
+    puts "your requested date is: #{dates[0]}, #{dates[1]}, #{year}"
+    puts ""
+    if Date.valid_date?(year.to_i, dates[0].to_i, dates[1].to_i)
+      tournament_date = Date.new(year.to_i, dates[0].to_i, dates[1].to_i)
+      got_tournament = self.get_tournaments_by_month(dates[0]).detect do |tournament|
+        (tournament_date <=> tournament.start_date) > -1 && (tournament_date <=> tournament.end_date) < 1
+      end
+    else
+      puts "that date is invalid, make sure to use the format of mm/dd"
+    end
+  end
+end

data/lib/PGA_tournament.rb

@@ -0,0 +1,48 @@
+class PGATourReader::PGA_Tournament
+
+  attr_accessor :start_date, :end_date, :season, :attributes, :purse, :name, :location, :winner, :cup_points, :url, :course, :winnings
+
+  def initialize(start_date, end_date, season, attributes = {})
+    @start_date = start_date
+    @end_date = end_date
+    @season = season
+    self.add_attributes(attributes)
+  end
+
+  #accepts hash of many tournament attributes and assigns them to self
+  def add_attributes(attributes)
+    @attributes = attributes
+    attributes.each {|key, value| self.send("#{key}=", value)}
+  end
+
+  #prints all attributes self has
+  def print_attributes
+    @attributes.each{|attribute, value| puts "#{attribute}: #{value}"}
+  end
+
+  #gets a single attribute's value
+  def get_attribute(attribute)
+    request = is_attribute?(attribute)
+    if request
+      puts "#{request} : #{@attributes[request]}"
+    end
+  end
+
+  #checks to see if attribute this tournament contains and returns attributes' symbol
+  def is_attribute?(attribute)
+    @attributes.keys.detect{|key| key.to_s == attribute}
+  end
+
+  #lists all attributes self has
+  def list_attributes
+    puts ""
+    @attributes.keys[0..-2].each{|a| print "#{a}, "}
+    puts attributes.keys.last
+  end
+
+  #prints basic information about self in "2/2 - 2/6: Greenbriar Classic" format
+  def print_date_name()
+      puts "#{self.start_date} - #{self.end_date}: #{self.name}"
+  end
+
+end

data/spec.md

@@ -0,0 +1,6 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+- [x] Pull data from an external source
+- [x] Implement both list and detail views

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: PGA_Tour_Reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Taylor Williams'"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 
+email:
+- "'taylor@thewilliams.net'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- PGA_Tour_Reader.gemspec
+- README.md
+- Rakefile
+- bin/PGA_Tour_Reader
+- bin/console
+- bin/setup
+- lib/PGA_Tour_Reader.rb
+- lib/PGA_Tour_Reader/cli.rb
+- lib/PGA_Tour_Reader/cli_helper.rb
+- lib/PGA_Tour_Reader/version.rb
+- lib/PGA_Tour_parser.rb
+- lib/PGA_Tour_scraper.rb
+- lib/PGA_season.rb
+- lib/PGA_tournament.rb
+- spec.md
+homepage: https://github.com/Taylor-Williams/PGA_Tour_Reader
+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.7.7
+signing_key: 
+specification_version: 4
+summary: PGATourReader scrapes information from the PGATour website and loads the
+  information into a CLI
+test_files: []