move-to-go 5.0.11 → 5.4.1

data/sources/lime-easy/.move-to-go/runner.rb

@@ -4,15 +4,16 @@ require 'move-to-go'
 require 'progress'
 require_relative("../converter")
 
-EXPORT_FOLDER = 'export'
 COWORKER_FILE = "#{EXPORT_FOLDER}/User.txt"
 ORGANIZATION_FILE = "#{EXPORT_FOLDER}/Company.txt"
 ORGANIZATION_HISTORY_FILE = "#{EXPORT_FOLDER}/Company-History.txt"
+ORGANIZATION_TODO_FILE = "#{EXPORT_FOLDER}/Company-To do.txt"
 ORGANIZATION_DOCUMENT_FILE = "#{EXPORT_FOLDER}/Company-Document.txt"
 PERSON_FILE = "#{EXPORT_FOLDER}/Company-Person.txt"
 INCLUDE_FILE = "#{EXPORT_FOLDER}/Project-Included.txt"
 DEAL_FILE = "#{EXPORT_FOLDER}/Project.txt"
 DEAL_HISTORY_FILE = "#{EXPORT_FOLDER}/Project-History.txt"
+DEAL_TODO_FILE = "#{EXPORT_FOLDER}/Project-To do.txt"
 PROJECT_DOCUMENT_FILE = "#{EXPORT_FOLDER}/Project-Document.txt"
 
 def convert_source
@@ -35,9 +36,12 @@ def convert_source
     # coworkers
     # start with these since they are referenced
     # from everywhere....
-    
-    process_rows(" - Reading Coworkers '#{COWORKER_FILE}'", COWORKER_FILE) do |row|
-        rootmodel.add_coworker(to_coworker(row))
+    if(File.exists?(COWORKER_FILE))
+        process_rows(" - Reading Coworkers '#{COWORKER_FILE}'", COWORKER_FILE) do |row|
+            rootmodel.add_coworker(to_coworker(row))
+        end
+    else
+        puts "WARNING: can't find coworker file '#{COWORKER_FILE}'"
     end
 
     # organizations
@@ -48,49 +52,100 @@ def convert_source
         converter.organization_hook(row, organization, rootmodel) if defined? converter.organization_hook
     end
 
+    # Person - Consent connection
+    # Reads the file and creats a hash
+    # that connect persons to consents
+    
+    if(defined?(PERSON_CONSENT_FILE) && File.exists?(PERSON_CONSENT_FILE))
+        if (defined?(VALID_EMAIL_CONSENTS) && VALID_EMAIL_CONSENTS.size > 0)
+            consent = Hash.new
+            process_rows(" - Reading Person Consents '#{PERSON_CONSENT_FILE}'", PERSON_CONSENT_FILE) do |row|
+                consent[row['idPerson']] = VALID_EMAIL_CONSENTS.include? row['String']
+            end
+        else
+            puts "WARNING: Person consent file exists but VALID_EMAIL_CONSENTS is not set."
+        end
+    end
+
     # persons
     # depends on organizations
     process_rows(" - Reading Persons '#{PERSON_FILE}'", PERSON_FILE) do |row|
         # init method also adds the person to the employer
-        person = init_person(row, rootmodel)
+        person = init_person(row, rootmodel, consent)
         converter.to_person(person, row)
     end
 
     # organization histories
-    process_rows(" - Reading Organization History '#{ORGANIZATION_HISTORY_FILE}'", ORGANIZATION_HISTORY_FILE) do |row|
-        # adds itself if applicable
-        rootmodel.add_history(to_organization_history(converter, row, rootmodel))
+    if(File.exists?(ORGANIZATION_HISTORY_FILE))
+        process_rows(" - Reading Organization History '#{ORGANIZATION_HISTORY_FILE}'", ORGANIZATION_HISTORY_FILE) do |row|
+            # adds itself if applicable
+            rootmodel.add_history(to_organization_history(converter, row, rootmodel))
+        end
+    else
+        puts "WARNING: can't find organization history file '#{ORGANIZATION_HISTORY_FILE}'"
+    end
+
+    # organization todos
+    if(File.exists?(ORGANIZATION_TODO_FILE))
+        process_rows(" - Reading Organization Todos '#{ORGANIZATION_TODO_FILE}'", ORGANIZATION_TODO_FILE) do |row|
+            # adds itself if applicable
+            rootmodel.add_todo(to_organization_todo(converter, row, rootmodel))
+        end
+    else
+        puts "WARNING: can't find organization history file '#{ORGANIZATION_TODO_FILE}'"
     end
 
     # Organization - Deal connection
     # Reads the includes.txt and creats a hash
