sports-butler 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3e17fd5165580e881b932d07db6bf3397ae625b352585258446706001942524
+  data.tar.gz: 5103324841fbb476f0be686a7270830c3e9235baae94315c1ac356d21f9a194f
+SHA512:
+  metadata.gz: 8ba8a193569f349de76c0ae0105a3b023b7d04f8b3b07e49362c3e02bf5a3d02df06217db10e25be7f85954cf9c9e6e515cd605c07c397c597eb56a3c3bb5969
+  data.tar.gz: 054a5aa66ba39f7020b5af5c9e2e1a7b01f72234a8acd44d876929269f5edd0b73040972f20e7ecc3d5337ccb710059227d8b7a895726af74afb3da113d86c1f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Joerg Kirschstein
+
+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/lib/sports/butler/api.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+require 'httparty'
+require 'sports/butler/api_base'
+
+module Sports
+  module Butler
+    class Api < ApiBase
+
+      attr_accessor :response, :parsed_response, :success, :errors, :response_code,
+                    :sport, :api_name, :url, :headers, :query, :uri
+
+      def initialize(sport, api_name)
+        @sport    = sport
+        @api_name = api_name
+
+        @response = nil
+        @success  = false
+        @errors   = []
+
+        @response_code = nil
+      end
+
+      def get(path:, filters: {})
+        if Configuration.invalid_config?(sport, api_name)
+          @response = Sports::Butler::ApiBase.invalid_config_result
+          @response_code = 400
+          return false
+        end
+
+        @response           = process_http_party(path, filters)
+        @response_code      = response.code
+        @success            = true if response_code == 200
+        @parsed_response    = process_response(response)
+        @uri                = response.request.last_uri&.to_s
+
+        true
+      end
+
+      def process_http_party(path, filters)
+        @headers  = Configuration.http_party_headers(sport, api_name)
+        @url      = Configuration.http_party_url(path, sport, api_name)
+        @query    = filters || {}
+
+        http_party_get
+      end
+
+      def process_response(response)
+        if response.parsed_response.is_a?(Hash) && response.dig('message')
+          error_message(response['message'])
+        else
+          response.parsed_response
+        end
+      end
+
+      def error_message(error)
+        { message: error }.with_indifferent_access
+      end
+
+      def http_party_get
+        HTTParty.get(
+          "#{url}",
+          headers: headers,
+          query: query,
+          format: :json
+        )
+      end
+
+      # direct calls
+      class << self
+        def get(url:, sport: nil, api_name: nil, filters: {}, headers: {})
+
+          if sport && api_name
+            if Configuration.invalid_config?(sport, api_name)
+              return Sports::Butler::ApiBase.invalid_config_result
+            end
+
+            headers  = Configuration.http_party_headers(sport, api_name)
+            url      = Configuration.http_party_url_suffix(url, sport, api_name)
+          end
+
+          query   = filters || {}
+
+          HTTParty.get "#{url}",
+                       headers: headers,
+                       query: query,
+                       format: :json
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/api_base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Sports
+  module Butler
+    class ApiBase
+      MSG_INVALID_CONFIG  = 'Invalid Configuration, check empty api_token or empty / invalid api_base_url.'
+
+      class << self
+        def invalid_config_result
+          error_message(MSG_INVALID_CONFIG)
+        end
+
+        def error_message(error)
+          { message: error }.with_indifferent_access
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/base.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+## SOCCER
+Dir.glob(File.expand_path("../soccer_api/*.rb", __FILE__)).each do |file|
+  require file
+end
+
+# api_football_com
+Dir.glob(File.expand_path("../soccer_api/api_football_com/*.rb", __FILE__)).each do |file|
+  require file
+end
+
+# football_data_org
+Dir.glob(File.expand_path("../soccer_api/football_data_org/*.rb", __FILE__)).each do |file|
+  require file
+end
+
+# apifootball_com
+Dir.glob(File.expand_path("../soccer_api/apifootball_com/*.rb", __FILE__)).each do |file|
+  require file
+end
+
+## BASKETBALL
+Dir.glob(File.expand_path("../basketball_api/*.rb", __FILE__)).each do |file|
+  require file
+end
+
+# api_basketball_com
+Dir.glob(File.expand_path("../basketball_api/api_basketball_com/*.rb", __FILE__)).each do |file|
+  require file
+end
+
+module Sports
+  module Butler
+    class Base
+
+      ALIASES = {
+        areas: :countries,
+        leagues: :competitions,
+        events: :matches,
+        fixtures: :matches,
+        top_scorers: :scorers
+      }
+
+      AVAILABLE_ENDPOINTS = {}
+      AVAILABLE_ENDPOINTS = {
+        soccer: {},
+        basketball: {}
+      }
+
+      AVAILABLE_ENDPOINTS[:soccer][:api_football_com] = Dir.
+        glob(File.expand_path("../soccer_api/api_football_com/*.rb", __FILE__))
+      AVAILABLE_ENDPOINTS[:soccer][:apifootball_com] = Dir.
+        glob(File.expand_path("../soccer_api/apifootball_com/*.rb", __FILE__))
+      AVAILABLE_ENDPOINTS[:soccer][:football_data_org] = Dir.
+        glob(File.expand_path("../soccer_api/football_data_org/*.rb", __FILE__))
+
+      AVAILABLE_ENDPOINTS[:basketball][:api_basketball_com] = Dir.
+        glob(File.expand_path("../basketball_api/api_basketball_com/*.rb", __FILE__))
+
+      attr_accessor :sport, :api_name, :api_class, :sport_class,
+                    :endpoints, :available_endpoints, :valid_configuration
+
+      def initialize(sport:, api_name:)
+        @sport        = sport
+        @api_name     = api_name
+        @api_class    = api_name.to_s.camelize
+        @sport_class  = "#{sport.to_s.camelize}Api"
+
+        @endpoints    = {}
+
+        @available_endpoints  = get_available_endpoints
+        @valid_configuration  = !Configuration.invalid_config?(sport, api_name)
+      end
+
+      def method_missing(method, *args, &block)
+        endpoint_name = eval_endpoint_name(method)
+        if endpoint_name.present?
+          @endpoints[method].present? ?
+            @endpoints[method] : @endpoints[method] = build_endpoint_classes(endpoint_name)
+        else
+          raise MissingEndpoint, endpoint_not_available(method)
+        end
+      end
+
+      private
+
+      def get_available_endpoints
+        result = {}.with_indifferent_access
+
+        AVAILABLE_ENDPOINTS[sport][api_name].each do |path|
+          next if File.basename(path, ".*") == 'base'
+
+          endpoint = File.basename(path, ".*")
+          endpoint_methods = self.send(endpoint).available_endpoint_methods
+
+          result_endpoints = {}.with_indifferent_access
+          endpoint_methods.each do |endpoint_method|
+            result_endpoints[endpoint_method] = self.send(endpoint).method(endpoint_method).parameters
+          end
+
+          result[endpoint] = result_endpoints
+        end
+
+        result
+      end
+
+      def eval_endpoint_name(endpoint_name)
+        endpoint = ALIASES[endpoint_name].present? ? ALIASES[endpoint_name] : endpoint_name
+        Kernel.const_defined?( "#{scope}::#{endpoint.to_s.camelize}") ? endpoint.to_s.camelize : nil
+      end
+
+      def scope
+        "Sports::Butler::#{sport_class}::#{api_class}"
+      end
+
+      def build_api_object
+        Api.new(sport, api_name)
+      end
+
+      def build_endpoint_classes(name)
+        "#{scope}::#{name}".constantize.new(sport: sport, api_name: api_name, api: build_api_object)
+      end
+
+      def endpoint_not_available(name)
+        "NOT AVAILABLE: the endpoint '#{name}' is not available for this sport/api combination."
+      end
+
+    end
+
+    class MissingEndpoint < StandardError
+      def initialize(msg)
+        super
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'sports/butler/base'
+
+module Sports
+  module Butler
+    class Basketball < Sports::Butler::Base
+
+      ENDPOINTS = [
+        :countries,
+        :competitions,
+        :matches,
+        :odds,
+        :seasons,
+        :standings,
+        :statistics,
+        :teams,
+        :timezones
+      ]
+
+      def initialize(sport:, api_name:)
+        super
+      end
+
+    end
+  end
+end

