Module: Brapi

Defined in:

lib/brapi.rb,
lib/brapi/model.rb,
lib/brapi/client.rb,
lib/brapi/errors.rb,
lib/brapi/version.rb,
lib/brapi/resource.rb,
lib/brapi/models/quote.rb,
lib/brapi/resources/v2.rb,
lib/brapi/configuration.rb,
lib/brapi/models/v2/fii.rb,
lib/brapi/resources/quote.rb,
lib/brapi/models/v2/crypto.rb,
lib/brapi/resources/v2/fii.rb,
lib/brapi/models/pagination.rb,
lib/brapi/models/v2/currency.rb,
lib/brapi/resources/v2/macro.rb,
lib/brapi/models/subscription.rb,
lib/brapi/resources/available.rb,
lib/brapi/resources/paginated.rb,
lib/brapi/resources/v2/crypto.rb,
lib/brapi/models/cash_dividend.rb,
lib/brapi/models/cashflow_entry.rb,
lib/brapi/models/dividends_data.rb,
lib/brapi/models/stock_dividend.rb,
lib/brapi/models/v2/fii_history.rb,
lib/brapi/resources/v2/currency.rb,
lib/brapi/resources/v2/treasury.rb,
lib/brapi/models/quote_list_item.rb,
lib/brapi/models/summary_profile.rb,
lib/brapi/models/v2/fii_dividend.rb,
lib/brapi/models/v2/macro_result.rb,
lib/brapi/models/v2/macro_series.rb,
lib/brapi/resources/v2/inflation.rb,
lib/brapi/models/v2/treasury_bond.rb,
lib/brapi/resources/v2/prime_rate.rb,
lib/brapi/models/value_added_entry.rb,
lib/brapi/models/v2/inflation_entry.rb,
lib/brapi/models/balance_sheet_entry.rb,
lib/brapi/models/quote_list_response.rb,
lib/brapi/models/v2/prime_rate_entry.rb,
lib/brapi/models/financial_data_entry.rb,
lib/brapi/models/key_statistics_entry.rb,
lib/brapi/models/v2/fii_list_response.rb,
lib/brapi/models/v2/macro_observation.rb,
lib/brapi/models/historical_data_price.rb,
lib/brapi/models/v2/treasury_rate_info.rb,
lib/brapi/models/income_statement_entry.rb,
lib/brapi/models/available_list_response.rb,
lib/brapi/models/quote_retrieve_response.rb,
lib/brapi/models/v2/fii_dividends_response.rb,
lib/brapi/models/v2/treasury_list_response.rb,
lib/brapi/models/v2/fii_historical_response.rb,
lib/brapi/models/v2/fii_indicators_response.rb,
lib/brapi/models/v2/macro_retrieve_response.rb,
lib/brapi/models/v2/crypto_retrieve_response.rb,
lib/brapi/models/v2/currency_retrieve_response.rb,
lib/brapi/models/v2/inflation_retrieve_response.rb,
lib/brapi/models/v2/prime_rate_retrieve_response.rb,
lib/brapi/models/v2/treasury_indicators_response.rb,
lib/brapi/models/v2/macro_list_available_response.rb,
lib/brapi/models/v2/crypto_list_available_response.rb,
lib/brapi/models/v2/currency_list_available_response.rb,
lib/brapi/models/v2/inflation_list_available_response.rb,
lib/brapi/models/v2/prime_rate_list_available_response.rb

Defined Under Namespace

Modules: Models, Resources Classes: AuthenticationError, BadRequestError, Client, Configuration, ConnectionError, Error, Model, NotFoundError, PaymentRequiredError, PermissionDeniedError, RateLimitError, Resource, ServerError

Constant Summary

ERROR_BY_STATUS =

{
  400 => BadRequestError,
  401 => AuthenticationError,
  402 => PaymentRequiredError,
  403 => PermissionDeniedError,
  404 => NotFoundError,
  429 => RateLimitError
}.freeze

VERSION =

"0.4.0"

Class Method Summary

• .available ⇒ Object
• .client ⇒ Object
• .configuration ⇒ Object
• .configure {|configuration| ... } ⇒ Object
• .quote ⇒ Object
• .reset_client! ⇒ Object
• .reset_configuration! ⇒ Object
• .v2 ⇒ Object

Class Method Details

.available ⇒ Object

# File 'lib/brapi.rb', line 109

def available
  client.available
end

.client ⇒ Object

# File 'lib/brapi.rb', line 97

def client
  @client ||= Client.new
end

.configuration ⇒ Object

# File 'lib/brapi.rb', line 84

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:

• (configuration)

# File 'lib/brapi.rb', line 88

def configure
  yield(configuration)
end

.quote ⇒ Object

# File 'lib/brapi.rb', line 105

def quote
  client.quote
end

.reset_client! ⇒ Object

# File 'lib/brapi.rb', line 101

def reset_client!
  @client = nil
end

.reset_configuration! ⇒ Object

# File 'lib/brapi.rb', line 92

def reset_configuration!
  @configuration = Configuration.new
  @client = nil
end

.v2 ⇒ Object

# File 'lib/brapi.rb', line 113

def v2
  client.v2
end