move-to-go 5.0.0

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

@@ -0,0 +1,140 @@
+# encoding: UTF-8
+
+require 'move-to-go'
+require 'roo'
+require 'progress'
+require_relative("../converter")
+
+def convert_source
+    puts "Trying to convert Excel source to LIME Go..."
+
+    converter = Converter.new
+
+    # First we read each sheet from the excel file into separate
+    # variables
+
+    if defined?(EXCEL_FILE) && !EXCEL_FILE.empty?()
+        if !::File.exists?(EXCEL_FILE)
+            puts "ERROR: Cant find excel file to import: '#{EXCEL_FILE}'."
+            raise
+        end
+    else
+        puts "ERROR: You must set EXCEL_FILE in converter.rb to point to the excel file that should be imported."
+        raise
+    end
+
+    excel_workbook = MoveToGo::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
+            converter.organization_hook(row, organization, rootmodel) if defined? converter.organization_hook
+        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?(HISTORY_SHEET)
+        if excel_workbook.has_sheet?(HISTORY_SHEET)
+            history_rows = excel_workbook.rows_for_sheet HISTORY_SHEET
+        else
+            puts "WARNING: can't find sheet '#{HISTORY_SHEET}'"
+        end
+    end
+
+    if defined?(FILE_SHEET)
+        if excel_workbook.has_sheet?(FILE_SHEET)
+            file_rows = excel_workbook.rows_for_sheet FILE_SHEET
+        else
+            puts "WARNING: can't find sheet '#{FILE_SHEET}'"
+        end
+    end
+
+    # Then we create a rootmodel that will contain all data that
+    # should be exported to LIME Go.
+    rootmodel = MoveToGo::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, histories)
+    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.with_progress().each do |row|
+            organization = converter.to_organization(row, rootmodel)
+            rootmodel.add_organization(organization)
+        end
+    end
+
+    # Add people and link them to their organizations
+    if defined?(person_rows) && !person_rows.nil?
+        puts "Trying to convert persons..."
+        person_rows.with_progress().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.with_progress().each do |row|
+            rootmodel.add_deal(converter.to_deal(row, rootmodel))
+        end
+    end
+
+    # History must be owned by a coworker and the be added to
+    # organizations and histories and might refernce a person
+    if defined?(history_rows) && !history_rows.nil?
+        puts "Trying to convert histories..."
+        history_rows.with_progress().each do |row|
+            rootmodel.add_history(converter.to_history(row, rootmodel))
+        end
+    end
+
+    if defined?(file_rows) && !file_rows.nil?
+        puts "Trying to convert files..."
+        file_rows.with_progress().each do |row|
+            rootmodel.add_file(converter.to_file(row, rootmodel))
+        end
+    end
+
+    return rootmodel
+end
+

data/sources/excel/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gem 'rspec'
+gem 'roo', '~> 2.0'
+gem 'thor'
+gem 'move-to-go'
+gem 'progress'

data/sources/excel/converter.rb

@@ -0,0 +1,188 @@
+# encoding: UTF-8
+require 'move-to-go'
+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 = "sample-data.xlsx"
+
+COWORKER_SHEET = "Medarbetare"
+ORGANIZATION_SHEET = "Företag"
+PERSON_SHEET = "Kontaktperson"
+DEAL_SHEET = "Affär"
+HISTORY_SHEET = "Anteckningar"
+FILE_SHEET = "Dokument"
+
+# 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:
+# 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)
+        # *** 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( { :integration_id => 'source', :title => 'Källa', :type => :Link } )
+        # end
+
+        # rootmodel.settings.with_person  do |person|
+        #     person.set_custom_field( { :integration_id => 'shoe_size', :title => 'Shoe size', :type => :String} )
+        # end
+
+        # rootmodel.settings.with_deal do |deal|
+        # assessment is default DealState::NoEndState
+        #     deal.add_status( {:label => '1. Kvalificering' })
+        #     deal.add_status( {:label => '2. Deal closed', :assessment => MoveToGo::DealState::PositiveEndState })
+        #     deal.add_status( {:label => '4. Deal lost', :assessment => MoveToGo::DealState::NegativeEndState })
+        # 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 = MoveToGo::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 MoveToGo::EmailHelper.is_valid?(row['Email'])
+            coworker.email = row['Email']
+        end
+
+        return coworker
+    end
+
+    def to_deal(row, rootmodel)
+        deal = MoveToGo::Deal.new()
+
+        # *** TODO:
+        #
+        # Set deal properties from the row.
+
+        return deal
+    end
+
+    def to_organization(row, rootmodel)
+        organization = MoveToGo::Organization.new()
+
+        # 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 MoveToGo::Relation.
+        organization.relation = MoveToGo::Relation::IsACustomer
+
+        # *** TODO:
+        #
+        # Set organization properties from the row.
+
+        organization.name = row['Namn']
+
+        # Set responsible such as
+        # organization.responsible_coworker = rootmodel.find_coworker_by_integration_id(row['Medarbetare'])
+
+        # Custom fields should be set like this.
+        # organization.set_custom_value("source", "internet")
+
+        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['Email'])
+            person.email = row['Email']
+        end
+        person.mobile_phone_number, person.direct_phone_number =
+            MoveToGo::PhoneHelper.parse_numbers(row['Telefon'], [",", "/", "\\"])
+
+        return person
+    end
+
+    def to_history(row, rootmodel)
+        history = MoveToGo::History.new()
+
+        # *** TODO:
+        #
+        # Set history properties from the row.
+
+        history.organization = rootmodel.find_organization_by_integration_id(row['ID'])
+        history.created_by = rootmodel.find_coworker_by_integration_id(row['Skapad av'])
+        history.text = row['Text']
+        history.date = row['Skapad den']
+
+        return history
+    end
+
+    def to_file(row, rootmodel)
+        file = MoveToGo::File.new()
+
+        file.organization = rootmodel.find_organization_by_integration_id(row['Företag'])
+        file.created_by = rootmodel.find_coworker_by_integration_id(row['Skapad Av'])
+        file.name = row['Namn']
+        file.description = row['Kommentar']
+        file.path = row['Path']
+
+        return file
+    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_comment(comment)
+    #    end
+    #end
+
+end

data/sources/excel-basic/.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/excel-basic/.move-to-go/readme.txt

@@ -0,0 +1,3 @@
+The Excel Basic source should be used when we have a customer that has some unstructured data they want to import to LIME Go.
+
+When the ask "do you have an excel tempate we can use?" we should create a project from this source and send them the 'Exempelfil.xslx'. When we get the excelfile back, copy it to the project folder and run 'move-to-go run'.

data/sources/excel-basic/.move-to-go/runner.rb

@@ -0,0 +1,139 @@
+# encoding: UTF-8
+
+require 'move-to-go'
+require 'roo'
+require_relative("../converter")
+
+def convert_source
+    puts "Trying to convert Excel source to LIME Go..."
+
+    converter = Converter.new
+
+    # First we read each sheet from the excel file into separate
+    # variables
+
+    if defined?(EXCEL_FILE) && !EXCEL_FILE.empty?()
+        if !::File.exists?(EXCEL_FILE)
+            puts "ERROR: Cant find excel file to import: '#{EXCEL_FILE}'."
+            raise
+        end
+    else
+        puts "ERROR: You must set EXCEL_FILE in converter.rb to point to the excel file that should be imported."
+        raise
+    end
+
+    excel_workbook = MoveToGo::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
+            converter.organization_hook(row, organization, rootmodel) if defined? converter.organization_hook
+        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?(HISTORY_SHEET)
+        if excel_workbook.has_sheet?(HISTORY_SHEET)
+            history_rows = excel_workbook.rows_for_sheet HISTORY_SHEET
+        else
+            puts "WARNING: can't find sheet '#{HISTORY_SHEET}'"
+        end
+    end
+
+    if defined?(FILE_SHEET)
+        if excel_workbook.has_sheet?(FILE_SHEET)
+            file_rows = excel_workbook.rows_for_sheet FILE_SHEET
+        else
+            puts "WARNING: can't find sheet '#{FILE_SHEET}'"
+        end
+    end
+
+    # Then we create a rootmodel that will contain all data that
+    # should be exported to LIME Go.
+    rootmodel = MoveToGo::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, histories)
+    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|
+            organization = converter.to_organization(row, rootmodel)
+            rootmodel.add_organization(organization)
+        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
+
+    # histories must be owned by a coworker and the be added to
+    # organizations and histories and might refernce a person
+    if defined?(history_rows) && !history_rows.nil?
+        puts "Trying to convert history..."
+        history_rows.each do |row|
+            rootmodel.add_history(converter.to_history(row, rootmodel))
+        end
+    end
+
+    if defined?(file_rows) && !file_rows.nil?
+        puts "Trying to convert files..."
+        file_rows.each do |row|
+            rootmodel.add_file(converter.to_file(row, rootmodel))
+        end
+    end
+
+    return rootmodel
+end
+

