superfeedr-ruby 0.4.1 → 0.4.2

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 4
-:patch: 1
+:patch: 2

data/lib/stanzas/notification_stanza.rb

@@ -9,31 +9,177 @@
 # - chunks (long entries might be notified in several chunks)
 # - chunk (current chunk out of chunks)
 #
-require "cgi"
+# <item xmlns="http://jabber.org/protocol/pubsub" chunks="2" chunk="1">
+#     <entry xmlns="http://www.w3.org/2005/Atom" xml:lang="">
+#         <title>cool</title>
+#         <content type="text">cool</content>
+#         <id>tag:pubhubsubbub-example-app,2009:ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAw</id>
+#         <published>2010-03-25T16:57:18Z</published>
+#         <link type="text/html" href="http://pubsubhubbub-example-app.appspot.com/ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAw" title="" rel="alternate"/>
+#     </entry>
+# </item>
+
+class Link
+  def initialize(node)
+    @node = node
+  end
+  
+  def title
+    @node["title"]
+  end
+  
+  def href
+    @node["href"]
+  end
+  
+  def rel
+    @node["rel"]
+  end
+  
+  def type
+    @node["type"]
+  end
+  
+end
+
+class Author
+  def initialize(node)
+    @node = node
+  end
+  
+  def name
+    if !@name
+      if name = @node.at_xpath("./atom:name", {"atom" => "http://www.w3.org/2005/Atom"})
+        @name = name.text
+      end
+    end
+  end
+  
+  def uri
+    if !@uri
+      if uri = @node.at_xpath("./atom:uri", {"atom" => "http://www.w3.org/2005/Atom"})
+        @uri = uri.text
+      end
+    end
+  end
+  
+  def email
+    if !@email
+      if email = @node.at_xpath("./atom:email", {"atom" => "http://www.w3.org/2005/Atom"})
+        @email = email.text
+      end
+    end
+  end
+  
+end
+
+class Category
+  def initialize(node)
+    @node = node
+  end
+  
+  def term
+    @node["term"]
+  end
+end
+
+class Location
+  def initialize(node)
+    @node = node
+  end
+  
+  def point
+    @point ||= @node.text
+  end
+  
+  def lat
+    @lat ||= point.split().first.to_f
+  end
+  
+  def lon
+    @lon ||= point.split().last.to_f
+  end
+  
+end
+
 class Item
-  include SAXMachine
-  element :item, :as => :chunk, :value => :chunk
-  element :item, :as => :chunks, :value => :chunks
-  element :title
-  element :summary
-  element :link, :as => :link, :value => :href
-  element :id, :as => :unique_id
-  element :published
   
-  def link
-    CGI.unescape(@link).gsub("\n", "")
+  def initialize(node)
+    @node = node
+  end
+  
+  def title
+    @title ||= @node.at_xpath("./atom:entry/atom:title", {"atom" => "http://www.w3.org/2005/Atom"}).text
+  end
+  
+  def summary
+    if !@summary
+      if summary = @node.at_xpath("./atom:entry/atom:summary", {"atom" => "http://www.w3.org/2005/Atom"})
+        @summary = summary.text
+      end
+    end
+    @summary
+  end
+
+  def unique_id
+    @unique_id ||= @node.at_xpath("./atom:entry/atom:id", {"atom" => "http://www.w3.org/2005/Atom"}).text
   end
   
   def published
-    Time.parse(@published)
+    if !@published
+      if published = @node.at_xpath("./atom:entry/atom:published", {"atom" => "http://www.w3.org/2005/Atom"}).text
+        @published = Time.parse(published)
+      end
+    end
+    @published
   end
   
   def chunks
-    @chunks.to_i
+    @node["chunks"].to_i
   end
   
   def chunk
