radamanthus-superfeedr-ruby 0.4.3

data/lib/stanzas/subscribe_query_stanza.rb

@@ -0,0 +1,26 @@
+class SubscribeQueryStanza < IqQueryStanza 
+  
+  def initialize(params) 
+    raise NoFeedToSubscribe if params[:nodes].nil? or params[:nodes].empty? 
+    raise TooManyFeeds if params[:nodes].size > 30 
+    super(params.merge({:type => :set})) 
+    @pubsub = Nokogiri::XML::Node.new("pubsub", @doc) 
+    @pubsub["xmlns"] = "http://jabber.org/protocol/pubsub" 
+    params[:nodes].each do |node| 
+      add_node(node) 
+    end 
+    @iq.add_child(@pubsub) 
+  end 
+  
+  def add_node(node)
+    subscribe = Nokogiri::XML::Node.new("subscribe", @doc)
+    subscribe["node"] = node
+    subscribe["jid"] = from.split("/").first
+    @pubsub.add_child(subscribe)
+  end
+  
+  def nodes
+    @pubsub.children.map {|c| c["node"]}
+  end
+  
+end

data/lib/stanzas/subscriptions_query_stanza.rb

@@ -0,0 +1,18 @@
+class SubscriptionsQueryStanza < IqQueryStanza
+  
+  def initialize(params)
+    super(params.merge({:type => :get}))
+    pubsub = Nokogiri::XML::Node.new("pubsub", @doc)
+    pubsub["xmlns"] = "http://jabber.org/protocol/pubsub"
+    @iq.add_child(pubsub)
+    subscriptions = Nokogiri::XML::Node.new("subscriptions", @doc)
+    subscriptions["page"] = params[:page].to_s
+    subscriptions["jid"] = from.split("/").first
+    pubsub.add_child(subscriptions)
+  end
+  
+  def page
+    @iq.search("subscriptions").first["page"]
+  end
+  
+end

data/lib/stanzas/unsubscribe_query_stanza.rb

@@ -0,0 +1,27 @@
+class UnsubscribeQueryStanza < IqQueryStanza
+  
+  def initialize(params)
+    raise NoFeedToSubscribe if params[:nodes].nil? or params[:nodes].empty? 
+    raise TooManyFeeds if params[:nodes].size > 30 
+    super(params.merge({:type => :set}))
+    
+    @pubsub = Nokogiri::XML::Node.new("pubsub", @doc)
+    params[:nodes].each do |node|
+      add_node(node)
+    end
+    @pubsub["xmlns"] = "http://jabber.org/protocol/pubsub"
+    @iq.add_child(@pubsub)
+  end 
+  
+  def add_node(node)
+    unsubscribe = Nokogiri::XML::Node.new("unsubscribe", @doc)
+    unsubscribe["node"] = node.to_s
+    unsubscribe["jid"] = from.split("/").first
+    @pubsub.add_child(unsubscribe)
+  end
+  
+  def nodes
+    @pubsub.children.map {|c| c["node"]}
+  end
+  
+end

data/lib/superfeedr.rb

