football-butler 1.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 991c183f8fbd4c8d04110b3d4bc59007a12fbf3d579c9b34d01f7744757d75d8
-  data.tar.gz: 5ecc30f4564d7a0c2e3a403f172ad69c83c229e46376162cdeb8ccb8060712bd
+  metadata.gz: 73aaf5b7373f6bc121c70b0595678dfbe68368657c5564e94570ea68821e4299
+  data.tar.gz: 3753f50ea821aa9b3f08962926a3b7dc5627e1cf8e2693a85b503bb2395e4265
 SHA512:
-  metadata.gz: 28d38f92b44efd7373985204acfbbe85fe69fb30a98fc43f6e0f603c0fb4496202d55ad35156433d1598bfb2fad59a2e9b0c1b1bd4a3e7cbd2e70cdbd0b84e24
-  data.tar.gz: 896d915e99ea08fe238610c114ccdc3a705c9186c108f2655942f280842bbf14984f0ea9220c6778cc9130044cfc4d6928c5a0b406e277ee07867d363b67f561
+  metadata.gz: 87b47413453c999564da314d5483a7c100f36f59ffe7c75c06dba8cbb69b65557632527354f1afec9de85d65ab02bdbb8aeb74b96d4b972812e0daff58bbac06
+  data.tar.gz: 4a624803962bc33c4aeb5d4ad13feaaaa19481204951cc16b5f2830c91fdd213ccf6f7442334faa54514868345acad52c2df2118487cca2ea462844ea2a2b352

data/lib/football/butler/api.rb

@@ -30,7 +30,7 @@ module Football
           end
 
           response = process_http_party(path, filters)
-          Tier.set_from_response_headers(response)
+          Configuration.tier_from_response(response)
 
           if reached_limit?(response)
             response = process_retry(path, filters)
@@ -50,7 +50,7 @@ module Football
             sleep(Tier.get_sleep_seconds) unless Rails.env.test?
 
             response = process_http_party(path, filters)
-            Tier.set_from_response_headers(response)
+            Configuration.tier_from_response(response)
 
             break unless reached_limit?(response)
           end
@@ -58,29 +58,23 @@ module Football
         end
 
         def process_http_party(path, filters)
-          headers = {
-            "X-Auth-Token": Configuration.api_token
-          }
-          url   = "#{Configuration.api_endpoint}/#{path}"
-          query = filters || {}
-
+          headers = Configuration.http_party_headers
+          url     = Configuration.http_party_url(path)
+          query   = filters || {}
           http_party_get(url, headers, query)
         end
 
         def process_response(response, result)
-          if response.dig('message')
+          if response.parsed_response.is_a?(Hash) && response.dig('message')
             error_message(response['message'])
           else
-            case result
-            when :default
-              response
-            else
-              response&.keys&.include?(result.to_s) ? response[result.to_s] : nil
-            end
+            Configuration.http_party_response(response, result)
           end
         end
 
         def http_party_get(url, headers, query)
+          Tier.count_request
+
           HTTParty.get "#{url}",
                        headers: headers,
                        query: query,
@@ -88,7 +82,7 @@ module Football
         end
 
         def invalid_config?
-          Configuration.api_token.blank? || Configuration.api_endpoint.blank?
+          Configuration.api_token.blank? || !Configuration.api_name_valid?(Configuration.api_name)
         end
 
         def log(text)

data/lib/football/butler/api_football/base_api_football.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Football
+  module Butler
+    module ApiFootball
+      class BaseApiFootball < Base
+
+        # class << self
+        #   def build_path(action)
+        #     "action=#{action}"
+        #   end
+        # end
+
+      end
+    end
+  end
+end

data/lib/football/butler/api_football/coachs.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/base_api_football'
+
+module Football
+  module Butler
+    module ApiFootball
+      class Coachs < BaseApiFootball
+        PATH = :coachs
+
+        class << self
+          ## COACHS
+          #
+          # id
+          # integer
+          # The id of the coach
+          #
+          # team
+          # integer
+          # The id of the team
+          #
+          # search
+          # string >= 3 characters
+          # The name of the coach
+          #
+          # /coachs?id={id}
+          def by_id(id:, result:, filters:)
+            filters.merge!({ id: id })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+
+          # /coachs?search={name}
+          def search_by_name(name:, result:, filters:)
+            filters.merge!({ search: name })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+
+          # /coachs?team={team}
+          def by_team(team:, result:, filters:)
+            filters.merge!({ team: team })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/football/butler/api_football/countries.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/base_api_football'
+
+module Football
+  module Butler
+    module ApiFootball
+      class Countries < BaseApiFootball
+        PATH = :countries
+
+        class << self
+          ## COUNTRY
+          # /countries?name={name}
+          def by_name(name:, result:, filters:)
+            filters.merge!({ name: name })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+
+          # /countries?code={code}
+          def by_code(code:, result:, filters:)
+            filters.merge!({ code: code })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+
+          ## COUNTRIES
+          # /countries
+          def all(result:)
+            Api.get(path: PATH, result: result)
+          end
+
+          # /countries?search={name}
+          def search_by_name(name:, result:, filters:)
+            filters.merge!({ search: name })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/football/butler/api_football/fixtures.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/base_api_football'
+
+module Football
+  module Butler
+    module ApiFootball
+      class Fixtures < BaseApiFootball
+        PATH = :fixtures
+
+        class << self
+          ## FIXTURE
+          # /fixtures?id={id}
+          def by_id(id:)
+            filters = { id: id }
+            Api.get(path: PATH, filters: filters, result: :response)
+          end
+
+          ## FIXTURES
+          #
+          # id
+          # integer
+          # The id of the fixture
+          #
+          # live
+          # string
+          # Enum: "all" "id-id"
+          # date
+          # stringYYYY-MM-DD
+          # A valid date
+          #
+          # league
+          # integer
+          # The id of the league
+          #
+          # season
+          # integer 4 characters YYYY
+          # The season of the league
+          #
+          # team
+          # integer
+          # The id of the team
+          #
+          # last
+          # integer <= 2 characters
+          # For the X last fixtures
+          #
+          # next
+          # integer <= 2 characters
+          # For the X next fixtures
+          #
+          # from
+          # stringYYYY-MM-DD
+          # A valid date
+          #
+          # to
+          # stringYYYY-MM-DD
+          # A valid date
+          #
+          # round
+          # string
+          # The round of the fixture
+          #
+          # status
+          # string
+          # The status short of the fixture
+          #
+          # timezone
+          # string
+          # A valid timezone from the endpoint Timezone
+          #
+          # /fixtures?league={id}&season={year}
+          def by_competition_and_year(id:, year:, result:, filters:)
+            filters.merge!({ league: id, season: year })
+            Api.get(path: PATH, filters: filters, result: result)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/football/butler/api_football/head_to_head.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Football
+  module Butler
+    module ApiFootball
+      class HeadToHead < Base
+        PATH = 'fixtures/headtohead'
+
+        class << self
+          ## HEAD TO HEAD
+          #
+          # h2h
+          # required
+          # stringID-ID
+          # The ids of the teams
+          #
+          # date
+          # stringYYYY-MM-DD
+          # league
+          # integer
+          # The id of the league
+          #
+          # season
+          # integer 4 characters YYYY
+          # The season of the league
+          #
+          # last
+          # integer
+          # For the X last fixtures
+          #
+          # next
+          # integer
+          # For the X next fixtures
+          #
+          # from
+          # stringYYYY-MM-DD
+          # to
+          # stringYYYY-MM-DD
+          # status
+          # string
+          # The status short of the fixture
+          #
+          # timezone
+          # string
+          # A valid timezone from the endpoint Timezone
+          #
+          # fixtures/headtohead?h2h={team_id-second_team_id}
+          def by_teams(team_id:, second_team_id:, filters:, result:)
+            filters.merge!(h2h: "#{team_id}-#{second_team_id}")
+            Api.get(path: PATH, filters: filters, result: result)
+          end
+        end
+      end
+    end
+  end
+end 

