cartodb/services/geocoder/spec/hires_geocoder_spec.rb

require 'tmpdir'
require 'fileutils'
require 'csv'
require_relative '../../../spec/rspec_configuration'
require_relative '../../../spec/spec_helper'
require_relative '../lib/hires_geocoder'


describe CartoDB::HiresGeocoder do

  MOCK_COORDINATES = [38.89037, -77.03196]

  RSpec.configure do |config|
    config.before :each do
      Typhoeus::Expectation.clear
    end
  end

  before(:each) do
    @working_dir = Dir.mktmpdir
    @input_csv_file = path_to '../../table-geocoder/spec/fixtures/nokia_input.csv'
    @log = mock
    @log.stubs(:append)
    @log.stubs(:append_and_store)
    CartoDB::HiresGeocoder.any_instance.stubs(:config).returns({
        'non_batch_base_url' => 'batch.example.com',
        'app_id' => '',
        'token' => '',
        'mailto' => ''
      })
    @geocoding_model = FactoryGirl.create(:geocoding, kind: 'high-resolution', formatter: '{street}')
    @geocoder = CartoDB::HiresGeocoder.new(@input_csv_file, @working_dir, @log, @geocoding_model)
  end

  after(:each) do
    FileUtils.rm_f @working_dir
  end

  describe '#run' do
    it 'takes every row from input and calls geocode_text on them' do
      rows_to_geocode = ::CSV.read(@input_csv_file, headers: true).length
      @geocoder.expects(:geocode_text).times(rows_to_geocode).returns(MOCK_COORDINATES)
      @geocoder.run
      @geocoder.status.should == 'completed'
    end
  end

  describe '#process_row' do
    it 'increments the number of processed rows by one when called' do
      output_csv_mock = mock
      output_csv_mock.expects(:add_row).once
      input_row = {'searchtext' => 'olakase'}
      @geocoder.expects(:geocode_text).once.returns(MOCK_COORDINATES)
      @geocoder.processed_rows.should == 0
      @geocoder.send(:process_row, input_row, output_csv_mock)
      @geocoder.processed_rows.should == 1
    end

    it 'adds a row with the expected format when success' do
      output_csv_mock = mock
      output_csv_mock.expects(:add_row).once.with ['olakase', 1, 1, MOCK_COORDINATES[0], MOCK_COORDINATES[1]]
      input_row = {'searchtext' => 'olakase'}
      @geocoder.expects(:geocode_text).once.returns(MOCK_COORDINATES)
      @geocoder.send(:process_row, input_row, output_csv_mock)
    end

    it 'does not add any row when it when geolocation fails' do
      output_csv_mock = mock
      output_csv_mock.expects(:add_row).never
      input_row = {'searchtext' => 'olakase'}
      @geocoder.expects(:geocode_text).once.returns([nil, nil])
      @geocoder.send(:process_row, input_row, output_csv_mock)
    end

  end

  describe '#geocode_text' do
    it 'sends a request to the non-batched geocoder service and gets a couple of coordinates' do
      json_response_body = {
        response: {
          view: [
            result: [
              location: {
                displayPosition: {
                  latitude: MOCK_COORDINATES[0],
                  longitude: MOCK_COORDINATES[1]
                }
              }
            ]
          ]
        }
      }.to_json
      mocked_response  = Typhoeus::Response.new(code: 200, body: json_response_body)
      Typhoeus.stub(//, method: :get).and_return(mocked_response)

      @geocoder.send(:geocode_text, 'Dummy address').should == MOCK_COORDINATES
    end

    it "returns nil coordinates if the http request doesn't succeed" do
      mocked_response  = Typhoeus::Response.new(code: 500)
      Typhoeus.stub(//, method: :get).and_return(mocked_response)
      CartoDB.expects(:notify_debug).with('Non-batched geocoder failed request', mocked_response).once

      @geocoder.send(:geocode_text, 'Dummy address').should == [nil, nil]
    end

    it 'returns nil coordinates and log a trace if it is not able to parse the response' do
      input_text = 'Dummy address'
      json_response_body = {
        unexpected: 'this response body has unexpected format for whatever reason'
      }.to_json
      mocked_response  = Typhoeus::Response.new(code: 200, body: json_response_body)
      Typhoeus.stub(//, method: :get).and_return(mocked_response)
      CartoDB.expects(:notify_debug).with("Non-batched geocoder couldn't parse response", anything()).once

      @geocoder.send(:geocode_text, input_text).should == [nil, nil]
    end

    it 'returns nil coordinates and stops there if the response does not contain any location' do
      input_text = 'Dummy address'
      json_response_body = '{"response":{"metaInfo":{"timestamp":"2015-07-14T15:33:35.023+0000"},"view":[]}}'
      mocked_response  = Typhoeus::Response.new(code: 200, body: json_response_body)
      Typhoeus.stub(//, method: :get).and_return(mocked_response)

      @geocoder.send(:geocode_text, input_text).should == [nil, nil]
    end
  end

  def path_to(filepath = '')
    File.expand_path(
      File.join(File.dirname(__FILE__), "../fixtures/#{filepath}")
      )
  end

end