Class: MaxMind::GeoIP2::Record::Traits

Inherits:
Abstract
  • Object
show all
Defined in:
lib/maxmind/geoip2/record/traits.rb

Overview

Contains data for the traits record associated with an IP address.

This record is returned by all location services and databases.

Instance Method Summary collapse

Instance Method Details

#anonymous? ⇒ Boolean

This is true if the IP address belongs to any sort of anonymous network. This property is only available from Insights.

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 80

def anonymous?
  get('is_anonymous')
end

#anonymous_vpn? ⇒ Boolean

This is true if the IP address is registered to an anonymous VPN provider. If a VPN provider does not register subnets under names associated with them, we will likely only flag their IP ranges using the hosting_provider? property. This property is only available from Insights.

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 90

def anonymous_vpn?
  get('is_anonymous_vpn')
end

#anycast? ⇒ Boolean

This is true if the IP address belongs to an anycast network.

This property is only available from the Country, City Plus, and Insights web services and the GeoIP2 Country, City, and Enterprise databases.

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 102

def anycast?
  get('is_anycast')
end

#autonomous_system_number ⇒ Integer?

The autonomous system number associated with the IP address. See Wikipedia. This attribute is only available from the City Plus and Insights web services and the Enterprise database.

Returns:

  • (Integer, nil) 


29
30
31
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 29

def autonomous_system_number
  get('autonomous_system_number')
end

#autonomous_system_organization ⇒ String?

The organization associated with the registered autonomous system number for the IP address. See Wikipedia. This attribute is only available from the City Plus and Insights web services and the Enterprise database.

Returns:

  • (String, nil) 


40
41
42
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 40

def autonomous_system_organization
  get('autonomous_system_organization')
end

#connection_type ⇒ String?

The connection type may take the following values: “Dialup”, “Cable/DSL”, “Corporate”, “Cellular”, and “Satellite”. Additional values may be added in the future. This attribute is only available from the City Plus and Insights web services and the Enterprise database.

Returns:

  • (String, nil) 


51
52
53
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 51

def connection_type
  get('connection_type')
end

#domain ⇒ String?

The second level domain associated with the IP address. This will be something like “example.com” or “example.co.uk”, not “foo.example.com”. This attribute is only available from the City Plus and Insights web services and the Enterprise database.

Returns:

  • (String, nil) 


61
62
63
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 61

def domain
  get('domain')
end

#hosting_provider? ⇒ Boolean

This is true if the IP address belongs to a hosting or VPN provider (see description of the anonymous_vpn? property). This property is only available from Insights.

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 111

def hosting_provider?
  get('is_hosting_provider')
end

#ip_address ⇒ String?

The IP address that the data in the model is for. If you performed a “me” lookup against the web service, this will be the externally routable IP address for the system the code is running on. If the system is behind a NAT, this may differ from the IP address locally assigned to it. This attribute is returned by all end points.

Returns:

  • (String, nil) 


72
73
74
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 72

def ip_address
  get('ip_address')
end

#isp ⇒ String?

The name of the ISP associated with the IP address. This attribute is only available from the City Plus and Insights web services and the Enterprise database.

Returns:

  • (String, nil) 


176
177
178
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 176

def isp
  get('isp')
end

#legitimate_proxy? ⇒ Boolean

This attribute is true if MaxMind believes this IP address to be a legitimate proxy, such as an internal VPN used by a corporation. This attribute is only available in the Enterprise database.

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 120

def legitimate_proxy?
  get('is_legitimate_proxy')
end

#mobile_country_code ⇒ String?

The mobile country code (MCC) associated with the IP address and ISP.

This attribute is only available from the City Plus and Insights web services and the Enterprise database.

Returns:

  • (String, nil) 


131
132
133
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 131

def mobile_country_code
  get('mobile_country_code')
end

#mobile_network_code ⇒ String?

The mobile network code (MNC) associated with the IP address and ISP.

This attribute is only available from the City Plus and Insights web services and the Enterprise database.

Returns:

  • (String, nil) 


142
143
144
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 142

def mobile_network_code
  get('mobile_network_code')
end

#network ⇒ String?

The network in CIDR notation associated with the record. In particular, this is the largest network where all of the fields besides ip_address have the same value.

Returns:

  • (String, nil) 


185
186
187
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 185

def network
  get('network')
end

#organization ⇒ String?

The name of the organization associated with the IP address. This attribute is only available from the City Plus and Insights web services and the Enterprise database.

Returns:

  • (String, nil) 


194
195
196
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 194

def organization
  get('organization')
end

#public_proxy? ⇒ Boolean

This is true if the IP address belongs to a public proxy. This property is only available from Insights.

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 150

def public_proxy?
  get('is_public_proxy')
end

#residential_proxy? ⇒ Boolean

This is true if the IP address is on a suspected anonymizing network and belongs to a residential ISP. This property is only available from Insights.

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 159

def residential_proxy?
  get('is_residential_proxy')
end

#static_ip_score ⇒ Float?

An indicator of how static or dynamic an IP address is. This property is only available from Insights.

Returns:

  • (Float, nil) 


202
203
204
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 202

def static_ip_score
  get('static_ip_score')
end

#tor_exit_node? ⇒ Boolean

This is true if the IP address is a Tor exit node. This property is only available from Insights.

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 167

def tor_exit_node?
  get('is_tor_exit_node')
end

#user_count ⇒ Integer?

The estimated number of users sharing the IP/network during the past 24 hours. For IPv4, the count is for the individual IP. For IPv6, the count is for the /64 network. This property is only available from Insights.

Returns:

  • (Integer, nil) 


211
212
213
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 211

def user_count
  get('user_count')
end

#user_type ⇒ String?

The user type associated with the IP address. This can be one of the following values:

  • business

  • cafe

  • cellular

  • college

  • consumer_privacy_network

  • content_delivery_network

  • dialup

  • government

  • hosting

  • library

  • military

  • residential

  • router

  • school

  • search_engine_spider

  • traveler

This attribute is only available from the Insights web service and the Enterprise database.

Returns:

  • (String, nil) 


239
240
241
 
# File 'lib/maxmind/geoip2/record/traits.rb', line 239

def user_type
  get('user_type')
end