go_import 3.0.17 → 3.0.18

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Nzk0YTFmNGY4MzJkMDA0MTBhZDAyZTlkNzFmMjUxMzM4YmM1ZjAzYQ==
+    Y2U3MjU1NzIwYzUyZDZjODA2ZDg2ZjQ1YmRjNDI2ZTE4ZGMzNGVjNQ==
   data.tar.gz: !binary |-
-    MDIzNTY0NDAzZDk5MmFjNmZmZGNmNWRmZWRkMTgyNDYzZWM3NzI1Nw==
+    ZWM4ZDMyYjVjOTdlYTE5ODcwNGQ0MjdkYjQ0OTViNjZhMzkxMGFmZQ==
 SHA512:
   metadata.gz: !binary |-
-    NWUwNTJlNTZkMzgxYTg5ODk1NjQ4OGY1Y2FjNzkzYTFmNjc4Y2EzOWYzOTNl
-    MGVmZTQ4YTY1NDc5NjFmNDhjNjJlN2ZhZGQwMDFmNmExYjRjZTQ2NmI3MjAx
-    Mjk2ZDI0NWVhZjc0MmQ2NjNkNWIxMGVkZGIzMDA2NDJkNjI2NDE=
+    ZDlkMGNmMTBkOWM2ZmE0ZWY5NGNlMDZlOTU4YTBkM2NlY2FiYjYxYWZjNjdl
+    NzEwMjBiMWQ4ZDkxY2QxOGZjNGY1NTc5ZWNiZDVkNjRmOWI3N2YyM2IzMmE0
+    NDBkNmE5M2M4MDI4YmE4NzZhNTBiYzkyZTY4M2Y5NWNiOGQxZGY=
   data.tar.gz: !binary |-
-    MThiMjRkOTZlYTk1MGY2NTVjMDg1NzEzMzA2MTNmOWZlOWM2MjhlNGU1NDc4
-    OTAyZDYyNDAzNGUzOTQzYzJhOGRkMzhhNmYwNjZiZmU5YWE1N2UwMTI3Y2Vk
-    NzA3NmZmMDA2MjExMWZhMDY3YWQ0ZmI0ZWZmM2JkMjRmZDE4ZDk=
+    NzdlMjZkYWMxYWJiMTdjMzJkOTk5MTRjNzZjNjZlNjI3MjRmMjY0Nzc5OTVj
+    ZGQ0OWE4NWE3ZGYwYTYyYjNjODQ4ZmVmMDA5OGYxYmMwZjY5NzdlYjNhZmE0
+    MzQxMWEzYTliNmM5NTVlNDQ0ZjAzMjYyNWU4Y2Q2ODczZjM1NzE=

data/lib/go_import/errors.rb

@@ -18,5 +18,8 @@ module GoImport
     end
 
     class InvalidNoteClassificationError < StandardError
+        def initalize(classification)
+            super("#{classification} is not a valid note classification")
+        end
     end
 end

data/lib/go_import/model/note.rb

@@ -87,7 +87,7 @@ module GoImport
                     classification == NoteClassification::ClientVisit
                 @classification = classification
             else
-                raise InvalidNoteClassificationError
+                raise InvalidNoteClassificationError, classification
             end
 
         end

data/lib/go_import/model/rootmodel.rb

@@ -117,7 +117,8 @@ module GoImport
 
             organization = Organization.new(organization) if !organization.is_a?(Organization)
 
-            if find_organization_by_integration_id(organization.integration_id) != nil
+            if (!organization.integration_id.nil? && organization.integration_id.length > 0) &&
+                find_organization_by_integration_id(organization.integration_id) != nil
                 raise AlreadyAddedError, "Already added an organization with integration_id #{organization.integration_id}"
             end
 

data/sources/easy/.go_import/runner.rb

@@ -56,7 +56,7 @@ def convert_source
     # organization notes
     process_rows ORGANIZATION_NOTE_FILE do |row|
         # adds itself if applicable
-        rootmodel.add_note(to_organization_note(row, rootmodel))
+        rootmodel.add_note(to_organization_note(converter, row, rootmodel))
     end
 
     # Organization - Deal connection
@@ -77,7 +77,7 @@ def convert_source
     # deal notes
     process_rows DEAL_NOTE_FILE do |row|
         # adds itself if applicable
-        rootmodel.add_note(to_deal_note(row, rootmodel))
+        rootmodel.add_note(to_deal_note(converter, row, rootmodel))
     end
 
     # documents
@@ -148,7 +148,7 @@ end
 
 # Turns a row from the Easy exported Company-History.txt file into
 # a go_import model that is used to generate xml.
-def to_organization_note(row, rootmodel)
+def to_organization_note(converter, row, rootmodel)
     organization = rootmodel.find_organization_by_integration_id(row['idCompany'])
     coworker = rootmodel.find_coworker_by_integration_id(row['idUser'])
 
@@ -158,8 +158,26 @@ def to_organization_note(row, rootmodel)
         note.created_by = coworker
         note.person = organization.find_employee_by_integration_id(row['idPerson'])
         note.date = row['Date']
-        note.text = "#{row['Category']}: #{row['History']}"
-
+        
+        if converter.respond_to?(:get_note_classification_for_activity_on_company)
+            # we will get an InvalidNoteClassificationError if we are
+            # setting and invalid classification. So no need to verify
+            # return value from converter.
+            classification =
+                converter.get_note_classification_for_activity_on_company(row['Category'])
+
+            if classification.nil?
+                classification = GoImport::NoteClassification::Comment
+            end
+            
+            note.classification = classification
+
+            note.text = row['History']
+        else
+            note.classification = GoImport::NoteClassification::Comment
+            note.text = "#{row['Category']}: #{row['History']}"            
+        end
+		
         return note.text.empty? ? nil : note
     end
 
@@ -235,7 +253,7 @@ end
 
 # Turns a row from the Easy exported Project-History.txt file into
 # a go_import model that is used to generate xml
-def to_deal_note(row, rootmodel)
+def to_deal_note(converter, row, rootmodel)
     # TODO: This could be improved to read a person from an
     # organization connected to this deal if any, but since it is
     # a many to many connection between organizations and deals
@@ -251,6 +269,26 @@ def to_deal_note(row, rootmodel)
         # Raw history looks like this <category>: <person>: <text>
         note.text = row['RawHistory']
 
+        if converter.respond_to?(:get_note_classification_for_activity_on_project)
+            # we will get an InvalidNoteClassificationError if we are
+            # setting and invalid classification. So no need to verify
+            # return value from converter.
+
+            classification =
+                converter.get_note_classification_for_activity_on_project(row['Category'])
+
+            if classification.nil?
+                classification = GoImport::NoteClassification::Comment
+            end
+            
+            note.classification = classification
+            note.text = row['RawHistory'].to_s.sub("#{row['Category']}:", "")
+        else
+            note.classification = GoImport::NoteClassification::Comment
+            note.text = row['RawHistory']
+        end
+        
+
         return note.text.empty? ? nil : note
     end
 

data/sources/easy/converter.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# encoding: iso-8859-1
 require 'go_import'
 
 # Customize this file to suit your input files.
@@ -220,6 +220,7 @@ class Converter
         ## LIME Go custom fields.
         # This is how you populate a LIME Go custom field that was created in
         # the configure method.
+
         # person.set_custom_value("shoe_size", row['shoe size'])
     end
 
@@ -268,6 +269,50 @@ class Converter
         return deal
     end
 
+    def get_note_classification_for_activity_on_company(activity)
+        # When notes are added to LIME Go this method is called for
+        # every note that is connected to a company in LIME Easy. The
+        # note's activity from LIME Easy is supplied as an argument
+        # and this method should return a classification for the note
+        # in LIME Go. The return value must be a value from the
+        # GoImport::NoteClassification enum. If no classification is
+        # return the note will get the default classification 'Comment'
+
+        # case activity
+        # when 'SalesCall' 
+		# 	classification = GoImport::NoteClassification::SalesCall
+		# when 'Customer Visit'
+	    # classification = GoImport::NoteClassification::ClientVisit
+		# when 'No answer'
+		# 	classification = GoImport::NoteClassification::TriedToReach
+        # else
+        #     classification = GoImport::NoteClassification::Comment
+        # end
+		
+		# return classification
+    end
+
+    def get_note_classification_for_activity_on_project(activity)
+        # When notes are added to LIME Go this method is called for
+        # every note that is connected to a project in LIME Easy. The
+        # note's activity from LIME Easy is supplied as an argument
+        # and this method should return a classification for the note
+        # in LIME Go. The return value must be a value from the
+        # GoImport::NoteClassification enum. If no classification is
+        # return the note will get the default classification 'Comment'
+        
+        # case activity
+        # when 'Installation' 
+		# 	classification = GoImport::NoteClassification::ClientVisit
+		# when 'No answer'
+		# 	classification = GoImport::NoteClassification::TriedToReach
+        # else
+        #     classification = GoImport::NoteClassification::Comment
+        # end
+		
+		# return classification
+    end
+    
     def configure(rootmodel)
         #####################################################################
         ## LIME Go custom fields.

data/sources/salesforce/.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/salesforce/.go_import/readme.txt

@@ -0,0 +1 @@
+This source converts a csv file to LIME Go.

data/sources/salesforce/.go_import/runner.rb

@@ -0,0 +1,72 @@
+
+require 'go_import'
+require_relative("../converter")
+
+# COWORKER_FILE and other file names should be defined ../converter.rb
+
+def process_rows(file_name)
+    data = File.open(file_name, 'r').read.encode('UTF-8',"ISO-8859-1")
+    rows = GoImport::CsvHelper::text_to_hashes(data)
+    rows.each do |row|
+        yield row
+    end
+end
+
+def convert_source
+    puts "Trying to convert Salesforce CSV export to LIME Go..."
+
+    converter = Converter.new
+
+    # A rootmodel is used to represent all entitite/models that is
+    # exported
+    rootmodel = GoImport::RootModel.new
+
+    if converter.respond_to?(:configure)
+        converter.configure(rootmodel)
+    end
+
+    contacts_file = ::File.expand_path('data/contacts.csv', Dir.pwd)
+    process_rows contacts_file do |row|
+        rootmodel.add_organization(converter.to_organization(row, rootmodel))
+    end
+
+    return rootmodel
+    
+    # coworkers
+    # start with these since they are referenced
+    # from everywhere....
+    if defined?(COWORKER_FILE) && !COWORKER_FILE.nil? && !COWORKER_FILE.empty?
+        process_rows COWORKER_FILE do |row|
+            rootmodel.add_coworker(converter.to_coworker(row))
+        end
+    end
+
+    # organizations
+    if defined?(ORGANIZATION_FILE) && !ORGANIZATION_FILE.nil? && !ORGANIZATION_FILE.empty?
+        process_rows ORGANIZATION_FILE do |row|
+            organization = converter.to_organization(row, rootmodel)
+            rootmodel.add_organization(organization)
+        end
+    end
+
+    # persons
+    # depends on organizations
+    if defined?(PERSON_FILE) && !PERSON_FILE.nil? && !PERSON_FILE.empty?
+        process_rows PERSON_FILE do |row|
+            # adds it self to the employer
+            converter.to_person(row, rootmodel)
+        end
+    end
+
+    # deals
+    # deals can reference coworkers (responsible), organizations
+    # and persons (contact)
+    if defined?(DEAL_FILE) && !DEAL_FILE.nil? && !DEAL_FILE.empty?
+        process_rows DEAL_FILE do |row|
+            rootmodel.add_deal(converter.to_deal(row, rootmodel))
+        end
+    end
+
+    return rootmodel
+end
+

data/sources/salesforce/Gemfile

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

data/sources/salesforce/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    global_phone (1.0.1)
+    go_import (3.0.17)
+      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
+  go_import
+  rspec
+  thor

data/sources/salesforce/converter.rb

