go_import 3.0.0

data/sources/excel/.go_import/runner.rb

@@ -0,0 +1,116 @@
+# encoding: UTF-8
+
+require 'go_import'
+require 'roo'
+require_relative("../converter")
+
+def convert_source
+    puts "Trying to convert Excel source to LIME Go..."
+
+    converter = Converter.new
+
+    # *** TODO:
+    #
+    # Modify the name of the sheets. Or add/remove sheets based on
+    # your Excel file.
+
+    # First we read each sheet from the excel file into separate
+    # variables
+    excel_workbook = GoImport::ExcelHelper.Open(EXCEL_FILE)
+
+    if defined?(COWORKER_SHEET)
+        if excel_workbook.has_sheet?(COWORKER_SHEET)
+            coworker_rows = excel_workbook.rows_for_sheet COWORKER_SHEET
+        else
+            puts "Warning: can't find sheet '#{COWORKER_SHEET}'"
+        end
+    end
+
+    if defined?(ORGANIZATION_SHEET)
+        if excel_workbook.has_sheet?(ORGANIZATION_SHEET)
+            organization_rows = excel_workbook.rows_for_sheet ORGANIZATION_SHEET
+        else
+            puts "Warning: can't find sheet '#{ORGANIZATION_SHEET}'"
+        end
+    end
+
+    if defined?(PERSON_SHEET)
+        if excel_workbook.has_sheet?(PERSON_SHEET)
+            person_rows = excel_workbook.rows_for_sheet PERSON_SHEET
+        else
+            puts "Warning: can't find sheet '#{PERSON_SHEET}'"
+        end
+    end
+
+    if defined?(DEAL_SHEET)
+        if excel_workbook.has_sheet?(DEAL_SHEET)
+            deal_rows = excel_workbook.rows_for_sheet DEAL_SHEET
+        else
+            puts "Warning: can't find sheet '#{DEAL_SHEET}'"
+        end
+    end
+
+    if defined?(NOTE_SHEET)
+        if excel_workbook.has_sheet?(NOTE_SHEET)
+            note_rows = excel_workbook.rows_for_sheet NOTE_SHEET
+        else
+            puts "Warning: can't find sheet '#{NOTE_SHEET}'"
+        end
+    end
+
+    # Then we create a rootmodel that will contain all data that
+    # should be exported to LIME Go.
+    rootmodel = GoImport::RootModel.new
+
+    # And configure the model if we have any custom fields
+    converter.configure rootmodel
+
+    # Now start to read data from the excel file and add to the
+    # rootmodel. We begin with coworkers since they are referenced
+    # from everywhere (orgs, deals, notes)
+    if defined?(coworker_rows) && !coworker_rows.nil?
+        puts "Trying to convert coworkers..."
+        coworker_rows.each do |row|
+            rootmodel.add_coworker(converter.to_coworker(row))
+        end
+    end
+
+    # Then create organizations, they are only referenced by
+    # coworkers.
+    if defined?(organization_rows) && !organization_rows.nil?
+        puts "Trying to convert organizations..."
+        organization_rows.each do |row|
+            rootmodel.add_organization(converter.to_organization(row, rootmodel))
+        end
+    end
+
+    # Add people and link them to their organizations
+    if defined?(person_rows) && !person_rows.nil?
+        puts "Trying to convert persons..."
+        person_rows.each do |row|
+            # People are special since they are not added directly to
+            # the root model
+            converter.import_person_to_organization(row, rootmodel)
+        end
+    end
+
+    # Deals can connected to coworkers, organizations and people.
+    if defined?(deal_rows) && !deal_rows.nil?
+        puts "Trying to convert deals..."
+        deal_rows.each do |row|
+            rootmodel.add_deal(converter.to_deal(row, rootmodel))
+        end
+    end
+
+    # Notes must be owned by a coworker and the be added to
+    # organizations and notes and might refernce a person
+    if defined?(note_rows) && !note_rows.nil?
+        puts "Trying to convert notes..."
+        note_rows.each do |row|
+            rootmodel.add_note(converter.to_note(row, rootmodel))
+        end
+    end
+
+    return rootmodel
+end
+

