minor code improvements and removing code that relies on our closed source geocoding module

Author: MattDunbar

app/code/community/Demac/MultiLocationInventory/Helper/Data.php

@@ -47,8 +47,6 @@ public function getRegions($countryCode)
     /**
      * Get latitude and longitude of an address and country.
      *
-     * Uses Demac_Geocoding library if it is available.
-     *
      * @param $postalCode
      * @param $country
      *
@@ -57,39 +55,30 @@ public function getRegions($countryCode)
      * @TODO Move to the location helper.
      * @TODO Isolate curl functionality so it is less exposed. (maybe use Zend_Http as part of this)
      * @TODO Come up with a better solution to sleep(1), at the very least sleep in microseconds.
-     * @TODO if we keep sleep related functionality add comments explaining that it is for the google api timeouts.
      */
     public function getLatLong($postalCode, $country)
     {
+        //This is used to avoid being rate limited by the google maps api.
         sleep(1);
         $postalCode = urlencode($postalCode);
         $country    = urlencode($country);
         $url        = "http://maps.google.com/maps/api/geocode/json?address=$postalCode&sensor=false&region=$country";
-        $ch         = curl_init();
-        curl_setopt($ch, CURLOPT_URL, $url);
-        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
-        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
-        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
-        $response = curl_exec($ch);
-        curl_close($ch);
-        $response_a = json_decode($response);
-
-        //@TODO handle invalid api responses that don't contain this element.
-        $lat  = $response_a->results[0]->geometry->location->lat;
-        $long = $response_a->results[0]->geometry->location->lng;
-
-        return array($lat, $long);
-    }
-
-    /**
-     * Checks if the Demac_Geocoding extension is available (recommended).
-     *
-     * @returns Boolean
-     * @TODO Move this to the Location helper.
-     */
-    public function geocodingAvailable()
-    {
-        return (bool) Mage::getModel('geocoding/geocode');
+        try {
+            $ch         = curl_init();
+            curl_setopt($ch, CURLOPT_URL, $url);
+            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
+            curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
+            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
+            $response = curl_exec($ch);
+            curl_close($ch);
+            $response_a = json_decode($response);
+            $lat  = $response_a->results[0]->geometry->location->lat;
+            $long = $response_a->results[0]->geometry->location->lng;
+            return array($lat, $long);
+        } catch (Exception $e) {
+            //@TODO return false and methods calling this to accept false as a response
+            return array(0, 0);
+        }
     }
 
 

app/code/community/Demac/MultiLocationInventory/Helper/Location.php

@@ -33,41 +33,6 @@ public function getClosestLocationWithProduct($customerCoordinates, $productId,
         return false;
     }
 
-    /**
-     * Finds the closest location to a postal code, with an optional list of locations to exclude.
-     *
-     * @param array $customerCoordinates The customer's location (array with 2 keys: latitude/longitude).
-     * @param array $excludes            Locations to exclude from the search (e.g. because we know they don't stock an item).
-     *
-     * @return bool|Demac_MultiLocationInventory_Model_Location
-     * @throws Mage_Core_Exception Throws exception when Demac_Geocoding isn't loaded.
-     */
-    protected function getClosestLocation($customerCoordinates, $excludes = array())
-    {
-        if(!Mage::helper('geocoding')) {
-            Mage::throwException('Demac_Geocoding module must be loaded before calling getClosestLocation.');
-        }
-        $closestLocation = false;
-        $closestDistance = 0;
-        $locations       = Mage::getModel('demac_multilocationinventory/location')->getCollection();
-        foreach ($locations as $location) {
-            if(!in_array($location->getId(), $excludes)) {
-                $locationCoordinates = array(
-                    'latitude'  => $location->getLat(),
-                    'longitude' => $location->getLong()
-                );
-
-                $locationDistance = Mage::helper('geocoding')->getGeocodingEngine()->findDistance($customerCoordinates, $locationCoordinates);
-                if($closestLocation == false || $closestDistance > $locationDistance) {
-                    $closestLocation = $location;
-                    $closestDistance = $locationDistance;
-                }
-            }
-        }
-
-        return $closestLocation;
-    }
-
     /**
      *
      *