mlb 0.7.0 → 0.9.0

data/lib/mlb/team.rb

@@ -1,136 +1,65 @@
-require 'faraday'
-require 'multi_json'
+require "shale"
+require_relative "division"
+require_relative "league"
+require_relative "sport"
+require_relative "venue"
 
 module MLB
-  class Team
-    attr_reader :name, :league, :division, :manager, :wins, :losses, :founded, :mascot, :ballpark, :logo_url, :players
+  class Team < Shale::Mapper
+    attribute :spring_league, League
+    attribute :all_star_status, Shale::Type::String
+    attribute :id, Shale::Type::Integer
+    attribute :name, Shale::Type::String
+    attribute :link, Shale::Type::String
+    attribute :season, Shale::Type::Integer
+    attribute :venue, Venue
+    attribute :spring_venue, Venue
+    attribute :team_code, Shale::Type::String
+    attribute :file_code, Shale::Type::String
+    attribute :abbreviation, Shale::Type::String
+    attribute :team_name, Shale::Type::String
+    attribute :location_name, Shale::Type::String
+    attribute :first_year_of_play, Shale::Type::Integer
+    attribute :league, League
+    attribute :division, Division
+    attribute :sport, Sport
+    attribute :short_name, Shale::Type::String
+    attribute :franchise_name, Shale::Type::String
+    attribute :club_name, Shale::Type::String
+    attribute :active, Shale::Type::Boolean
 
-    # Returns an array of Team objects
-    #
-    # @example
-    #   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"
-    def self.all
-      # Attempt to fetch the result from the Freebase API unless there is a
-      # connection error, in which case read from a fixture file
-      @all ||= begin
-        results_to_team(results_from_freebase)
-      rescue Faraday::Error::ConnectionFailed, Faraday::Error::TimeoutError
-        results_to_team(results_from_cache)
-      end
-    end
-
-    def self.reset
-      @all = nil
-    end
-
-  private
-
-    def initialize(attributes = {})
-      attributes.each do |key, value|
-        instance_variable_set("@#{key}", value) if self.respond_to?(key)
-      end
-    end
-
-    def self.results_from_freebase
-      Request.get('/freebase/v1/mqlread', :query => mql_query)
-    end
-
-    def self.results_from_cache
-      JSON.load(file_from_cache('teams.json').read)
-    end
-
-    def self.file_from_cache(file_name)
-      File.new(File.expand_path('../../../cache', __FILE__) + '/' + file_name)
-    end
-
-    def self.results_to_team(results) # rubocop:disable CyclomaticComplexity, MethodLength
-      results['result'].map do |result|
-        league      = result['league']
-        division    = result['division']
-        manager     = result['current_manager']
-        stats       = result['team_stats'].first
-        founded     = result['/sports/sports_team/founded'].first
-        mascot      = result['/sports/sports_team/team_mascot'].first
-        ballpark    = result['/sports/sports_team/arena_stadium'].first
-        logo_prefix = 'http://img.freebase.com/api/trans/image_thumb'
-        logo_suffix = result['/common/topic/image'].first
-        players     = result['/sports/sports_team/roster']
+    alias_method :active?, :active
 