data/lib/football/butler/api_football/injuries.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/base_api_football'
+
+module Football
+  module Butler
+    module ApiFootball
+      class Injuries < BaseApiFootball
+        PATH = :injuries
+
+        class << self
+          ## Injuries
+          #
+          # league
+          # integer
+          # The id of the league
+          #
+          # season
+          # integer 4 characters YYYY
+          # The season of the league, required with league, team and player parameters
+          #
+          # fixture
+          # integer
+          # The id of the fixture
+          #
+          # team
+          # integer
+          # The id of the team
+          #
+          # player
+          # integer
+          # The id of the player
+          #
+          # date
+          # stringYYYY-MM-DD
+          # A valid date
+          #
+          # timezone
+          # string
+          # A valid timezone from the endpoint Timezone
+          #
+          # /injuries?ccompetition={competition}&season={season}
+          def by_competition_and_season(competition:, season:, result:, filters:)
+            filters.merge!({ league: competition, season: season })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+
+          # /injuries?fixture={match}
+          def by_match(match:, result:, filters:)
+            filters.merge!({ fixture: match })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+
+          # /injuries?team={team}&season={season}
+          def by_team_and_season(team:, season:, result:, filters:)
+            filters.merge!({ team: team, season: season })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/football/butler/api_football/leagues.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/base_api_football'
+
+module Football
+  module Butler
+    module ApiFootball
+      class Leagues < BaseApiFootball
+        PATH = :leagues
+
+        class << self
+          ## LEAGUE
+          # /leagues?id={id}
+          def by_id(id:)
+            filters = { id: id }
+            Api.get(path: PATH, filters: filters, result: :response)
+          end
+
+          # /leagues?country={country}
+          def by_country_name(name:, result:)
+            filters = { country: name }
+            Api.get(path: PATH, filters: filters, result: result)
+          end
+
+          # /leagues/seasons
+          def all_seasons(result:)
+            path = "#{PATH}/seasons"
+            Api.get(path: path, result: result)
+          end
+
+          ## LEAGUES
+          # https://www.api-football.com/documentation-v3#operation/get-leagues
+          #
+          # id
+          # integer
+          # The id of the league
+          #
+          # name
+          # string
+          # The name of the league
+          #
+          # country
+          # string
+          # The country name of the league
+          #
+          # code
+          # string 2 characters FR, GB, IT…
+          # The Alpha2 code of the country
+          #
+          # season
+          # integer 4 characters YYYY
+          # The season of the league
+          #
+          # team
+          # integer
+          # The id of the team
+          #
+          # type
+          # string
+          # Enum: "league" "cup"
+          # The type of the league
+          #
+          # current
+          # string
+          # Enum: "true" "false"
+          # The state of the league
+          #
+          # search
+          # string >= 3 characters
+          # The name or the country of the league
+          #
+          # last
+          # integer <= 2 characters
+          #
+          # /leagues
+          def all(result:, filters:)
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+
+          # /leagues?search={name}
+          def search_by_name(name:, filters:, result:)
+            filters.merge!({ search: name })
+            Api.get(path: PATH, filters: filters, result: result)
+          end
+
+          # /leagues?type=league
+          def all_leagues(result:, filters:)
+            filters.merge!({ type: 'league' })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+
+          # /leagues?type=cup
+          def all_cups(result:, filters:)
+            filters.merge!({ type: 'cup' })
+            Api.get(path: PATH, result: result, filters: filters)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/football/butler/api_football/lineups.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/base_api_football'
+
+module Football
+  module Butler
+    module ApiFootball
+      class Lineups < BaseApiFootball
+        PATH = 'fixtures/lineups'
+
+        class << self
+          ## LINEUPS
+          #
+          # fixture
+          # required
+          # integer
+          # The id of the fixture
+          #
+          # team
+          # integer
+          # The id of the team
+          #
+          # player
+          # integer
+          # The id of the player
+          #
+          # type
+          # string
+          # The type
+          #
+          # fixtures/lineups?fixture={id}
+          def by_match(id:)
+            filters = { fixture: id }
+            Api.get(path: PATH, filters: filters, result: :response)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/football/butler/api_football/odds.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/base_api_football'
+
+module Football
+  module Butler
+    module ApiFootball
+      class Odds < BaseApiFootball
+        PATH = :odds
+
+        class << self
+          ## ODDS
+          #
+          # fixture
+          # integer
+          # The id of the fixture
+          #
+          # league
+          # integer
+          # The id of the league
+          #
+          # season
+          # integer 4 characters YYYY
+          # The season of the league
+          #
+          # date
+          # stringYYYY-MM-DD
+          # A valid date
+          #
+          # timezone
+          # string
+          # A valid timezone from the endpoint Timezone
+          #
+          # page
+          # integer
+          # Default: 1
+          # Use for the pagination
+          #
+          # bookmaker
+          # integer
+          # The id of the bookmaker
+          #
+          # bet
+          # integer
+          # The id of the bet
+          #
+          # odds&match_id={id}&from={from}&to={to}
+          def by_match(id:, from:, to:, result:)
+            filters = { fixture: id }
+            Api.get(path: PATH, filters: filters, result: result)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/football/butler/api_football/players.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/base_api_football'
+
+module Football
+  module Butler
+    module ApiFootball
+      class Players < BaseApiFootball
+        PATH = :players
+
+        class << self
+          ## PLAYER
+          #
+          # id
+          # integer
+          # The id of the player
+          #
+          # team
+          # integer
+          # The id of the team
+          #
+          # league
+          # integer
+          # The id of the league
+          #
+          # season
+          # integer 4 characters YYYY | Requires the fields Id, League or Team...
+          # The season of the league
+          #
+          # search
+          # string >= 4 characters Requires the fields League or Team
+          # The name of the player
+          #
+          # page
+          # integer
+          # Default: 1
+          # Use for the pagination
+          #
+          # players?id={id}&season={season}
+          def by_id_and_season(id:, season:, result:, filters:)
+            filters.merge!({ id: id, season: season })
+            Api.get(path: PATH, filters: filters, result: result)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/football/butler/api_football/predictions.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/base_api_football'
+
+module Football
+  module Butler
+    module ApiFootball
+      class Predictions < BaseApiFootball
+        PATH = :predictions
+
+        class << self
+          ## PREDICTIONS
+          #
+          # fixture
+          # required
+          # integer
+          # The id of the fixture
+          #
+          # predictions&fixture={id}
+          def by_match(id:, filters:, result:)
+            filters.merge!(fixture: id)
+            Api.get(path: PATH, filters: filters, result: result)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/football/butler/api_football/sidelineds.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/base_api_football'
+
+module Football
+  module Butler
+    module ApiFootball
+      class Sidelineds < BaseApiFootball
+        PATH = :sidelined
+
+        class << self
+          ## SIDELINED
+          #
+          # player
+          # integer
+          # The id of the player
+          #
+          # coach
+          # integer
+          # The id of the coach
+          #
+          # /trophies?player={player}
+          def by_player(player:, result:, filters:)
+            filters.merge!({ player: player })
+            Api.get(path: PATH, filters: filters, result: result)
+          end
+
+          # /trophies?coach={coach}
+          def by_coach(coach:, result:, filters:)
+            filters.merge!({ coach: coach })
+            Api.get(path: PATH, filters: filters, result: result)
+          end
+
+        end
+      end
+    end
+  end
+end