-    # that connect organizations to deals 
+    # that connect organizations to deals
     process_rows(" - Reading Organization Deals '#{INCLUDE_FILE}'", INCLUDE_FILE) do |row|
         includes[row['idProject']] = row['idCompany']
     end
 
     # deals
     # deals can reference coworkers (responsible), organizations
-    # and persons (contact) 
+    # and persons (contact)
     process_rows(" - Reading Deals '#{DEAL_FILE}'", DEAL_FILE) do |row|
         deal = init_deal(row, rootmodel, includes)
         rootmodel.add_deal(converter.to_deal(deal, row))
     end
 
     # deal histories
-    process_rows(" - Reading Deal Histories '#{DEAL_HISTORY_FILE}'", DEAL_HISTORY_FILE) do |row|
-        # adds itself if applicable
-        rootmodel.add_history(to_deal_history(converter, row, rootmodel))
+    if(File.exists?(DEAL_HISTORY_FILE))
+        process_rows(" - Reading Deal Histories '#{DEAL_HISTORY_FILE}'", DEAL_HISTORY_FILE) do |row|
+            # adds itself if applicable
+            rootmodel.add_history(to_deal_history(converter, row, rootmodel))
+        end
+    else
+        puts "WARNING: can't find deal history file '#{DEAL_HISTORY_FILE}'"
+    end
+
+    # deal todos
+    if(File.exists?(DEAL_TODO_FILE))
+        process_rows(" - Reading Deal Todos '#{DEAL_TODO_FILE}'", DEAL_TODO_FILE) do |row|
+            # adds itself if applicable
+            rootmodel.add_todo(to_deal_todo(converter, row, rootmodel))
+        end
+    else
+        puts "WARNING: can't find deal history file '#{DEAL_TODO_FILE}'"
     end
 
     # documents
     if defined?(IMPORT_DOCUMENTS) && !IMPORT_DOCUMENTS.nil? && IMPORT_DOCUMENTS
-        process_rows(" - Reading Organization Documents", ORGANIZATION_DOCUMENT_FILE) do |row|
-            rootmodel.add_file(to_organization_document(row, rootmodel))
+        if(File.exists?(ORGANIZATION_DOCUMENT_FILE))
+            process_rows(" - Reading Organization Documents", ORGANIZATION_DOCUMENT_FILE) do |row|
+                rootmodel.add_file(to_organization_document(row, rootmodel))
+            end
+        else
+            puts "WARNING: can't find company documents file '#{ORGANIZATION_DOCUMENT_FILE}'"
         end
 
-        process_rows(" - Reading Project Documents", PROJECT_DOCUMENT_FILE) do |row|
-            rootmodel.add_file(to_deal_document(row, rootmodel))
+        if(File.exists?(PROJECT_DOCUMENT_FILE))
+            process_rows(" - Reading Project Documents", PROJECT_DOCUMENT_FILE) do |row|
+                rootmodel.add_file(to_deal_document(row, rootmodel))
+            end
+        else
+            puts "WARNING: can't find project documents file '#{PROJECT_DOCUMENT_FILE}'"
         end
     end
 
@@ -99,7 +154,7 @@ end
 
 def to_coworker(row)
     coworker = MoveToGo::Coworker.new
-    
+
     # integration_id is typically the userId in Easy
     # Must be set to be able to import the same file more
     # than once without creating duplicates
@@ -129,7 +184,7 @@ def init_organization(row, rootmodel)
     return organization
 end
 
-def init_person(row, rootmodel)
+def init_person(row, rootmodel, consent)
     person = MoveToGo::Person.new
 
     # Easy standard fields created in configure method Easy
@@ -140,7 +195,9 @@ def init_person(row, rootmodel)
     person.integration_id = row['idPerson']
     person.first_name = row['First name']
     person.last_name = row['Last name']
-
+    if (!consent.nil?)
+        person.has_mail_consent = !!consent[row['idPerson']]
+    end
     # set employer connection
     employer = rootmodel.find_organization_by_integration_id(row['idCompany'])
     if employer
@@ -162,7 +219,7 @@ def to_organization_history(converter, row, rootmodel)
         history.created_by = coworker
         history.person = organization.find_employee_by_integration_id(row['idPerson'])
         history.date = row['Date']
-        
+
         if converter.respond_to?(:get_history_classification_for_activity_on_company)
             # we will get an InvalidHistoryClassificationError if we are
             # setting and invalid classification. So no need to verify
@@ -173,7 +230,7 @@ def to_organization_history(converter, row, rootmodel)
             if classification.nil?
                 classification = MoveToGo::HistoryClassification::Comment
             end
