location guessing system

Author: Duc Anh Nguyen

app/extensions/abbreviation_extension.rb

@@ -38,7 +38,7 @@ def encode_region_24HoursForecast(location)
     end
 
     def decode_region_24HoursForecast(location)
-      location[2,5].capitalize
+      location[2, 5].capitalize
     end
 
     def get_forecast_meaning(abbreviation)

app/extensions/wit_extension.rb

@@ -33,7 +33,15 @@ def initialize
           entities = request['entities']
 
           location = first_entity_value(entities, 'location') || context['location']
-          intent = first_entity_value(entities, 'intent') || context['intent']
+          # intent = first_entity_value(entities, 'intent') || context['intent']
+
+          known_location = KnownLocation.get_known_location(location, 'location')
+          if known_location
+            location = known_location
+          else
+            location = KnownLocation.guess_known_location(location, 'location')
+            context['guess_location'] = location
+          end
 
           if location
             forecast = search_forecast(location)
@@ -57,7 +65,15 @@ def initialize
           entities = request['entities']
 
           location = first_entity_value(entities, 'location') || context['location']
-          intent = first_entity_value(entities, 'intent') || context['intent']
+          # intent = first_entity_value(entities, 'intent') || context['intent']
+
+          known_location = KnownLocation.get_known_location(location, 'region')
+          if known_location
+            location = known_location
+          else
+            location = KnownLocation.guess_known_location(location, 'region')
+            context['guess_location'] = location
+          end
 
           if location
             context['24HoursForecast'] = search_24HoursForecast(location)
@@ -76,7 +92,15 @@ def initialize
           entities = request['entities']
 
           location = first_entity_value(entities, 'location') || context['location']
-          intent = first_entity_value(entities, 'intent') || context['intent']
+          # intent = first_entity_value(entities, 'intent') || context['intent']
+
+          known_location = KnownLocation.get_known_location(location, 'region')
+          if known_location
+            location = known_location
+          else
+            location = KnownLocation.guess_known_location(location, 'region')
+            context['guess_location'] = location
+          end
 
           if location
             hour_psi = search_hour_psi(location)

app/models/known_location.rb

@@ -1,15 +1,50 @@
+# frozen_string_literal: true
+require 'fuzzystringmatch'
+
 class KnownLocation
   include Mongoid::Document
+  before_save :name_downcase
+
   field :name, type: String
   field :type, type: String
   field :lat, type: Float
   field :lon, type: Float
 
   validates_uniqueness_of :name
 
-  def self.known_region?(location)
+  def name_downcase
+    self.name = name.downcase
+  end
+
+  def self.get_known_location(location, type)
+    return nil if location.blank?
+
+    regex_str = Regexp.new(location.downcase)
+    known_location = KnownLocation.where(name: regex_str, type: type).first
+    if known_location.present?
+      return known_location.name.capitalize
+    else
+      return nil
+    end
   end
 
-  def self.known_location?(location)
+  def self.guess_known_location(location, type)
+    return nil if location.blank?
+
+    jarow = FuzzyStringMatch::JaroWinkler.create(:native)
+
+    location = location.downcase
+    known_locations = KnownLocation.where(type: type).only(:name).pluck(:name)
+    known_locations_with_distance = {}
+    known_locations.each do |known_location|
+      known_locations_with_distance[known_location] = jarow.getDistance(known_location, location)
+    end
+
+    known_location = known_locations_with_distance.max_by { |_name, distance| distance }
+    if known_location[1] < 0.7
+      return nil
+    else
+      return known_location[0].capitalize
+    end
   end
 end

app/models/message.rb

@@ -11,14 +11,14 @@ class Message
   belongs_to :conversation
 
   validates_inclusion_of :kind, in: %w(outgoing incoming), allow_nil: false
-  validates :conversation, :presence => true
+  validates :conversation, presence: true
 
   def digest
-    if self.quick_replies.present?
+    if quick_replies.present?
       quick_replies = self.quick_replies.map { |qr| { title: qr.title, content_type: qr.content_type, payload: qr.payload } }
     end
 
-    if /FACEBOOK_TEMPLATE_LIST/ === self.body
+    if /FACEBOOK_TEMPLATE_LIST/ === body
       body = self.body
       body.slice!('FACEBOOK_TEMPLATE_LIST:')
       reponse_message = JSON.parse(body)
@@ -29,7 +29,7 @@ def digest
       }
     end
 
-    deliver(reponse_message, self.conversation.uid)
+    deliver(reponse_message, conversation.uid)
   end
 
   private

db/seeds.rb

@@ -1,8 +1,55 @@
 # frozen_string_literal: true
