football-butler 2.0.0 → 2.1.0

data/lib/football/butler/apifootball/competitions.rb

@@ -10,9 +10,9 @@ module Football
         class << self
           ## COMPETITION
           # action=get_leagues&country_id={id}
-          def by_country(id:)
+          def by_country(id:, result:)
             filters = { country_id: id }
-            Api.get(path: build_path(PATH), filters: filters)
+            Api.get(path: build_path(PATH), filters: filters, result: result)
           end
 
           ## COMPETITIONS

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

@@ -14,9 +14,9 @@ module Football
           # to	  Stop date (yyyy-mm-dd)
           #
           # action=get_odds&match_id={id}&from={from}&to={to}
-          def by_match(id:, from:, to:)
+          def by_match(id:, from:, to:, result:)
             filters = { match_id: id, from: from, to: to }
-            Api.get(path: build_path(PATH), filters: filters, result: :parsed_response)
+            Api.get(path: build_path(PATH), filters: filters, result: result)
           end
         end
       end

data/lib/football/butler/areas.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'football/butler/apifootball/countries'
 require 'football/butler/football_data/areas'
+require 'football/butler/api_football/countries'
 
 module Football
   module Butler
@@ -18,8 +19,16 @@ module Football
         end
 
         ## ADDITIONAL
-        def by_name(name:)
-          api_switch_method(__method__, { name: name })
+        def by_name(name:, result: api_switch_result, filters: {})
+          api_switch_method(__method__, { name: name, result: result, filters: filters })
+        end
+
+        def by_code(code:, result: api_switch_result, filters: {})
+          api_switch_method(__method__, { code: code, result: result, filters: filters })
+        end
+
+        def search_by_name(name:, result: api_switch_result, filters: {})
+          api_switch_method(__method__, { name: name, result: result, filters: filters })
         end
       end
     end

data/lib/football/butler/base.rb

@@ -3,17 +3,13 @@
 module Football
   module Butler
     class Base
-      MSG_REACHED_LIMIT   = 'You reached your request limit.' # code: 429
       MSG_INVALID_CONFIG  = 'Invalid Configuration, check empty api_token or empty / invalid api_endpoint!'
 
       class << self
 
         # MESSAGES
         def reached_limit?(response)
-          return false if !response.is_a?(Hash) &&
-            (response.respond_to?(:parsed_response) &&
-              !response.parsed_response.is_a?(Hash))
-          response.dig('message') ? response['message'].start_with?(MSG_REACHED_LIMIT) : false
+          Configuration.reached_limit?(response)
         end
 
         # RESULT MESSAGES
@@ -42,6 +38,7 @@ module Football
         # MULTI-API
         def api_switch_method(method, named_params)
           klass = api_switch
+
           if klass
             klass.respond_to?(method) ?
               klass.send(method, **named_params) :

data/lib/football/butler/coachs.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'football/butler/api_football/coachs'
+
+module Football
+  module Butler
+    class Coachs < Base
+
+      class << self
+        ## COACHS
+        #
+        def by_id(id:, result: api_switch_result, filters: {})
+          api_switch_method(__method__, { id: id, result: result, filters: filters })
+        end
+
+        def search_by_name(name:, result: api_switch_result, filters: {})
+          api_switch_method(__method__, { name: name, result: result, filters: filters })
+        end
+
+        def by_team(team:, result: api_switch_result, filters: {})
+          api_switch_method(__method__, { team: team, result: result, filters: filters })
+        end
+
+      end
+    end
+  end
+end

data/lib/football/butler/competitions.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'football/butler/apifootball/competitions'
 require 'football/butler/football_data/competitions'
+require 'football/butler/api_football/leagues'
 
 module Football
   module Butler
@@ -12,8 +13,12 @@ module Football
           api_switch_method(__method__, { id: id })
         end
 
-        def by_country(id:)
-          api_switch_method(__method__, { id: id })
+        def by_country(id:, result: api_switch_result)
+          api_switch_method(__method__, { id: id, result: result })
+        end
+
+        def by_country_name(name:, result: api_switch_result)
+          api_switch_method(__method__, { name: name, result: result })
         end
 
         ## COMPETITIONS
@@ -42,6 +47,23 @@ module Football
         def seasons(id:)
           api_switch_method(__method__, { id: id })
         end
+
+        def all_seasons(result: api_switch_result)
+          api_switch_method(__method__, { result: result })
+        end
+
+        def search_by_name(name:, result: api_switch_result, filters: {})
+          api_switch_method(__method__, { name: name, result: result, filters: filters })
+        end
+
+        def all_leagues(result: api_switch_result, filters: {})
+          api_switch_method(__method__, { result: result, filters: filters })
+        end
+
+        # /leagues?type=cup
+        def all_cups(result: api_switch_result, filters: {})
+          api_switch_method(__method__, { result: result, filters: filters })
+        end
       end
 
     end

