radamanthus-superfeedr-ruby 0.4.3

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,71 @@
+= 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 Gemcutter :
+
+    sudo gem install superfeedr-ruby
+
+Source : 
+    
+    git clone git@github.com:superfeedr/superfeedr-ruby.git  
+
+
+== Example
+
+Create a directory called superfeedr-example. In the superfeedr-example directory create a file called example.rb and copy the code from the gist below into that file. Replace "demo@superfeedr.com" with "your-username@superfeedr.com" and replace the "*******" with your Superfeedr password. Next, create a directory called log in the superfeedr-example directory. Finally, run it with:
+
+    ruby example.rb
+
+Example code: {Gist}[http://gist.github.com/110247]
+
+== REQUIREMENTS:
+
+{Skates}[http://github.com/julien51/skates/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 skates
+
+== 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('skates')
+    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 @@
+--- 
+:major: 0
+:minor: 4
+:patch: 3

data/lib/config.yaml

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

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"] = Superfeedr.conf[:superfeedr_jid]
+    @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,278 @@
+##
+# 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)
+#
+# <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>
+
+require 'time'
+
+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
+  
+  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 content
+    if !@content
+      if content = @node.at_xpath("./atom:entry/atom:content", {"atom" => "http://www.w3.org/2005/Atom"})
+        @content = content.text
+      end
+    end
+    @content
+  end
+
+  def unique_id
+    @unique_id ||= @node.at_xpath("./atom:entry/atom:id", {"atom" => "http://www.w3.org/2005/Atom"}).text
+  end
+  
+  def 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
+    @node["chunks"].to_i
+  end
+  
+  def chunk
+    @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
+
+
+##
+# 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)
+#
+# 
+# <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 
+
+  XMLNS = {
+    "ps" => "http://jabber.org/protocol/pubsub#event",
+    "ps2" => "http://jabber.org/protocol/pubsub",
+    "sf" => "http://superfeedr.com/xmpp-pubsub-ext" } unless defined? XMLNS
+  
+  def next_fetch
+    if !@next_fetch
+      time = @node.at_xpath("./ps:event/sf:status/sf:next_fetch", XMLNS).text
+      @next_fetch = Time.parse(time)
+    end
+    @next_fetch
+  end
+  
+  def http_status
+    @http_status ||= @node.at_xpath("./ps:event/sf:status/sf:http/@code", XMLNS).text.to_i
+  end
+  
+  def feed_url
+    @feed_url ||= @node.at_xpath("./ps:event/sf:status/@feed", XMLNS).text
+  end
+  
+  def message_status
+    @message_status ||= @node.at_xpath("./ps:event/sf:status/sf:http", XMLNS).text
+  end
+
+  def title
+    @title ||= @node.at_xpath("./ps:event/sf:status/sf:title", XMLNS).text
+  end
+  
+  def entries
+    if !@entries
+      @entries = []
+      @node.xpath("./ps:event/ps:items/ps2:item", XMLNS).each do |node|
+        @entries.push(Item.new(node))
+      end
+    end
+    @entries
+  end
+  
+end
+