-    @chunk.to_i
+    @node["chunk"].to_i
+  end
+  
+  def links
+    if !@links
+      @links = []
+      @node.xpath("./atom:entry/atom:link", {"atom" => "http://www.w3.org/2005/Atom"}).each do |node|
+        @links.push(Link.new(node))
+      end
+    end
+    @links
+  end
+
+  def authors
+    if !@authors
+      @authors = []
+      @node.xpath("./atom:entry/atom:author", {"atom" => "http://www.w3.org/2005/Atom"}).each do |node|
+        @authors.push(Author.new(node))
+      end
+    end
+    @authors
+  end
+
+  def categories
+    if !@categories
+      @categories = []
+      @node.xpath("./atom:entry/atom:category", {"atom" => "http://www.w3.org/2005/Atom"}).each do |node|
+        @categories.push(Category.new(node))
+      end
+    end
+    @categories
+  end
+
+  def locations
+    if !@locations
+      @locations = []
+      @node.xpath("./atom:entry/georss:point", {"atom" => "http://www.w3.org/2005/Atom", "georss" => "http://www.georss.org/georss"}).each do |node|
+        @locations.push(Location.new(node))
+      end
+    end
+    @locations
   end
   
 end
@@ -46,30 +192,67 @@ end
 # - feed_url : url of the feed
 # - next_fetch : Time when the feed will be fetched again (this is purely informative and it might change)
 # - items : array of new items detected (might be empty)
-class NotificationStanza
-  include SAXMachine
-  
-  def initialize(xml)
-    parse(xml.to_s)
-  end
+#
+# 
+# <message xmlns="jabber:client" from="firehoser.superfeedr.com" to="julien@superfeedr.com">
+#   <event xmlns="http://jabber.org/protocol/pubsub#event">
+#     <status xmlns="http://superfeedr.com/xmpp-pubsub-ext" feed="http://pubsubhubbub-example-app.appspot.com/feed">
+#       <http code="200">25002 bytes fetched in 0.73s for 1 new entries.</http>
+#       <next_fetch>2010-03-25T17:06:30+00:00</next_fetch>
+#       <title>PubSubHubBub example app</title>
+#     </status>
+#     <items node="http://pubsubhubbub-example-app.appspot.com/feed">
+#       <item xmlns="http://jabber.org/protocol/pubsub" chunks="1" chunk="1">
+#         <entry xmlns="http://www.w3.org/2005/Atom" xml:lang="" xmlns:xml="http://www.w3.org/XML/1998/namespace">
+#           <title>cool</title>
+#           <content type="text">cool</content>
+#           <id>tag:pubhubsubbub-example-app,2009:ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAw</id>
+#           <published>2010-03-25T16:57:18Z</published>
+#           <link type="text/html" href="http://pubsubhubbub-example-app.appspot.com/ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAw" title="" rel="alternate"/>
+#         </entry>
+#         <entry xmlns="http://www.w3.org/2005/Atom" xml:lang="" xmlns:xml="http://www.w3.org/XML/1998/namespace">
+#           <title>great</title>
+#           <content type="text">great</content>
+#           <id>tag:pubhubsubbub-example-app,2009:ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAx</id>
+#           <published>2010-03-25T16:57:19Z</published>
+#           <link type="text/html" href="http://pubsubhubbub-example-app.appspot.com/ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAx" title="" rel="alternate"/>
+#         </entry>
+#       </item>
+#     </items>
+#   </event>
+# </message>
+
+class NotificationStanza < Skates::Base::Stanza 
   
   def next_fetch
-    Time.parse(@next_fetch)
+    if !@next_fetch
+      time = @node.at_xpath("./ps:event/sf:status/sf:next_fetch", {"ps" => "http://jabber.org/protocol/pubsub#event", "sf" => "http://superfeedr.com/xmpp-pubsub-ext"}).text
+      @next_fetch = Time.parse(time)
+    end
+    @next_fetch
   end
   
   def http_status