data/lib/football/butler/configuration.rb

@@ -4,14 +4,16 @@ module Football
   module Butler
     module Configuration
       # MULTI-API
-      API_URL_FOOTBALL_DATA = 'https://api.football-data.org'
-      API_URL_APIFOOTBALL   = 'https://apiv2.apifootball.com/?'
+      API_URL_FOOTBALL_DATA   = 'https://api.football-data.org'
+      API_URL_APIFOOTBALL     = 'https://apiv2.apifootball.com/?'
+      API_URL_API_FOOTBALL    = 'https://v3.football.api-sports.io'
 
       API_VERSION_FOOTBALL_DATA = 2
       API_VERSION_APIFOOTBALL   = 2
+      API_VERSION_API_FOOTBALL  = 3
 
       # API
-      AVAILABLE_APIS        = [:football_data_org, :apifootball_com]
+      AVAILABLE_APIS        = [:football_data_org, :apifootball_com, :api_football_com]
       DEFAULT_API_NAME      = :football_data_org
       DEFAULT_API_URL       = API_URL_FOOTBALL_DATA
 
@@ -23,9 +25,15 @@ module Football
       DEFAULT_TIER_PLAN     = nil
       DEFAULT_WAIT_ON_LIMIT = false
 
+      # MESSAGES
+      MSG_REACHED_LIMIT = {
+        football_data_org: 'You reached your request limit.', # code: 429
+        api_football_com: 'Too many requests. Your rate limit is 10 requests per minute.' # code: 200
+      }
+
       class << self
         attr_accessor :api_version, :api_token, :api_endpoint, :tier_plan, :wait_on_limit, :init_done,
-                      :api_name
+                      :api_name, :header_token_name, :header_additional
 
         def configure
           raise "You need to configure football-butler first, see readme." unless block_given?
@@ -41,6 +49,9 @@ module Football
           @tier_plan      ||= DEFAULT_TIER_PLAN
           @wait_on_limit  ||= set_wait_on_limit(self.wait_on_limit, @api_name)
 
+          @header_token_name ||= set_header_token_name(@api_name)
+          @header_additional ||= {}
+
           @init_done = true
 
           api_name_valid?(self.api_name)
@@ -48,15 +59,15 @@ module Football
 
         def reconfigure(
           api_token: nil, api_version: nil, api_endpoint: nil, tier_plan: nil, wait_on_limit: nil,
-          api_name: nil
+          api_name: nil, header_token_name: nil, header_additional: nil
         )
 
           reset unless @init_done
 
           @api_name       = set_api_name(api_name) unless api_name.nil?
-          @api_token      = api_token unless api_token.nil?
+          @api_token      = api_token if api_token
 
-          unless api_version.nil?
+          if api_version
             @api_version    = api_version
             @api_endpoint   = set_api_endpoint(@api_name, @api_version) if api_endpoint.nil?
           end
@@ -67,9 +78,12 @@ module Football
             @api_endpoint = api_endpoint
           end
 
-          @tier_plan      = tier_plan unless tier_plan.nil?
+          @tier_plan      = tier_plan if tier_plan
           @wait_on_limit  = set_wait_on_limit(wait_on_limit, @api_name) unless wait_on_limit.nil?
 
+          @header_token_name = header_token_name ? header_token_name : set_header_token_name(@api_name)
+          @header_additional = header_additional if header_additional
+
           api_name_valid?(api_name ? api_name : @api_name)
         end
 
@@ -84,6 +98,9 @@ module Football
           @tier_plan      = DEFAULT_TIER_PLAN
           @wait_on_limit  = DEFAULT_WAIT_ON_LIMIT
 
+          @header_token_name = set_header_token_name(@api_name)
+          @header_additional = {}
+
           @init_done = true
 
           true
@@ -103,6 +120,8 @@ module Football
             'Apifootball'
           when :football_data_org
             'FootballData'
+          when :api_football_com
+            'ApiFootball'
           end
         end
 
@@ -118,6 +137,8 @@ module Football
             API_URL_APIFOOTBALL
           when :football_data_org
             "#{API_URL_FOOTBALL_DATA}/v#{api_version}"
+          when :api_football_com
+            API_URL_API_FOOTBALL
           end
         end
 
@@ -127,24 +148,43 @@ module Football
             false
           when :football_data_org
             wait_on_limit
+          when :api_football_com
+            wait_on_limit
           end
         end
 
