superfeedr-superfeedr-ruby 0.2.1 → 0.3.0

data/VERSION.yml

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

data/lib/config.yaml

@@ -0,0 +1,2 @@
+--- 
+:superfeedr_jid: firehoser.superfeedr.com

data/lib/stanzas/iq_query_stanza.rb

@@ -4,7 +4,7 @@ class IqQueryStanza
     @doc = Nokogiri::XML::Document.new
     @iq = Nokogiri::XML::Node.new("iq", @doc)
     @iq["type"] = params[:type].to_s
-    @iq["to"] = "firehoser.superfeedr.com"
+    @iq["to"] = Superfeedr.conf[:superfeedr_jid]
     @iq["id"] = "#{random_iq_id}"
     @iq["from"] = params[:from] if params[:from]
   end

data/lib/superfeedr.rb

@@ -6,6 +6,12 @@ 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
+Babylon.logger.level = Log4r::ERROR
+
+
 ##
 # Based on the API documented there : http://superfeedr.com/documentation
 module Superfeedr
@@ -52,10 +58,43 @@ module Superfeedr
   end
   
   ##
-  # Subscribe to a feed. The block passed in argument will be called upon success. 
+  # Subscribes to the multiple feeds, one by one. Calls the block after each feed.
+  def self.subscribe(*feeds, &block)
+    return if feeds.flatten! == []
+    feed = feeds.shift
+    Superfeedr.add_feed(feed) do |result|
+      subscribe(feeds, &block)
+      block.call(feed)
+    end
+  end
+  
+  ##
+  # Ubsubscribe to multiple feeds, one by one.  Calls the block after each feed.
+  def self.unsubscribe(*feeds, &block)
+    return if feeds.flatten! == []
+    feed = feeds.shift
+    Superfeedr.remove_feed(feed) do |result|
+      unsubscribe(feeds, &block)
+      block.call(feed)
+    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 |result|
+      if !result.empty?
+        subscriptions(start_page + 1, &block)
+      end
+      block.call(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 Babylon's log to Log4r::INFO for more info)
-  def self.subscribe(feed_url, &block)
+  def self.add_feed(feed_url, &block)
     raise NotConnected unless connection
     stanza = SubscribeQueryStanza.new({:node => feed_url, :from => connection.jid})
     @@callbacks[stanza.id] = Hash.new
@@ -68,7 +107,7 @@ module Superfeedr
   # 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 Babylon's log to Log4r::INFO for more info)
-  def self.unsubscribe(feed_url, &block)
+  def self.remove_feed(feed_url, &block)
     raise NotConnected unless connection
     stanza = UnsubscribeQueryStanza.new({:node => feed_url, :from => connection.jid})
     @@callbacks[stanza.id] = Hash.new
@@ -81,7 +120,7 @@ module Superfeedr
   # 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(page = 1, &block)
+  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
@@ -154,10 +193,19 @@ module Superfeedr
     if stanza["id"] && @@callbacks[stanza["id"]]
       @@callbacks[stanza["id"]][:method].call(stanza, &@@callbacks[stanza["id"]][:param])
       @@callbacks.delete(stanza["id"])
-    elsif stanza.name == "message" and stanza.at("event")["xmlns"] == "http://jabber.org/protocol/pubsub#event"
-      @@notication_callback.call(NotificationStanza.new(stanza))
-      # Here we need to call the main notification callback!
+    else
+      if stanza.name == "message" and stanza.at("event")
+        @@notication_callback.call(NotificationStanza.new(stanza))
+        # 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/superfeedr_ruby_spec.rb

@@ -12,7 +12,48 @@ describe Superfeedr do
   describe "on_stanza" do
   end
   
+  
   describe "subscribe" do
+    it "should call add_feed with feeds supplied" do
+      feeds = "a", "b", "c", "d"
+      feeds.each do |feed|
+        Superfeedr.should_receive(:add_feed).with(feed).and_yield(true)
+      end
+      Superfeedr.subscribe(feeds) do |result|
+        result.should be_true
+      end
+    end
+  end
+  
+  describe "unsubscribe" do
+    it "should call remove_feed with feeds supplied" do
+      feeds = "a", "b", "c", "d"
+      feeds.each do |feed|
+        Superfeedr.should_receive(:remove_feed).with(feed).and_yield(true)
+      end
+      Superfeedr.unsubscribe(feeds) do |result|
+        result.should be_true
+      end
+    end
+  end
+  
+  describe "subscriptions" do
+    it "should call subscriptions_by_page for each page as long as they're not empty" do
+      def method_called_upon_page
+      end
+      self.should_receive(:method_called_upon_page).exactly(4).times
+      3.times do |t|
+        Superfeedr.should_receive(:subscriptions_by_page).with(t+1).and_yield(["a", "b", "c"])
+      end
+      Superfeedr.should_receive(:subscriptions_by_page).with(4).and_yield([])      
+      Superfeedr.subscriptions do |result|
+        method_called_upon_page
+      end
+    end
+  end
+  
+  
+  describe "add_feed" do
     before(:each) do
       Superfeedr.stub!(:connection).and_return(@mock_connection)
       Superfeedr.stub!(:send).and_return(true)
@@ -27,28 +68,28 @@ describe Superfeedr do
     it "should raise an error if not connected" do
       Superfeedr.should_receive(:connection).and_return(nil)
       lambda {
-        Superfeedr.subscribe(@node, &@block)
+        Superfeedr.add_feed(@node, &@block)
       }.should raise_error(Superfeedr::NotConnected)
     end
       
     it "should create a new SubscribeQueryStanza with the right url" do
       SubscribeQueryStanza.should_receive(:new).with({:node => @node, :from => @mock_connection.jid}).and_return(@mock_stanza)
-      Superfeedr.subscribe(@node, &@block)
+      Superfeedr.add_feed(@node, &@block)
     end
     
     it "should add a Proc that just calls the block in params to the @@callbacks" do
-      Superfeedr.subscribe(@node, &@block)
+      Superfeedr.add_feed(@node, &@block)
       Superfeedr.callbacks[@mock_stanza.id][:method].should == Superfeedr.method(:on_subscribe)
       Superfeedr.callbacks[@mock_stanza.id][:param].should == @block
     end
     
     it "should send the stanza"  do
       Superfeedr.should_receive(:send).with(@mock_stanza).and_return(true)
-      Superfeedr.subscribe(@node, &@block)
+      Superfeedr.add_feed(@node, &@block)
     end
   end
   
-  describe "unsubscribe" do
+  describe "remove_feed" do
     before(:each) do
       Superfeedr.stub!(:connection).and_return(@mock_connection)
       Superfeedr.stub!(:send).and_return(true)
@@ -63,28 +104,28 @@ describe Superfeedr do
     it "should raise an error if not connected" do
       Superfeedr.should_receive(:connection).and_return(nil)
       lambda {
-        Superfeedr.unsubscribe(@node, &@block)
+        Superfeedr.remove_feed(@node, &@block)
       }.should raise_error(Superfeedr::NotConnected)
     end
       
     it "should create a new SubscribeQueryStanza with the right url" do
       UnsubscribeQueryStanza.should_receive(:new).with({:node => @node, :from => @mock_connection.jid}).and_return(@mock_stanza)
-      Superfeedr.unsubscribe(@node, &@block)
+      Superfeedr.remove_feed(@node, &@block)
     end
     
     it "should add a Proc that just calls the block in params to the @@callbacks" do
-      Superfeedr.unsubscribe(@node, &@block)
+      Superfeedr.remove_feed(@node, &@block)
       Superfeedr.callbacks[@mock_stanza.id][:method].should == Superfeedr.method(:on_unsubscribe)
       Superfeedr.callbacks[@mock_stanza.id][:param].should == @block
     end
     
     it "should send the stanza"  do
       Superfeedr.should_receive(:send).with(@mock_stanza).and_return(true)
-      Superfeedr.unsubscribe(@node, &@block)
+      Superfeedr.remove_feed(@node, &@block)
     end
   end
   
-  describe "subscriptions" do
+  describe "subscriptions_by_page" do
     before(:each) do
       Superfeedr.stub!(:connection).and_return(@mock_connection)
       Superfeedr.stub!(:send).and_return(true)
@@ -99,17 +140,17 @@ describe Superfeedr do
     it "should raise an error if not connected" do
       Superfeedr.should_receive(:connection).and_return(nil)
       lambda {
-        Superfeedr.subscriptions(@page, &@block)
+        Superfeedr.subscriptions_by_page(@page, &@block)
       }.should raise_error(Superfeedr::NotConnected)
     end
       
     it "should create a new SubscribeQueryStanza with the right url" do
       SubscriptionsQueryStanza.should_receive(:new).with({:page => @page, :from => @mock_connection.jid}).and_return(@mock_stanza)
-      Superfeedr.subscriptions(@page, &@block)
+      Superfeedr.subscriptions_by_page(@page, &@block)
     end
     
     it "should add a Proc that just calls the block in params to the @@callbacks" do
-      Superfeedr.subscriptions(@page, &@block)
+      Superfeedr.subscriptions_by_page(@page, &@block)
       Superfeedr.callbacks[@mock_stanza.id][:method].should == Superfeedr.method(:on_subscriptions)
       Superfeedr.callbacks[@mock_stanza.id][:param].should == @block
       
@@ -117,11 +158,10 @@ describe Superfeedr do
     
     it "should send the stanza"  do
       Superfeedr.should_receive(:send).with(@mock_stanza).and_return(true)
-      Superfeedr.subscriptions(@page, &@block)
+      Superfeedr.subscriptions_by_page(@page, &@block)
     end
   end
   
-  
   describe "on_subscribe" do
     it "should call the block with true if the stanza type is 'result'" do
       xml = <<-EOXML

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: superfeedr-superfeedr-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - julien Genestoux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-04 00:00:00 -07:00
+date: 2009-06-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +46,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION.yml
+- lib/config.yaml
 - lib/stanzas/iq_query_stanza.rb
 - lib/stanzas/notification_stanza.rb
 - lib/stanzas/subscribe_query_stanza.rb