blackbook 1.0.0

data/History.txt

@@ -0,0 +1,18 @@
+== 1.0.0 / 2008-01-30
+
+* 2 major enhancements
+  * Birthday!
+  * Mechanize patch for AOL sign-on! Thanks Mortee!
+
+* Importers
+  * AOL
+  * GMail
+  * Hotmail
+  * Yahoo!
+  * CSV
+
+* Exporters
+  * Hash
+  * XML
+  * VCard
+

data/Manifest.txt

@@ -0,0 +1,55 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+init.rb
+lib/blackbook.rb
+lib/blackbook/exporter/base.rb
+lib/blackbook/exporter/vcf.rb
+lib/blackbook/exporter/xml.rb
+lib/blackbook/importer/aol.rb
+lib/blackbook/importer/base.rb
+lib/blackbook/importer/csv.rb
+lib/blackbook/importer/gmail.rb
+lib/blackbook/importer/hotmail.rb
+lib/blackbook/importer/page_scraper.rb
+lib/blackbook/importer/yahoo.rb
+test/fixtures/aol_bad_login_response_stage_3.html
+test/fixtures/aol_contacts.html
+test/fixtures/aol_login_response_stage_1.html
+test/fixtures/aol_login_response_stage_2.html
+test/fixtures/aol_login_response_stage_3.html
+test/fixtures/aol_login_response_stage_4.html
+test/fixtures/aol_login_response_stage_5.html
+test/fixtures/gmail.csv
+test/fixtures/gmail_bad_login_response_stage_2.html
+test/fixtures/gmail_contacts.html
+test/fixtures/gmail_login_response_stage_1.html
+test/fixtures/gmail_login_response_stage_2.html
+test/fixtures/gmail_login_response_stage_3.html
+test/fixtures/hotmail_bad_login_response_stage_2.html
+test/fixtures/hotmail_contacts.html
+test/fixtures/hotmail_login_response_stage_1.html
+test/fixtures/hotmail_login_response_stage_2.html
+test/fixtures/hotmail_login_response_stage_3.html
+test/fixtures/yahoo_bad_login_response_stage_2.html
+test/fixtures/yahoo_contacts.csv
+test/fixtures/yahoo_contacts_not_logged_in.html
+test/fixtures/yahoo_contacts_stage_1.html
+test/fixtures/yahoo_login_response_stage_1.html
+test/fixtures/yahoo_login_response_stage_2.html
+test/scripts/live_test.rb
+test/test_blackbook.rb
+test/test_blackbook_exporter_base.rb
+test/test_blackbook_exporter_vcf.rb
+test/test_blackbook_exporter_xml.rb
+test/test_blackbook_importer_aol.rb
+test/test_blackbook_importer_base.rb
+test/test_blackbook_importer_csv.rb
+test/test_blackbook_importer_gmail.rb
+test/test_blackbook_importer_hotmail.rb
+test/test_blackbook_importer_page_scraper.rb
+test/test_blackbook_importer_yahoo.rb
+test/test_helper.rb
+vendor/plugins/blackbook/lib/autotest/blackbook.rb
+vendor/plugins/blackbook/lib/autotest/discover.rb

data/README.txt