-    @http_status.to_i
+    @http_status ||= @node.at_xpath("./ps:event/sf:status/sf:http/@code", {"ps" => "http://jabber.org/protocol/pubsub#event", "sf" => "http://superfeedr.com/xmpp-pubsub-ext"}).text.to_i
   end
   
   def feed_url
-    CGI.unescape(@feed_url).gsub("\n", "")
+    @feed_url ||= @node.at_xpath("./ps:event/sf:status/@feed", {"ps" => "http://jabber.org/protocol/pubsub#event", "sf" => "http://superfeedr.com/xmpp-pubsub-ext"}).text
   end
   
-  element :http, :as => :message_status
-  element :http, :as => :http_status, :value => :code
-  element :status, :value => :feed, :as => :feed_url
-  element :next_fetch
-  elements :item, :as => :entries, :class => Item
+  def message_status
+    @message_status ||= @node.at_xpath("./ps:event/sf:status/sf:http", {"ps" => "http://jabber.org/protocol/pubsub#event", "sf" => "http://superfeedr.com/xmpp-pubsub-ext"}).text
+  end
+  
+  def entries
+    if !@entries
+      @entries = []
+      @node.xpath("./ps:event/ps:items/ps2:item", {"ps" => "http://jabber.org/protocol/pubsub#event", "ps2" => "http://jabber.org/protocol/pubsub"}).each do |node|
+        @entries.push(Item.new(node))
+      end
+    end
+    @entries
+  end
   
 end
 

data/lib/superfeedr.rb

@@ -137,8 +137,12 @@ module Superfeedr
   ##
   # Called with a response to a subscriptions listing
   def self.on_subscriptions(stanza, &block)
-    page = stanza.xpath('//subscriptions').first["page"].to_i
-    feeds = stanza.xpath('//subscription').map { |s| CGI.unescapeHTML(s["node"]) }
+    xmlns = {
+      'pubsub' => 'http://jabber.org/protocol/pubsub',
+      'superfeedr' => 'http://superfeedr.com/xmpp-pubsub-ext'
+    }
+    page = stanza.xpath('//pubsub:subscriptions/@superfeedr:page', xmlns).to_s.to_i
+    feeds = stanza.xpath('//pubsub:subscription', xmlns).map { |s| CGI.unescapeHTML(s["node"]) }
     block.call(page, feeds)
   end
   
@@ -192,7 +196,7 @@ module Superfeedr
       @@callbacks[stanza["id"]][:method].call(stanza, &@@callbacks[stanza["id"]][:param])
       @@callbacks.delete(stanza["id"])
     else
-      if stanza.name == "message" and stanza.at("event")
+      if stanza.name == "message" and !stanza.xpath("./ps:event", {"ps" => "http://jabber.org/protocol/pubsub#event"}).empty?
         @@notification_callback.call(NotificationStanza.new(stanza)) if @@notification_callback
         # Here we need to call the main notification callback!
       end
@@ -206,4 +210,4 @@ module Superfeedr
   end
   
   
-end
+end

data/spec/stanzas/notifications_stanza_spec.rb

@@ -3,50 +3,62 @@ describe NotificationStanza do
   
   before(:each) do
     xml = <<-EOXML
-    <message from='firehoser.superfeedr.com' to='you@superfeedr.com'>
-      <event xmlns='http://jabber.org/protocol/pubsub#event'>
-        <status feed="http://domain.tld/path/to/feed.xml" xmlns:superfeedr='http://superfeedr.com/xmpp-pubsub-ext'>
-          <http code="200">9718 bytes fetched in 1.462708s : 2 new entries.</http>
-          <next_fetch>2009-05-10T11:19:38-07:00</next_fetch>
+    <message xmlns="jabber:client" from="firehoser.superfeedr.com" to="julien@superfeedr.com">
+      <event xmlns="http://jabber.org/protocol/pubsub#event">
+        <status xmlns="http://superfeedr.com/xmpp-pubsub-ext" feed="http://pubsubhubbub-example-app.appspot.com/feed">
+          <http code="200">25002 bytes fetched in 0.73s for 1 new entries.</http>
+          <next_fetch>2010-03-25T17:06:30+00:00</next_fetch>
+          <title>PubSubHubBub example app</title>
         </status>
