alexreisner/geocoder

View on GitHub
lib/geocoder/lookups/freegeoip.rb

Summary

Maintainability
A
0 mins
Test Coverage
require 'geocoder/lookups/base'
require 'geocoder/results/freegeoip'

module Geocoder::Lookup
  class Freegeoip < Base

    def name
      "FreeGeoIP"
    end

    def supported_protocols
      if configuration[:host]
        [:https]
      else
        # use https for default host
        [:https]
      end
    end

    private # ---------------------------------------------------------------

    def base_query_url(query)
      "#{protocol}://#{host}/json/#{query.sanitized_text}?"
    end

    def query_url_params(query)
      {
        :apikey => configuration.api_key
      }.merge(super)
    end

    def parse_raw_data(raw_data)
      raw_data.match(/^<html><title>404/) ? nil : super(raw_data)
    end

    def results(query)
      # don't look up a loopback or private address, just return the stored result
      return [reserved_result(query.text)] if query.internal_ip_address?
      # note: Freegeoip.net returns plain text "Not Found" on bad request
      (doc = fetch_data(query)) ? [doc] : []
    end

    def reserved_result(ip)
      {
        "ip"           => ip,
        "city"         => "",
        "region_code"  => "",
        "region_name"  => "",
        "metro_code"    => "",
        "zip_code"      => "",
        "latitude"     => "0",
        "longitude"    => "0",
        "country_name" => "Reserved",
        "country_code" => "RD"
      }
    end

    def host
      configuration[:host] || "freegeoip.app"
    end
  end
end