foot_stats 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color -f d

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+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,72 @@
+# FootStats
+
+FootStats API Client in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'foot_stats'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install foot_stats
+
+## Setup
+
+```ruby
+    FootStats::Setup.setup do |config|
+      config.username = "username"
+      config.password = "password"
+      config.logger   = Rails.logger
+      config.base_url = "http://footstats.com"
+    end
+```
+
+## Usage
+
+```ruby
+     # Championship
+     #
+     championships = FootStats::Championship.all
+
+     # Championship
+     #
+     championship = championships.first
+
+     # Championship Classification
+     #
+     championship.classification 
+
+     # Championship Teams
+     #
+     championship.teams
+
+     # Matches
+     #
+     matches = championship.matches
+
+     # Match
+     match = matches.first
+
+     # Narrations
+     #
+     match.narrations
+```
+
+## Next
+
+* LIVE 'feed'.
+* Create a Fake App (Sandbox), that simulates FootStats API.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/foot_stats.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foot_stats/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "foot_stats"
+  gem.version       = FootStats::VERSION
+  gem.authors       = ["Tomas D'Stefano"]
+  gem.email         = ["tomas_stefano@successoft.com"]
+  gem.description   = %q{FootStats API Client in Ruby.}
+  gem.summary       = %q{FootStats API Client.}
+  gem.homepage      = "https://github.com/tomas-stefano/foot_stats"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'rest-client'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'fakeweb'
+end

data/lib/foot_stats/championship.rb

@@ -0,0 +1,66 @@
+module FootStats
+  class Championship < Resource
+    attr_accessor :source_id, :name, :has_classification, :current_round, :total_rounds
+
+    # Retrieve all championships from FootStats
+    #
+    # @return [Array]
+    #
+    def self.all
+      request  = Request.new(self)
+      response = request.parse
+
+      return response.error if response.error?
+
+      response.collect do |championship|
+        new(
+          :source_id          => championship['@Id'].to_i,
+          :name               => championship['@Nome'],
+          :has_classification => championship['@TemClassificacao'] == 'True',
+          :current_round      => championship['@RodadaATual'].to_i,
+          :total_rounds       => championship['@Rodadas'].to_i
+        )
+      end
+    end
+
+    # Return the resource name to request to FootStats.
+    #
+    # @return [String]
+    #
+    def self.resource_name
+      'ListaCampeonatos'
+    end
+
+    # Return the resource key that is fetch from the API response.
+    #
+    # @return [String]
+    #
+    def self.resource_key
+      'Campeonato'
+    end
+
+    # Return the Championship classification.
+    #
+    # @return [Array]
+    #
+    def classification
+      ChampionshipClassification.all(championship: source_id)
+    end
+
+    # Return the Championship teams.
+    #
+    # @return [Array]
+    #
+    def teams
+      Team.all(championship: source_id)
+    end
+
+    # Return all the Championship matches.
+    #
+    # @return [Array]
+    #
+    def matches
+      Match.all(championship: source_id)
+    end
+  end
+end

data/lib/foot_stats/championship_classification.rb

@@ -0,0 +1,55 @@
+module FootStats
+  class ChampionshipClassification < Resource
+    attr_accessor :team_source_id, :group, :position, :points, :games, :victories, :draws, :loss
+    attr_accessor :goals_for, :goals_against, :goals_balance, :home_victories, :outside_victories
+    attr_accessor :home_draws, :outside_draws, :home_defeats, :outside_defeats, :max_point
+    attr_accessor :use
+
+    def self.all(options={})
+      request  = Request.new(self, :Campeonato => options.fetch(:championship))
+      response = request.parse
+
+      return response.error if response.error?
+
+      response["Classificacoes"]['Classificacao']['Equipe'].collect do |classification|
+        ChampionshipClassification.new(
+          :team_source_id    => classification['@Id'].to_i,
+          :group             => classification['@Grupo'],
+          :position          => classification['Posicao'],
+          :points            => classification['Pontos_Ganhos'],
+          :games             => classification['Jogos'],
+          :victories         => classification['Vitorias'],
+          :draws             => classification['Empates'],
+          :loss              => classification['Derrotas'],
+          :goals_for         => classification['Gols_Pro'],
+          :goals_against     => classification['Gols_Contra'],
+          :goals_balance     => classification['Saldo_Gols'],
+          :home_victories    => classification['Vitorias_Casa'],
+          :outside_victories => classification['Vitorias_Fora'],
+          :home_draws        => classification['Empates_Casa'],
+          :outside_draws     => classification['Empate_Fora'],
+          :home_defeats      => classification['Derrotas_Casa'],
+          :outside_defeats   => classification['Derrotas_Fora'],
+          :max_point         => classification['Ponto_Maximo'],
+          :use               => classification['Aproveitamento']
+        )
+      end
+    end
+
+    # Return the resource name to request to FootStats.
+    #
+    # @return [String]
+    #
+    def self.resource_name
+      'ListaClassificacao'
+    end
+
+    # Return the resource key that is fetch from the API response.
+    #
+    # @return [String]
+    #
+    def self.resource_key
+      'Campeonato'
+    end
+  end
+end