@@ -0,0 +1,213 @@
+require "skates"
+require "stanzas/iq_query_stanza.rb"
+require "stanzas/notification_stanza.rb"
+require "stanzas/subscribe_query_stanza.rb"
+require "stanzas/unsubscribe_query_stanza.rb"
+require "stanzas/subscriptions_query_stanza.rb"
+
+##
+# By default, the log level is at error. You can change that at anytime in your app
+Skates.logger.level = Log4r::ERROR
+
+##
+# Based on the API documented there : http://superfeedr.com/documentation
+module Superfeedr
+  
+  class NotConnected < StandardError; end
+  
+  @@connection = nil
+  @@callbacks = {}
+  @@connection_callback = nil
+  @@notification_callback = nil
+  
+  ##
+  # Connects your client to the Superfeedr.com XMPP server. You need to pass the following arguments :
+  # "jid" : login@superfeedr.com
+  # "password" : your superfeedr.com password
+  # ["host" : host for your jid or component : only useful if you use an external jid ]
+  # ["port" : port for your jid or component : only useful if you use an external jid ]
+  # ["app_type" : (client | component) only useful if you use an external jid ]
+  # The optional block will be called upon connection.
+  def self.connect(jid, password, host = nil, port = nil, app_type = "client", &block)
+
+    params = {
+      "jid" => jid,
+      "password" => password,
+      "host" => host,
+      "port" => port
+    }
+    @@connection_callback = block
+    
+    run = Proc.new {
+      if app_type == "client"
+        Skates::ClientConnection.connect(params, self) 
+      else 
+        Skates::ComponentConnection.connect(params, self) 
+      end          
+    }
+    
+    if EventMachine.reactor_running?
+      run.call
+    else
+    EventMachine.run {
+      run.call
+    }
+    end
+  end
+  
+  ##
+  # Subscribes to the multiple feeds, 30 by 30. Calls the block after each set of 30 feeds.
+  def self.subscribe(*feeds, &block)
+    return if feeds.flatten! == []
+    subset = feeds.slice!(0..29)
+    Superfeedr.add_feeds(subset) do |result|
+      subscribe(feeds, &block)
+      block.call(subset) 
+    end
+  end
+  
+  ##
+  # Ubsubscribe to multiple feeds, one by one.  Calls the block after each set of 30 feeds.
+  def self.unsubscribe(*feeds, &block)
+    return if feeds.flatten! == []
+    subset = feeds.slice!(0..29)
+    Superfeedr.remove_feeds(subset) do |result|
+      unsubscribe(feeds, &block)
+      block.call(subset) 
+    end
+  end
+  
+  ##
+  # List all subscriptions, by sending them by blocks (page), starting at page specified in argument
+  def self.subscriptions(start_page = 1, &block)
+    Superfeedr.subscriptions_by_page(start_page) do |page, result|
+      if !result.empty?
+        subscriptions(start_page + 1, &block)
+      end
+      block.call(page, result)
+    end
+  end
+  
+  ##
+  # Adds the url to the list of feeds you're monitoring. The block passed in argument will be called upon success. 
+  # The block will take one boolen argument : true means everything went right... false means something failed! 
+  # (Please set Skates's log to Log4r::INFO for more info)
+  def self.add_feeds(feeds_url, &block)
+    raise NotConnected unless connection
+    stanza = SubscribeQueryStanza.new({:nodes => feeds_url, :from => connection.jid})
+    @@callbacks[stanza.id] = Hash.new
+    @@callbacks[stanza.id][:method] = method(:on_subscribe)
+    @@callbacks[stanza.id][:param] = block
+    send(stanza)
+  end
+  
+  ## 
+  # Unsubscribe from a feed. The block passed in argument will be called upon success. 
+  # The block will take one boolen argument  : true means everything went right... false means something failed! 
+  # (Please set Skates's log to Log4r::INFO for more info)
+  def self.remove_feeds(feeds_url, &block)
+    raise NotConnected unless connection
+    stanza = UnsubscribeQueryStanza.new({:nodes => feeds_url, :from => connection.jid})
+    @@callbacks[stanza.id] = Hash.new
+    @@callbacks[stanza.id][:method] = method(:on_unsubscribe)
+    @@callbacks[stanza.id][:param] = block
+    send(stanza)
+  end
+  
+  ##
+  # Lists the subscriptions by page. The block passed in argument will be called with 2 arguments : the page, 
+  # and an array of the feed's url in the page you requested. 
+  # (Currently the Superfeedr API only supports 30 feeds per page.)
+  def self.subscriptions_by_page(page = 1, &block)
+    raise NotConnected unless connection
+    stanza = SubscriptionsQueryStanza.new({:page => page, :from => connection.jid})
+    @@callbacks[stanza.id] = Hash.new
+    @@callbacks[stanza.id][:method] = method(:on_subscriptions)
+    @@callbacks[stanza.id][:param] = block
+    send(stanza)
+  end
+  
+  ##
+  # Specifies the block that will be called upon notification. 
+  # Your block should take a NotificationStanza instance argument.
+  def self.on_notification(&block)
+    @@notification_callback = block
+  end
+  
+  ##
+  # Called with a response to a subscriptions listing
+  def self.on_subscriptions(stanza, &block)
+    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
+  
+  ##
+  # Called with a response to a subscribe
+  def self.on_subscribe(stanza, &block)
+    block.call(stanza["type"] == "result")
+  end
+  
+  ##
+  # Called with a response to an unsubscribe.
+  def self.on_unsubscribe(stanza, &block)
+    block.call(stanza["type"] == "result")
+  end
+  
+  ##
+  # ::nodoc::
+  def self.callbacks
+    @@callbacks
+  end
+  
+  ##
+  # ::nodoc::  
+  def self.connection
+    @@connection
+  end
+  
+  ##
+  # ::nodoc::
+  def self.send(xml)
+    connection.send_xml(xml)
+  end
+  
+  ##
+  # ::nodoc::
+  def self.on_connected(connection) 
+    @@connection = connection
+    @@connection_callback.call
+  end
+  
+  ##
+  # ::nodoc::
+  def self.on_disconnected()
+    @@connection = false
+  end
+  
+  ##
+  # This shall not be called by your application. It is called upon stanza recetion. If it is a reply to a stanza we sent earlier, then, we just call it's associated callback. If it is a notification stanza, then, we call the notification callback (that you should have given when calling Superfeedr.connect) with a NotificationStanza instance.
+  def self.on_stanza(stanza)
+    if stanza["id"] && @@callbacks[stanza["id"]]
+      @@callbacks[stanza["id"]][:method].call(stanza, &@@callbacks[stanza["id"]][:param])
+      @@callbacks.delete(stanza["id"])
+    else
+      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
+    end
+  end
+  
+  ##
+  # Config loaded from config.yaml
+  def self.conf
+    @@conf ||= YAML::load(File.read(File.dirname(__FILE__) + '/config.yaml'))
+  end
+  
+  
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format nested
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'spec'
+require "rubygems"
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'superfeedr'
+require "skates"
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/stanzas/iq_query_stanza_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+shared_examples_for "Iq Query Stanzas" do
+
+  it "should have the right type" do
+    IqQueryStanza.new(@params).type.should == @params[:type]
+  end
+    
+  it "should have the right to" do
+    IqQueryStanza.new(@params).to.should == "firehoser.superfeedr.com"
+  end
+  
+  it "should have a random id" do
+    IqQueryStanza.new(@params).id.should match /[0..9]*/
+  end
+  
+  it "should have the right from" do
+    IqQueryStanza.new(@params).from.should == @params[:from]
+  end
+
+end
+
+describe IqQueryStanza do
+  before(:each) do
+    @params = { :type => "set", :from => "me@server.com/resource"}
+  end
+  
+  it_should_behave_like "Iq Query Stanzas"
+  
+end

data/spec/stanzas/notifications_stanza_spec.rb

@@ -0,0 +1,184 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+describe NotificationStanza do
+  
+  before(:each) do
+    xml = <<-EOXML
+    <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="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>
+              <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 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(Nokogiri::XML(xml).root)
+  end
+  
+  it "should have the right feed_url" do
+    @stanza.feed_url.should == "http://pubsubhubbub-example-app.appspot.com/feed"
+  end
+  
+  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 right next_fetch" do
+    @stanza.next_fetch.should == Time.parse("2010-03-25T17:06:30+00:00")
+  end
+
+  it "should have the title" do
+    @stanza.title.should == 'PubSubHubBub example app'
+  end
+  
+  it "should have the right number of items" do
+    @stanza.entries.count.should == 2
+  end
+  
+  describe "items" do
+    before(:each) do
+      @item = @stanza.entries.first
+    end
+    
+    it "should have the right chunk" do
+      @item.chunk.should == 1
+    end
+    
+    it "should have the right chunks" do
+      @item.chunks.should == 2
+    end
+    
+    it "should have the right title" do
+      @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 unique_id" do
+      @item.unique_id.should == "tag:pubhubsubbub-example-app,2009:ahhwdWJzdWJodWJidWItZXhhbXBsZS1hcHByDQsSBUVudHJ5GMGOEAw"
+    end
+    
+    it "should have the right published" do
+      @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