data/sources/excel/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'rspec'
+gem 'roo'
+gem 'thor'
+#gem 'go_import'

data/sources/excel/Rakefile.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/sources/excel/converter.rb

@@ -0,0 +1,130 @@
+# encoding: UTF-8
+require 'go_import'
+require 'roo'
+
+# This Converter will convert an Excel file to a XML file that can be
+# imported into LIME Go.
+#
+# You need to customize this script to suit your Excel file.
+
+# First set the name of the Excel file to convert. It is a filename
+# relative to this folder.
+EXCEL_FILE = "template.xlsx"
+
+COWORKER_SHEET = "Medarbetare"
+ORGANIZATION_SHEET = "Företag"
+PERSON_SHEET = "Kontaktperson"
+DEAL_SHEET = "Affär"
+NOTE_SHEET = "Anteckningar"
+
+# Then you need to modify the script below according to the TODO
+# comments.
+
+# To generate the xml-file that should be sent to LIME Go with the
+# command:
+# go-import run
+
+class Converter
+    def configure(rootmodel)
+        # *** TODO: Add custom field to your rootmodel here. Custom fields
+        # can be added to organization, deal and person. Valid types
+        # are :String and :Link. If no type is specified :String is
+        # used as default.
+
+        # rootmodel.settings.with_organization do |organization|
+        #     organization.set_custom_field( { :integrationid => 'source', :title => 'Källa', :type => :Link } )
+        # end
+    end
+
+    def import_person_to_organization(row, rootmodel)
+        person = to_person(row, rootmodel)
+        organization = rootmodel.find_organization_by_integration_id(row['ID'])
+
+        if !organization.nil?
+            organization.add_employee(person)
+        end
+    end
+
+    def to_coworker(row)
+        coworker = GoImport::Coworker.new()
+
+        # *** TODO:
+        #
+        # Set coworker properties from the row.
+
+        coworker.parse_name_to_firstname_lastname_se row['Namn/Titel']
+        coworker.integration_id = row['Namn/Titel']
+        if GoImport::EmailHelper.is_valid?(row['Email'])
+            coworker.email = row['Email']
+        end
+
+        return coworker
+    end
+
+    def to_deal(row, rootmodel)
+        deal = GoImport::Deal.new()
+
+        # *** TODO:
+        #
+        # Set deal properties from the row.
+
+        return deal
+    end
+
+    def to_organization(row, rootmodel)
+        organization = GoImport::Organization.new()
+        organization.set_tag "Importerad"
+
+        # Integrationid is typically the id in the system that we are
+        # getting the csv from. Must be set to be able to import the
+        # same file more than once without creating duplicates
+        organization.integration_id = row['ID']
+
+        # Sets the organization's relation. Relation must be a value
+        # from GoImport::Relation.
+        organization.relation = GoImport::Relation::IsACustomer
+
+        # *** TODO:
+        #
+        # Set organization properties from the row.
+
+        organization.name = row['Namn']
+
+        # Custom fields should be set like this.
+        # organization.set_custom_value("source", "internet")
+
+        return organization
+    end
+
+    def to_person(row, rootmodel)
+        person = GoImport::Person.new()
+
+        # *** TODO:
+        #
+        # Set person properties from the row.
+
+        person.parse_name_to_firstname_lastname_se(row['Namn'])
+        if GoImport::EmailHelper.is_valid?(row['Email'])
+            person.email = row['Email']
+        end
+        person.mobile_phone_number, person.direct_phone_number =
+            GoImport::PhoneHelper.parse_numbers(row['Telefon'], [",", "/", "\\"])
+
+        return person
+    end
+
+    def to_note(row, rootmodel)
+        note = GoImport::Note.new()
+
+        # *** TODO:
+        #
+        # Set note properties from the row.
+
+        note.organization = rootmodel.find_organization_by_integration_id(row['ID'])
+        note.created_by = rootmodel.find_coworker_by_integration_id(row['Skapad av'])
+        note.text = row['Text']
+        note.date = row['Skapad den']
+
+        return note
+    end
+end

