outlook_importer 0.1.0

data/README.md

@@ -0,0 +1,42 @@
+# Outlook CSV Importer
+
+Can read csv contacts files exported by Outlook > 2000 and Windows Live Mail and return the contacts as a nested array.
+
+
+# USAGE
+
+Initialize the importer with a lookup table that specifies which strings in the csv headers match either firstname, lastname and email or name and email. 
+
+    lookup_table = {
+      :name => 'Name',
+      :email => 'E-Mail-Adresse'
+    }
+    importer = OutlookImporter.new(lookup_table)
+
+After initialization let the importer read a file and you can access you contacts via the contacts method. 
+
+    importer.read('example.csv')
+    importer.contacts # => [["Robin Example", "robin@example.de"]]
+
+For further reference please see the outlook importer test in this project.
+
+
+# CREDITS
+ * Payango GmbH for allowing us to open source this lib.
+ * Robin Mehner for sharing the Outlook CSV test files.
+ * Frank Prößdorf
+ * Thilo Utke
+
+# LICENSE
+
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+Version 2, December 2004
+ 
+Copyright (C) 2004 Sam Hocevar
+14 rue de Plaisance, 75014 Paris, France
+Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long as the name is changed.
+
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+ 
+0. You just DO WHAT THE FUCK YOU WANT TO.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "outlook_importer"
+    gem.summary = "Simple importer for outlook and alike csv files"
+    gem.description = "Nothing more to say"
+    gem.email = "dont@bother.me"
+    gem.homepage = "http://github.com/thilo/outlook_importer"
+    gem.authors = ["Frank Prößdorf, Thilo Utke"]
+    gem.add_dependency "fastercsv", ">= 1.5.0"
+    gem.add_development_dependency "test-unit", ">= 1.2.3"
+    gem.has_rdoc = false
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "outlook_importer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/outlook_importer.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{outlook_importer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Frank Pr\303\266\303\237dorf, Thilo Utke"]
+  s.date = %q{2010-10-25}
+  s.description = %q{Nothing more to say}
+  s.email = %q{dont@bother.me}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+     "Rakefile",
+     "VERSION",
+     "outlook_importer.gemspec",
+     "outlook_importer.rb",
+     "test/livemail_de.csv",
+     "test/outlook_2007_de.csv",
+     "test/outlook_importer_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/thilo/outlook_importer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple importer for outlook and alike csv files}
+  s.test_files = [
+    "test/outlook_importer_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fastercsv>, [">= 1.5.0"])
+      s.add_development_dependency(%q<test-unit>, [">= 1.2.3"])
+    else
+      s.add_dependency(%q<fastercsv>, [">= 1.5.0"])
+      s.add_dependency(%q<test-unit>, [">= 1.2.3"])
+    end
+  else
+    s.add_dependency(%q<fastercsv>, [">= 1.5.0"])
+    s.add_dependency(%q<test-unit>, [">= 1.2.3"])
+  end
+end
+

data/outlook_importer.rb

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'fastercsv'
+
+class OutlookImporter
+  def initialize(mapping)
+    @mapping = mapping.invert
+    raise ArgumentError unless valid_arguments?
+  end
+  
+  def read(file_path)
+    separator = File.new(file_path).gets.match(/([,;])[^,;]+\n/)[1]
+    @csv = FasterCSV.read(file_path, :headers => true, :col_sep => separator)
+    assign_header_columns(@csv.headers)
+  end
+  
+  def assign_header_columns(headers)
+    @header_column_indices = {}
+    @mapping.keys.each do |key|
+      @header_column_indices[@mapping[key]] = headers.index(key)
+    end  
+  end
+  
+  def contacts
+    _contacts = []
+    @csv.each do |row|
+      _contacts << contact_entry(row)
+    end
+    _contacts
+  end
+  
+  def contact_entry(row)
+    [
+      contact_entry_name(row),
+      row[@header_column_indices[:email]]
+    ]
+  end
+
+  def contact_entry_name(row)
+    if joined_arguments?
+      row[@header_column_indices[:name]]
+    else
+      "#{row[@header_column_indices[:firstname]]} #{row[@header_column_indices[:lastname]]}"
+    end
+  end
+  
+  def valid_arguments?
+    required_values_present? && required_keys_present?
+  end
+  
+  def required_values_present?
+    required_keys_split_up - @mapping.values == [] ||
+      required_keys_joined - @mapping.values == []
+  end
+  
+  def required_keys_present?
+    values = @mapping.keys
+    values.select{|val| val && val.length > 0}.length == values.length
+  end
+  
+  def required_keys_split_up
+    [:firstname, :lastname, :email]
+  end
+  
+  def required_keys_joined
+    [:name, :email]
+  end
+  
+  def joined_arguments?
+    @joined_arguments ||= @header_column_indices.include?(:name)
+  end
+end

data/test/livemail_de.csv

@@ -0,0 +1,2 @@
+Name;E-Mail-Adresse;Straße (privat);Ort (privat);Postleitzahl (privat);Bundesland (privat);Land/Region (privat);Telefon (privat);Straße (geschäftlich);Ort (geschäftlich);Postleitzahl (geschäftlich);Bundesland (geschäftlich);Land/Region (geschäftlich);Telefon (geschäftlich);Firma;Position
+Robin Example;robin@example.de;;;;;;+49 160 00000000000;;;;;;;Coding Robin;

data/test/outlook_2007_de.csv

@@ -0,0 +1,3 @@
+"Anrede","Vorname","Weitere Vornamen","Nachname","Suffix","Firma","Abteilung","Position","Straße geschäftlich","Straße geschäftlich 2","Straße geschäftlich 3","Ort geschäftlich","Region geschäftlich","Postleitzahl geschäftlich","Land/Region geschäftlich","Straße privat","Straße privat 2","Straße privat 3","Ort privat","Bundesland/Kanton privat","Postleitzahl privat","Land/Region privat","Weitere Straße","Weitere Straße 2","Weitere Straße 3","Weiterer Ort","Weiteres/r Bundesland/Kanton","Weitere Postleitzahl","Weiteres/e Land/Region","Telefon Assistent","Fax geschäftlich","Telefon geschäftlich","Telefon geschäftlich 2","Rückmeldung","Autotelefon","Telefon Firma","Fax privat","Telefon privat","Telefon privat 2","ISDN","Mobiltelefon","Weiteres Fax","Weiteres Telefon","Pager","Haupttelefon","Mobiltelefon 2","Telefon für Hörbehinderte","Telex","Abrechnungsinformation","Benutzer 1","Benutzer 2","Benutzer 3","Benutzer 4","Beruf","Büro","E-Mail-Adresse","E-Mail-Typ","E-Mail: Angezeigter Name","E-Mail 2: Adresse","E-Mail 2: Typ","E-Mail 2: Angezeigter Name","E-Mail 3: Adresse","E-Mail 3: Typ","E-Mail 3: Angezeigter Name","Empfohlen von","Geburtstag","Geschlecht","Hobby","Initialen","Internet-Frei/Gebucht","Jahrestag","Kategorien","Kinder","Konto","Name Assistent","Name des/der Vorgesetzten","Notizen","Organisationsnr.","Ort","Partner","Postfach geschäftlich","Postfach privat","Priorität","Privat","Regierungsnr.","Reisekilometer","Sprache","Stichwörter","Vertraulichkeit","Verzeichnisserver","Webseite","Weiteres Postfach"
+"","Robin","","Example","","Coding Robin","","","Teststr. 23",,,"Berlin","","13355","Deutschland",,,,,,,,,,,,,,,,,"+49 1600000",,,,,,,,,,,,,,,,,,,,,,,,"robin@example.de","SMTP","Robin Example (robin@example.com)",,,,,,,,"0.0.00","Keine Angabe",,"R.M.",,"0.0.00",,,"",,,"
+",,"",,,,"Normal","Aus",,,"","","Normal",,"http://example.de"

data/test/outlook_importer_test.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class OutlookImporterTest < Test::Unit::TestCase
+  def test_read_outlook_contacts
+    lookup_table = {
+      :firstname => 'Vorname',
+      :lastname => 'Nachname',
+      :email => 'E-Mail-Adresse'
+    }
+    importer = OutlookImporter.new(lookup_table)
+    importer.read('outlook_2007_de.csv')
+    
+    assert_equal importer.contacts.first, ["Robin Example", "robin@example.de"]
+  end
+  
+  def test_read_livemail_contacts
+    lookup_table = {
+      :name => 'Name',
+      :email => 'E-Mail-Adresse'
+    }
+    importer = OutlookImporter.new(lookup_table)
+    importer.read('livemail_de.csv')
+    
+    assert_equal importer.contacts.first, ["Robin Example", "robin@example.de"]
+    
+  end
+  
+  def test_initilize_raise_invalid_argument_error_if_lookup_not_satisfied
+    assert_raise ArgumentError do
+      importer = OutlookImporter.new(:firstname => '', :lastname => '', :email => '')
+    end
+  end
+  
+  def test_initialize_raises_invalid_argument_error_if_lookup_is_missing_a_value
+    assert_raise ArgumentError do
+      lookup = {:firstname => 'Vorname', :lastname => 'Nachname'}
+      importer = OutlookImporter.new(lookup)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../outlook_importer'

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: outlook_importer
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Frank Pr\xC3\xB6\xC3\x9Fdorf, Thilo Utke"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-25 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 2
+        - 3
+        version: 1.2.3
+  type: :development
+  version_requirements: *id002
+description: Nothing more to say
+email: dont@bother.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION
+- outlook_importer.gemspec
+- outlook_importer.rb
+- test/livemail_de.csv
+- test/outlook_2007_de.csv
+- test/outlook_importer_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/thilo/outlook_importer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple importer for outlook and alike csv files
+test_files: 
+- test/outlook_importer_test.rb
+- test/test_helper.rb