contact_csv 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-02-05
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Marshall Huss
+
+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/Manifest.txt

@@ -0,0 +1,35 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/contact_csv.rb
+lib/contact_csv/contact.rb
+lib/contact_csv/contact_csv.rb
+lib/contact_csv/contact_manager.rb
+lib/contact_csv/importer.rb
+lib/contact_csv/lookup_tables/lookup_table.rb
+lib/contact_csv/lookup_tables/outlook_csv.rb
+lib/contact_csv/version.rb
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/outlook_contacts.csv
+test/outlook_contacts_dos.csv
+test/test_contact.rb
+test/test_contact_csv.rb
+test/test_contact_manager.rb
+test/test_helper.rb
+test/test_importer.rb
+test/test_lookup_table.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,20 @@
+# === ContactCsv
+# 
+# ==== Reading in CSV
+#
+#  The two class methods are used to read in a CSV file of contacts exported by email clients such as Outlook or GMail. Both methods return an Array of Contact objects.
+#
+#    contacts = ContactCSV.read('/path/to/file.csv')  
+#
+#    contacts = ContactCSV.parse('csv,data,string')  
+#
+# ==== Getting the contacts
+#
+#    contacts.each do |contact|
+#      puts contact.name
+#      puts contact.email
+#    end
+#
+#    See the Contact class for a complete list of attributes.
+#
+#

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,71 @@
+require 'contact_csv/version'
+
+AUTHOR = 'Marshall Huss'  # can also be an array of Authors
+EMAIL = "mwhuss@gmail.com"
+DESCRIPTION = "Simple gem for reading in contact csv files that you can export from email clients like Outlook or GMail"
+GEM_NAME = 'contact_csv' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'contactcsv' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "mwhuss"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = ContactCsv::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'contact_csv documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [ ['fastercsv'] ]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+#PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+PATH    = RUBYFORGE_PROJECT
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'contact_csv'

data/lib/contact_csv.rb

@@ -0,0 +1,10 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'fastercsv'
+require 'contact_csv/contact_csv.rb'
+require 'contact_csv/importer.rb'
+require 'contact_csv/contact.rb'
+require 'contact_csv/contact_manager.rb'
+require 'contact_csv/lookup_tables/lookup_table.rb'
+require 'contact_csv/lookup_tables/outlook_csv.rb'

data/lib/contact_csv/contact.rb

@@ -0,0 +1,102 @@
+# === Contact
+#
+#   Object that represents a Contact from an address book
+#
+class ContactCsv::Contact
+  
+  attr_accessor :extras, :first_name, :middle_name, :last_name, :email, :title
+  
+  def initialize(attributes={})
+    @extras = {}
+    @first_name = attributes[:first_name]
+    @middle_name = attributes[:middle_name]
+    @last_name = attributes[:last_name]
+    @email = attributes[:email]
+    @title = attributes[:title]
+  end
+  
+  def extras
+    @extras
+  end
+  
+  def add_extra(extra)
+    @extras.merge!(extra)
+  end
+  
+  #def method_missing(method, *args)
+  #  self.add_extras( { method => args[0] } )
+  #end
+  
+  # attr_accessor :name, :email, :address, :notes, :email2, :email3, :mobile_phone, :pager, 
+  #                 :company, :job_title, :home_phone, :home_phone2, :home_fax, :home_address, 
+  #                 :business_phone, :business_phone2, :business_fax, :business_address, 
+  #                 :other_phone, :other_fax, :other_address
+  #   
+  #   # Initilize takes in options hash and sets the local attributes          
+  #   def initialize(attributes={})
+  #     @name = attributes[:name]
+  #     @email = attributes[:email]
+  #     @address = attributes[:address]
+  #     @notes = attributes[:notes]
+  #     @email2 = attributes[:email2]
+  #     @email3 = attributes[:email3]
+  #     @mobile_phone = attributes[:mobile_phone]
+  #     @pager = attributes[:pager]
+  #     @company = attributes[:company]
+  #     @job_title = attributes[:job_title]
+  #     @home_phone = attributes[:home_phone]
+  #     @home_phone2 = attributes[:home_phone2]
+  #     @home_fax = attributes[:home_fax]
+  #     @home_address = attributes[:home_address]
+  #     @business_phone = attributes[:business_phone]
+  #     @business_phone2 = attributes[:business_phone2]
+  #     @business_fax = attributes[:business_fax]
+  #     @business_address = attributes[:business_address]
+  #     @other_phone = attributes[:other_phone]
+  #     @other_fax = attributes[:other_fax]
+  #     @other_address = attributes[:other_address]
+  #   end
+  #   
+  #   # Creates an Array of Contact objects from the FasterCSV Array
+  #   def self.contacts(csv)
+  #     contacts = []
+  #     csv.each do |c|
+  #       contacts << Contact.new(
+  #         :name             => c[0], 
+  #         :email            => c[1],
+  #         :address          => c[2],
+  #         :notes            => c[3],
+  #         :email2           => c[4],
+  #         :email3           => c[5],
+  #         :mobile_phone     => c[6],
+  #         :pager            => c[7],
+  #         :company          => c[8],
+  #         :job_title        => c[9],
+  #         :home_phone       => c[10],
+  #         :home_phone2      => c[11],
+  #         :home_fax         => c[12],
+  #         :home_address     => c[13],
+  #         :business_phone   => c[14],
+  #         :business_phone2  => c[15],
+  #         :business_fax     => c[16],
+  #         :business_address => c[17],
+  #         :other_phone      => c[18],
+  #         :other_fax        => c[19],
+  #         :other_address    => c[20]
+  #       )
+  #     end
+  #     contacts
+  #   end
+  #   
+  #   def empty?
+  #     @name.nil? && @email.nil? && @address.nil? && @notes.nil? && @email2.nil? && 
+  #     @email3.nil? && @mobile_phone.nil? && @pager.nil? && @company.nil? && @job_title.nil? && 
+  #     @home_phone.nil? && @home_phone2.nil? && @home_fax.nil? && @home_address.nil? && @business_phone.nil? && 
+  #     @business_phone2.nil? && @business_fax.nil? && @business_address.nil? && @other_phone.nil? && @other_fax.nil? && @other_address
+  #   end
+  #   
+  #   
+  #   def method_missing(method, *args)
+  #   end
+  
+end

data/lib/contact_csv/contact_csv.rb

@@ -0,0 +1,14 @@
+# === ContactCsv
+# 
+# ==== Reading in CSV
+#
+#  The two class methods are used to read in a CSV file of contacts exported by email clients such as Outlook or GMail. Both methods return an Array of Contact objects.
+#
+#    ContactCSV.read('/path/to/file.csv')  
+#
+#    ContactCSV.parse('csv,data,string')  
+#
+module ContactCsv
+  module LookupTables
+  end
+end

data/lib/contact_csv/contact_manager.rb

@@ -0,0 +1,52 @@
+class ContactCsv::ContactManager
+  include ContactCsv
+  
+  attr_accessor :contacts
+  
+  def initialize(csv, lookup_tables=[])
+    @contacts = []
+    
+    lookup_table = find_lookup_table(csv, lookup_tables)
+    raise LookupTableNotFoundError if lookup_table.nil?
+    
+    csv.each do |row|
+      c = Contact.new
+    
+      row.each do |r|
+        col = lookup_table.lookup(r[0])
+        if !col.nil? && c.respond_to?(col.to_sym)
+          c.send("#{col.to_s}=", r[1])
+        else
+          c.add_extra({ r[0] => r[1] })
+        end
+      
+      end
+    
+      contacts << c
+    end
+    
+    contacts
+  end
+  
+  
+  
+  #def contacts
+  #  []
+  #end
+  
+  
+  
+  private
+  
+  def find_lookup_table(csv, lookup_tables)
+    tables = lookup_tables + [ContactCsv::LookupTables::OutlookCsv.lookup_table]
+    tables.each do |table|
+      return table if table.headers == csv.headers
+    end
+    return nil
+  end
+  
+
+  class LookupTableNotFoundError < StandardError; end
+
+end

data/lib/contact_csv/importer.rb

@@ -0,0 +1,18 @@
+class ContactCsv::Importer
+  include ContactCsv
+  
+  # Creates an Array of Contact objects from a CSV File
+  def self.read(file_path, lookup_tables=[])
+    csv = FasterCSV.read(file_path, :headers => true)
+    contact_manager = ContactManager.new(csv, lookup_tables)
+    contact_manager.contacts
+  end
+
+  # Creates an Array of Contact objects from a CSV String
+  def self.parse(csv_string, lookup_tables=[])
+    csv = FasterCSV.parse(csv_string, :headers => true)
+    contact_manager = ContactManager.new(csv, lookup_tables)
+    contact_manager.contacts
+  end
+  
+end

data/lib/contact_csv/lookup_tables/lookup_table.rb

@@ -0,0 +1,20 @@
+class ContactCsv::LookupTables::LookupTable
+  
+    class InvalidInputFormatError < StandardError; end
+
+    attr_accessor :legend, :headers
+
+
+    def initialize(headers, legend)
+      raise InvalidInputFormatError unless headers.is_a?(Array) && legend.is_a?(Hash)
+      @headers = headers
+      @legend = legend
+    end
+
+
+    # Returns the corresponding Contact attribute mapped to the specific Outlook CSV column name
+    def lookup(column)
+      @legend[column]
+    end
+  
+end

data/lib/contact_csv/lookup_tables/outlook_csv.rb

@@ -0,0 +1,114 @@
+# === OutlookCsv
+#
+#
+#
+#
+class ContactCsv::LookupTables::OutlookCsv
+   include ContactCsv::LookupTables
+   
+    def self.legend
+      {
+        'Title'               => :title,
+        'First Name'          => :first_name,
+        'Middle Name'         => :middle_name,
+        'Last Name'           => :last_name,
+        'E-mail Address'      => :email
+      }
+    end 
+  
+    # Returns an Array of all the headers for a Outlook CSV file
+    def self.headers
+      [ "Title",
+        "First Name",
+        "Middle Name",
+        "Last Name",
+        "Suffix",
+        "Company",
+        "Department",
+        "Job Title",
+        "Business Street",
+        "Business Street 2",
+        "Business Street 3",
+        "Business City",
+        "Business State",
+        "Business Postal Code",
+        "Business Country",
+        "Home Street",
+        "Home Street 2",
+        "Home Street 3",
+        "Home City",
+        "Home State",
+        "Home Postal Code",
+        "Home Country",
+        "Other Street",
+        "Other Street 2",
+        "Other Street 3",
+        "Other City",
+        "Other State",
+        "Other Postal Code",
+        "Other Country",
+        "Assistant's Phone",
+        "Business Fax",
+        "Business Phone",
+        "Business Phone 2",
+        "Callback",
+        "Car Phone",
+        "Company Main Phone",
+        "Home Fax","Home Phone",
+        "Home Phone 2",
+        "ISDN",
+        "Mobile Phone",
+        "Other Fax",
+        "Other Phone",
+        "Pager",
+        "Primary Phone",
+        "Radio Phone",
+        "TTY/TDD Phone",
+        "Telex","Account",
+        "Anniversary",
+        "Assistant's Name",
+        "Billing Information",
+        "Birthday",
+        "Business Address PO Box",
+        "Categories","Children",
+        "Directory Server",
+        "E-mail Address",
+        "E-mail Type",
+        "E-mail Display Name",
+        "E-mail 2 Address",
+        "E-mail 2 Type",
+        "E-mail 2 Display Name",
+        "E-mail 3 Address",
+        "E-mail 3 Type",
+        "E-mail 3 Display Name",
+        "Gender",
+        "Government ID Number",
+        "Hobby",
+        "Home Address PO Box",
+        "Initials",
+        "Internet Free Busy",
+        "Keywords","Language",
+        "Location",
+        "Manager's Name",
+        "Mileage",
+        "Notes",
+        "Office Location",
+        "Organizational ID Number",
+        "Other Address PO Box",
+        "Priority","Private",
+        "Profession",
+        "Referred By",
+        "Sensitivity",
+        "Spouse",
+        "User 1",
+        "User 2",
+        "User 3",
+        "User 4",
+        "Web Page"]
+    end
+
+    def self.lookup_table
+      LookupTable.new(self.headers, self.legend)
+    end
+
+  end