Merge lp:~submarine/ubuntu-scopes/openweathermap-previews into lp:~submarine/ubuntu-scopes/openweathermap

[David Callé]

Initial previews (with Flickr weather project support)

Initial previews.
- Displays a geolocalized photo with matching weather (using Flickr weather project)
- If no photo is found, a "Submit photo" button appears, opening the Flickr weather project group.

[Michal Hruby (mhr3)]

From a quick test it looks and works great! :)

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'data/openweathermap.scope.in'
--- data/openweathermap.scope.in	2013-03-15 17:29:42 +0000
+++ data/openweathermap.scope.in	2013-03-27 13:24:21 +0000
@@ -4,7 +4,7 @@
 Icon=
 _Keywords=openweathermap;weather;sky;forecast;
 RequiredMetadata=
-OptionalMetadata=
+OptionalMetadata=min_temp[s];max_temp[s];pressure[s];humidity[s];wind_speed[s];wind_direction[s];latitude[s];longitude[s];
 Loader=/usr/share/unity-scopes/openweathermap/unity_openweathermap_daemon.py
 RemoteContent=true
 Type=info

=== modified file 'src/unity_openweathermap_daemon.py'
--- src/unity_openweathermap_daemon.py	2013-03-21 18:00:25 +0000
+++ src/unity_openweathermap_daemon.py	2013-03-27 13:24:21 +0000
@@ -21,6 +21,7 @@
 import json
 import datetime
 import gettext
+from random import randrange
 
 APP_NAME = 'unity-scope-openweathermap'
 LOCAL_PATH = '/usr/share/locale/'
@@ -39,7 +40,7 @@
 PROVIDER_ICON = SVG_DIR+'service-openweathermap.svg'
 DEFAULT_RESULT_ICON = SVG_DIR+'result-info.svg'
 DEFAULT_RESULT_MIMETYPE = 'text/html'
-DEFAULT_RESULT_TYPE = Unity.ResultType.PERSONAL
+DEFAULT_RESULT_TYPE = Unity.ResultType.DEFAULT
 
 c1 = {'id'      :'weather',
       'name'    :_('Weather Forecast'),
@@ -47,13 +48,37 @@
       'renderer':Unity.CategoryRenderer.VERTICAL_TILE}
 CATEGORIES = [c1]
 FILTERS = []