data/lib/foot_stats/error_response.rb

@@ -0,0 +1,13 @@
+module FootStats
+  class ErrorResponse
+    attr_reader :message
+
+    def initialize(message)
+      @message = message
+    end
+
+    def ==(other)
+      @message == other.message
+    end
+  end
+end

data/lib/foot_stats/match.rb

@@ -0,0 +1,77 @@
+module FootStats
+  class Match < Resource
+    attr_accessor :source_id, :date, :status, :referee, :stadium, :city, :state
+    attr_accessor :country, :has_statistic, :has_narration, :round, :phase
+    attr_accessor :cup, :group, :game_number, :live
+    attr_accessor :home_team, :home_team_name, :home_score, :home_penalties_score
+    attr_accessor :visitor_team, :visitor_team_name, :visitor_score, :visitor_penalties_score
+
+    def self.all(options={})
+      request  = Request.new(self, :Campeonato => options.fetch(:championship))
+      response = request.parse
+
+      return response.error if response.error?
+
+      response['Partida'].collect do |match|
+        match_object = Match.new(
+          :source_id     => match['@Id'].to_i,
+          :date          => match['Data'],
+          :status        => match['Status'],
+          :referee       => match['Arbitro'],
+          :stadium       => match['Estadio'],
+          :city          => match['Cidade'],
+          :state         => match['Estado'],
+          :country       => match['Pais'],
+          :has_statistic => match['TemEstatistica'], # TODO: Need to see boolean
+          :has_narration => match['TemNarracao'],    # fields.
+          :round         => match['Rodada'],
+          :phase         => match['Fase'],
+          :cup           => match['Taca'],
+          :group         => match['Grupo'],
+          :game_number   => match['NumeroJogo'],
+          :live          => match['AoVivo']
+        )
+
+        match['Equipe'].each do |team|
+          if team['@Tipo'] == 'Mandante'
+            match_object.home_team            = team['@Id'].to_i
+            match_object.home_team_name       = team['@Nome']
+            match_object.home_score           = team['@Placar']
+            match_object.home_penalties_score = team['@PlacarPenaltis']
+          else
+            match_object.visitor_team            = team['@Id'].to_i
+            match_object.visitor_team_name       = team['@Nome']
+            match_object.visitor_score           = team['@Placar']
+            match_object.visitor_penalties_score = team['@PlacarPenaltis']
+          end
+        end
+
+        match_object
+      end
+    end
+
+    # Return the resource name to request to FootStats.
+    #
+    # @return [String]
+    #
+    def self.resource_name
+      'ListaPartidas'
+    end
+
+    # Return the resource key that is fetch from the API response.
+    #
+    # @return [String]
+    #
+    def self.resource_key
+      'Partidas'
+    end
+
+    # Return the narration from a match
+    #
+    # @return [Array]
+    #
+    def narrations
+      Narration.all(match: source_id)
+    end
+  end
+end

data/lib/foot_stats/narration.rb

