openliga 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c536f8e8f075a90cdaebbc6c0a5b06de9b58dcc026b1a50240a709807ede9d9
-  data.tar.gz: e0acb89fa7e33e21ca65f1191d8fa1c567cfd05a3220c85d1be8363455c9ca44
+  metadata.gz: 8123f6f8860fd4bfec1960d65f175292be9d45df3c462b030afc42798e0c6060
+  data.tar.gz: ca3f26f2ca73dce8361e716d772baa9125ee829802a1a38cf0262e624fea18be
 SHA512:
-  metadata.gz: 33f66d0098831db3fbc807c7dbc165cc8052e2fbaa2c7795572740add7b012e95cca1347979a7f5f8769bcf24696df095a6a340419a48b93cc08ea636ec5460f
-  data.tar.gz: 39f97ffa909180c2bf93f4085ada7fc49a8f88e6da3ea967c8495ceabd1561e6fa847836bb043f90531e1f5b92be62a7aa03b995d30bb6fb6352fe9c6a567636
+  metadata.gz: db61a16c8abbbdad2914fd47c2900035c5e9898fae029beed4ee8d83969589d88cf9f432b856cf0f59951d567d01950a80461630b9463860d381419a9b7fce11
+  data.tar.gz: 75041d2444b4c7ce31999057109c11e9478e251dfdb1d82b6f0f06fd5e88ba88812d00654581b6983e2c8aaa768fe1dad516fff83b7709ba037df6e79e651db5

data/CHANGELOG.md

@@ -1,4 +1,5 @@
 
+### 1.0.0
 ### 0.0.1 / 2026-08-28
 
 * Everything is new. First release.

data/README.md