-EXTRA_METADATA = []
+m1 = {'id'   :'min_temp',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m2 = {'id'   :'max_temp',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m3 = {'id'   :'pressure',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m4 = {'id'   :'humidity',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m5 = {'id'   :'wind_speed',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m6 = {'id'   :'wind_direction',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m7 = {'id'   :'latitude',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m8 = {'id'   :'longitude',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+EXTRA_METADATA = [m1, m2, m3, m4, m5, m6, m7, m8]
 
 def weather_search(query, s_type):
     print (query)
     query = urllib.parse.quote(str(query))
     data = None
-    if not query:
+    if not query or len(query) <= 1:
         return data
     if s_type == 'forecast':
         uri = "%s%s?mode=daily_compact&units=metric" % (SEARCH_URI[1], query)
@@ -113,10 +138,30 @@
         wind =  place_data['list'][0]['wind']['speed']
         temp_c = float(place_data['list'][0]['main']['temp'])
         temp_f = temp_c*(9.0/5.0)+32
-        temp = '%i%sC/%i%sF' % (int(temp_c),  u"\u00B0", int(temp_f),  u"\u00B0")
-        title = _('Today') + '\n' + temp
+        temp = '%i%sC / %i%sF' % (int(temp_c),  u"\u00B0", int(temp_f),  u"\u00B0")
+        name = place_data['list'][0]['name']
+        country = place_data['list'][0]['sys']['country']
+        title = name + ', ' + country + '\n' + temp
         city_id = place_data['list'][0]['id']
         uri = place_data['list'][0]['url']
+        min_temp_c = float(place_data['list'][0]['main']['temp_min'])
+        min_temp_f = min_temp_c*(9.0/5.0)+32
+        min_temp = '%i%sC / %i%sF' % (int(min_temp_c),  u"\u00B0", int(min_temp_f),  u"\u00B0")
+        max_temp_c = float(place_data['list'][0]['main']['temp_max'])
+        max_temp_f = max_temp_c*(9.0/5.0)+32
+        max_temp = '%i%sC / %i%sF' % (int(max_temp_c),  u"\u00B0", int(max_temp_f),  u"\u00B0")
+        try:
+            pressure = place_data['list'][0]['main']['pressure']
+        except:
+            pressure = ''
+        try:
+            humidity = place_data['list'][0]['main']['humidity']
+        except:
+            humidity = ''
+        wind_speed = place_data['list'][0]['wind']['speed']
+        wind_direction = place_data['list'][0]['wind']['deg']
+        latitude = place_data['list'][0]['coord']['lat']
+        longitude = place_data['list'][0]['coord']['lon']
     except Exception as error:
         print(error)
         return results
@@ -125,7 +170,15 @@
     results.append({'uri':uri,
                     'icon':icon,
                     'title':title,
-                    'comment':description})
+                    'comment':description,
+                    'min_temp':GLib.Variant('s', min_temp),
+                    'max_temp':GLib.Variant('s', max_temp),
+                    'pressure':GLib.Variant('s', str(pressure)),
+                    'humidity':GLib.Variant('s', str(humidity)),
+                    'wind_speed':GLib.Variant('s', str(wind_speed)),
+                    'wind_direction':GLib.Variant('s', str(wind_direction)),
+                    'latitude':GLib.Variant('s', str(latitude)),
+                    'longitude':GLib.Variant('s', str(longitude))})
     forecast = weather_search(city_id, 'forecast')
     if not forecast or not "list" in forecast:
         return results
@@ -140,18 +193,35 @@
         try:
             description = forecast['list'][i]['weather'][0]['description']
             icon = get_icon(forecast['list'][i]['weather'][0]['icon'])
-            wind =  forecast['list'][i]['speed']
             temp_c = float(forecast['list'][i]['temp'])
             temp_f = temp_c*(9.0/5.0)+32
-            temp = '%i%sC/%i%sF' % (int(temp_c),  u"\u00B0", int(temp_f),  u"\u00B0")
+            temp = '%i%sC / %i%sF' % (int(temp_c),  u"\u00B0", int(temp_f),  u"\u00B0")
             title = day_name + '\n' + temp
+            min_temp_c = float(forecast['list'][i]['morn'])
+            min_temp_f = min_temp_c*(9.0/5.0)+32
+            min_temp = '%i%sC / %i%sF' % (int(min_temp_c),  u"\u00B0", int(min_temp_f),  u"\u00B0")
+            max_temp_c = float(forecast['list'][i]['eve'])
+            max_temp_f = max_temp_c*(9.0/5.0)+32
+            max_temp = '%i%sC / %i%sF' % (int(max_temp_c),  u"\u00B0", int(max_temp_f),  u"\u00B0")
+            pressure = forecast['list'][i]['pressure']
+            humidity = forecast['list'][i]['humidity']
+            wind_speed = forecast['list'][i]['speed']
+            wind_direction = forecast['list'][i]['deg']
         except Exception as error:
             print(error)
             return results
         results.append({'uri':uri+"#"+day_name,
                         'icon':icon,
                         'title':title,
-                        'comment':description})
+                        'comment':description,
+                        'min_temp':GLib.Variant('s', min_temp),
+                        'max_temp':GLib.Variant('s', max_temp),
+                        'pressure':GLib.Variant('s', str(pressure)),
+                        'humidity':GLib.Variant('s', str(humidity)),
+                        'wind_speed':GLib.Variant('s', str(wind_speed)),
+                        'wind_direction':GLib.Variant('s', str(wind_direction)),
+                        'latitude':GLib.Variant('s', str(latitude)),
+                        'longitude':GLib.Variant('s', str(longitude))})
     return results
 
 
@@ -188,21 +258,97 @@
                     i['comment'] = ''
                 if not 'dnd_uri' in i or not i['dnd_uri'] or i['dnd_uri'] == '':
                     i['dnd_uri'] = i['uri']
-                i['metadata'] = {}
-                if EXTRA_METADATA:
-                    for e in i:
-                        for m in EXTRA_METADATA:
-                            if m['id'] == e:
-                                i['metadata'][e] = i[e]
-                i['metadata']['provider_credits'] = GLib.Variant('s', PROVIDER_CREDITS)
-                result = Unity.ScopeResult.create(str(i['uri']), str(i['icon']),
-                                                  i['category'], i['result_type'],
-                                                  str(i['mimetype']), str(i['title']),
-                                                  str(i['comment']), str(i['dnd_uri']),
-                                                  i['metadata'])
-                result_set.add_result(result)
-        except Exception as error:
-            print (error)
+                i['provider_credits'] = GLib.Variant('s', PROVIDER_CREDITS)
+                result_set.add_result(**i)
+        except Exception as error:
+            print (error)
+
+class Preview (Unity.ResultPreviewer):
+
+    def get_image(self,q, lat, lon):
+        print (lat, lon)
+        flick_map={'weather-clear':'clear',
+                   'weather-clear-night':'clear',
+                   'weather-few-clouds':'cloudy',
+                   'weather-few-clouds-night':'cloudy',
+                   'weather-clouds':'cloudy',
+                   'weather-clouds-night':'cloudy',
+                   'weather-overcast':'cloudy',
+                   'weather-overcast':'cloudy',
+                   'weather-showers-scattered':'rain',
+                   'weather-showers-scattered':'rain',
+                   'weather-showers':'rain',
+                   'weather-showers':'rain',
+                   'weather-storm':'storm',
+                   'weather-storm':'storm',
+                   'weather-snow':'snow',
+                   'weather-snow':'snow',
+                   'weather-fog':'fog',
+                   'weather-fog':'fog'}
+        license_list = ["All Rights Reserved",
+                       "Attribution-NonCommercial-ShareAlike License",
+                       "Attribution-NonCommercial License",
+                       "Attribution-NonCommercial-NoDerivs License",
+                       "Attribution License",
+                       "Attribution-ShareAlike License",
+                       "Attribution-NoDerivs License",
+                       "No known copyright restrictions",
+                       "United States Government Work"]
+        image = None
+        query = urllib.parse.quote(flick_map[q])
+        key = 'd87224f0b467093b2a87fd788d950e27'
+        uri = 'http://secure.flickr.com/services/rest/?method=flickr.photos.search&nojsoncallback=1&per_page=20&api_key=%s&extras=url_m,owner_name,license&group_id=1463451@N25&format=json&tag_mode=all&tags=%s&bbox=%f,%f,%f,%f' % (key, 
+                                                                                                                       query,
+                                                                                                                       round(float(lon) - 0.1, 2), round(float(lat) - 0.1, 2),
+                                                                                                                       round(float(lon) + 0.1, 2), round(float(lat) +0.1, 2))
+        print (uri)
+        try:
+            response = urllib.request.urlopen(uri).read()
+            data = json.loads(response.decode('utf-8'))
+            photo = randrange(len(data['photos']['photo']))
+            image = data['photos']['photo'][photo]['url_m']
+            owner = data['photos']['photo'][photo]['ownername']
+            license = license_list[int(data['photos']['photo'][photo]['license'])]
+            link = 'https://www.flickr.com/photos/%s/%s' % (data['photos']['photo'][photo]['owner'], data['photos']['photo'][photo]['id'])
+        except Exception as error:
+            print (error)
+            image, owner, license, link = None, None, None, None
+        return image, owner, license, link
+
+    def do_run(self):
+        
+        preview = Unity.GenericPreview.new(self.result.title.split('\n')[0], '', None)
+        preview.props.subtitle = self.result.comment.capitalize()
+        image, owner, license, link = self.get_image(self.result.icon_hint,
+                                                     self.result.metadata['latitude'].get_string(),
+                                                     self.result.metadata['longitude'].get_string())
+
+        gfile_icon = Gio.file_new_for_path(PROVIDER_ICON)
+        gicon = Gio.FileIcon.new (gfile_icon)
+        open_action = Unity.PreviewAction.new("open", _("Open Weather Map"), gicon)
+        preview.add_action(open_action)
+        preview.add_info(Unity.InfoHint.new("min_temp", _("Minimum Temperature"), None, self.result.metadata['min_temp'].get_string()))
+        preview.add_info(Unity.InfoHint.new("max_temp", _("Maximum Temperature"), None, self.result.metadata['max_temp'].get_string()))
+        preview.add_info(Unity.InfoHint.new("wind_speed", _("Wind Speed"), None, self.result.metadata['wind_speed'].get_string() + ' m/s'))
+        preview.add_info(Unity.InfoHint.new("wind_direction", _("Wind Direction"), None, self.result.metadata['wind_direction'].get_string() + u"\u00B0"))
+        if self.result.metadata['pressure'].get_string() != '':
+            preview.add_info(Unity.InfoHint.new("pressure", _("Pressure"), None, self.result.metadata['pressure'].get_string() + ' hPa'))
+        if self.result.metadata['humidity'].get_string() != '':
+            preview.add_info(Unity.InfoHint.new("humidity", _("Humidity"), None, self.result.metadata['humidity'].get_string() + '%'))
+        if image:
+            preview.props.image_source_uri = image
+            gfile_icon = Gio.file_new_for_path(SVG_DIR+'service-flickr.svg')
+            gicon = Gio.FileIcon.new (gfile_icon)
+            preview.add_info(Unity.InfoHint.new("photo_owner", _("Photo source"), gicon, 'Flickr'))
+            preview.add_info(Unity.InfoHint.new("photo_owner", _("Photo credit"), None, owner))
+            preview.add_info(Unity.InfoHint.new("photo_license", _("Photo license"), None, license))
+        else:
+            gfile_icon = Gio.file_new_for_path(SVG_DIR+'service-flickr.svg')
+            gicon = Gio.FileIcon.new (gfile_icon)
+            submit_action = Unity.PreviewAction.new("submit", _("Submit Photo"), gicon)
+            preview.add_action(submit_action)
+        return preview
+
 
 class Scope (Unity.AbstractScope):
     def __init__(self):
@@ -255,5 +401,19 @@
         se = MySearch (search_context)
         return se
 
+    def do_create_previewer(self, result, metadata):
+        rp = Preview()
+        rp.set_scope_result(result)
+        rp.set_search_metadata(metadata)
+        return rp
+
+    def do_activate(self, result, metadata, id):
+        if not id:
+            return Unity.ActivationResponse(handled=Unity.HandledType.SHOW_PREVIEW, goto_uri=result.uri)
+        if id == 'submit':
+            uri = 'https://www.flickr.com/groups/projectweather/'
+            return Unity.ActivationResponse(handled=Unity.HandledType.HIDE_DASH, goto_uri=uri)
+        return
+
 def load_scope():
     return Scope()

=== modified file 'tests/test_openweathermap.py'
--- tests/test_openweathermap.py	2013-03-21 18:20:20 +0000
+++ tests/test_openweathermap.py	2013-03-27 13:24:21 +0000
@@ -43,11 +43,11 @@
                                         'file:tests/data/mock_openweathermap_city_pass#']
         expected_results = ['http://openweathermap.org/city/3026083', 
                             'weather-snow',
-                            'Today\n0°C/33°F',
+                            'Chatillon, FR\n0°C / 33°F',
                             'heavy snow',
                             'http://openweathermap.org/city/3026083#Tomorrow',
                             'weather-clouds',
-                            'Tomorrow\n257°C/494°F',
+                            'Tomorrow\n257°C / 494°F',
                             'scattered clouds']
         results = []
         for s in ['query']: