openf1-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01513030c5ac4786387f7658a656918027433f46406ef3c0d06ee689fd17f160
+  data.tar.gz: 0a6a3a51a67cad6eab01b6b4bb55ba2afea72ea963617b80a5a13b8a4bb1bf1d
+SHA512:
+  metadata.gz: 935e2fe6be3714e05280c399436903ab45502088dc735c22bf1ea44d6d95148ff1eb811ca3aa1068845b5bf6d3a7fa140fd6783bff1ff2fcfa22ed65cb818698
+  data.tar.gz: 7b3a7c1a8fb9c9f129acde474cb895f226939518eba369c9243fba877c5bef8f1faa51f0c49b9412c50ec6715438ca1b43c1644bd87a691af3b542f26fcb138f

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [0.1.0] - 2025-02
+
+* Initial release
+* Basic API client implementation
+* Support for all OpenF1 API endpoints

data/README.md

@@ -0,0 +1,86 @@
+# Openf1::Ruby
+
+A simple Ruby client for the [OpenF1 API](https://openf1.org/), providing access to Formula 1 timing data, telemetry, and race information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "openf1-ruby"
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install openf1-ruby
+```
+
+## Usage
+
+### Basic Setup
+
+Create a client to interact with the OpenF1 API:
+
+```ruby
+client = Openf1::Client.new
+```
+
+### Available Endpoints
+
+The client provides access to all OpenF1 API endpoints:
+
+```ruby
+client.car_data      # Car telemetry data
+client.drivers       # Driver information
+client.intervals     # Timing intervals
+client.laps          # Lap timing data
+client.location      # Track location data
+client.meetings      # Race meeting information
+client.pit           # Pit stop data
+client.position      # Car position data
+client.race_control  # Race control messages
+client.sessions      # Session information
+client.stints        # Stint data
+client.team_radio    # Team radio messages
+client.weather       # Weather data
+```
+
+### Making Requests
+
+All endpoint methods accept optional parameters as a hash:
+
+```ruby
+# Get all drivers
+client.drivers
+
+# Get drivers for a specific session
+client.drivers(session_key: "12345")
+
+# Get sessions for a specific year
+client.sessions(year: 2024)
+
+# Get Sprint Sessions for a specific year
+client.sessions({year: 2024, session_name: "Sprint"})
+```
+
+### Response Format
+
+All responses are returned as OpenStruct objects with data accessible through the `data` attribute:
+
+```ruby
+response = client.drivers
+response.data.each do |driver|
+  puts "#{driver.full_name} (#{driver.driver_number})"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/gregdodd/openf1-ruby.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/openf1/client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Openf1
+  class Client
+    attr_accessor :api_key
+
+    BASE_URL = "https://api.openf1.org/v1"
+
+    def initialize(api_key: nil)
+      @api_key = api_key
+    end
+
+    def car_data(params = {})
+      CarData.new(get_request("car-data", params))
+    end
+
+    def drivers(params = {})
+      Drivers.new(get_request("drivers", params))
+    end
+
+    def intervals(params = {})
+      Intervals.new(get_request("intervals", params))
+    end
+
+    def laps(params = {})
+      Laps.new(get_request("laps", params))
+    end
+
+    def location(params = {})
+      Location.new(get_request("location", params))
+    end
+
+    def meetings(params = {})
+      Meetings.new(get_request("meetings", params))
+    end
+
+    def pit(params = {})
+      Pit.new(get_request("pit", params))
+    end
+
+    def position(params = {})
+      Position.new(get_request("position", params))
+    end
+
+    def race_control(params = {})
+      RaceControl.new(get_request("race-control", params))
+    end
+
+    def sessions(params = {})
+      Sessions.new(get_request("sessions", params))
+    end
+
+    def stints(params = {})
+      Stints.new(get_request("stints", params))
+    end
+
+    def team_radio(params = {})
+      TeamRadio.new(get_request("team-radio", params))
+    end
+
+    def weather(params = {})
+      Weather.new(get_request("weather", params))
+    end
+
+    private
+
+    def get_request(endpoint, params = {})
+      response = connection.get("#{BASE_URL}/#{endpoint}", params)
+      JSON.parse(response.body)
+    rescue Faraday::Error => e
+      raise Openf1::Error, "API request failed: #{e.message}"
+    rescue JSON::ParserError => e
+      raise Openf1::Error, "Failed to parse API response: #{e.message}"
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.headers["Authorization"] = "Bearer #{api_key}" if api_key
+        conn.headers["Content-Type"] = "application/json"
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/openf1/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Error < StandardError; end
+end

data/lib/openf1/object.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module Openf1
+  class Object < OpenStruct
+    def initialize(attributes)
+      raise ArgumentError, "Response cannot be nil" if attributes.nil?
+
+      # Response is always an array so nest under data:
+      super(data: to_ostruct(attributes))
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.transform_values { |val| to_ostruct(val) })
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else
+        obj
+      end
+    end
+  end
+end

data/lib/openf1/objects/car_data.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class CarData < Object
+  end
+end

data/lib/openf1/objects/drivers.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Drivers < Object
+  end
+end

data/lib/openf1/objects/intervals.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Intervals < Object
+  end
+end

data/lib/openf1/objects/laps.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Laps < Object
+  end
+end

data/lib/openf1/objects/location.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Location < Object
+  end
+end

data/lib/openf1/objects/meetings.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Meetings < Object
+  end
+end

data/lib/openf1/objects/pit.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Pit < Object
+  end
+end

data/lib/openf1/objects/position.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Position < Object
+  end
+end

data/lib/openf1/objects/race_control.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class RaceControl < Object
+  end
+end

data/lib/openf1/objects/sessions.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Sessions < Object
+  end
+end

data/lib/openf1/objects/stints.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Stints < Object
+  end
+end

data/lib/openf1/objects/team_radio.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class TeamRadio < Object
+  end
+end

data/lib/openf1/objects/weather.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Openf1
+  class Weather < Object
+  end
+end

data/lib/openf1/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Openf1
+  VERSION = "0.1.0"
+end

data/lib/openf1.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "openf1/version"
+require_relative "openf1/error"
+require_relative "openf1/client"
+
+module Openf1
+  autoload :Object, "openf1/object"
+  autoload :Sessions, "openf1/objects/sessions"
+  autoload :CarData, "openf1/objects/car_data"
+  autoload :Drivers, "openf1/objects/drivers"
+  autoload :Intervals, "openf1/objects/intervals"
+  autoload :Laps, "openf1/objects/laps"
+  autoload :Location, "openf1/objects/location"
+  autoload :Meetings, "openf1/objects/meetings"
+  autoload :Pit, "openf1/objects/pit"
+  autoload :Position, "openf1/objects/position"
+  autoload :RaceControl, "openf1/objects/race_control"
+  autoload :Stints, "openf1/objects/stints"
+  autoload :TeamRadio, "openf1/objects/team_radio"
+  autoload :Weather, "openf1/objects/weather"
+end

data/sig/openf1/ruby.rbs

@@ -0,0 +1,6 @@
+module Openf1
+  module Ruby
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: openf1-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Greg Dodd
+bindir: exe
+cert_chain: []
+date: 2025-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Ruby wrapper for the OpenF1 API providing access to Formula 1 timing
+  data
+email:
+- greg.dodd@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/openf1.rb
+- lib/openf1/client.rb
+- lib/openf1/error.rb
+- lib/openf1/object.rb
+- lib/openf1/objects/car_data.rb
+- lib/openf1/objects/drivers.rb
+- lib/openf1/objects/intervals.rb
+- lib/openf1/objects/laps.rb
+- lib/openf1/objects/location.rb
+- lib/openf1/objects/meetings.rb
+- lib/openf1/objects/pit.rb
+- lib/openf1/objects/position.rb
+- lib/openf1/objects/race_control.rb
+- lib/openf1/objects/sessions.rb
+- lib/openf1/objects/stints.rb
+- lib/openf1/objects/team_radio.rb
+- lib/openf1/objects/weather.rb
+- lib/openf1/version.rb
+- sig/openf1/ruby.rbs
+homepage: https://github.com/gregdodd/openf1-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gregdodd/openf1-ruby
+  source_code_uri: https://github.com/gregdodd/openf1-ruby
+  changelog_uri: https://github.com/gregdodd/openf1-ruby/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Ruby client for the OpenF1 API
+test_files: []