ba-webby-pingback 1.0

data/README.textile

@@ -0,0 +1,75 @@
+h2. Why and what?
+
+I like webby and the idea of having a blog with static pages, not that I ever think I need the speed of it but I at least save some RAM on a daily basis. :)
+
+So this gem can send pingbacks and also receive pingbacks through "Disqus":http://www.disqus.com. What we're actually doing when receiving is just validating it as a "pingback":http://en.wikipedia.org/wiki/Pingback and then send a "trackback":http://en.wikipedia.org/wiki/Trackback to the Disqus page for the post.
+
+h2. Usage
+
+Make sure that all your posts that you want to be able to ping
+other sites have a meta-data key that is called _trackback_done_ and
+set it to false. When the ping has been done, successful or otherwise,
+it will be set to true. Eg:
+
+<pre>
+<code>
+  ---
+  title: a spiffy blogpost
+  trackback_done: false
+  ---
+</code>
+</pre>
+
+Write your posts, deploy and then run:
+
+  @webby pingback:ping@
+
+*Note:* _You've to deploy because of how the pingback protocol works._
+
+h2. Installation
+
+Install it through rubygems:  
+
+  @gem install ba-webby-pingback --source gems.github.com@
+
+h3. Installing the sender
+
+Now you've to install the rake tasks. Do this by either copying the
+pingback.rake file from the gem installation directory or create a new
+file with this content:  
+
+  @require 'webby-pingback-rake'@
+
+h3. Installing the receiver
+
+To receive pingbacks you've to run a script that can act as a XML-RPC server, I've written a CGI-script using Rubys built-in XML-RPC package (which also can run it as a standalone server or WEBrick servlet), which can be used with a CGI-script that looks like this: (a copy exists in the _ext_ folder)
+
+<pre>
+<code>
+  #!/usr/bin/env ruby  
+  # -*- coding: utf-8 -*-  
+  $KCODE = 'u'  
+
+  module Pingback  
+    Conf = {  
+      :db => 'path-to-sqlite-datbase-that-is-writable-by-server'  
+      :forum_api_key => 'long string from disqus, use rake task to get'  
+    }  
+  end  
+
+  require 'rubygems'  
+  require 'webby-pingback-xmlrpc.cgi'  
+</code>
+</pre>
+
+*Note*: _The pingback database, a sqlite database, has to be writable by the server running the cgi-script._
+
+To get the Disqus forum api key you can use a rake-task that is included in the rakefale for this gem. Just run:
+
+  @webby pingback:fetch_disqus_forum_key@
+
+The user key you can get at http://disqus.com/api/get_my_key/ when you're logged in.
+
+When the CGI-script is setup and is working you only have to add a @<link>@ tag to your blogposts that points to the CGI-script and we're done:
+
+  @<link rel="pingback" href="http://example.com/cgi-bin/pingback-xmlrpc.cgi.rb" />@

data/ext/pingback.cgi

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+$KCODE = 'u'
+
+module Pingback
+Conf = {
+  :db => 'path-to-sqlite-datbase-that-is-writable-by-server'
+  :forum_api_key => 'long string from disqus, use raketasks to get'
+}
+end 
+
+require 'rubygems'
+require 'webby-pingback-xmlrpc.cgi'

data/tasks/pingback.rake

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+
+require 'webby-pingback'
+
+namespace :pingback do
+  desc 'Ping all links in all new blogposts which hasn\'t been processed'
+  task :ping do
+    Webby.load_files
+    db = Webby::Resources.pages.find(:all, :blog_post => true, :trackback_done => false)
+    db.each do |page|
+      doc = Hpricot(File.read(Webby.site.output_dir + page.url))
+      urls = (doc/'/html/body//a[@href]').inject([]) do |memo, a|
+        if a['href'] == ("#{Webby.site.base}/") or a['href'].match(/(disqus)|(webby.rubyforge.org)/)
+          memo
+        else
+          memo << a['href']
+        end
+     end.uniq # /doc
+
+      pinger = Pingback::Sender.new("#{Webby.site.base}#{page.url}", urls)
+      pinger.start
+      Pingback.toggle_trackback_done(page.path)
+    end
+  end
+
+  desc 'Fetches the Disqus forum key, needs the User API key'
+  task :fetch_disqus_forum_key do
+    require 'open-uri'
+    require 'json'
+    disqus_url = 'http://disqus.com/api/'
+
+    print 'Disqus user API key: '
+    user_key = STDIN.gets.strip
+
+    forum_list = JSON.parse(open("#{disqus_url}get_forum_list/?user_api_key=#{user_key}").read)
+    forum_id = if forum_list['message'].size > 2
+                 puts 'Available shortnames:'
+                 forum_list['message'].each_with_index {|x, i| puts "\t#{i + 1}) #{x['shortname']}" }
+
+                 print 'Fetch shortname # '
+                 num = STDIN.gets.strip
+                 forum_list['message'][num.to_i - 1]['id']
+               else
+                 forum_list['message'][0]['id']
+               end
+
+    if forum_id
+      forum_api_key = JSON.parse(open("#{disqus_url}get_forum_api_key/?user_api_key=#{user_key}&forum_id=#{forum_id}").read)
+      if forum_api_key['succeeded']
+        puts "Forum api key: #{forum_api_key['message']}"
+      else
+        STDERR.puts 'Unknown error:'
+        STDERR.puts forum_api_key.inspect
+      end
+    end
+  end
+end

data/webby-pingback.gemspec

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name	 = "webby-pingback"
+  s.version	 = "1.0"
+  s.date	 = Time.now.strftime('%Y-%m-%d')
+  s.description	 = "Using Webby and some custom meta-data tags enable pingbacks to blogs and pages"
+  s.authors	 = ["Björn Andersson"]
+  s.email	 = "ba@sanitarium.se"
+  s.homepage	 = "http://github.com/ba/webby-pingback"
+  s.summary      = s.description
+  s.require_path = 'lib'
+  s.has_rdoc	 = false
+  s.files	 = %w[README.textile tasks/pingback.rake webby-pingback.gemspec ext/pingback.cgi] +
+                   Dir.glob('lib/*.rb')
+  s.add_dependency('amalgalite',  '>= 0.10.2')
+  s.add_dependency('json',        '>= 1.1.7')
+  s.add_dependency('hpricot',     '>= 0.8.1')
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: ba-webby-pingback
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- "Bj\xC3\xB6rn Andersson"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: amalgalite
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+    version: 
+description: Using Webby and some custom meta-data tags enable pingbacks to blogs and pages
+email: ba@sanitarium.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.textile
+- tasks/pingback.rake
+- webby-pingback.gemspec
+- ext/pingback.cgi
+has_rdoc: false
+homepage: http://github.com/ba/webby-pingback
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Using Webby and some custom meta-data tags enable pingbacks to blogs and pages
+test_files: []
+