Add Atom feeds for issues either by operator or map area

app/controllers/operators_controller.rb

@@ -4,7 +4,7 @@ class OperatorsController < ApplicationController
   before_filter :long_cache
   before_filter :find_operator, :except => [:index]
   before_filter :setup_shared_title, :except => [:index]
-
+  before_filter :setup_issues_feed, :only => [:show, :issues, :routes]
 
   def index
     @operator_list_threshold = 20
@@ -45,7 +45,12 @@ def index
       end    
     end
   end
-
+
+  def setup_issues_feed
+    @issues_feed_params = params.clone
+    @issues_feed_params[:format] = 'atom'
+  end
+
   def show
     @title = @operator.name 
     @current_tab = :issues
@@ -74,9 +79,18 @@ def show
   #       reported to another organisation (e.g., a PTE) then that route won't show here.
 
   def issues
-    show
-    @title = t('route_operators.issues.title', :operator => @operator.name) 
-    render :show
+    respond_to do |format|
+      format.html do
+        show
+        @title = t('route_operators.issues.title', :operator => @operator.name)
+        render :show
+      end
+      format.atom do
+        @title = t('route_operators.issues.feed_title', :operator => @operator.name)
+        @issues = Problem.find_recent_issues false, :single_operator => @operator
+        render :template => 'shared/issues.atom.builder', :layout => false
+      end
+    end
   end
 
   def routes 

app/controllers/problems_controller.rb

@@ -7,7 +7,8 @@ class ProblemsController < ApplicationController
                                                :find_train_route,
                                                :find_ferry_route,
                                                :find_other_route,
-                                               :browse]
+                                               :browse,
+                                               :atom_link]
   before_filter :find_visible_problem, :only => [:show, :update, :add_comment]
   before_filter :require_problem_reporter, :only => [:convert]
   skip_before_filter :require_beta_password, :only => [:frontpage]
@@ -376,6 +377,15 @@ def find_ferry_route
   def choose_location
   end
 
+  def atom_link
+    @issues_feed_title = atom_feed_title @lon, @lat
+    @issues_feed_params = params.clone
+    @issues_feed_params['action'] = 'browse'
+    @issues_feed_params['format'] = 'atom'
+    render :partial => 'shared/atom_link',
+           :locals => { :feed_link_text => t('problems.browse.feed_link_text') }
+  end
+
   def browse
     if params[:geolocate] == '1'
       @geolocate_on_load = true
@@ -430,9 +440,16 @@ def find_nearest_stop(lon, lat, transport_mode_name)
     end
   end
 
+  def atom_feed_title(lon, lat)
+    t('problems.browse.feed_title',
+      :longitude => lon,
+      :latitude => lat)
+  end
+
   def find_area(options)
     @map_height = options[:map_height]
     @map_width = options[:map_width]
+    to_render = nil
     if is_valid_lon_lat?(params[:lon], params[:lat])
       lat = params[:lat].to_f
       lon = params[:lon].to_f
@@ -442,100 +459,107 @@ def find_area(options)
         @geolocate_on_load = false
         # don't show geolocate button
         @geolocation_failed = true
