move-to-go 5.0.0

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

@@ -0,0 +1,404 @@
+
+require 'zip'
+
+require 'move-to-go'
+require_relative("../converter")
+
+# EXPORT_FOLDER and other constants should be defined ../converter.rb
+
+USER_FILE = "User.csv"
+ORGANIZATION_ACCOUNT_FILE = "Account.csv"
+ORGANIZATION_LEAD_FILE = "Lead.csv"
+PERSON_FILE = "Contact.csv"
+DEAL_FILE = "Opportunity.csv"
+NOTE_FILE = "Note.csv"
+
+def process_rows(filename)
+    if !File.exists?(filename)
+        puts "Error: Cant find the file '#{filename}'."
+        raise
+    end
+
+    f = File.open(filename, 'r')
+    data = f.read.encode("UTF-8", "ISO-8859-1")
+    rows = MoveToGo::CsvHelper::text_to_hashes(data, ',')
+    rows.each do |row|
+        yield row
+    end
+    f.close
+end
+
+def get_salesforce_export_zipfile()
+    if defined?(EXPORT_FOLDER)
+        if EXPORT_FOLDER.nil? || EXPORT_FOLDER.empty?
+            puts "EXPORT_FOLDER is empty, using 'export' as default."
+            export_folder = File.expand_path("export", Dir.pwd)
+        else
+            export_folder = File.expand_path(EXPORT_FOLDER, Dir.pwd)
+        end
+    else
+        puts "EXPORT_FOLDER is not defined, using 'export' as default."
+        export_folder = File.expand_path("export", Dir.pwd)
+    end
+
+    puts "Searching '#{export_folder}' for Salesforce export zip file..."
+
+    if defined?(EXPORT_FILE)
+        if EXPORT_FILE.nil? || EXPORT_FILE.empty?
+            export_zip_files = Dir.glob(File.join(export_folder, "*.zip"))
+        else
+            export_zip_files = Dir.glob(File.join(export_folder, EXPORT_FILE))
+        end
+    else
+        export_zip_files = Dir.glob(File.join(export_folder, "*.zip"))
+    end
+
+    if export_zip_files.length == 0
+        puts "No zip file found, please copy your Salesforce export zipfile to '#{export_folder}'."
+        return nil
+    elsif export_zip_files.length > 1
+        puts "More than one zip file found in '#{export_folder}', either remove all but one or set the EXPORT_FILE in converter.rb"
+        return nil
+    elsif export_zip_files.length == 1
+        puts "Found zipfile to import from. Using: '#{export_zip_files[0]}'."
+        return export_zip_files[0]
+    end
+end
+
+def to_coworker(row)
+    coworker = nil
+    
+    if row['IsActive'] == '1' && row['UserType'] == 'Standard'
+        coworker = MoveToGo::Coworker.new
+
+        coworker.email = row['Email']
+        coworker.integration_id = row['Id']
+        coworker.first_name = row['FirstName']
+        coworker.last_name = row['LastName']
+        coworker.direct_phone_number = row['Phone']
+        coworker.mobile_phone_number = row['MobilePhone']
+    end
+    
+    return coworker
+end
+
+def account_to_organization(row, rootmodel)
+    if row['IsDeleted'] != '0'
+        return nil
+    end
+
+    organization = MoveToGo::Organization.new
+
+    organization.relation = MoveToGo::Relation::IsACustomer
+    organization.integration_id = row['Id']
+    organization.name = row['Name']
+    organization.set_tag(row['Type'])
+
+    organization.central_phone_number = row['Phone']
+    organization.web_site = row['Website']
+    
+    organization.with_postal_address do |address|
+        address.street = row['BillingStreet']
+        address.zip_code = row['BillingPostalCode']
+        address.city = row['BillingCity']
+        address.country_code = get_country_code(row['BillingCountry'])
+    end
+
+    organization.with_visit_address do |address|
+        address.street = row['ShippingStreet']
+        address.zip_code = row['ShippingPostalCode']
+        address.city = row['ShippingCity']
+        address.country_code = get_country_code(row['ShippingCountry'])
+    end
+
+    organization.set_tag row['Industry']
+    
+    organization.responsible_coworker =
+        rootmodel.find_coworker_by_integration_id(row['OwnerId'])
+   
+    converter.organization_hook(row, organization, rootmodel) if defined? converter.organization_hook
+
+    return organization
+end
+
+def lead_to_organization(row, rootmodel, converter)
+    if row['IsDeleted'] != '0'
+        return nil
+    end
+
+    if row['IsConverted'] == '1'
+        return nil
+    end
+
+    organization = MoveToGo::Organization.new
+
+    if converter.respond_to?(:get_relation_for_lead)
+        relation = converter.get_relation_for_lead        
+        
+        if !relation.nil?
+            organization.relation = relation
+        else
+            organization.relation = MoveToGo::Relation::WorkingOnIt
+        end
+    end
+
+    use_default_lead_tag = true
+    if converter.respond_to?(:get_tags_for_lead)
+        tags = converter.get_tags_for_lead(row['Status'])
+        
+        if !tags.nil?
+            if tags.is_a?(String)
+                organization.set_tag tags
+                use_default_lead_tag = false
+            elsif tags.is_a?(Array)
+                tags.each do |tag|
+                    organization.set_tag tag
+                end
+                use_default_lead_tag = false
+            end
+        end
+    end
+    if use_default_lead_tag == true
+        organization.set_tag 'lead'
+        organization.set_tag row['Status']        
+    end
+    
+    organization.responsible_coworker =
+        rootmodel.find_coworker_by_integration_id(row['OwnerId'])
+    
+    organization.name = row['Company']
+    organization.with_postal_address do |address|
+        address.street = row['Street']
+        address.zip_code = row['PostalCode']
+        address.city = row['City']
+        address.country_code = get_country_code(row['Country'])
+    end
+    organization.web_site = row['WebSite']
+
+    organization.set_tag row['Industry']
+
+    person = MoveToGo::Person.new
+    organization.add_employee(person)
+    person.first_name = row['FirstName']
+    person.last_name = row['LastName']
+    person.position = row['Title']
+    person.direct_phone_number = row['Phone']
+    person.mobile_phone_number = row['MobilePhone']
+    person.email = row['Email']
+
+    return organization
+end
+
+def get_country_code(country)
+    country_code = ''
+
+    case country.downcase
+    when 'sverige'
+        country_code = 'se'
+    when 'sweden'
+        country_code = 'se'
+    when 'norge'
+        country_code = 'no'
+    when 'norway'
+        country_code = 'no'
+    when 'danmark'
+        country_code = 'dk'
+    when 'denmark'
+        country_code = 'dk'
+    end
+    
+    return country_code
+end
+
+def add_person_to_organization(row, rootmodel)
+    if row['IsDeleted'] != '0'
+        return
+    end
+
+    org = rootmodel.find_organization_by_integration_id(row['AccountId'])
+    if !org.nil?
+        person = MoveToGo::Person.new
+        org.add_employee(person)
+        
+        person.integration_id = row['Id']
+        person.first_name = row['FirstName']
+        person.last_name = row['LastName']
+        
+        person.direct_phone_number = row['Phone']
+        person.fax_phone_number = row['Fax']
+        person.mobile_phone_number = row['MobilePhone']
+        person.home_phone_number = row['HomePhone']
+        person.position = row['Title']
+        person.email = row['Email']
+    end
+end
+
+def to_deal(row, rootmodel, converter)
+    if row['IsDeleted'] != '0'
+        return nil
+    end
+
+    deal = MoveToGo::Deal.new
+
+    deal.integration_id = row['Id']
+    deal.customer = rootmodel.find_organization_by_integration_id(row['AccountId'])
+    deal.responsible_coworker = rootmodel.find_coworker_by_integration_id(row['OwnerId'])
+    deal.customer_contact =
+        rootmodel.find_person_by_integration_id(row['PrimaryPartnerAccountId'])
+    deal.name = row['Name']
+    deal.description = row['Description']
+    deal.value = row['Amount']
+    deal.probability = row['Probability']
+
+    deal.set_tag row['Type']
+
+    if converter.respond_to?(:get_deal_status_from_salesforce_stage)
+        status = converter.get_deal_status_from_salesforce_stage(row['StageName'])
+
+        if !status.nil?
+            deal.status = status
+        else
+            deal.status = row['StageName']
+        end
+    else
+        deal.status = row['StageName']
+    end
+    
+    return deal
+end
+
+def to_history(row, rootmodel)
+    if row['IsDeleted'] != '0'
+        return nil
+    end
+
+    history = MoveToGo::History.new
+
+    history.integration_id = row['Id']
+    history.text = row['Title'] + ' ' + row['Body']
+    
+    history.date = row['CreatedDate']
+
+    history.created_by = rootmodel.find_coworker_by_integration_id(row['CreatedById'])
+    history.organization = rootmodel.find_organization_by_integration_id(row['AccountId'])
+
+    # TODO: we should probably set the classification in the same was
+    # a a deal's status is set.
+    
+    return history
+end
+
+def add_opportunity_stages_as_deal_status_to_model(rootmodel)
+    puts "Trying to create deal statuses..."
+
+    default_status = ''
+    statuses = []
+    process_rows(DEAL_FILE) do |row|
+        status = {
+            :label => row['StageName'],
+            :integration_id => row['StageName'],
+            :sort_order => row['StageSortOrder']
+        }
+        
+        if row['IsClosed'] == '1'
+            if row['IsWon'] == '1'
+                status[:assessment] = MoveToGo::DealState::PositiveEndState
+            else
+                status[:assessment] = MoveToGo::DealState::NegativeEndState
+            end
+        end
+
+        if !statuses.any? {|s| s[:label] == status[:label]}
+            statuses.push status
+            
+            if row['StageSortOrder'] == '1'
+                default_status = status[:label]
+            end                
+        end
+    end
+
+    statuses.sort! { |s1, s2| s1[:sort_order] <=> s2[:sort_order] }
+    rootmodel.settings.with_deal do |deal|
+        statuses.each do |status|
+            deal.add_status({ :label => status[:label],
+                              :integration_id => status[:integration_id],
+                              :assessment => status[:assessment]
+                            })
+        end
+
+        deal.default_status = default_status
+    end
+end
+
+def convert_source
+    puts "Trying to convert Salesforce to LIME Go..."
+
+    converter = Converter.new
+
+    salesforce_export_zipfile = get_salesforce_export_zipfile()
+    
+    if salesforce_export_zipfile.nil? then
+        puts "Could find Salesforce export zip file."
+        raise
+    end
+
+    rootmodel = MoveToGo::RootModel.new
+    if converter.respond_to?(:configure)
+        converter.configure(rootmodel)
+    end    
+    
+    # We know have the Salesforce export zip file in
+    # export_zip_files[0]. We should unzip the file to a temp folder
+    # and return the path.
+    working_folder = Dir.mktmpdir("move-to-go") 
+    puts "upzip '#{salesforce_export_zipfile}' to '#{working_folder.to_s}'..."
+    
+    Dir.chdir(working_folder) do
+        Zip::File.open(salesforce_export_zipfile) do |zip_file|
+            zip_file.each do |entry|
+                if entry.to_s.include?("/") then
+                #                        puts "DIR"
+                else
+                    entry.extract
+                end
+            end
+        end        
+        
+        add_opportunity_stages_as_deal_status_to_model(rootmodel)
+        
+        puts "Trying to import users..."
+        process_rows(USER_FILE) do |row|
+            rootmodel.add_coworker(to_coworker(row))
+        end
+
+        puts "Trying to import organizations..."
+        process_rows(ORGANIZATION_ACCOUNT_FILE) do |row|
+            rootmodel.add_organization(account_to_organization(row, rootmodel))
+        end
+        process_rows(ORGANIZATION_LEAD_FILE) do |row|
+            rootmodel.add_organization(lead_to_organization(row, rootmodel, converter))
+        end
+
+        puts "Trying to import persons..."
+        process_rows(PERSON_FILE) do |row|
+            add_person_to_organization(row, rootmodel)
+        end
+
+        puts "Trying to import deals..."
+        process_rows(DEAL_FILE) do |row|
+            rootmodel.add_deal(to_deal(row, rootmodel, converter))
+        end
+
+        puts "Trying to import history..."
+        process_rows(NOTE_FILE) do |row|
+            rootmodel.add_history(to_history(row, rootmodel))
+        end
+    end
+    
+    puts "Trying to remove '#{working_folder}'."
+    FileUtils.rm_rf(working_folder)
+    
+    return rootmodel
+                               
+end
+

data/sources/salesforce/Gemfile

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

data/sources/salesforce/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    global_phone (1.0.1)
+    move-to-go (3.0.18)
+      bundler
+      global_phone
+      iso_country_codes
+      nokogiri
+      roo
+      sixarm_ruby_email_address_validation
+      thor
+    iso_country_codes (0.6.1)
+    mini_portile (0.6.1)
+    nokogiri (1.6.4.1-x86-mingw32)
+      mini_portile (~> 0.6.0)
+    roo (1.13.2)
+      nokogiri
+      rubyzip
+      spreadsheet (> 0.6.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    ruby-ole (1.2.11.7)
+    rubyzip (1.1.6)
+    sixarm_ruby_email_address_validation (2.0.0)
+    spreadsheet (1.0.0)
+      ruby-ole (>= 1.0)
+    thor (0.19.1)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  move-to-go
+  rspec
+  rubyzip
+  thor

data/sources/salesforce/converter.rb

@@ -0,0 +1,113 @@
+require 'move-to-go'
+
+# This converter will convert a full export from Salesforce to LIME
+# Go. Export data according to
+# https://help.salesforce.com/apex/HTViewHelpDoc?id=admin_exportdata.htm
+
+# You need to customize this script to suit your Salesforce export. 
+
+# You should save the zipfile from Salesforce in the
+# EXPORT_FOLDER. You dont have to unzip the file, just put it in the folder. 
+EXPORT_FOLDER = "export"
+
+# If you put more than one zip in the folder you must name the file
+# you want to import to LIME GO.
+# EXPORT_FILE = ""
+
+# move-to-go will NOT use any unzipped files from the EXPORT_FOLDER. It
+# will instead extract the zipfile to a temporary folder.
+
+
+# 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
+    # Configure your root model, add custom fields and deal statuses.
+    def configure(rootmodel)
+        # add custom field and deal statuses 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.
+
+        # You dont have to add the Stages for Opportunities here since
+        # they are automagically added.
+
+        
+#        rootmodel.settings.with_organization do |organization|
+#            organization.set_custom_field( { :integrationid => 'external_url', :title => 'Link to external system', :type => :Link } )
+#        end
+    end
+
+    def get_deal_status_from_salesforce_stage(salesforce_deal_stage)
+        # When deals are added to LIME Go this method is called for
+        # each deal. The deal's stage from Salesforce is supplied as
+        # an argument and this method should return a status for the
+        # deal in LIME Go. The returned value is probably a label of a
+        # deal status that has been added in the configure(rootmodel)
+        # method. If nil is returned, the default status will be the
+        # same as in Salesforce (ie salesforce_deal_stage)
+
+        # deal_status = nil
+        
+        # case salesforce_deal_stage
+        # when 'Prospecting'
+        #     deal_status = '1. Kvalificering'
+        # when 'Closed Won'
+        #     deal_status = 'Vunnen'
+        # end
+
+        # return deal_status
+    end
+
+    def get_relation_for_lead()
+        # Returns the relation that converted leads should have. By
+        # default leads will get the relation WorkingOnIt.
+        
+        return MoveToGo::Relation::WorkingOnIt
+    end
+
+    def get_tags_for_lead(lead_status)
+        # Returns the tag or tags that converted leads should
+        # have. Return either a string or an array of
+        # strings. lead_status is the status value from Salesforce.
+
+        # If no tag is returned, the default is 'lead' and the status. 
+
+        # if lead_status == 'Qualified'
+        #     return ['lead', 'qualified']
+        # else
+        #     return 'lead'
+        # end
+        
+        # return nil
+    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/salesforce/export/readme.txt

@@ -0,0 +1,3 @@
+Place the export zip from Salesforce.com here. 
+
+Yay!

data/spec/address_spec.rb

@@ -0,0 +1,49 @@
+require_relative 'spec_helper'
+require 'move-to-go'
+
+describe MoveToGo::Address do
+    describe "Parse line with swedish zip and city into zipcode" do
+        let (:zip_code) {
+            address = MoveToGo::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 = MoveToGo::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 = MoveToGo::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 = MoveToGo::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 'move-to-go'
+
+describe "ClassSettings" do
+    let(:class_settings) {
+        MoveToGo::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
+