graybook 1.0.24 → 1.1.0

data/{CHANGES.md → CHANGELOG}

@@ -1,5 +1,16 @@
-==1.0.24
-
+==1.1.0 / 2009-10-01
+
+ * Removed the completely outdates tests (will write new tests next patch)
+ * Restricted importers to the following:
+  * AOL/AIM
+  * Yahoo
+  * Hotmail/Live/MSN
+  * Google Mail
+ * Restricted exporters to just basic.
+ * Got rid of exception raising and instead implemented Problem, a child
+   of Exception that returns true on .nil? This is to pass error
+   messages back all the way through the .get function to whatever it
+   originated from (e.g. Rails).
  * Fixed Hotmail contact regexp to reflect new site.
 
 ==1.0.22 / 2009-09-30

data/README

@@ -0,0 +1,94 @@
+                   ,-------------------------, 
+                   |                         |,
+                   (=========================||
+                   (=========================||
+                   (=========================||
+                   |  __,  ,_    __,         ||
+                   | /  | /  |  /  |  |   |  ||
+                   | \_/|/   |_/\_/|_/ \_/|/ ||
+                   |   /|                /|  ||
+                   |   \|                \|  ||
+                   |     _              _    ||
+                   |    | |            | |   ||
+                   |    | |   __   __  | |   ||
+                   |    |/ \_/  \_/  \_|/_)  ||
+                   |     \_/ \__/ \__/ | \_/ ||
+                   (=========================||
+                   (=========================||
+                   (=========================||
+                   |                         ||
+                   |_________________________'|
+                    '-------------------------'
+
+Description:
+------------
+  
+Pulls contact lists from EVERYWHERE! (Some sites not included.)
+Originally based on Blackbook, but heavily modified and simplified.
+
+Features:
+---------
+  
+The current list of supported services and file types:
+
+Services:
+  - AOL/AIM
+  - Yahoo
+  - Hotmail/Live/MSN
+  - Google Mail
+
+Synopsis:
+---------
+
+Returns an array of hashes containing a name key and an email key can
+be used as is oreasily be converted into a JSON that can be iterated
+though.
+
+>> contacts = Graybook.get :service,
+                :username => 'username@service.com',
+                :password => 'supersecret'
+=> [{:name => 'john doe', :email => 'male@unknown.com'},
+    {:named => 'jane doe', :email => 'female@unknown.com'}]
+
+Requirements:
+-------------
+
+* Mechanize >= 0.7.0 for page scraping
+
+Install:
+--------
+
+1. gem install gemcutter
+1. gem tumble
+2. gem install graybook
+
+Thanks:
+-------
+
+Big thanks to the peoples of Contentfree for making Blackbook.
+More thanks to everyone else who maintained working forks of Blackbook.
+
+License:
+--------
+
+Copyright (c) 2009, kojul.com
+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

@@ -1,39 +1,20 @@
 # -*- ruby -*-
 
 require 'rubygems'
-require 'hoe'
 $LOAD_PATH.unshift 'lib'
 require 'graybook'
 
-begin
-  require 'rcov/rcovtask'
-rescue LoadError
-end
-
-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
-
-require 'rubygems'
-
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name        = "graybook"
-    s.summary     = "It does things. Like import contacts from EVERYWHERE."
+    s.summary     = "It does things. Like import contacts from EVERYWHERE. (Some sites may be excluded)"
     s.email       = "kojul@kojul.com"
     s.homepage    = "http://github.com/kojul/gray"
-    s.description = "It does things. Like import contacts from EVERYWHERE."
-    s.authors     = ["kojul"]
+    s.description = "Graybook is used to import email contact lists from popular webmail sites. Currently supported are AOL/AIM, Yahoo, Hotmail/Live/MSN, and Google Mail (although not Google Apps Mail yet)."
+    s.authors     = ["kojul", "Contentfree"]
     s.add_dependency('hpricot', '>= 0.7.0')
     s.add_dependency('mechanize', '>= 0.7.0')
-    s.add_dependency('hoe', '>= 1.5.0')
-    s.add_dependency('fastercsv', '>= 1.2.0')
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION

@@ -1 +1 @@
-1.0.24
+1.1.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
-:minor: 0
-:patch: 24
+:minor: 1
+:patch: 0

data/VERSION_NAME

@@ -1 +1 @@
-Gray Gorilla
+Gray Grouper

data/lib/graybook/importer/aol.rb

@@ -11,7 +11,7 @@ class Graybook::Importer::Aol < Graybook::Importer::PageScraper
   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
@@ -29,36 +29,36 @@ class Graybook::Importer::Aol < Graybook::Importer::PageScraper
 
     case page.body
     when /Invalid Screen Name or Password. Please try again./
-      raise( Graybook::BadCredentialsError, "That username and password was not accepted. Please check them and try again." )
+      return Problem.new("Username and password were not accepted. Please check them and try again.")
     when /Terms of Service/
-      raise( Graybook::LegacyAccount, "Your AOL account is not setup for WebMail. Please signup: http://webmail.aol.com")
+      return Problem.new("Your AOL account is not setup for WebMail. Please signup: http://webmail.aol.com")
     end
 
     # aol bumps to a wait page while logging in.  if we can't scrape out the js then its a bad login
     extractor = proc { |var_name| page.body.scan(/var\s*#{var_name}\s*=\s*\"(.*?)\"\s*;/).first.first }
-      
+
     base_uri = extractor.call( 'gSuccessPath' )
-    raise( Graybook::BadCredentialsError, "You do not appear to be signed in." ) unless base_uri
+    return Problem.new("An error occurred. Please try again.") unless base_uri
     page = agent.get base_uri
   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    
+  def scrape_contacts
     unless auth_cookie = agent.cookies.find{|c| c.name =~ /^Auth/}
-      raise( Graybook::BadCredentialsError, "Must be authenticated to access contacts." )
+      return Problem.new("An error occurred. Please try again.")
     end
-    
+
     # jump through the hoops of formulating a request to get printable contacts
     uri = agent.current_page.uri.dup
     inputs = agent.current_page.search("//input")
@@ -82,6 +82,6 @@ class Graybook::Importer::Aol < Graybook::Importer::PageScraper
       }
     end
   end
-  
+
   Graybook.register :aol, self
 end

data/lib/graybook/importer/gmail.rb

@@ -9,11 +9,11 @@ class Graybook::Importer::Gmail < Graybook::Importer::PageScraper
   RETRY_THRESHOLD = 5
   ##
   # Matches this importer to an user's name/address
-  
+
   def =~(options = {})
     options && options[:username] =~ /@(gmail|googlemail).com$/i ? true : false
   end
-  
+
   def import(*args)
     # GMail depends on Hpricot for some reason...
     parser = WWW::Mechanize.html_parser
@@ -22,41 +22,41 @@ class Graybook::Importer::Gmail < Graybook::Importer::PageScraper
       WWW::Mechanize.html_parser = parser
     end
   end
-  
+
   ##
   # login to gmail
 
-  def login    
+  def login
     page = agent.get('http://mail.google.com/mail/')
     form = page.forms.first
     form.Email = options[:username]
     form.Passwd = options[:password]
     page = agent.submit(form,form.buttons.first)
-    
-    raise( Graybook::BadCredentialsError, "That username and password was not accepted. Please check them and try again." ) if page.body =~ /Username and password do not match/
-    
+
+    return Problem.new("Username and password were not accepted. Please check them and try again.") if page.body =~ /Username and password do not match/
+
     if page.search('//meta').first.attributes['content'] =~ /url='?(http.+?)'?$/i
       page = agent.get $1
     end
   end
-  
+
   ##
   # prepare this importer
 
   def prepare
     login
   end
-  
+
   ##
   # scrape gmail contacts for this importer
 
-  def scrape_contacts    
-    unless agent.cookies.find { |c| 
-        c.name == 'GAUSR' && c.value.match(/mail(.*?):#{options[:username]}/) 
+  def scrape_contacts
+    unless agent.cookies.find { |c|
+        c.name == 'GAUSR' && c.value.match(/mail(.*?):#{options[:username]}/)
       }
-      raise( Graybook::BadCredentialsError, "Must be authenticated to access contacts." )
+      return Problem.new("Username and password were not accepted. Please check them and try again.")
     end
-    
+
     page = agent.get('http://mail.google.com/mail/h/?v=cl&pnl=a')
     title = page.search("//title").inner_text
     if title == 'Redirecting'
@@ -64,22 +64,22 @@ class Graybook::Importer::Gmail < Graybook::Importer::PageScraper
       url = redirect_text.match(/url='(http.*)'/i)[1]
       page = agent.get(url)
     end
-    
+
     contact_rows = page.search("//input[@name='c']/../..")
     contact_rows.collect do |row|
       columns = row/"td"
       email = columns[2].inner_html.gsub( /(\n|&nbsp;)/, '' ) # email
-      clean_email = email[/[a-zA-Z0-9._%+-]+@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,4}/] 
-      
+      clean_email = email[/[a-zA-Z0-9._%+-]+@(?:[a-zA-Z0-9-]+\.)+[a-zA-Z]{2,4}/]
+
       unless clean_email.empty?
         columns = row/"td"
-        { 
+        {
           :name  => ( columns[1] / "b" / "a" ).inner_html.strip, # name
           :email => clean_email
-        } 
+        }
       end
     end.compact
   end
-  
+
   Graybook.register(:gmail, self)
 end

data/lib/graybook/importer/hotmail.rb

@@ -51,8 +51,7 @@ class Graybook::Importer::Hotmail < Graybook::Importer::PageScraper
     # Check for login success
     if page.body =~ /The e-mail address or password is incorrect/ ||
       page.body =~ /Sign in failed\./
-      raise( Graybook::BadCredentialsError, 
-        "That username and password was not accepted. Please check them and try again." )
+      return Problem.new("Username and password were not accepted. Please check them and try again.")
     end
     
     @first_page = agent.get( page.body.scan(/http\:\/\/[^"]+/).first )
@@ -68,12 +67,11 @@ class Graybook::Importer::Hotmail < Graybook::Importer::PageScraper
   ##
   # Scrape contacts for Hotmail
   # Seems like a POST to directly fetch CSV contacts from options.aspx?subsection=26&n=
-  # raises an end of file error in Net::HTTP via Mechanize.
   # Seems like Hotmail addresses are now hosted on Windows Live.
 
   def scrape_contacts
     unless agent.cookies.find{|c| c.name == 'MSPPre' && c.value == options[:username]}
-      raise( Graybook::BadCredentialsError, "Must be authenticated to access contacts." )
+      return Problem.new("Username and password were not accepted. Please check them and try again.")
     end
 
     page = agent.get('http://mail.live.com/')

data/lib/graybook/importer/page_scraper.rb

@@ -60,8 +60,10 @@ class Graybook::Importer::PageScraper < Graybook::Importer::Base
 
   def fetch_contacts!
     create_agent
-    prepare
-    scrape_contacts
+    prep = prepare
+    return prep if prep.nil?
+    cont = scrape_contacts
+    return cont if cont.nil?
   end
   
   ##

data/lib/graybook/importer/yahoo.rb

@@ -12,7 +12,7 @@ class Graybook::Importer::Yahoo < Graybook::Importer::PageScraper
   def =~(options = {})
     options && options[:username] =~ /@yahoo.co(m|\.uk)$/i ? true : false
   end
-  
+
   ##
   # login for Yahoo!
 
@@ -22,42 +22,42 @@ class Graybook::Importer::Yahoo < Graybook::Importer::PageScraper
     form.login = options[:username].split("@").first
     form.passwd = options[:password]
     page = agent.submit(form, form.buttons.first)
-    
+
     if page.body =~ /Invalid ID or password./ || page.body =~ /This ID is not yet taken./
-      raise Graybook::BadCredentialsError, "That username and password was not accepted. Please check them and try again."
+      return Problem.new("Username and password were not accepted. Please check them and try again.")
     end
-    
+
     true
   end
-  
+
   ##
   # prepare the importer
 
   def prepare
     login
   end
-  
+
   ##
   # scrape yahoo contacts
 
   def scrape_contacts
     page = agent.get("http://address.yahoo.com/?1=&VPC=import_export")
     if page.body =~ /To access Yahoo! Address Book\.\.\..*Sign in./m
-      raise( Graybook::BadCredentialsError, "Must be authenticated to access contacts." )
+      return Problem.new("Username and password were not accepted. Please check them and try again.")
     end
     form = page.forms.last
     csv = agent.submit(form, form.buttons[2]) # third button is Yahoo-format CSV
-    
+
     contact_rows = FasterCSV.parse(csv.body)
     labels = contact_rows.shift # TODO: Actually use the labels to find the indexes of the data we want
     contact_rows.collect do |row|
       next if !row[7].empty? && options[:username] =~ /^#{Regexp.escape(row[7])}/ # Don't collect self
       {
-        :name  => "#{row[0]} #{row[2]}".to_s, 
-        :email => (row[4] || "#{row[7]}@yahoo.com") # email is a field in the data, but will be blank for Yahoo users so we create their email address    
-      } 
+        :name  => "#{row[0]} #{row[2]}".to_s,
+        :email => (row[4] || "#{row[7]}@yahoo.com") # email is a field in the data, but will be blank for Yahoo users so we create their email address
+      }
     end
   end
-  
+
   Graybook.register(:yahoo, self)
 end

data/lib/graybook.rb

@@ -4,15 +4,17 @@ require 'rubygems'
 
 class Graybook
   include ::Singleton
-  VERSION = '1.0.24'
-  
-  class GraybookError < ::StandardError; end
-  class BadCredentialsError < GraybookError; end
-  class LegacyAccount < GraybookError; end
-  
+  VERSION = '1.1.0'
+
+  class Problem < Exception
+    def nil?
+      true
+    end
+  end
+
   attr_accessor :importers
   attr_accessor :exporters
-  
+
   def self.get( *args )
     instance.get( *args )
   end
@@ -24,39 +26,36 @@ class Graybook
       when Exporter::Base
         instance.exporters[name.to_sym] = adapter
       else
-        raise ArgumentError, "Unknown adapter"
+        return nil
     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 - Graybook'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 ]
+    to_format = exporters[: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
-    
+    return nil unless to_format
+    return nil unless source
+
     export source, to_format, options
   end
-  
+
   def initialize
     self.importers = {}
     self.exporters = {}
@@ -78,6 +77,6 @@ end
 class Object
   def blank?
     respond_to?(:empty?) ? empty? : !self
-  end  
+  end
 end
 

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: graybook
 version: !ruby/object:Gem::Version 
-  version: 1.0.24
+  version: 1.1.0
 platform: ruby
 authors: 
 - kojul
+- Contentfree
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -32,112 +33,33 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.7.0
     version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.5.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: fastercsv
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.0
-    version: 
-description: It does things. Like import contacts from EVERYWHERE.
+description: Graybook is used to import email contact lists from popular webmail sites. Currently supported are AOL/AIM, Yahoo, Hotmail/Live/MSN, and Google Mail (although not Google Apps Mail yet).
 email: kojul@kojul.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.md
+- README
 files: 
 - .gitignore
-- CHANGES.md
+- CHANGELOG
 - Manifest.txt
-- README.md
+- README
 - Rakefile
 - VERSION
 - VERSION.yml
 - VERSION_NAME
-- debug_graybook.rb
 - init.rb
 - lib/graybook.rb
 - lib/graybook/exporter/base.rb
-- lib/graybook/exporter/vcf.rb
-- lib/graybook/exporter/xml.rb
 - lib/graybook/importer/aol.rb
 - lib/graybook/importer/base.rb
-- lib/graybook/importer/csv.rb
-- lib/graybook/importer/freenet.rb
 - lib/graybook/importer/gmail.rb
-- lib/graybook/importer/gmx.rb
 - lib/graybook/importer/hotmail.rb
 - lib/graybook/importer/page_scraper.rb
-- lib/graybook/importer/web.de.rb
 - lib/graybook/importer/yahoo.rb
-- test/config/credentials.yml.example
-- test/fixtures/aol_application_page.html
-- 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/aol_new_contacts.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_2a.html
-- test/fixtures/gmail_login_response_stage_3.html
-- test/fixtures/gmail_redirect_body.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/hotmail_scrape_first_page.html
-- test/fixtures/hotmail_scrape_response_stage_1.html
-- test/fixtures/hotmail_scrape_response_stage_2.html
-- test/fixtures/hotmail_scrape_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/fixtures/yahoo_no_user_response_stage_2.html
-- test/freenet_importer_test.rb
-- test/gmx_importer_test.rb
-- test/scripts/live_test.rb
-- test/test_graybook.rb
-- test/test_graybook_exporter_base.rb
-- test/test_graybook_exporter_vcf.rb
-- test/test_graybook_exporter_xml.rb
-- test/test_graybook_importer_aol.rb
-- test/test_graybook_importer_base.rb
-- test/test_graybook_importer_csv.rb
-- test/test_graybook_importer_gmail.rb
-- test/test_graybook_importer_hotmail.rb
-- test/test_graybook_importer_page_scraper.rb
-- test/test_graybook_importer_yahoo.rb
-- test/test_helper.rb
-- test/web.de_importer_test.rb
 - updater.rb
-- vendor/plugins/graybook/lib/autotest/discover.rb
-- vendor/plugins/graybook/lib/autotest/graybook.rb
 has_rdoc: true
 homepage: http://github.com/kojul/gray
 licenses: []
@@ -165,21 +87,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: It does things. Like import contacts from EVERYWHERE.
-test_files: 
-- test/freenet_importer_test.rb
-- test/gmx_importer_test.rb
-- test/scripts/live_test.rb
-- test/test_graybook.rb
-- test/test_graybook_exporter_base.rb
-- test/test_graybook_exporter_vcf.rb
-- test/test_graybook_exporter_xml.rb
-- test/test_graybook_importer_aol.rb
-- test/test_graybook_importer_base.rb
-- test/test_graybook_importer_csv.rb
-- test/test_graybook_importer_gmail.rb
-- test/test_graybook_importer_hotmail.rb
-- test/test_graybook_importer_page_scraper.rb
-- test/test_graybook_importer_yahoo.rb
-- test/test_helper.rb
-- test/web.de_importer_test.rb
+summary: It does things. Like import contacts from EVERYWHERE. (Some sites may be excluded)
+test_files: []
+