-        render options[:find_template]
-        return
-      end
-      nearest_stop = find_nearest_stop(params[:lon], params[:lat], nil)
-      if nearest_stop
-        map_params_from_location([nearest_stop],
-                                 find_other_locations=true,
-                                 @map_height,
-                                 @map_width,
-                                 options[:map_options])
-        @locations = [nearest_stop]
-        render options[:browse_template]
-        return
-      else # no nearest stop suggests empty database
-        location_search.fail
-        @error_message = t('problems.find_stop.please_enter_an_area')
-      end
-    elsif params[:name]
-      if params[:name].blank?
-        @error_message = t('problems.find_stop.please_enter_an_area')
-        render options[:find_template]
-        return
-      end
-      location_search = LocationSearch.new_search!(session_id, :name => params[:name],
-                                                               :location_type => 'Stop/station')
-      stop_info = Gazetteer.place_from_name(params[:name], params[:stop_name], options[:map_options][:mode])
-      # got back localities
-      if stop_info[:localities]
-        if stop_info[:localities].size > 1
-          @localities = stop_info[:localities]
-          @matched_stops_or_stations = stop_info[:matched_stops_or_stations]
-          @name = params[:name]
-          render :choose_locality
-          return
-        else
-          return render_browse_template(stop_info[:localities], options[:map_options], options[:browse_template])
-        end
-      # got back district
-      elsif stop_info[:district]
-        return render_browse_template([stop_info[:district]], options[:map_options], options[:browse_template])
-      # got back admin area
-      elsif stop_info[:admin_area]
-        return render_browse_template([stop_info[:admin_area]], options[:map_options], options[:browse_template])
-      # got back stops/stations
-      elsif stop_info[:locations]
-        if options[:map_options][:mode] == :browse
-          return render_browse_template(stop_info[:locations], options[:map_options], options[:browse_template])
-        else
-          map_params_from_location(stop_info[:locations],
+        to_render = options[:find_template]
+      else
+        nearest_stop = find_nearest_stop(params[:lon], params[:lat], nil)
+        if nearest_stop
+          map_params_from_location([nearest_stop],
                                    find_other_locations=true,
                                    @map_height,
                                    @map_width,
                                    options[:map_options])
-          @locations = stop_info[:locations]
-          render options[:browse_template]
-          return
-        end
-      # got back postcode info
-      elsif stop_info[:postcode_info]
-        postcode_info = stop_info[:postcode_info]
-        if postcode_info[:error]
+          @locations = [nearest_stop]
+          to_render = options[:browse_template]
+        else # no nearest stop suggests empty database
           location_search.fail
-          if postcode_info[:error] == :area_not_known
-            @error_message = t('problems.find_stop.postcode_area_not_known')
-          elsif postcode_info[:error] == :service_unavailable
-            @error_message = t('problems.find_stop.postcode_service_unavailable')
+          @error_message = t('problems.find_stop.please_enter_an_area')
+        end
+      end
+    elsif params[:name]
+      if params[:name].blank?
+        @error_message = t('problems.find_stop.please_enter_an_area')
+        to_render = options[:find_template]
+      else
+        location_search = LocationSearch.new_search!(session_id, :name => params[:name],
+                                                     :location_type => 'Stop/station')
+        stop_info = Gazetteer.place_from_name(params[:name], params[:stop_name], options[:map_options][:mode])
+        # got back localities
+        if stop_info[:localities]
+          if stop_info[:localities].size > 1
+            @localities = stop_info[:localities]
+            @matched_stops_or_stations = stop_info[:matched_stops_or_stations]
+            @name = params[:name]
+            to_render = :choose_locality
           else
-            @error_message = t('problems.find_stop.postcode_not_found')
+            return render_browse_template(stop_info[:localities], options[:map_options], options[:browse_template])
+          end
+          # got back district
+        elsif stop_info[:district]
+          return render_browse_template([stop_info[:district]], options[:map_options], options[:browse_template])
+          # got back admin area
+        elsif stop_info[:admin_area]
+          return render_browse_template([stop_info[:admin_area]], options[:map_options], options[:browse_template])
+          # got back stops/stations
+        elsif stop_info[:locations]
+          if options[:map_options][:mode] == :browse
+            return render_browse_template(stop_info[:locations], options[:map_options], options[:browse_template])
+          else
+            map_params_from_location(stop_info[:locations],
+                                     find_other_locations=true,
+                                     @map_height,
+                                     @map_width,
+                                     options[:map_options])
+            @locations = stop_info[:locations]
+            to_render = options[:browse_template]
+          end
+          # got back postcode info
+        elsif stop_info[:postcode_info]
+          postcode_info = stop_info[:postcode_info]
+          if postcode_info[:error]
+            location_search.fail
+            if postcode_info[:error] == :area_not_known
+              @error_message = t('problems.find_stop.postcode_area_not_known')
+            elsif postcode_info[:error] == :service_unavailable
+              @error_message = t('problems.find_stop.postcode_service_unavailable')
+            else
+              @error_message = t('problems.find_stop.postcode_not_found')
+            end
+            to_render = options[:find_template]
+          else
+            @lat = postcode_info[:lat] unless @lat
+            @lon = postcode_info[:lon] unless @lon
+            @zoom = postcode_info[:zoom] unless @zoom
+            map_data = Map.other_locations(@lat, @lon, @zoom, @map_height, @map_width, @highlight)
+            @other_locations = map_data[:locations]
+            @issues_on_map = map_data[:issues]
+            @nearest_issues = map_data[:nearest_issues]
+            @distance = map_data[:distance]
+            @locations = []
+            @find_other_locations = true
+            to_render = options[:browse_template]
           end
-          render options[:find_template]
-          return
         else
-          @lat = postcode_info[:lat] unless @lat
-          @lon = postcode_info[:lon] unless @lon
-          @zoom = postcode_info[:zoom] unless @zoom
-          map_data = Map.other_locations(@lat, @lon, @zoom, @map_height, @map_width, @highlight)
-          @other_locations = map_data[:locations]
-          @issues_on_map = map_data[:issues]
-          @nearest_issues = map_data[:nearest_issues]
-          @distance = map_data[:distance]
-          @locations = []
-          @find_other_locations = true
-          render options[:browse_template]
-          return
+          # didn't find anything
+          location_search.fail
+          @error_message = t('problems.find_stop.area_not_found')
+          to_render = options[:find_template]
         end
-      else
-        # didn't find anything
-        location_search.fail
-        @error_message = t('problems.find_stop.area_not_found')
-        render options[:find_template]
-        return
       end
     end
-
+    respond_to do |format|
+      format.html do
+        @issues_feed_params = params.clone
+        @issues_feed_params[:format] = 'atom'
+        render to_render if to_render
+      end
+      format.atom do
+        @title = atom_feed_title @lon, @lat
+        @issues = []
+        @issues.concat(@issues_on_map) if @issues_on_map
+        @issues.concat(@nearest_issues) if @nearest_issues
+        render :template => 'shared/issues.atom.builder', :layout => false
+      end
+    end
   end
 
   def is_valid_lon_lat?(lon, lat)

app/models/campaign.rb

@@ -263,4 +263,9 @@ def self.needing_questionnaire(weeks_ago, user=nil)
     self.visible.find(:all, :conditions => query + params,
                             :include => :problem)
   end
+
+  def feed_title_suffix
+    :fixed == status ? " [FIXED]" : ""
+  end
+
 end

app/models/problem.rb

@@ -494,4 +494,8 @@ def self.needing_questionnaire(weeks_ago, user=nil)
     self.visible.sent.find(:all, :conditions => query + params)
   end
 
-end
+  def feed_title_suffix
+    :fixed == status ? " [FIXED]" : ""
+  end
+
+end

app/views/operators/show.erb

@@ -57,6 +57,7 @@
         <%= will_paginate @stations %>
       <%- elsif @current_tab == :issues %>
         <%- if @issue_count != 0 %>
+          <%= render :partial => 'shared/atom_link', :locals => { :feed_link_text => t('route_operators.show.feed_link_text', :operator => @operator.name) } %>
           <%= will_paginate @issues, :params => { :action => :issues } %>
           <ul class="issues-list widecol">
             <%= render :partial => "shared/issue", :collection => @issues, :locals => {:context => :issue_list } %>

app/views/problems/browse_area.erb

@@ -7,6 +7,7 @@
 <div id="main-content" class="browse-map-container container">
 
 	<div class="leftcol mediumnarrowcol">
+    <%= render :partial => 'shared/atom_link', :locals => { :feed_link_text => t('problems.browse.feed_link_text') } %>
     <div id="issues-in-area">
       <%= render :partial => 'shared/issues_in_area'%>
     </div>

app/views/shared/_atom_link.erb

@@ -0,0 +1,5 @@
+<%- if @issues_feed_params %>
+  <div class="atom-link" id="in-page-atom-link">
+    <%= link_to image_tag("feed.png", :class => 'inline-icon') + " " + feed_link_text, @issues_feed_params %>
+  </div>
+<%- end %>

app/views/shared/issues.atom.builder

@@ -4,15 +4,15 @@ atom_feed do |feed|
   @issues.each do |issue|
     if issue.is_a?(Campaign)
       feed.entry(issue) do |entry|
-        entry.title(h(issue.title))
+        entry.title issue.title + issue.feed_title_suffix
         entry.content(strip_tags(issue.description))
         entry.author do |author|
           author.name(issue.initiator.name)
         end
       end
     elsif issue.is_a?(Problem)
       feed.entry(issue) do |entry|
-        entry.title(h(issue.subject))
+        entry.title issue.subject + issue.feed_title_suffix
         entry.content(strip_tags(issue.description))
         entry.author do |author|
           author.name(issue.reporter.name)

config/locales/views/operators/en.yml

@@ -16,6 +16,7 @@ en:
       routes_header: "Routes"
       stations_header: "Stations"
       issues_header: "Issues"
+      feed_link_text: "Get updates on issues for %{operator}"
       is_an_operator: "{%operator} is a transport operator."
       is_an_operator_with_transport_mode: "%{operator} is a transport operator providing %{transport_mode} services."
       operates_routes:
@@ -32,6 +33,7 @@ en:
         other: "%{count} issues have been reported to %{operator}."
     issues:
       title: "%{operator} issues"
+      feed_title: "Issues for %{operator} on FixMyTransport"
     routes:
       title: "%{operator} routes"
     stations:

config/locales/views/problems/en.yml

@@ -8,6 +8,8 @@ en:
       title: "Issues in '%{area}'"
       no_other_issues: No issues have been reported yet.
       title_no_name: "Browsing issues"
+      feed_title: "Issues around longitude %{longitude} and latitude %{latitude} on FixMyTransport"
+      feed_link_text: "Get updates on issues on and around this map"
     choose_area:
       choose_area: "Choose area"
       multiple_localities: "We found more than one place matching \"%{name}\". Please select one, or try a different search if yours is not here:"

config/routes.rb

@@ -72,6 +72,13 @@
   map.issues '/issues', :action => 'issues_index', :controller => 'problems'
   map.browse_issues '/issues/browse', :action => 'browse', :controller => 'problems'
 
+  map.browse_issues_atom_link '/issues/browse/atom_link/:zoom/:lat/:lon', :action => 'atom_link',
+                                                                          :controller => 'problems',
+                                                                          :conditions => { :method => :get },
+                                                                          :requirements => { :zoom => /\d\d?/,
+                                                                                             :lon => /[-+]?[0-9]*\.?[0-9]+/,
+                                                                                             :lat => /[-+]?[0-9]*\.?[0-9]+/ }
+
   # stops
   map.add_comment_stop "/stops/:scope/:id/add_comment", :controller => "locations",
                                                         :action => 'add_comment_to_stop',