Merge pull request #690 from mtmail/opencagedata-overlimittest

Opencagedata: additional tests

lib/geocoder/lookups/opencagedata.rb

@@ -18,14 +18,27 @@ module Geocoder::Lookup
 
     private
 
-    def valid_response?(response)
-      status = parse_json(response.body)["status"]
-      super(response) and status['message'] == 'OK'
-    end
-
     def results(query)
-      data = fetch_data(query)
-      (data && data['results']) || []
+      return [] unless doc = fetch_data(query)
+      # return doc["results"]
+      
+      messages = doc['status']['message']
+      case doc['status']['code']
+      when 400 # Error with input
+        raise_error(Geocoder::InvalidRequest, messages) ||
+          warn("Opencagedata Geocoding API error: #{messages}")
+      when 403 # Key related error
+        raise_error(Geocoder::InvalidApiKey, messages) ||
+          warn("Opencagedata Geocoding API error: #{messages}")
+      when 402 # Quata Exceeded
+          raise_error(Geocoder::OverQueryLimitError, messages) ||
+          warn("Opencagedata Geocoding API error: #{messages}")
+      when 500 # Unknown error
+        raise_error(Geocoder::Error, messages) ||
+          warn("Opencagedata Geocoding API error: #{messages}")
+      end
+
+      return doc["results"]
     end
 
     def query_url_params(query)

test/fixtures/opencagedata_invalid_api_key

+{
+    "licenses": [
+        {
+            "name": "CC-BY-SA",
+            "url": "http://creativecommons.org/licenses/by-sa/3.0/"
+        },
+        {
+            "name": "ODbL",
+            "url": "http://opendatacommons.org/licenses/odbl/summary/"
+        }
+    ],
+    "results": [ ],
+    "status": {
+        "code": 403,
+        "message": "invalid API key"
+    },
+    "thanks": "For using an OpenCage Data API",
+    "timestamp": {
+        "created_http": "Thu, 07 Aug 2014 14:26:28 GMT",
+        "created_unix": 1407421588
+    },
+    "total_results": 0,
+    "we_are_hiring": "http://lokku.com/#jobs"
+
+}
\ No newline at end of file

test/fixtures/opencagedata_invalid_request

+{
+
+    "licenses": [
+        {
+            "name": "CC-BY-SA",
+            "url": "http://creativecommons.org/licenses/by-sa/3.0/"
+        },
+        {
+            "name": "ODbL",
+            "url": "http://opendatacommons.org/licenses/odbl/summary/"
+        }
+    ],
+    "results": [ ],
+    "status": {
+        "code": 400,
+        "message": "Attribute (format) does not pass the type constraint because: not a valid format"
+    },
+    "thanks": "For using an OpenCage Data API",
+    "timestamp": {
+        "created_http": "Thu, 07 Aug 2014 14:27:29 GMT",
+        "created_unix": 1407421649
+    },
+    "total_results": 0,
+    "we_are_hiring": "http://lokku.com/#jobs"
+
+}
\ No newline at end of file

test/fixtures/opencagedata_over_limit

+{
+
+    "licenses": [
+        {
+            "name": "CC-BY-SA",
+            "url": "http://creativecommons.org/licenses/by-sa/3.0/"
+        },
+        {
+            "name": "ODbL",
+            "url": "http://opendatacommons.org/licenses/odbl/summary/"
+        }
+    ],
+    "rate": {
+        "limit": 1,
+        "remaining": 0,
+        "reset": null
+    },
+    "results": [ ],
+    "status": {
+        "code": 402,
+        "message": "quota exceeded"
+    },
+    "thanks": "For using an OpenCage Data API",
+    "timestamp": {
+        "created_http": "Thu, 07 Aug 2014 13:59:19 GMT",
+        "created_unix": 1407419959
+    },
+    "total_results": 0,
+    "we_are_hiring": "http://lokku.com/#jobs"
+
+}
\ No newline at end of file

test/unit/lookups/opencagedata_test.rb

@@ -39,12 +39,26 @@ class OpencagedataTest < GeocoderTestCase
 
 
 
+  def test_raises_exception_when_invalid_request
+    Geocoder.configure(always_raise: [Geocoder::InvalidRequest])
+    assert_raises Geocoder::InvalidRequest do
+      Geocoder.search("invalid request")
+    end
+  end
+
+  def test_raises_exception_when_invalid_api_key
+    Geocoder.configure(always_raise: [Geocoder::InvalidApiKey])
+    assert_raises Geocoder::InvalidApiKey do
+      Geocoder.search("invalid api key")
+    end
+  end
 
-  # def test_raises_exception_when_over_query_limit
-  #   Geocoder.configure(:always_raise => [Geocoder::OverQueryLimitError])
-  #   l = Geocoder::Lookup.get(:opencagedata)
-  #   assert_raises Geocoder::OverQueryLimitError do
-  #     l.send(:results, Geocoder::Query.new("over limit"))
-  #   end
-  # end
+
+  def test_raises_exception_when_over_query_limit
+    Geocoder.configure(:always_raise => [Geocoder::OverQueryLimitError])
+    l = Geocoder::Lookup.get(:opencagedata)
+    assert_raises Geocoder::OverQueryLimitError do
+      l.send(:results, Geocoder::Query.new("over limit"))
+    end
+  end
 end