Doc and tests updates

Author: oschwald

geoip2/models.py

@@ -21,13 +21,18 @@ class Country(object):
 
     :ivar continent: :py:class:`geoip2.records.Continent` object
       representing continent data for the requested IP address.
-    :ivar country: :py:class:`geoip2.recordsCountry` object representing
+    :ivar country: :py:class:`geoip2.records.Country` object representing
       country data for the requested IP address. This record represents the
       country where MaxMind believes the IP is located in.
-    :ivar registered_country: :py:class:`geoip2.recordsCountry` object
+    :ivar registered_country: :py:class:`geoip2.records.Country` object
       representing the registered country data for the requested IP address.
       This record represents the country where the ISP has registered a given
       IP block in and may differ from the user's country.
+    :ivar represented_country: :py:class:`geoip2.records.RepresentedCountry`
+      object containing details about the country represented by the users
+      of the IP address when that country is different than the country in
+      ``county``. For instance, the country represented by an
+      overseas military base or embassy.
     :ivar traits: :py:class:`geoip2.records.Traits` object representing
       the traits for the request IP address.
 
@@ -45,6 +50,11 @@ def __init__(self, raw_response, languages=None):
             geoip2.records.Country(languages,
                                    **raw_response.get('registered_country',
                                                       {}))
+        self.represented_country = \
+            geoip2.records.RepresentedCountry(languages,
+                                   **raw_response.get('represented_country',
+                                                      {}))
+
         self.traits = geoip2.records.Traits(**raw_response.get('traits', {}))
         self.raw = raw_response
 
@@ -56,17 +66,22 @@ class City(Country):
       country data for the requested IP address.
     :ivar continent: :py:class:`geoip2.records.Continent` object
       representing continent data for the requested IP address.
-    :ivar country: :py:class:`geoip2.recordsCountry` object representing
+    :ivar country: :py:class:`geoip2.records.Country` object representing
       country data for the requested IP address. This record represents the
       country where MaxMind believes the IP is located in.
     :ivar location: :py:class:`geoip2.records.Location` object
       representing country data for the requested IP address.
     :ivar region: :py:class:`geoip2.records.Region` object representing
       country data for the requested IP address.
-    :ivar registered_country: :py:class:`geoip2.recordsCountry` object
+    :ivar registered_country: :py:class:`geoip2.records.Country` object
       representing the registered country data for the requested IP address.
       This record represents the country where the ISP has registered a given
       IP block in and may differ from the user's country.
+    :ivar represented_country: :py:class:`geoip2.records.RepresentedCountry`
+      object containing details about the country represented by the users
+      of the IP address when that country is different than the country in
+      ``county``. For instance, the country represented by an
+      overseas military base or embassy.
     :ivar traits: :py:class:`geoip2.records.Traits` object representing
       the traits for the request IP address.
 
@@ -91,17 +106,22 @@ class CityISPOrg(City):
       country data for the requested IP address.
     :ivar continent: :py:class:`geoip2.records.Continent` object
       representing continent data for the requested IP address.
-    :ivar country: :py:class:`geoip2.recordsCountry` object representing
+    :ivar country: :py:class:`geoip2.records.Country` object representing
       country data for the requested IP address. This record represents the
       country where MaxMind believes the IP is located in.
     :ivar location: :py:class:`geoip2.records.Location` object
       representing country data for the requested IP address.
     :ivar region: :py:class:`geoip2.records.Region` object representing
       country data for the requested IP address.
-    :ivar registered_country: :py:class`geoip2.recordsCountry` object
+    :ivar registered_country: :py:class`geoip2.records.Country` object
       representing the registered country data for the requested IP address.
       This record represents the country where the ISP has registered a given
       IP block in and may differ from the user's country.
+    :ivar represented_country: :py:class:`geoip2.records.RepresentedCountry`
+      object containing details about the country represented by the users
+      of the IP address when that country is different than the country in
+      ``county``. For instance, the country represented by an
+      overseas military base or embassy.
     :ivar traits: :py:class:`geoip2.records.Traits` object representing
       the traits for the request IP address.
 
@@ -115,17 +135,22 @@ class Omni(CityISPOrg):
       country data for the requested IP address.
     :ivar continent: :py:class:`geoip2.records.Continent` object
       representing continent data for the requested IP address.
-    :ivar country: :py:class:`geoip2.recordsCountry` object representing
+    :ivar country: :py:class:`geoip2.records.Country` object representing
       country data for the requested IP address. This record represents the
       country where MaxMind believes the IP is located in.
     :ivar location: :py:class:`geoip2.records.Location` object
       representing country data for the requested IP address.
     :ivar region: :py:class:`geoip2.records.Region` object representing
       country data for the requested IP address.
-    :ivar registered_country: :py:class:`geoip2.recordsCountry` object
+    :ivar registered_country: :py:class:`geoip2.records.Country` object
       representing the registered country data for the requested IP address.
       This record represents the country where the ISP has registered a given
       IP block in and may differ from the user's country.
+    :ivar represented_country: :py:class:`geoip2.records.RepresentedCountry`
+      object containing details about the country represented by the users
+      of the IP address when that country is different than the country in
+      ``county``. For instance, the country represented by an
+      overseas military base or embassy.
     :ivar traits: :py:class:`geoip2.records.Traits` object representing
       the traits for the request IP address.
 

tests/models_test.py

@@ -65,6 +65,12 @@ def test_omni_full(self):
                 'iso_code': 'CA',
                 'names': {'en': 'Canada'},
                 },
+            'represented_country': {
+                'geoname_id': 3,
+                'iso_code': 'GB',
+                'names': {'en': 'United Kingdom'},
+                'type': 'military',
+                },
             'traits': {
                 'autonomous_system_number': 1234,
                 'autonomous_system_organization': 'AS Organization',
@@ -91,6 +97,9 @@ def test_omni_full(self):
         self.assertEqual(type(model.registered_country),
                          geoip2.records.Country,
                          'geoip2.records.Country object')
+        self.assertEqual(type(model.represented_country),
+                         geoip2.records.RepresentedCountry,
+                         'geoip2.records.RepresentedCountry object')
         self.assertEqual(type(model.location), geoip2.records.Location,
                          'geoip2.records.Location object')
         self.assertEqual(type(model.subdivisions[0]),
@@ -111,6 +120,13 @@ def test_omni_full(self):
                          'div 2 has correct name')
         self.assertEqual(model.subdivisions.most_specific.iso_code, 'HP',
                           'subdivisions.most_specific returns HP')
+        self.assertEqual(model.represented_country.name,
+                         'United Kingdom',
+                         'represented_country name is correct')
+        self.assertEqual(model.represented_country.type,
+                         'military',
+                         'represented_country type is correct')
+
 
     def test_omni_min(self):
         model = geoip2.models.Omni({'traits': {'ip_address': '5.6.7.8'}})