-            
+
             history.classification = classification
 
             history.text = row['History']
@@ -188,6 +245,35 @@ def to_organization_history(converter, row, rootmodel)
     return nil
 end
 
+# Turns a row from the Easy exported Company-To do.txt file into
+# a move-to-go model that is used to generate xml.
+def to_organization_todo(converter, row, rootmodel)
+    organization = rootmodel.find_organization_by_integration_id(row['idCompany'])
+    coworker = rootmodel.find_coworker_by_integration_id(row['idUser'])
+
+    if organization && coworker
+        todo = MoveToGo::Todo.new()
+        todo.organization = organization
+        todo.created_by = coworker
+        todo.assigned_coworker = coworker
+        todo.person = organization.find_employee_by_integration_id(row['idPerson'])
+        if row['Start time'] != ''
+            todo.date_start = "#{row['Start date']} #{row['Start time']}"
+            todo.date_start_has_time = true
+        else
+            todo.date_start = row['Start date'] != '' ? row['Start date'] : Date.today.to_s
+            todo.date_start_has_time = false
+        end
+
+        todo.date_checked = DateTime.now if row['Done'] == "1"
+        todo.text = row['Description']
+
+        return todo.text.empty? ? nil : todo
+    end
+
+    return nil
+end
+
 def to_organization_document(row, rootmodel)
     file = MoveToGo::File.new()
 
@@ -284,14 +370,14 @@ def to_deal_history(converter, row, rootmodel)
             if classification.nil?
                 classification = MoveToGo::HistoryClassification::Comment
             end
-            
+
             history.classification = classification
             history.text = row['RawHistory'].to_s.sub("#{row['Category']}:", "")
         else
             history.classification = MoveToGo::HistoryClassification::Comment
             history.text = row['RawHistory']
         end
-        
+
 
         return history.text.empty? ? nil : history
     end
@@ -299,6 +385,35 @@ def to_deal_history(converter, row, rootmodel)
     return nil
 end
 
+# Turns a row from the Easy exported Project-To do.txt file into
+# a move-to-go model that is used to generate xml.
+def to_deal_todo(converter, row, rootmodel)
+    deal = rootmodel.find_deal_by_integration_id(row['idProject'])
+    coworker = rootmodel.find_coworker_by_integration_id(row['idUser'])
+
+    if deal && coworker
+        todo = MoveToGo::Todo.new()
+        todo.deal = deal
+        todo.organization = deal.customer
+        todo.created_by = coworker
+        todo.assigned_coworker = coworker
+        todo.person = todo.organization.find_employee_by_integration_id(row['idPerson'])
+        if row['Start time'] != ''
+            todo.date_start = "#{row['Start date']} #{row['Start time']}"
+            todo.date_start_has_time = true
+        else
+            todo.date_start = row['Start date'] != '' ? row['Start date'] : Date.today.to_s
+            todo.date_start_has_time = false
+        end
+
+        todo.date_checked = DateTime.now if row['Done'] == "1"
+        todo.text = row['Description']
+
+        return todo.text.empty? ? nil : todo
+    end
+
+    return nil
+end
 
 def validate_constants()
     if !defined?(ORGANIZATION_RESPONSIBLE_FIELD)
@@ -321,6 +436,13 @@ def validate_constants()
         Otherwise you should define 'IMPORT_DOCUMENTS' in converter.rb
         with the value 'true'."
     end
+
+    if !defined?(VALID_EMAIL_CONSENTS) || VALID_EMAIL_CONSENTS.empty?
+        puts "WARNING: You havce not defined any valid email consents.
+        No person will now have the 'Email consent given' set.
+        To set the valid email consents, define 'VALID_EMAIL_CONSENTS' with
+        the strings from Company-Person-Consent.txt that are valid for email."
+    end
 end
 
 
@@ -336,13 +458,8 @@ def process_rows(description, file_name)
 end
 
 def make_sure_database_has_been_exported()
-    return File.exists?(COWORKER_FILE) &&
-        File.exists?(ORGANIZATION_FILE) &&
-        File.exists?(ORGANIZATION_HISTORY_FILE) &&
-        File.exists?(ORGANIZATION_DOCUMENT_FILE) &&
+    return File.exists?(ORGANIZATION_FILE) &&
         File.exists?(PERSON_FILE) &&
-        File.exists?(INCLUDE_FILE) &&
-        File.exists?(DEAL_FILE) &&
-        File.exists?(DEAL_HISTORY_FILE) &&
-        File.exists?(PROJECT_DOCUMENT_FILE)
+#        File.exists?(INCLUDE_FILE) &&
+        File.exists?(DEAL_FILE)
 end

