Merge lp:~martin-borho/ubuntu-weather-app/API-features into lp:ubuntu-weather-app/obsolete.trunk

[Martin Borho]

Updated to new openweathermap API version 2.5, API calls now in WorkerScript, added fixes for stability

- updated to openweathermap API version 2.5
- now 10 instead of 7 days in daily forecast
- API calls now done in WorkerScript
- handling occasional empty API responses from openweathermap by a prompt retry

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

PASSED: Continuous integration, rev:19
http://91.189.93.125:8080/job/ubuntu-weather-app-ci/8/
Executed test runs:
    SUCCESS: http://91.189.93.125:8080/job/ubuntu-weather-app-quantal-amd64-ci/8
    SUCCESS: http://91.189.93.125:8080/job/ubuntu-weather-app-raring-amd64-ci/8

Click here to trigger a rebuild:
http://91.189.93.125:8080/job/ubuntu-weather-app-ci/8/rebuild

review: Approve (continuous-integration)

[Raúl Yeguas (neokore)]

review: Approve

=== modified file 'components/AddLocationDialog.qml'
--- components/AddLocationDialog.qml	2013-04-21 18:05:01 +0000
+++ components/AddLocationDialog.qml	2013-04-27 14:57:26 +0000
@@ -2,17 +2,31 @@
 import Ubuntu.Components 0.1
 import Ubuntu.Components.Popups 0.1
 import Ubuntu.Components.ListItems 0.1 as ListItem;
-import "WeatherApi.js" as Api
 
 // Dialog for adding a new location
 Component {
     id: addLocationDialog
-    Dialog {
+
+    Dialog {        
         id: addLocationDialogue
         height: units.gu(10)
         title: i18n.tr("Add location")
         text: i18n.tr("Write a city name o pick it by your location")
 
+        WorkerScript {
+            id: searchWorker
+            source: "./WeatherApi.js"
+            onMessage: {
+                if(!messageObject.error) {
+                    messageObject.result.locations.forEach(function(loc) {
+                        citiesModel.append(loc);
+                    });
+                } else {
+                    console.log(messageObject.error.msg+" / "+messageObject.error.request.url)
+                }
+            }
+        }
+
         function locationSelected(index) {
             var location = citiesModel.get(index);
             // make clone
@@ -21,18 +35,6 @@
             PopupUtils.close(addLocationDialogue)
         }
 
-        function onApiError(err) {
-            // TODO display
-            console.log("onApiError")
-            console.log(err.msg+" / "+err.request.url)
-        }
-
-        function onSearchSuccess(locations) {
-            locations.results.forEach(function(v) {
-                citiesModel.append(v);
-            })
-        }
-
         Row {
             TextField {
                 id: locationString
@@ -47,7 +49,10 @@
 
                 onClicked: {
                     citiesModel.clear();
-                    Api.WeatherApi.searchLocationByName({name:locationString.text, units:"metric"},onSearchSuccess,onApiError);
+                    searchWorker.sendMessage({
+                        action: "searchByName",
+                        params: {name:locationString.text, units:"metric"}
+                    })
                 }
             }
         }
@@ -57,7 +62,10 @@
             text: i18n.tr("Use my own location")
             onClicked: {
                 citiesModel.clear();
-                Api.WeatherApi.searchLocationByPoint({coords: {"lon":10,"lat":53.549999}, units:"metric"}, onSearchSuccess,onApiError);
+                searchWorker.sendMessage({
+                    action: "searchByPoint",
+                    params: {coords: {"lon":10,"lat":53.549999}, units:"metric"}
+                })
             }
         }
 
 
=== modified file 'components/LocationTab.qml'
--- components/LocationTab.qml	2013-04-24 17:37:44 +0000
+++ components/LocationTab.qml	2013-04-27 14:57:26 +0000
@@ -43,18 +43,14 @@
             dayForecastModel.append({
                 dateRel: "",//Tomorrow",
                 date: formatTimestamp(dailyForecasts[x].timestamp, 'dddd, dd MMMM yyyy'),
-                temp: dailyForecasts[x].temp,
-                tempMin: dailyForecasts[x].night,
+                temp: dailyForecasts[x].max,
+                tempMin: dailyForecasts[x].min,
                 cond: dailyForecasts[x].condition.id,
                 condIcon: dailyForecasts[x].condition.icon
             });
         }
     }
 
-    function locationAdded(location) {
-        mainView.locationAdded({"service":"openweathermap","service_id":2643743,"name":"London","country":"GB"});
-    }
-
     // Menu for options
     page: Page {
 
 
=== modified file 'components/WeatherApi.js'
--- components/WeatherApi.js	2013-04-21 18:05:01 +0000
+++ components/WeatherApi.js	2013-04-27 14:57:26 +0000
@@ -4,22 +4,25 @@
     /**
       provides neccessary methods for requesting and preparing data from OpenWeatherMap.org
     */
-    var _baseUrl = "http://api.openweathermap.org/data/2.1/";
+    var _baseUrl = "http://api.openweathermap.org/data/2.5/";
+
     //
     function _buildSearchResult(request, data) {
         var searchResult = {
-            results: [],
+            locations: [],
             request: request
         }
-        data.list.forEach(function(r) {
-           searchResult.results.push({
-                service: "openweathermap",
-                service_id: r.id,
-                name: r.name,
-                coord: r.coords,
-                country: (r.sys && r.sys.country) ? r.sys.country : ""
-            });
-        })
+        if(data.cod === "200" && data.list) {
+            data.list.forEach(function(r) {
+               searchResult.locations.push({
+                    service: "openweathermap",
+                    service_id: r.id,
+                    name: r.name,
+                    coord: r.coords,
+                    country: (r.sys && r.sys.country) ? r.sys.country : ""
+                });
+            })
+        }
         return searchResult;
     }
     //
@@ -73,10 +76,12 @@
             // TODO date_txt
             forecastResult.results.push({
                 timestamp: f.dt,
-                temp: f.temp,
-                night: f.night,
-                eve: f.eve,
-                morn: f.morn,
+                day: f.temp.day,
+                min: f.temp.min,
+                max: f.temp.max,
+                night: f.temp.night,
+                eve: f.temp.eve,
+                morn: f.temp.morn,
                 pressure: f.pressure,
                 humidity: f.humidity,
                 condition: f.weather[0],
@@ -92,14 +97,14 @@
         getSearchByNameRequest: function(params) {
             var request = {
                 type: "search",
-                url: _baseUrl+"find/name?q="+encodeURIComponent(params.name)+"&units="+params.units,
+                url: _baseUrl+"find?q="+encodeURIComponent(params.name)+"&units="+params.units,
                 formatter: _buildSearchResult
             }
             return request;
         },
         //
         getSearchByPointRequest: function(params) {
-            var url = _baseUrl+"find/city?lat="+encodeURIComponent(params.coords.lat)
+            var url = _baseUrl+"find?lat="+encodeURIComponent(params.coords.lat)
                     +"&lon="+encodeURIComponent(params.coords.lon)+"&units="+params.units,
                 request = {
                     type: "search",
@@ -112,7 +117,7 @@
         getCurrentConditionRequest: function(params) {
             var request = {
                 type: "current",
-                url: _baseUrl + "weather/city/"+params.location.service_id+"?units="+params.units,
+                url: _baseUrl + "weather?id="+params.location.service_id+"&units="+params.units,
                 formatter: _buildCurrentCondition
             }
             return request;
@@ -121,7 +126,7 @@
         getForecastRequest: function(params) {
             var request = {
                 type: "forecast",
-                url: _baseUrl + "forecast/city/"+params.location.service_id+"?units="+params.units,
+                url: _baseUrl + "forecast?id="+params.location.service_id+"&units="+params.units,
                 formatter: _buildForecast
             }
             return request;
@@ -130,7 +135,8 @@
         getDailyForecastRequest: function(params) {
             var request = {
                 type: "daily",
-                url: _baseUrl + "forecast/city/"+params.location.service_id+"?mode=daily_compact&units="+params.units,
+                url: _baseUrl + "forecast/daily?"+params.location.service_id
+                     +"&mode=daily_compact&cnt=10&units="+params.units,
                 formatter: _buildDailyForecast
             }
             return request;
@@ -151,24 +157,32 @@
         return _services["openweathermap"];
     }
     //
-    function _sendRequest(request, onSuccess, onError) {
-        var xmlHttp = new XMLHttpRequest();
-        if (xmlHttp) {
-            console.log(request.url);
-            xmlHttp.open('GET', request.url, true);
-            xmlHttp.onreadystatechange = function () {
-                if (xmlHttp.readyState == 4) {
-                    var json = JSON.parse(xmlHttp.responseText);
-                    if(xmlHttp.status === 200) {
-                        var result = request.formatter(request,json);
-                        onSuccess(result);
-                    } else {
-                        onError({error: true, msg: "something went wrong", request: request});
+    function _sendRequest(request, onSuccess, onError) {        
+            var xmlHttp = new XMLHttpRequest();
+            if (xmlHttp) {
+                console.log(request.url);
+                xmlHttp.open('GET', request.url, true);
+                xmlHttp.onreadystatechange = function () {
+                    try {
+                        if (xmlHttp.readyState == 4) {
+                            //console.log(xmlHttp.responseText);
+                            var json = JSON.parse(xmlHttp.responseText);
+                            if(xmlHttp.status === 200) {
+                                var result = request.formatter(request,json);
+                                onSuccess(result);
+                            } else {
+                                onError({
+                                    msg: "wrong response http code, got "+xmlHttp.status,
+                                    request: request
+                                });
+                            }
+                        }
+                    } catch (e) {
+                        onError({msg: "wrong response data format", request: request});
                     }
-                }
-            };
-            xmlHttp.send(null);
-        }
+                };
+                xmlHttp.send(null);
+            }
     }
     //
     return  {
@@ -197,22 +211,106 @@
             _sendRequest(request, onSuccess, onError);
         },
         //
+        search: function(mode, params, onSuccess, onError) {
+            var searchFunc = (mode === "point") ? this.searchLocationByPoint: this.searchLocationByName,
+                retryHandler = (function(err) {
+                    console.log("search retry of "+err.request.url);
+                    searchFunc(params, onSuccess, onError);
+            });
+            searchFunc(params, onSuccess, retryHandler);
+        },
+        //
         getLocationData: function(params, onSuccess, onError) {
-            var response = {
-                location: params.location
+            var retryMap = {
+                current:this.getCurrentCondition,
+                daily:this.getDailyForecast,
+                forecast:this.getForecast
+            },
+            response = {
+                location: params.location,
+                db: (params.db) ? params.db : null
             },
             addDataToResponse = (function(data) {
                 response[data.request.type] = data;
-                if(response["current"] !== undefined && response["forecast"] !== undefined && response["daily"] !== undefined) {
+                if(response["current"] !== undefined
+                        && response["forecast"] !== undefined
+                            && response["daily"] !== undefined) {
                     onSuccess(response);
                 }
-            });
+            }),
+            onErrorHandler = (function(err) {
+                onError(err);
+            }),
+            retryHandler = (function(err) {
+                console.log("retry of "+err.request.url);
+                var retryFunc = retryMap[err.request.type];
+                retryFunc(params, addDataToResponse, onErrorHandler);
+            })
 
-            this.getCurrentCondition(params, addDataToResponse, addDataToResponse)
-            this.getForecast(params, addDataToResponse, addDataToResponse);
-            this.getDailyForecast(params, addDataToResponse, addDataToResponse);
+            this.getCurrentCondition(params, addDataToResponse, retryHandler);
+            this.getForecast(params, addDataToResponse, retryHandler);
+            this.getDailyForecast(params, addDataToResponse, retryHandler);
         }
     }
 })({
     "openweathermap": OpenWeatherMapApi
 });
+
+
+/*
+  following WorkerScript handles the data requests against the weather API.
+  "message" requires a "params" property with the required params to perform
+  the API call and an "action" property, which will be added also to the response.
+*/
+if(typeof WorkerScript != "undefined") {
+    WorkerScript.onMessage = function(message) {
+        // handles the response data
+        var finished = function(result) {
+            WorkerScript.sendMessage({
+                action: message.action,
+                result: result
+            })
+        }
+        // handles errors
+        var onError = function(err) {
+            console.log(JSON.stringify(err, null, true));
+            WorkerScript.sendMessage({ 'error': err})
+        }
+        // keep order of locations, sort results
+        var sortDataResults = function(locA, locB) {
+            return locA.db.id - locB.db.id;
+        }
+        // perform the api calls
+        if(message.action === "searchByName") {
+            WeatherApi.search("name", message.params, finished, onError);
+        } else if(message.action === "searchByPoint") {
+            WeatherApi.search("point", message.params, finished, onError);
+        } else if(message.action === "newLocationData") {
+            WeatherApi.getLocationData(message.params, finished, onError);
+        } else if(message.action === "updateData") {
+            var locLength = message.params.locations.length,
+                locUpdated = 0,
+                result = [];
+            if(locLength > 0) {
+                message.params.locations.forEach(function(loc) {
+                    var updatedHnd = function (newData) {
+                            locUpdated += 1;
+                            result.push(newData);
+                            if(locUpdated === locLength) {
+                                result.sort(sortDataResults);
+                                finished(result);
+                            }
+                        },
+                        params = {
+                            location:loc.location,
+                            db: loc.db,
+                            units: message.params.units
+                        };
+                    WeatherApi.getLocationData(params, updatedHnd, onError);
+                })
+            } else {
+                finished(result);
+            }
+        }
+    }
+}
 
=== modified file 'ubuntu-weather-app.qml'
--- ubuntu-weather-app.qml	2013-04-25 13:04:02 +0000
+++ ubuntu-weather-app.qml	2013-04-27 14:57:26 +0000
@@ -2,7 +2,6 @@
 import Ubuntu.Components 0.1
 import "components" as Components
 import Ubuntu.Components.Popups 0.1
-import "components/WeatherApi.js" as Api
 
 MainView {
     // objectName for functional testing purposes (autopilot-qt5)
@@ -17,6 +16,25 @@
     property var locationsList: []
     property var tabsObject: null
 
+    WorkerScript {
+        id: locationDataWorker
+        source: "components/WeatherApi.js"
+        onMessage: {
+            if(!messageObject.error) {
+                if(messageObject.action === "updateData") {
+                    messageObject.result.forEach(function(loc) {
+                        storage.updateLocation(loc.db.id, loc);
+                    });
+                    buildTabs(messageObject.result);
+                } else if(messageObject.action === "newLocationData") {
+                    onNewLocationDataSuccess(messageObject.result);
+                }
+            } else {
+                console.log(messageObject.error.msg+" / "+messageObject.error.request.url)
+            }
+        }
+    }
+
     // see https://bugs.launchpad.net/ubuntu-ui-toolkit/+bug/1124071, temporary workaround
     function buildTabs(locations) {
         locationsList = locations;
@@ -43,13 +61,10 @@
     }
 
     function locationAdded(locationObj) {
-        Api.WeatherApi.getLocationData({location:locationObj, units: "metric"}, onNewLocationDataSuccess, onApiError);
-    }
-
-    function onApiError(err) {
-        // TODO show error popup
-        console.log("onApiError")
-        console.log(err.msg+" / "+err.request.url)
+        locationDataWorker.sendMessage({
+            action: "newLocationData",
+            params: {location:locationObj, units:"metric"}
+        })
     }
 
     function onNewLocationDataSuccess(resp) {
@@ -59,20 +74,10 @@
 
     function refreshData() {
         storage.getLocations(function(locations) {
-            var locLength = locations.length,
-                locUpdated = 0;
-            if(locLength > 0) {
-                locations.forEach(function(loc) {
-                    var updatedHnd = function (newData) {
-                        locUpdated += 1;
-                        storage.updateLocation(loc.db.id, newData);
-                        if(locUpdated === locLength) {
-                            buildTabs(locations);
-                        }
-                    }
-                    Api.WeatherApi.getLocationData({location:loc.location, units: "metric"}, updatedHnd, onApiError);
-                })
-            } else buildTabs(locations);
+            locationDataWorker.sendMessage({
+                action: "updateData",
+                params: {locations:locations, units:"metric"}
+            })
         });
     }