data/sources/excel-basic/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'rspec'
+gem 'roo', '~> 2.0'
+gem 'thor'
+gem 'move-to-go'

data/sources/excel-basic/converter.rb

@@ -0,0 +1,175 @@
+# encoding: UTF-8
+require 'move-to-go'
+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 = "Exempelfil.xlsx"
+
+COWORKER_SHEET = "Medarbetare"
+ORGANIZATION_SHEET = "Företag"
+PERSON_SHEET = "Kontaktperson"
+HISTORY_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:
+# move-to-go 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.
+
+        # Organizastion
+        # rootmodel.settings.with_organization do |organization|
+        #     organization.set_custom_field( { :integration_id => 'source', :title => 'Källa', :type => :Link } )
+        # end
+
+        #Person
+        #rootmodel.settings.with_person  do |person|
+            # person.set_custom_field( { :integration_id => 'shoe_size', :title => 'Shoe Size', :type => :String} )
+        #end
+
+        end
+
+    def import_person_to_organization(row, rootmodel)
+        person = to_person(row, rootmodel)
+        organization = rootmodel.find_organization_by_integration_id(row['Kundnummer/FöretagsID'])
+
+        if !organization.nil?
+            organization.add_employee(person)
+        end
+    end
+
+    def to_coworker(row)
+        coworker = MoveToGo::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 MoveToGo::EmailHelper.is_valid?(row['Email'])
+            coworker.email = row['Email']
+        end
+
+        return coworker
+    end
+
+    def to_organization(row, rootmodel)
+        organization = MoveToGo::Organization.new()
+
+        # 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['Kundnummer/FöretagsID']
+
+        # Sets the organization's relation. Relation must be a value
+        # from MoveToGo::Relation.
+        organization.relation = MoveToGo::Relation::IsACustomer
+
+        # *** TODO:
+        #
+        # Set organization properties from the row.
+
+        organization.name = row['Namn']
+        organization.organization_number=row['Organisationsnummer']
+
+        # Postaladdress
+        organization.with_postal_address do |address|
+             address.street = row['Postadress']
+             address.zip_code = row['Postnummer']
+             address.city = row['Postnummer']
+        end
+
+        # Visitingaddress
+        organization.with_visit_address do |addr|
+             addr.street = row['Besöksadress']
+             addr.zip_code = row['Besökspostnummer']
+             addr.city = row['Besöksort']
+        end
+
+        # Set responsible such as
+        # organization.responsible_coworker = rootmodel.find_coworker_by_integration_id(row['Ansvarig saljare'])
+
+        # Set categorytag
+         if row['Företagskategori']
+             category = row['Företagskategori'].split(',')
+             category.each do |categorytag|
+                 organization.set_tag(categorytag.strip)
+             end
+         end
+
+        # Custom fields should be set like this.
+        # organization.set_custom_value("source", "internet")
+
+        ## LIME Go Relation.
+        # let's say that there is a option field in Easy called 'Customer relation'
+        # with the options '1.Customer', '2.Prospect' '3.Partner' and '4.Lost customer'
+
+        if row['Relation'] == 'Kund'
+        # We have made a deal with this organization.
+             organization.relation = MoveToGo::Relation::IsACustomer
+        elsif row['Relation'] == 'Prospekt'
+        # Something is happening with this organization, we might have
+        # booked a meeting with them or created a deal, etc.
+             organization.relation = MoveToGo::Relation::WorkingOnIt
+        elsif row['Relation'] == 'Tidigare kund'
+             organization.relation = MoveToGo::Relation::WasACustomer
+        # We had something going with this organization but we
+        # couldn't close the deal and we don't think they will be a
+        # customer to us in the foreseeable future.
+        #     organization.relation = MoveToGo::Relation::BeenInTouch
+        else
+             organization.relation = MoveToGo::Relation::NoRelation
+        end 
+
+        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['Email'])
+            person.email = row['Email']
+        end
+
+        person.direct_phone_number = row['Telefon']
+        person.mobile_phone_number = row['Mobiltelefon']
+
+        person.position = row['Titel']
+
+        return person
+    end
+
+    def to_history(row, rootmodel)
+        history = MoveToGo::History.new()
+
+        # *** TODO:
+        #
+        # Set history properties from the row.
+
+        history.organization = rootmodel.find_organization_by_integration_id(row['Kundnummer/FöretagsID'])
+        history.created_by = rootmodel.find_coworker_by_integration_id(row['Skapad av medarbetare'])
+        history.text = row['Textanteckningar/Historik']
+        history.date = row['Skapad den']
+
+        return history
+    end
+end