-        new(:name     => result['name'],
-            :league   => (league      ? league['name']                  : nil),
-            :division => (division    ? division['name']                : nil),
-            :manager  => (manager     ? manager['name']                 : nil),
-            :wins     => (stats       ? stats['wins'].to_i              : nil),
-            :losses   => (stats       ? stats['losses'].to_i            : nil),
-            :founded  => (founded     ? founded['value'].to_i           : nil),
-            :mascot   => (mascot      ? mascot['name']                  : nil),
-            :ballpark => (ballpark    ? ballpark['name']                : nil),
-            :logo_url => (logo_suffix ? logo_prefix + logo_suffix['id'] : nil),
-            :players  => (players     ? Player.all_from_roster(players) : []))
-      end
+    json do
+      map "springLeague", to: :spring_league
+      map "allStarStatus", to: :all_star_status
+      map "id", to: :id
+      map "name", to: :name
+      map "link", to: :link
+      map "season", to: :season
+      map "venue", to: :venue
+      map "springVenue", to: :spring_venue
+      map "teamCode", to: :team_code
+      map "fileCode", to: :file_code
+      map "abbreviation", to: :abbreviation
+      map "teamName", to: :team_name
+      map "locationName", to: :location_name
+      map "firstYearOfPlay", to: :first_year_of_play
+      map "league", to: :league
+      map "division", to: :division
+      map "sport", to: :sport
+      map "shortName", to: :short_name
+      map "franchiseName", to: :franchise_name
+      map "clubName", to: :club_name
+      map "active", to: :active
     end
 
-    # Returns the MQL query for teams, as a Ruby hash
-    def self.mql_query # rubocop:disable MethodLength
-      query = <<-eos
-        [{
-          "name":          null,
-          "league": {
-            "name": null
-          },
-          "division": {
-            "name": null
-          },
-          "current_manager": {
-            "optional": true,
-            "name": null
-          },
-          "team_stats": [{
-            "wins":   null,
-            "losses": null,
-            "season": null,
-            "limit":  1,
-            "sort":   "-season"
-          }],
-          "/sports/sports_team/roster": [{
-            "player":   null,
-            "number":   null,
-            "from": null,
-            "to": null,
-            "position": [],
-            "sort":     "player"
-          }],
-          "/sports/sports_team/founded": [{
-            "value": null
-          }],
-          "/sports/sports_team/team_mascot": [{}],
-          "/sports/sports_team/arena_stadium": [{
-            "name": null
-          }],
-          "/common/topic/image": [{
-            "optional": true,
-            "id":        null,
-            "timestamp": null,
-            "sort":      "-timestamp",
-            "limit":     1
-          }],
-          "sort":          "name",
-          "type":          "/baseball/baseball_team"
-        }]
-        eos
-      query.gsub!("\n", '').gsub!(' ', '')
+    def roster(season: Time.now.year)
+      params = {season:}
+      query_string = URI.encode_www_form(params)
+      response = CLIENT.get("teams/#{id}/roster?#{query_string}")
+      roster = Roster.from_json(response)
+      roster.roster
     end
   end
 end

data/lib/mlb/teams.rb

@@ -0,0 +1,30 @@
+require "shale"
+require "uri"
+require_relative "sport"
+require_relative "team"
+
+module MLB
+  class Teams < Shale::Mapper
+    attribute :copyright, Shale::Type::String
+    attribute :teams, Team, collection: true
+
+    def self.all(season: Time.now.year, sport: Sport.new(id: 1))
+      sport_id = sport.respond_to?(:id) ? sport.id : sport
+      params = {sportId: sport_id, season:}
+      query_string = URI.encode_www_form(params)
+      response = CLIENT.get("teams?#{query_string}")
+      teams = from_json(response)
+      teams.teams
+    end
+
+    def self.find(team, season: Time.now.year, sport: Sport.new(id: 1))
+      id = team.respond_to?(:id) ? team.id : team
+      sport_id = sport.respond_to?(:id) ? sport.id : sport
+      params = {sportId: sport_id, season:}
+      query_string = URI.encode_www_form(params)
+      response = CLIENT.get("teams/#{id}?#{query_string}")
+      teams = from_json(response)
+      teams.teams.first
+    end
+  end
+end

data/lib/mlb/transaction.rb

