footty 0.4.0 → 2024.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a9e350f6c69753563babe7b6313e990333d20f8a
-  data.tar.gz: 9abbd3a090529c2d6dceb8f5cb4a30c09032885a
+SHA256:
+  metadata.gz: 34ac44dbe56d51fad5a516b69331ab594243cbac79f5c4b63f69271455773cd5
+  data.tar.gz: 428605f76f7713f3e61f8cf53cf80d5c8c3d6add43f649a0d701e9ca465d4259
 SHA512:
-  metadata.gz: 9fb986e01c99f9ce33b1ebb04e321af30c85570967c42a046029c3c70726a57e38a56a8f217792959cebe9d59313962407af8ca54a07c4a2af07f422812751ad
-  data.tar.gz: dae5fdad18c6f894f01e991d5bc0db5f9345fbde968edf3d42b4f3407c79a31e2678af30269d2b24d67b419e1d8f1602d6a856bad70828aa0c08b87f93d31979
+  metadata.gz: 359ab0cc33ca8b8482a1d2e9cb60ea58e96c95c5494dc35232018dba09fe164f22a8a167afc1536e90ed9dabb600fe412fab6d0c7aa1a4afa3e3967e3c857907
+  data.tar.gz: 344366274d54e0721d8a718af983dd555009db88a8d11f89e56149bef17cb24ff23e17c772ca133a31bef0e0ac65a1dc68207b45e3c9a4c9c429241d30398599

data/{HISTORY.md → CHANGELOG.md}

@@ -1,3 +1,4 @@
+### 2024.5.10
 ### 1.0.0 / 2018-06-09
 
 * Everything is new (again). First release.

data/Manifest.txt

@@ -1,4 +1,4 @@
-HISTORY.md
+CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
@@ -6,5 +6,3 @@ bin/footty
 lib/footty.rb
 lib/footty/client.rb
 lib/footty/version.rb
-test/helper.rb
-test/test_client.rb

data/README.md

@@ -1,10 +1,9 @@
-# footty - football.db command line client for world cup (russia 2018) and more
+# footty - football.db command line client for european ("euro") championship 2024 and more
 
 * home  :: [github.com/sportdb/footty](https://github.com/sportdb/footty)
 * bugs  :: [github.com/sportdb/footty/issues](https://github.com/sportdb/footty/issues)
 * gem   :: [rubygems.org/gems/footty](https://rubygems.org/gems/footty)
 * rdoc  :: [rubydoc.info/gems/footty](http://rubydoc.info/gems/footty)
-* forum :: [opensport](http://groups.google.com/group/opensport)
 
 
 
@@ -15,27 +14,12 @@
 The footty command line tool lets you query the online football.db HTTP JSON API services
 for upcoming or past matches. For example:
 
-    $ footty              # Defaults to today's world cup 2018 matches
+    $ footty              # Defaults to today's euro 2024 matches
 
-prints on Jun/14 2018:
+prints on Jun/14 2024:
 
-    #1 Thu Jun/14       Russia (RUS)  5-0  Saudi Arabia (KSA) Group A  @ Luzhniki Stadium, Moscow
-                     [Gazinsky 12' Cheryshev 43' Dzyuba 71' Cheryshev 90+1' Golovin 90+4']
-
-prints on Jun/15 2018:
-
-    #2 Fri Jun/15        Egypt (EGY) vs      Uruguay (URU) Group A  @ Ekaterinburg Arena, Ekaterinburg
-    #3 Fri Jun/15     Portugal (POR) vs        Spain (ESP) Group B  @ Fisht Stadium, Sochi
-    #4 Fri Jun/15      Morocco (MAR) vs         Iran (IRN) Group B  @ Saint Petersburg Stadium, Saint Petersburg
-
-prints on Jun/16:
-
-    #5 Sat Jun/16       France (FRA) vs    Australia (AUS) Group C  @ Kazan Arena, Kazan
-    #6 Sat Jun/16         Peru (PER) vs      Denmark (DEN) Group C  @ Mordovia Arena, Saransk
-    #7 Sat Jun/16    Argentina (ARG) vs      Iceland (ISL) Group D  @ Spartak Stadium, Moscow
-    #8 Sat Jun/16      Croatia (CRO) vs      Nigeria (NGA) Group D  @ Kaliningrad Stadium, Kaliningrad
-
-and so on.
+    #1 Fri Jun/14            Germany (GER)    vs    Scotland (SCO)         Group A / Matchday 1
+   
 Use `tomorrow` or `t` or `+1` to print tomorrow's matches e.g.:
 
     $ footty tomorrow    # -or-
@@ -60,6 +44,13 @@ Use `past` or `p` to print all past matches e.g.:
 That's it. Enjoy the beautiful game.
 
 
+
+
+## Trivia
+
+Why tty? tty stands for teletype (tty) writer and is the old traditional (short) name for the unix command line.
+
+
 ## Install
 
 Just install the gem:
@@ -73,8 +64,11 @@ The `footty` scripts are dedicated to the public domain.
 Use it as you please with no restrictions whatsoever.
 
 
+
+
+
 ## Questions? Comments?
 
-Send them along to the
-[Open Sports & Friends Forum/Mailing List](http://groups.google.com/group/opensport).
-Thanks!
+Yes, you can. More than welcome.
+See [Help & Support »](https://github.com/openfootball/help)
+

data/Rakefile

@@ -5,17 +5,17 @@ Hoe.spec 'footty' do
 
   self.version = Footty::VERSION
 
-  self.summary = 'footty - football.db command line client for world cup (russia 2018) and more - who is playing today?'
+  self.summary = 'footty - football.db command line client for european "euro" championship 2024 and more - who is playing today?'
   self.description = summary
 
-  self.urls = ['https://github.com/sportdb/footty']
+  self.urls = { home: 'https://github.com/sportdb/footty' }
 
   self.author = 'Gerald Bauer'
   self.email = 'opensport@googlegroups.com'
 
   # switch extension to .markdown for gihub formatting
-  self.readme_file = 'README.md'
-  self.history_file = 'HISTORY.md'
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
     ['logutils' ],
@@ -25,6 +25,6 @@ Hoe.spec 'footty' do
   self.licenses = ['Public Domain']
 
   self.spec_extras = {
-   :required_ruby_version => '>= 2.3'
+   required_ruby_version: '>= 2.3'
   }
 end

data/bin/footty

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+## tip: to test run:
+##   ruby -I ./lib bin/footty
+
 require 'footty'
 
 Footty.main

data/lib/footty/client.rb

@@ -1,58 +1,66 @@
-# encoding: utf-8
-
 module Footty
 
+
   class Client
 
     include LogUtils::Logging
 
-    API_BASE = 'https://raw.githubusercontent.com/openfootball/world-cup.json/master/2018'
 
-    def initialize( opts={} )
-      @opts   = opts
+    def initialize( league:, year: )
       @worker = Fetcher::Worker.new
+
+      @league = league
+      @year   = year
     end
 
 
+    APIS = {
+      worldcup: 'https://github.com/openfootball/worldcup.json/raw/master/$year$/worldcup.json',
+      euro:     'https://github.com/openfootball/euro.json/raw/master/$year$/euro.json'
+    }
 
     ### note:
-    ##   cache ALL methods - only do one web request for worldcup match schedule & results
-    def get_worldcup
-      @worldcup ||= get( 'worldcup.json' )    ## use "memoized" / cached result
+    ##   cache ALL methods - only do one web request for match schedule & results
+    def get_matches
+      @data ||= begin
+                  str = APIS[ @league.downcase.to_sym ]
+                  str = str.gsub( '$year$', @year.to_s )
+
+                  get( str )    ## use "memoized" / cached result
+                end
     end
 
 
 
 
-
     ## for testing lets you use /round/1 etc.
-    def get_round( num )
-      h = get_worldcup
+    def round( num )
+      h = get_matches
       matches = h[ 'rounds' ][ num-1 ]    ## note: rounds hash starts with zero (not 1)
       matches
     end
 
 
-    def get_todays_matches( date: Date.today )      get_matches_for( date ); end
-    def get_tomorrows_matches( date: Date.today )   get_matches_for( date+1 );  end
-    def get_yesterdays_matches( date: Date.today )  get_matches_for( date-1 );  end
+    def todays_matches( date: Date.today )      matches_for( date ); end
+    def tomorrows_matches( date: Date.today )   matches_for( date+1 );  end
+    def yesterdays_matches( date: Date.today )  matches_for( date-1 );  end
 
-    def get_matches_for( date )
-      hash  = get_worldcup
+    def matches_for( date )
+      hash  = get_matches
       matches = select_matches( hash[ 'rounds' ] ) { |match| date == Date.parse( match['date'] ) }
       matches
     end
 
 
-    def get_upcoming_matches( date: Date.today )
+    def upcoming_matches( date: Date.today )
       ## note: includes todays matches for now
-      hash  = get_worldcup
+      hash  = get_matches
       matches = select_matches( hash[ 'rounds' ] ) { |match| date <= Date.parse( match['date'] ) }
       matches
     end
 
-    def get_past_matches( date: Date.today )
-      hash  = get_worldcup
+    def past_matches( date: Date.today )
+      hash  = get_matches
       matches = select_matches( hash[ 'rounds' ] ) { |match| date > Date.parse( match['date'] ) }
       ## note reveserve matches (chronological order/last first)
       matches.reverse
@@ -76,17 +84,14 @@ private
       matches
     end
 
-    def get( path )
-      ## uri = URI.parse( "#{API_BASE}/#{path}" )
-      # fix: use is_a? URI in fetcher
-      uri_string = "#{API_BASE}/#{path}"
 
-      response = @worker.get_response( uri_string )
+    def get( str )
+      response = @worker.get_response( str )
 
       if response.code == '200'
         ##
-        ## todo/check:
-        ##  do we need to force utf-8 encoding?
+        ## fix/fix/todo/check:
+        ##  do we need to force utf-8 encoding? yes!!!!
         ##   check for teams w/ non-ascii names
         hash = JSON.parse( response.body )
         ## pp hash
@@ -98,6 +103,4 @@ private
     end
 
   end # class Client
-
-
 end # module Footty

data/lib/footty/version.rb

@@ -1,14 +1,14 @@
-# encoding: utf-8
-
 
 module Footty
-   VERSION = '0.4.0'
+   VERSION = '2024.5.10'
 
    def self.banner
-     "footty/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+     "footty/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in (#{root})"
    end
 
    def self.root
-     "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+     File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
    end
 end
+
+

data/lib/footty.rb

@@ -1,6 +1,3 @@
-# encoding: utf-8
-
-
 ## stdlibs
 
 require 'net/http'
@@ -15,8 +12,8 @@ require 'pp'
 require 'logutils'
 require 'fetcher'
 
-# our own code
 
+# our own code
 require 'footty/version' # let it always go first
 require 'footty/client'
 
@@ -24,7 +21,8 @@ require 'footty/client'
 module Footty
 
   def self.client
-    @@client ||= Client.new    ## use "singelton" / shared client
+    ## note: hard code tournament / league for now
+    @client ||= Client.new( league: 'euro', year: 2024 )    ## use "singelton" / shared client
   end
 
 
@@ -38,43 +36,47 @@ module Footty
     ## in the future make today "configurable" as param - why? why not?
     today = Date.today
 
-    if ['yesterday', 'y', '-1'].include? what
-      matches = client.get_yesterdays_matches
+    if ['yesterday', 'y', '-1'].include?( what )
+      matches = client.yesterdays_matches
       if matches.empty?
          puts "** No matches played yesterday.\n"
       end
-    elsif ['tomorrow', 't', '+1', '1'].include? what
-      matches = client.get_tomorrows_matches
+    elsif ['tomorrow', 't', '+1', '1'].include?( what )
+      matches = client.tomorrows_matches
       if matches.empty?
          puts "** No matches scheduled tomorrow.\n"
       end
-    elsif ['past', 'p', 'prev'].include? what
-      matches = client.get_past_matches
+    elsif ['past', 'p', 'prev'].include?( what )
+      matches = client.past_matches
       if matches.empty?
          puts "** No matches played yet.\n"
       end
-    elsif ['upcoming', 'up', 'u', 'next', 'n'].include? what
-      matches = client.get_upcoming_matches
+    elsif ['upcoming', 'up', 'u', 'next', 'n'].include?( what )
+      matches = client.upcoming_matches
       if matches.empty?
          puts "** No more matches scheduled.\n"
       end
     else
-       matches = client.get_todays_matches
+       matches = client.todays_matches
 
        ## no matches today
        if matches.empty?
           puts "** No matches scheduled today.\n"
 
-          if Date.today > Date.new( 2018, 7, 11 )   ## world cup is over, look back
+          ## note: was world cup 2018 - end date -- Date.new( 2018, 7, 11 )
+          ## note: was euro 2020 (in 2021) - end date -- Date.new( 2021, 7, 11 )
+          if Date.today > Date.new( 2024, 7, 14 )     ## tournament is over, look back
             puts "Past matches:"
-            matches = client.get_past_matches
+            matches = client.past_matches
           else  ## world cup is upcoming /in-progress,look forward
             puts "Upcoming matches:"
-            matches = client.get_upcoming_matches
+            matches = client.upcoming_matches
           end
        end
     end
 
+
+
     print_matches( matches )
   end
 
@@ -95,25 +97,32 @@ module Footty
          print "%10s" % "(in #{diff}d) "
       end
 
-      print "%20s" % "#{match['team1']['name']} (#{match['team1']['code']})"
+      print "%22s" % "#{match['team1']['name']} (#{match['team1']['code']})"
 
+      ## todo/fix: add support for knockout scores
+      ##                 with score1et/score1p  (extra time and penalty)
       if match['score1'] && match['score2']
         print " #{match['score1']}-#{match['score2']} "
+        print "(#{match['score1i']}-#{match['score2i']}) "
       else
-        print " vs "
+        print "    vs    "
       end
 
-      print "%20s" % "#{match['team2']['name']} (#{match['team2']['code']})"
+      print "%-22s" % "#{match['team2']['name']} (#{match['team2']['code']})"
 
       if match['group']
-        print " #{match['group']} "    ## group phase/stage
-      else
-        print " #{match['round']} "    ## knock out (k.o.) phase/stage
+        print " #{match['group']} /"    ## group phase/stage
+      end
+
+      print " #{match['round']} "    ## knock out (k.o.) phase/stage
+
+      if match['stadium']
+        print " @ #{match['stadium']['name']}, #{match['city']}"
       end
 
-      print " @ #{match['stadium']['name']}, #{match['city']}"
       print "\n"
 
+
       if match['goals1'] && match['goals2']
         print "                     ["
         match['goals1'].each_with_index do |goal,i|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: footty
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 2024.5.10
 platform: ruby
 authors:
 - Gerald Bauer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-14 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -42,42 +42,48 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
-description: footty - football.db command line client for world cup (russia 2018)
-  and more - who is playing today?
+        version: '4.1'
+description: footty - football.db command line client for european "euro" championship
+  2024 and more - who is playing today?
 email: opensport@googlegroups.com
 executables:
 - footty
 extensions: []
 extra_rdoc_files:
-- HISTORY.md
+- CHANGELOG.md
 - Manifest.txt
 - README.md
 files:
-- HISTORY.md
+- CHANGELOG.md
 - Manifest.txt
 - README.md
 - Rakefile
@@ -85,13 +91,11 @@ files:
 - lib/footty.rb
 - lib/footty/client.rb
 - lib/footty/version.rb
-- test/helper.rb
-- test/test_client.rb
 homepage: https://github.com/sportdb/footty
 licenses:
 - Public Domain
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -108,10 +112,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
-summary: footty - football.db command line client for world cup (russia 2018) and
-  more - who is playing today?
+summary: footty - football.db command line client for european "euro" championship
+  2024 and more - who is playing today?
 test_files: []

data/test/helper.rb

@@ -1,10 +0,0 @@
-## $:.unshift(File.dirname(__FILE__))
-
-## minitest setup
-
-require 'minitest/autorun'
-
-
-## our own code
-
-require 'footty'

data/test/test_client.rb

@@ -1,163 +0,0 @@
-# encoding: utf-8
-
-
-require 'helper'
-
-
-
-class TestClient < MiniTest::Test
-
-  def setup
-    @client = Footty.client
-  end
-
-
-  def test_getters
-    today = Date.new( 2018, 6, 16 )
-
-    todays     = @client.get_todays_matches( date: today )
-    pp todays
-    assert_equal 4,     todays.size
-
-    yesterdays = @client.get_yesterdays_matches( date: today )
-    pp yesterdays
-    assert_equal 3,     yesterdays.size
-
-    tomorrows  = @client.get_tomorrows_matches( date: today )
-    pp tomorrows
-    assert_equal 3,     tomorrows.size
-
-    past     = @client.get_past_matches( date: today )
-    pp past
-
-    upcoming = @client.get_upcoming_matches( date: today )
-    pp upcoming
-  end
-
-
-
-  def test_todays_matches_2018_6_14
-     today = Date.new( 2018, 6, 14 )
-     ary = @client.get_todays_matches( date: today )
-     ## pp ary
-=begin
-[{"num"=>1,
-  "date"=>"2018-06-14",
-  "time"=>"18:00",
-  "team1"=>{"name"=>"Russia", "code"=>"RUS"},
-  "team2"=>{"name"=>"Saudi Arabia", "code"=>"KSA"},
-  "score1"=>nil,
-  "score2"=>nil,
-  "score1i"=>nil,
-  "score2i"=>nil,
-  "group"=>"Group A",
-  "stadium"=>{"key"=>"luzhniki", "name"=>"Luzhniki Stadium"},
-  "city"=>"Moscow",
-  "timezone"=>"UTC+3",
-  "round"=>"Matchday 1"}]
-=end
-
-     assert_equal Array, ary.class     ## for now just check return type (e.g. assume Array for parsed JSON data)
-     assert_equal 1,     ary.size
-     assert_equal 'RUS',        ary[0]['team1']['code']
-     assert_equal 'KSA',        ary[0]['team2']['code']
-     assert_equal 'Matchday 1', ary[0]['round']
-     assert_nil                 ary[0]['score1']
-     assert_nil                 ary[0]['score2']
-  end
-
-  def test_todays_matches_2018_6_10
-     today = Date.new( 2018, 6, 10 )
-     ary = @client.get_todays_matches( date: today )
-     ## note: returns empty array if no matches scheduled/playing today
-     pp ary
-
-     assert_equal Array, ary.class     ## for now just check return type (e.g. assume Array for parsed JSON data)
-     assert              ary.empty?
-  end
-
-  def test_world_2018_round_1
-    h = @client.get_round( 1 )
-
-    ## pp h
-=begin
-{"name"=>"Matchday 1",
- "matches"=>
-  [{"num"=>1,
-    "date"=>"2018-06-14",
-    "time"=>"18:00",
-    "team1"=>{"name"=>"Russia", "code"=>"RUS"},
-    "team2"=>{"name"=>"Saudi Arabia", "code"=>"KSA"},
-    "score1"=>nil,
-    "score2"=>nil,
-    "score1i"=>nil,
-    "score2i"=>nil,
-    "group"=>"Group A",
-    "stadium"=>{"key"=>"luzhniki", "name"=>"Luzhniki Stadium"},
-    "city"=>"Moscow",
-    "timezone"=>"UTC+3"}]}
-=end
-
-    assert_equal 'RUS', h['matches'][0]['team1']['code']
-    assert_equal 'KSA', h['matches'][0]['team2']['code']
-    assert_nil          h['matches'][0]['score1']
-    assert_nil          h['matches'][0]['score2']
-  end
-
-
-  def test_world_2018_round_2
-    h = @client.get_round( 2 )
-
-    ## pp h
-=begin
-{"name"=>"Matchday 2",
- "matches"=>
-  [{"num"=>2,
-    "date"=>"2018-06-15",
-    "time"=>"17:00",
-    "team1"=>{"name"=>"Egypt", "code"=>"EGY"},
-    "team2"=>{"name"=>"Uruguay", "code"=>"URU"},
-    "score1"=>nil,
-    "score2"=>nil,
-    "score1i"=>nil,
-    "score2i"=>nil,
-    "group"=>"Group A",
-    "stadium"=>{"key"=>"ekaterinburg", "name"=>"Ekaterinburg Arena"},
-    "city"=>"Ekaterinburg",
-    "timezone"=>"UTC+5"},
-   {"num"=>3,
-    "date"=>"2018-06-15",
-    "time"=>"21:00",
-    "team1"=>{"name"=>"Portugal", "code"=>"POR"},
-    "team2"=>{"name"=>"Spain", "code"=>"ESP"},
-    "score1"=>nil,
-    "score2"=>nil,
-    "score1i"=>nil,
-    "score2i"=>nil,
-    "group"=>"Group B",
-    "stadium"=>{"key"=>"fisht", "name"=>"Fisht Stadium"},
-    "city"=>"Sochi",
-    "timezone"=>"UTC+3"},
-   {"num"=>4,
-    "date"=>"2018-06-15",
-    "time"=>"18:00",
-    "team1"=>{"name"=>"Morocco", "code"=>"MAR"},
-    "team2"=>{"name"=>"Iran", "code"=>"IRN"},
-    "score1"=>nil,
-    "score2"=>nil,
-    "score1i"=>nil,
-    "score2i"=>nil,
-    "group"=>"Group B",
-    "stadium"=>{"key"=>"saintpetersburg", "name"=>"Saint Petersburg Stadium"},
-    "city"=>"Saint Petersburg",
-    "timezone"=>"UTC+3"}]}
-=end
-
-    assert_equal 'EGY', h['matches'][0]['team1']['code']
-    assert_equal 'URU', h['matches'][0]['team2']['code']
-    assert_nil          h['matches'][0]['score1']
-    assert_nil          h['matches'][0]['score2']
-  end
-
-
-end # class TestClient