@@ -0,0 +1,69 @@
+module FootStats
+  class Narration < Resource
+    attr_accessor :championship_id, :name, :season, :match_id, :score, :has_penalty, :details
+
+    def self.all(options={})
+      request  = Request.new(self, :Partida => options.fetch(:match))
+      response = request.parse
+
+      return response.error if response.error?
+
+      response.resource.collect do |match, value|
+        match_hash = response['Partida']
+        narrations = response['Narracoes'] || []
+
+        narration = Narration.new(
+          :championship_id => response['@Id'].to_i,
+          :name            => response['@Nome'],
+          :season          => response['@Temporada'],
+          :match_id        => match_hash['@Id'].to_i,
+          :score           => match_hash['@Placar'],
+          :has_penalty     => match_hash['@TemDisputaPenaltis']
+        )
+
+        if narrations.empty?
+          narration.details = narrations
+        else
+          narration.details = []
+
+          narrations.each do |foot_stats_narration|
+            narration.details.push(NarrationDetail.new(
+              :source_id        => foot_stats_narration["@Id"].to_i,
+              :team_source_id   => foot_stats_narration["IdEquipe"].to_i,
+              :team_name        => foot_stats_narration["NomeEquipe"],
+              :player_source_id => foot_stats_narration["IdJogador"].to_i,
+              :player_name      => foot_stats_narration["NomeJogador"],
+              :period           => foot_stats_narration["Periodo"],
+              :moment           => foot_stats_narration["Momento"],
+              :description      => foot_stats_narration["Descricao"],
+              :action           => foot_stats_narration["Acao"]
+            ))
+          end
+        end
+
+        narration
+      end
+    end
+
+    # Return the resource name to request to FootStats.
+    #
+    # @return [String]
+    #
+    def self.resource_name
+      'Narracao'
+    end
+
+    # Return the resource key that is fetch from the API response.
+    #
+    # @return [String]
+    #
+    def self.resource_key
+      'Campeonato'
+    end
+  end
+
+  class NarrationDetail < Resource
+    attr_accessor :source_id, :team_source_id, :team_name, :player_source_id
+    attr_accessor :player_name, :period, :moment, :description, :action
+  end
+end

data/lib/foot_stats/request.rb

@@ -0,0 +1,58 @@
+require 'rest-client'
+
+module FootStats
+  # Class responsible to make the request to the FootStats API
+  #
+  # @example
+  #
+  #  Request.new('ListaCampeonatos')
+  #
+  class Request
+    attr_reader :response_body, :resource_name, :resource_key, :logger
+
+    def initialize(resource, options={})
+      @resource_name = resource.resource_name
+      @resource_key  = resource.resource_key
+      @response_body = post(options)
+      @logger        = Setup.logger
+    end
+
+    # Return the request uri based on the resource.
+    #
+    # @return [String]
+    #
+    def request_url
+      "#{Setup.base_url}/#{resource_name}"
+    end
+
+    # Make the post request to the request url.
+    #
+    # @return [String]
+    #
+    def post(options)
+      logger.info("POST #{request_url}") if logger.present?
+      response = RestClient.post(request_url, setup_params.merge(options))
+      logger.info("RESPONSE BODY:\n#{response}\n") if logger.present?
+      response
+    end
+
+    # Parse the "XML"/ "JSON".
+    #
+    # @return [Response]
+    #
+    def parse
+      Response.new(resource_key: @resource_key, body: @response_body)
+    end
+
+    # Passing the setup params configured in your app.
+    #
+    # @return [Hash]
+    #
+    def setup_params
+      {
+        :Usuario => Setup.username,
+        :Senha   => Setup.password
+      }
+    end
+  end
+end

data/lib/foot_stats/resource.rb

@@ -0,0 +1,27 @@
+module FootStats
+  class Resource
+    # Waiting for ActiveModel::Model. =p
+    #
+    def initialize(options={})
+      options.each do |key, value|
+        send("#{key}=", value) if respond_to?("#{key}=")
+      end
+    end
+
+    # Return the resource name to request to FootStats.
+    #
+    # @return [String]
+    #
+    def self.resource_name
+      raise NotImplementedError, "need to implement .resource_name in #{self}."
+    end
+
+    # Return the resource key that is fetch from the API response.
+    #
+    # @return [String]
+    #
+    def self.resource_key
+      raise NotImplementedError, "need to implement .resource_key in #{self}."
+    end
+  end
+end

data/lib/foot_stats/response.rb

@@ -0,0 +1,61 @@
+require 'active_support/json'
+
+module FootStats
+  class Response
+    attr_accessor :resource_key, :body, :parsed_response
+    REGEX_PARSER = /\{.*}/m
+
+    def initialize(options={})
+      @resource_key    = options.fetch(:resource_key)
+      @body            = options.fetch(:body)
+      @parsed_response = ActiveSupport::JSON.decode(json_response)
+    end
+
+    # Return the error response object with the message if had errors.
+    #
+    # @return [ErrorResponse]
+    #
+    def error
+      ErrorResponse.new(@parsed_response['Erro']['@Mensagem']) if error?
+    end
+
+    # Verifies if the response had errors.
+    #
+    # @return [True, False]
+    #
+    def error?
+      @parsed_response['Erro'].present?
+    end
+
+    # Return the resource match by the resource key.
+    #
+    # @return [Hash]
+    #
+    def resource
+      @parsed_response[@resource_key]
+    end
+
+    # Attempt to fetch a key from resource.
+    #
+    # @return [Object]
+    #
+    def [](value)
+      resource[value]
+    end
+
+    # Collect all the resources evaluate from FootStats
+    #
+    # @return [Array]
+    #
+    def collect
+      resource.collect { |resource_value| yield(resource_value) }
+    end
+    alias :map :collect
+
+    private
+
+    def json_response
+      @body.scan(REGEX_PARSER).first
+    end
+  end
+end

data/lib/foot_stats/setup.rb

@@ -0,0 +1,27 @@
+require 'active_support/core_ext/class'
+
+module FootStats
+  # Class responsible to handle all the FootStats setup.
+  #
+  # @example
+  #
+  #    FootStats::Setup.setup do |config|
+  #      config.username = "foo"
+  #      config.password = "bar"
+  #      config.logger   = Rails.logger
+  #      config.base_url = "http://footstats.com.br/modyo.asmx/"
+  #    end
+  #
+  class Setup
+    cattr_accessor :username
+    cattr_accessor :password
+    cattr_accessor :logger
+    cattr_accessor :base_url
+
+    # @param block [Proc]
+    #
+    def self.setup
+      yield(self)
+    end
+  end
+end

data/lib/foot_stats/team.rb

@@ -0,0 +1,37 @@
+module FootStats
+  class Team < Resource
+    attr_accessor :source_id, :full_name, :city, :country
+
+    def self.all(options={})
+      request  = Request.new(self, :IdCampeonato => options.fetch(:championship))
+      response = request.parse
+
+      return response.error if response.error?
+
+      response.collect do |team|
+        Team.new(
+          :source_id => team['@Id'].to_i,
+          :full_name => team['@Nome'],
+          :city      => team['@Cidade'],
+          :country   => team['@Pais']
+        )
+      end
+    end
+
+    # Return the resource name to request to FootStats.
+    #
+    # @return [String]
+    #
+    def self.resource_name
+      'ListaEquipesCampeonato'
+    end
+
+    # Return the resource key that is fetch from the API response.
+    #
+    # @return [String]
+    #
+    def self.resource_key
+      'Equipe'
+    end
+  end
+end

data/lib/foot_stats/version.rb

@@ -0,0 +1,3 @@
+module FootStats
+  VERSION = "0.0.1"
+end

data/lib/foot_stats.rb

@@ -0,0 +1,14 @@
+require 'foot_stats/version'
+
+module FootStats
+  autoload :Championship,  'foot_stats/championship'
+  autoload :ChampionshipClassification, 'foot_stats/championship_classification'
+  autoload :ErrorResponse, 'foot_stats/error_response'
+  autoload :Match,         'foot_stats/match'
+  autoload :Narration,     'foot_stats/narration'
+  autoload :Resource,      'foot_stats/resource'
+  autoload :Request,       'foot_stats/request'
+  autoload :Response,      'foot_stats/response'
+  autoload :Team,          'foot_stats/team'
+  autoload :Setup,         'foot_stats/setup'
+end