mlb 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e86303e2aa1810d5213ac3b1994bad065045a89f
-  data.tar.gz: 0e8c5d53d3912fcbc27a9eac8b53e6bb8cd5cc68
+SHA256:
+  metadata.gz: d6e28a22c9b934399e0edab2d391ef9dacc66209850caae9ad8e70a6bd524e1e
+  data.tar.gz: dd0f65a56582ec130bf1d46371fdf72cc4c48b6371af994632f0d663a6851c53
 SHA512:
-  metadata.gz: 22d39a995a4edde5e03c3a4b294aaab99b94e5aa06db7cd0906f3ec5ea2a40435bf02be75337b2a1b23435590e7ccbe4705814765524f489fd7e9404332c313e
-  data.tar.gz: a89f2d8eb70401b875534421efd4b21ec92f32641528cc94a90b91e7169b24b05fd0f1515b584f306548fd6b32aaf06d0775766d1e0d907bde50474bb9f1ca58
+  metadata.gz: 7b57c8c9eda053930153f421a9447c4cd65f4fd7a55612d027faa9633a61783660a338d0468a752d2666b83223f23b2c9649c9a977e72354cb21c879000e2543
+  data.tar.gz: 5c866fb121cc4d6972e717b7466474d97d7dd044418d84a573b19f6f94ffd5b65569d66bf2a2eca4997c3b6bfc64f93cadefac7e6501cc659bb256d975ab5d83

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [0.8.0] - 2024-05-22
+* Rewrite to use MLB Stats API
+
+## [0.8.0] - 2024-05-06
+* Rewrite

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-2024 Erik Berlin, Nilesh Trivedi
+
+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

