athenaeum 1.0

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2007, LAIKA Inc.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+
+  * Neither the name of the LAIKA, Inc nor the names of its contributors
+    may be used to endorse or promote products derived from this software
+    without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,19 @@
+= Athenaeum
+
+Athenaeum is a small web application meant to read and display the items
+checked out from your Delicious Library.
+
+== Dependencies
+
+* Delicious Library - http://www.delicious-monster.com
+* RubyCocoa - http://rubycocoa.sf.net
+* hpricot - http://code.whytheluckystiff.net/hpricot
+* mongrel - http://mongrel.rubyforge.org
+
+== Authors
+
+* Ben Bleything - <mailto:bbleything@laika.com>
+
+== License and Copyright
+
+Athenaeum is copyright (c) 2007, LAIKA Inc.  It is distributed under the terms of the BSD license.

data/Rakefile

@@ -0,0 +1,128 @@
+##############################################################
+# Copyright 2007, LAIKA, Inc.                                #
+#                                                            #
+# Based heavily on Ben Bleything's Rakefile for plist, which #
+# is in turn based on Geoffrey Grosenbach's Rakefile for     #
+# gruff.                                                     #
+#                                                            #
+# Includes whitespace-fixing task based on code from Typo.   #
+#                                                            #
+# Authors:                                                   #
+#  * Ben Bleything <bbleything@laika.com>                    #
+##############################################################
+
+require 'fileutils'
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'athenaeum'
+
+PKG_NAME      = Athenaeum::NAME.downcase
+PKG_VERSION   = Athenaeum::VERSION
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBYFORGE_PROJECT = "athenaeum"
+RUBYFORGE_USER    = ENV['RUBYFORGE_USER']
+
+TEXT_FILES    = %w( Rakefile README LICENSE )
+LIB_FILES     = Dir.glob('lib/**/*').delete_if { |item| item.include?( "\.svn" ) }
+RELEASE_FILES = TEXT_FILES + LIB_FILES 
+
+task :default => [ :clean ]
+
+desc "Clean pkg, coverage, and rdoc; remove .bak files"
+task :clean => [ :clobber_rdoc, :clobber_package ] do
+	puts cmd = "find . -type f -name *.bak -delete"
+	`#{cmd}`
+end
+
+desc "Strip trailing whitespace and fix newlines for all release files"
+task :fix_whitespace => [ :clean ] do
+	RELEASE_FILES.each do |filename|
+		next if File.directory? filename
+
+		File.open(filename) do |file|
+			newfile = ''
+			needs_love = false
+
+			file.readlines.each_with_index do |line, lineno|
+				if line =~ /[ \t]+$/
+					needs_love = true
+					puts "#{filename}: trailing whitespace on line #{lineno}"
+					line.gsub!(/[ \t]*$/, '')
+				end
+
+				if line.chomp == line
+					needs_love = true
+					puts "#{filename}: no newline on line #{lineno}"
+					line << "\n"
+				end
+
+				newfile << line
+			end
+
+			if needs_love
+				tempname = "#{filename}.new"
+
+				File.open(tempname, 'w').write(newfile)
+				File.chmod(File.stat(filename).mode, tempname)
+
+				FileUtils.ln filename, "#{filename}.bak"
+				FileUtils.ln tempname, filename, :force => true
+				File.unlink(tempname)
+			end
+		end
+	end
+end
+
+
+desc "Copy documentation to rubyforge"
+task :update_rdoc => [ :rdoc ] do
+	Rake::SshDirPublisher.new("#{RUBYFORGE_USER}@rubyforge.org", "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}", "rdoc").upload
+end
+
+
+### Genereate the RDoc documentation
+Rake::RDocTask.new { |rdoc|
+	rdoc.rdoc_dir = 'rdoc'
+	rdoc.title    = "#{Athenaeum::NAME} - #{Athenaeum::DESCRIPTION}"
+	rdoc.options << '-SNmREADME'
+
+	rdoc.rdoc_files.include TEXT_FILES
+	rdoc.rdoc_files.include LIB_FILES
+	rdoc.rdoc_files.include Dir.glob('docs/**').delete_if {|f| f.include? 'jamis' }
+}
+
+
+### Create compressed packages
+spec = Gem::Specification.new do |s|
+	s.name    = PKG_NAME
+	s.version = PKG_VERSION
+
+	s.summary     = "#{Athenaeum::NAME} - #{Athenaeum::DESCRIPTION}"
+	s.description = Athenaeum::LONG_DESC
+
+	s.authors  = "LAIKA, Inc."
+	s.homepage = "http://opensource.laika.com"
+	s.rubyforge_project = RUBYFORGE_PROJECT
+
+	s.has_rdoc = true
+
+	s.files       = RELEASE_FILES
+	s.executables = 'athenaeum'
+	
+	s.autorequire = 'athenaeum'
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+	p.gem_spec = spec
+	p.need_tar = true
+	p.need_zip = true
+end

data/bin/athenaeum

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+# 
+# Athenaeum
+# 
+# == Synopsis
+# 
+# Athenaeum is a small web application meant to read and display the items
+# checked out from your Delicious Library.
+# 
+# == Authors
+# 
+# * Ben Bleything <bbleything@laika.com>
+# 
+# == Copyright
+#
+# Copyright (c) 2007 LAIKA, Inc
+# 
+# == Version
+#
+#  $Id: athenaeum 288 2007-08-01 22:35:03Z bbleything $
+
+require 'athenaeum'
+
+########################################################################
+### S E T U P
+########################################################################
+
+# fetch the DL data from the running user's home directory
+@xml = File.read( "/Users/#{`whoami`.strip}/Library/Application\ Support/Delicious\ Library/Library\ Media\ Data.xml" )
+@doc = Hpricot.XML( @xml )
+
+########################################################################
+### B U I L D   L I B R A R Y
+########################################################################
+
+# this query will get us all the top-level books, movies, music, and games 
+#from the item container.  This prevents us from accidentally grabbing the 
+# recommendations and related items.
+@doc.at( "/library/items" ).search( "/book | /movie | /music | /game" ) do |item|
+	Athenaeum::Item.create( item )
+end
+
+# fetches all the borrowers from the xml, creating Athenaeum::Borrower objects
+# for each.	This must happen *after* the Items are found, because
+# Athenaeum::Borrower uses Athenaeum::Item's registry to build its internal
+# registry.
+@doc.search( "/library/borrowers/borrower" ).each do |b|
+	Athenaeum::Borrower.new( b )
+end
+
+########################################################################
+### O U T P U T ! ! ! 1
+########################################################################
+
+Athenaeum::Item.types.sort_by {|k| k.type_name}.each do |type|
+	items = Athenaeum::Item.find_by_type( type )
+	next if items.empty?
+
+	type_name = type.type_name
+	type_name << 's' unless type_name == 'Music'
+
+	# +-----+
+	# | foo |
+	# +-----+----------------------------------------------------------------------+
+	puts "+-" + ( '-' * type_name.length ) + "-+"
+	puts "| #{type_name} |"
+	puts "+-" + ( '-' * type_name.length ) + "-+" + ( '-' * (79 - type_name.length - 6) ) + "+"
+	puts
+
+	# get the items of this type, sorted by title
+	items.sort_by {|item| item.title }.each do |item|
+		puts "- #{item.title} by #{item.creator}"
+		
+		if loan = Athenaeum::Loan.find_by_item_uuid( item.uuid )
+			due_date = loan.due_date.strftime( '%B %d, %Y' )
+			puts "  - loaned to #{loan.borrower.name} (#{loan.borrower.email}), due on #{due_date}"
+		end
+	end
+	
+	puts # blank line for clarity
+end

data/lib/athenaeum.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# 
+# Athenaeum
+# 
+# == Synopsis
+# 
+# Athenaeum is a small web application meant to read and display the items
+# checked out from your Delicious Library.
+# 
+# == Authors
+# 
+# * Ben Bleything <bbleything@laika.com>
+# 
+# == Copyright
+#
+# Copyright (c) 2007 LAIKA, Inc
+# 
+# == Version
+#
+#  $Id: athenaeum.rb 292 2007-08-02 21:56:18Z bbleything $
+
+### standard library
+require 'date'
+
+### rubygems
+require 'rubygems'
+require 'hpricot'
+
+### rubycocoa
+require 'osx/cocoa'
+
+module Athenaeum
+	NAME        = "Athenaeum"
+	DESCRIPTION = "A small webapp to display the contents of your Delicious Library"
+	LONG_DESC   = "Athenaeum is a collection of libraries to read and display  the contents of your Delicious Library.  It includes the ability to display what items are checked out, to whom, and when they are due."
+	VERSION     = "1.0"
+end
+
+### athenaeum
+require 'athenaeum/borrower'
+require 'athenaeum/item'
+require 'athenaeum/loan'
+
+require 'athenaeum/itemtypes/book'
+require 'athenaeum/itemtypes/game'
+require 'athenaeum/itemtypes/movie'
+require 'athenaeum/itemtypes/music'

data/lib/athenaeum/borrower.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+# 
+# Athenaeum::Borrower
+# 
+# == Synopsis
+# 
+# Represents a person who has borrowed an item.
+#
+# Accepts a <borrower> record (as an Hpricot::Elem) and creates an object that 
+# represents that data.
+#
+# == Authors
+# 
+# * Ben Bleything <bbleything@laika.com>
+# 
+# == Copyright
+#
+# Copyright (c) 2007 LAIKA, Inc
+# 
+# == Version
+#
+#  $Id: borrower.rb 287 2007-08-01 22:15:57Z bbleything $
+
+class Athenaeum::Borrower
+	# load the AddressBook framework from RubyCocoa
+	OSX.require_framework 'AddressBook'
+
+	attr_reader :email, :id, :name
+
+	# takes an Hpricot::Elem representing a borrower.
+	def initialize( info )
+		raise "Must provide an Hpricot::Elem object" unless
+			info.is_a? Hpricot::Elem
+
+		@id = info[ :id ]
+
+		if ab_record = fetch_ab_record( @id )
+			@name, @email = extract_data( ab_record )
+		else
+			@name = @email = 'Unknown'
+		end
+
+		info.search( "/loan" ).each {|loan| Athenaeum::Loan.new( self, loan ) }
+	end
+	
+	# return an HTML representation of this borrower
+	def to_html
+		inner = if email !~ /unknown email address/
+			"<a href='mailto:#{self.email}'>#{self.name}</a>"
+		else
+			self.name
+		end
+		
+		return "<span class='borrower'>#{inner}</span>"
+	end
+
+	########################################################################
+	private
+	########################################################################
+
+	# given a uuid, finds the record in the Address Book
+	def fetch_ab_record( id )
+		return OSX::ABAddressBook.sharedAddressBook.recordForUniqueId( id )
+	end
+	
+	# fetches name and email from Address Book
+	def extract_data( ab_record )
+		return extract_name( ab_record ), extract_email( ab_record )
+	end
+
+	# fetches name from Address Book
+	def extract_name( ab_record )
+		first = ab_record.valueForProperty( 'First' )
+		last  = ab_record.valueForProperty( 'Last'  )
+
+		return "#{first} #{last}"
+	end
+
+	# fetches primary email from Address Book
+	def extract_email( ab_record )
+		if emails = ab_record.valueForProperty( 'Email' )
+			# emails is a multivalue list, so we need to find the primary
+			# identifier and then...
+			primary_id = emails.primaryIdentifier
+			# ... fetch the value associated with the primary id
+			return emails.valueAtIndex( emails.indexForIdentifier( primary_id ) ).to_s
+		else
+			return 'unknown email address'
+		end
+	end
+end

data/lib/athenaeum/item.rb

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+# 
+# Athenaeum::Item
+# 
+# == Synopsis
+# 
+# Represents an item from your collection.  This is the semi-abstract
+# superclass from which the actual object types descend.
+#
+# == Authors
+# 
+# * Ben Bleything <bbleything@laika.com>
+# 
+# == Copyright
+#
+# Copyright (c) 2007 LAIKA, Inc
+# 
+# == Version
+#
+#  $Id: item.rb 290 2007-08-02 18:26:29Z bbleything $
+
+class Athenaeum::Item
+	########################################################################
+	### I N I T I A L I Z E R S
+	########################################################################
+	
+	# the initializer is not used directly, rather it is inherited by the
+	# subclasses and used in them.
+	def initialize( item )
+		item.attributes.keys.each do |name|
+			# add getter
+			(class << self ; self ; end).instance_eval {
+				attr_reader name.to_s.intern
+			}
+			
+			# set ivar.  Use raw_attributes because that's the only way to
+			# get the un-unescaped content.
+			instance_variable_set "@#{name}", item.raw_attributes[ name ]
+		end
+		
+		@@registry ||= []
+		@@registry << self
+	end
+
+	# this is the initializer that actually gets used.  Pass the appropriate
+	# kind of Hpricot::Elem object (representing an item in the xml) and it
+	# will give you the appropriate type of item back.
+	def self::create( item )
+		raise "Must provide an Hpricot::Elem object" unless
+			item.is_a? Hpricot::Elem
+		
+		Athenaeum.const_get( item.etag.name.capitalize ).new( item )
+	end
+	
+	########################################################################
+	### M A G I C   H O O K S
+	########################################################################
+	
+	# keep a registry of subclasses, for self::types, below
+	def self::inherited( klass )
+		@@subclasses ||= []
+		@@subclasses <<  klass
+	end
+	
+	########################################################################
+	### I N T R O S P E C T I O N
+	########################################################################
+	
+	# simple getter for the item registry
+	def self::registry
+		@@registry ||= []
+		return @@registry
+	end
+	
+	# the name of this particular type... book, music, game, movie, etc
+	def self::type_name
+		self.to_s.split( /::/ ).last
+	end
+	
+	# simple getter for the subclass registry
+	def self::types
+		@@subclasses || []
+	end
+
+	########################################################################
+	### F I N D E R S
+	########################################################################
+	
+	# searches through the registry, finding all items of a given subclass
+	def self::find_by_type( type )
+		return @@registry.select {|item| item.is_a? type }
+	end
+	
+	# searches through the registry, returning the item with the uuid 
+	# specified
+	def self::find_by_uuid( uuid )
+		return @@registry.detect {|item| item.uuid == uuid }
+	end
+	
+	########################################################################
+	### I N S T A N C E   M E T H O D S
+	########################################################################
+	
+	# returns a decent HTML representation of the item
+	def to_html
+		return "<span class='title'>#{self.title}</span> <span class='creator'>by #{self.creator}</span>"
+	end
+	
+end

data/lib/athenaeum/itemtypes/book.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# 
+# Athenaeum::Book
+# 
+# == Synopsis
+# 
+# Represents a book from your collection.
+#
+# == Authors
+# 
+# * Ben Bleything <bbleything@laika.com>
+# 
+# == Copyright
+#
+# Copyright (c) 2007 LAIKA, Inc
+# 
+# == Version
+#
+#  $Id: book.rb 285 2007-08-01 21:38:27Z bbleything $
+
+class Athenaeum::Book < Athenaeum::Item
+	# alias author to creator
+	def creator
+		creator = self.author rescue nil
+		return creator || 'Unknown Author'
+	end	
+end

data/lib/athenaeum/itemtypes/game.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# 
+# Athenaeum::Game
+# 
+# == Synopsis
+# 
+# Represents a video game from your collection.
+#
+# == Authors
+# 
+# * Ben Bleything <bbleything@laika.com>
+# 
+# == Copyright
+#
+# Copyright (c) 2007 LAIKA, Inc
+# 
+# == Version
+#
+#  $Id: game.rb 284 2007-08-01 18:01:14Z bbleything $
+
+class Athenaeum::Game < Athenaeum::Item
+	# alias publisher to creator
+	def creator
+		self.publisher
+	end
+end

data/lib/athenaeum/itemtypes/movie.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# 
+# Athenaeum::Movie
+# 
+# == Synopsis
+# 
+# Represents a movie from your collection.
+#
+# == Authors
+# 
+# * Ben Bleything <bbleything@laika.com>
+# 
+# == Copyright
+#
+# Copyright (c) 2007 LAIKA, Inc
+# 
+# == Version
+#
+#  $Id: movie.rb 285 2007-08-01 21:38:27Z bbleything $
+
+class Athenaeum::Movie < Athenaeum::Item
+	# alias director (or, failing that, publisher) to creator
+	def creator
+		creator = self.director rescue nil
+		return creator || 'Unknown Director'
+	end
+end

data/lib/athenaeum/itemtypes/music.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# 
+# Athenaeum::Music
+# 
+# == Synopsis
+# 
+# Represents an audio recording from your collection.
+#
+# == Authors
+# 
+# * Ben Bleything <bbleything@laika.com>
+# 
+# == Copyright
+#
+# Copyright (c) 2007 LAIKA, Inc
+# 
+# == Version
+#
+#  $Id: music.rb 285 2007-08-01 21:38:27Z bbleything $
+
+class Athenaeum::Music < Athenaeum::Item
+	# alias artist to creator
+	def creator
+		creator = self.artist rescue nil
+		return creator || 'Unknown Artist'
+	end
+end

data/lib/athenaeum/loan.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+# 
+# Athenaeum::Loan
+# 
+# == Synopsis
+# 
+# Encapsulates the relationship between a borrower and an item.  Any instance 
+# of this class represented an item that has been loaned out to a particular 
+# person.
+#
+# == Authors
+# 
+# * Ben Bleything <bbleything@laika.com>
+# 
+# == Copyright
+#
+# Copyright (c) 2007 LAIKA, Inc
+# 
+# == Version
+#
+#  $Id: loan.rb 289 2007-08-01 23:17:06Z bbleything $
+
+class Athenaeum::Loan
+	attr_reader :borrower, :item, :due_date
+
+	# take a borrower and a loan tag, and create an object to encapsulate 
+	# them. Searches the Item registry for the item.
+	def initialize( borrower, loan )
+		raise "Must provide an Athenaeum::Borrower object" unless
+			borrower.is_a? Athenaeum::Borrower
+
+		raise "Must provide an Hpricot::Elem object" unless
+			loan.is_a? Hpricot::Elem
+		
+		@item     = Athenaeum::Item.find_by_uuid( loan[ :mediaID ] )
+		@borrower = borrower
+		@due_date = Date.strptime( loan[ :dueDate ], '%d-%m-%Y' )
+		
+		@@registry ||= []
+		@@registry << self
+	end
+	
+	########################################################################
+	### I N T R O S P E C T I O N
+	########################################################################
+	
+	# simple getter for the loan registry
+	def self::registry
+		@@registry ||= []
+		return @@registry
+	end
+	
+	########################################################################
+	### F I N D E R S
+	########################################################################
+	
+	# searches the Loan registry and returns the loan for the item with the
+	# given uuid, if any.
+	def self::find_by_item_uuid( uuid )
+		@@registry ||= []
+		return @@registry.detect {|loan| loan.item.uuid == uuid }
+	end
+	
+	# searches the Loan registry and returns all loans that belong to the
+	# specified borrower. 
+	def self::find_by_borrower_id( id )
+		@@registry ||= []
+		return @@registry.select {|loan| loan.borrower.id == id }
+	end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: athenaeum
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+date: 2007-09-10 00:00:00 -07:00
+summary: Athenaeum - A small webapp to display the contents of your Delicious Library
+require_paths: 
+- lib
+email: 
+homepage: http://opensource.laika.com
+rubyforge_project: athenaeum
+description: Athenaeum is a collection of libraries to read and display  the contents of your Delicious Library.  It includes the ability to display what items are checked out, to whom, and when they are due.
+autorequire: athenaeum
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- LAIKA, Inc.
+files: 
+- Rakefile
+- README
+- LICENSE
+- lib/athenaeum
+- lib/athenaeum/borrower.rb
+- lib/athenaeum/item.rb
+- lib/athenaeum/itemtypes
+- lib/athenaeum/itemtypes/book.rb
+- lib/athenaeum/itemtypes/game.rb
+- lib/athenaeum/itemtypes/movie.rb
+- lib/athenaeum/itemtypes/music.rb
+- lib/athenaeum/loan.rb
+- lib/athenaeum.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- athenaeum
+extensions: []
+
+requirements: []
+
+dependencies: []
+