Back to Repositories

Testing OpenCage Data Geocoding Integration in geocoder

This test suite validates the OpenCage Data geocoding service integration within the Geocoder gem. It covers address lookup, reverse geocoding, and error handling functionality through comprehensive unit tests.

Test Coverage Overview

The test suite provides thorough coverage of OpenCage Data API functionality, including address component extraction, viewport handling, and coordinate-based searches.

Address component validation and formatting
Viewport coordinate verification
Query URL parameter handling
Reverse geocoding capabilities
Timezone data retrieval

Implementation Analysis

The testing approach follows Ruby unit testing best practices, utilizing the GeocoderTestCase framework for consistent test organization. The implementation employs setup methods for configuration and API key management, with isolated test cases for each feature.

Key patterns include:

Individual test methods for distinct functionality
Query URL validation
Error state handling
Response parsing verification

Technical Details

Testing infrastructure includes:

Ruby test framework with GeocoderTestCase extension
OpenCage Data API integration
Configuration management for API keys
HTTP request/response handling
UTF-8 encoding support

Best Practices Demonstrated

The test suite exemplifies high-quality testing practices through comprehensive error handling, edge case coverage, and clear test organization.

Systematic API response validation
Explicit error condition testing
Clear test method naming
Modular test case organization
Proper setup and teardown management

alexreisner/geocoder

test/unit/lookups/opencagedata_test.rb

            
# encoding: utf-8
require 'test_helper'

class OpencagedataTest < GeocoderTestCase

  def setup
    super
    Geocoder.configure(lookup: :opencagedata)
    set_api_key!(:opencagedata)
  end

  def test_result_components
    result = Geocoder.search("Madison Square Garden, New York, NY").first
    assert_equal "West 31st Street", result.street
    assert_match(/46, West 31st Street, Koreatown, New York County, 10011, New York City, New York, United States of America/, result.address)

  end

  def test_opencagedata_viewport
    result = Geocoder.search("Madison Square Garden, New York, NY").first
    assert_equal [40.7498531, -73.9944444, 40.751161, -73.9925922],
      result.viewport
  end

  def test_opencagedata_query_url_contains_bounds
    lookup = Geocoder::Lookup::Opencagedata.new
    url = lookup.query_url(Geocoder::Query.new(
      "Some street",
      :bounds => [[40.0, -120.0], [39.0, -121.0]]
    ))
    assert_match(/bounds=40.0+%2C-120.0+%2C39.0+%2C-121.0+/, url)
  end

  def test_opencagedata_query_url_contains_optional_params
    lookup = Geocoder::Lookup::Opencagedata.new
    url = lookup.query_url(Geocoder::Query.new(
      "Some street",
      :countrycode => 'fr',
      :min_confidence => 5,
      :no_dedupe => 1,
      :no_annotations => 1,
      :no_record => 1,
      :limit => 2
    ))
    assert_match(/countrycode=fr/, url)
    assert_match(/min_confidence=5/, url)
    assert_match(/no_dedupe=1/, url)
    assert_match(/no_annotations=1/, url)
    assert_match(/no_record=1/, url)
    assert_match(/limit=2/, url)
  end

  def test_no_results
    results = Geocoder.search("no results")
    assert_equal 0, results.length
  end


  def test_opencagedata_reverse_url
    query = Geocoder::Query.new([45.423733, -75.676333])
    assert_match(/\bq=45.423733%2C-75.676333\b/, query.url)
  end

  def test_opencagedata_time_zone
    result = Geocoder.search("Madison Square Garden, New York, NY").first
    assert_equal "America/New_York", result.time_zone
  end

  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
end