superfeedr-superfeedr-ruby 0.2.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 julien
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,69 @@
+= superfeedr-ruby
+
+Yes, the gem is called superfeedr-ruby, but the library is superfeedr only ;)
+
+{Superfeedr.com}[http://superfeedr.com] is a Real-time Cloud Feed Parsing service
+
+* *Realtime* : By combining different technologies we can notify you of new entries in less than 15 minutes (or it's free)
+* *No* *more* *polling* : Stop wasting your time and resources fetching 'old data', and stop being late when there is new data.
+* *Simplicity* : give us urls, and we'll do the rest. Check our docs and tutorials.
+* *Standardization* : No more nightmares with gazillions of formats, we will send you strict ATOM, whatever the original feed format is.
+* *Multi*-*channel* : receive the notifications by XMPP, on a local JID or your own external JID, or using WebHooks.
+* *Cost* *saving* : we will match the cost of your existing system.
+
+== FEATURES:
+
+* Subscribe to a feed
+
+    Superfeedr.subscribe("http://github.com/superfeedr.atom") do |result|
+        puts "Yay, subscribed to the github Atom feed for Superfeedr" if result
+    end
+      
+* Unsubscribe from a feed
+    
+    Superfeedr.unsubscribe("http://github.com/superfeedr.atom") do |result|
+        puts "Sad, you unsubscribed from the github Atom feed for Superfeedr" if result
+    end
+
+* List subscriptions by page
+    
+    Superfeedr.subscriptions(5) do |page, feeds|
+        puts "On page #{page}" : 
+        puts feeds.inspect
+      end
+
+* Receive notifications 
+
+    Superfeedr.on_notification do |notification|
+        puts "The feed #{notification.feed_url} has been fetched (#{notification.http_status}: #{notification.message_status}) and will be fetched again in #{(notification.next_fetch - Time.now)/60} minutes."
+        notification.entries.each do |e|
+            puts " - #{e.title} (#{e.link}) was published (#{e.published}) with #{e.unique_id} as unique id : \n #{e.summary} (#{e.chunk}/#{e.chunks})"
+        end
+    end
+
+== Install
+
+Install the gem from Github :
+
+    gem sources -a http://gems.github.com
+    sudo gem install superfeedr-superfeedr-ruby
+
+Source : 
+    
+    git clone git@github.com:superfeedr/superfeedr-ruby.git  
+
+
+== Example
+
+Please see this {Gist}[http://gist.github.com/110247] while I am trying to find a way to integrate it into this document ;)
+
+
+== REQUIREMENTS:
+
+{Babylon}[http://github.com/julien51/babylon/tree/master] : please note that there are 2 gems named Baylon. The one you want is the one about XMPP, you can get it with :
+    
+    sudo gem install babylon-julien51
+
+== Copyright
+
+Copyright (c) 2009 julien. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,80 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+    gem.name = "superfeedr-ruby"
+    gem.version = "#{version}"
+    gem.summary = %Q{Ruby Client for the Superfeedr}
+    gem.email = "julien.genestoux@gmail.com"
+    gem.homepage = "http://github.com/julien51/superfeedr-ruby"
+    gem.authors = ["julien Genestoux"]
+    gem.rubyforge_project = "superfeedr-ruby"
+    gem.add_dependency('julien51-babylon')
+    gem.add_dependency('nokogiri')
+    gem.has_rdoc = true
+    gem.homepage = 'http://github.com/julien51/superfeedr-ruby/'
+    gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test,spec}/**/*"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "superfeedr-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+    
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+        
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/superfeedr-ruby/"
+        local_dir = 'rdoc'
+        
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION.yml

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

data/lib/stanzas/iq_query_stanza.rb

@@ -0,0 +1,36 @@
+class IqQueryStanza
+  
+  def initialize(params =  {})
+    @doc = Nokogiri::XML::Document.new
+    @iq = Nokogiri::XML::Node.new("iq", @doc)
+    @iq["type"] = params[:type].to_s
+    @iq["to"] = "firehoser.superfeedr.com"
+    @iq["id"] = "#{random_iq_id}"
+    @iq["from"] = params[:from] if params[:from]
+  end
+  
+  def type
+    @iq["type"]
+  end
+  
+  def to
+    @iq["to"]
+  end
+  
+  def from
+    @iq["from"]
+  end
+  
+  def id
+    @iq["id"]
+  end
+  
+  def random_iq_id
+    rand(1000)
+  end
+  
+  def to_s
+    @iq.to_s
+  end
+  
+end

data/lib/stanzas/notification_stanza.rb

@@ -0,0 +1,66 @@
+##
+# Repesents the items published by the firehoser (the feed entries).
+# They have accessors for the following fields :
+# - title 
+# - summary 
+# - link
+# - published
+# - unique_id
+# - chunks (long entries might be notified in several chunks)
+# - chunk (current chunk out of chunks)
+#
+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 published
+    Time.parse(@published)
+  end
+  
+  def chunks
+    @chunks.to_i
+  end
+  
+  def chunk
+    @chunk.to_i
+  end
+  
+end
+
+
+##
+# Notification : sent every time a feed has been fetched. It has the following methods: 
+# - message_status : a simple message that gives information about the last fetch
+# - http_status : status of the http response
+# - 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
+  
+  def next_fetch
+    Time.parse(@next_fetch)
+  end
+  
+  def http_status
+    @http_status.to_i
+  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
+  
+end
+

data/lib/stanzas/subscribe_query_stanza.rb

@@ -0,0 +1,18 @@
+class SubscribeQueryStanza < IqQueryStanza
+  
+  def initialize(params)
+    super(params.merge({:type => :set}))
+    pubsub = Nokogiri::XML::Node.new("pubsub", @doc)
+    pubsub["xmlns"] = "http://jabber.org/protocol/pubsub"
+    subscribe = Nokogiri::XML::Node.new("subscribe", @doc)
+    subscribe["node"] = params[:node]
+    subscribe["jid"] = from.split("/").first
+    pubsub.add_child(subscribe)
+    @iq.add_child(pubsub)
+  end 
+  
+  def node
+    @iq.search("subscribe").first["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,18 @@
+class UnsubscribeQueryStanza < IqQueryStanza
+  
+  def initialize(params)
+    super(params.merge({:type => :set}))
+    pubsub = Nokogiri::XML::Node.new("pubsub", @doc)
+    pubsub["xmlns"] = "http://jabber.org/protocol/pubsub"
+    @iq.add_child(pubsub)
+    unsubscribe = Nokogiri::XML::Node.new("unsubscribe", @doc)
+    unsubscribe["node"] = params[:node].to_s
+    unsubscribe["jid"] = from.split("/").first
+    pubsub.add_child(unsubscribe)
+  end 
+  
+  def node
+    @iq.search("unsubscribe").first["node"]
+  end
+  
+end

data/lib/superfeedr.rb

@@ -0,0 +1,163 @@
+require "babylon"
+require "nokogiri"
+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"
+
+##
+# Based on the API documented there : http://superfeedr.com/documentation
+module Superfeedr
+  
+  class NotConnected < StandardError; end
+  
+  @@connection = nil
+  @@callbacks = {}
+  @@connection_callback = nil
+  @@notication_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"
+        Babylon::ClientConnection.connect(params, self) 
+      else 
+        Babylon::ComponentConnection.connect(params, self) 
+      end          
+    }
+    
+    if EventMachine.reactor_running?
+      run.call
+    else
+    EventMachine.run {
+      run.call
+    }
+    end
+  end
+  
+  ##
+  # Subscribe to 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.subscribe(feed_url, &block)
+    raise NotConnected unless connection
+    stanza = SubscribeQueryStanza.new({:node => feed_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 Babylon's log to Log4r::INFO for more info)
+  def self.unsubscribe(feed_url, &block)
+    raise NotConnected unless connection
+    stanza = UnsubscribeQueryStanza.new({:node => feed_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(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)
+    @@notication_callback = block
+  end
+  
+  ##
+  # Called with a response to a subscriptions listing
+  def self.on_subscriptions(stanza, &block)
+    page = stanza.xpath('//xmlns:subscriptions', { 'xmlns' => 'http://jabber.org/protocol/pubsub' }).first["page"].to_i
+    feeds = stanza.xpath('//xmlns:subscription', { 'xmlns' => 'http://jabber.org/protocol/pubsub' }).map { |s| 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"])
+    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!
+    end
+  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 "babylon"
+
+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,91 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+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>
+        </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>
+              <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>
+            </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>
+            </entry>
+          </item>
+        </items>
+      </event>
+    </message>
+    EOXML
+    @stanza = NotificationStanza.new(xml)
+  end
+  
+  it "should have the right feed_url" do
+    @stanza.feed_url.should == "http://domain.tld/path/to/feed.xml"
+  end
+  
+  it "should have the right message_status" 
+  
+  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")
+  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 == "Soliloquy"
+    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"
+    end
+    
+    it "should have the right published" do
+      @item.published.should == Time.parse("2010-04-05T11:04:21Z")
+    end
+    
+  end
+  
+end

data/spec/stanzas/subscribe_stanza_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/iq_query_stanza_spec'
+describe SubscribeQueryStanza do
+  
+  it_should_behave_like "Iq Query Stanzas"
+  
+  before(:each) do
+    @params = { :type => "set", :from => "me@server.com/resource", :node => "http//domain.tld/feed.xml", :type => "set", :from => "me@server.com/resource"}
+  end
+  
+  it "should have the right node value" do
+    SubscribeQueryStanza.new(@params).node.should == @params[:node]
+  end
+  
+end

data/spec/stanzas/subscriptions_stanza_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/iq_query_stanza_spec'
+describe SubscriptionsQueryStanza do
+  
+  it_should_behave_like "Iq Query Stanzas"
+  
+  before(:each) do
+    @params = { :type => "set", :from => "me@server.com/resource", :page => 3, :type => "set", :from => "me@server.com/resource"}
+  end
+  
+  it "should have the right page value" do
+    SubscriptionsQueryStanza.new(@params).page.should == @params[:page].to_s
+  end
+  
+end

data/spec/stanzas/unsubscribe_stanza_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/iq_query_stanza_spec'
+describe UnsubscribeQueryStanza do
+  
+  it_should_behave_like "Iq Query Stanzas"
+  
+  before(:each) do
+    @params = { :type => "set", :from => "me@server.com/resource", :node => "http//domain.tld/feed.xml", :type => "set", :from => "me@server.com/resource"}
+  end
+  
+  it "should have the right node value" do
+    UnsubscribeQueryStanza.new(@params).node.should == @params[:node]
+  end
+  
+end

data/spec/superfeedr_ruby_spec.rb

@@ -0,0 +1,199 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Superfeedr do
+  
+  before(:each) do
+    @mock_connection = mock(Babylon::XmppConnection, {:send_xml => true, :jid => "client@server.tld/resource"})
+  end
+  
+  describe "connect" do
+  end
+  
+  describe "on_stanza" do
+  end
+  
+  describe "subscribe" do
+    before(:each) do
+      Superfeedr.stub!(:connection).and_return(@mock_connection)
+      Superfeedr.stub!(:send).and_return(true)
+      @block = Proc.new {
+        
+      }
+      @node = "http://domain.com/feed.xml"
+      @mock_stanza = mock(SubscribeQueryStanza, {:id => "123"})
+      SubscribeQueryStanza.stub!(:new).and_return(@mock_stanza)
+    end
+    
+    it "should raise an error if not connected" do
+      Superfeedr.should_receive(:connection).and_return(nil)
+      lambda {
+        Superfeedr.subscribe(@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)
+    end
+    
+    it "should add a Proc that just calls the block in params to the @@callbacks" do
+      Superfeedr.subscribe(@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)
+    end
+  end
+  
+  describe "unsubscribe" do
+    before(:each) do
+      Superfeedr.stub!(:connection).and_return(@mock_connection)
+      Superfeedr.stub!(:send).and_return(true)
+      @block = Proc.new {
+        
+      }
+      @node = "http://domain.com/feed.xml"
+      @mock_stanza = mock(UnsubscribeQueryStanza, {:id => "123"})
+      UnsubscribeQueryStanza.stub!(:new).and_return(@mock_stanza)
+    end
+    
+    it "should raise an error if not connected" do
+      Superfeedr.should_receive(:connection).and_return(nil)
+      lambda {
+        Superfeedr.unsubscribe(@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)
+    end
+    
+    it "should add a Proc that just calls the block in params to the @@callbacks" do
+      Superfeedr.unsubscribe(@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)
+    end
+  end
+  
+  describe "subscriptions" do
+    before(:each) do
+      Superfeedr.stub!(:connection).and_return(@mock_connection)
+      Superfeedr.stub!(:send).and_return(true)
+      @block = Proc.new {
+        
+      }
+      @page = 3
+      @mock_stanza = mock(SubscriptionsQueryStanza, {:id => "123"})
+      SubscriptionsQueryStanza.stub!(:new).and_return(@mock_stanza)
+    end
+    
+    it "should raise an error if not connected" do
+      Superfeedr.should_receive(:connection).and_return(nil)
+      lambda {
+        Superfeedr.subscriptions(@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)
+    end
+    
+    it "should add a Proc that just calls the block in params to the @@callbacks" do
+      Superfeedr.subscriptions(@page, &@block)
+      Superfeedr.callbacks[@mock_stanza.id][:method].should == Superfeedr.method(:on_subscriptions)
+      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.subscriptions(@page, &@block)
+    end
+  end
+  
+  
+  describe "on_subscribe" do
+    it "should call the block with true if the stanza type is 'result'" do
+      xml = <<-EOXML
+      <iq type="result" to="you@superfeedr.com/home" from="firehoser.superfeedr.com" id="sub1">
+        <pubsub xmlns="http://jabber.org/protocol/pubsub">
+          <subscription jid="you@superfeedr.com" subscription="subscribed" node="http://domain.tld/path/to/feed.xml"/>
+        </pubsub>
+      </iq>
+      EOXML
+      stanza = Nokogiri::XML(xml) 
+      Superfeedr.on_subscribe(stanza.root) do |res|
+        res.should be_true
+      end
+    end
+    
+    it "should call the block with false if the stanza type is not 'result'" do
+      xml = <<-EOXML
+      <iq type="error" to="you@superfeedr.com/home" from="firehoser.superfeedr.com" id="sub1">
+        <pubsub xmlns="http://jabber.org/protocol/pubsub">
+          <subscription jid="you@superfeedr.com" subscription="subscribed" node="http://domain.tld/path/to/feed.xml"/>
+        </pubsub>
+      </iq>
+EOXML
+      stanza = Nokogiri::XML(xml) 
+      Superfeedr.on_subscribe(stanza.root) do |res|
+        res.should be_false
+      end
+    end
+    
+  end
+  
+  describe "on_unsubscribe" do
+    it "should call the block with true if the stanza type is 'result'" do
+      xml = <<-EOXML
+        <iq type='result' from='firehoser.superfeedr.com' to='you@superfeedr.com/home' id='unsub1' />
+      EOXML
+      stanza = Nokogiri::XML(xml) 
+      Superfeedr.on_unsubscribe(stanza.root) do |res|
+        res.should be_true
+      end
+    end
+    
+    it "should call the block with false if the stanza type is not 'result'" do
+      xml = <<-EOXML
+        <iq type='error' from='firehoser.superfeedr.com' to='you@superfeedr.com/home' id='unsub1' />
+      EOXML
+      stanza = Nokogiri::XML(xml) 
+      Superfeedr.on_unsubscribe(stanza.root) do |res|
+        res.should be_false
+      end
+    end
+  end
+  
+  describe "on_subscriptions" do
+    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 xmlns="http://jabber.org/protocol/pubsub" xmlns:superfeedr="http://superfeedr.com/xmpp-pubsub-ext" >
+          <subscriptions superfeedr:page="3">
+            <subscription node="http://domain.tld/path/to/a/feed/atom.xml" subscription="subscribed" jid="you@superfeedr.com" />
+            <subscription node="http://domain2.tld/path/to/feed.rss" subscription="subscribed" jid="you@superfeedr.com" />
+          </subscriptions>
+        </pubsub>
+      </iq>
+      EOXML
+      stanza = Nokogiri::XML(xml) 
+      Superfeedr.on_subscriptions(stanza.root) do |page, subscriptions|
+        page.should == 3
+        subscriptions.should == ["http://domain.tld/path/to/a/feed/atom.xml", "http://domain2.tld/path/to/feed.rss"] 
+      end
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: superfeedr-superfeedr-ruby
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- julien Genestoux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: julien51-babylon
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: julien.genestoux@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/stanzas/iq_query_stanza.rb
+- lib/stanzas/notification_stanza.rb
+- lib/stanzas/subscribe_query_stanza.rb
+- lib/stanzas/subscriptions_query_stanza.rb
+- lib/stanzas/unsubscribe_query_stanza.rb
+- lib/superfeedr.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/stanzas/iq_query_stanza_spec.rb
+- spec/stanzas/notifications_stanza_spec.rb
+- spec/stanzas/subscribe_stanza_spec.rb
+- spec/stanzas/subscriptions_stanza_spec.rb
+- spec/stanzas/unsubscribe_stanza_spec.rb
+- spec/superfeedr_ruby_spec.rb
+has_rdoc: true
+homepage: http://github.com/julien51/superfeedr-ruby/
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: superfeedr-ruby
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby Client for the Superfeedr
+test_files: 
+- spec/spec_helper.rb
+- spec/stanzas/iq_query_stanza_spec.rb
+- spec/stanzas/notifications_stanza_spec.rb
+- spec/stanzas/subscribe_stanza_spec.rb
+- spec/stanzas/subscriptions_stanza_spec.rb
+- spec/stanzas/unsubscribe_stanza_spec.rb
+- spec/superfeedr_ruby_spec.rb