geocoder-olleh 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: beddb48bf5e2d6be49933a3c6f6ea2b05ff968c7
-  data.tar.gz: 9485bb8561762d4922ab66b0177a204ea35ca470
+  metadata.gz: d2afc3e7667878e6845e61eba31f0281ad67c123
+  data.tar.gz: 306fa16f547805908e9976878b9de9a7d0e1e7c9
 SHA512:
-  metadata.gz: 35157961515bad6c9be77d6ec788f2276a57e7869bd261ec587d9b4672a2e931dd9ed709b8d12a37f349a7611bc609e6b2186a2aeb422d3974a6ae4e06a87a3f
-  data.tar.gz: 37cd32862b1a257b6940015ca3d5cefa927c052490c6162c0f0221b040a0ca2d529893dbfdfb8d25e5c40623eddebbda2d6aa6563ff4ae415867e1670477d40f
+  metadata.gz: f16ad4659d8e5dc909eaa4d0bba1f5c03878f0e4245ea17bb98e9af49f950508c7c97bbabfa759191168977fea4154e2c400c77639ac72f1968379705cb4c4d5
+  data.tar.gz: e148fbf059d6726aef6587351876686962ae4775802e8ec3006b574173527c97ccce516a7a349d2b2933f286dc74847cf1c8f4217428b9370dbb3d91fffcb3bc

data/km2_LocalSearch.md