data/sources/lime-easy/converter.rb

@@ -39,6 +39,22 @@ require 'move-to-go'
 ## Constants
 # Edit these constants to fit your needs
 
+# The export folder, it's probably called 'Export' if you haven't changed it.
+EXPORT_FOLDER = 'Export'
+
+# This file referes to the consent set super field in Lime Easy
+# where the customer have their email consents.
+PERSON_CONSENT_FILE = "#{EXPORT_FOLDER}/Company-Person-Samtycken.txt"
+
+# Valid Consents strings for setting E-mail consent.
+# Which of the set alternatives should be converted to
+# E-mail consent in Lime Go. Just name them here, and
+# move-to-go will fetch them from the file above.
+
+# VALID_EMAIL_CONSENTS = ['Ok för nyhetsbrev', 'Ok för produktnyheter']
+VALID_EMAIL_CONSENTS = ['Nyhetsbrev']
+
+
 # determines if documents should be imported.
 # IMPORT_DOCUMENTS = true
 
@@ -305,7 +321,7 @@ class Converter
         # return the note will get the default classification 'Comment'
 
         # case activity
-        # when 'SalesCall' 
+        # when 'SalesCall'
         #   classification = MoveToGo::HistoryClassification::SalesCall
         # when 'Customer Visit'
         # classification = MoveToGo::HistoryClassification::ClientVisit
@@ -314,7 +330,7 @@ class Converter
         # else
         #     classification = MoveToGo::HistoryClassification::Comment
         # end
-        
+
         # return classification
     end
 
@@ -326,20 +342,20 @@ class Converter
         # in LIME Go. The return value must be a value from the
         # MoveToGo::HistoryClassification enum. If no classification is
         # return the history will get the default classification 'Comment'
-        
+
         # case activity
-        # when 'Installation' 
+        # when 'Installation'
         #   classification = MoveToGo::HistoryClassification::ClientVisit
         # when 'No answer'
         #   classification = MoveToGo::HistoryClassification::TriedToReach
         # else
         #     classification = MoveToGo::HistoryClassification::Comment
         # end
-        
+
         # return classification
     end
 
-    
+
 
     # HOOKS
     #
@@ -355,7 +371,7 @@ class Converter
     #        rootmodel.add_comment(comment)
     #    end
     #end
-    
+
 
 end
 

data/spec/file_spec.rb

@@ -27,6 +27,19 @@ describe "File" do
         file.validate.should eq ""
     end
 
+    it "is valid when it has name, path, created_by, deal, person and organization" do
+        # given
+        file.name = "Offert"
+        file.path = "spec/sample_data/offert.docx"
+        file.created_by = MoveToGo::CoworkerReference.new( { :integration_id => "123" } )
+        file.deal = MoveToGo::DealReference.new( { :integration_id => "456" } )
+        file.person = MoveToGo::PersonReference.new( { :integration_id => "456" } )
+        file.organization = MoveToGo::OrganizationReference.new( { :integration_id => "456" } )
+
+        # when, then
+        file.validate.should eq ""
+    end
+
     it "is valid when it has name, invalid path, created_by and deal but ignores the path" do
         # given
         file.name = "Offert"
@@ -138,6 +151,20 @@ describe "File" do
         file.instance_variable_get(:@deal_reference).is_a?(MoveToGo::DealReference).should eq true
     end
 
+    it "will set person ref when person is assigned" do
+        # given
+        person = MoveToGo::Person.new({:integration_id => "123" })
+        person.first_name = "The"
+        person.last_name = "Limer"
+
+        # when
+        file.person = person
+
+        # then
+        file.person.is_a?(MoveToGo::Person).should eq true
+        file.instance_variable_get(:@person_reference).is_a?(MoveToGo::PersonReference).should eq true
+    end
+
     it "will set coworker ref when coworker is assinged" do
         # given
         coworker = MoveToGo::Coworker.new({:integration_id => "123" })

data/spec/helpers/xsd_validate_spec.rb

@@ -3,25 +3,30 @@ require 'move-to-go'
 require 'nokogiri'
 describe MoveToGo::SerializeHelper do
     describe "Validate according to xsd" do
-        let(:validate_result) {
+        let(:rootmodel) do
             rootmodel = MoveToGo::RootModel.new
             rootmodel.settings.with_organization do |s|
                 s.set_custom_field({:integration_id => "2", :title => "cf title"})
                 s.set_custom_field({:integration_id => "3", :title => "cf title2"})
             end
-            coworker = MoveToGo::Coworker.new({
-                                                  :integration_id => "123",
-                                                  :first_name => "Kalle",
-                                                  :last_name => "Anka",
-                                                  :email => "kalle.anka@vonanka.com"
-                                              })
-            rootmodel.add_coworker(coworker)
+            rootmodel
+        end
+
+        let(:coworker) do
+            MoveToGo::Coworker.new({
+                :integration_id => "123",
+                :first_name => "Kalle",
+                :last_name => "Anka",
+                :email => "kalle.anka@vonanka.com"
+            })
+        end
+ 
+        let(:organization) do
             organization = MoveToGo::Organization.new
             organization.name = "Ankeborgs bibliotek"
             organization.with_source do |source|
                 source.par_se('122345')
             end
-            #organization.source_ref = {:name => 'Go',:id => "PASE122345"}
             organization.set_tag("tag:bibliotek")
             organization.set_tag("tag:Bj\u{00F6}rk")
             organization.set_custom_value("2", "cf value")
@@ -33,25 +38,90 @@ describe MoveToGo::SerializeHelper do
             organization.with_visit_address do |addr|
                 addr.city = "Gaaseborg"
             end
-            coworker = MoveToGo::Coworker.new({:integration_id => "1", :first_name => "Vincent", :last_name => "Vega"})
-            organization.responsible_coworker = coworker
+            organization
+        end
 
+        let(:employee) do
             emp = MoveToGo::Person.new
-            emp.integration_id = "1"
+            emp.integration_id = "12345"
             emp.first_name = "Kalle"
             emp.last_name = "Anka"
             emp.direct_phone_number = '234234234'
             emp.currently_employed = true
+            emp
+        end
+
+        let(:deal) do
+            deal = MoveToGo::Deal.new
+            deal.integration_id = "42"
+            deal.name = "foo"
+            deal.offer_date = "2012-12-12T00:00:00"
+            deal.order_date = "2012-12-01T00:00:00"
+            deal.value = "0"
+            deal.probability = "20"
+            deal
+        end
+
+        let(:link) do
+            link = MoveToGo::Link.new
+            link.integration_id = "12"
+            link.url = "https://go.lime-go.com"
+            link
+        end
+
+        let(:file) do
+            file = MoveToGo::File.new
+            file.integration_id = "12"
+            file.name = "smallfile.txt"
+            file
+        end
+
+        it "Should not contain validation errors" do
+            rootmodel.add_coworker(coworker)
+            organization.responsible_coworker = MoveToGo::Coworker.new({:integration_id => "1", :first_name => "Vincent", :last_name => "Vega"})
+            organization.add_employee employee
             rootmodel.add_organization organization
+
+            doc = Nokogiri::XML(MoveToGo::SerializeHelper::serialize(rootmodel, -1))
+
             xsd_file = File.join(File.dirname(__FILE__), '..', 'sample_data', 'schema0.xsd')
+            xsd = Nokogiri::XML::Schema(File.read(xsd_file))            
+            expect(xsd.validate(doc)).to eq([])
+        end
+
+        it "Documents can have many references" do
+            rootmodel.add_coworker(coworker)
+            organization.add_employee employee
+            rootmodel.add_organization organization
+            deal.customer = organization
+            rootmodel.add_deal deal
+            
+            link.deal = deal
+            link.organization = organization
+            link.person = employee
+            rootmodel.add_link link
+
+            file.deal = deal
+            file.organization = organization
+            file.person = employee
+            rootmodel.add_file file
 
-            xsd = Nokogiri::XML::Schema(File.read(xsd_file))
             doc = Nokogiri::XML(MoveToGo::SerializeHelper::serialize(rootmodel, -1))
-            xsd.validate(doc)
-        }
+            xsd_file = File.join(File.dirname(__FILE__), '..', 'sample_data', 'schema0.xsd')
+            xsd = Nokogiri::XML::Schema(File.read(xsd_file))            
+            expect(xsd.validate(doc)).to eq([])
+        end
 
-        it "Should not contain validation errors" do
-            expect(validate_result).to eq([])
+        it "valudate deals" do
+            rootmodel.add_coworker(coworker)
+            rootmodel.add_organization organization
+            deal.customer = organization
+            rootmodel.add_deal deal
+
+            doc = Nokogiri::XML(MoveToGo::SerializeHelper::serialize(rootmodel, -1))
+            xsd_file = File.join(File.dirname(__FILE__), '..', 'sample_data', 'schema0.xsd')
+            xsd = Nokogiri::XML::Schema(File.read(xsd_file))            
+            expect(xsd.validate(doc)).to eq([])
         end
     end
 end