football__data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 707998b5dd3cbd164065aa5e8a950452584590c4
+  data.tar.gz: b7f4a287e8d4a4d886376848ffb5d4d351b73002
+SHA512:
+  metadata.gz: ceea9f5e640522bb22a840d6075dcc07b8111a558933ea149ae2083df6d0864a18346a115ab7f67c7904cc2970000af3e57a4423ed8c00f7d742a9f0db9a0f5b
+  data.tar.gz: 6e0b033c89154db0525673f69dd2a9d5c5112fd73843e8fc9208b3c94afd31214b1dfb8920c40346f5ef7c79dd65d240051b20d18d757e603662b6225acce71e

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,74 @@
+# FootballData
+
+A ruby wrapper of [football-data.org](http://api.football-data.org/index)
+
+## 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
+
+### API Usage
+
+First you need to configure the api
+
+```ruby
+FootballData.configure do |config|
+    # get api key at 'http://api.football-data.org/register'
+    config.api_key = YOUR_API_KEY
+
+    # default api version is 'alpha' if not setted
+    config.api_version = 'alpha'
+
+    # the default control method is 'full' if not setted
+    # see request section on 'http://api.football-data.org/documentation'
+    config.response_control = 'minified'
+end
+```
+
+Use `FootballData.fetch(resource, subresource, params)` to fetch the data.
+It returns a json parsed object. Such as:
+
+```ruby
+# GET 'http://api.football-data.org/v1/soccerseasons'
+FootballData.fetch(:soccerseasons)
+
+# GET 'http://api.football-data.org/v1/soccerseasons/398/leagueTable'
+FootballData.fetch(:soccerseasons, :leagueTable, id: 398)
+
+# GET 'http://api.football-data.org/v1/soccerseasons/398/fixtures?matchday=8'
+FootballData.fetch(:soccerseasons, :fixtures, id: 398, matchday: 8)
+
+res = FootballData.fetch(:teams, :players, id: 57)
+pp res['players'].find{|player| player['name'] =~ /Mesut/i}
+# {"id"=>1967,
+# "name"=>"Mesut Özil",
+# "position"=>"Attacking Midfield",
+# "jerseyNumber"=>11,
+# "dateOfBirth"=>"1988-10-15",
+# "nationality"=>"Germany",
+# "contractUntil"=>"2018-06-30",
+# "marketValue"=>"40,000,000 €"}
+```
+
+See api structure on page 'http://api.football-data.org/documentation'
+
+### Executable Usage
+
+TODO
+
+## Contributing
+
+Feel free to file an issue of make a pr.

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/football

@@ -0,0 +1 @@
+#!/usr/bin/env ruby

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,25 @@
+# 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       = ["delta"]
+  spec.email         = ["delta4d@gmail.com"]
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{ruby api wrapper of football-data.org}
+  spec.description   = %q{ruby api wrapper of football-data.org}
+  spec.homepage      = "https://github.com/delta4d/football-data"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ["football"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "faraday", "~> 0.9"
+end

data/lib/football__data/configuration.rb

@@ -0,0 +1,24 @@
+module FootballData
+    module Configuration
+        DEFAULT_API_KEY = nil
+        DEFAULT_API_VERSON   = "alpha"
+        DEFAULT_RESPONSE_CONTROL = "full"
+
+        API_ENDPOINT = "http://api.football-data.org"
+
+        attr_writer :api_version, :api_key, :response_control
+
+        def configure
+            raise "don't you wanna configure it?" unless block_given?
+            yield self
+            @api_version ||= DEFAULT_API_VERSON
+            @response_control ||= DEFAULT_RESPONSE_CONTROL
+        end
+
+        def reset!
+            @api_key = DEFAULT_API_KEY
+            @api_version = DEFAULT_API_VERSON
+            @response_control = DEFAULT_RESPONSE_CONTROL
+        end
+    end
+end

data/lib/football__data/version.rb

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

data/lib/football__data.rb

@@ -0,0 +1,48 @@
+require "football__data/version"
+require "football__data/configuration"
+
+require "json"
+require "faraday"
+
+module FootballData
+    extend Configuration
+
+    class << self
+        # main method of FootballData, fetch info of football matches and players
+        # see 'http://api.football-data.org/documentation' for details
+        #
+        # @param resource [Symbol, String] one of :soccerseasons, :teams, :fixtures
+        # @param subresource [Symbol, String]
+        #   :soccerseasons => one of :fixtures, :teams, :leagueTable
+        #   :teams => one of :fixtures, :players
+        # @param params [Hash] the filter parameters, :id is also pass by params
+        def fetch(resource, subresource = nil, params = {})
+            id, filter = parse_params(params)
+            path = "/#{@api_version}/#{resource}"
+            path += "/#{id}/#{subresource}" if id
+            path += "?#{filter}" if filter
+            response = get(path)
+            JSON.parse(response.body)
+        end
+
+        private
+
+        def parse_params(params)
+            id = params[:id]
+            no_id_params = params.dup
+            no_id_params.delete(:id)
+            filter = no_id_params.map{ |key, val| "#{key}=#{val}" }.join("&")
+            [id, filter]
+        end
+
+        def connection
+            @connection ||= Faraday.new(url: API_ENDPOINT,
+                                        headers: {"X-Auth-Token" => @api_key,
+                                                  "X-Response-Control" => @response_control})
+        end
+
+        def get(path)
+            connection.get(path)
+        end
+    end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: football__data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- delta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-06 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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: ruby api wrapper of football-data.org
+email:
+- delta4d@gmail.com
+executables:
+- football
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/football
+- bin/setup
+- football__data.gemspec
+- lib/football__data.rb
+- lib/football__data/configuration.rb
+- lib/football__data/version.rb
+homepage: https://github.com/delta4d/football-data
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: ruby api wrapper of football-data.org
+test_files: []
+has_rdoc: