mlb_stats_api 0.2.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f1785568e2c7c97a04981d1f64b33aed72ea46788219c9c1adf6240532bfe7b
-  data.tar.gz: 5357dde99f31c0cf5decad6147a8bac2cb5ff3e48570bfdc0b8a2d550bea3077
+  metadata.gz: 9e9bba45d360b519bccd1b22745067ffda8245672a11ec43a1320e11da22fb71
+  data.tar.gz: a4dabc6bccc1a4ed6751c7e6e29a0444814196abfc7208cf61e0109e9d542f61
 SHA512:
-  metadata.gz: 3435b50ac963edf95ea2958d305efb266c7ca42352e2bd1443af6c7eda12ade4ed328fcab39b7f50f943613cfe2f51f1fb5fd0a3237eca9f126cf8dcd152bd94
-  data.tar.gz: 5694e37addf8422ee99a180868b5bb66a1279056dd7fd078a6ffbc798d79ffe80c1585b9b34a3fa5639e68c06a8e564975ee0ba42db133dde5c548ca3e5c6a76
+  metadata.gz: 95614ebb018b8fa5c747cf68c250775a0daa87047505e36b8acb1f0f9347c942f71c33901edd2cd960e9c63845d24b77e8afc8378e849d8f4167f69b43ea6d5a
+  data.tar.gz: 8481c2e4fc37c84db1a25f7708e14be896a66c1f6507165e9869d52d89d9cf2528590c46c89ba9f089963503559de6f28bf2449ad3b94627be35255244ec30fe

data/.github/workflows/rspec.yml

@@ -0,0 +1,30 @@
+name: RSpec
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu]
+        ruby: [3.1]
+
+    runs-on: ${{ matrix.os }}-latest
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically:
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -1,9 +1,74 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  EnabledByDefault: true
+  NewCops: enable
+  SuggestExtensions: false
+
+# ----------------------------------------------------------------------------------------------------------------------
+# Coding Style
+# ----------------------------------------------------------------------------------------------------------------------
 
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
+# ----------------------------------------------------------------------------------------------------------------------
+# Cops that should not be run
+# ----------------------------------------------------------------------------------------------------------------------
+
+# Recommends each array item be on its own line.
+Layout/MultilineArrayLineBreaks:
+  Enabled: false
+
+# Recommends right hand side of multi-line assignment be on a new line
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+
+# Wants every argument in a multi-line method call to be on its own line
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: false
+
+# Recommends squishing a multi-line hash into one line. I don't like that. It's not readable.
+Layout/RedundantLineBreak:
+  Enabled: false
+
+# Recommends `::File` instead of `File`
+Lint/ConstantResolution:
+  Enabled: false
+
+# Converts if-elsif to case-when.
+Style/CaseLikeIf:
+  Enabled: false
+
+# Wants every constant to be listed in #public_constant or #private_constant
+Style/ConstantVisibility:
+  Enabled: false
+
+Style/Copyright:
+  Enabled: false
+
+# Every class and module *should* be documented, but I don't have the time
+Style/Documentation:
+  Enabled: false
+
+# Every method *should* be documented, but I don't have the time
+Style/DocumentationMethod:
+  Enabled: false
+
+# Converts [1, 2, three: 3] to [1, 2, { three: 3 }]
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+# Converts `a_method 1` to `a_method(1)`
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+# Not every `if` needs an `else`
+Style/MissingElse:
+  Enabled: false
+
+# HTTP headers need to use string keys
+Style/StringHashKeys:
+  Enabled: false
+
+# I consider myself capable of understanding logical operators in an unless
+Style/UnlessLogicalOperators:
+  Enabled: false

data/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+    "[ruby]": {
+        "editor.tabSize": 2,
+        "editor.rulers": [120]
+    },
+    "[yaml]": {
+        "editor.tabSize": 2,
+        "editor.rulers": [120]
+    },
+    "files.trimTrailingWhitespace": true,
+    "files.insertFinalNewline": true
+}

data/Gemfile

@@ -2,7 +2,7 @@
 
 source 'https://rubygems.org'
 
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { "https://github.com/#{_1}" }
 
 # Specify your gem's dependencies in mlb_stats_api.gemspec
 gemspec

data/Gemfile.lock

@@ -1,47 +1,68 @@
 PATH
   remote: .
   specs:
-    mlb_stats_api (0.2.5)
+    mlb_stats_api (0.4.0)
       hana (~> 1.3)
-      httparty (~> 0.16)
-      moneta (~> 1.0)
+      httparty (~> 0.20)
+      moneta (~> 1.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    hana (1.3.5)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hana (1.3.7)
     hashdiff (1.0.1)
-    httparty (0.18.0)
+    httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
+    json (2.6.2)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    moneta (1.2.1)
+    mime-types-data (3.2022.0105)
+    moneta (1.5.1)
     multi_xml (0.6.0)
-    public_suffix (4.0.3)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    safe_yaml (1.0.5)
-    webmock (3.8.3)
-      addressable (>= 2.3.6)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.37.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.22.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
@@ -49,11 +70,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (> 1.16)
+  bundler (> 2.3)
   mlb_stats_api!
-  rake (> 10.0)
-  rspec (~> 3.8)
-  webmock (~> 3.4)
+  rake (> 13.0)
+  rspec (~> 3.11)
+  rubocop (~> 1.37)
+  webmock (~> 3.18)
 
 BUNDLED WITH
-   1.17.2
+   2.3.22

data/bin/console

@@ -4,8 +4,8 @@
 require 'bundler/setup'
 require 'mlb_stats_api'
 
-# 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.
+# 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.
 
 @client = MLBStatsAPI::Client.new
 

data/lib/mlb_stats_api/base.rb

@@ -8,12 +8,8 @@ module MLBStatsAPI
       @data = data
     end
 
-    def [](key)
-      @data[key]
-    end
+    def [](key) = @data[key]
 
-    def dig(*path)
-      @data.dig(*path)
-    end
+    def dig(*path) = @data.dig(*path)
   end
 end

data/lib/mlb_stats_api/client.rb

@@ -46,7 +46,7 @@ module MLBStatsAPI
       @logger = logger.is_a?(::Logger) ? logger : ::Logger.new(logger)
     end
 
-    def get(endpoint, query = {})
+    def get(endpoint, **query)
       url = "/api/v#{query.delete(:version) || DEFAULT_VERSION}#{endpoint}"
 
       args = normalize_query_args(query)
@@ -60,14 +60,9 @@ module MLBStatsAPI
       response.parsed_response
     end
 
-    def normalize_query_args(query)
-      query
-        .reject { |_, v| v.nil? }
-        .map { |key, val| [key, val.is_a?(Array) ? val.join(',') : val] }
-        .to_h
-    end
+    def normalize_query_args(query) = query.compact.transform_values { _1.is_a?(Array) ? _1.join(',') : _1 }
 
-    def load(key, options = {})
+    def load(key, **options)
       value = @cache.load(key)
 
       return value if value

data/lib/mlb_stats_api/color_feed.rb

@@ -5,8 +5,9 @@ module MLBStatsAPI
     attr_reader :game_pk
 
     def initialize(api, game_pk, data)
+      super(data)
+
       @api = api
-      @data = data
       @game_pk = game_pk
     end
 

data/lib/mlb_stats_api/conferences.rb

@@ -2,18 +2,11 @@
 
 module MLBStatsAPI
   # Only the Pacific Coast League uses conferences
-  # @see https://statsapi.mlb.com/docs/#tag/conference
   module Conferences
     # View all PCL conferences.
-    # @see https://statsapi.mlb.com/docs/#operation/conferences
-    def conferences(options = {})
-      get '/conferences', options
-    end
+    def conferences(**options) = get('/conferences', **options)
 
-    # View PCL conferences by conferenceId.
-    # @see https://statsapi.mlb.com/docs/#operation/conferences
-    def conference(conference_id, options = {})
-      get "/conferences/#{conference_id}", options
-    end
+    # View PCL conferences by conference ID.
+    def conference(conference_id, **options) = get("/conferences/#{conference_id}", **options)
   end
 end

data/lib/mlb_stats_api/config.rb

@@ -2,76 +2,33 @@
 
 module MLBStatsAPI
   # These methods all return lists of possible values
-  # @see https://statsapi.mlb.com/docs/#tag/config
   module Config
-    # @see https://statsapi.mlb.com/docs/#operation/gameStatus
-    def game_status
-      get '/gameStatus'
-    end
+    def game_status = get('/gameStatus')
 
-    # @see https://statsapi.mlb.com/docs/#operation/baseballStats
-    def baseball_stats
-      get '/baseballStats'
-    end
+    def baseball_stats = get('/baseballStats')
 
-    # @see https://statsapi.mlb.com/docs/#operation/gameTypes
-    def game_types
-      get '/gameTypes'
-    end
+    def game_types = get('/gameTypes')
 
-    # @see https://statsapi.mlb.com/docs/#operation/languages
-    def languages
-      get '/languages'
-    end
+    def languages = get('/languages')
 
-    # @see https://statsapi.mlb.com/docs/#operation/leagueLeaderTypes
-    def league_leader_types
-      get '/leagueLeaderTypes'
-    end
+    def league_leader_types = get('/leagueLeaderTypes')
 
-    # @see https://statsapi.mlb.com/docs/#operation/metrics
-    def metrics
-      get '/metrics'
-    end
+    def metrics = get('/metrics')
 
-    # @see https://statsapi.mlb.com/docs/#operation/platforms
-    def platforms
-      get '/platforms'
-    end
+    def platforms = get('/platforms')
 
-    # @see https://statsapi.mlb.com/docs/#operation/positions
-    def positions
-      get '/positions'
-    end
+    def positions = get('/positions')
 
-    # @see https://statsapi.mlb.com/docs/#operation/rosterTypes
-    def roster_types
-      get '/rosterTypes'
-    end
+    def roster_types = get('/rosterTypes')
 
-    # @see https://statsapi.mlb.com/docs/#operation/scheduleEventTypes
-    def schedule_event_types
-      get '/scheduleEventTypes'
-    end
+    def schedule_event_types = get('/scheduleEventTypes')
 
-    # @see https://statsapi.mlb.com/docs/#operation/sitCodes
-    def situation_codes
-      get '/situationCodes'
-    end
+    def situation_codes = get('/situationCodes')
 
-    # @see https://statsapi.mlb.com/docs/#operation/standingsTypes
-    def standings_types
-      get '/standingsTypes'
-    end
+    def standings_types = get('/standingsTypes')
 
-    # @see https://statsapi.mlb.com/docs/#operation/statGroups
-    def stat_groups
-      get '/statGroups'
-    end
+    def stat_groups = get('/statGroups')
 
-    # @see https://statsapi.mlb.com/docs/#operation/statTypes
-    def stat_types
-      get '/statTypes'
-    end
+    def stat_types = get('/statTypes')
   end
 end

data/lib/mlb_stats_api/divisions.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module MLBStatsAPI
-  # @see https://statsapi.mlb.com/docs/#tag/division
   module Divisions
     # There are actually far more divisions from other leagues in the API.
     # I don't think I'll add them until necessary.
@@ -15,9 +14,6 @@ module MLBStatsAPI
     }.freeze
 
     # View league division directorial information.
-    # @see https://statsapi.mlb.com/docs/#operation/divisions
-    def divisions(options = {})
-      get '/divisions', options
-    end
+    def divisions(**options) = get('/divisions', **options)
   end
 end

data/lib/mlb_stats_api/drafts.rb

@@ -2,25 +2,14 @@
 
 module MLBStatsAPI
   # Operations pertaining to MLB Rule 4 Draft (First-Year Player Draft)
-  # @see https://statsapi.mlb.com/docs/#tag/draft
   module Drafts
     # View drafted players by year.
-    # @see https://statsapi.mlb.com/docs/#operation/draft
-    def draft(year, options = {})
-      get "/draft/#{year}", options
-    end
+    def draft(year, **options) = get("/draft/#{year}", **options)
 
     # View draft eligible prospects by year.
-    # @see https://statsapi.mlb.com/docs/#operation/draftProspects
-    def draft_prospects(year, options = {})
-      get "/draft/#{year}/prospects", options
-    end
+    def draft_prospects(year, **options) = get("/draft/#{year}/prospects", **options)
 
-    # View latest player drafted, endpoint best used when draft is currently
-    # open.
-    # @see https://statsapi.mlb.com/docs/#operation/latestDraftPicks
-    def draft_latest(year, options = {})
-      get "/draft/#{year}/latest", options
-    end
+    # View latest player drafted, endpoint best used when draft is currently open.
+    def draft_latest(year, **options) = get("/draft/#{year}/latest", **options)
   end
 end

data/lib/mlb_stats_api/errors.rb

@@ -3,25 +3,25 @@
 module MLBStatsAPI
   class Error < ::RuntimeError
     def initialize(response)
+      super()
+
       @response = response
     end
 
     def to_s
+      # @response.response
       format(
         '%<code>s: %<message>s (%<uri>s)',
         code: @response.code,
-        message: '', # @response.response,
+        message: '',
         uri: @response.request.last_uri.to_s
       )
     end
   end
 
-  class ForbiddenError < Error
-  end
+  class ForbiddenError < Error; end
 
-  class NotFoundError < Error
-  end
+  class NotFoundError < Error; end
 
-  class UnauthorizedError < Error
-  end
+  class UnauthorizedError < Error; end
 end

data/lib/mlb_stats_api/games.rb

@@ -2,42 +2,26 @@
 
 module MLBStatsAPI
   module Games
-    PREGAME_STATUSES = /
-      Preview|Warmup|Pre-Game|Delayed Start|Scheduled
-    /x.freeze
+    PREGAME_STATUSES = /Preview|Warmup|Pre-Game|Delayed Start|Scheduled/
+    POSTGAME_STATUSES = /Final|Game Over|Postponed|Completed Early/
 
-    POSTGAME_STATUSES = /Final|Game Over|Postponed|Completed Early/.freeze
+    def self.pregame_status?(status) = PREGAME_STATUSES.match?(status)
 
-    def self.pregame_status?(status)
-      PREGAME_STATUSES.match?(status)
-    end
+    def self.postgame_status?(status) = POSTGAME_STATUSES.match?(status)
 
-    def self.postgame_status?(status)
-      POSTGAME_STATUSES.match?(status)
-    end
+    def boxscore(game_pk) = get("/game/#{game_pk}/boxscore")
 
-    def boxscore(game_id)
-      get "/game/#{game_id}/boxscore"
-    end
-
-    def content(game_id, limit: nil)
-      get "/game/#{game_id}/content", highlightLimit: limit
-    end
+    def content(game_pk, limit: nil) = get("/game/#{game_pk}/content", highlightLimit: limit)
 
-    def context_metrics(game_id, timecode: nil)
-      get "/game/#{game_id}/contextMetrics", timecode: timecode
-    end
+    def context_metrics(game_pk, timecode: nil) = get("/game/#{game_pk}/contextMetrics", timecode:)
 
-    # This endpoint can return very large payloads. It is STRONGLY recommended
-    # that clients ask for diffs and use "Accept-Encoding: gzip" header.
-    def live_feed(game_id, timecode: nil)
-      MLBStatsAPI::LiveFeed.new(
-        self,
-        get("/game/#{game_id}/feed/live", version: '1.1', timecode: timecode)
-      )
+    # This endpoint can return very large payloads. It is STRONGLY recommended that clients ask for diffs and use
+    # "Accept-Encoding: gzip" header.
+    def live_feed(game_pk, timecode: nil)
+      MLBStatsAPI::LiveFeed.new self, get("/game/#{game_pk}/feed/live", version: '1.1', timecode:)
     end
 
-    def live_feed_diff(game_id, timecode: nil, snapshot_at: nil)
+    def live_feed_diff(game_pk, timecode: nil, snapshot_at: nil)
       query = { version: '1.1' }
 
       if timecode
@@ -48,22 +32,16 @@ module MLBStatsAPI
         raise ArgumentError, 'Please pass either a timecode or a snapshot.'
       end
 
-      get "/game/#{game_id}/feed/live/diffPatch", query
+      get "/game/#{game_pk}/feed/live/diffPatch", query
     end
 
-    def live_feed_timestamps(game_id)
-      get "/game/#{game_id}/feed/live/timestamps", version: '1.1'
-    end
+    def live_feed_timestamps(game_pk) = get("/game/#{game_pk}/feed/live/timestamps", version: '1.1')
 
-    def color_feed(game_id, timecode: nil)
-      MLBStatsAPI::ColorFeed.new(
-        self,
-        game_id,
-        get("/game/#{game_id}/feed/color", timecode: timecode)
-      )
+    def color_feed(game_pk, timecode: nil)
+      MLBStatsAPI::ColorFeed.new self, game_pk, get("/game/#{game_pk}/feed/color", timecode:)
     end
 
-    # def color_feed_diff(game_id, timecode: nil, snapshot_at: nil)
+    # def color_feed_diff(game_pk, timecode: nil, snapshot_at: nil)
     #   query = {}
 
     #   if timecode
@@ -74,23 +52,17 @@ module MLBStatsAPI
     #     raise ArgumentError, 'Please pass either a timecode or a snapshot.'
     #   end
 
-    #   get "/game/#{game_id}/feed/color/diffPatch", query
+    #   get "/game/#{game_pk}/feed/color/diffPatch", query
     # end
 
-    # def color_feed_timestamps(game_id)
-    #   get "/game/#{game_id}/feed/color/timestamps"
+    # def color_feed_timestamps(game_pk)
+    #   get "/game/#{game_pk}/feed/color/timestamps"
     # end
 
-    def linescore(game_id)
-      get "/game/#{game_id}/linescore"
-    end
+    def linescore(game_pk) = get("/game/#{game_pk}/linescore")
 
-    def play_by_play(game_id, timecode: nil)
-      get "/game/#{game_id}/playByPlay", timecode: timecode
-    end
+    def play_by_play(game_pk, timecode: nil) = get("/game/#{game_pk}/playByPlay", timecode:)
 
-    def win_probability(game_id, timecode: nil)
-      get "/game/#{game_id}/winProbability", timecode: timecode
-    end
+    def win_probability(game_pk, timecode: nil) = get("/game/#{game_pk}/winProbability", timecode:)
   end
 end

data/lib/mlb_stats_api/home_run_derby.rb

@@ -1,24 +1,14 @@
 # frozen_string_literal: true
 
 module MLBStatsAPI
-  # @see https://statsapi.mlb.com/docs/#tag/homerunderby
   module HomeRunDerby
     # View a home run derby object based on gamePk.
-    # @see https://statsapi.mlb.com/docs/#operation/homeRunDerbyBracket
-    def home_run_derby(game_pk, options = {})
-      get "/homeRunDerby/#{game_pk}", options
-    end
+    def home_run_derby(game_pk, **options) = get("/homeRunDerby/#{game_pk}", **options)
 
     # View a home run derby object based on bracket.
-    # @see https://statsapi.mlb.com/docs/#operation/homeRunDerbyBracket
-    def home_run_derby_bracket(game_pk, options = {})
-      get "/homeRunDerby/#{game_pk}/bracket", options
-    end
+    def home_run_derby_bracket(game_pk, **options) = get("/homeRunDerby/#{game_pk}/bracket", **options)
 
     # View a home run derby object based on pool.
-    # @see https://statsapi.mlb.com/docs/#operation/homeRunDerbyPool
-    def home_run_derby_pool(game_pk, options = {})
-      get "/homeRunDerby/#{game_pk}/pool", options
-    end
+    def home_run_derby_pool(game_pk, **options) = get("/homeRunDerby/#{game_pk}/pool", **options)
   end
 end