data/lib/sports/butler/basketball_api/api_basketball_com/competitions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Sports
+  module Butler
+    module BasketballApi
+      module ApiBasketballCom
+        class Competitions < Sports::Butler::BasketballApi::Competitions
+          def available_endpoint_methods
+            [:all, :by_id, :by_name, :by_country_name, :by_country, :cups, :leagues, :by_season]
+          end
+
+          def path
+            :leagues
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/api_basketball_com/countries.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Sports
+  module Butler
+    module BasketballApi
+      module ApiBasketballCom
+        class Countries < Sports::Butler::BasketballApi::Countries
+          def available_endpoint_methods
+            [:all, :by_name, :by_id, :by_code, :search_by_name]
+          end
+
+          def filters_search_by_name(name)
+            { search: name }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/api_basketball_com/matches.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Sports
+  module Butler
+    module BasketballApi
+      module ApiBasketballCom
+        class Matches < Sports::Butler::BasketballApi::Matches
+
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/api_basketball_com/odds.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Sports
+  module Butler
+    module BasketballApi
+      module ApiBasketballCom
+        class Odds < Sports::Butler::BasketballApi::Odds
+
+          def filters_by_match(id)
+            { game: id }
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/api_basketball_com/seasons.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Sports
+  module Butler
+    module BasketballApi
+      module ApiBasketballCom
+        class Seasons < Sports::Butler::BasketballApi::Seasons
+
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/api_basketball_com/standings.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Sports
+  module Butler
+    module BasketballApi
+      module ApiBasketballCom
+        class Standings < Sports::Butler::BasketballApi::Standings
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/api_basketball_com/statistics.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Sports
+  module Butler
+    module BasketballApi
+      module ApiBasketballCom
+        class Statistics < Sports::Butler::BasketballApi::Statistics
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/api_basketball_com/teams.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sports
+  module Butler
+    module BasketballApi
+      module ApiBasketballCom
+        class Teams < Sports::Butler::BasketballApi::Teams
+
+          def filters_search_by_name(name)
+            { search: name }
+          end
+
+          def filters_by_competition(id)
+            { league: id }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/api_basketball_com/timezones.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Sports
+  module Butler
+    module BasketballApi
+      module ApiBasketballCom
+        class Timezones < Sports::Butler::BasketballApi::Timezones
+
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require "sports/butler/endpoints"
+
+module Sports
+  module Butler
+    module BasketballApi
+      class Base < Sports::Butler::Endpoints
+        def method_missing(method, *args, &block)
+          return error_missing_endpoint_method(method)
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/competitions.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'sports/butler/basketball_api/base'
+
+module Sports
+  module Butler
+    module BasketballApi
+      class Competitions < Sports::Butler::BasketballApi::Base
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/countries.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'sports/butler/basketball_api/base'
+
+module Sports
+  module Butler
+    module BasketballApi
+      class Countries < Sports::Butler::BasketballApi::Base
+        def path
+          :countries
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/matches.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'sports/butler/basketball_api/base'
+
+module Sports
+  module Butler
+    module BasketballApi
+      class Matches < Sports::Butler::BasketballApi::Base
+        def available_endpoint_methods
+          [:by_id, :by_competition_and_year, :all]
+        end
+
+        def path
+          :games
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/odds.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'sports/butler/basketball_api/base'
+
+module Sports
+  module Butler
+    module BasketballApi
+      class Odds < Sports::Butler::BasketballApi::Base
+        def available_endpoint_methods
+          [:by_match]
+        end
+
+        def path
+          :odds
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/seasons.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'sports/butler/basketball_api/base'
+
+module Sports
+  module Butler
+    module BasketballApi
+      class Seasons < Sports::Butler::BasketballApi::Base
+        def available_endpoint_methods
+          [:all]
+        end
+
+        def path
+          :seasons
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/standings.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'sports/butler/basketball_api/base'
+
+module Sports
+  module Butler
+    module BasketballApi
+      class Standings < Sports::Butler::BasketballApi::Base
+        def available_endpoint_methods
+          [:by_competition_and_team_and_season]
+        end
+
+        def path
+          :standings
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/statistics.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'sports/butler/basketball_api/base'
+
+module Sports
+  module Butler
+    module BasketballApi
+      class Statistics < Sports::Butler::BasketballApi::Base
+        def available_endpoint_methods
+          [:by_competition_and_team_and_season]
+        end
+
+        def path
+          :statistics
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/teams.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'sports/butler/basketball_api/base'
+
+module Sports
+  module Butler
+    module BasketballApi
+      class Teams < Sports::Butler::BasketballApi::Base
+        def available_endpoint_methods
+          [:by_id, :by_name, :by_competition, :by_season, :search_by_name ]
+        end
+
+        def path
+          :teams
+        end
+      end
+    end
+  end
+end

data/lib/sports/butler/basketball_api/timezones.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'sports/butler/basketball_api/base'
+
+module Sports
+  module Butler
+    module BasketballApi
+      class Timezones < Sports::Butler::BasketballApi::Base
+        def available_endpoint_methods
+          [:all]
+        end
+
+        def path
+          :timezones
+        end
+      end
+    end
+  end
+end