broken-geocoder 1.3.4

data/lib/geocoder/lookups/pelias.rb

@@ -0,0 +1,64 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/pelias'
+
+module Geocoder::Lookup
+  class Pelias < Base
+    def name
+      'Pelias'
+    end
+
+    def endpoint
+      configuration[:endpoint] || 'localhost'
+    end
+
+    def query_url(query)
+      query_type = query.reverse_geocode? ? 'reverse' : 'search'
+      "#{protocol}://#{endpoint}/v1/#{query_type}?" + url_query_string(query)
+    end
+
+    def required_api_key_parts
+      ['search-XXXX']
+    end
+
+    private
+
+    def query_url_params(query)
+      params = {
+        api_key: configuration.api_key,
+        size: 1
+      }.merge(super)
+
+      if query.reverse_geocode?
+        lat,lon = query.coordinates
+        params[:'point.lat'] = lat
+        params[:'point.lon'] = lon
+      else
+        params[:text] = query.text
+      end
+      params
+    end
+
+    def results(query)
+      return [] unless doc = fetch_data(query)
+
+      # not all responses include a meta
+      if doc['meta']
+        error = doc.fetch('results', {}).fetch('error', {})
+        message = error.fetch('type', 'Unknown Error') + ': ' + error.fetch('message', 'No message')
+        log_message = 'Pelias Geocoding API error - ' + message
+        case doc['meta']['status_code']
+          when '200'
+            # nothing to see here
+          when '403'
+            raise_error(Geocoder::RequestDenied, message) || Geocoder.log(:warn, log_message)
+          when '429'
+            raise_error(Geocoder::OverQueryLimitError, message) || Geocoder.log(:warn, log_message)
+          else
+            raise_error(Geocoder::Error, message) || Geocoder.log(:warn, log_message)
+        end
+      end
+
+      doc['features'] || []
+    end
+  end
+end

data/lib/geocoder/lookups/pointpin.rb

@@ -0,0 +1,68 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/pointpin'
+
+module Geocoder::Lookup
+  class Pointpin < Base
+
+    def name
+      "Pointpin"
+    end
+
+    def required_api_key_parts
+      ["key"]
+    end
+
+    def query_url(query)
+      "#{ protocol }://geo.pointp.in/#{ api_key }/json/#{ query.sanitized_text }"
+    end
+
+  private
+
+    def results(query)
+      # don't look up a loopback address, just return the stored result
+      return [] if query.loopback_ip_address?
+      doc = fetch_data(query)
+      if doc and doc.is_a?(Hash)
+        if !data_contains_error?(doc)
+          return [doc]
+        elsif doc['error']
+          case doc['error']
+          when "Invalid IP address"
+            raise_error(Geocoder::InvalidRequest) || Geocoder.log(:warn, "Invalid Pointpin request.")
+          when "Invalid API key"
+            raise_error(Geocoder::InvalidApiKey) || Geocoder.log(:warn, "Invalid Pointpin API key.")
+          when "Address not found"
+            Geocoder.log(:warn, "Address not found.")
+          end
+        else
+          raise_error(Geocoder::Error) || Geocoder.log(:warn, "Pointpin server error")
+        end
+      end
+      
+      return []
+    end
+
+    def data_contains_error?(parsed_data)
+      parsed_data.keys.include?('error')
+    end
+
+    def reserved_result(ip)
+      {
+        "ip"           => ip,
+        "city"         => "",
+        "region_code"  => "",
+        "region_name"  => "",
+        "metrocode"    => "",
+        "zipcode"      => "",
+        "latitude"     => "0",
+        "longitude"    => "0",
+        "country_name" => "Reserved",
+        "country_code" => "RD"
+      }
+    end
+
+    def api_key
+      configuration.api_key
+    end
+  end
+end

data/lib/geocoder/lookups/postcode_anywhere_uk.rb

