Updated tests and docs for ISP

Author: oschwald

README.rst

@@ -97,9 +97,32 @@ Web Service Example
     >>> response.location.longitude
     -93.2323
 
+Web Service Client Exceptions
+-----------------------------
+
+For details on the possible errors returned by the web service itself, see
+http://dev.maxmind.com/geoip/geoip2/web-services for the GeoIP2 web service
+docs.
+
+If the web service returns an explicit error document, this is thrown as a
+``AddressNotFoundError``, ``AuthenticationError``, ``InvalidRequestError``, or
+``OutOfQueriesError`` as appropriate. These all subclass ``GeoIP2Error``.
+
+If some other sort of error occurs, this is thrown as an ``HTTPError``. This
+is thrown when some sort of unanticipated error occurs, such as the web
+service returning a 500 or an invalid error document. If the web service
+returns any status code besides 200, 4xx, or 5xx, this also becomes an
+``HTTPError``.
+
+Finally, if the web service returns a 200 but the body is invalid, the client
+throws a ``GeoIP2Error``.
+
 Database Example
 -------------------
 
+City Database
+^^^^^^^^^^^^^
+
 .. code-block:: pycon
 
     >>> import geoip2.database
@@ -134,26 +157,65 @@ Database Example
     44.9733
     >>> response.location.longitude
     -93.2323
+    >>> reader.close()
 
-Web Service Client Exceptions
------------------------------
+Connection-Type Database
+^^^^^^^^^^^^^^^^^^^^^^^^
 
-For details on the possible errors returned by the web service itself, see
-http://dev.maxmind.com/geoip/geoip2/web-services for the GeoIP2 web service
-docs.
+    >>> import geoip2.database
+    >>>
+    >>> # This creates a Reader object. You should use the same object
+    >>> # across multiple requests as creation of it is expensive.
+    >>> reader = geoip2.database.Reader('/path/to/GeoIP2-Connection-Type.mmdb')
+    >>>
+    >>> response = reader.connection_type('128.101.101.101')
+    >>>
+    >>> response.connection_type
+    'Corporate'
+    >>> response.ip_address
+    '128.101.101.101'
+    >>> reader.close()
 
-If the web service returns an explicit error document, this is thrown as a
-``AddressNotFoundError``, ``AuthenticationError``, ``InvalidRequestError``, or
-``OutOfQueriesError`` as appropriate. These all subclass ``GeoIP2Error``.
 
-If some other sort of error occurs, this is thrown as an ``HTTPError``. This
-is thrown when some sort of unanticipated error occurs, such as the web
-service returning a 500 or an invalid error document. If the web service
-returns any status code besides 200, 4xx, or 5xx, this also becomes an
-``HTTPError``.
+Domain Database
+^^^^^^^^^^^^^^^
 
-Finally, if the web service returns a 200 but the body is invalid, the client
-throws a ``GeoIP2Error``.
+    >>> import geoip2.database
+    >>>
+    >>> # This creates a Reader object. You should use the same object
+    >>> # across multiple requests as creation of it is expensive.
+    >>> reader = geoip2.database.Reader('/path/to/GeoIP2-Domain.mmdb')
+    >>>
+    >>> response = reader.domain('128.101.101.101')
+    >>>
+    >>> response.domain
+    'umn.edu'
+    >>> response.ip_address
+    '128.101.101.101'
+    >>> reader.close()
+
+ISP Database
+^^^^^^^^^^^^
+
+    >>> import geoip2.database
+    >>>
+    >>> # This creates a Reader object. You should use the same object
+    >>> # across multiple requests as creation of it is expensive.
+    >>> reader = geoip2.database.Reader('/path/to/GeoIP2-ISP.mmdb')
+    >>>
+    >>> response = reader.isp('1.128.0.0')
+    >>>
+    >>> response.autonomous_system_number
+    1221
+    >>> response.autonomous_system_organization
+    'Telstra Pty Ltd'
+    >>> response.isp
+    'Telstra Internet'
+    >>> response.organization
+    'Telstra Internet'
+    >>> response.ip_address
+    '128.101.101.101'
+    >>> reader.close()
 
 Database Reader Exceptions
 --------------------------

geoip2/database.py

@@ -109,15 +109,15 @@ def domain(self, ip_address):
         """
         return self._flat_model_for(geoip2.models.Domain, ip_address)
 
-    def isp_org(self, ip_address):
-        """Get the ISPOrg object for the IP address
+    def isp(self, ip_address):
+        """Get the ISP object for the IP address
 
         :param ip_address: IPv4 or IPv6 address as a string.
 
-        :returns: :py:class:`geoip2.models.ISPOrg` object
+        :returns: :py:class:`geoip2.models.ISP` object
 
         """
-        return self._flat_model_for(geoip2.models.ISPOrg, ip_address)
+        return self._flat_model_for(geoip2.models.ISP, ip_address)
 
     def _get(self, ip_address):
         record = self._db_reader.get(ip_address)

geoip2/models.py

@@ -358,9 +358,9 @@ def __init__(self, raw):
         self.raw = raw
 
 
-class ISPOrg(object):
+class ISP(object):
 
-    """Model class for the GeoIP2 ISP-Org
+    """Model class for the GeoIP2 ISP
 
     This class provides the following attribute:
 

tests/data

@@ -82,16 +82,17 @@ def test_domain(self):
 
         reader.close()
 
-    def test_isp_org(self):
+    def test_isp(self):
         reader = geoip2.database.Reader(
-            'tests/data/test-data/GeoIP2-ISP-Org-Test.mmdb')
+            'tests/data/test-data/GeoIP2-ISP-Test.mmdb')
 
-        ip_address = '2001:1700::'
-        record = reader.isp_org(ip_address)
-        self.assertEqual(record.autonomous_system_number, 6730)
+        ip_address = '1.128.0.0'
+        record = reader.isp(ip_address)
+        self.assertEqual(record.autonomous_system_number, 1221)
         self.assertEqual(record.autonomous_system_organization,
-                         'Sunrise Communications AG')
-        # XXX - Add org/isp when available
+                         'Telstra Pty Ltd')
+        self.assertEqual(record.isp, 'Telstra Internet')
+        self.assertEqual(record.organization, 'Telstra Internet')
         self.assertEqual(record.ip_address, ip_address)
 
         reader.close()