-        def http_party_headers
+        def set_header_token_name(api_name)
           case api_name
           when :apifootball_com
-            {}
+            # not used in header
+            nil
           when :football_data_org
-            { "X-Auth-Token": Configuration.api_token }
+            "X-Auth-Token"
+          when :api_football_com
+            "x-apisports-key"
           end
         end
 
+        def http_party_headers
+          result = case api_name
+                   when :apifootball_com
+                    {}
+                   when :football_data_org, :api_football_com
+                     { Configuration.header_token_name => Configuration.api_token }
+                   end
+
+          result.merge!(Configuration.header_additional)
+          result
+        end
+
         def http_party_url(path)
           case api_name
           when :apifootball_com
             "#{Configuration.api_endpoint}#{path}&APIkey=#{Configuration.api_token}"
           when :football_data_org
             "#{Configuration.api_endpoint}/#{path}"
+          when :api_football_com
+            "#{Configuration.api_endpoint}/#{path}"
           end
         end
 
@@ -154,6 +194,8 @@ module Football
             response_apifootball_com(response, result)
           when :football_data_org
             response_football_data_org(response, result)
+          when :api_football_com
+            response_api_football_com(response, result)
           end
         end
 
@@ -161,6 +203,8 @@ module Football
           case result
           when :default
             response
+          when :array_first
+            response.parsed_response.is_a?(Array) ? response.parsed_response.first : nil
           else
             response.parsed_response
           end
@@ -177,12 +221,17 @@ module Football
           end
         end
 
-        def tier_from_response(response)
-          case api_name
-          when :apifootball_com
-            # n/a
-          when :football_data_org
-            Tier.set_from_response_headers(response)
+        def response_api_football_com(response, result)
+          case result
+          when :default
+            response
+          when :parsed_response
+            response.parsed_response
+          when :array_first
+            response&.keys&.include?('response') && response['response'].is_a?(Array) ?
+              response['response'].first : nil
+          else
+            response&.keys&.include?('response') ? response['response'] : nil
           end
         end
 
@@ -192,11 +241,22 @@ module Football
             :parsed_response
           when :football_data_org
             klass::PATH
+          when :api_football_com
+            :response
           end
         rescue
           return nil
         end
 
+        def tier_from_response(response)
+          case api_name
+          when :apifootball_com
+            # n/a
+          when :football_data_org, :api_football_com
+            Tier.set_from_response_headers(response)
+          end
+        end
+
         def class_converter(klass)
           case api_name
           when :apifootball_com
@@ -205,8 +265,12 @@ module Football
               return 'Countries'
             when 'Matches'
               return 'Events'
+            when 'Fixtures'
+              return 'Events'
             when 'Scorers'
               return 'TopScorers'
+            when 'Leagues'
+              return 'Competitions'
             end
           when :football_data_org
             case klass
@@ -214,13 +278,55 @@ module Football
               return 'Areas'
             when 'Events'
               return 'Matches'
+            when 'Fixtures'
+              return 'Matches'
             when 'TopScorers'
               return 'Scorers'
+            when 'Leagues'
+              return 'Competitions'
+            end
+          when :api_football_com
+            case klass
+            when 'Areas'
+              return 'Countries'
+            when 'Competitions'
+              return 'Leagues'
+            when 'Events'
+              return 'Fixtures'
+            when 'Matches'
+              return 'Fixtures'
+            when 'Scorers'
+              return 'TopScorers'
             end
           end
 
           klass
         end
+
+        def reached_limit?(response)
+          case api_name
+          when :apifootball_com
+            false
+          when :football_data_org
+            return false if !response.is_a?(Hash) &&
+              (response.respond_to?(:parsed_response) &&
+                !response.parsed_response.is_a?(Hash))
+            return response.dig('message') ? response['message'].start_with?(MSG_REACHED_LIMIT[api_name]) : false
+          when :api_football_com
+            if response.is_a?(HTTParty::Response) && response&.headers.present?
+              if response.headers['x-ratelimit-remaining'] == '0' ||
+                response.headers['x-ratelimit-requests-remaining'] == '0'
+                return true
+              end
+            elsif response.is_a?(HTTParty::Response) && response.parsed_response.dig('errors', 'rateLimit').present?
+              return true
+            end
+          end
+
+          false
+        rescue
+          return false
+        end
       end
     end
   end

data/lib/football/butler/countries.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'football/butler/apifootball/countries'
 require 'football/butler/football_data/areas'
+require 'football/butler/api_football/countries'
 
 module Football
   module Butler

data/lib/football/butler/events.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'football/butler/apifootball/events'
 require 'football/butler/football_data/matches'
+require 'football/butler/api_football/fixtures'
 
 module Football
   module Butler