@@ -0,0 +1,51 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/postcode_anywhere_uk'
+
+module Geocoder::Lookup
+  class PostcodeAnywhereUk < Base
+    # API documentation: http://www.postcodeanywhere.co.uk/Support/WebService/Geocoding/UK/Geocode/2/
+    BASE_URL_GEOCODE_V2_00 = 'services.postcodeanywhere.co.uk/Geocoding/UK/Geocode/v2.00/json.ws'
+    DAILY_LIMIT_EXEEDED_ERROR_CODES = ['8', '17'] # api docs say these two codes are the same error
+    INVALID_API_KEY_ERROR_CODE = '2'
+
+    def name
+      'PostcodeAnywhereUk'
+    end
+
+    def required_api_key_parts
+      %w(key)
+    end
+
+    def query_url(query)
+      format('%s://%s?%s', protocol, BASE_URL_GEOCODE_V2_00, url_query_string(query))
+    end
+
+    private
+
+    def results(query)
+      response = fetch_data(query)
+      return [] if response.nil? || !response.is_a?(Array) || response.empty?
+
+      raise_exception_for_response(response[0]) if response[0]['Error']
+      response
+    end
+
+    def raise_exception_for_response(response)
+      case response['Error']
+      when *DAILY_LIMIT_EXEEDED_ERROR_CODES
+        raise_error(Geocoder::OverQueryLimitError, response['Cause']) || Geocoder.log(:warn, response['Cause'])
+      when INVALID_API_KEY_ERROR_CODE
+        raise_error(Geocoder::InvalidApiKey, response['Cause']) || Geocoder.log(:warn, response['Cause'])
+      else # anything else just raise general error with the api cause
+        raise_error(Geocoder::Error, response['Cause']) || Geocoder.log(:warn, response['Cause'])
+      end
+    end
+
+    def query_url_params(query)
+      {
+        :location => query.sanitized_text,
+        :key => configuration.api_key
+      }.merge(super)
+    end
+  end
+end

data/lib/geocoder/lookups/smarty_streets.rb

@@ -0,0 +1,50 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/smarty_streets'
+
+module Geocoder::Lookup
+  class SmartyStreets < Base
+    def name
+      "SmartyStreets"
+    end
+
+    def required_api_key_parts
+      %w(auti-id auth-token)
+    end
+
+    def query_url(query)
+      path = zipcode_only?(query) ? "zipcode" : "street-address"
+      "#{protocol}://api.smartystreets.com/#{path}?#{url_query_string(query)}"
+    end
+
+    # required by API as of 26 March 2015
+    def supported_protocols
+      [:https]
+    end
+
+    private # ---------------------------------------------------------------
+
+    def zipcode_only?(query)
+      !query.text.is_a?(Array) and query.to_s.strip =~ /\A\d{5}(-\d{4})?\Z/
+    end
+
+    def query_url_params(query)
+      params = {}
+      if zipcode_only?(query)
+        params[:zipcode] = query.sanitized_text
+      else
+        params[:street] = query.sanitized_text
+      end
+      if configuration.api_key.is_a?(Array)
+        params[:"auth-id"] = configuration.api_key[0]
+        params[:"auth-token"] = configuration.api_key[1]
+      else
+        params[:"auth-token"] = configuration.api_key
+      end
+      params.merge(super)
+    end
+
+    def results(query)
+      fetch_data(query) || []
+    end
+  end
+end

data/lib/geocoder/lookups/telize.rb

@@ -0,0 +1,55 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/telize'
+
+module Geocoder::Lookup
+  class Telize < Base
+
+    def name
+      "Telize"
+    end
+
+    def required_api_key_parts
+      configuration[:host] ? [] : ["key"]
+    end
+
+    def query_url(query)
+      if configuration[:host]
+        "#{protocol}://#{configuration[:host]}/geoip/#{query.sanitized_text}"
+      else
+        "#{protocol}://telize-v1.p.mashape.com/geoip/#{query.sanitized_text}?mashape-key=#{api_key}"
+      end
+    end
+
+    def supported_protocols
+      [].tap do |array|
+        array << :https
+        array << :http if configuration[:host]
+      end
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query)
+      # don't look up a loopback address, just return the stored result
+      return [reserved_result(query.text)] if query.loopback_ip_address?
+      if (doc = fetch_data(query)).nil? or doc['code'] == 401 or empty_result?(doc)
+        []
+      else
+        [doc]
+      end
+    end
+
+    def empty_result?(doc)
+      !doc.is_a?(Hash) or doc.keys == ["ip"]
+    end
+
+    def reserved_result(ip)
+      {"message" => "Input string is not a valid IP address", "code" => 401}
+    end
+
+    def api_key
+      configuration.api_key
+    end
+    
+  end
+end