-# This file should contain all the record creation needed to seed the database with its default values.
-# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
-#
-# Examples:
-#
-#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
-#   Character.create(name: 'Luke', movie: movies.first)
+KnownLocation.create(lat: 1.375, lon: 103.839, name: 'ang mo kio', type: 'location')
+KnownLocation.create(lat: 1.321, lon: 103.924, name: 'bedok', type: 'location')
+KnownLocation.create(lat: 1.350772, lon: 103.839, name: 'bishan', type: 'location')
+KnownLocation.create(lat: 1.304, lon: 103.701, name: 'boon lay', type: 'location')
+KnownLocation.create(lat: 1.353, lon: 103.754, name: 'bukit batok', type: 'location')
+KnownLocation.create(lat: 1.277, lon: 103.819, name: 'bukit merah', type: 'location')
+KnownLocation.create(lat: 1.362, lon: 103.77195, name: 'bukit panjang', type: 'location')
+KnownLocation.create(lat: 1.325, lon: 103.791, name: 'bukit timah', type: 'location')
+KnownLocation.create(lat: 1.38, lon: 103.805, name: 'central water catchment', type: 'location')
+KnownLocation.create(lat: 1.357, lon: 103.987, name: 'changi', type: 'location')
+KnownLocation.create(lat: 1.377, lon: 103.745, name: 'choa chu kang', type: 'location')
+KnownLocation.create(lat: 1.315, lon: 103.76, name: 'clementi', type: 'location')
+KnownLocation.create(lat: 1.292, lon: 103.844, name: 'city', type: 'location')
+KnownLocation.create(lat: 1.318, lon: 103.884, name: 'geylang', type: 'location')
+KnownLocation.create(lat: 1.361218, lon: 103.886, name: 'hougang', type: 'location')
+KnownLocation.create(lat: 1.347, lon: 103.67, name: 'jalan bahar', type: 'location')
+KnownLocation.create(lat: 1.326, lon: 103.737, name: 'jurong east', type: 'location')
+KnownLocation.create(lat: 1.266, lon: 103.699, name: 'jurong island', type: 'location')
+KnownLocation.create(lat: 1.34039, lon: 103.705, name: 'jurong west', type: 'location')
+KnownLocation.create(lat: 1.312, lon: 103.862, name: 'kallang', type: 'location')
+KnownLocation.create(lat: 1.423, lon: 103.717332, name: 'lim chu kang', type: 'location')
+KnownLocation.create(lat: 1.419, lon: 103.812, name: 'mandai', type: 'location')
+KnownLocation.create(lat: 1.297, lon: 103.891, name: 'marine parade', type: 'location')
+KnownLocation.create(lat: 1.327, lon: 103.826, name: 'novena', type: 'location')
+KnownLocation.create(lat: 1.37, lon: 103.948, name: 'pasir ris', type: 'location')
+KnownLocation.create(lat: 1.358, lon: 103.914, name: 'paya lebar', type: 'location')
+KnownLocation.create(lat: 1.315, lon: 103.675, name: 'pioneer', type: 'location')
+KnownLocation.create(lat: 1.403, lon: 104.053, name: 'pulau tekong', type: 'location')
+KnownLocation.create(lat: 1.404, lon: 103.96, name: 'pulau ubin', type: 'location')
+KnownLocation.create(lat: 1.401, lon: 103.904, name: 'punggol', type: 'location')
+KnownLocation.create(lat: 1.291, lon: 103.78576, name: 'queenstown', type: 'location')
+KnownLocation.create(lat: 1.404, lon: 103.869, name: 'seletar', type: 'location')
+KnownLocation.create(lat: 1.445, lon: 103.818495, name: 'sembawang', type: 'location')
+KnownLocation.create(lat: 1.384, lon: 103.891443, name: 'sengkang', type: 'location')
+KnownLocation.create(lat: 1.243, lon: 103.832, name: 'sentosa', type: 'location')
+KnownLocation.create(lat: 1.357, lon: 103.865, name: 'serangoon', type: 'location')
+KnownLocation.create(lat: 1.208, lon: 103.842, name: 'southern islands', type: 'location')
+KnownLocation.create(lat: 1.413, lon: 103.756, name: 'sungei kadut', type: 'location')
+KnownLocation.create(lat: 1.345, lon: 103.944, name: 'tampines', type: 'location')
+KnownLocation.create(lat: 1.308, lon: 103.813, name: 'tanglin', type: 'location')
+KnownLocation.create(lat: 1.374, lon: 103.715, name: 'tengah', type: 'location')
+KnownLocation.create(lat: 1.334304, lon: 103.856327, name: 'toa payoh', type: 'location')
+KnownLocation.create(lat: 1.294947, lon: 103.635, name: 'tuas', type: 'location')
+KnownLocation.create(lat: 1.205926, lon: 103.746, name: 'western islands', type: 'location')
+KnownLocation.create(lat: 1.405, lon: 103.689, name: 'western water catchment', type: 'location')
+KnownLocation.create(lat: 1.432, lon: 103.786528, name: 'woodlands', type: 'location')
+KnownLocation.create(lat: 1.418, lon: 103.839, name: 'yishun', type: 'location')
+KnownLocation.create(lat: nil, lon: nil, name: 'north', type: 'region')
+KnownLocation.create(lat: nil, lon: nil, name: 'south', type: 'region')
+KnownLocation.create(lat: nil, lon: nil, name: 'east', type: 'region')
+KnownLocation.create(lat: nil, lon: nil, name: 'west', type: 'region')
+KnownLocation.create(lat: nil, lon: nil, name: 'center', type: 'region')
+KnownLocation.create(lat: nil, lon: nil, name: 'centre', type: 'region')
+KnownLocation.create(lat: nil, lon: nil, name: 'central', type: 'region')

test/models/known_location_test.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class KnownLocationTest < ActiveSupport::TestCase