@@ -0,0 +1,71 @@
+Blackbook
+http://rubyforge.org/projects/contentfree/
+
+== DESCRIPTION:
+  
+Blackbook automates the nitty-gritty of importing contacts from various services and files and exporting them as VCard, XML, or simple Hash. Utilize those contacts from services like AOL, GMail, Yahoo Mail, Hotmail or CSV to help your social networking site become GIGANTIC overnight! You'll be able to get big and sell for millions before anyone figures out it's just like every other social network.
+
+== FEATURES/PROBLEMS:
+  
+The current list of supported services and file types:
+
+Import:
+* AOL
+* CSV files
+* Gmail
+* Hotmail
+* Yahoo! Mail
+
+Export:
+* Simple hash (default)
+* Vcard
+* XML
+
+If you create an additional importer or exporter - or simply find a bug - please consider submitting it as a patch to the project so the community can all benefit from your hard work and ingenuity. 
+
+== SYNOPSIS:
+
+# An example of fetching Gmail contacts - by default, returns an array of hashes with :name and :email
+  contacts = Blackbook.get :username => 'me@gmail.com', :password => 'whatever'
+
+# or returning XML
+  contacts = Blackbook.get :username => 'me@gmail.com', :password => 'whatever', :as => :xml
+  
+# or importing from a CSV file 
+  contacts = Blackbook.get :csv, :file => #<File:/path/to/file.csv>
+
+== REQUIREMENTS:
+
+* Mechanize and its dependencies, for interacting with online providers
+* Fastercsv for reading CSV, Mechanize >= 0.7.0 for page scraping
+
+== INSTALL:
+
+* sudo gem install blackbook
+
+== THANKS:
+
+Big thanks to Marton Fabo for figuring out why Mechanize couldn't log in to AOL.
+
+== LICENSE:
+
+Copyright (c) 2007, Contentfree
+
+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/Rakefile

@@ -0,0 +1,38 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+$LOAD_PATH.unshift 'lib'
+require 'blackbook'
+
+begin
+  require 'rcov/rcovtask'
+rescue LoadError
+end
+
+Hoe.new('blackbook', Blackbook::VERSION) do |p|
+  p.rubyforge_name = 'contentfree'
+  p.author         = 'Contentfree'
+  p.email          = 'dave.myron@contentfree.com'
+  p.summary        = 'Blackbook handles the nitty-gritty of importing contacts from various service providers and contact lists and exporting them in a useful format.'
+  p.description    = p.paragraphs_of('README.txt', 1).join("\n\n")
+  p.url            = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes        = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps    << [ "mechanize", ">= 0.7.0" ]
+  p.extra_deps    << [ "fastercsv", ">= 1.2.0" ]
+  p.clean_globs << 'coverage'
+  p.clean_globs << 'pkg'
+  p.clean_globs << 'doc'
+  p.clean_globs << 'ri'
+end
+
+task :release_and_publish => [:release, :publish_docs]
+
+begin
+  Rcov::RcovTask.new do |t|
+    t.test_files = FileList['test/test*.rb']
+    t.verbose = true
+    #t.rcov_opts << "--exclude rcov.rb,hpricot.rb,hpricot/.*\.rb"
+  end
+rescue NameError
+end

data/init.rb

@@ -0,0 +1 @@
+require 'blackbook'

data/lib/blackbook.rb

