move-to-go 5.0.0

data/lib/move-to-go/source.rb

@@ -0,0 +1,108 @@
+require 'fileutils'
+require 'open3'
+
+module MoveToGo
+    class Sources
+        def initialize(path)
+            @path = path
+        end
+
+        def list()
+            Dir.entries(@path).select {
+                |f| f != '.' && f != '..'
+            }
+        end
+
+        def create_project_from_source(project_name, source_name)
+            if !source_exists?(source_name)
+                puts "The source '#{source_name}' doesnt exist."
+                return false
+            end
+
+            if project_exists?(project_name)
+                puts "A project named '#{project_name}' already exists"
+                return false
+            end
+
+            begin
+                copy_source_to_folder(source_name, project_name)
+
+                install_gems_for_project(project_name)
+                return true
+            rescue
+                puts "Something when wrong (errors should have been printed above)..."
+                FileUtils.remove_dir(project_name, true)
+                return false
+            end
+        end
+
+        def about_source(source_name)
+            if !source_exists?(source_name)
+                puts "The source '#{source_name}' doesnt exist."
+                return false
+            end
+            
+            print_about_file_for_source(source_name)
+        end
+
+        private
+        def print_about_file_for_source(name)
+            about_path = ::File.expand_path("#{name}/.move-to-go/readme.txt", @path)
+
+            if ::File.exists?(about_path)
+                about_contents = ::File.open(about_path, "rb").read
+                puts about_contents
+            else
+                puts "No about text specifed for source '#{name}'."
+            end
+        end
+        
+        private
+        def source_exists?(name)
+            source = list.find { |s| s.downcase == name.downcase }
+
+            return !source.nil?
+        end
+
+        private
+        def project_exists?(name)
+            # do we have a folder named 'name' in the current folder?
+            project = Dir.entries(Dir.pwd).find { |f| f.downcase == name.downcase}
+
+            return !project.nil?
+        end
+
+        private
+        def copy_source_to_folder(source_name, project_name)
+            puts "Trying to create project '#{project_name}' from source '#{source_name}'..."
+            FileUtils.cp_r ::File.expand_path(source_name, @path), project_name
+        end
+
+        private
+        def install_gems_for_project(project_name)
+            puts "Trying to verify that all required gems are installed..."
+            Dir.chdir(::File.expand_path(project_name, Dir.pwd)) do
+                exec_but_dont_show_unless_error('bundle install --verbose')
+            end
+        end
+
+        private
+        def exec_but_dont_show_unless_error(cmd)
+            std_out_value = []
+            Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+                while std_line = stdout.gets
+                    std_out_value << std_line
+                end
+
+                exit_status = wait_thr.value
+                if !exit_status.success?
+                    puts "Command '#{cmd}' failed with #{exit_status}"
+                    puts "Output from command:"
+                    puts std_out_value
+
+                    raise "failed exec #{cmd}"
+                end
+            end
+        end
+    end
+end

data/lib/move-to-go/templating.rb

@@ -0,0 +1,52 @@
+require "fileutils"
+require 'open3'
+module MoveToGo
+    class Templating
+        def initialize(path)
+            @path = path
+        end
+
+        def list()
+            Dir.entries(@path).select { |d| d != '.' && d != '..' }
+        end
+
+        def unpack(name, path)
+            template = list.find { |t| t == name }
+            if template
+                unpackedname = name
+
+                puts "Unpacking template #{name} to #{path}"
+                FileUtils.cp_r File.expand_path(name, @path), path
+
+                # Now make sure all gems in template are installed
+                puts "Making sure all needed gems are present"
+                Dir.chdir(File.expand_path(unpackedname, path)) do
+                    exec_but_dont_show_unless_error('bundle install --verbose')
+                end
+                true
+            else
+                puts "Unable to find template #{name}"
+                false
+            end
+        end
+
+        private
+        def exec_but_dont_show_unless_error(cmd)
+            std_out_value = []
+            Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+                while std_line = stdout.gets
+                    std_out_value << std_line
+                end
+
+                exit_status = wait_thr.value
+                if !exit_status.success?
+                    puts "Failed with #{exit_status}"
+                    puts "std_out_value"
+                    puts std_out_value
+
+                    raise "failed exec #{cmd}"
+                end
+            end
+        end
+    end
+end

data/lib/move-to-go.rb