data/lib/geocoder/lookups/test.rb

@@ -0,0 +1,44 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/test'
+
+module Geocoder
+  module Lookup
+    class Test < Base
+
+      def name
+        "Test"
+      end
+
+      def self.add_stub(query_text, results)
+        stubs[query_text] = results
+      end
+
+      def self.set_default_stub(results)
+        @default_stub = results
+      end
+
+      def self.read_stub(query_text)
+        stubs.fetch(query_text) {
+          return @default_stub unless @default_stub.nil?
+          raise ArgumentError, "unknown stub request #{query_text}"
+        }
+      end
+
+      def self.stubs
+        @stubs ||= {}
+      end
+
+      def self.reset
+        @stubs = {}
+        @default_stub = nil
+      end
+
+      private
+
+      def results(query)
+        Geocoder::Lookup::Test.read_stub(query.text)
+      end
+
+    end
+  end
+end

data/lib/geocoder/lookups/yandex.rb

@@ -0,0 +1,58 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/yandex"
+
+module Geocoder::Lookup
+  class Yandex < Base
+
+    def name
+      "Yandex"
+    end
+
+    def map_link_url(coordinates)
+      "http://maps.yandex.ru/?ll=#{coordinates.reverse.join(',')}"
+    end
+
+    def query_url(query)
+      "#{protocol}://geocode-maps.yandex.ru/1.x/?" + url_query_string(query)
+    end
+    
+    def supported_protocols
+      [:https]
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      if err = doc['error']
+        if err["status"] == 401 and err["message"] == "invalid key"
+          raise_error(Geocoder::InvalidApiKey) || Geocoder.log(:warn, "Invalid API key.")
+        else
+          Geocoder.log(:warn, "Yandex Geocoding API error: #{err['status']} (#{err['message']}).")
+        end
+        return []
+      end
+      if doc = doc['response']['GeoObjectCollection']
+        meta = doc['metaDataProperty']['GeocoderResponseMetaData']
+        return meta['found'].to_i > 0 ? doc['featureMember'] : []
+      else
+        Geocoder.log(:warn, "Yandex Geocoding API error: unexpected response format.")
+        return []
+      end
+    end
+
+    def query_url_params(query)
+      if query.reverse_geocode?
+        q = query.coordinates.reverse.join(",")
+      else
+        q = query.sanitized_text
+      end
+      {
+        :geocode => q,
+        :format => "json",
+        :plng => "#{query.language || configuration.language}", # supports ru, uk, be
+        :key => configuration.api_key
+      }.merge(super)
+    end
+  end
+end

data/lib/geocoder/models/active_record.rb

@@ -0,0 +1,50 @@
+require 'geocoder/models/base'
+
+module Geocoder
+  module Model
+    module ActiveRecord
+      include Base
+
+      ##
+      # Set attribute names and include the Geocoder module.
+      #
+      def geocoded_by(address_attr, options = {}, &block)
+        geocoder_init(
+          :geocode       => true,
+          :user_address  => address_attr,
+          :latitude      => options[:latitude]  || :latitude,
+          :longitude     => options[:longitude] || :longitude,
+          :geocode_block => block,
+          :units         => options[:units],
+          :method        => options[:method],
+          :lookup        => options[:lookup],
+          :language      => options[:language]
+        )
+      end
+
+      ##
+      # Set attribute names and include the Geocoder module.
+      #
+      def reverse_geocoded_by(latitude_attr, longitude_attr, options = {}, &block)
+        geocoder_init(
+          :reverse_geocode => true,
+          :fetched_address => options[:address] || :address,
+          :latitude        => latitude_attr,
+          :longitude       => longitude_attr,
+          :reverse_block   => block,
+          :units           => options[:units],
+          :method          => options[:method],
+          :lookup          => options[:lookup],
+          :language        => options[:language]
+        )
+      end
+
+
+      private # --------------------------------------------------------------
+
+      def geocoder_file_name;   "active_record"; end
+      def geocoder_module_name; "ActiveRecord"; end
+    end
+  end
+end
+