Class: Ipregistry::Models::Base

Inherits:

Object

• Object
• Ipregistry::Models::Base

Defined in:

lib/ipregistry/models/base.rb

Overview

Base class for all response models. Wraps the decoded JSON hash and exposes convenient readers declared with a small class-level DSL.

Direct Known Subclasses

Carrier, Company, Connection, Continent, Country, Currency, CurrencyFormat, CurrencyFormatAffix, Flag, IpInfo, Language, Location, Region, Security, TimeZone, UserAgent, UserAgentDevice, UserAgentEngine, UserAgentOperatingSystem

Instance Method Summary

• #==(other) ⇒ Object (also: #eql?)
• #[](key) ⇒ Object

  Raw access to any field of the payload, including ones without a dedicated reader.

• #hash ⇒ Object
• #initialize(data = {}) ⇒ Base constructor

  A new instance of Base.

• #inspect ⇒ Object
• #to_h ⇒ Hash

  The raw decoded payload backing this model.

Constructor Details

#initialize(data = {}) ⇒ Base

Returns a new instance of Base.

Parameters:

• data (Hash, nil) (defaults to: {}) —

  the decoded JSON payload

# File 'lib/ipregistry/models/base.rb', line 14

def initialize(data = {})
  @data = data.is_a?(Hash) ? data : {}
end

Instance Method Details

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

# File 'lib/ipregistry/models/base.rb', line 30

def ==(other)
  other.instance_of?(self.class) && other.to_h == @data
end

#[](key) ⇒ Object

Raw access to any field of the payload, including ones without a dedicated reader.

# File 'lib/ipregistry/models/base.rb', line 26

def [](key)
  @data[key.to_s]
end

#hash ⇒ Object

# File 'lib/ipregistry/models/base.rb', line 35

def hash
  [self.class, @data].hash
end

#inspect ⇒ Object

# File 'lib/ipregistry/models/base.rb', line 39

def inspect
  "#<#{self.class.name} #{@data.inspect}>"
end

#to_h ⇒ Hash

The raw decoded payload backing this model.

Returns:

• (Hash)

# File 'lib/ipregistry/models/base.rb', line 20

def to_h
  @data
end