Twitter: cfjedimaster


Address: Lafayette, LA, USA

PhoneGap RSS Reader - Part 4

07-09-2012 5,181 views Mobile, jQuery, JavaScript 21 Comments

Edited on August 4, 2012: Readers noted that this version didn't correctly handle trying to load the cache when offline. I confirmed that and posted a fix in the comments.

For whatever reason, my articles on PhoneGap and RSS (see related entries below) have been incredibly popular. The last entry currently has 163 comments. Some of the comments deal with the fact that RSS, while a standard, does have a bit of variation to it. My code made some assumptions that didn't always work for other feeds. I thought this was a great opportunity to look at ways I could make the code more applicable to other types of feeds, especially Atom. Luckily, there is an awesome service for this - the Google Feed API.

As you can probably guess, the Google Feed API allows you to parse RSS feeds into simple to use data. It takes any valid RSS or Atom feed and parses it into a simple, standard data model. While the previous code I used wasn't too difficult, it was also very tied to one particular flavor of RSS. I could have continued to add in support for multiple styles of RSS feeds but this seemed far easier to me.

To begin, I added a script tag to load in the Google Loader. This is service Google provides that allows you to dynamically include in JavaScript support for various Google APIs.

<script type="text/javascript" src="https://www.google.com/jsapi"></script>

To load in support for the Feed API, I modified my mainPage pageinit event handler to ask Google Load to go grab the bits. It is very important that you provide the callback option to this API. If you do not, Google Load will blow away the jQuery Mobile DOM completely.

Now let's look at initialize. Previously, this is the portion that would have done the Ajax call, used XML parsing on the results, and stored the entries. Because Google's Feed API is doing this for me the code is now somewhat simpler. (I also added support for jQuery Mobile's "showPageLoadingMsg" API to make it obvious to the user that something is happening.)

And that's pretty much it. My previous code stored the content of the RSS item in a key named content. Google uses a key named description so I modified my display code.

As a final enhancement, I decided to make use of PhoneGap Build to create my mobile application. This allowed me to define a simple config.xml file to help define how the executables are generated. For example, I was able to provide simple icon support. (The icons I used were provided by Fast Icon.)

You can see my application at the bottom here in the screen shot. And yes - I have a Selena Gomez app. Don't hate me for downloading apps my daughter loves.

Want to download the app yourself? Try the public Build page for every platform but iOS. You can also download all of the bits below.

Download attached file

Related Blog Entries

21 Comments

  • HuabinZhang #
    Commented on 07-18-2012 at 4:14 AM
    Thanks for the tip Raymond!I ever wrote an RSS Reader with phonegap.I also used google feed api.But I met a lot of problems.Most important of all is 'google.load("feeds", "1",{callback:initialize});'. I just wrote it like 'google.load("feeds", "1")'.In addition to this?I thisk it wastes time to download js from google.It may use google feed api by google URL base addresses,like 'https://ajax.googleapis.com/ajax/services/feed/loa....'?After trying your code, I found app can not show cached version without network,which was not a problem in previous version.
  • Commented on 07-18-2012 at 10:36 AM
    Did you see where I described why google.load won't work w/o the 3rd option? That hit me too which is why I described it above.

    So - you say the cached version isn't working when offline. I'll give that a test. If I forget to ping back, remind me. :)
  • Commented on 07-25-2012 at 4:07 PM
    Tried building this in Dreamweaver CS6 and getting stuck when building for Android. error is Resource icon already defined. Not sure if this was meant for Dreamweaver, but kinda stuck now. Works in a browser tho.
  • Commented on 07-25-2012 at 4:08 PM
    Sorry - I don't have DW CS6 here so I can't test. I'd post it to the Adobe forums for DW. Also, you can try using Build yourself. Just login to build.phonegap.com and upload the code.
  • Commented on 07-25-2012 at 10:22 PM
    Ok, so I guess it was my fault. I redownloaded, and screwed with it less and hey - now it works. How about that?
  • Commented on 07-26-2012 at 5:35 AM
    Happens to me all the time. :)
  • Commented on 07-29-2012 at 8:08 PM
    Code works well except when offline. Given the index.html header includes src="https://www.google.com/jsapi";

    Wouldn't that kill the possibility of using a cached version offline.

    Is there any reason why we couldn't just download the source and include it in the app? TOS perhaps :p
  • Commented on 07-29-2012 at 8:28 PM
    Well, to be clear, even if you had a copy of Google's code in the app, it wouldn't help you parse the remote RSS feed, right?
  • Commented on 07-30-2012 at 2:39 AM
    Yes. After the remote feed has been read at least once in order to be cached to localStorage and with jsapi stored locally, not having much success getting it to display the stored feed while offline.
  • Commented on 07-30-2012 at 6:28 AM
    Yeah, someone higher mentioned that too. This week I'll look into that bug and fix it. Sorry.
  • Commented on 08-04-2012 at 7:26 AM
    Ok guys, I created a new version of main.js that handles this. NOTE - this is one way of handling, not necessarily the best way.

    I could have used cordova.js and check the connection, but instead, I simply wrap google.load in a try/catch. The nice thing about this is that it is actually 'broader' then just a network connection test.

    If it fails, we try to load the cached version:

    https://gist.github.com/3257160
  • soumavo chatterjee #
    Commented on 08-06-2012 at 4:48 AM
    How can I parse logo using this API

    Here is the xml http://www.morningstaradvisor.com/rssdata/xml/getr...
  • Commented on 08-06-2012 at 6:27 AM
    From what I can see in the docs, the logo field is not returned. You will need to switch to using XML parsing as demonstrated in the earlier posts in this series.
  • Mike Taylor #
    Commented on 08-16-2012 at 9:04 AM
    Any reason why this would work great on an iphone4 but not load on an ipad3?
  • Commented on 08-16-2012 at 9:12 AM
    Nope. I don't have an iPhone, just an iPad3. I don't remember testing it there... but it should work fine. You -do- need to whitelist the URL, but that would apply to all iOS devices, not just the iPad3.
  • Commented on 08-16-2012 at 9:18 AM
    As just an FYI, I'm testing this now. I had not had a chance to get XCode installed on this new Mac so this is a perfect opportunity.
  • Commented on 08-16-2012 at 10:32 AM
    Finally got stuff up and running... and it works for me on my iPad3.
  • Commented on 08-24-2012 at 5:27 AM
    The new version works brilliantly.

    Thanks Raymond for updating it. :)
  • Commented on 12-04-2012 at 8:22 AM
    Thanks for this - it's working really well for me! One question I have is about the "target" attribute on URLs. The links in my blog's posts all use target="_blank" to fire off a new window, but that appears to be getting stripped out and links are replacing the app itself (I want them to open a new browser).

    Any idea what would be doing that? Not sure if it's your code, Google, or what...

    Thanks.
  • Commented on 12-04-2012 at 8:47 AM
    I'd add a jQuery event handler that binds to the anchor tag and detects if it has a target. I believe this would do it:

    $("a[target]")

    That would match anything with a target. This may be more precise:

    $("a[target='_blank']")

    Anyway - capture that, and you can handle the links as you want, like with the ChildBrowser plugin for example.
  • Commented on 12-04-2012 at 9:39 AM
    Excellent, thank you!

Post Reply

Please refrain from posting large blocks of code as a comment. Use Pastebin or Gists instead.

Leave this field empty