@@ -0,0 +1,20 @@
+module MoveToGo
+    private
+    def self.require_all_in(folder)
+        Dir.glob(::File.join(::File.dirname(::File.absolute_path(__FILE__)),folder), &method(:require))
+    end
+
+    require_relative 'move-to-go/errors'
+    require_relative 'move-to-go/serialize_helper'
+    require_relative 'move-to-go/model_helpers'
+    require_relative 'move-to-go/can_become_immutable'
+    MoveToGo::require_all_in 'move-to-go/model/*.rb'
+    require_relative 'move-to-go/csv_helper'
+    require_relative 'move-to-go/roo_helper'
+    require_relative 'move-to-go/phone_helper'
+    require_relative 'move-to-go/email_helper'
+    require_relative 'move-to-go/excel_helper'
+    require_relative 'move-to-go/templating'
+    require_relative 'move-to-go/source'
+    require_relative 'move-to-go/shard_helper'
+end

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/.move-to-go/readme.txt

@@ -0,0 +1 @@
+This source converts a VISMA Administration 2000 database to LIME Go.

data/sources/VISMA/.move-to-go/runner.rb

@@ -0,0 +1,89 @@
+# encoding: UTF-8
+
+require 'move-to-go'
+#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 Administration 2000 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 = MoveToGo::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"] == ""
+                organization = converter.to_organization(row, rootmodel)
+                rootmodel.add_organization(organization)
+                converter.organization_hook(row, organization, rootmodel) if defined? converter.organization_hook
+            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."
+
+    # History must be owned by a coworker and then should reference
+    # organization or deal and might reference a person
+    puts "Trying to process History..."
+    imported_history_count = 0
+    organization_rows.each do |row|
+        if not row.nil?
+            if row['ANTECK_1'].length > 0
+
+                comment = MoveToGo::Comment.new()
+
+                organization = rootmodel.find_organization_by_integration_id(row['KUNDNR'])
+                unless organization.nil?
+                    comment.organization = organization
+                end
+                comment.created_by = rootmodel.migrator_coworker
+                comment.text = row['ANTECK_1']
+                
+                rootmodel.add_history(comment)
+                imported_history_count = imported_history_count + 1
+            end
+        end
+    end
+    puts "Processed #{imported_history_count} History."
+
+    return rootmodel
+end
+

data/sources/VISMA/Gemfile

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

data/sources/VISMA/converter.rb

@@ -0,0 +1,120 @@
+require 'move-to-go'
+require 'dbf'
+
+# Customize this file to suit your input for a 
+# VISMA Administration 2000 database.
+#
+# You must put KUND.DBS and KONTAKTER.DBS in the database folder.
+#
+# Documentation move-to-go can be found at
+# http://rubygems.org/gems/move-to-go
+#
+# move-to-go 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:
+# move-to-go run
+
+# If you are importing files then you must set the FILES_FOLDER
+# constant. FILES_FOLDER should point to the folder where the files
+# are stored. FILES_FOLDER can be relative to the project directory
+# or absolute. Note that you need to escape \ with a \ so in order to
+# write \ use \\.
+FILES_FOLDER = "./files"
+
+# If you are importing files with an absolute path (eg
+# m:\documents\readme.doc) then you probably wont have files at that
+# location on the computer where "move-to-go run" is executed. Set
+# FILES_FOLDER_AT_CUSTOMER to the folder where documents are stored at
+# the customers site. Ie, in this example m:\documents.
+# Note that you need to escape \ with a \ so in order to write \ use
+# \\.
+FILES_FOLDER_AT_CUSTOMER = "m:\\documents\\"
+
+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 = MoveToGo::Organization.new()
+
+        #Add tags:
+        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 MoveToGo::Relation.
+        organization.relation = MoveToGo::Relation::IsACustomer
+
+        #Fill data to custom fields
+        organization.set_custom_value("ackoms", row["ACKOMS"])
+
+        return organization
+    end
+
+    def to_person(row, rootmodel)
+        person = MoveToGo::Person.new()
+
+        # *** TODO:
+        #
+        # Set person properties from the row.
+
+        person.parse_name_to_firstname_lastname_se(row['NAMN'])
+        if MoveToGo::EmailHelper.is_valid?(row['EPOST'])
+            person.email = row['EPOST']
+        end
+        person.mobile_phone_number = MoveToGo::PhoneHelper.parse_numbers(row['MBTEL'], [",", "/", "\\"])
+        person.direct_phone_number = MoveToGo::PhoneHelper.parse_numbers(row['TEL'], [",", "/", "\\"])
+
+        return person
+    end
+
+    # HOOKS
+    #
+    # Sometimes you need to add exra information to the rootmodel, this can be done
+    # with hooks, below is an example of an organization hook that adds a comment to
+    # an organization if a field has a specific value
+    #def organization_hook(row, organization, rootmodel)
+    #    if not row['fieldname'].empty?
+    #        comment = MoveToGo::Comment.new
+    #        comment.text = row['fieldname']
+    #        comment.organization = organization
+    #        comment.created_by = rootmodel.migrator_coworker
+    #        rootmodel.add_history(comment)
+    #    end
+    #end
+
+end

