sports_api 1.0.0

data/docs/usage.md

@@ -0,0 +1,13 @@
+# Usage <!-- {docsify-ignore} -->
+
+To access the API, you'll need to create a client and pass in your API key. You can find your API key at [https://dashboard.api-football.com/profile](https://dashboard.api-football.com/profile?access), example:
+
+```ruby
+client = SportsApi::Football::Client.new(api_key: ENV["SPORTS_API_KEY"])
+```
+
+The client then gives you access to each of the resources, for example:
+
+```ruby
+client.coaches.list(search: 'Tuchel')
+```

data/lib/sports_api/collection.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SportsApi
+  class Collection
+    attr_reader :data, :total, :current, :results
+
+    # Example usage:
+    # from_reponse(response, key: "response", type: League)
+    # SportsApi::Collection.from_response(response, type: SportsApi::Football::League)
+    def self.from_response(response, type:, key: 'response')
+      body = response.body
+
+      new(
+        data: body[key].map { |attrs| type.new(attrs) },
+        total: body['results'],
+        paging: body['paging'],
+        paging_total: body.dig('paging', 'total'),
+        paging_current: body.dig('paging', 'current')
+      )
+    end
+
+    def initialize(data:, total:, paging:, paging_total:, paging_current:)
+      @data = data
+      @total = total
+      @paging = paging
+      @paging_total = paging_total
+      @paging_current = paging_current
+    end
+  end
+end

data/lib/sports_api/error.rb

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

data/lib/sports_api/football/client.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module SportsApi
+  module Football
+    # rubocop:disable Metrics/ClassLength
+    class Client
+      BASE_URL = 'https://v3.football.api-sports.io/'
+
+      attr_reader :api_key, :adapter
+
+      def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+        @api_key = api_key
+        @adapter = adapter
+
+        # Test stubs for requests
+        @stubs = stubs
+      end
+
+      def coaches
+        CoachResource.new(self)
+      end
+
+      def countries
+        CountryResource.new(self)
+      end
+
+      def fixtures
+        FixtureResource.new(self)
+      end
+
+      def fixture_rounds
+        FixtureRoundResource.new(self)
+      end
+
+      def fixture_head_to_head
+        FixtureHeadToHeadResource.new(self)
+      end
+
+      def fixture_statistics
+        FixtureStatisticResource.new(self)
+      end
+
+      def fixture_events
+        FixtureEventResource.new(self)
+      end
+
+      def fixture_lineups
+        FixtureLineupResource.new(self)
+      end
+
+      def fixture_player_statistics
+        FixturePlayerStatisticResource.new(self)
+      end
+
+      def injuries
+        InjuryResource.new(self)
+      end
+
+      def leagues
+        LeagueResource.new(self)
+      end
+
+      def league_seasons
+        LeagueSeasonResource.new(self)
+      end
+
+      def odds
+        OddsResource.new(self)
+      end
+
+      def odds_bets
+        OddsBetResource.new(self)
+      end
+
+      def odds_bookmakers
+        OddsBookmakerResource.new(self)
+      end
+
+      def odds_lives
+        OddsLiveResource.new(self)
+      end
+
+      def odds_live_bets
+        OddsLiveBetResource.new(self)
+      end
+
+      def odds_mappings
+        OddsMappingResource.new(self)
+      end
+
+      def players
+        PlayerResource.new(self)
+      end
+
+      def player_top_assists
+        PlayerTopAssistResource.new(self)
+      end
+
+      def player_top_scorers
+        PlayerTopScorerResource.new(self)
+      end
+
+      def player_top_red_cards
+        PlayerTopRedCardResource.new(self)
+      end
+
+      def player_top_yellow_cards
+        PlayerTopYellowCardResource.new(self)
+      end
+
+      def player_seasons
+        PlayerSeasonResource.new(self)
+      end
+
+      def player_squads
+        PlayerSquadResource.new(self)
+      end
+
+      def predictions
+        PredictionResource.new(self)
+      end
+
+      def sidelined
+        SidelinedResource.new(self)
+      end
+
+      def standings
+        StandingResource.new(self)
+      end
+
+      def teams
+        TeamResource.new(self)
+      end
+
+      def team_countries
+        TeamCountryResource.new(self)
+      end
+
+      def team_seasons
+        TeamSeasonResource.new(self)
+      end
+
+      def team_statistics
+        TeamStatisticResource.new(self)
+      end
+
+      def timezones
+        TimezoneResource.new(self)
+      end
+
+      def transfers
+        TransferResource.new(self)
+      end
+
+      def trophies
+        TrophyResource.new(self)
+      end
+
+      def venues
+        VenueResource.new(self)
+      end
+
+      def connection
+        @connection ||= Faraday.new do |conn|
+          conn.url_prefix = BASE_URL
+          conn.request :json
+          conn.response :json, content_type: 'application/json'
+          conn.adapter adapter, @stubs
+        end
+      end
+
+      def inspect
+        '#<SportsApi::Football::Client>'
+      end
+    end
+    # rubocop:enable Metrics/ClassLength
+  end
+end

data/lib/sports_api/football/objects/coach.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Coach < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/country.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Country < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/fixtures/fixture.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Fixture < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/fixtures/fixture_event.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class FixtureEvent < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/fixtures/fixture_head_to_head.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class FixtureHeadToHead < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/fixtures/fixture_lineup.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class FixtureLineup < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/fixtures/fixture_player_statistic.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class FixturePlayerStatistic < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/fixtures/fixture_round.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class FixtureRound < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/fixtures/fixture_statistic.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class FixtureStatistic < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/injury.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Injury < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/leagues/league.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class League < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/leagues/league_season.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class LeagueSeason < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/odds_in_play/odds_live.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class OddsLive < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/odds_in_play/odds_live_bet.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class OddsLiveBet < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/odds_pre_match/odds.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Odds < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/odds_pre_match/odds_bet.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class OddsBet < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/odds_pre_match/odds_bookmaker.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class OddsBookmaker < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/odds_pre_match/odds_mapping.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class OddsMapping < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/players/player.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Player < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/players/player_season.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class PlayerSeason < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/players/player_squad.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class PlayerSquad < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/players/player_top_assist.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class PlayerTopAssist < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/players/player_top_red_card.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class PlayerTopRedCard < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/players/player_top_scorer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class PlayerTopScorer < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/players/player_top_yellow_card.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class PlayerTopYellowCard < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/prediction.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Prediction < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/sidelined.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Sidelined < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/standing.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Standing < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/teams/team.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Team < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/teams/team_country.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class TeamCountry < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/teams/team_season.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class TeamSeason < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/teams/team_statistic.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class TeamStatistic < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/timezone.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Timezone < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/transfer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Transfer < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/trophy.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Trophy < Object
+    end
+  end
+end

data/lib/sports_api/football/objects/venue.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class Venue < Object
+    end
+  end
+end

data/lib/sports_api/football/resources/coach.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class CoachResource < Resource
+      # Arguments:
+      # id: [Integer](optional) - The coach ID.
+      # team: [Integer](optional) - The team ID.
+      # search: [String](optional) - The name of the coach (>= XXX).
+      def list(**params)
+        response = get_request('coachs', params:)
+        Collection.from_response(response, type: SportsApi::Football::Coach)
+      end
+
+      def find(id:)
+        response = get_request('coachs', params: { id: id.to_s })
+        SportsApi::Football::Coach.new(response.body['response'][0])
+      end
+    end
+  end
+end

data/lib/sports_api/football/resources/country.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class CountryResource < Resource
+      # Arguments:
+      # name: [String](optional) - The name of the country.
+      # code: [String] (optional) - The country code (= XXX).
+      # search: [String] (optional) - The country name, can be some letters (>= XXX).
+      def list(**params)
+        response = get_request('countries', params:)
+        Collection.from_response(response, type: SportsApi::Football::Country)
+      end
+
+      def find_by_code(code:)
+        response = get_request('countries', params: { code: code.to_s })
+        SportsApi::Football::Country.new(response.body['response'][0])
+      end
+
+      def find_by_name(name:)
+        response = get_request('countries', params: { name: name.to_s })
+        SportsApi::Football::Country.new(response.body['response'][0])
+      end
+    end
+  end
+end

data/lib/sports_api/football/resources/fixtures/fixture.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SportsApi
+  module Football
+    class FixtureResource < Resource
+      # Arguments:
+      # id: [Integer](optional) - The fixture ID.
+      # ids: [String](optional) - One or more fixture IDs (id-id-id).
+      # live: [String](optional) - All or several leagues ids ["all", "id-id"]
+      # date: [String](optional) - The date of the fixture (= YYYY-MM-DD).
+      # league: [Integer](optional) - The league ID.
+      # season: [Integer](optional) - The season year (= YYYY).
+      # last: [Integer](optional) - For the X last fixtures (<= 2 characters).
+      # next: [Integer](optional) - For the X next fixtures (<= 2 characters).
+      # from: [String](optional) - A valid date (= YYYY-MM-DD).
+      # to: [String](optional) - A valid date (= YYYY-MM-DD).
+      # round: [String](optional) - The round of the fixture.
+      # status: [String](optional) - One or more fixture status short ["NS", "NS-PST-FT"].
+      # venue: [Integer] (optional) - The venue ID.
+      # timezone: [String](optional) - A valid timezone from the endpoint Timezone.
+      def list(**params)
+        response = get_request('fixtures', params:)
+        Collection.from_response(response, type: SportsApi::Football::Fixture)
+      end
+
+      def find(id:)
+        response = get_request('fixtures', params: { id: id.to_s })
+        SportsApi::Football::Fixture.new(response.body['response'][0])
+      end
+    end
+  end
+end