@@ -0,0 +1,74 @@
+## Way to send out - valid request
+
+* Request URL : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22UTF-8_Address%22,%22s%22=%22AN%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+
+* "s"="AN" : Return both of old and new addresses
+* "sr":"RANK" : Give high priority to the accuracy
+* "places":"5" : Number of address that want to get returned
+* "option":"2" : Distance based result alignment from current location
+* "isaddr":"0", "isaddr":"1" : Search from address DB or not (0 : No, 1 : Yes)
+
+## Search queries from end users
+
+1) POI search
+
+* KeyWord1 : 국민은행
+* KeyWord2 : 서울 국민은행
+* KeyWord3 : 서초동 강남미래타워
+
+- Valid query1 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EA%25B5%25AD%25EB%25AF%25BC%25EC%259D%2580%25ED%2596%2589%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+- Valid query2 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EC%2584%259C%25EC%259A%25B8+%25EA%25B5%25AD%25EB%25AF%25BC%25EC%259D%2580%25ED%2596%2589%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+- Valid query3 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EC%2584%259C%25EC%25B4%2588%25EB%258F%2599+%25EA%25B0%2595%25EB%2582%25A8%25EB%25AF%25B8%25EB%259E%2598%25ED%2583%2580%25EC%259B%258C%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+
+2) Old address search (With Gibun or without Gibun)
+
+* KeyWord1 : 삼평동
+* KeyWord2 : 삼평동 689
+* KeyWord3 : 분당구 689
+* KeyWord4 : 분당구 삼평동 689
+* KeyWord5 : 성남시 분당구 삼평동 689
+* KeyWord6 : 경기 성남시 분당구 삼평동 689
+* KeyWord7 : 경기도 성남시 분당구 삼평동 689
+
+- Valid query1 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EC%2582%25BC%25ED%258F%2589%25EB%258F%2599%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+- Valid query2 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EC%2582%25BC%25ED%258F%2589%25EB%258F%2599+689%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+- Valid query3 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EB%25B6%2584%25EB%258B%25B9%25EA%25B5%25AC+689%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%221%22}`
+- Valid query4 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EB%25B6%2584%25EB%258B%25B9%25EA%25B5%25AC+%25EC%2582%25BC%25ED%258F%2589%25EB%258F%2599+689%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+- Valid query5 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EC%2584%25B1%25EB%2582%25A8%25EC%258B%259C+%25EB%25B6%2584%25EB%258B%25B9%25EA%25B5%25AC+%25EC%2582%25BC%25ED%258F%2589%25EB%258F%2599+689%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+- Valid query6 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EA%25B2%25BD%25EA%25B8%25B0+%25EC%2584%25B1%25EB%2582%25A8%25EC%258B%259C+%25EB%25B6%2584%25EB%258B%25B9%25EA%25B5%25AC+%25EC%2582%25BC%25ED%258F%2589%25EB%258F%2599+689%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+- Valid query7 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EA%25B2%25BD%25EA%25B8%25B0%25EB%258F%2584+%25EC%2584%25B1%25EB%2582%25A8%25EC%258B%259C+%25EB%25B6%2584%25EB%258B%25B9%25EA%25B5%25AC+%25EC%2582%25BC%25ED%258F%2589%25EB%258F%2599+689%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+
+3) New address search (With street number or without street number)
+
+* KeyWord1 : 사임당로
+* KeyWord2 : 사임당로 174
+* KeyWord3 : 서초구 사임당로 174
+* KeyWord4 : 서울 서초구 사임당로 174
+* KeyWord5 : 서울시 서초구 사임당로 174
+
+- Valid query1 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EC%2582%25AC%25EC%259E%2584%25EB%258B%25B9%25EB%25A1%259C%22,%22s%22=%22AN%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%221%22}`
+- Valid query2 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EC%2582%25AC%25EC%259E%2584%25EB%258B%25B9%25EB%25A1%259C+174%22,%22s%22=%22AN%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%221%22}`
+- Valid query3 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EC%2584%259C%25EC%25B4%2588%25EB%258F%2599+%25EC%2582%25AC%25EC%259E%2584%25EB%258B%25B9%25EB%25A1%259C+174%22,%22s%22=%22AN%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%221%22}`
+- Valid query4 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EC%2584%259C%25EC%259A%25B8+%25EC%2584%259C%25EC%25B4%2588%25EB%258F%2599+%25EC%2582%25AC%25EC%259E%2584%25EB%258B%25B9%25EB%25A1%259C+174%22,%22s%22=%22AN%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%221%22}`
+- Valid query5 : `http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22%25EC%2584%259C%25EC%259A%25B8%25EC%258B%259C+%25EC%2584%259C%25EC%25B4%2588%25EB%258F%2599+%25EC%2582%25AC%25EC%259E%2584%25EB%258B%25B9%25EB%25A1%259C+174%22,%22s%22=%22AN%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%221%22}`
+
+## Data to be taken
+
+* Old address : address from "ADDR" or "M_ADDR1" + "M_ADDR2"
+* New address : address from "NEW_ADDR"
+
+* Coordinates
+"Y":"1933916.06","H_CODE":"4113565500","X":"965566.75"
+
+* Procedure to query address
+
+Search address with "s"="AN" & "isaddr":"1"
+`http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22UTF-8_Address%22,%22s%22=%22AN%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%221%22}`
+
+Search address with "isaddr":"1"
+`http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22UTF-8_Address%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%221%22}`
+
+Search address with "isaddr":"0"
+`http://openapi.kt.com/maps/search/km2_LocalSearch?params={%22query%22:%22UTF-8_Address%22,%22sr%22:%22RANK%22,%22places%22:%225%22,%22option%22:%222%22,%22timestamp%22:%2220120413092033765%22,%22isaddr%22:%220%22}`
+
+If all above 3 returns no address it means there is no available results for the * keyword

data/lib/geocoder/lookups/olleh.rb

@@ -113,6 +113,8 @@ module Geocoder::Lookup
         'convert_coord'
       when options.include?(:l_code)
         'addr_step_search'
+      when options.include?(:places)
+        'addr_local_search'
       when options.include?(:radius)
         'addr_nearest_position_search'
       else
@@ -128,6 +130,7 @@ module Geocoder::Lookup
     def results(query)
       data = fetch_data(query)
       return [] unless data
+      return [] if data["error"]
       doc = JSON.parse(URI.decode(data["payload"]))
       if doc['ERRCD'] != nil && doc['ERRCD'] != 0
         Geocoder.log(:warn, "Olleh API error: #{doc['ERRCD']} (#{doc['ERRMS'] if doc['ERRMS']}).")