-        <items node='http://domain.tld/path/to/feed.xml'>
-          <item chunk="1" chunks="2" >
-            <entry xmlns='http://www.w3.org/2005/Atom'>
-              <title>Soliloquy</title>
+        <items node="http://pubsubhubbub-example-app.appspot.com/feed">
+          <item xmlns="http://jabber.org/protocol/pubsub" chunks="2" chunk="1">
+            <entry xmlns="http://www.w3.org/2005/Atom" xml:lang="" xmlns:xml="http://www.w3.org/XML/1998/namespace">
+              <id>tag:pubhubsubbub-example-app,2009:ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAw</id>
+              <title>cool</title>
+              <content type="text">cool</content>
               <summary>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.</summary>
-              <link rel='alternate' type='text/html' href='http://superfeedr.com/entries/12345789'/>
-              <id>tag:domain.tld,2009:Soliloquy-32397</id>
-              <published>2010-04-05T11:04:21Z</published>
+              <published>2010-03-25T16:57:18Z</published>
+              <link type="text/html" href="http://pubsubhubbub-example-app.appspot.com/ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAw" title="cool" rel="alternate"/>
+              <link href="http://domain.tld/entries/12345/comments.xml" rel="replies" type="application/atom+xml" /> 
+              <point xmlns="http://www.georss.org/georss">47.597553 -122.15925</point>
+              <author>
+                <name>John Doe</name>
+                <email>john@superfeedr.com</email>
+              </author>
+              <category term="tag" scheme="http://www.sixapart.com/ns/types#tag" />
+              <category term="category" scheme="http://www.sixapart.com/ns/types#tag" />
             </entry>
           </item>
-          <item chunk="2" chunks="2" >
-            <entry xmlns='http://www.w3.org/2005/Atom'>
-              <title>Finibus Bonorum et Malorum</title>
-              <summary>Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.</summary>
-              <link rel='alternate' type='text/html' href='http://superfeedr.com/entries/12345788'/>
-              <id>tag:domain.tld,2009:Finibus-32398</id>
-              <published>2010-04-06T08:54:02Z</published>
+          <item xmlns="http://jabber.org/protocol/pubsub" chunks="2" chunk="2">
+            <entry xmlns="http://www.w3.org/2005/Atom" xml:lang="" xmlns:xml="http://www.w3.org/XML/1998/namespace">
+              <title>great</title>
+              <content type="text">great</content>
+              <id>tag:pubhubsubbub-example-app,2009:ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAx</id>
+              <published>2010-03-25T16:57:19Z</published>
+              <link type="text/html" href="http://pubsubhubbub-example-app.appspot.com/ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAx" title="" rel="alternate"/>
             </entry>
           </item>
         </items>
       </event>
     </message>
     EOXML
-    @stanza = NotificationStanza.new(xml)
+    @stanza = NotificationStanza.new(Nokogiri::XML(xml).root)
   end
   
   it "should have the right feed_url" do
-    @stanza.feed_url.should == "http://domain.tld/path/to/feed.xml"
+    @stanza.feed_url.should == "http://pubsubhubbub-example-app.appspot.com/feed"
   end
   
-  it "should have the right message_status" 
+  it "should have the right message_status" do
+    @stanza.message_status.should == "25002 bytes fetched in 0.73s for 1 new entries."
+  end
   
   it "should have the right http_status" do
     @stanza.http_status.should == 200
   end
   
   it "should have the have the right next_fetch" do
-    @stanza.next_fetch.should == Time.parse("2009-05-10T11:19:38-07:00")
+    @stanza.next_fetch.should == Time.parse("2010-03-25T17:06:30+00:00")
   end
   
   it "should have the right number of items" do