@@ -0,0 +1,204 @@
+
+require 'go_import'
+
+# This converter will convert one or more CVS files into a LIME Go XML
+# file.
+
+# You need to customize this script to suit your CVS file(s).
+
+# First we set the file names of your CVS files. If you dont need to
+# import all kind of objects, just leave the filename empty or remove
+# the line.
+DATA_FOLDER = "data"
+
+#COWORKER_FILE = "data/coworkers.csv"
+#ORGANIZATION_FILE = "data/organizations.csv"
+#PERSON_FILE = "data/persons.csv"
+#DEAL_FILE = "data/deals.csv"
+
+# Ie if you dont want to import deals, set DEAL_FILE = ""
+
+# 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 "go-import 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 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.
+        # rootmodel.settings.with_organization do |organization|
+        #     organization.set_custom_field( { :integrationid => 'external_url', :title => 'Link to external system', :type => :Link } )
+        # end
+
+        # rootmodel.settings.with_deal do |deal|
+        #     deal.add_status({:label => "1. Kvalificering", :integration_id => "qualification"})
+        #     deal.add_status({:label => "Vunnen", :integration_id => "won",
+        #                         :assessment => GoImport::DealState::PositiveEndState })
+        #     deal.add_status({:label => "Lost", :integration_id => "Lost",
+        #                         :assessment => GoImport::DealState::NegativeEndState })
+        # end
+    end
+
+    # Turns a row from the organization csv file into a
+    # GoImport::Organization.
+    # Use rootmodel to locate other related stuff such coworker
+    def to_organization(row, rootmodel)
+        organization = GoImport::Organization.new
+
+        puts "Trying to create org '#{row}'"
+
+        return organization
+
+        
+        # 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']
+        organization.name = row['name']
+
+        # Just setting all basic properties to show whats available
+        # Remove or fix...
+        organization.organization_number = 'a number'   # needs clean up, should have helpers for that in lib. Swedish format.
+        organization.email = 'email to organizaiton, not the person'
+        organization.web_site = 'www.whatever.com'
+        organization.central_phone_number = '0000'      # needs clean up, should have helpers for that in lib. Default swedish format, convert to global format
+
+        # Addresses consists of several parts in Go.
+        # Lots of other systems have the address all in one
+        # line, to be able to match when importing it is
+        # way better to split the addresses
+        organization.with_visit_address do |address|
+            address.street = 'visit street'
+            address.zip_code = 'visit zip'
+            address.city = 'visit city'
+        end
+
+        # Another example of setting address using
+        # helper to split '226 48 LUND' into zip and city
+        organization.with_postal_address do |address|
+            address.street = 'postal street'
+            address.parse_zip_and_address_se '226 48 LUND'
+        end
+
+        # Responsible coworker is set by first locating
+        # it in the root model and then setting a reference
+        # to him/her
+        # We need to be able handle missing coworkers here
+        coworker = rootmodel.find_coworker_by_integration_id row['responsible_id']
+        organization.responsible_coworker = coworker.to_reference
+
+        # Set tags for the organization. All organizations will get
+        # the tag "import" automagically
+        organization.set_tag("Guldkund")
+
+        # When imported from web based ERP or similair that
+        # client will continue to use it can be useful to be
+        # able to link from Go to the same record in the ERP
+        # FOr instance Lime links
+        organization.set_custom_value("external_url", "http://something.com?key=#{row['id']}")
+
+        return organization
+    end
+
+    # Turns a row from the coworker csv file into a GoImport::Coworker.
+    def to_coworker(row)
+        coworker = GoImport::Coworker.new
+        coworker.integration_id = row['id']
+        coworker.first_name = row['first_name']
+        coworker.last_name = row['last_name']
+
+        # Other optional attributes
+        coworker.email = 't@e.com'
+        coworker.direct_phone_number = '+46121212'
+        coworker.mobile_phone_number = '+46324234'
+        coworker.home_phone_number = '+46234234'
+
+        # Tags and custom fields are set the same
+        # way as on organizations
+
+        return coworker
+    end
+
+    # Turns a row from the person csv file into a GoImport::Person.
+    #
+    # You MUST add the new person to an existing organization. Use the
+    # rootmodel to find the organization and then add the person with
+    # organization.add_employee
+    def to_person(row, rootmodel)
+        person = GoImport::Person.new
+        person.integration_id = row['id']
+        # Note that Go has separate first and last names
+        # Some splitting might be necessary
+        person.first_name = row['first_name']
+        person.last_name = row['last_name']
+        # other optional attributes
+        person.direct_phone_number = '+4611111'
+        person.fax_phone_number = '+4623234234234'
+        person.mobile_phone_number = '+462321212'
+        person.email = 'x@y.com'
+        person.alternative_email = 'y@x.com'
+        person.with_postal_address do |address|
+            address.street = 'postal street'
+            address.parse_zip_and_address_se '226 48 LUND'
+        end
+
+        # Tags and custom fields are set the same
+        # way as on organizations
+
+        # set employer connection
+        employer_id = row['employer_id']
+        employer = rootmodel.find_organization_by_integration_id employer_id
+        employer.add_employee person
+    end
+
+    # Turns a row form the deal csv file into a GoImport::Deal. Use
+    # the rootmodel to find objects that should be linked to the new
+    # deal.
+    def to_deal(row, rootmodel)
+        deal = GoImport::Deal.new
+        deal.integration_id = row['id']
+        deal.name = row['name']
+        # should be integer, same currency should be used in
+        # the system
+        deal.value = row['value']
+
+        # find stuff connected to deal
+        responsible = rootmodel.find_coworker_by_integration_id row['responsible_id']
+        organization = rootmodel.find_organization_by_integration_id row['customer_id']
+        person = organization.find_employee_by_integration_id row['customer_contact_id']
+        # connect the deal by references
+        deal.responsible_coworker = responsible.to_reference
+        deal.customer = organization.to_reference
+        deal.customer_contact = person.to_reference
+
+        # other optional attributes
+        deal.probability = 50           # should be between 0 - 100
+        deal.order_date = '2014-01-05'  # Format ?
+
+        # status, set this by either label, id or integration_id (use
+        # appropriate method to find status)
+        deal.status = rootmodel.settings.deal.find_status_by_label row['status']
+
+        # or set by existing status, search by label, integration_id
+        # (if string) or id (if integer).
+        # deal.status = "Won"
+
+        return deal
+    end
+end

data/sources/salesforce/data/contacts.csv

@@ -0,0 +1,4 @@
+FirstName,LastName,Title,ReportsTo.Email,Birthdate,Description
+Tom,Jones,Senior Director,buyer@salesforcesample.com,1940-06-07Z,"Self-described as ""the top"" branding guru on the West Coast"
+Ian,Dury,Chief Imagineer,cto@salesforcesample.com,,"World-renowned expert in fuzzy logic design. 
+Influential in technology purchases."

data/spec/rootmodel_spec.rb

@@ -96,10 +96,25 @@ describe "RootModel" do
         rootmodel.organizations.length.should eq 1
     end
 
+    it "will add two organizations without integration id" do
+        # given
+        org1 = GoImport::Organization.new
+        org1.name = "Beagle Boys"
+        org2 = GoImport::Organization.new
+        org2.name = "The Corporation"
+
+        # when
+        rootmodel.add_organization(org1)
+        rootmodel.add_organization(org2)
+
+        # then
+        rootmodel.organizations.length.should eq 2
+    end
+
     it "can add a deal from hash" do
         rootmodel.add_deal({
-                                       :integration_id => "123key",
-                                       :name => "Big deal"
+                :integration_id => "123key",
+                :name => "Big deal"
         })
         rootmodel.find_deal_by_integration_id("123key").name.should eq "Big deal"
         rootmodel.deals.length.should eq 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: go_import
 version: !ruby/object:Gem::Version
-  version: 3.0.17
+  version: 3.0.18
 platform: ruby
 authors:
 - Oskar Gewalli
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso_country_codes
@@ -227,6 +227,14 @@ files:
 - sources/excel-basic/files/offert-2.docx
 - sources/excel-basic/files/offert.docx
 - sources/excel-basic/Gemfile
+- sources/salesforce/.gitignore
+- sources/salesforce/.go_import/readme.txt
+- sources/salesforce/.go_import/runner.rb
+- sources/salesforce/converter.rb
+- sources/salesforce/data/contacts.csv
+- sources/salesforce/Gemfile
+- sources/salesforce/Gemfile.lock
+- sources/salesforce/go.zip
 - sources/VISMA/.gitignore
 - sources/VISMA/.go_import/readme.txt
 - sources/VISMA/.go_import/runner.rb