data/sources/base-crm/.move-to-go/runner.rb

@@ -0,0 +1,235 @@
+require 'move-to-go'
+require_relative("../converter")
+
+REPORT_RESULT = true
+COWORKER_FILE = "data/coworkers.csv"
+ORGANIZATION_FILE = "data/contacts.csv"
+LEADS_FILE = "data/leads.csv"
+PERSON_FILE = "data/contacts.csv"
+DEAL_FILE = "data/deals.csv"
+HISTORY_FILE = "data/histories.csv"
+SOURCE_ENCODING = "utf-8"
+
+
+
+def process_rows(file_name, source_encoding)
+    data = File.read(file_name, :encoding => source_encoding)
+    rows = MoveToGo::CsvHelper::text_to_hashes(data)
+    rows.each do |row|
+        yield row
+    end
+end
+
+def convert_source
+    puts "Trying to convert Base CRM source to LIME Go..."
+
+    converter = Converter.new
+    ignored_histories = 0
+    ignored_persons = 0
+
+    # A rootmodel is used to represent all entitite/models that is
+    # exported
+    rootmodel = MoveToGo::RootModel.new
+
+    converter.configure(rootmodel)
+    source_encoding = defined?(SOURCE_ENCODING) ? SOURCE_ENCODING : 'ISO-8859-1'
+
+    # coworkers
+    # start with these since they are referenced
+    # from everywhere....
+    if defined?(COWORKER_FILE) && !COWORKER_FILE.nil? && !COWORKER_FILE.empty?
+        process_rows(COWORKER_FILE, source_encoding) do |row|
+            coworker = converter.to_coworker(row)
+            coworker.integration_id = "#{row['first_name']} #{row['last_name']}"
+            coworker.first_name = row['first_name']
+            coworker.last_name = row['last_name']
+            coworker.email = row['email']
+            rootmodel.add_coworker(coworker)
+        end
+    end
+
+    # organizations
+    if defined?(ORGANIZATION_FILE) && !ORGANIZATION_FILE.nil? && !ORGANIZATION_FILE.empty?
+        process_rows(ORGANIZATION_FILE, source_encoding) do |row|
+            next if row["is_organisation"] == "false"
+            organization = converter.to_organization(row, rootmodel)
+            organization = MoveToGo::Organization.new
+            organization.integration_id = row['id']
+            organization.name = row['name']
+            organization.email = row['email']
+            organization.web_site = row['website']
+            organization.central_phone_number = MoveToGo::PhoneHelper.parse_numbers(row['phone']) if not row['phone'].nil?
+
+            organization.with_visit_address do |address|
+                address.street = row['address']
+                address.zip_code = row['zip']
+                address.city = row['city']
+            end
+
+            organization.with_postal_address do |address|
+                address.street = row['address']
+                address.zip_code = row['zip']
+                address.city = row['city']
+            end
+
+            case row['prospect_status']
+            when "current"
+                organization.relation = MoveToGo::Relation::WorkingOnIt
+            else
+                organization.relation = MoveToGo::Relation::BeenInTouch
+            end
+
+            case row['customer_status']
+            when "current"
+                organization.relation = MoveToGo::Relation::IsACustomer
+            when "past"
+                organization.relation = MoveToGo::Relation::WasACustomer
+            else
+                organization.relation = MoveToGo::Relation::BeenInTouch
+            end
+
+            coworker = rootmodel.find_coworker_by_integration_id row['owner']
+            organization.responsible_coworker = coworker
+            tags = row['tags'].split(",")
+            tags.each do |tag|
+                organization.set_tag(tag)
+            end
+
+            rootmodel.add_organization(organization)
+        end
+    end
+
+    # persons
+    # depends on organizations
+    if defined?(PERSON_FILE) && !PERSON_FILE.nil? && !PERSON_FILE.empty?
+        process_rows(PERSON_FILE, source_encoding) do |row|
+            # adds it self to the employer
+            next if row["is_organisation"] == "true"
+            person = converter.to_person(row, rootmodel)
+
+            person.integration_id = row['id']
+
+            person.first_name = row['first_name']
+            person.last_name = row['last_name']
+
+            person.direct_phone_number = MoveToGo::PhoneHelper.parse_numbers(row['phone'])
+            person.mobile_phone_number = MoveToGo::PhoneHelper.parse_numbers(row['mobile'])
+            person.email = row['email']
+
+            organization = rootmodel.find_organization {|org|
+                org.name == row["organisation_name"]
+            }
+            if not organization.nil?
+                organization.add_employee(person)
+            else
+                puts "No organization for person '#{person.first_name} #{person.last_name}, #{person.integration_id}' could be found. Person will not be imported!"
+                ignored_persons += 1
+            end
+        end
+    end
+
+    # leads
+    if defined?(LEADS_FILE) && !LEADS_FILE.nil? && !LEADS_FILE.empty?
+        process_rows(LEADS_FILE, source_encoding) do |row|
+            organization = converter.to_organization_from_lead(row, rootmodel)
+
+            organization.integration_id = "l#{row['id']}"
+            organization.name = row['company_name']
+            organization.relation = MoveToGo::Relation::WorkingOnIt
+
+            organization.central_phone_number = MoveToGo::PhoneHelper.parse_numbers(row['phone']) if not row['phone'].nil?
+
+            organization.with_visit_address do |address|
+                address.street = row['street']
+                address.city = row['city']
+            end
+
+            coworker = rootmodel.find_coworker_by_integration_id row['owner']
+            organization.responsible_coworker = coworker
+
+            if not row['tags'].nil?
+                tags = row['tags'].split(",")
+                tags.each do |tag|
+                    organization.set_tag(tag)
+                end
+            end
+
+            person = MoveToGo::Person.new
+
+            person.integration_id = "p#{row['id']}"
+            person.first_name = row['first_name']
+            person.last_name = row['last_name']
+            person.direct_phone_number = MoveToGo::PhoneHelper.parse_numbers(row['phone']) if not row['phone'].nil?
+            person.mobile_phone_number = MoveToGo::PhoneHelper.parse_numbers(row['mobile']) if not row['mobile'].nil?
+            person.email = row['email']
+
+            organization.add_employee(person)
+
+            if row['description']
+                comment = MoveToGo::Comment.new()
+
+                comment.text = row['description']
+                comment.person = person
+                comment.organization = organization
+                comment.created_by = coworker
+
+                rootmodel.add_comment(comment)
+            end
+            rootmodel.add_organization(organization)
+        end
+    end
+
+    # deals
+    if defined?(DEAL_FILE) && !DEAL_FILE.nil? && !DEAL_FILE.empty?
+        process_rows(DEAL_FILE, source_encoding) do |row|
+            deal = converter.to_deal(row, rootmodel)
+            deal.integration_id = row['id']
+            deal.name = row['name']
+
+            deal.value = row['scope']
+            deal.customer = rootmodel.find_organization_by_integration_id(row['company_id'])
+            deal.customer_contact = rootmodel.find_person_by_integration_id(row['main_contact_id'])
+            deal.responsible_coworker = rootmodel.find_coworker_by_integration_id(row['owner'])
+
+            values = row['tags'].split(",")
+            values.each do |value|
+                deal.set_tag(value)
+            end
+            rootmodel.add_deal(deal)
+        end
+    end
+
+    # historys
+    if defined?(HISTORY_FILE) && !HISTORY_FILE.nil? && !HISTORY_FILE.empty?
+        process_rows(HISTORY_FILE, source_encoding) do |row|
+            history = MoveToGo::Comment.new()
+            history.integration_id = row['id']
+            history.text = row['content']
+            history.created_by = rootmodel.find_coworker_by_integration_id(row["owner"])
+            notable_id = row['noteable_id']
+            case row["noteable_type"]
+            when "Deal"
+                deal = rootmodel.find_deal_by_integration_id(notable_id)
+                history.deal = deal
+            when "Lead"
+                history.person = rootmodel.find_person_by_integration_id("p#{notable_id}")
+                history.organization = rootmodel.find_organization_by_integration_id("l#{notable_id}")
+            when "Contact"
+                puts "Ignoreing history for unbound person: #{row['owner']}"
+                ignored_histories += 1
+                next
+            else
+                org = rootmodel.find_organization_by_integration_id(notable_id)
+                if org.nil?
+                    person = rootmodel.find_person_by_integration_id(notable_id)
+                    org = person.organization
+                    history.person = person
+                end
+                history.organization = org
+            end
+            rootmodel.add_history(history)
+        end
+    end
+    puts "Ignored #{ignored_persons} persons and #{ignored_histories} histories"
+    return rootmodel
+end

data/sources/base-crm/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gem 'thor'
+gem 'move-to-go'
+gem 'rspec'

data/sources/base-crm/README.md

@@ -0,0 +1,9 @@
+# Base CRM migration
+
+1. Export your Base CRM data with the built in export in Base CRM
+2. Put the exported data into the `data` folder
+3. Coworkers has to be entered manually into the coworkers file. A template file is provided
+4. All mappings are done in `runner.rb` but special unique things can be configured in `converter.rb`
+
+Note: In Base CRM you can have contacts persons without a corresponding organization.
+This is not allowed in LIME Go and these persons and notes just linked to them will be ignored.