@@ -135,20 +138,23 @@ module Geocoder::Lookup
       end
 
       case Olleh.check_query_type(query)
-      when "geocoding"
+      when 'addr_local_search'
+        return [] if doc["RESULTDATA"]["place"]["TotalCount"].to_i == 0
+        return doc["RESULTDATA"]["place"]["Data"]
+      when 'geocoding'
         return [] if doc['RESDATA']['COUNT'] == 0
-        return doc['RESDATA']["ADDRS"]
-      when "reverse_geocoding"
+        return doc['RESDATA']['ADDRS']
+      when 'reverse_geocoding'
         return [] if doc['RESDATA']['COUNT'] == 0
-        return doc['RESDATA']["ADDRS"] || []
-      when "route_search"
-        return [] if doc["RESDATA"]["SROUTE"]["isRoute"] == "false"
-        return doc["RESDATA"] || []
-      when "convert_coord"
+        return doc['RESDATA']['ADDRS'] || []
+      when 'route_search'
+        return [] if doc['RESDATA']['SROUTE']['isRoute'] == 'false'
         return doc['RESDATA'] || []
-      when "addr_step_search"
+      when 'convert_coord'
+        return doc['RESDATA'] || []
+      when 'addr_step_search'
         return doc['RESULTDATA'] || []
-      when "addr_nearest_position_search"
+      when 'addr_nearest_position_search'
         return doc['RESULTDATA'] || []
       else
         []
@@ -157,6 +163,8 @@ module Geocoder::Lookup
 
     def base_url(query)
       case Olleh.check_query_type(query)
+      when "addr_local_search"
+        "https://openapi.kt.com/maps/search/km2_LocalSearch?params="
       when "route_search"
         "https://openapi.kt.com/maps/etc/RouteSearch?params="
       when "reverse_geocoding"
@@ -174,6 +182,18 @@ module Geocoder::Lookup
 
     def query_url_params(query)
       case Olleh.check_query_type(query)
+      when "addr_local_search"
+        # option 2 is for sorting results. we are using default.
+        # places is for number of results
+        # sr is for
+        # isaddr for searching address only. excluding building name, etc.
+        hash = {
+          query: URI.encode(query.text),
+          option: "1",
+          places: query.options[:places],
+          sr: query.options[:sr],
+          isaddr: "1"
+        }
       when "route_search"
         hash = {
           SX: query.options[:start_x],

data/lib/geocoder/olleh/version.rb

@@ -1,5 +1,5 @@
 module Geocoder
   module Olleh
-    VERSION = "0.2.3"
+    VERSION = "0.2.4"
   end
 end

data/lib/geocoder/results/olleh.rb

@@ -164,6 +164,38 @@ module Geocoder::Result
       "#{@data['SIDO']} #{@data['L_SIGUN_GU']} #{@data['L_DONG']} #{@data['GIBUN']}"
     end
 
+    ##
+    # addr used when we call km2_LocalSearch
+    # using old address system
+    def addr
+      @data["ADDR"].gsub("+", " ")
+    end
+
+    ##
+    # addr used when we call km2_LocalSearch
+    # using new address system
+    def new_addr
+      @data["NEW_ADDR"].gsub("+", " ")
+    end
+
+    ##
+    # NAME used when we call km2_LocalSearch
+    def name
+      @data["NAME"]
+    end
+
+    ##
+    # UTMK X coordinate used when we call km2_LocalSearch
+    def x
+      @data["X"]
+    end
+
+    ##
+    # UTMK Y coordinate used when we call km2_LocalSearch
+    def y
+      @data["Y"]
+    end
+
     response_attributes.each do |a|
       define_method a do
         @data[a]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder-olleh
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Jaigouk Kim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,6 +55,7 @@ files:
 - bin/console
 - bin/setup
 - geocoder-olleh.gemspec
+- km2_LocalSearch.md
 - lib/geocoder/lookups/olleh.rb
 - lib/geocoder/olleh.rb
 - lib/geocoder/olleh/lookup.rb