arrow 1.0.7

data/data/arrow/applets/tutorial/missing.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# 
+# The MissingApplet class, a derivative of Arrow::Applet. It
+# is an example 'missingApplet' applet.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+
+### An example missingApplet applet.
+class MissingApplet < Arrow::Applet
+
+
+	# Applet signature
+	Signature = {
+		:name => "No-such-applet handler",
+		:description => "An example 'missingApplet' applet. If Arrow is configured " +
+						"with the uri of this applet as the missingApplet value, " +
+						"it will run this applet instead of declining requests for " +
+						"URIs that don't match a registered applet.",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'display',
+		:templates => {
+			:display	=> 'missingapplet.tmpl',
+		},
+	}
+
+	# No action: defaults to loading and displaying the template with the same
+	# name as the action.
+
+end # class NoSuchAppletHandler
+
+

data/data/arrow/applets/tutorial/protected.rb

@@ -0,0 +1,100 @@
+#!/usr/bin/env ruby
+# 
+# The ProtectedDelegator class, a derivative of
+# Arrow::Applet. It is an applet you can chain through for authentication
+# purposes.
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'digest/md5'
+
+require 'arrow/applet'
+
+
+### An example applet that you can chain through for simple authentication.
+class ProtectedDelegator < Arrow::Applet
+
+
+	Users = {
+		'ged'			=> "30ff9a6c184a0fde7ac7ade1479ee19f",
+		'stillflame'	=> "4a484004cef4efebf22b2f7ec9cdc439",
+	}
+
+	# Applet signature
+	Signature = {
+		:name => "Password-protected delegator",
+		:description => "It is an applet you can chain through for authentication purposes.",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'default',
+		:templates	=> {
+			:default	=> 'protected.tmpl',
+			:loginform	=> 'loginform.tmpl',
+			:logout		=> 'logout.tmpl',
+		},
+	}
+
+
+
+	######
+	public
+	######
+
+	def delegate( txn, chain, *args )
+		self.log.debug "Checking authentication for the %s applet." % args[0]
+
+		if !txn.session.key?( :user )
+			rval = self.run( txn, 'loginform', *args )
+			unless rval == true
+				return rval
+			end
+		end
+
+		yield( chain )
+	end
+
+
+	def_action :logout do |txn, *args|
+		txn.session.delete( :user )
+
+		templ = self.load_template( :logout )
+		templ.txn = txn
+
+		return templ
+	end
+
+	def_action :loginform do |txn, *args|
+		self.log.debug "In the 'display' action of the '%s' applet." %
+			self.signature.name 
+
+		username = txn.request.param('username')
+		password = txn.request.param('password')
+		errors = []
+
+		if username
+			pwhash = Digest::MD5.hexdigest( password )
+			if !password
+				errors << "No password given."
+			elsif Users[ username ] != pwhash
+				self.log.error "Auth failure: %p vs %p" %
+					[ Users[username], pwhash ]
+				errors << "Authentication failure."
+			else
+				txn.session[:user] = username
+				return true
+			end
+		end
+
+		templ = self.load_template( :loginform )
+		templ.txn = txn
+		templ.errors = errors unless errors.empty?
+
+		return templ
+	end
+
+
+end # class ProtectedDelegator
+
+

data/data/arrow/applets/tutorial/redirector.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+# 
+# The RedirectorApplet class, a derivative of
+# Arrow::Applet. It's only a demonstration of the Transaction's #redirect
+# method.
+# 
+# == VCS Id
+# 
+# $Id$
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+
+
+### It's only a demonstration of the Transaction's #redirect method.
+class RedirectorApplet < Arrow::Applet
+
+
+	# The default URI to redirect to
+	DefaultURI = "status"
+
+
+	# Applet signature
+	Signature = {
+		:name => "Redirector",
+		:description => "It's only a demonstration of the Transaction's #redirect method.",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'redirect',
+	}
+
+
+
+	######
+	public
+	######
+
+	def redirect_action( txn, *args )
+		self.log.debug "In the 'redirect' action of the '%s' app." %
+			self.signature.name 
+
+		uri = args.empty? ? DefaultURI : args.join("/")
+		return txn.redirect( txn.app_root + "/" + uri )
+	end
+	alias_method :action_missing_action, :redirect_action
+
+end # class RedirectorApplet
+
+

data/data/arrow/applets/tutorial/rndimages.rb

@@ -0,0 +1,159 @@
+#!/usr/bin/env ruby
+# 
+# The RandomImages class, a derivative of Arrow::Applet. It
+# shows the 'latest images' feed from LiveJournal as a page full of clickable
+# links.
+# 
+# == VCS Id
+# 
+# $Id$
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'uri'
+require 'net/http'
+
+require 'arrow/applet'
+
+### It shows the 'latest images' feed from LiveJournal as a page full of clickable links.
+class RandomImages < Arrow::Applet
+
+
+	# Default feed URL if none is configured
+	DefaultFeedUrl = 'http://www.livejournal.com/stats/latest-img.bml'
+
+	# Default number of seconds to cache the image list
+	DefaultCacheSeconds = 15 * 60
+
+	# Recent-image entry pattern
+	RecentImagePattern = %r{
+		<recent-image			# Tag open
+		  \s+					# whitespace
+		 img='([^']+)'			# $1 = image URL
+		  \s+					# whitespace
+		 url='([^']+)'			# $2 = link URL
+		  \s*					# whitspace
+		/>						# Tag close
+	}x
+
+	# Image struct
+	Image = Struct.new( :src, :href )
+
+	# Default number of images to display from the feed at a time
+	DefaultImageCount = 15
+
+	# Applet signature
+	Signature = {
+		:name => "Random image gallery",
+		:description => "Shows the 'latest images' feed from LiveJournal as " +
+			"a page full of clickable links.",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'display',
+		:templates => {
+			:display	=> 'rndimages.tmpl',
+		}
+	}
+
+
+	### Set up the random image gallery.
+	def initialize( *args )
+		super
+
+		if @config.respond_to?( :rndimages )
+			feeduri = @config.rndimages.feedurl
+			@cache_seconds = Integer( @config.rndimages.cacheseconds ) rescue nil
+			@count = Integer( @config.rndimages.displaycount ) rescue nil
+		end
+
+		feeduri ||= DefaultFeedUrl
+		@feeduri = URI.parse( feeduri )
+
+		@cache_seconds ||= DefaultCacheSeconds
+		@cache_expiry = Time.at( 0 )
+		@count ||= DefaultImageCount
+		@images = []
+	end
+
+
+
+	######
+	public
+	######
+
+	def_action :display do |txn, *args|
+		if @cache_expiry < Time.now
+			self.log.debug "Cached images expired at %s: Fetching new list" %
+				[ @cache_expiry ]
+			@images = self.build_imagelist( @feeduri )
+			@cache_expiry = Time.now + @cache_seconds
+		end
+
+		imgslice = []
+		until imgslice.nitems == @count
+			imgslice << rand( @images.nitems )
+			imgslice.uniq!
+		end
+
+		tmpl = self.load_template( :display )
+		tmpl.txn = txn
+		tmpl.app = self
+		tmpl.images = @images.values_at( *imgslice )
+
+		return tmpl
+	end
+
+
+
+	#########
+	protected
+	#########
+
+	### Fetch the list of images in the feed and replace the ones currently in
+	### @images, if any.
+	def build_imagelist( feeduri )
+		rawfeed = self.fetch_imagefeed( feeduri )
+		images = self.parse_imagefeed( rawfeed )
+
+		return images
+	end
+
+
+	### Fetch the raw imagelist over HTTP and return it. An exception is raised
+	### if the fetch fails for some reason.
+	def fetch_imagefeed( uri )
+		res = nil
+
+		Net::HTTP.start( uri.host, uri.port ) do |http|
+			res = http.get( uri.path )
+		end
+
+		unless Net::HTTPSuccess === res
+			raise "Fetch of %s failed: %d: %s" %
+				[ uri, res.code, res.message ]
+		end
+
+		return res.body
+	end
+
+
+	### Parse the given +rawdata+ from the image feed and return an Array of
+	### Hashes that describe the images referenced therein.
+	def parse_imagefeed( rawdata )
+		images = []
+
+		rawdata.scan( RecentImagePattern ) do |match|
+			self.log.debug "Matched image tag: %p" % match
+			images << Image.new( $1, $2 )
+		end
+
+		self.log.debug "Parsed images: %p ..." % images[0..3]
+		return images
+	end
+
+
+end # class RandomImages
+
+

data/data/arrow/applets/tutorial/sharenotes.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# 
+# The ShareNotes class, a derivative of Arrow::Applet. Render
+# a shared document after being transformed via Markdown
+# 
+# == VCS Id
+# 
+# $Id$
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+require 'arrow/applet'
+require 'bluecloth'
+
+### Render a shared document after being transformed via Markdown
+class ShareNotes < Arrow::Applet
+
+	# Default share directory
+	DefaultDirectory = "/Users/ged/Documents"
+
+
+	# Applet signature
+	Signature = {
+		:name => "sharenotes",
+		:description => "Render a shared document after being transformed via Markdown",
+		:maintainer => "ged@FaerieMUD.org",
+		:default_action => 'display',
+		:templates => { 
+			:display => "sharenotes/display.tmpl"
+		}
+	}
+
+
+	def initialize( *args )
+		super
+
+		if @config.respond_to?( :sharenotes )
+			@directory = @config.sharenotes.directory
+		end
+
+		@directory ||= DefaultDirectory
+	end
+
+
+	######
+	public
+	######
+
+	def display_action( txn, *args )
+		self.log.debug "In the 'display' action of the '%s' app." %
+			self.signature.name 
+
+		doc = $1 if /(\w[\w. -]+)/.match( args.first )
+		doc.untaint
+
+		tmpl = self.load_template( :display )
+
+		begin
+			if doc
+				if File.readable?( doc )
+					markdown = File.read( doc )
+					tmpl.body = BlueCloth.new( markdown ).to_html
+				else
+					tmpl.error = "File '%s' is not readable." % [doc]
+				end
+			else
+				tmpl.error = "No document specified"
+			end
+		rescue RuntimeError => err
+			tmpl.error = err.message
+		end
+		
+
+		return true
+	end
+
+
+end # class ShareNotes
+
+

data/data/arrow/applets/tutorial/subclassed-hello.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# 
+# The SubclassedHello class, a derivative of the Hello
+# applet to test applet inheritance.
+# 
+# == Authors
+# 
+# * Martin Chase <stillflame@FaerieMUD.org>
+# 
+
+begin
+	basedir = File.dirname(__FILE__)
+	$LOAD_PATH.unshift( basedir ) unless $LOAD_PATH.include?( basedir )
+end
+
+require 'superhello'
+
+Arrow::Logger.global.debug "SubclassedHello: Past the requires"
+
+### An applet for testing inheritance from other derived applets
+class SubclassedHello < SuperHello
+
+
+	# Applet signature
+	Signature = {
+		:name => "Hello World (Subclassed)",
+		:description => %{A modified 'hello world' applet to figure out if subclassing works.},
+		:uri => "subhello",
+		:maintainer => "stillflame@FaerieMUD.org",
+	}
+
+end # class SubclassedHello