api_football_v3 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f766b7f4ba6d62e858803d54a906759715c02ace7f365d9f7da96d1c7b59094
+  data.tar.gz: 38cd3dc31c18d72fb9e433c269bb9068f495dc2279325fc6648315a107619b34
+SHA512:
+  metadata.gz: bca6e2c4a3ac9f8f8af0a22a608cbc213c6335e2d2ba2ce788e65a396bdfb7df5c058a00ecba437716c17c306cd720d0011d0da5ec7566eff7f2078c6db21070
+  data.tar.gz: f5726d1272786dfc1341e0e74418b074076d8742a278dcfee8eb195bddc7231fd612b4071d04721283d1192ebeacddecfc340eb8048a69d39fe64ce67424d54b

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2020 Agustin Gomez Campero
+
+MIT License
+
+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/README.md

@@ -0,0 +1,242 @@
+# The Football API Ruby Gem
+
+A Ruby interface to [API Football v3](https://www.api-football.com)
+
+This gem won't work with v1 or v2 of the API
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_football_v3'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_football_v3
+
+## Configurations
+Configure `api_football_v3` with your API-Key and the URL (depends on whether you are subscribed via RapidApi or ApiSports)
+
+```ruby
+@client = ApiFootballV3::Client.new do |config|
+  config.api_key = "YOUR_API_KEY"
+  config.base_url = "https://api-football-beta.p.rapidapi.com/" #  or https://v3.football.api-sports.io/
+end
+```
+
+## Usage
+Endpoints can be accessed using built in functions that take options as a parameter.
+In all cases options is a hash and they return a JSON object.
+
+Examples:
+```ruby
+@client.countries(search: "Chile")
+```
+Response:
+```
+{
+    "get": "countries",
+    "parameters": {
+        "search": "Chile"
+    },
+    "errors": [],
+    "results": 1,
+    "paging": {
+        "current": 1,
+        "total": 1
+    },
+    "response": [
+        {
+            "name": "Chile",
+            "code": "CL",
+            "flag": "https://media.api-sports.io/flags/cl.svg"
+        }
+    ]
+}
+```
+
+```ruby
+@client.leagues(country: "Chile", season: 2020)
+```
+Response:
+```
+{
+    "get": "leagues",
+    "parameters": {
+        "country": "Chile",
+        "season": "2020"
+    },
+    "errors": [],
+    "results": 2,
+    "paging": {
+        "current": 1,
+        "total": 1
+    },
+    "response": [
+        {
+            "league": {
+                "id": 265,
+                "name": "Primera Division",
+                "type": "League",
+                "logo": "https://media.api-sports.io/football/leagues/265.png"
+            },
+            "country": {
+                "name": "Chile",
+                "code": "CL",
+                "flag": "https://media.api-sports.io/flags/cl.svg"
+            },
+            "seasons": [
+                {
+                    "year": 2020,
+                    "start": "2020-01-24",
+                    "end": "2020-10-11",
+                    "current": true,
+                    "coverage": {
+                        "fixtures": {
+                            "events": true,
+                            "lineups": true,
+                            "statistics_fixtures": true,
+                            "statistics_players": true
+                        },
+                        "standings": true,
+                        "players": true,
+                        "top_scorers": true,
+                        "predictions": true,
+                        "odds": true
+                    }
+                }
+            ]
+        },
+        {
+            "league": {
+                "id": 266,
+                "name": "Primera B",
+                "type": "League",
+                "logo": "https://media.api-sports.io/football/leagues/266.png"
+            },
+            "country": {
+                "name": "Chile",
+                "code": "CL",
+                "flag": "https://media.api-sports.io/flags/cl.svg"
+            },
+            "seasons": [
+                {
+                    "year": 2020,
+                    "start": "2020-02-22",
+                    "end": "2020-10-05",
+                    "current": true,
+                    "coverage": {
+                        "fixtures": {
+                            "events": true,
+                            "lineups": true,
+                            "statistics_fixtures": false,
+                            "statistics_players": false
+                        },
+                        "standings": true,
+                        "players": true,
+                        "top_scorers": true,
+                        "predictions": true,
+                        "odds": true
+                    }
+                }
+            ]
+        }
+    ]
+}
+```
+
+Here you can see how you can call all available endpoints.
+For information on options on each endpoint please review the [official documentation](https://www.api-football.com/documentation-beta).
+
+
+```ruby
+@client.coaches                     # /coachs
+
+@client.countries                   # /countries
+
+@client.fixtures                    # /fixtures
+@client.live                        # /fixtures?live=all
+@client.rounds                      # /fixtures/rounds
+@client.head_to_head                # /fixtures/headtohead
+@client.fixture_statistics          # /fixtures/statistics
+@client.fixture_events              # /fixtures/events
+@client.fixture_lineups             # /fixtures/lineups
+@client.fixture_player_statistics   # /fixtures/players
+
+@client.leagues                     # /leagues
+@client.leagues_seasons             # /leagues/seasons
+
+@client.odds                        # /odds
+@client.mapping                     # /odds/mapping
+@client.bookmakers                  # /odds/bookmakers
+@client.bets                        # /odds/bets
+
+@client.players                     # /players
+@client.top_scorers                 # /players/topscorers
+@client.players_seasons             # /players/seasons
+
+@client.predictions                 # /predictions
+
+@client.sidelined                   # /sidelined
+
+@client.standings                   # /standings
+
+@client.teams                       # /teams
+@client.team_statistics             # /teams/statistics
+
+@client.timezones                   # /timezone
+
+@client.transfers                   # /transfers
+
+@client.trophies                    # /trophies
+
+@client.venues                      # /venues
+```
+
+All endpoints can also be accessed using `get(endpoint, options)`.
+
+Example:
+```ruby
+@client.get('/teams', { id: 2323 })
+```
+Response:
+```
+{
+    "get":"teams",
+    "parameters":{
+        "id":"2323"
+    },
+    "errors":[],
+    "results":1,
+    "paging":{
+        "current":1,
+        "total":1
+    },
+    "response":[
+        {
+            "team":{
+                "id":2323,
+                "name":"Universidad de Chile",
+                "country":"Chile",
+                "founded":1927,
+                "national":false,
+                "logo":"https://media.api-sports.io/football/teams/2323.png"
+            },
+            "venue":{
+                "id":316,
+                "name":"Estadio Nacional Julio Mart\u00EDnez Pr\u00E1danos",
+                "address":"Avenida Grecia 2001, \u00D1u\u00F1oa",
+                "city":"Santiago de Chile",
+                "capacity":48665,
+                "surface":"grass",
+                "image":"https://media.api-sports.io/football/venues/316.png"
+            }
+        }
+    ]
+}
+```

data/api_football_v3.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |spec|
+  spec.name = "api_football_v3"
+  spec.version = "0.0.2"
+  spec.authors = ["agomezcampero"]
+  spec.email = ["agomezcampero@gmail.com"]
+  spec.date = "2020-09-17"
+  spec.summary = "A gem to connect to api-football v3, www.api-football.com"
+  spec.files = %w[LICENSE.md README.md api_football_v3.gemspec] + Dir['lib/**/*.rb']
+  spec.homepage = 'https://github.com/agomezcampero/api_football_v3'
+  spec.require_paths = ["lib"]
+  spec.licenses = %w[MIT]
+end

data/lib/api_football_v3.rb

@@ -0,0 +1 @@
+require 'api_football_v3/client'

data/lib/api_football_v3/client.rb

@@ -0,0 +1,17 @@
+require 'api_football_v3/rest/api'
+require 'api_football_v3/request'
+
+module ApiFootballV3
+  class Client
+    include ApiFootballV3::Rest::Api
+    include ApiFootballV3::Request
+    attr_accessor :api_key, :base_url
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      yield(self) if block_given?
+    end
+  end
+end

data/lib/api_football_v3/error.rb

@@ -0,0 +1,36 @@
+module ApiFootballV3
+  class Error < StandardError
+    attr_reader :code
+
+    ClientError = Class.new(self)
+    BadRequest = Class.new(ClientError)
+    Unauthorized = Class.new(ClientError)
+    Forbidden = Class.new(ClientError)
+    NotFound = Class.new(ClientError)
+    NotAcceptable = Class.new(ClientError)
+    RequestEntityTooLarge = Class.new(ClientError)
+    UnprocessableEntity = Class.new(ClientError)
+    TooManyRequests = Class.new(ClientError)
+
+    ServerError = Class.new(self)
+    InternalServerError = Class.new(ServerError)
+    BadGateway = Class.new(ServerError)
+    ServiceUnavailable = Class.new(ServerError)
+    GatewayTimeout = Class.new(ServerError)
+
+    ERRORS = {
+      400 => ApiFootballV3::Error::BadRequest,
+      401 => ApiFootballV3::Error::Unauthorized,
+      403 => ApiFootballV3::Error::Forbidden,
+      404 => ApiFootballV3::Error::NotFound,
+      406 => ApiFootballV3::Error::NotAcceptable,
+      413 => ApiFootballV3::Error::RequestEntityTooLarge,
+      422 => ApiFootballV3::Error::UnprocessableEntity,
+      429 => ApiFootballV3::Error::TooManyRequests,
+      500 => ApiFootballV3::Error::InternalServerError,
+      502 => ApiFootballV3::Error::BadGateway,
+      503 => ApiFootballV3::Error::ServiceUnavailable,
+      504 => ApiFootballV3::Error::GatewayTimeout
+    }.freeze
+  end
+end

data/lib/api_football_v3/request.rb

@@ -0,0 +1,51 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+require 'json'
+require 'api_football_v3/error'
+
+module ApiFootballV3
+  module Request
+    def get(path, options = {})
+      @path = path
+      @options = options
+      perform_get_request
+    end
+
+    private
+
+    def perform_get_request
+      response = http.request(request)
+      response_body = response.read_body ? JSON.parse(response.read_body) : ''
+      raise(error(response.code), response_body) unless response.is_a?(Net::HTTPSuccess)
+
+      response_body
+    end
+
+    def url
+      URI(@base_url + @path + query_params)
+    end
+
+    def query_params
+      '?' + URI.encode_www_form(@options)
+    end
+
+    def http
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http
+    end
+
+    def request
+      request = Net::HTTP::Get.new(url)
+      request["x-rapidapi-key"] = @api_key
+      request
+    end
+
+    def error(code)
+      klass = ApiFootballV3::Error::ERRORS[code.to_i]
+      klass || ApiFootballV3::Error
+    end
+  end
+end

data/lib/api_football_v3/rest/api.rb

@@ -0,0 +1,35 @@
+require 'api_football_v3/rest/coaches'
+require 'api_football_v3/rest/countries'
+require 'api_football_v3/rest/fixtures'
+require 'api_football_v3/rest/leagues'
+require 'api_football_v3/rest/odds'
+require 'api_football_v3/rest/players'
+require 'api_football_v3/rest/predictions'
+require 'api_football_v3/rest/sidelined'
+require 'api_football_v3/rest/standings'
+require 'api_football_v3/rest/teams'
+require 'api_football_v3/rest/timezones'
+require 'api_football_v3/rest/transfers'
+require 'api_football_v3/rest/trophies'
+require 'api_football_v3/rest/venues'
+
+module ApiFootballV3
+  module Rest
+    module Api
+      include ApiFootballV3::Rest::Coaches
+      include ApiFootballV3::Rest::Countries
+      include ApiFootballV3::Rest::Fixtures
+      include ApiFootballV3::Rest::Leagues
+      include ApiFootballV3::Rest::Odds
+      include ApiFootballV3::Rest::Players
+      include ApiFootballV3::Rest::Predictions
+      include ApiFootballV3::Rest::Sidelined
+      include ApiFootballV3::Rest::Standings
+      include ApiFootballV3::Rest::Teams
+      include ApiFootballV3::Rest::Timezones
+      include ApiFootballV3::Rest::Transfers
+      include ApiFootballV3::Rest::Trophies
+      include ApiFootballV3::Rest::Venues
+    end
+  end
+end

data/lib/api_football_v3/rest/coaches.rb

@@ -0,0 +1,9 @@
+module ApiFootballV3
+  module Rest
+    module Coaches
+      def coaches(options = {})
+        get('/coachs', options)
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/countries.rb

@@ -0,0 +1,9 @@
+module ApiFootballV3
+  module Rest
+    module Countries
+      def countries(options = {})
+        get('/countries', options)
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/fixtures.rb

@@ -0,0 +1,37 @@
+module ApiFootballV3
+  module Rest
+    module Fixtures
+      def fixtures(options = {})
+        get('/fixtures', options)
+      end
+
+      def live
+        get('/fixtures', { live: 'all' })
+      end
+
+      def rounds(options = {})
+        get('/fixtures/rounds', options)
+      end
+
+      def head_to_head(options = {})
+        get('/fixtures/headtohead', options)
+      end
+
+      def fixture_statistics(options = {})
+        get('/fixtures/statistics', options)
+      end
+
+      def fixture_events(options = {})
+        get('/fixtures/events', options)
+      end
+
+      def fixture_lineups(options = {})
+        get('/fixtures/lineups', options)
+      end
+
+      def fixture_player_statistics(options = {})
+        get('/fixtures/players', options)
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/leagues.rb

@@ -0,0 +1,13 @@
+module ApiFootballV3
+  module Rest
+    module Leagues
+      def leagues(options = {})
+        get('/leagues', options)
+      end
+
+      def leagues_seasons
+        get('/leagues/seasons')
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/odds.rb

@@ -0,0 +1,21 @@
+module ApiFootballV3
+  module Rest
+    module Odds
+      def odds(options = {})
+        get('/odds', options)
+      end
+
+      def mapping(options = {})
+        get('/odds/mapping', options)
+      end
+
+      def bookmakers(options = {})
+        get('/odds/bookmakers', options)
+      end
+
+      def bets(options = {})
+        get('/odds/bets', options)
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/players.rb

@@ -0,0 +1,17 @@
+module ApiFootballV3
+  module Rest
+    module Players
+      def players(options = {})
+        get('/players', options)
+      end
+
+      def top_scorers(options = {})
+        get('/players/topscorers', options)
+      end
+
+      def players_seasons
+        get('/players/seasons')
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/predictions.rb

@@ -0,0 +1,9 @@
+module ApiFootballV3
+  module Rest
+    module Predictions
+      def predictions(options = {})
+        get('/predictions', options)
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/sidelined.rb

@@ -0,0 +1,9 @@
+module ApiFootballV3
+  module Rest
+    module Sidelined
+      def sidelined(options = {})
+        get('/sidelined', options)
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/standings.rb

@@ -0,0 +1,9 @@
+module ApiFootballV3
+  module Rest
+    module Standings
+      def standings(options = {})
+        get('/standings', options)
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/teams.rb

@@ -0,0 +1,13 @@
+module ApiFootballV3
+  module Rest
+    module Teams
+      def teams(options = {})
+        get('/teams', options)
+      end
+
+      def team_statistics(options = {})
+        get('/teams/statistics', options)
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/timezones.rb

@@ -0,0 +1,9 @@
+module ApiFootballV3
+  module Rest
+    module Timezones
+      def timezones
+        get('/timezone')
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/transfers.rb

@@ -0,0 +1,9 @@
+module ApiFootballV3
+  module Rest
+    module Transfers
+      def transfers(options = {})
+        get('/transfers', options)
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/trophies.rb

@@ -0,0 +1,9 @@
+module ApiFootballV3
+  module Rest
+    module Trophies
+      def trophies(options = {})
+        get('/trophies', options)
+      end
+    end
+  end
+end

data/lib/api_football_v3/rest/venues.rb

@@ -0,0 +1,9 @@
+module ApiFootballV3
+  module Rest
+    module Venues
+      def venues(options = {})
+        get('/venues', options)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: api_football_v3
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- agomezcampero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-17 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- agomezcampero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- api_football_v3.gemspec
+- lib/api_football_v3.rb
+- lib/api_football_v3/client.rb
+- lib/api_football_v3/error.rb
+- lib/api_football_v3/request.rb
+- lib/api_football_v3/rest/api.rb
+- lib/api_football_v3/rest/coaches.rb
+- lib/api_football_v3/rest/countries.rb
+- lib/api_football_v3/rest/fixtures.rb
+- lib/api_football_v3/rest/leagues.rb
+- lib/api_football_v3/rest/odds.rb
+- lib/api_football_v3/rest/players.rb
+- lib/api_football_v3/rest/predictions.rb
+- lib/api_football_v3/rest/sidelined.rb
+- lib/api_football_v3/rest/standings.rb
+- lib/api_football_v3/rest/teams.rb
+- lib/api_football_v3/rest/timezones.rb
+- lib/api_football_v3/rest/transfers.rb
+- lib/api_football_v3/rest/trophies.rb
+- lib/api_football_v3/rest/venues.rb
+homepage: https://github.com/agomezcampero/api_football_v3
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A gem to connect to api-football v3, www.api-football.com
+test_files: []