@@ -0,0 +1,80 @@
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__)))
+require 'singleton'
+require 'rubygems'
+
+class Blackbook
+  include ::Singleton
+  VERSION = '1.0.0'
+  
+  class BlackbookError < ::StandardError; end
+  class BadCredentialsError < BlackbookError; end
+  
+  attr_accessor :importers
+  attr_accessor :exporters
+  
+  def self.get( *args )
+    instance.get( *args )
+  end
+
+  def self.register(name, adapter_class)
+    case adapter = adapter_class.new
+      when Importer::Base
+        instance.importers[name.to_sym] = adapter
+      when Exporter::Base
+        instance.exporters[name.to_sym] = adapter
+      else
+        raise ArgumentError, "Unknown adapter"
+    end
+  end
+  
+  # Sends the vcards from the import to whatever is handling the export
+  def export( importer, exporter, options )
+    exporter.export importer.import( options )
+  end
+  
+  # Searches registered importers for one that will handle the given options
+  def find_importer( options )
+    importers.each{ |key, importer| return importer if importer =~ options }
+    nil
+  end
+  
+  # Fetches contacts from various services or filetypes. The default is to return an array
+  # of hashes - Blackbook's internal format
+  # 
+  # Handles several different calls:
+  #  get( :username => 'something@gmail.com', :password => 'whatever' )
+  #  get( :as => :xml, :username => 'something@gmail.com', :password => 'whatever' )
+  #  get( :csv, :file => #<File:/path/to/file.csv> )
+  def get( *args )
+    options   = args.last.is_a?(Hash) ? args.pop : {}
+    to_format = exporters[ options[:as] || :basic ]
+    source    = (importers[args.first.to_sym] rescue nil) || find_importer(options)
+
+    raise ArgumentError, "Unknown exporter" unless to_format
+    raise ArgumentError, "Unknown source" unless source
+    
+    export source, to_format, options
+  end
+  
+  def initialize
+    self.importers = {}
+    self.exporters = {}
+  end
+end
+
+# Require all the importers/exporters
+require 'blackbook/importer/base'
+require 'blackbook/exporter/base'
+Dir.glob(File.join(File.dirname(__FILE__), 'blackbook/importer/*.rb')).each {|f| require f }
+Dir.glob(File.join(File.dirname(__FILE__), 'blackbook/exporter/*.rb')).each {|f| require f }
+
+class String
+  alias :blank? :empty?
+end
+class NilClass
+  alias :blank? :nil?
+end
+class Array
+  alias :blank? :empty?
+end
+

data/lib/blackbook/exporter/base.rb

@@ -0,0 +1,16 @@
+##
+# base class for exporters of contact information
+
+module Blackbook::Exporter
+
+  class Base
+    ##
+    # Override this to convert +contacts+ (an array of hashes) to something more useful. Here, it
+    # just returns Blackbook's internal format
+    def export( contacts )
+      contacts
+    end
+    
+    Blackbook.register :basic, self
+  end
+end

data/lib/blackbook/exporter/vcf.rb

@@ -0,0 +1,45 @@
+##
+# exports contacts in Vcard format
+class Blackbook::Exporter::Vcf < Blackbook::Exporter::Base
+
+  ##
+  # representation of a vcard
+
+  class Vcard
+
+    attr_accessor :first, :last, :email
+    
+    ##
+    # initialize dynamically sets the attributes passed in as accessible 
+    # attribute on its object
+
+    def initialize( attributes = {} )
+      attributes.each{ |name,value| self.send("#{name}=", value) rescue next }
+    end
+    
+    ##
+    # text representation of this vcard
+    def to_s
+      <<-EOVC
+BEGIN:VCARD
+N:#{last};#{first}
+EMAIL:#{email}
+END:VCARD
+      EOVC
+    end
+  end
+
+  ##
+  # exports contacts as Vcards
+
+  def export( contacts = [] )
+    return if contacts.blank? 
+    
+    contacts.uniq.compact.collect do |contact|
+      first_name, last_name = contact[:name].split(' ', 2)
+      Vcard.new( :first => first_name.to_s, :last => last_name.to_s, :email => contact[:email])
+    end
+  end
+  
+  Blackbook.register(:vcf, self)
+end

data/lib/blackbook/exporter/xml.rb

@@ -0,0 +1,28 @@
+require 'rexml/document'
+
+##
+# exports contacts in xml format
+
+class Blackbook::Exporter::Xml < Blackbook::Exporter::Base
+
+  ##
+  # contacts are an array of hashes that are contacts and returns xml
+
+  def export( contacts )
+    doc = REXML::Document.new
+    doc << REXML::XMLDecl.new
+    
+    root = doc.add_element 'contacts'
+    contacts.each do |contact|
+      el = root.add_element 'contact'
+      name = el.add_element 'name' 
+      name.text = contact[:name]
+      
+      el.add_element('email').text = contact[:email]
+    end
+    
+    doc.to_s
+  end
+  
+  Blackbook.register(:xml, self)
+end

data/lib/blackbook/importer/aol.rb