data/sources/excel/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+#require File.expand_path("../../config/environment", __FILE__)
+#require 'rspec/autorun'
+
+RSpec.configure do |config|
+    # ## Mock Framework
+    #
+    # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+    #
+    # config.mock_with :mocha
+    # config.mock_with :flexmock
+    # config.mock_with :rr
+
+    # Run specs in random order to surface order dependencies. If you find an
+    # order dependency and want to debug it, you can fix the order by providing
+    # the seed, which is printed after each run.
+    #     --seed 1234
+    config.order = "random"
+
+    # Allow both should and expect syntax
+    # http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    config.expect_with :rspec do |c|
+        c.syntax = [:should, :expect]
+    end
+end
+

data/sources/excel/spec/tomodel_spec.rb

@@ -0,0 +1,18 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+require 'tomodel'
+
+describe 'Model' do
+    before(:all) do
+        converter = Converter.new
+        samplefile = File.join(File.dirname(__FILE__), '..', 'template.xlsx')
+        @rootmodel = converter.to_model(samplefile)
+    end
+
+    it "will find something with a name" do
+        organization = @rootmodel.organizations[0]
+        organization.name.length.should > 0
+    end
+end
+

data/spec/address_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'go_import'
+
+describe GoImport::Address do
+    describe "Parse line with swedish zip and city into zipcode" do
+        let (:zip_code) {
+            address = GoImport::Address.new
+            line = "114 45 STOCKHOLM"
+            address.parse_zip_and_address_se(line).zip_code
+        }
+        it "should have zipcode equal to '114 45'" do
+            zip_code.should eq '114 45'
+        end
+    end
+
+    describe "Parse line with swedish zip and city into city" do
+        let (:city){
+            address = GoImport::Address.new
+            line = "114 45 STOCKHOLM"
+            address.parse_zip_and_address_se(line).city
+        }
+        it "should have city equal to 'STOCKHOLM'" do
+            city.should eq 'STOCKHOLM'
+        end
+    end
+
+    describe "Parse line with non-swedish zip and city assuming swedish format" do
+        describe "praha example" do
+            let (:parse_result){
+                address = GoImport::Address.new
+                line = "CZ-140 00 PRAHA 4"
+                address.parse_zip_and_address_se(line)          
+            }
+            it "should be nil" do
+                parse_result.should == nil
+            end
+        end
+        describe "finnish example" do
+            let (:parse_result){
+                address = GoImport::Address.new
+                line = "0511  HELSINKI"
+                address.parse_zip_and_address_se(line)          
+            }
+            it "should be nil" do
+                parse_result.should == nil
+            end
+        end
+    end
+end

data/spec/class_settings_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+require 'go_import'
+
+describe "ClassSettings" do
+    let(:class_settings) {
+        GoImport::ClassSettings.new
+    }
+
+    it "can set custom field and if there is already an existing custom field, then it is overwritten." do
+        class_settings.set_custom_field({:integration_id => "link_to_bi_system", :title => "Link to BI system"})
+        class_settings.set_custom_field({:integration_id => "link_to_bi_system", :title => "Link to BI system 2"})
+        class_settings.custom_fields.length.should eq 1
+        class_settings.custom_fields[0].title.should eq "Link to BI system 2"
+    end
+
+    it "should not allow new custom fields without id and integration id" do
+        begin
+            class_settings.set_custom_field({:integration_id => "", :id => "", :title => "Link to BI system"})
+        rescue
+        end
+
+        class_settings.custom_fields.length.should eq 0
+    end
+
+    it "should allow new custom field with integration_id" do
+        class_settings.set_custom_field({:integration_id => "link_to_bi_system", :title => "Link to BI system"})
+        class_settings.custom_fields.length.should eq 1
+        class_settings.custom_fields[0].title.should eq "Link to BI system"
+    end
+
+    it "should allow new custom field with id" do
+        class_settings.set_custom_field({:id => "123", :title => "Link to BI system"})
+        class_settings.custom_fields.length.should eq 1
+        class_settings.custom_fields[0].title.should eq "Link to BI system"
+    end
+end
+

data/spec/coworker_spec.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+require "spec_helper"
+require 'go_import'
+
+describe "Coworker" do
+    let(:coworker) {
+        GoImport::Coworker.new
+    }
+
+    describe "parse_name_to_firstname_lastname_se" do
+        it "can parse 'Kalle Nilsson' into firstname 'Kalle' and lastname 'Nilsson'" do
+            coworker.parse_name_to_firstname_lastname_se 'Kalle Nilsson'
+
+            coworker.first_name.should eq 'Kalle'
+            coworker.last_name.should eq 'Nilsson'
+
+        end
+
+        it "can parse 'Kalle Svensson Nilsson' into firstname 'Kalle' and lastname 'Svensson Nilsson'" do
+            coworker.parse_name_to_firstname_lastname_se 'Kalle Svensson Nilsson'
+
+            coworker.first_name.should eq 'Kalle'
+            coworker.last_name.should eq 'Svensson Nilsson'
+        end
+
+        it "sets default name when name is empty" do
+            coworker.parse_name_to_firstname_lastname_se '', 'a default'
+
+            coworker.first_name.should eq 'a default'
+        end
+
+        it "sets default name when name is nil" do
+            coworker.parse_name_to_firstname_lastname_se nil, 'a default'
+
+            coworker.first_name.should eq 'a default'
+        end
+    end
+
+    describe "guess_email" do
+        it "guesses kalle.nilsson@x.com for coworker with firstname 'Kalle', lastname 'Nilsson' and domain set to 'x.com" do
+            coworker.first_name = 'Kalle'
+            coworker.last_name = 'Nilsson'
+
+            guessed = coworker.guess_email 'x.com'
+
+            guessed.should eq 'kalle.nilsson@x.com'
+        end
+
+        it "guesses '' when lastname is missing" do
+            coworker.first_name = 'Kalle'
+            coworker.last_name = ''
+
+            guessed = coworker.guess_email 'x.com'
+
+            guessed.should eq ''
+        end
+
+        it "guesses '' when firstname is missing" do
+            coworker.first_name = nil
+            coworker.last_name = 'Nilsson'
+
+            guessed = coworker.guess_email 'x.com'
+
+            guessed.should eq ''
+        end
+
+        it "guesses åäöèé to be aaoee" do
+            coworker.first_name = 'åäöèé'
+            coworker.last_name = 'Nilsson'
+
+            guessed = coworker.guess_email 'x.com'
+
+            guessed.should eq 'aaoee.nilsson@x.com'
+        end
+
+        it "guesses 'sven-erik.nilsson@x.com' when firstname has two names with ' ' between them" do
+            coworker.first_name = 'Sven Erik'
+            coworker.last_name = 'Nilsson'
+
+            guessed = coworker.guess_email 'x.com'
+
+            guessed.should eq 'sven-erik.nilsson@x.com'
+        end
+
+        it "guesses 'sven.nilsson-svensson@x.com' when lastnames has two names with ' ' between them" do
+            coworker.first_name = 'Sven'
+            coworker.last_name = 'Nilsson Svensson'
+
+            guessed = coworker.guess_email 'x.com'
+
+            guessed.should eq 'sven.nilsson-svensson@x.com'
+        end
+    end
+end

data/spec/custom_field_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+require 'go_import'
+
+describe "CustomField" do
+    before (:all) do
+        @custom_field = GoImport::CustomField.new({:id => 'the id',
+            :integration_id=>'the key',
+            :value=> 'the value'})
+    end
+
+    it "is the same as a custom field with the same integration_id" do
+        @custom_field.same_as?(GoImport::CustomField.new({:integration_id=>'the key',
+            :value=> 'the value 2'})).should eq true
+    end
+
+    it "is the same as a custom field with the same id" do
+        @custom_field.same_as?(GoImport::CustomField.new({:id=>'the id',
+            :value=> 'the value 2'})).should eq true
+    end
+
+end
+

data/spec/deal_class_settings_spec.rb

@@ -0,0 +1,104 @@
+require "spec_helper"
+require "go_import"
+
+describe "DealClassSettings" do
+    let(:deal_class_settings) {
+        GoImport::DealClassSettings.new
+    }
+
+    it "should not allow new deal status without a label" do
+        # given, when
+        begin
+            deal_class_settings.add_status({:integration_id => "123"})
+        rescue GoImport::InvalidDealStatusError
+        end
+
+        # then
+        deal_class_settings.statuses.length.should eq 0
+    end
+
+    it "should set assessment to NotAnEndState as default" do
+        # given, when
+        status = deal_class_settings.add_status({:label => "1. Kvalificering"})
+
+        # then
+        status.assessment.should eq GoImport::DealState::NotAnEndState
+    end
+
+    it "should set assessment if specified" do
+        # given, when
+        status = deal_class_settings.add_status({
+                                                    :label => "4. Won deal",
+                                                    :assessment => GoImport::DealState::PositiveEndState
+                                                })
+
+        # then
+        status.assessment.should eq GoImport::DealState::PositiveEndState
+    end
+
+    it "should find a status by case insensitive label" do
+        # given
+        deal_class_settings.add_status({:label => "1. Kvalificering"})
+        deal_class_settings.add_status({:label => "2. Skickat offert"})
+
+        # when
+        status = deal_class_settings.find_status_by_label("2. skICkat OfFert")
+
+        # then
+        status.label.should eq "2. Skickat offert"
+    end
+
+    it "should find a status by integration id" do
+        # given
+        deal_class_settings.add_status({:label => "1. Kvalificering", :integration_id => "qualify"})
+        deal_class_settings.add_status({:label => "2. Skickat offert", :integration_id => "tender sent"})
+
+        # when
+        status = deal_class_settings.find_status_by_integration_id("tender SeNT")
+
+        # then
+        status.label.should eq "2. Skickat offert"
+    end
+
+    it "should find nil by label if no statuses are defined" do
+        # given, when
+        status = deal_class_settings.find_status_by_label("3. Won")
+
+        # then
+        status.should eq nil
+    end
+
+    it "should find nil by label if label is nil" do
+        # given
+        deal_class_settings.add_status({:label => "1. Kvalificering", :integration_id => "qualify"})
+        deal_class_settings.add_status({:label => "2. Skickat offert", :integration_id => "tender sent"})
+
+        # when
+        status = deal_class_settings.find_status_by_label(nil)
+
+        # then
+        status.should eq nil
+    end
+
+    it "should find nil by integration id if no statuses are defined" do
+        # given, when
+        status = deal_class_settings.find_status_by_integration_id("3. Won")
+
+        # then
+        status.should eq nil
+    end
+
+    it "should find nil by integration id if integration id is nil" do
+        # given
+        deal_class_settings.add_status({:label => "1. Kvalificering", :integration_id => "qualify"})
+        deal_class_settings.add_status({:label => "2. Skickat offert", :integration_id => "tender sent"})
+
+        # when
+        status = deal_class_settings.find_status_by_integration_id(nil)
+
+        # then
+        status.should eq nil
+    end
+end
+
+