Merge pull request #3 from Ziptastic/develop

Add reverse geocoding ability.

Author: daspecster

ziptastic/tests.py

@@ -3,11 +3,12 @@
 from nose.tools import eq_
 from json import loads
 
-from .ziptastic import Ziptastic
+from .ziptastic import Ziptastic, ZiptasticAPIKeyRequiredException
 
-compare_v3_json = """[{"city": "Owosso", "country": "US",
-    "county": "Shiawassee", "state": "Michigan", "state_short": "MI",
-    "postal_code": "48867"}]"""
+compare_v3_json = """[{"city": "Owosso", "geohash": "dpshsfsytw8k",
+    "country": "US", "county": "Shiawassee", "state": "Michigan",
+    "state_short": "MI", "postal_code": "48867", "latitude": 42.9934,
+    "longitude": -84.1595, "timezone": "America/Detroit"}]"""
 
 compare_v2_json = """{"city": "Owosso", "country": "US",
     "county": "Shiawassee", "state": "Michigan", "state_short": "MI",
@@ -40,6 +41,31 @@ def test_get_from_v2_postal_code(self, m):
         eq_(url, req.url)
         eq_(loads(compare_v2_json), result)
 
+    @requests_mock.mock()
+    def test_reverse_geocoding(self, m):
+        latitude = '42.9934'
+        longitude = '-84.1595'
+        url = 'https://zip.getziptastic.com/v3/' + latitude + '/' + longitude
+
+        m.get(url, text=compare_v3_json)
+        ziptastic = Ziptastic('abc123')
+        result = ziptastic.get_from_coordinates(latitude, longitude)
+
+        req = m.request_history[0]
+        eq_(url, req.url)
+        eq_(loads(compare_v3_json), result)
+
+    @requests_mock.mock()
+    def test_reverse_geocoding_api_key(self, m):
+        latitude = '42.9934'
+        longitude = '-84.1595'
+        url = 'https://zip.getziptastic.com/v3/' + latitude + '/' + longitude
+
+        m.get(url, text=compare_v3_json)
+        ziptastic = Ziptastic('')
+        self.assertRaises(ZiptasticAPIKeyRequiredException,
+                          ziptastic.get_from_coordinates, latitude, longitude)
+
     def test_build_url(self):
         version = 'v42'
         endpoint = 'test.endpoint'

ziptastic/ziptastic.py

@@ -1,6 +1,10 @@
 import requests
 
 
+class ZiptasticAPIKeyRequiredException(Exception):
+    pass
+
+
 class Ziptastic(object):
     """Ziptastic Python Module"""
 
@@ -40,3 +44,24 @@ def get_from_postal_code(self, postal_code, country='US'):
         r = requests.get(url, headers=headers)
 
         return r.json()
+
+    def get_from_coordinates(self, latitude, longitude):
+        """Get geo data from coordinates"""
+
+        headers = {}
+
+        #: If no api_key is set then default to Version 2 of Ziptastic API.
+        if self.api_key:
+            headers.update({
+                "x-key": self.api_key
+            })
+            uri = self.build_url(self.endpoint)
+        else:
+            raise ZiptasticAPIKeyRequiredException
+
+        url = "{uri}/{latitude}/{longitude}".format(uri=uri, latitude=latitude,
+                                                    longitude=longitude)
+
+        r = requests.get(url, headers=headers)
+
+        return r.json()