@@ -0,0 +1,74 @@
+require 'blackbook/importer/page_scraper'
+
+##
+# Imports contacts from AOL
+
+class Blackbook::Importer::Aol < Blackbook::Importer::PageScraper
+
+  ##
+  # Matches this importer to an user's name/address
+
+  def =~( options )
+    options && options[:username] =~ /@(aol|aim)\.com$/i ? true : false
+  end
+  
+  ##
+  # Login process:
+  # - Get mail.aol.com which redirects to a page containing a javascript redirect
+  # - Get the URL that the javascript is supposed to redirect you to
+  # - Fill out and submit the login form
+  # - Get the URL from *another* javascript redirect
+
+  def login
+    page = agent.get( 'http://webmail.aol.com/' )
+
+    form = page.forms.name('AOLLoginForm').first
+    form.loginId = options[:username].split('@').first # Drop the domain
+    form.password = options[:password]
+    page = agent.submit(form, form.buttons.first)
+
+    raise( Blackbook::BadCredentialsError, "That username and password was not accepted. Please check them and try again." ) if page.body =~ /Invalid Screen Name or Password. Please try again./
+
+    # aol bumps to a wait page while logging in.  if we can't scrape out the js then its a bad login
+    wait_url = page.body.scan(/onLoad="checkError[^\)]+/).first.scan(/'([^']+)'/).last.first
+    page = agent.get wait_url
+    # aol generates the URL below from some JS magic in the wait_url page
+    agent.get 'http://webmail.aol.com/31361/aol/en-us/Suite.aspx'
+  end
+  
+  ##
+  # must login to prepare
+
+  def prepare
+    login
+  end
+  
+  ##
+  # The url to scrape contacts from has to be put together from the Auth cookie
+  # and a known uri that hosts their contact service. An array of hashes with
+  # :name and :email keys is returned.
+
+  def scrape_contacts
+    unless auth_cookie = agent.cookies.find{|c| c.name =~ /^Auth/}
+      raise( Blackbook::BadCredentialsError, "Must be authenticated to access contacts." )
+    end
+    
+    # Get user id from cookies
+    user_id = auth_cookie.value.scan(/&uid:([^&]+)&/).first.first
+    
+    # Get contacts print page
+    page = agent.get "http://webmail.aol.com/aim/en-us/Lite/addresslist-print.aspx?command=all&sort=FirstLastNick&sortDir=Ascending&nameFormat=FirstLastNick&user=#{user_id}"
+    
+    # Grab all the contacts
+    names = page.body.scan( /<span class="fullName">([^<]+)<\/span>/ ).flatten
+    emails = page.body.scan( /<span>Email 1:<\/span> <span>([^<]+)<\/span>/ ).flatten
+    (0...[names.size,emails.size].max).collect do |i|
+      {
+        :name => names[i],
+        :email => emails[i]
+      }
+    end
+  end
+  
+  Blackbook.register :aol, self
+end

data/lib/blackbook/importer/base.rb

@@ -0,0 +1,39 @@
+#
+# Provides a base template for interface and behavior of contact importers
+
+module Blackbook::Importer
+  class Base
+    attr_accessor :options
+
+    ##
+    # Should return true or false/nil depending on whether the +options+ given 
+    # can be handled by this importer
+
+    def =~( options ); end # stub
+
+    ##
+    # Does the work of extracting contacts. Returns an Array of Arrays 
+    # containing the name and email as the first and second elements. Of 
+    # course, you can override this behavior to meet the needs of a 
+    # particular service.
+
+    def fetch_contacts!; end # stub
+
+    ##
+    # Imports the contacts using the given +options+. Returns an array of 
+    # hashes in the internal format (a hash with at least :name and :email 
+    # values).
+
+    def import(options = {}) 
+      self.options = options
+      fetch_contacts!
+    end
+
+    ##
+    # Name of the importer service.
+
+    def service_name
+      self.class.name.split("::").last
+    end
+  end
+end