@@ -67,25 +79,102 @@ describe NotificationStanza do
     end
     
     it "should have the right title" do
-      @item.title.should == "Soliloquy"
+      @item.title.should == "cool"
     end
     
     it "should have the right summary" do
       @item.summary.should == "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur."
     end
     
-    it "should have the right link" do
-      @item.link.should == "http://superfeedr.com/entries/12345789"
-    end
-    
     it "should have the right unique_id" do
-      @item.unique_id.should == "tag:domain.tld,2009:Soliloquy-32397"
+      @item.unique_id.should == "tag:pubhubsubbub-example-app,2009:ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAw"
     end
     
     it "should have the right published" do
-      @item.published.should == Time.parse("2010-04-05T11:04:21Z")
+      @item.published.should == Time.parse("2010-03-25T16:57:18Z")
+    end
+
+    it "should have the right number of links" do
+      @item.should have(2).links
     end
     
+    describe "links" do
+      before(:each) do
+        @link = @item.links.first
+      end
+      
+      it "should have the right title" do
+        @link.title.should == "cool"
+      end
+
+      it "should have the right href" do
+        @link.href.should == "http://pubsubhubbub-example-app.appspot.com/ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAw"
+      end
+
+      it "should have the right rel" do
+        @link.rel.should == "alternate"
+      end
+
+      it "should have the right mime type" do
+        @link.type.should == "text/html"
+      end
+      
+    end
+
+    it "should have the right number of locations" do
+      @item.should have(1).locations
+    end
+    
+    describe "locations" do
+      before(:each) do
+        @location = @item.locations.first
+      end
+      
+      it "should have the right lat" do
+        @location.lat.should == 47.597553
+      end
+      
+      it "should have the right lon" do
+        @location.lon.should == -122.15925
+      end
+      
+    end
+    
+    it "should have the right number of authors" do
+      @item.should have(1).authors
+    end
+
+    describe "authors" do
+      before(:each) do
+        @author = @item.authors.first
+      end
+      
+      it "should have the right name" do
+        @author.name.should == "John Doe"
+      end
+      
+      it "should have the right uri" do
+        @author.uri.should == nil
+      end
+      
+      it "should have the right email" do
+        @author.email.should == "john@superfeedr.com"
+      end
+      
+    end
+
+    it "should have the right number of categories" do
+      @item.should have(2).categories
+    end
+    
+    describe "categories" do
+      before(:each) do
+        @category = @item.categories.first
+      end
+      
+      it "should have the right term" do
+        @category.term.should == "tag"
+      end
+    end
   end
-  
 end

data/spec/superfeedr_ruby_spec.rb

@@ -217,8 +217,8 @@ EOXML
     it "should call the block with the page number and the list of feeds as an array" do
       xml = <<-EOXML
       <iq type="result" to="you@superfeedr.com/home" id="subman1" from="firehoser.superfeedr.com">
-        <pubsub>
-          <subscriptions page="3">
+        <pubsub xmlns:superfeedr='http://superfeedr.com/xmpp-pubsub-ext' xmlns='http://jabber.org/protocol/pubsub'>
+          <subscriptions superfeedr:page="3">
             <subscription node="http://domain.tld/path/to/a/feed/atom.xml&amp;toto=tutu" subscription="subscribed" jid="you@superfeedr.com" />
             <subscription node="http://domain2.tld/path/to/feed.rss" subscription="subscribed" jid="you@superfeedr.com" />
           </subscriptions>

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: superfeedr-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 2
+  version: 0.4.2
 platform: ruby
 authors: 
 - julien Genestoux
@@ -9,29 +14,33 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-25 00:00:00 +01:00
+date: 2010-03-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: skates
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: 
 email: julien.genestoux@gmail.com
 executables: []
@@ -74,18 +83,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: superfeedr-ruby
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby Client for the Superfeedr