Class: Brapi::Model

Inherits:

Object

• Object
• Brapi::Model

Defined in:

lib/brapi/model.rb

Direct Known Subclasses

Brapi::Models::AvailableListResponse, Brapi::Models::BalanceSheetEntry, Brapi::Models::CashDividend, Brapi::Models::CashflowEntry, Brapi::Models::DividendsData, Brapi::Models::FinancialDataEntry, Brapi::Models::HistoricalDataPrice, Brapi::Models::IncomeStatementEntry, Brapi::Models::KeyStatisticsEntry, Brapi::Models::Quote, Brapi::Models::QuoteListItem, Brapi::Models::QuoteListResponse, Brapi::Models::QuoteRetrieveResponse, Brapi::Models::StockDividend, Brapi::Models::Subscription, Brapi::Models::SummaryProfile, Brapi::Models::V2::Crypto, Brapi::Models::V2::CryptoListAvailableResponse, Brapi::Models::V2::CryptoRetrieveResponse, Brapi::Models::V2::Currency, Brapi::Models::V2::CurrencyListAvailableResponse, Brapi::Models::V2::CurrencyRetrieveResponse, Brapi::Models::V2::InflationEntry, Brapi::Models::V2::InflationListAvailableResponse, Brapi::Models::V2::InflationRetrieveResponse, Brapi::Models::V2::PrimeRateEntry, Brapi::Models::V2::PrimeRateListAvailableResponse, Brapi::Models::V2::PrimeRateRetrieveResponse, Brapi::Models::ValueAddedEntry

Instance Attribute Summary

• #raw ⇒ Object readonly

  Returns the value of attribute raw.

Class Method Summary

• .attribute(name, type: nil, json_key: nil) ⇒ Object
• .attribute_specs ⇒ Object
• .camelize(snake) ⇒ Object
• .from_h(value) ⇒ Object

Instance Method Summary

• #==(other) ⇒ Object (also: #eql?)
• #[](name) ⇒ Object
• #hash ⇒ Object
• #initialize(hash = {}) ⇒ Model constructor

  A new instance of Model.

• #to_h ⇒ Object

Constructor Details

#initialize(hash = {}) ⇒ Model

Returns a new instance of Model.

# File 'lib/brapi/model.rb', line 34

def initialize(hash = {})
  hash ||= {}
  hash = hash.transform_keys(&:to_s) if hash.respond_to?(:transform_keys)
  @raw = hash
  self.class.attribute_specs.each do |name, spec|
    value = hash[spec[:json_key]]
    value = hash[name.to_s] if value.nil?
    instance_variable_set("@#{name}", coerce(value, spec[:type]))
  end
end

Instance Attribute Details

#raw ⇒ Object (readonly)

Returns the value of attribute raw.

# File 'lib/brapi/model.rb', line 65

def raw
  @raw
end

Class Method Details

.attribute(name, type: nil, json_key: nil) ⇒ Object

# File 'lib/brapi/model.rb', line 8

def attribute(name, type: nil, json_key: nil)
  attr_reader name

  attribute_specs[name] = { type: type, json_key: json_key&.to_s || camelize(name.to_s) }
end

.attribute_specs ⇒ Object

# File 'lib/brapi/model.rb', line 14

def attribute_specs
  @attribute_specs ||= begin
    parent = superclass.respond_to?(:attribute_specs) ? superclass.attribute_specs : {}
    parent.dup
  end
end

.camelize(snake) ⇒ Object

# File 'lib/brapi/model.rb', line 28

def camelize(snake)
  head, *rest = snake.split("_")
  ([head] + rest.map(&:capitalize)).join
end

.from_h(value) ⇒ Object

# File 'lib/brapi/model.rb', line 21

def from_h(value)
  return nil if value.nil?
  return value if value.is_a?(self)

  new(value)
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?

# File 'lib/brapi/model.rb', line 56

def ==(other)
  other.is_a?(self.class) && other.to_h == to_h
end

#[](name) ⇒ Object

# File 'lib/brapi/model.rb', line 52

def [](name)
  public_send(name) if respond_to?(name)
end

#hash ⇒ Object

# File 'lib/brapi/model.rb', line 61

def hash
  to_h.hash
end

#to_h ⇒ Object

# File 'lib/brapi/model.rb', line 45

def to_h
  self.class.attribute_specs.each_with_object({}) do |(name, _), h|
    value = public_send(name)
    h[name] = serialize(value)
  end
end