Exception: Ably::Exceptions::BaseAblyException

Inherits:

StandardError

• Object
• StandardError
• Ably::Exceptions::BaseAblyException

Defined in:

lib/ably/exceptions.rb

Overview

Base Ably exception class that contains status and code values used by Ably Refer to github.com/ably/ably-common/blob/master/protocol/errors.json

Direct Known Subclasses

ChannelInactive, CipherError, ConnectionError, EncoderError, ForbiddenRequest, IncompatibleClientId, InsecureRequest, InvalidRequest, InvalidResponseBody, InvalidState, InvalidStateChange, InvalidTokenRequest, MessageDeliveryFailed, MessageQueueingDisabled, PageMissing, ProtocolError, ResourceMissing, ServerError, Standard, TokenExpired, TokenRequestFailed, UnauthorizedRequest, UnsupportedDataType, Models::ErrorInfo

Instance Attribute Summary

• #code ⇒ String readonly

  Ably specific error code.

• #message ⇒ String readonly

  Error message from Ably.

• #status ⇒ String readonly

  HTTP status code of error.

Instance Method Summary

• #as_json(*args) ⇒ Object
• #initialize(message, status = nil, code = nil, base_exception = nil, options = {}) ⇒ BaseAblyException constructor

  A new instance of BaseAblyException.

• #to_s ⇒ Object

Constructor Details

#initialize(message, status = nil, code = nil, base_exception = nil, options = {}) ⇒ BaseAblyException

# File 'lib/ably/exceptions.rb', line 18

def initialize(message, status = nil, code = nil, base_exception = nil, options = {})
  super message

  @base_exception = base_exception
  @status = status
  @status ||= base_exception.status if base_exception && base_exception.respond_to?(:status)
  @status ||= options[:fallback_status]
  @code = code
  @code ||= base_exception.code if base_exception && base_exception.respond_to?(:code)
  @code ||= options[:fallback_code]
end

Instance Attribute Details

#code ⇒ String (readonly)

# File 'lib/ably/exceptions.rb', line 15

class BaseAblyException < StandardError
  attr_reader :status, :code

  def initialize(message, status = nil, code = nil, base_exception = nil, options = {})
    super message

    @base_exception = base_exception
    @status = status
    @status ||= base_exception.status if base_exception && base_exception.respond_to?(:status)
    @status ||= options[:fallback_status]
    @code = code
    @code ||= base_exception.code if base_exception && base_exception.respond_to?(:code)
    @code ||= options[:fallback_code]
  end

  def to_s
    message = [super]
    if status || code
      additional_info = []
      additional_info << "code: #{code}" if code
      additional_info << "http status: #{status}" if status
      additional_info << "base exception: #{@base_exception.class}" if @base_exception
      message << "(#{additional_info.join(', ')})"
    end
    message.join(' ')
  end

  def as_json(*args)
    {
      message: "#{self.class}: #{message}",
      status: @status,
      code: @code
    }.delete_if { |key, val| val.nil? }
  end
end

#message ⇒ String (readonly)

# File 'lib/ably/exceptions.rb', line 15

class BaseAblyException < StandardError
  attr_reader :status, :code

  def initialize(message, status = nil, code = nil, base_exception = nil, options = {})
    super message

    @base_exception = base_exception
    @status = status
    @status ||= base_exception.status if base_exception && base_exception.respond_to?(:status)
    @status ||= options[:fallback_status]
    @code = code
    @code ||= base_exception.code if base_exception && base_exception.respond_to?(:code)
    @code ||= options[:fallback_code]
  end

  def to_s
    message = [super]
    if status || code
      additional_info = []
      additional_info << "code: #{code}" if code
      additional_info << "http status: #{status}" if status
      additional_info << "base exception: #{@base_exception.class}" if @base_exception
      message << "(#{additional_info.join(', ')})"
    end
    message.join(' ')
  end

  def as_json(*args)
    {
      message: "#{self.class}: #{message}",
      status: @status,
      code: @code
    }.delete_if { |key, val| val.nil? }
  end
end

#status ⇒ String (readonly)

# File 'lib/ably/exceptions.rb', line 15

class BaseAblyException < StandardError
  attr_reader :status, :code

  def initialize(message, status = nil, code = nil, base_exception = nil, options = {})
    super message

    @base_exception = base_exception
    @status = status
    @status ||= base_exception.status if base_exception && base_exception.respond_to?(:status)
    @status ||= options[:fallback_status]
    @code = code
    @code ||= base_exception.code if base_exception && base_exception.respond_to?(:code)
    @code ||= options[:fallback_code]
  end

  def to_s
    message = [super]
    if status || code
      additional_info = []
      additional_info << "code: #{code}" if code
      additional_info << "http status: #{status}" if status
      additional_info << "base exception: #{@base_exception.class}" if @base_exception
      message << "(#{additional_info.join(', ')})"
    end
    message.join(' ')
  end

  def as_json(*args)
    {
      message: "#{self.class}: #{message}",
      status: @status,
      code: @code
    }.delete_if { |key, val| val.nil? }
  end
end

Instance Method Details

#as_json(*args) ⇒ Object

# File 'lib/ably/exceptions.rb', line 42

def as_json(*args)
  {
    message: "#{self.class}: #{message}",
    status: @status,
    code: @code
  }.delete_if { |key, val| val.nil? }
end

#to_s ⇒ Object

# File 'lib/ably/exceptions.rb', line 30

def to_s
  message = [super]
  if status || code
    additional_info = []
    additional_info << "code: #{code}" if code
    additional_info << "http status: #{status}" if status
    additional_info << "base exception: #{@base_exception.class}" if @base_exception
    message << "(#{additional_info.join(', ')})"
  end
  message.join(' ')
end