@@ -1,109 +1,119 @@
-# MLB.rb
-[![Gem Version](https://badge.fury.io/rb/mlb.png)][gem]
-[![Build Status](https://secure.travis-ci.org/sferik/mlb.png?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/sferik/mlb.png?travis)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/sferik/mlb.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/sferik/mlb/badge.png?branch=master)][coveralls]
+[![Tests](https://github.com/sferik/mlb-ruby/actions/workflows/test.yml/badge.svg)](https://github.com/sferik/mlb-ruby/actions/workflows/test.yml)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/fc32f80cb778b773a5b2/test_coverage)](https://codeclimate.com/github/sferik/mlb-ruby/test_coverage)
+[![Mutant](https://github.com/sferik/mlb-ruby/actions/workflows/mutant.yml/badge.svg)](https://github.com/sferik/mlb-ruby/actions/workflows/mutant.yml)
+[![Linter](https://github.com/sferik/mlb-ruby/actions/workflows/lint.yml/badge.svg)](https://github.com/sferik/mlb-ruby/actions/workflows/lint.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/fc32f80cb778b773a5b2/maintainability)](https://codeclimate.com/github/sferik/mlb-ruby/maintainability)
+[![Gem Version](https://badge.fury.io/rb/mlb.svg)](https://rubygems.org/gems/mlb)
 
-[gem]: https://rubygems.org/gems/mlb
-[travis]: http://travis-ci.org/sferik/mlb
-[gemnasium]: https://gemnasium.com/sferik/mlb
-[codeclimate]: https://codeclimate.com/github/sferik/mlb
-[coveralls]: https://coveralls.io/r/sferik/mlb
+# A [Ruby](https://www.ruby-lang.org) interface to the [MLB Stats API](https://statsapi.mlb.com)
 
-MLB.rb is a Ruby library for retrieving current Major League Baseball players, managers, teams, divisions, and leagues.
+## Follow
+
+For updates and announcements, follow [@sferik](https://x.com/sferik).
 
 ## Installation
+
+Install the gem and add to the application's Gemfile:
+
+    bundle add mlb
+
+Or, if Bundler is not being used to manage dependencies:
+
     gem install mlb
 
-To ensure the code you're installing hasn't been tampered with, it's
-recommended that you verify the signature. To do this, you need to add my
-public key as a trusted certificate (you only need to do this once):
-
-    gem cert --add <(curl -Ls https://raw.github.com/sferik/mlb/master/certs/sferik.pem)
-
-Then, install the gem with the high security trust policy:
-
-    gem install mlb -P HighSecurity
-
-## Documentation
-[http://rdoc.info/gems/mlb][documentation]
-
-[documentation]: http://rdoc.info/gems/mlb
-
-## Usage Examples
-    $ irb
-    >> require 'mlb'
-    >> MLB::Team.all.first.name                   # => "Arizona Diamondbacks"
-    >> MLB::Team.all.first.league                 # => "National League"
-    >> MLB::Team.all.first.division               # => "National League West"
-    >> MLB::Team.all.first.manager                # => "Bob Melvin"
-    >> MLB::Team.all.first.wins                   # => 82
-    >> MLB::Team.all.first.losses                 # => 80
-    >> MLB::Team.all.first.founded                # => 1998
-    >> MLB::Team.all.first.mascot                 # => nil
-    >> MLB::Team.all.first.ballpark               # => "Chase Field"
-    >> MLB::Team.all.first.logo_url               # => "http://img.freebase.com/api/trans/image_thumb/wikipedia/images/en_id/13104064"
-    >> MLB::Team.all.first.players.first.name     # => "Alex Romero"
-    >> MLB::Team.all.first.players.first.number   # => 28
-    >> MLB::Team.all.first.players.first.position # => "Right fielder"
-
-## Supported Ruby Versions
-This library aims to support and is [tested against][travis] the following Ruby
-implementations:
-
-* Ruby 1.8.7
-* Ruby 1.9.2
-* Ruby 1.9.3
-* Ruby 2.0.0
-* Ruby 2.1.0
-* [Rubinius][]
-* [JRuby][]
-
-[rubinius]: http://rubini.us/
-[jruby]: http://jruby.org/
-
-If something doesn't work on one of these interpreters, it's a bug.
-
-This library may inadvertently work (or seem to work) on other Ruby
-implementations, however support will only be provided for the versions listed
-above.
-
-If you would like this library to support another Ruby version, you may
-volunteer to be a maintainer. Being a maintainer entails making sure all tests
-run and pass on that implementation. When something breaks on your
-implementation, you will be responsible for providing patches in a timely
-fashion. If critical issues for a particular implementation exist at the time
-of a major release, support for that Ruby version may be dropped.
-
-## Colophon
-MLB was built with the following tools:
-
-* [Bundler][]
-* [Freebase][]
-* [Faraday][]
-* [Markdown][]
-* [MultiJSON][]
-* [RSpec][]
-* [SimpleCov][]
-* [SQLite][]
-* [vim][]
-* [WebMock][]
-* [YARD][]
-
-[bundler]: http://gembundler.com/
-[freebase]: http://www.freebase.com/
-[faraday]: https://github.com/technoweenie/faraday
-[markdown]: http://daringfireball.net/projects/markdown/
-[multijson]: https://github.com/intridea/multi_json
-[rspec]: http://relishapp.com/rspec/
-[simplecov]: https://github.com/colszowka/simplecov
-[sqlite]: http://www.sqlite.org/
-[vim]: http://www.vim.org/
-[webmock]: https://github.com/bblimke/webmock
-[yard]: http://yardoc.org/
-
-## Copyright
-Copyright (c) 2010-2013 Erik Michaels-Ober. See [LICENSE][] for details.
-
-[license]: LICENSE.md
+## Usage
+
+```ruby
+require "mlb"
+
+mets = MLB::Teams.all(season: 2024).last
+mets.name                   # => "New York Mets"
+mets.short_name             # => "NY Mets"
+mets.abbreviation           # => "NYM"
+mets.league.name            # => "National League"
+mets.spring_league.name     # => "Grapefruit League"
+mets.division.name          # => "National League East"
+mets.first_year_of_play     # => 1962
+mets.location_name          # => "Flushing"
+mets.venue.name             # => "Citi Field"
+
+adam = MLB::Players.all(season: 2024).find { |player| player.id == mets.roster.first.player.id }
+
+adam.full_name              # => "Adam Ottavino"
+adam.primary_number         # => 0
+adam.primary_position.name  # => "Pitcher"
+adam.pitch_hand.description # => "Right"
+adam.bat_side.description   # => "Switch"
+adam.current_age            # => 38
+adam.birth_date.to_s        # => "1985-11-22"
+adam.birth_city             # => "New York"
+adam.birth_state_province   # => "NY"
+adam.birth_country          # => "USA"
+adam.draft_year             # => 2006
+adam.mlb_debut_date.to_s    # => "2010-05-29"
+adam.height                 # => "6' 5\""
+adam.weight                 # => 246
+adam.active?                # => true
+```
+
+## Sponsorship
+
+By contributing to the project, you help:
+
+1. Maintain the library: Keeping it up-to-date and secure.
+2. Add new features: Enhancements that make your life easier.
+3. Provide support: Faster responses to issues and feature requests.
+
+⭐️ Bonus: Sponsors will get priority support and influence over the project roadmap. We will also list your name or your company's logo on our GitHub page.
+
+Building and maintaining an open-source project like this takes a considerable amount of time and effort. Your sponsorship can help sustain this project. Even a small monthly donation makes a huge difference!
+
+[Click here to sponsor this project.](https://github.com/sponsors/sferik)
+
+## Development
+
+1. Checkout and repo:
+
+       git checkout git@github.com:sferik/mlb-ruby.git
+
+2. Enter the repo’s directory:
+
+       cd mlb-ruby
+
+3. Install dependencies via Bundler:
+
+       bin/setup
+
+4. Run the default Rake task to ensure all tests pass:
+
+       bundle exec rake
+
+5. Create a new branch for your feature or bug fix:
+
+       git checkout -b my-new-branch
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sferik/mlb-ruby.
+
+Pull requests will only be accepted if they meet all the following criteria:
+
+1. Code must conform to [Standard Ruby](https://github.com/standardrb/standard#readme). This can be verified with:
+
+       bundle exec rake standard
+
+2. Code must conform to the [RuboCop rules](https://github.com/rubocop/rubocop#readme). This can be verified with:
+
+       bundle exec rake rubocop
+
+3. 100% C0 code coverage. This can be verified with:
+
+       bundle exec rake test
+
+4. 100% mutation coverage. This can be verified with:
+
+       bundle exec rake mutant
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mlb"
+
+# 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.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/mlb/client.rb

@@ -0,0 +1,63 @@
+require "forwardable"
+require_relative "connection"
+require_relative "redirect_handler"
+require_relative "request_builder"
+require_relative "error_handler"
+
+module MLB
+  class Client
+    extend Forwardable
+
+    DEFAULT_BASE_URL = "https://statsapi.mlb.com/api/v1/".freeze
+
+    attr_accessor :base_url
+
+    def_delegators :@connection, :open_timeout, :read_timeout, :write_timeout, :proxy_url, :debug_output
+    def_delegators :@connection, :open_timeout=, :read_timeout=, :write_timeout=, :proxy_url=, :debug_output=
+    def_delegators :@redirect_handler, :max_redirects
+    def_delegators :@redirect_handler, :max_redirects=
+
+    def initialize(base_url: DEFAULT_BASE_URL,
+      open_timeout: Connection::DEFAULT_OPEN_TIMEOUT,
+      read_timeout: Connection::DEFAULT_READ_TIMEOUT,
+      write_timeout: Connection::DEFAULT_WRITE_TIMEOUT,
+      debug_output: Connection::DEFAULT_DEBUG_OUTPUT,
+      proxy_url: nil,
+      max_redirects: RedirectHandler::DEFAULT_MAX_REDIRECTS)
+
+      @base_url = base_url
+      @connection = Connection.new(open_timeout:, read_timeout:, write_timeout:, debug_output:, proxy_url:)
+      @request_builder = RequestBuilder.new
+      @redirect_handler = RedirectHandler.new(connection: @connection, request_builder: @request_builder, max_redirects:)
+      @error_handler = ErrorHandler.new
+    end
+
+    def get(endpoint, headers: {})
+      execute_request(:get, endpoint, headers:)
+    end
+
+    def post(endpoint, body = nil, headers: {})
+      execute_request(:post, endpoint, body:, headers:)
+    end
+
+    def put(endpoint, body = nil, headers: {})
+      execute_request(:put, endpoint, body:, headers:)
+    end
+
+    def delete(endpoint, headers: {})
+      execute_request(:delete, endpoint, headers:)
+    end
+
+    private
+
+    def execute_request(http_method, endpoint, headers:, body: nil)
+      uri = URI.join(base_url, endpoint)
+      request = @request_builder.build(http_method:, uri:, body:, headers:)
+      response = @connection.perform(request:)
+      response = @redirect_handler.handle(response:, request:, base_url:)
+      @error_handler.handle(response:)
+    end
+  end
+
+  CLIENT = Client.new
+end

data/lib/mlb/connection.rb

@@ -0,0 +1,80 @@
+require "forwardable"
+require "net/http"
+require "openssl"
+require "uri"
+require_relative "errors/network_error"
+
+module MLB
+  class Connection
+    extend Forwardable
+
+    DEFAULT_HOST = "statsapi.mlb.com".freeze
+    DEFAULT_PORT = 443
+    DEFAULT_OPEN_TIMEOUT = 60 # seconds
+    DEFAULT_READ_TIMEOUT = 60 # seconds
+    DEFAULT_WRITE_TIMEOUT = 60 # seconds
+    DEFAULT_DEBUG_OUTPUT = File.open(File::NULL, "w")
+    NETWORK_ERRORS = [
+      Errno::ECONNREFUSED,
+      Errno::ECONNRESET,
+      Net::OpenTimeout,
+      Net::ReadTimeout,
+      OpenSSL::SSL::SSLError
+    ].freeze
+
+    attr_accessor :open_timeout, :read_timeout, :write_timeout, :debug_output
+    attr_reader :proxy_url, :proxy_uri
+
+    def_delegator :proxy_uri, :host, :proxy_host
+    def_delegator :proxy_uri, :port, :proxy_port
+    def_delegator :proxy_uri, :user, :proxy_user
+    def_delegator :proxy_uri, :password, :proxy_pass
+
+    def initialize(open_timeout: DEFAULT_OPEN_TIMEOUT, read_timeout: DEFAULT_READ_TIMEOUT,
+      write_timeout: DEFAULT_WRITE_TIMEOUT, debug_output: DEFAULT_DEBUG_OUTPUT, proxy_url: nil)
+      @open_timeout = open_timeout
+      @read_timeout = read_timeout
+      @write_timeout = write_timeout
+      @debug_output = debug_output
+      self.proxy_url = proxy_url unless proxy_url.nil?
+    end
+
+    def perform(request:)
+      host = request.uri.host || DEFAULT_HOST
+      port = request.uri.port || DEFAULT_PORT
+      http_client = build_http_client(host, port)
+      http_client.use_ssl = request.uri.scheme.eql?("https")
+      http_client.request(request)
+    rescue *NETWORK_ERRORS => e
+      raise NetworkError, "Network error: #{e}"
+    end
+
+    def proxy_url=(proxy_url)
+      @proxy_url = proxy_url
+      proxy_uri = URI(proxy_url)
+      raise ArgumentError, "Invalid proxy URL: #{proxy_uri}" unless proxy_uri.is_a?(URI::HTTP)
+
+      @proxy_uri = proxy_uri
+    end
+
+    private
+
+    def build_http_client(host = DEFAULT_HOST, port = DEFAULT_PORT)
+      http_client = if proxy_uri
+        Net::HTTP.new(host, port, proxy_host, proxy_port, proxy_user, proxy_pass)
+      else
+        Net::HTTP.new(host, port)
+      end
+      configure_http_client(http_client)
+    end
+
+    def configure_http_client(http_client)
+      http_client.tap do |c|
+        c.open_timeout = open_timeout
+        c.read_timeout = read_timeout
+        c.write_timeout = write_timeout
+        c.set_debug_output(debug_output)
+      end
+    end
+  end
+end

data/lib/mlb/division.rb

@@ -0,0 +1,42 @@
+require "shale"
+require_relative "league"
+require_relative "sport"
+
+module MLB
+  class Division < Shale::Mapper
+    include Comparable
+
+    attribute :id, Shale::Type::Integer
+    attribute :name, Shale::Type::String
+    attribute :season, Shale::Type::String
+    attribute :name_short, Shale::Type::String
+    attribute :link, Shale::Type::String
+    attribute :abbreviation, Shale::Type::String
+    attribute :league, League
+    attribute :sport, Sport
+    attribute :has_wildcard, Shale::Type::Boolean
+    attribute :sort_order, Shale::Type::Integer
+    attribute :active, Shale::Type::Boolean
+
+    alias_method :active?, :active
+    alias_method :wildcard?, :has_wildcard
+
+    json do
+      map "id", to: :id
+      map "name", to: :name
+      map "season", to: :season
+      map "nameShort", to: :name_short
+      map "link", to: :link
+      map "abbreviation", to: :abbreviation
+      map "league", to: :league
+      map "sport", to: :sport
+      map "hasWildcard", to: :has_wildcard
+      map "sortOrder", to: :sort_order
+      map "active", to: :active
+    end
+
+    def <=>(other)
+      sort_order <=> other.sort_order
+    end
+  end
+end

data/lib/mlb/divisions.rb

@@ -0,0 +1,30 @@
+require "shale"
+require "uri"
+require_relative "sport"
+require_relative "division"
+
+module MLB
+  class Divisions < Shale::Mapper
+    attribute :copyright, Shale::Type::String
+    attribute :divisions, Division, collection: true
+
+    def self.all(sport: Sport.new(id: 1))
+      sport_id = sport.respond_to?(:id) ? sport.id : sport
+      params = {sportId: sport_id}
+      query_string = URI.encode_www_form(params)
+      response = CLIENT.get("divisions?#{query_string}")
+      divisions = from_json(response)
+      divisions.divisions.sort!
+    end
+
+    def self.find(division, sport: Sport.new(id: 1))
+      id = division.respond_to?(:id) ? division.id : division
+      sport_id = sport.respond_to?(:id) ? sport.id : sport
+      params = {sportId: sport_id}
+      query_string = URI.encode_www_form(params)
+      response = CLIENT.get("divisions/#{id}?#{query_string}")
+      divisions = from_json(response)
+      divisions.divisions.first
+    end
+  end
+end

data/lib/mlb/error_handler.rb

@@ -0,0 +1,53 @@
+require "net/http"
+require_relative "errors/bad_gateway"
+require_relative "errors/bad_request"
+require_relative "errors/connection_exception"
+require_relative "errors/http_error"
+require_relative "errors/forbidden"
+require_relative "errors/gateway_timeout"
+require_relative "errors/gone"
+require_relative "errors/internal_server_error"
+require_relative "errors/not_acceptable"
+require_relative "errors/not_found"
+require_relative "errors/payload_too_large"
+require_relative "errors/service_unavailable"
+require_relative "errors/too_many_requests"
+require_relative "errors/unauthorized"
+require_relative "errors/unprocessable_entity"
+
+module MLB
+  class ErrorHandler
+    ERROR_MAP = {
+      400 => BadRequest,
+      401 => Unauthorized,
+      403 => Forbidden,
+      404 => NotFound,
+      406 => NotAcceptable,
+      409 => ConnectionException,
+      410 => Gone,
+      413 => PayloadTooLarge,
+      422 => UnprocessableEntity,
+      429 => TooManyRequests,
+      500 => InternalServerError,
+      502 => BadGateway,
+      503 => ServiceUnavailable,
+      504 => GatewayTimeout
+    }.freeze
+
+    def handle(response:)
+      raise error(response) unless response.is_a?(Net::HTTPSuccess)
+
+      response.body
+    end
+
+    private
+
+    def error(response)
+      error_class(response).new(response:)
+    end
+
+    def error_class(response)
+      ERROR_MAP[Integer(response.code)] || HTTPError
+    end
+  end
+end

data/lib/mlb/errors/bad_gateway.rb

@@ -0,0 +1,5 @@
+require_relative "server_error"
+
+module MLB
+  class BadGateway < ServerError; end
+end

data/lib/mlb/errors/bad_request.rb

@@ -0,0 +1,5 @@
+require_relative "client_error"
+
+module MLB
+  class BadRequest < ClientError; end
+end

data/lib/mlb/errors/client_error.rb

@@ -0,0 +1,5 @@
+require_relative "http_error"
+
+module MLB
+  class ClientError < HTTPError; end
+end

data/lib/mlb/errors/connection_exception.rb

@@ -0,0 +1,5 @@
+require_relative "client_error"
+
+module MLB
+  class ConnectionException < ClientError; end
+end

data/lib/mlb/errors/error.rb

@@ -0,0 +1,3 @@
+module MLB
+  class Error < StandardError; end
+end

data/lib/mlb/errors/forbidden.rb

@@ -0,0 +1,5 @@
+require_relative "client_error"
+
+module MLB
+  class Forbidden < ClientError; end
+end

data/lib/mlb/errors/gateway_timeout.rb

@@ -0,0 +1,5 @@
+require_relative "server_error"
+
+module MLB
+  class GatewayTimeout < ServerError; end
+end

data/lib/mlb/errors/gone.rb

@@ -0,0 +1,5 @@
+require_relative "client_error"
+
+module MLB
+  class Gone < ClientError; end
+end

data/lib/mlb/errors/http_error.rb

@@ -0,0 +1,14 @@
+require "json"
+require_relative "error"
+
+module MLB
+  class HTTPError < Error
+    attr_reader :response, :code
+
+    def initialize(response:)
+      super(response.message)
+      @response = response
+      @code = response.code
+    end
+  end
+end

data/lib/mlb/errors/internal_server_error.rb

@@ -0,0 +1,5 @@
+require_relative "server_error"
+
+module MLB
+  class InternalServerError < ServerError; end
+end

data/lib/mlb/errors/network_error.rb

@@ -0,0 +1,5 @@
+require_relative "error"
+
+module MLB
+  class NetworkError < Error; end
+end

data/lib/mlb/errors/not_acceptable.rb

@@ -0,0 +1,5 @@
+require_relative "client_error"
+
+module MLB
+  class NotAcceptable < ClientError; end
+end

data/lib/mlb/errors/not_found.rb

@@ -0,0 +1,5 @@
+require_relative "client_error"
+
+module MLB
+  class NotFound < ClientError; end
+end