pp-contacts 1.5.1 → 1.5.2

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+pkg/*
+test/accounts.yml
+.rvmrc
+.idea
+*.swp
+*.gem

data/Gemfile

@@ -0,0 +1,16 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gem "rake"
+gem 'gdata19', :git => 'git://github.com/paperlesspost/gdata.git'
+gem 'hpricot'
+gem 'nokogiri'
+gem "json", '> 0.4.1'
+
+group :development do
+  gem 'gem-release'
+end
+
+group :test do
+  gem 'shoulda'
+end

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GIT
+  remote: git://github.com/paperlesspost/gdata.git
+  revision: 91f3a5b2e701c879ae5dfcb48dec5bb039e37a7b
+  specs:
+    gdata19 (0.1.9.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    gem-release (0.3.1)
+    hpricot (0.8.4)
+    json (1.5.3)
+    nokogiri (1.5.2)
+    rake (0.9.2)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gdata19!
+  gem-release
+  hpricot
+  json (> 0.4.1)
+  nokogiri
+  rake
+  shoulda

data/contacts.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = "pp-contacts"
+  s.version = "1.5.2"
+  s.date = "2012-04-26"
+  s.summary = "A universal interface to grab contact list information from various providers including Outlook, Address Book, Yahoo, AOL, Gmail, Hotmail, and Plaxo."
+  s.homepage = "http://github.com/paperlesspost/contacts"
+  s.description = "A universal interface to grab contact list information from various providers including Outlook, Address Book, Yahoo, AOL, Gmail, Hotmail, and Plaxo."
+  s.has_rdoc = false
+  s.authors = ["Lucas Carlson", "Paperless"]
+  s.files = `git ls-files`.split($\)
+  s.add_dependency("json", ">= 1.1.1")
+  s.add_dependency('gdata19')
+  s.add_dependency('hpricot')
+  s.add_dependency('nokogiri')
+  s.add_dependency('encryptor')
+end

data/cruise_config.rb

@@ -0,0 +1,22 @@
+# Project-specific configuration for CruiseControl.rb
+
+Project.configure do |project|
+
+  # Send email notifications about broken and fixed builds to email1@your.site, email2@your.site (default: send to nobody)
+  # if building this on your own CI box, please remove!
+   project.email_notifier.emails = ['opensource@pivotallabs.com']
+
+  # Set email 'from' field to john@doe.com:
+  # project.email_notifier.from = 'john@doe.com'
+
+  # Build the project by invoking rake task 'custom'
+  # project.rake_task = 'custom'
+
+  # Build the project by invoking shell script "build_my_app.sh". Keep in mind that when the script is invoked, current working directory is
+  # [cruise]/projects/your_project/work, so if you do not keep build_my_app.sh in version control, it should be '../build_my_app.sh' instead
+  # project.build_command = 'build_my_app.sh'
+
+  # Ping Subversion for new revisions every 5 minutes (default: 30 seconds)
+  # project.scheduler.polling_interval = 5.minutes
+
+end

data/geminstaller.yml

@@ -0,0 +1,8 @@
+---
+defaults:
+  install_options: --no-ri --no-rdoc
+gems:
+  - name: json
+    version: >= 1.1.1
+  - name: gdata
+    version: >= 1.1.1

data/lib/contacts/base.rb

@@ -10,7 +10,6 @@ require "erb"
 class Contacts
   TYPES = {}
   FILETYPES = {}
-  VERSION = "1.4.1"
 
   class Base
     def initialize(login, password, options={})

data/lib/contacts/outlook.rb

@@ -0,0 +1,59 @@
+require 'csv'
+
+class Contacts
+  class Outlook < Base
+
+    def initialize(file)
+      @contact_file = Array.new
+      file = file.respond_to?(:read) ? file.read : file
+      file.each_line do |line|
+        @contact_file << CSV.parse(line)[0]
+      end
+      @full_name = false
+      @header_indexes = Hash.new
+      @header_indexes[:email_address] = Array.new
+
+      headers = @contact_file[0]
+
+      @contact_file = @contact_file[1, @contact_file.length]
+
+      headers.each_with_index do |header, i|
+        if header.match(/^Name$/)
+          @full_name = true
+          @header_indexes[:full_name] = i
+        elsif header.match(/^First Name/)
+          @header_indexes[:first_name] = i
+        elsif header.match(/^Last Name/)
+          @header_indexes[:last_name] = i
+        elsif header.match(/E-mail/)
+          @header_indexes[:email_address] << i
+        end
+      end
+    end
+
+    def contacts
+
+      contacts = Array.new
+
+      @contact_file.each_with_index do |line, i|
+        contacts[i] = Array.new unless contacts[i]
+        if(@full_name)
+          contacts[i][0] = line[@header_indexes[:full_name]]
+        else
+          contacts[i][0] = "#{line[@header_indexes[:first_name]]} #{line[@header_indexes[:last_name]]}"
+        end
+        @header_indexes[:email_address].each do |index|
+          if line[index] && !contacts[i][1]
+            contacts[i][1] = line[index]
+          end
+        end
+      end
+
+      contacts
+    end
+
+  end
+
+  private
+    FILETYPES[:outlook] = Outlook
+end

data/lib/contacts/vcf.rb

@@ -0,0 +1,25 @@
+class Contacts
+  class Vcf < Base
+    
+    def initialize(file)
+      @contact_file = file
+    end
+    
+    def contacts
+      contacts = Array.new
+      i = 0
+      @contact_file.each do |line|
+        contacts[i] = Array.new unless contacts[i]
+        if line.match(/FN:/)
+          contacts[i] << line.gsub(/FN:/, '').strip
+        elsif line.match(/EMAIL;/)
+          contacts[i] << line.gsub(/^.*:/, '').strip
+        elsif line.match(/END:VCARD/)
+          i += 1
+        end
+      end
+      contacts
+    end
+  end
+  FILETYPES[:vcf] = Vcf
+end

data/test/example_accounts.yml

@@ -0,0 +1,40 @@
+gmail:
+  username: <changeme>
+  password: <changeme>
+  contacts: 
+    -
+      name: "FirstName1 LastName1"
+      email_address: "firstname1@example.com"
+    -
+      name: "FirstName2 LastName2"
+      email_address: "firstname2@example.com"
+yahoo:
+  username: <changeme>
+  password: <changeme>
+  contacts: 
+    -
+      name: "FirstName1 LastName1"
+      email_address: "firstname1@example.com"
+    -
+      name: "FirstName2 LastName2"
+      email_address: "firstname2@example.com"
+hotmail:
+  username: <changeme>
+  password: <changeme>
+  contacts: 
+    -
+      name: "FirstName1 LastName1"
+      email_address: "firstname1@example.com"
+    -
+      name: "FirstName2 LastName2"
+      email_address: "firstname2@example.com"
+aol:
+  username: <changeme>
+  password: <changeme>
+  contacts: 
+    -
+      name: "FirstName1 LastName1"
+      email_address: "firstname1@example.com"
+    -
+      name: "FirstName2 LastName2"
+      email_address: "firstname2@example.com"

data/test/outlook_fullname.csv

@@ -0,0 +1,3 @@
+First Name,Last Name,E-mail
+FirstName1,LastName1,firstname1@example.com
+FirstName2,LastName2,firstname2@example.com

data/test/outlook_splitname.csv

@@ -0,0 +1,3 @@
+First Name,Last Name,E-mail
+FirstName1,LastName1,firstname1@example.com
+FirstName2,LastName2,firstname2@example.com

data/test/test_helper.rb

@@ -0,0 +1,32 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(dir + "/../lib/")
+require 'test/unit'
+require 'contacts'
+require 'yaml'
+require 'shoulda'
+
+class ContactImporterTestCase < Test::Unit::TestCase
+  # Add more helper methods to be used by all tests here...
+  def default_test
+    assert true
+  end
+end
+
+class TestAccounts
+  def self.[](type)
+    load[type]
+  end
+  
+  def self.load(file = File.dirname(__FILE__) + "/accounts.yml")
+    raise "/test/accounts.yml file not found, please create, see /test/example_accounts.yml for information" unless File.exist?(file)
+    
+    accounts = {}
+    YAML::load(File.open(file)).each do |type, contents|
+      contacts = contents["contacts"].collect {|contact| [contact["name"], contact["email_address"]]}
+      accounts[type.to_sym] = Account.new(type.to_sym, contents["username"], contents["password"], contacts)
+    end
+    accounts
+  end
+
+  Account = Struct.new :type, :username, :password, :contacts
+end

data/test/test_suite.rb

@@ -0,0 +1,4 @@
+dir = File.dirname(__FILE__)
+Dir["#{dir}/**/*_test.rb"].each do |file|
+  require file
+end

data/test/unit/aol_contact_importer_test.rb

@@ -0,0 +1,33 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../test_helper"
+require 'contacts'
+
+class AolContactImporterTest < ContactImporterTestCase
+  def setup
+    super
+    @account = TestAccounts[:aol]
+  end
+
+  def test_successful_login
+    Contacts.new(:aolImporter, @account.username, @account.password)
+  end
+
+  def test_importer_fails_with_blank_password
+    assert_raise(Contacts::AuthenticationError) do
+      Contacts.new(:aolImporter, @account.username, "")
+    end
+  end
+
+  def test_importer_fails_with_blank_username
+    assert_raise(Contacts::AuthenticationError) do
+      Contacts.new(:aolImporter, "", @account.password)
+    end
+  end
+
+  def test_fetch_contacts
+    contacts = Contacts.new(:aolImporter, @account.username, @account.password).contacts
+    @account.contacts.each do |contact|
+      assert contacts.include?(contact), "Could not find: #{contact.inspect} in #{contacts.inspect}"
+    end
+  end
+end

data/test/unit/gmail_contact_importer_test.rb

@@ -0,0 +1,39 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../test_helper"
+require 'contacts'
+
+class GmailContactImporterTest < ContactImporterTestCase
+  def setup
+    super
+    @account = TestAccounts[:gmail]
+  end
+
+  def test_successful_login
+    Contacts.new(:gmail, @account.username, @account.password)
+  end
+
+  def test_importer_fails_with_invalid_password
+    assert_raise(Contacts::AuthenticationError) do
+      Contacts.new(:gmail, @account.username, "wrong_password")
+    end
+  end
+
+  def test_importer_fails_with_blank_password
+    assert_raise(Contacts::AuthenticationError) do
+      Contacts.new(:gmail, @account.username, "")
+    end
+  end
+
+  def test_importer_fails_with_blank_username
+    assert_raise(Contacts::AuthenticationError) do
+      Contacts.new(:gmail, "", @account.password)
+    end
+  end
+
+  def test_fetch_contacts
+    contacts = Contacts.new(:gmail, @account.username, @account.password).contacts
+    @account.contacts.each do |contact|
+      assert contacts.include?(contact), "Could not find: #{contact.inspect} in #{contacts.inspect}"
+    end
+  end
+end

data/test/unit/hotmail_contact_importer_test.rb

@@ -0,0 +1,41 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../test_helper"
+require 'contacts'
+
+class HotmailContactImporterTest < ContactImporterTestCase
+  def setup
+    super
+    @account = TestAccounts[:hotmail]
+  end
+
+  def test_successful_login
+    Contacts.new(:hotmail, @account.username, @account.password)
+  end
+
+  def test_importer_fails_with_invalid_msn_password
+    assert_raise(Contacts::AuthenticationError) do
+      Contacts.new(:hotmail, "test@msn.com","wrong_password")
+    end
+  end
+
+  def test_importer_fails_with_invalid_password
+    assert_raise(Contacts::AuthenticationError) do
+      Contacts.new(:hotmail, @account.username,"wrong_password")
+    end
+  end
+
+  def test_fetch_contacts
+    contacts = Contacts.new(:hotmail, @account.username, @account.password).contacts
+    @account.contacts.each do |contact|
+      assert contacts.include?(contact), "Could not find: #{contact.inspect} in #{contacts.inspect}"
+    end
+  end
+
+  # Since the hotmail scraper doesn't read names, test email
+  def test_fetch_email
+    contacts = Contacts.new(:hotmail, @account.username, @account.password).contacts
+    @account.contacts.each do |contact|
+      assert contacts.any?{|book_contact| book_contact.last == contact.last }, "Could not find: #{contact.inspect} in #{contacts.inspect}"
+    end
+  end
+end

data/test/unit/outlook_test.rb

@@ -0,0 +1,23 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../test_helper"
+
+class OutlookTest < ContactImporterTestCase
+  context 'An instance of Outlook' do
+    should 'open file properly' do
+      outlookobject = Contacts.new(:outlook, File.open(File.dirname(__FILE__) + '/../outlook_fullname.csv'))
+      assert_not_nil outlookobject
+    end
+    
+    should 'get contacts from file with Full Name' do
+      outlookobject = Contacts.new(:outlook, File.open(File.dirname(__FILE__) + '/../outlook_fullname.csv'))
+      contacts = outlookobject.contacts
+      assert_not_nil contacts
+    end
+    
+    should 'get contacts from file with split up names' do
+      outlookobject = Contacts.new(:outlook, File.open(File.dirname(__FILE__) + '/../outlook_splitname.csv'))
+      contacts = outlookobject.contacts
+      assert_not_nil contacts      
+    end
+  end
+end

data/test/unit/test_accounts_test.rb

@@ -0,0 +1,23 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../test_helper"
+
+class TestAccountsTest < ContactImporterTestCase
+  def test_test_accounts_loads_data_from_example_accounts_file
+    account = TestAccounts.load(File.dirname(__FILE__) + "/../example_accounts.yml")[:gmail]
+    
+    assert_equal :gmail, account.type
+    assert_equal "<changeme>", account.username
+    assert_equal "<changeme>", account.password
+    assert_equal [["FirstName1 LastName1", "firstname1@example.com"], ["FirstName2 LastName2", "firstname2@example.com"]], account.contacts
+  end
+  
+  def test_test_accounts_blows_up_if_file_doesnt_exist
+    assert_raise(RuntimeError) do
+      TestAccounts.load("file_that_does_not_exist.yml")
+    end
+  end
+  
+  def test_we_can_load_from_account_file
+    assert_not_nil TestAccounts[:gmail].username
+  end
+end

data/test/unit/vcf_test.rb

@@ -0,0 +1,17 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../test_helper"
+
+class VcfTest < ContactImporterTestCase
+  context 'An instance of Vcf' do
+    should 'open file properly' do
+      vcfobject = Contacts.new(:vcf, File.open(File.dirname(__FILE__) + '/../vCards.vcf'))
+      assert_not_nil vcfobject
+    end
+    
+    should 'get contacts from file' do
+      vcfobject = Contacts.new(:vcf, File.open(File.dirname(__FILE__) + '/../vCards.vcf'))
+      contacts = vcfobject.contacts
+      assert_not_nil contacts
+    end
+  end
+end

data/test/unit/yahoo_csv_contact_importer_test.rb

@@ -0,0 +1,35 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/../test_helper"
+require 'contacts'
+
+class YahooContactImporterTest < ContactImporterTestCase
+  def setup
+    super
+    @account = TestAccounts[:yahoo]
+  end
+
+  def test_a_successful_login
+    Contacts.new(:yahoo, @account.username, @account.password)
+  end
+
+  def test_importer_fails_with_invalid_password
+    assert_raise(Contacts::AuthenticationError) do
+      Contacts.new(:yahoo, @account.username, "wrong_password")
+    end
+    # run the "successful" login test to ensure we reset yahoo's failed login lockout counter
+    # See http://www.pivotaltracker.com/story/show/138210
+    # yahoo needs some time to unset the failed login state, apparently... 
+    # ...1 sec and 5 secs still failed sporadically
+    sleep 10
+    assert_nothing_raised do
+      Contacts.new(:yahoo, @account.username, @account.password)
+    end
+  end
+
+  def test_a_fetch_contacts
+    contacts = Contacts.new(:yahoo, @account.username, @account.password).contacts
+    @account.contacts.each do |contact|
+      assert contacts.include?(contact), "Could not find: #{contact.inspect} in #{contacts.inspect}"
+    end
+  end
+end

data/test/vCards.vcf

@@ -0,0 +1,16 @@
+BEGIN:VCARD
+VERSION:3.0
+N:LastName1;FirstName1;;;
+FN:FirstName1 LastName1
+EMAIL;type=INTERNET;type=WORK;type=pref:firstname1@example.com
+CATEGORIES:test
+X-ABUID:3BCA01C2-3EF7-4BB8-BFD4-08ED31416C8F\:ABPerson
+END:VCARD
+BEGIN:VCARD
+VERSION:3.0
+N:LastName2;FirstName2;;;
+FN:FirstName2 LastName2
+EMAIL;type=INTERNET;type=WORK;type=pref:firstname2@example.com
+CATEGORIES:test
+X-ABUID:53F6702D-D2B6-4B46-8C41-CD31F743260B\:ABPerson
+END:VCARD

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pp-contacts
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-04-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70264084117900 !ruby/object:Gem::Requirement
+  requirement: &70303491442280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 1.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *70264084117900
+  version_requirements: *70303491442280
 - !ruby/object:Gem::Dependency
   name: gdata19
-  requirement: &70264084117380 !ruby/object:Gem::Requirement
+  requirement: &70303491441860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70264084117380
+  version_requirements: *70303491441860
 - !ruby/object:Gem::Dependency
   name: hpricot
-  requirement: &70264084116800 !ruby/object:Gem::Requirement
+  requirement: &70303491441400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70264084116800
+  version_requirements: *70303491441400
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70264084116260 !ruby/object:Gem::Requirement
+  requirement: &70303491440980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70264084116260
+  version_requirements: *70303491440980
 - !ruby/object:Gem::Dependency
   name: encryptor
-  requirement: &70264084115760 !ruby/object:Gem::Requirement
+  requirement: &70303491440560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,7 +66,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70264084115760
+  version_requirements: *70303491440560
 description: A universal interface to grab contact list information from various providers
   including Outlook, Address Book, Yahoo, AOL, Gmail, Hotmail, and Plaxo.
 email: 
@@ -74,18 +74,39 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
-- Rakefile
 - README.md
+- Rakefile
+- contacts.gemspec
+- cruise_config.rb
 - examples/grab_contacts.rb
+- geminstaller.yml
 - lib/contacts.rb
+- lib/contacts/aol_importer.rb
 - lib/contacts/base.rb
-- lib/contacts/json_picker.rb
 - lib/contacts/gmail.rb
-- lib/contacts/aol_importer.rb
 - lib/contacts/hotmail.rb
+- lib/contacts/json_picker.rb
+- lib/contacts/outlook.rb
 - lib/contacts/plaxo.rb
+- lib/contacts/vcf.rb
 - lib/contacts/yahoo.rb
+- test/example_accounts.yml
+- test/outlook_fullname.csv
+- test/outlook_splitname.csv
+- test/test_helper.rb
+- test/test_suite.rb
+- test/unit/aol_contact_importer_test.rb
+- test/unit/gmail_contact_importer_test.rb
+- test/unit/hotmail_contact_importer_test.rb
+- test/unit/outlook_test.rb
+- test/unit/test_accounts_test.rb
+- test/unit/vcf_test.rb
+- test/unit/yahoo_csv_contact_importer_test.rb
+- test/vCards.vcf
 homepage: http://github.com/paperlesspost/contacts
 licenses: []
 post_install_message: