go_import 3.0.0 → 3.0.1

data/bin/go-import

@@ -43,7 +43,11 @@ class GoImportCommandLine < Thor
         end
     end
 
-    desc "run", "Executes the current project and create a go-import.xml file. Existing go-import.xml will be overwritten, use -o to specify a different filename"
+    desc "run", "Executes the current project and create a go.xml file. Existing go.xml will be overwritten, use --output to specify a different filename"
+    option(:output,
+           :desc => "Name of the file where the converted source will be saved. This file should be sent to LIME Go. If the file already exist it will be replaced.",
+           :type => :string,
+           :required => false)
     def run_import()
         # run is a Thor reserved word and cant be used as a method name
 
@@ -66,7 +70,7 @@ class GoImportCommandLine < Thor
         # returns an instance of GoImport::RootModel
         model = convert_source()
 
-        go_data_filename = "go.xml"
+        go_data_filename = options.output.nil? == true ? "go.xml" : options.output
 
         error = model.sanity_check
         if error.empty?

data/lib/go_import/model/deal_class_settings.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+require_relative 'class_settings'
+
 module GoImport
     class DealClassSettings < ClassSettings
         attr_reader :statuses

data/lib/go_import/model/rootmodel.rb

@@ -114,7 +114,7 @@ module GoImport
             organization = Organization.new(organization) if !organization.is_a?(Organization)
 
             if find_organization_by_integration_id(organization.integration_id) != nil
-                raise AlreadyAddedError, "Already added an organization with integration_id #(organization.integration_id)"
+                raise AlreadyAddedError, "Already added an organization with integration_id #{organization.integration_id}"
             end
 
             @organizations.push(organization)

data/lib/go_import.rb

@@ -7,7 +7,6 @@ module GoImport
     require 'go_import/errors'
     require 'go_import/serialize_helper'
     require 'go_import/model_helpers'
-    #FruitToLime::require_all_in 'go_import/model/*.rb'
     GoImport::require_all_in 'go_import/model/*.rb'
     require 'go_import/csv_helper'
     require 'go_import/roo_helper'

data/sources/VISMA/.gitignore

