Class: Retailer::CostcoApi::Result

Inherits:

Data

• Object
• Data
• Retailer::CostcoApi::Result

Defined in:

app/services/retailer/costco_api.rb

Overview

Outcome of a probe.

Instance Attribute Summary

• #available ⇒ Boolean^? readonly

  In-stock flag; nil when inventory is unknown.

• #currency ⇒ String^? readonly

  ISO currency code.

• #error ⇒ String^? readonly

  Failure description.

• #price ⇒ Float^? readonly

  Current online price.

• #regular_price ⇒ Float^? readonly

  Pre-discount list price, when higher than price.

• #success ⇒ Boolean readonly

  Whether a price was retrieved.

Instance Method Summary

• #initialize(success:, price: nil, currency: nil, regular_price: nil, available: nil, error: nil) ⇒ Result constructor

  A new instance of Result.

• #success? ⇒ Boolean

Constructor Details

#initialize(success:, price: nil, currency: nil, regular_price: nil, available: nil, error: nil) ⇒ Result

Returns a new instance of Result.

# File 'app/services/retailer/costco_api.rb', line 51

def initialize(success:, price: nil, currency: nil, regular_price: nil, available: nil, error: nil)
  super
end

Instance Attribute Details

#available ⇒ Boolean^? (readonly)

Returns in-stock flag; nil when inventory is unknown.

Returns:

• (Boolean, nil) —

  in-stock flag; nil when inventory is unknown

# File 'app/services/retailer/costco_api.rb', line 50

Result = Data.define(:success, :price, :currency, :regular_price, :available, :error) do
  def initialize(success:, price: nil, currency: nil, regular_price: nil, available: nil, error: nil)
    super
  end

  def success? = success
end

#currency ⇒ String^? (readonly)

Returns ISO currency code.

Returns:

• (String, nil) —

  ISO currency code

# File 'app/services/retailer/costco_api.rb', line 50

Result = Data.define(:success, :price, :currency, :regular_price, :available, :error) do
  def initialize(success:, price: nil, currency: nil, regular_price: nil, available: nil, error: nil)
    super
  end

  def success? = success
end

#error ⇒ String^? (readonly)

Returns failure description.

Returns:

• (String, nil) —

  failure description

# File 'app/services/retailer/costco_api.rb', line 50

Result = Data.define(:success, :price, :currency, :regular_price, :available, :error) do
  def initialize(success:, price: nil, currency: nil, regular_price: nil, available: nil, error: nil)
    super
  end

  def success? = success
end

#price ⇒ Float^? (readonly)

Returns current online price.

Returns:

• (Float, nil) —

  current online price

# File 'app/services/retailer/costco_api.rb', line 50

Result = Data.define(:success, :price, :currency, :regular_price, :available, :error) do
  def initialize(success:, price: nil, currency: nil, regular_price: nil, available: nil, error: nil)
    super
  end

  def success? = success
end

#regular_price ⇒ Float^? (readonly)

Returns pre-discount list price, when higher than price.

Returns:

• (Float, nil) —

  pre-discount list price, when higher than price

# File 'app/services/retailer/costco_api.rb', line 50

Result = Data.define(:success, :price, :currency, :regular_price, :available, :error) do
  def initialize(success:, price: nil, currency: nil, regular_price: nil, available: nil, error: nil)
    super
  end

  def success? = success
end

#success ⇒ Boolean (readonly)

Returns whether a price was retrieved.

Returns:

• (Boolean) —

  whether a price was retrieved

# File 'app/services/retailer/costco_api.rb', line 50

Result = Data.define(:success, :price, :currency, :regular_price, :available, :error) do
  def initialize(success:, price: nil, currency: nil, regular_price: nil, available: nil, error: nil)
    super
  end

  def success? = success
end

Instance Method Details

#success? ⇒ Boolean

Returns:

• (Boolean)

# File 'app/services/retailer/costco_api.rb', line 55

def success? = success