@@ -1,4 +1,4 @@
-# openliga - openligadb.de api client/wrapper and football.txt format converter
+# openliga -  openligadb.de api client/wrapper and football.txt format converter
 
 
 * home  :: [github.com/sportdb/sport.db](https://github.com/sportdb/sport.db)
@@ -64,10 +64,46 @@ To be continued...
 
 
 
+### Bonus - `openliga` Command-Line Tool
 
+Use the `openliga` command-line tool to
+(i) download openligadb.de match data (in JSON) and
+(ii) convert to the Football.TXT format. Try:
+
+```
+$ openliga -h
+```
+
+resulting in:
+
+```
+Usage: openliga [options] CODE
+    -m, --metal           use openligadb.de shortcuts/codes and seasons/years (default: false)
+    -o, --output=PATH     write football.txt conversion to output path (default: none)
+        --season=SEASON   season (default: none)
+```
+
+examples with "common football.txt codes"
+e.g. `de.1`, `de.2`, `de.3`, `de.cup`:
+
+```
+$ openliga de.1
+$ openliga de.cup
+
+$ openliga de.1  --output=2026-27_de.1.txt
+$ openliga de.1  --season=2020/21 --output=2020-21_de.1.txt
+$ openliga de.cup --season=2025/26 --output=2025-26_de.cup.txt
+```
+
+or use the original openligadb.de code/shortcut (and season/year)
+with the `-m/--metal` flag:
+
+```
+$ openliga bl1 --metal
+$ openliga bl1 --metal --season=2020
+```
 
 
-### About the Football (Match) Data
 
 Conversion to Football.TXT Conversion Samples
 
@@ -148,6 +184,9 @@ Sat May 23
 
 
 
+
+### About the OpenLigaDB.de (Football) Match Data
+
 **What's missing (upstream)?**
 
 the only match status is  `finished: true|false`, that is,
@@ -169,12 +208,22 @@ starting with the after-extra time scor  e.g.
 ```
 SG Sonnenhof Großaspach  v  DSC Arminia Bielefeld      2-2 aet (2-2, 1-2), 5-2 pen
             (...
-             3-2 Arbnor Nuraj (p)
-             4-2 Luca Molinari (p)
-             5-2 Franz Xaver Bleicher (p))
+             3-2  Arbnor Nuraj (p)
+             4-2  Luca Molinari (p)
+             5-2  Franz Xaver Bleicher (p))
+
+-or-
+
+England  v Spanien                    1-1 aet, 1-1 pen
+            (0-1  M. Caldentey 25'
+             1-1  Alessia RUSSO 57'
+             1-2  P. Guijarro (p)
+             2-2  A. Greenwood (p)
+             3-2  N. Charles (p)
+             4-2  C. Kelly (p))
 ```
 
-and there's no way to record missed/saved penalties (??).
+and there's no way to record missed/saved penalties.
 
 
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'hoe'
 
 Hoe.spec 'openliga' do
 
-  self.version = '0.0.1'
+  self.version = '1.0.0'
 
   self.summary = "openliga - openligadb.de api client/wrapper and football.txt format converter"
   self.description = summary

data/config/leagues_more.csv

@@ -1,4 +1,7 @@
 
+###
+#  see https://www.openligadb.de/Leagues?season=2026 for more
+
 
 code, season,  league_name, league_season, league_shortcut
 
@@ -13,7 +16,7 @@ code, season,  league_name, league_season, league_shortcut
 ##      UEFA CL 2021/22,  2021,  uefacl
 #       UEFA Europa League 2021,  el21
 
-
+uefa.cl, 2026/27, Champions League 2026/2027, 2026, ucl
 uefa.cl, 2025/26, Champions League 2025/2026, 2025, ucl
 uefa.cl, 2024/25, UEFA Champions League, 2024, ucl24
 uefa.cl, 2023/24, UEFA Champions League 2023/2024, 2023, champion1
@@ -37,7 +40,7 @@ uefa.cl, 2022/23, UEFA Champions League 22/23, 2022, uefacl22
 world, 2026,    WM 2026, 2026, wm26
 world, 2022,    WM-KATAR, 2022, WM2022
 
-euro,  2024,     UEFA EURO 2024, 2024, em
+euro,  2024,    UEFA EURO 2024, 2024, em
 euro,  2021,    UEFA EURO 2020, 2020, em20
 
 copa,  2024,     Copa América 2024, 2024, CA2024

data/lib/openliga/download.rb

@@ -33,12 +33,27 @@ class Metal
     get( "#{BASE_URL}/getavailableleagues" )
   end
 
+
+###
+#  note - MUST escape URL path  e.g.  /getmatchdata/BLÖ/2026
+#                                =>   /getmatchdata/BL%C3%96/2026
+#
+#  Extra Tip:
+#  use CGI.escape !!
+#    Avoid URI.encode_www_form_component here
+#    While URI.encode_www_form_component is also built into Ruby,
+#    it turns spaces into plus signs (+) instead of %20.
+#    For URL paths (the parts between the slashes /),
+#     CGI.escape is usually the safer choice because it strictly
+#      uses percent-encoding (%).
+
+
   ## api call - /getavailableteams/{code}/{year}
   def self.teams( code, year )
     get( teams_url( code, year ) )
   end
   def self.teams_url( code, year )
-    "#{BASE_URL}/getavailableteams/#{code}/#{year}"
+    "#{BASE_URL}/getavailableteams/#{CGI.escape(code)}/#{year}"
   end
 
   ## api call - /getmatchdata/{code}/{year}
@@ -46,12 +61,12 @@ class Metal
     get( matches_url( code, year ) )
   end
   def self.matches_url( code, year )
-    "#{BASE_URL}/getmatchdata/#{code}/#{year}"
+    "#{BASE_URL}/getmatchdata/#{CGI.escape(code)}/#{year}"
   end
 
   ## api call - /getgoalgetters/{code}/{year}
   def self.goalgetters( code, year )
-    get( "#{BASE_URL}/getgoalgetters/#{code}/#{year}" )
+    get( "#{BASE_URL}/getgoalgetters/#{CGI.escape(code)}/#{year}" )
   end
 
 

data/lib/openliga/tool.rb

@@ -19,14 +19,14 @@ opts = {
 
 
 parser = OptionParser.new do |parser|
-parser.banner = "Usage: #{$PROGRAM_NAME} [options] NAME"
+parser.banner = "Usage: #{$PROGRAM_NAME} [options] CODE"
 
-   parser.on( "--metal",
+   parser.on( "--metal",  "-m",
                "use openligadb.de shortcuts/codes and seasons/years (default: #{opts[:metal]})" ) do |metal|
      opts[:metal] = true
    end
 
-   parser.on( "-o PATH", "--output",
+   parser.on( "--output=PATH", "-o",
                "write football.txt conversion to output path (default: #{opts[:outpath]||'none'})" ) do |outpath|
      opts[:outpath] = outpath
    end
@@ -104,7 +104,12 @@ end
    data = Metal.matches( code, year )
 
    puts "   #{data.size} match(es)"
-   pp data[0]    ## dump first match
+
+   if data.empty?
+     ## do nothing; skip convert (& write)
+   else
+
+    pp data[0]    ## dump first match
 
 ##################
 ### step 2 - convert to football.txt
@@ -115,20 +120,22 @@ end
 ###
 ###  auto-add header
 ###    note - use leagueName from first match
+   title = data[0]['leagueName']
+
   header =<<TXT
 ###
 #  converted from openligadb.de json to Football.TXT
 #    for source, see https://api.openligadb.de/getmatchdata/#{code}/#{year}
 
-= #{data[0]['leagueName']}
+= #{title}
 TXT
 
+     puts header+body
 
-   puts header+body
-
-   if opts[:outpath]
-       puts "  writing football.txt to >#{opts[:outpath]}<"
-       write_text( opts[:outpath], header+body )
+     if opts[:outpath]
+         puts "  writing football.txt to >#{opts[:outpath]}<"
+         write_text( opts[:outpath], header+body )
+     end
    end
 
    puts "bye"

data/lib/openliga.rb

@@ -2,6 +2,8 @@
 require 'season/formats'   ## add season support
 require 'webget'           ## incl. webget, webcache, webclient, etc.
 
+require 'cgi'  ## todo - check if already required upstream!!!
+               ##   pulled-in for CGI.escpape  (URI path) e.g. /getmatchdata/BLÖ/2026
 
 
 ###

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openliga
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-28 00:00:00.000000000 Z
+date: 2026-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocos