ergast_f1 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba4fe8c5822d06158b23f315a94017a966e094c9
+  data.tar.gz: b64631ed4c894aad83de73737e87ab26920e49b7
+SHA512:
+  metadata.gz: 4c94b7f8563f1715255daf8ce40cddf8bc2f610b8a8c169aeb6807edaaf87f51f48e8f5a60eeb1541e250da20e83fd5834264e634a18145f2b9f4bf3a851b93d
+  data.tar.gz: ccf5dd98d99dbedd2f3d15c50bc65d00698dd228afac8eae5ab2f6380eaab0d2cd0d317385d1e292854bc3056fe10bce8bbb0f3fd7994aad918c3f9b4ce09868

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.3
+before_install: gem install bundler -v 1.14.3

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 nathan@3playmedia.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'
+gem "pry"
+gem "vcr"
+gem "webmock"
+
+# Specify your gem's dependencies in ergast_f1.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nathan Burgess
+
+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,95 @@
+# ErgastF1-Ruby
+ErgastF1-Ruby is a Ruby gem wrapper for using the [ErgastF1 API](http://ergast.com/mrd/).
+It currently supports querying Formula 1 race results by season year and round number or circuit name. Additionally, it includes support for filtering a race result by driver, constructor, finishing position, grid position and finishing status/cause of retirement (ex. "Finished", "Gearbox", "Engine"). Future features will include schedules, qualifying results, standings, driver information and more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ergast_f1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ergast_f1
+
+## Usage
+
+### Querying Race Results
+To return all data for a specific race, initialize an instance of `ErgastF1::Race` with a season year and either a round number or a circuit name and call `.result`:
+
+```ruby
+ErgastF1::Race.new(year: 1989, round: 15).result
+ErgastF1::Race.new(year: 1989, circuit: "Suzuka").result
+
+```
+Results from the ErgastF1 API are supplied as an array. If no results are found, an empty array is returned.
+
+### Filtering results
+Results can be filtered by a number of parameters:
+
+```ruby
+race = ErgastF1::Race.new(year: 2017, circuit: "Hungaroring")
+
+#Constructor Name
+race.constructor_result("Ferrari")
+
+#Driver Family Name
+race.driver_result("Vettel")
+
+#Starting Grid Position
+race.grid_position(6)
+
+#Fastest Laptime Ranking - the driver with the supplied ranking for fastest laptime
+race.laptime_ranking(1)
+
+```
+### Filtering by finishing status
+ErgastF1-Ruby supports filtering race results by a scored "finishing status", i.e., if the driver finished or, if they retired, the reason why.
+```ruby
+race.finishing_status("Engine")
+```
+Valid ilters for finishing status:
+
+* Finished
+* Disqualified
+* Accident
+* Collision
+* Engine
+* Gearbox
+* Transmission
+* Clutch
+* Hydraulics
+* Electrical
+* Spun
+* Radiator
+* Suspension
+* Brakes
+* Differential
+* Overheating
+* Mechanical
+* Tyre
+* Driver Seat
+* Puncture
+* Driveshaft
+
+## 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/Nathan Burgess/ergast_f1. 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ergast_f1"
+
+# 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/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/ergast_f1.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ergast_f1/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ergast_f1"
+  spec.version       = ErgastF1::VERSION
+  spec.authors       = ["Nathan Burgess"]
+  spec.email         = ["burgess.nathan28@gmail.com"]
+
+  spec.summary       = %q{A Ruby wrapper for the ergast F1 API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "curb"
+
+end

data/lib/ergast_f1.rb

@@ -0,0 +1,22 @@
+require "ergast_f1/version"
+require "ergast_f1/season"
+require "ergast_f1/race"
+require "ergast_f1/ergast_client"
+
+require "json"
+require "curb"
+
+# TODO: INHERIT FROM MORE USEFUL ERROR TYPES
+class BadQuery < StandardError; end
+class ApiError < StandardError; end
+
+class TestMe
+  def self.hello
+    puts "hello world"
+  end
+end
+
+
+module ErgastF1
+  # Your code goes here...
+end

data/lib/ergast_f1/ergast_client.rb

@@ -0,0 +1,27 @@
+class ErgastClient
+  BASE_URL = "http://ergast.com/api/f1/"
+
+  def initialize(endpoint_path)
+    # TODO: SUPPORT OTHER FORMATS BESIDES JSON
+    @endpoint = BASE_URL + endpoint_path + ".json"
+  end
+
+  def api_get_request
+    c = Curl::Easy.new(@endpoint)
+    c.connect_timeout = 60
+    c.timeout = 300
+    c.http_get()
+    # TODO: ADD CONNECTION ERROR HANDLING
+    return json_parse_response(c.body_str)
+  end
+
+  private
+
+  def json_parse_response(response)
+    begin
+      return JSON.parse(response)
+    rescue JSON::ParserError
+      return ApiError, "Error: invalid JSON reponse from ErgastF1 server"
+    end
+  end
+end

data/lib/ergast_f1/race.rb

@@ -0,0 +1,81 @@
+module ErgastF1
+  class Race
+    STATUS_TABLE = {"Finished" => "1",
+       "Disqualified" => "2",
+       "Accident" => "3",
+       "Collision" => "4",
+       "Engine" => "5",
+       "Gearbox" => "6",
+       "Transmission" => "7",
+       "Clutch" => "8",
+       "Hydraulics" => "9",
+       "Electrical" => "10",
+       "Spun" => "20",
+       "Radiator" => "21",
+       "Suspension" => "22",
+       "Brakes" => "23",
+       "Differential" => "24",
+       "Overheating" => "25",
+       "Mechanical" => "26",
+       "Tyre" => "27",
+       "Driver Seat" => "28",
+       "Puncture" => "29",
+       "Driveshaft" => "30"
+     }
+    
+    def initialize(year: nil, circuit: nil, round: nil)
+      @year = year || Time.now.year
+      @circuit = circuit
+      @round = round
+    end
+
+    def result
+      race_data(race_path + "/results")
+    end
+
+    def constructor_result(constructor_name)
+      race_data(race_path + "/constructors/#{constructor_name}/results")
+    end
+
+    def driver_result(driver_name)
+      race_data(race_path + "/drivers/#{driver_name}/results")
+    end
+
+    def grid_position(position)
+      race_data(race_path + "/grid/#{position}/results")
+    end
+
+    def finishing_status(status)
+      finishing_status = resolve_finishing_status(status)
+      race_data(race_path + "/status/#{finishing_status}/results")
+    end
+
+    def laptime_ranking(position=nil)
+      raise BadQuery, "Fastest lap data isn't available for races before 2004" if @year < 2004
+      race_data(race_path + "/fastest/#{position}/results")
+    end
+
+    private
+
+    def race_path
+      if @round
+        "#{@year}/#{@round}"
+      elsif @circuit
+        "#{@year}/circuits/#{@circuit}"
+      else
+        "#{@year}/last"
+      end
+    end
+
+    def resolve_finishing_status(status)
+      STATUS_TABLE[status] || (raise BadQuery, "Invalid status supplied. Valid status arguments are: Finished, Disqualified, Accident, Collision, Engine, Gearbox, Transmission, Clutch, Hydraulics, Electrical, Spun, Radiator, Suspension, Brakes, Differential, Overheating, Mechanical, Tyre, Driver, Puncture, Driveshaft.")
+    end
+
+    def race_data(endpoint)
+      parsed_response = ErgastClient.new(endpoint).api_get_request
+      race_results = parsed_response.dig("MRData", "RaceTable", "Races")
+      return [] if race_results.empty?
+      race_results.first["Results"]
+    end
+  end
+end

data/lib/ergast_f1/season.rb

@@ -0,0 +1,35 @@
+module ErgastF1
+  class Season
+    def initialize(year=nil)
+      @year = year || Time.now.year
+    end
+
+    def races(round=nil)
+      season_data = get_season
+
+      if round
+        season_data.dig("MRData", "RaceTable", "Races").select{|r| r["round"] == round.to_s}.first || (raise ApiError, "Nonexistent Round Number Specified")
+      else
+        season_data.dig("MRData", "RaceTable", "Races")
+      end
+    end
+
+    def driver_standings
+      parsed_response = ErgastClient.new("#{@year}/driverStandings").api_get_request
+      # Uh oh, array for standings lists
+      parsed_response.dig("MRData", "StandingsTable", "StandingsLists").first["DriverStandings"]
+    end
+
+    def constructor_standings
+      parsed_response = ErgastClient.new("#{@year}/constructorStandings").api_get_request
+      # Uh oh, array for standings lists
+      parsed_response.dig("MRData", "StandingsTable", "StandingsLists").first["ConstructorStandings"]
+    end
+
+    private
+
+    def get_season
+      ErgastClient.new("#{@year}").api_get_request
+    end
+  end
+end