football_data 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8bbe4b1bd4a6641d8ff67525542f49f5a75f617
+  data.tar.gz: 592420d5665dd0bd8a33214880f715ed79d159d5
+SHA512:
+  metadata.gz: 5230e13746916e6a9b126e2214f8178d08d18dae3ed67259cc195c29fe4133e9d2860dc0a06421ccfb995ef7c9c08a3681210114491e0d9969de96cf7dbaa9f1
+  data.tar.gz: 8fbf36da3b2f8707c61ae44fcc38fcc0861924baa33301ecbed81cf498fc5d681f843eeec2de39a5edfbdca057b735019758714f7b49c1705e3c1668c4f22b28

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in football_data.gemspec
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+# FootballData
+
+This gem intends to provide easy access to the REST API provided by [Football-Data](http://api.football-data.org)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'football_data'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install football_data
+
+## Usage
+
+According to the API documentation, you can retrive the following model:
+
+<image> 
+
+```ruby
+FootballData.all_seasons 
+```
+This method returns all the current seasons. A season is made of teams, their 
+fixtures and the respective league table.
+
+
+TBA
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "football_data"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/football_data.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'football_data/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "football_data"
+  spec.version       = FootballData::VERSION
+  spec.authors       = ["PedroGabriel"]
+  spec.email         = ["pedrogabriel@protonmail.ch"]
+
+  spec.summary       = %q{Quick access to the Football-Data API}
+  spec.description   = %q{This gem intends to provide easy access to the REST API provided by Football-Data}
+  spec.homepage      = "https://bitbucket.org/PedroGabriel/footballdatagem"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "json", '~> 1.8', '>= 1.8.3'
+  spec.add_development_dependency "rspec", '~> 3.3'
+  spec.add_development_dependency "rest-client", '~> 1.8'
+end

data/lib/football_data.rb

@@ -0,0 +1,49 @@
+
+require "json"
+require "rest-client"
+
+module FootballData
+
+  private
+
+  @@api_key
+
+  public
+
+  def self.set_api_key(api_key)
+    @@api_key = api_key
+  end
+
+  ##
+  # 
+  #
+  def self.all_leagues
+    uri = 'http://api.football-data.org/v1/soccerseasons/'
+    leagues = []
+    begin
+      json = Utils::request uri
+      json.each do |league|
+        leagues.push League.new(league)
+      end
+      return leagues
+    rescue
+      return leagues
+    end
+  end
+
+  ##
+  # Each season is based upon a certain league.
+  # In order to select a certain season we must provide the league's
+  # name in order to select the most recent season.
+  #
+  # @param name_or_id League's name
+  #
+  def self.get_league(name_or_id)
+    return nil if name_or_id.nil?
+    leagues = self.all_leagues
+    leagues.each do |league|
+      return league if league.has_eql_name(name_or_id) or league.has_eql_id(name_or_id)
+    end
+    nil
+  end
+end

data/lib/football_data/fixture.rb

@@ -0,0 +1,41 @@
+require_relative './link'
+class Fixture
+
+  attr_reader :date, :status, :match_day, :home_team_name, :away_team_name,
+              :result, :links, :id
+
+  def initialize(fixture_hash)
+    @date = fixture_hash['date']
+    @status = fixture_hash['status']
+    @match_day = fixture_hash['matchday']
+    @home_team_name = fixture_hash['homeTeamName']
+    @away_team_name = fixture_hash['awayTeamName']
+    @result = fixture_hash['result'] #gives an hash as well
+    @links = Link.new(fixture_hash['_links'])
+    @id = @links.self.split('/').pop
+  end
+
+  ##
+  # Gives back the amount of goals related
+  # to the home team.
+  #
+  def goals_home_team
+    @result['goalsHomeTeam']
+  end
+
+  ##
+  # Gives back the amount of goals related
+  # to the away team.
+  #
+  def goals_away_team
+    @result['goalsAwayTeam']
+  end
+
+  ##
+  # Printable version of Fixture instance.
+  #
+  def to_s
+    "(#{@id}) - Match Day #{@match_day} #{@home_team_name} vs #{@away_team_name} - #{@status}"
+  end
+
+end

data/lib/football_data/league.rb

@@ -0,0 +1,120 @@
+require_relative '../football_data/link'
+
+require_relative '../football_data'
+require_relative './utils'
+extend Utils
+
+require_relative './team'
+require_relative './standing'
+require 'rest-client'
+
+##
+# DTO Class that represents the concept of a league.
+#
+class League
+  attr_reader :caption, :league, :year, :number_of_teams, :number_of_games, 
+              :links, :id
+  
+
+  def initialize(season_hash)
+    raise ArgumentError.new('JSON object is invalid') if season_hash.nil?
+
+    @caption = season_hash['caption'] || nil #TODO rename
+    @league = season_hash['league'] || nil  #TODO rename
+    @year = season_hash['year'] || nil
+    @number_of_teams = season_hash['numberOfTeams'] || nil
+    @number_of_games = season_hash['numberOfGames'] || nil
+    @links = Link.new(season_hash['_links'])
+    @id = @links.self.split('/').pop
+  
+    @teams = []
+  end
+
+  ##
+  # Returns an array of Team that represents all the teams inside a certain
+  # season. It uses an internal "buffer" that gets returned if any other call
+  # to this method was made previously. This may happen since for an entire 
+  # season the set of teams is constant.
+  #
+  def get_teams
+    return @teams unless @teams.empty?
+    season_hash_teams = Utils.request(@links.teams) 
+    season_hash_teams['teams'].each do |team|
+      @teams.push Team.new(team)
+    end
+    @teams
+  end
+
+  ##
+  # 
+  #
+  def get_team(name)
+    get_teams.each { |team| return team if team.name.eql?(name) or team.short_name.eql?(name) }
+    nil
+  end
+
+  ##
+  # Printable version of League instance. 
+  #
+  def to_s
+    "(#{@id})#{@league} - #{@caption} - #{@year}"
+  end
+
+  ##
+  # Verifies if the target team has the same name as
+  # the parameter. You can pass the name or the short name.
+  #
+  def has_eql_name(name)
+    @caption.eql? name or @league.eql? name
+  end
+
+  ##
+  # Verifies if the target team has the same id
+  # as the id passed as parameter.
+  #
+  def has_eql_id(id)
+    @id.eql? id
+  end
+
+  ##
+  # Returns an array with instances of Fixture. It does not use an internal 
+  # array since the API does not hold all the fixtures since the beginning of the
+  # season. It keep adding as time goes by which makes every call return a new
+  # value every time. 
+  #
+  def all_fixtures
+    fixtures = []
+    league_hash_fixtures = Utils.request(@links.fixtures)
+    league_hash_fixtures['fixtures'].each do |fix|
+      fixtures.push Fixture.new(fix)
+    end
+    fixtures
+  end
+
+  ##
+  # It tries to return a given matchday. Instead of returning all the fixtures,
+  # it filters and returns only one if the parameter equals to the id present
+  # in any of the matchdays.
+  def get_matchday(matchday_number)
+    throw ArgumentError if matchday_number < 1
+    fixtures_from_matchday = []
+    self.all_fixtures.each do |matchday| 
+      fixtures_from_matchday.push matchday if matchday.match_day == matchday_number
+    end
+    fixtures_from_matchday
+  end
+
+  ##
+  # Tries to acquire the resource given by the the URI "leaguetable"
+  # present in the main resource (all seasons).
+  # It does not use a buffer mechanism since after every week all the
+  # league tables might change according to the results of each fixture.
+  def get_leaguetable
+    leaguetable = []
+    league_hash_leaguetable = Utils.request(@links.league_table)
+    league_hash_leaguetable['standing'].each do |standing_hash| 
+      leaguetable.push Standing.new(standing_hash)
+    end
+    leaguetable
+  end
+end

data/lib/football_data/link.rb

@@ -0,0 +1,17 @@
+
+class Link
+
+  attr_reader :self, :teams, :fixtures, :league_table
+  attr_reader :team
+
+  def initialize(link_hash)
+    raise ArgumentError.new('JSON object is invalid') if link_hash.nil?
+
+    @self = link_hash['self']['href'] unless link_hash['self'].nil?
+    @team = link_hash['team']['href'] unless link_hash['team'].nil?
+    @teams = link_hash['teams']['href'] unless link_hash['teams'].nil?
+    @fixtures = link_hash['fixtures']['href'] unless link_hash['fixtures'].nil?
+    @league_table = link_hash['leagueTable']['href'] unless link_hash['leagueTable'].nil?
+  end
+
+end

data/lib/football_data/standing.rb

@@ -0,0 +1,25 @@
+
+class Standing
+
+  attr_reader :links, :position, :team_name, :points, :played_games
+  attr_reader :goals, :goals_against, :goal_difference, :wins, :draws, :losses
+
+  def initialize(standing_hash)
+    @links = Link.new(standing_hash['_links'])
+    @position = standing_hash['position']
+    @team_name = standing_hash['teamName']
+    @played_games = standing_hash['playedGames']
+    @points = standing_hash['points']
+    @goals = standing_hash['goals']
+    @goals_against = standing_hash['goalsAgainst']
+    @goal_difference = standing_hash['goalDifference']
+    @wins = standing_hash['wins']
+    @draws = standing_hash['draws']
+    @losses = standing_hash['losses']
+  end
+
+  def to_s
+    "#{@position} - #{@team_name} - #{@points} Points"
+  end
+
+end

data/lib/football_data/team.rb

@@ -0,0 +1,22 @@
+require_relative './link'
+
+class Team
+  attr_reader :name, :market_value, :code, :short_name, :crest_url, :links, :id
+
+  def initialize(team_hash)
+    @name = team_hash['name']
+    @code = team_hash['code']
+    @short_name = team_hash['shortName']
+    @crest_url = team_hash['crestUrl']
+    @market_value = team_hash['squadMarketValue']
+    @links = Link.new(team_hash['_links'])
+    @id = @links.self.split('/').pop
+  end
+
+
+  def to_s
+    rep = "#{@name}"
+    rep = " - (#{@code}) " unless @code.nil? 
+    rep + " - #{@short_name}"
+  end
+end

data/lib/football_data/utils.rb

@@ -0,0 +1,12 @@
+module Utils
+    def self.request(uri)
+      begin
+        api_key =  FootballData.class_variable_get(:@@api_key)
+        response = RestClient.get uri,  {'x-auth-token' => api_key}
+        return JSON.parse(response.body) if response.code == 200
+        nil
+      rescue
+        return nil
+      end
+    end
+  end

data/lib/football_data/version.rb

@@ -0,0 +1,3 @@
+module FootballData
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: football_data
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- PedroGabriel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: This gem intends to provide easy access to the REST API provided by Football-Data
+email:
+- pedrogabriel@protonmail.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- football_data.gemspec
+- lib/football_data.rb
+- lib/football_data/fixture.rb
+- lib/football_data/league.rb
+- lib/football_data/link.rb
+- lib/football_data/standing.rb
+- lib/football_data/team.rb
+- lib/football_data/utils.rb
+- lib/football_data/version.rb
+homepage: https://bitbucket.org/PedroGabriel/footballdatagem
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Quick access to the Football-Data API
+test_files: []