mlb 0.6.3 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e82207f5345873c47ef01b18d32ed5dc131a7a2a2531b5c5adf2ca87e2c5d397
+  data.tar.gz: 597c40742c137216cc3210362b9a157dc28ef25cd5dacff689489821323cb804
+SHA512:
+  metadata.gz: c9e096ebd1e2a1d88d618507c8e3d15b540f06c146b29c3dff1abe2dbf581521858fbf1b6362ad251c241db89330f3d2c4d6fb94753d8236056b5ec2910bfb69
+  data.tar.gz: e962f38e4fc333cafb5618ab1c5bdf66e53aed74b12a2e8be708877a2a8100af96410bfd8e196ce51ad4570490da98c4ade2eaefee845c9cf9230dacb2a7f5a2

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## [0.8.0] - 2024-05-02
+* 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,104 +1,121 @@
-# 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]
+[![Tests](https://github.com/sferik/mlb-ruby/actions/workflows/test.yml/badge.svg)](https://github.com/sferik/mlb-ruby/actions/workflows/test.yml)
+[![Linter](https://github.com/sferik/mlb-ruby/actions/workflows/lint.yml/badge.svg)](https://github.com/sferik/mlb-ruby/actions/workflows/lint.yml)
+[![Mutant](https://github.com/sferik/mlb-ruby/actions/workflows/mutant.yml/badge.svg)](https://github.com/sferik/mlb-ruby/actions/workflows/mutant.yml)
+[![Typer Checker](https://github.com/sferik/mlb-ruby/actions/workflows/steep.yml/badge.svg)](https://github.com/sferik/mlb-ruby/actions/workflows/steep.yml)
+[![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
+# A [Ruby](https://www.ruby-lang.org) interface to the [MLB Data API](https://appac.github.io/mlb-data-api-docs/)
 
-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) on X.
 
 ## 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://gist.github.com/sferik/4701180/raw/public_cert.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
-* [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"
+
+dbacks = MLB::Team.all(season: 2024).first
+dbacks.name_display_full       # => "Arizona Diamondbacks"
+dbacks.name_display_brief      # => "D-backs"
+dbacks.name_abbrev             # => "AZ"
+dbacks.city                    # => "Phoenix"
+dbacks.league_full             # => "National League"
+dbacks.league_abbrev           # => "NL"
+dbacks.spring_league_full      # => "Cactus League"
+dbacks.spring_league_abbrev    # => "CL"
+dbacks.division_full           # => "National League West"
+dbacks.division_abbrev         # => "NLW"
+dbacks.first_year_of_play      # => "1996"
+dbacks.venue_name              # => "Chase Field"
+
+blaze = dbacks.roster.first
+blaze.name_display_first_last  # => "Blaze Alexander"
+blaze.jersey_number            # => "9"
+blaze.primary_position         # => "6"
+blaze.position_txt             # => "SS"
+blaze.height_feet              # => "5"
+blaze.height_inches            # => "11"
+blaze.weight                   # => "160"
+blaze.bats                     # => "R"
+blaze.throws                   # => "R"
+blaze.birth_date               # => "1999-06-11T00:00:00"
+blaze.start_date               # => "2022-11-15T00:00:00"
+blaze.pro_debut_date           # => "2024-03-28T00:00:00"
+```
+
+## 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
+
+5. RBS type signatures (in `sig/mlb.rbs`). This can be verified with:
+
+       bundle exec rake steep
+
+## 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,73 @@
+require "forwardable"
+require_relative "connection"
+require_relative "redirect_handler"
+require_relative "request_builder"
+require_relative "response_parser"
+
+module MLB
+  class Client
+    extend Forwardable
+
+    DEFAULT_BASE_URL = "https://lookup-service-prod.mlb.com/json/".freeze
+    DEFAULT_ARRAY_CLASS = Array
+    DEFAULT_OBJECT_CLASS = Hash
+
+    attr_accessor :base_url, :default_array_class, :default_object_class
+
+    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,
+      default_array_class: DEFAULT_ARRAY_CLASS,
+      default_object_class: DEFAULT_OBJECT_CLASS,
+      max_redirects: RedirectHandler::DEFAULT_MAX_REDIRECTS)
+
+      @base_url = base_url
+      initialize_default_classes(default_array_class, default_object_class)
+      @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:)
+      @response_parser = ResponseParser.new
+    end
+
+    def get(endpoint, headers: {}, array_class: default_array_class, object_class: default_object_class)
+      execute_request(:get, endpoint, headers:, array_class:, object_class:)
+    end
+
+    def post(endpoint, body = nil, headers: {}, array_class: default_array_class, object_class: default_object_class)
+      execute_request(:post, endpoint, body:, headers:, array_class:, object_class:)
+    end
+
+    def put(endpoint, body = nil, headers: {}, array_class: default_array_class, object_class: default_object_class)
+      execute_request(:put, endpoint, body:, headers:, array_class:, object_class:)
+    end
+
+    def delete(endpoint, headers: {}, array_class: default_array_class, object_class: default_object_class)
+      execute_request(:delete, endpoint, headers:, array_class:, object_class:)
+    end
+
+    private
+
+    def initialize_default_classes(default_array_class, default_object_class)
+      @default_array_class = default_array_class
+      @default_object_class = default_object_class
+    end
+
+    def execute_request(http_method, endpoint, body: nil, headers: {}, array_class: default_array_class, object_class: default_object_class)
+      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:)
+      @response_parser.parse(response:, array_class:, object_class:)
+    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 = "lookup-service-prod.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/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

data/lib/mlb/errors/payload_too_large.rb

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

data/lib/mlb/errors/server_error.rb

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

data/lib/mlb/errors/service_unavailable.rb

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

data/lib/mlb/errors/too_many_redirects.rb

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

data/lib/mlb/errors/too_many_requests.rb

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

data/lib/mlb/errors/unauthorized.rb

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

data/lib/mlb/errors/unprocessable_entity.rb

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

data/lib/mlb/player.rb

@@ -1,26 +1,21 @@
 module MLB
-  class Player
-    private_class_method :new
-    attr_reader :name, :number, :position
-
-    private
-
-    def initialize(attributes={})
-      attributes.each do |key, value|
-        instance_variable_set("@#{key}", value) if self.respond_to?(key)
-      end
+  Player = Struct.new(:bats, :birth_date, :college, :end_date, :height_feet,
+    :height_inches, :jersey_number, :name_display_first_last,
+    :name_display_last_first, :name_first, :name_full, :name_last, :name_use,
+    :player_id, :position_txt, :primary_position, :pro_debut_date, :start_date,
+    :starter_sw, :status_code, :team_abbrev, :team_code, :team_id, :team_name,
+    :throws, :weight, keyword_init: true) do
+    def team
+      require_relative "team"
+      sport_code = "'mlb'"
+      season = Time.now.year
+      all_star_sw = "'N'"
+      params = {sport_code:, season:, all_star_sw:}
+      query_string = URI.encode_www_form(params)
+      response = CLIENT.get("named.team_all_season.bam?#{query_string}")
+      teams = response[:team_all_season][:queryResults][:row]
+      team = teams.find { |t| t[:team_id] == team_id.to_s }
+      Team.new(**team)
     end
-
-    # Returns an array of Player objects given a team roster
-    def self.all_from_roster(players)
-      players.map do |player|
-        new(
-          :name     => player['player'],
-          :number   => player['number'],
-          :position => player['position']
-        )
-      end
-    end
-
   end
 end