@@ -0,0 +1,31 @@
+require "shale"
+require_relative "player"
+require_relative "team"
+
+module MLB
+  class Transaction < Shale::Mapper
+    attribute :id, Shale::Type::Integer
+    attribute :player, Player
+    attribute :from_team, Team, default: nil
+    attribute :to_team, Team
+    attribute :date, Shale::Type::Date
+    attribute :effective_date, Shale::Type::Date
+    attribute :resolution_date, Shale::Type::Date
+    attribute :type_code, Shale::Type::String
+    attribute :type_desc, Shale::Type::String
+    attribute :description, Shale::Type::String
+
+    json do
+      map "id", to: :id
+      map "person", to: :player
+      map "fromTeam", to: :from_team
+      map "toTeam", to: :to_team
+      map "date", to: :date
+      map "effectiveDate", to: :effective_date
+      map "resolutionDate", to: :resolution_date
+      map "typeCode", to: :type_code
+      map "typeDesc", to: :type_desc
+      map "description", to: :description
+    end
+  end
+end

data/lib/mlb/transactions.rb

@@ -0,0 +1,18 @@
+require "shale"
+require "uri"
+require_relative "transaction"
+
+module MLB
+  class Transactions < Shale::Mapper
+    attribute :copyright, Shale::Type::String
+    attribute :transactions, Transaction, collection: true
+
+    def self.between(start_date: Date.today, end_date: start_date)
+      params = {startDate: start_date, endDate: end_date}
+      query_string = URI.encode_www_form(params)
+      response = CLIENT.get("transactions?#{query_string}")
+      transactions = from_json(response)
+      transactions.transactions
+    end
+  end
+end

data/lib/mlb/venue.rb

@@ -0,0 +1,13 @@
+require "shale"
+
+module MLB
+  class Venue < Shale::Mapper
+    attribute :id, Shale::Type::Integer
+    attribute :name, Shale::Type::String
+    attribute :link, Shale::Type::String
+    attribute :active, Shale::Type::Boolean
+    attribute :season, Shale::Type::Integer
+
+    alias_method :active?, :active
+  end
+end

data/lib/mlb/venues.rb

@@ -0,0 +1,30 @@
+require "shale"
+require "uri"
+require_relative "sport"
+require_relative "venue"
+
+module MLB
+  class Venues < Shale::Mapper
+    attribute :copyright, Shale::Type::String
+    attribute :venues, Venue, collection: true
+
+    def self.all(season: Time.now.year, sport: Sport.new(id: 1))
+      sport_id = sport.respond_to?(:id) ? sport.id : sport
+      params = {sportId: sport_id, season:}
+      query_string = URI.encode_www_form(params)
+      response = CLIENT.get("venues?#{query_string}")
+      venues = from_json(response)
+      venues.venues
+    end
+
+    def self.find(venue, season: Time.now.year, sport: Sport.new(id: 1))
+      id = venue.respond_to?(:id) ? venue.id : venue
+      sport_id = sport.respond_to?(:id) ? sport.id : sport
+      params = {sportId: sport_id, season:}
+      query_string = URI.encode_www_form(params)
+      response = CLIENT.get("venues/#{id}?#{query_string}")
+      venues = from_json(response)
+      venues.venues.first
+    end
+  end
+end

data/lib/mlb/version.rb

@@ -1,15 +1,5 @@
-module MLB
-  class Version
-    MAJOR = 0
-    MINOR = 7
-    PATCH = 0
-    PRE = nil
+require "rubygems/version"
 
-    class << self
-      # @return [String]
-      def to_s
-        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
-      end
-    end
-  end
+module MLB
+  VERSION = Gem::Version.create("0.9.0")
 end

data/lib/mlb.rb

@@ -1,3 +1,9 @@
-require 'mlb/request'
-require 'mlb/team'
-require 'mlb/player'
+require_relative "mlb/client"
+require_relative "mlb/divisions"
+require_relative "mlb/leagues"
+require_relative "mlb/players"
+require_relative "mlb/roster"
+require_relative "mlb/sports"
+require_relative "mlb/teams"
+require_relative "mlb/transactions"
+require_relative "mlb/venues"

data/sig/mlb.rbs

@@ -0,0 +1,186 @@
+module MLB
+  CLIENT: Client
+  VERSION: Gem::Version
+
+  class Error < StandardError
+  end
+
+  class ClientError < HTTPError
+  end
+
+  class BadGateway < ClientError
+  end
+
+  class BadRequest < ClientError
+  end
+
+  class ConnectionException < ClientError
+  end
+
+  class HTTPError < Error
+    attr_reader response : Net::HTTPResponse
+    attr_reader code : String
+
+    def initialize: (response: Net::HTTPResponse) -> void
+  end
+
+  class Forbidden < ClientError
+  end
+
+  class GatewayTimeout < ClientError
+  end
+
+  class Gone < ClientError
+  end
+
+  class InternalServerError < ServerError
+  end
+
+  class NetworkError < Error
+  end
+
+  class NotAcceptable < ClientError
+  end
+
+  class NotFound < ClientError
+  end
+
+  class PayloadTooLarge < ClientError
+  end
+
+  class ServerError < HTTPError
+  end
+
+  class ServiceUnavailable < ServerError
+  end
+
+  class TooManyRedirects < Error
+  end
+
+  class TooManyRequests < ClientError
+  end
+
+  class Unauthorized < ClientError
+  end
+
+  class UnprocessableEntity < ClientError
+  end
+
+  class Connection
+    DEFAULT_HOST: String
+    DEFAULT_PORT: Integer
+    DEFAULT_OPEN_TIMEOUT: Integer
+    DEFAULT_READ_TIMEOUT: Integer
+    DEFAULT_WRITE_TIMEOUT: Integer
+    DEFAULT_DEBUG_OUTPUT: IO
+    NETWORK_ERRORS: Array[(singleton(Errno::ECONNREFUSED) | singleton(Errno::ECONNRESET) | singleton(Net::OpenTimeout) | singleton(Net::ReadTimeout) | singleton(OpenSSL::SSL::SSLError))]
+
+    @proxy_url: URI::Generic | String
+
+    extend Forwardable
+
+    attr_accessor open_timeout : Float | Integer
+    attr_accessor read_timeout : Float | Integer
+    attr_accessor write_timeout : Float | Integer
+    attr_accessor debug_output : IO
+
+    attr_reader proxy_uri: URI::Generic?
+    attr_reader proxy_host : String?
+    attr_reader proxy_port : Integer?
+    attr_reader proxy_user : String?
+    attr_reader proxy_pass : String?
+
+    def initialize: (?open_timeout: Float | Integer, ?read_timeout: Float | Integer, ?write_timeout: Float | Integer, ?proxy_url: URI::Generic? | String?, ?debug_output: IO) -> void
+    def proxy_url=: (URI::Generic | String proxy_url) -> void
+    def perform: (request: Net::HTTPRequest) -> Net::HTTPResponse
+
+    private
+    def build_http_client: (?String host, ?Integer port) -> Net::HTTP
+    def configure_http_client: (Net::HTTP http_client) -> Net::HTTP
+  end
+
+  class RequestBuilder
+    HTTP_METHODS: Hash[Symbol, (singleton(Net::HTTP::Get) | singleton(Net::HTTP::Post) | singleton(Net::HTTP::Put) | singleton(Net::HTTP::Delete))]
+    DEFAULT_HEADERS: Hash[String, String]
+
+    def initialize: (?content_type: String, ?user_agent: String) -> void
+    def build: (http_method: Symbol, uri: URI::Generic, ?body: String?, ?headers: Hash[String, String]) -> (Net::HTTPRequest)
+
+    private
+    def create_request: (http_method: Symbol, uri: URI::Generic, body: String?) -> (Net::HTTPRequest)
+    def add_headers: (request: Net::HTTPRequest, headers: Hash[String, String]) -> void
+    def escape_query_params: (URI::Generic uri) -> URI::Generic
+  end
+
+  class RedirectHandler
+    DEFAULT_MAX_REDIRECTS: Integer
+
+    attr_reader connection: Connection
+    attr_reader request_builder: RequestBuilder
+    attr_reader max_redirects: Integer
+    def initialize: (?connection: Connection, ?request_builder: RequestBuilder, ?max_redirects: Integer) -> void
+    def handle: (response: Net::HTTPResponse, request: Net::HTTPRequest, base_url: String, ?redirect_count: Integer) -> Net::HTTPResponse
+
+    private
+    def build_new_uri: (Net::HTTPResponse response, String base_url) -> URI::Generic
+    def build_request: (Net::HTTPRequest request, URI::Generic new_uri, Integer response_code) -> Net::HTTPRequest
+    def send_new_request: (URI::Generic new_uri, Net::HTTPRequest new_request) -> Net::HTTPResponse
+  end
+
+  class ErrorHandler
+    ERROR_MAP: Hash[Integer, singleton(BadGateway) | singleton(BadRequest) | singleton(ConnectionException) | singleton(Forbidden) | singleton(GatewayTimeout) | singleton(Gone) | singleton(InternalServerError) | singleton(NotAcceptable) | singleton(NotFound) | singleton(PayloadTooLarge) | singleton(ServiceUnavailable) | singleton(TooManyRequests) | singleton(Unauthorized) | singleton(UnprocessableEntity)]
+    JSON_CONTENT_TYPE_REGEXP: Regexp
+
+    def parse: (response: Net::HTTPResponse) -> untyped
+
+    private
+    def error: (Net::HTTPResponse response) -> HTTPError
+    def error_class: (Net::HTTPResponse response) -> (singleton(BadGateway) | singleton(BadRequest) | singleton(ConnectionException) | singleton(Forbidden) | singleton(GatewayTimeout) | singleton(Gone) | singleton(InternalServerError) | singleton(NotAcceptable) | singleton(NotFound) | singleton(PayloadTooLarge) | singleton(ServiceUnavailable) | singleton(TooManyRequests) | singleton(Unauthorized) | singleton(UnprocessableEntity))
+    def json?: (Net::HTTPResponse response) -> bool
+  end
+
+  class Client
+    DEFAULT_BASE_URL: String
+    extend Forwardable
+    @connection: Connection
+    @request_builder: RequestBuilder
+    @redirect_handler: RedirectHandler
+    @error_handler: ErrorHandler
+
+    attr_accessor base_url: String
+    def initialize: (?base_url: String, ?open_timeout: Integer, ?read_timeout: Integer, ?write_timeout: Integer, ?debug_output: untyped, ?proxy_url: nil, ?max_redirects: Integer) -> void
+    def get: (String endpoint, ?headers: Hash[String, String]) -> untyped
+    def post: (String endpoint, ?String? body, ?headers: Hash[String, String]) -> untyped
+    def put: (String endpoint, ?String? body, ?headers: Hash[String, String]) -> untyped
+    def delete: (String endpoint, ?headers: Hash[String, String]) -> untyped
+
+    private
+    def execute_request: (:delete | :get | :post | :put http_method, String endpoint, ?body: String?, ?headers: Hash[String, String]) -> nil
+  end
+
+  attr_accessor effective_date: String
+  attr_accessor player_id: String
+  attr_accessor team_id: String
+
+  class Team < Struct[untyped]
+    attr_accessor team_id: String
+    def self.new: -> void
+    def self.all: (?season: Integer, ?sort_order: String, ?all_star: false) -> Array[Team]
+    def roster: -> Array[Player]
+  end
+
+  class Transaction < Struct[untyped]
+    attr_accessor player_id: String
+    attr_accessor team_id: String
+    def self.new: -> void
+    def self.all: (?season: Integer, ?sort_order: String, ?all_star: false) -> Array[Team]
+    def team: -> Team
+    def player: -> Player
+  end
+
+  class Player < Struct[untyped]
+    attr_accessor player_id: String
+    def self.new: -> void
+    def team: -> Team
+  end
+end