Class: NBA::Client

Inherits:

Object

• Object
• NBA::Client

Defined in:

lib/nba/client.rb

Overview

API client for making requests to the NBA Stats API

Instance Attribute Summary

• #connection ⇒ Connection readonly private

  Returns the connection used for HTTP requests.

Instance Method Summary

• #get(path) ⇒ String

  Makes a GET request to the specified path.

• #initialize(connection: Connection.new) ⇒ NBA::Client constructor

  Initializes a new Client object.

Constructor Details

#initialize(connection: Connection.new) ⇒ NBA::Client

Initializes a new Client object

Examples:

client = NBA::Client.new

Parameters:

• connection (Connection) (defaults to: Connection.new) —

  the connection to use for requests

# File 'lib/nba/client.rb', line 28

def initialize(connection: Connection.new)
  @connection = connection
end

Instance Attribute Details

#connection ⇒ Connection (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the connection used for HTTP requests

Returns:

• (Connection) —

  the connection instance

# File 'lib/nba/client.rb', line 19

def connection
  @connection
end

Instance Method Details

#get(path) ⇒ String

Makes a GET request to the specified path

Examples:

client.get("commonplayerinfo?PlayerID=2544")

Parameters:

• path (String) —

  the API path to request

Returns:

• (String) —

  the response body

# File 'lib/nba/client.rb', line 13

def get(path) = connection.get(path)