ba-webby-pingback 1.0.1 → 1.1

data/History.txt

@@ -0,0 +1,5 @@
+== 1.1 / 2009-08-25
+* Added a configuration option for the find call that fetches the posts to ping
+
+== 1.0 / 2009-08-12
+* First release

data/README.textile

@@ -7,69 +7,100 @@ So this gem can send pingbacks and also receive pingbacks through "Disqus":http:
 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
+other sites have a meta-data key that is called _pingback_done_ and
 set it to false. When the ping has been done, successful or otherwise,
-it will be set to true. Eg:
+it will be set to true. Example meta-data:
 
 <pre>
 <code>
   ---
   title: a spiffy blogpost
-  trackback_done: false
+  [..]
+  blog_post: true
+  pingback_done: false
   ---
 </code>
 </pre>
 
-Write your posts, deploy and then run:
+Write your post, deploy and then run:
 
   @webby pingback:ping@
 
-*Note:* _You've to deploy because of how the pingback protocol works._
+*Note:* _You've to deploy because of how the pingback protocol works, the receiving end must be able to retrieve the page trying to send it a pingback_
 
 h2. Installation
 
-Install it through rubygems:  
+Install it through rubygems:
 
   @gem install ba-webby-pingback --source http://gems.github.com@
 
+This library depends on these gems:
+* @amalgalite@ for SQLite database support
+* @json@ for parsing received JSON-data from Disqus
+* @hpricot@ for parsing HTML-sites and finding whether there's a link to your site in the pingback receiver
+
 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:  
+file with this content:
 
   @require 'webby-pingback-rake'@
 
+The sender has an option for finding which posts you want to send pingbacks for, as with any other Webby options you set it in your Sitefile as:
+
+  @SITE.pingback_find = [:all, {:blog_post => true, :pingback_done => false}]@
+
+The above is the default search parameter and it gets passed into the @Webby::Resources.pages.find@ method directly.
+
+You also have to set the @SITE.base@ option in your Sitefile which together with your blog posts gives the task an absolute URL to your post. Without it the sender won't be able to send URLs that the receiver can do a lookup on and your pingbacks will not be received.
+
+  @SITE.base = 'http://example.com/blog'@
+
 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'  
+  #!/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._
+*Note*: _The pingback database, a sqlite database, has to be writable by the server running the cgi-script. The database will be created if it doesn't exist, so you don't have to do anything to create it. The database is used to record incoming pingbacks so that we don't send multiple trackbacks to Disqus for the same link._
 
-To get the Disqus forum api key you can use a rake-task that is included in the rakefale for this gem. Just run:
+To get the Disqus forum api key you can use a rake-task that is included in the rakefile 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.
+The user key which the task asks for you can get at http://disqus.com/api/get_my_key/ when you're logged in to Disqus.
 
 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" />@
+  @<link rel="pingback" href="http://example.com/cgi-bin/pingback-xmlrpc.cgi.rb" />@
+
+h3. Setting up CGI with Lighttpd
+
+To get CGI-scripts to work with "ligghttpd":http://lighttpd.net you just have to activate the CGI module and then tell lighty the path to where you store the script, aka the cgi-bin directory.
+
+Note that the receiver proxy doesn't in any way require webby, so if you have any other static site you can as well use this script to get pingbacks with Disqus. :)
+
+<pre>
+<code>
+  server.modules += ("mod_cgi")
+  alias.url += ("cgi-bin" => "/var/www/cgi-bin/")
+  cgi.assign = ("" => "")
+</code>
+</pre>

data/tasks/pingback.rake

@@ -1,12 +1,17 @@
 # -*- coding: utf-8 -*-
 
+Loquacious.configuration_for(:webby) do
+  desc 'The find attributes to search for new blog posts to ping with the webby-pingback gem'
+  pingback_find [:all, {:blog_post => true, :pingback_done => false}]
+end
+
 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 = Webby::Resources.pages.find(*Webby.site.pingback_find)
     db.each do |page|
       doc = Hpricot(File.read(Webby.site.output_dir + page.url))
       urls = (doc/'/html/body//a[@href]').inject([]) do |memo, a|

data/webby-pingback.gemspec

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name	 = "webby-pingback"
-  s.version	 = "1.0.1"
+  s.version	 = "1.1"
   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"]
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   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 lib/webby-pingback-rake.rb lib/webby-pingback-xmlrpc.cgi.rb lib/webby-pingback.rb]
+  s.files	 = %w[README.textile History.txt tasks/pingback.rake webby-pingback.gemspec ext/pingback.cgi lib/webby-pingback-rake.rb lib/webby-pingback-xmlrpc.cgi.rb lib/webby-pingback.rb]
   s.add_dependency('amalgalite',  '>= 0.10.2')
   s.add_dependency('json',        '>= 1.1.7')
   s.add_dependency('hpricot',     '>= 0.8.1')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ba-webby-pingback
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: "1.1"
 platform: ruby
 authors: 
 - "Bj\xC3\xB6rn Andersson"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-15 00:00:00 -07:00
+date: 2009-08-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,7 @@ extra_rdoc_files: []
 
 files: 
 - README.textile
+- History.txt
 - tasks/pingback.rake
 - webby-pingback.gemspec
 - ext/pingback.cgi