Changes between Version 37 and Version 38 of BluePrint/SaveSearch_Sub

Timestamp:

09/11/12 05:00:03 (13 years ago)

Author:

James O'Neill

Comment:

--

BluePrint/SaveSearch_Sub

@@ -17 +17 @@
  pe_id::
   The person entity to be notified when the search results change. Defaults to the pe_id record associated with the current user account.
+ prefix::
+  The module prefix where the search was performed.
+ function::
+  The controller function where the search was performed. This is used with the prefix to build requests that go through the same controllers.
+ resource_name::
+  The module resource that the search is being performed on.
  query::
   The query string for the search.
@@ -74 +80 @@
 
 ==== Notifications ====
-1. Subscription notifications are sent by a cron task sending a request to `/msg/search_subscription_notifications/`
-   * The first query string argument specifies what period this applies to, e.g., daily, monthly, etc.
-1. The controller fetches the saved searches with that frequency.
-1. The resource is created, and the filters are applied.
-1. The resource, with filters, and saved search record is passed to a notification function for the specific notification_method of each saved search.
+1. Scheduled tasks are used to fetch the saved searches for a particular frequency, e.g., daily, monthly, etc.
+1. The notification function fetches the saved searches with that frequency.
+1. An HTTP request is made for each search so that the search results are filtered properly.
 1. Records with a `modified_on` value greater than `last_executed` are added to the message.
 1. Format the response for special media, e.g., Twitter, SMS.
 1. The message is sent via the method specified.
 1. `last_executed` field updated to when the request was made.
-
-=== Tasks ===
-Phase I
-* Implement model
-* Implement representation functions for query string
-* Implement or update controllers
-  * `/msg/search_notifications/` to be called via cron, first argument is the frequency.
-  * Records with a `modified_on` value greater than `last_executed` are returned.
-Phase II
-* Expand `/msg/search_notifications/` to notify all people within a pr_group by fetching the relevant contact details from all members.
-* Add formatters/codecs to format the response for Twitter, SMS, etc.
-* Extend OAuth implementation for Twitter and Facebook to allow posting to users account.
-
-=== Tests ===
-* Save a search without any filters.
-* Save a search after performing a search with filters.
-* Attempt to save a search with empty name; must fail.
-* Delete a saved search.
-* Edit and save a saved search.
-* Executing a search from the saved search list page.
-* Send notification email.