@@ -0,0 +1,14 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+# Ignore built gems
+/*.gem
+# Ignore all logfiles and tempfiles.
+/tmp
+/spec/tmp
+pkg

data/sources/VISMA/.go_import/runner.rb

@@ -0,0 +1,77 @@
+# encoding: UTF-8
+
+require 'go_import'
+#require 'roo'
+require 'dbf'
+require_relative("../converter")
+
+KUND_FILE = './database/KUND.DBF'
+KONTAKT_FILE = './database/KONTAKT.DBF'
+
+def convert_source
+    puts "Trying to convert VISMA source to LIME Go..."
+
+    # Verify that required files exists.
+    if !File.exists?(KUND_FILE)
+        puts "You MUST put KUND.DBF in the database folder."
+        raise
+    end
+
+    if !File.exists?(KONTAKT_FILE)
+        puts "You MUST put KONTAKT.DBF in the database folder."
+        raise
+    end
+
+    puts "Trying to read data from VISMA files..."
+    organization_rows = DBF::Table.new(KUND_FILE)
+    person_rows = DBF::Table.new(KONTAKT_FILE)
+
+    rootmodel = GoImport::RootModel.new
+    converter = Converter.new
+
+    converter.configure rootmodel
+
+    # Then create organizations, they are only referenced by
+    # coworkers.
+    puts "Trying to process Organization..."
+    organization_rows.each do |row|
+        if not row.nil?
+            if not row["NAMN"] == ""
+                rootmodel.add_organization(converter.to_organization(row, rootmodel))
+            end
+        end
+    end
+    puts "Processed #{rootmodel.organizations.length} Organizations."
+
+    # Add people and link them to their organizations
+    puts "Trying to process Persons..."
+    imported_person_count = 0
+    person_rows.each do |row|
+        # People are special since they are not added directly to
+        # the root model
+        if not row.nil?
+            if not row["KUNDNR"] == "" and not row["NAMN"] == ""
+                converter.import_person_to_organization(row, rootmodel)
+                imported_person_count = imported_person_count + 1
+            end
+        end
+    end
+    puts "Processed #{imported_person_count} Persons."
+
+    # Notes must be owned by a coworker and the be added to
+    # organizations and notes and might refernce a person
+    puts "Trying to process Notes..."
+    imported_note_count = 0
+    organization_rows.each do |row|
+        if not row.nil?
+            if row['ANTECK_1'].length > 0
+                rootmodel.add_note(converter.to_note(row))
+                imported_note_count = imported_note_count + 1
+            end
+        end
+    end
+    puts "Processed #{imported_note_count} Notes."
+
+    return rootmodel
+end
+

data/sources/VISMA/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'rspec'
+gem 'go_import'
+gem 'dbf'

data/sources/VISMA/converter.rb

@@ -0,0 +1,104 @@
+require 'go_import'
+require 'dbf'
+
+# Customize this file to suit your input for a VISMA database.
+#
+# You must put KUND.DBS and KONTAKTER.DBS in the database folder.
+#
+# Documentation go_import can be found at
+# http://rubygems.org/gems/go_import
+#
+# go_import contains all objects in LIME Go such as organizations,
+# people, deals, etc. What properties each object has is described in
+# the documentation.
+#
+# Generate the xml-file that should be sent to LIME Go with the command:
+# go-import run
+
+class Converter
+    def configure(rootmodel)
+        # Add custom field to your model 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.
+
+        #Creates a custom field to add invoicing data
+        rootmodel.settings.with_organization do |org|
+            org.set_custom_field( { :integrationid => 'ackoms', :title => 'Fakturerat', :type => :String } )
+        end
+    end
+
+    def import_person_to_organization(row, rootmodel)
+        organization = rootmodel.find_organization_by_integration_id(row['KUNDNR'])
+
+        if !organization.nil?
+            organization.add_employee(to_person(row, rootmodel))
+        end
+    end
+
+    def to_organization(row, rootmodel)
+        organization = GoImport::Organization.new()
+
+        #Add tags:
+        organization.set_tag "Importerad"
+        organization.set_tag "Kund"
+
+        organization.name = row['NAMN']
+        # Integrationid must be set to be able to import the same file
+        # more than once without creating duplicates
+        organization.integration_id = row['KUNDNR']
+
+        #address
+        organization.with_postal_address do |address|
+            address.street = row['POSTADR']
+            address.zip_code = row['POSTNR']
+            address.city = row['ORT']
+        end
+
+        organization.email = row['EPOST']
+        organization.organization_number = row['ORGNR']
+        organization.central_phone_number = row['TEL']
+
+        # Sets the organization's relation. Relation must be a value
+        # from GoImport::Relation.
+        organization.relation = GoImport::Relation::IsACustomer
+
+        #Fill data to custom fields
+        organization.set_custom_field({:integration_id => "ackoms", :value => row["ACKOMS"]})
+
+        return organization
+    end
+
+    def to_note(row, rootmodel)
+        note = GoImport::Note.new()
+
+        # *** TODO:
+        #
+        # Set note properties from the row.
+        organization = rootmodel.find_organization_by_integration_id(row['KUNDNR'])
+        unless organization.nil?
+            note.organization = organization
+        end
+        note.created_by = rootmodel.import_coworker
+        note.text = row['ANTECK_1']
+
+        return note
+    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['EPOST'])
+            person.email = row['EPOST']
+        end
+        person.mobile_phone_number = GoImport::PhoneHelper.parse_numbers(row['MBTEL'], [",", "/", "\\"])
+        person.direct_phone_number = GoImport::PhoneHelper.parse_numbers(row['TEL'], [",", "/", "\\"])
+
+        return person
+    end
+end

data/sources/VISMA/tomodel.rb

@@ -0,0 +1,202 @@
+require 'go_import'
+require 'roo'
+require 'dbf'
+
+# Customize this file to suit your input for a VISMA database.
+# You'll need KUND.DBS and KONTAKTER.DBS
+#
+# Documentation go_import can be found at
+# http://rubygems.org/gems/go_import
+#
+# go_import contains all objects in LIME Go such as organization,
+# people, deals, etc. What properties each object has is described in
+# the documentation.
+
+# *** TODO:
+#
+# This template will convert the files KUNDER.dbs and KONTAKTER.DBS to LIME Go. You
+# should modify the Converted class suit your input file.
+#
+# Try this template with the template.xlsx file to generate a go.xml
+#file:
+# ruby convert.rb to_go lime-go.xml
+
+class Converter
+    def configure(model)
+        # Add custom field to your model 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.
+
+        #Creates a custom field to add invoicing data
+        model.settings.with_organization do |org|
+            org.set_custom_field( { :integrationid => 'ackoms', :title => 'Fakturerat', :type => :String } )
+        end
+    end
+
+    def import_person_to_organization(row)
+        person = to_person(row)
+        organization = @rootmodel.find_organization_by_integration_id(row['KUNDNR'])
+
+        if !organization.nil?
+            organization.add_employee(person)
+        end
+    end
+
+    def to_organization(row)
+        organization = GoImport::Organization.new()
+
+        #Add tags:
+        organization.set_tag "Importerad"
+        organization.set_tag "Kund"
+
+        organization.name = row['NAMN']
+        # 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['KUNDNR']
+
+        #address
+        organization.with_postal_address do |address|
+            address.street = row['POSTADR']
+            address.zip_code = row['POSTNR']
+            address.city = row['ORT']
+        end
+
+        organization.email = row['EPOST']
+        organization.organization_number = row['ORGNR']
+        organization.central_phone_number = row['TEL']
+
+        # Sets the organization's relation. Relation must be a value
+        # from GoImport::Relation.
+        organization.relation = GoImport::Relation::IsACustomer
+
+        #Fill data to custom fields
+        organization.set_custom_field({:integration_id=>"ackoms", :value=>row["ACKOMS"]})
+
+        return organization
+    end
+
+    def to_note(row)
+        note = GoImport::Note.new()
+
+        # *** TODO:
+        #
+        # Set note properties from the row.
+        organization = @rootmodel.find_organization_by_integration_id(row['KUNDNR'])
+        unless organization.nil?
+            note.organization = organization
+        end
+        note.created_by = @rootmodel.import_coworker
+        note.text = row['ANTECK_1']
+
+        return note
+    end
+
+    def to_person(row)
+        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['EPOST'])
+            person.email = row['EPOST']
+        end
+        person.mobile_phone_number = GoImport::PhoneHelper.parse_numbers(row['MBTEL'], [",", "/", "\\"])
+        person.direct_phone_number = GoImport::PhoneHelper.parse_numbers(row['TEL'], [",", "/", "\\"])
+
+        return person
+    end
+
+    def to_model()
+        # First we read each database into separate variables
+        puts "Reading data from './Databas/'"
+        organization_rows = DBF::Table.new("./Databas/KUND.DBF")
+        person_rows = DBF::Table.new("./Databas/KONTAKT.DBF")
+
+        # Then we create a rootmodel that should contain all data that
+        # should be exported to LIME Go.
+        @rootmodel = GoImport::RootModel.new
+
+        # And configure the model if we have any custom fields
+        puts "Adding custom fields to model"
+        configure @rootmodel
+
+        # Then create organizations, they are only referenced by
+        # coworkers.
+        puts "Importing Organization..."
+        organization_rows.each do |row|
+            if not row.nil?
+                if not row["NAMN"] == ""
+                    @rootmodel.add_organization(to_organization(row))
+                end
+            end
+        end
+        puts "Imported #{@rootmodel.organizations.length} Organization"
+
+        # Add people and link them to their organizations
+        puts "Importing Persons..."
+        imported_person_count = 0
+        person_rows.each do |row|
+            # People are special since they are not added directly to
+            # the root model
+            if not row.nil?
+                if not row["KUNDNR"] == "" and not row["NAMN"] == ""
+                    import_person_to_organization(row)
+                    imported_person_count = nbrPersons + 1
+                end
+            end
+        end
+        puts "Imported #{imported_person_count} Persons"
+
+        # Deals can connected to coworkers, organizations and people.
+        # deal_rows.each do |row|
+        #     @rootmodel.add_deal(to_deal(row))
+        # end
+
+        # Notes must be owned by a coworker and the be added to
+        # organizations and notes and might refernce a person
+        puts "Importing Notes..."
+        organization_rows.each do |row|
+            if not row.nil?
+                if row['ANTECK_1'].length > 0
+                    @rootmodel.add_note(to_note(row))
+                end
+            end
+        end
+
+        return @rootmodel
+    end
+end
+
+# You don't need to change anything below this line.
+
+require "thor"
+require "fileutils"
+require 'pathname'
+
+class Cli < Thor
+    desc "to_go GO_DATA_FILENAME", "Converts VISMA 'KUND.DBS' and 'KONTAKTER.DBS' to Go xml format. Place the DBS-files in the folder 'Databas'. GO_DATA_FILENAME is output file where Go xml will go."
+    def to_go(go_data_filename = nil)
+        go_data_filename = 'go-data.xml' if go_data_filename == nil
+        converter = Converter.new()
+        model = converter.to_model()
+        error = model.sanity_check
+        if error.empty?
+            validation_errors = model.validate
+
+            if validation_errors.empty?
+                model.serialize_to_file(go_data_filename)
+                puts "VISMA data has been converted into '#{go_data_filename}'."
+            else
+                puts "VISMA database could not be converted due to"
+                puts validation_errors
+            end
+        else
+            puts "VISMA database could not be converted due to"
+            puts error
+        end
+    end
+end

data/sources/csv/Gemfile

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

data/sources/custom/.gitignore

@@ -0,0 +1,14 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+# Ignore built gems
+/*.gem
+# Ignore all logfiles and tempfiles.
+/tmp
+/spec/tmp
+pkg

data/sources/custom/.go_import/runner.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+
+require 'go_import'
+require_relative("../converter")
+
+def convert_source
+    puts "Trying to convert a custom source to LIME Go..."
+
+    converter = Converter.new
+
+    if !converter.respond_to?(:to_go)
+        puts "The converter must have a method called to_go that returns an instance of GoImport::RootModel."
+        raise "The converter must have a method called to_go that returns an instance of GoImport::RootModel."
+    end
+
+    rootmodel = converter.to_go
+
+    if rootmodel.nil?
+        puts "The returned rootmodel is nil. You must return a GoImport::RootModel."
+        raise "The returned rootmodel is nil. You must return a GoImport::RootModel."
+    end
+
+    if !rootmodel.is_a?(GoImport::RootModel)
+        puts "The returned object is not an instance of GoImport::RootModel."
+        raise "The returned object is not an instance of GoImport::RootModel."
+    end
+
+    return rootmodel
+end
+

data/sources/custom/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+gem 'rspec'
+gem 'go_import'

data/sources/custom/converter.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'go_import'
+
+# This Converter will convert a generic source to a XML file that can
+# be imported into LIME Go.
+#
+# You MUST customzie this script to read a source and return a
+# RootModel.
+#
+# Reference documentation for go_import can be found at
+# https://rubygems.org/gems/go_import (click Documentation)
+#
+# Generate the xml-file that should be sent to LIME Go with the
+# command:
+# go-import run
+#
+# Good luck.
+
+class Converter
+    def to_go()
+        rootmodel = GoImport::RootModel.new
+
+        # *** TODO:
+        #
+        # Configure the model and then add coworkers, organizations, etc
+
+        return rootmodel
+    end
+end