go_import 3.0.0

data/lib/go_import/serialize_helper.rb

@@ -0,0 +1,186 @@
+# encoding: utf-8
+require "rexml/document"
+
+module GoImport
+    module SerializeHelper
+        def serialize()
+            SerializeHelper::serialize(self)
+        end
+
+        def serialize_to_file(file)
+            SerializeHelper::serialize_to_file(file, self)
+        end
+
+        # @!visibility private
+        def self.serialize_variables_rexml(elem, obj)
+            if (obj.respond_to?(:serialize_variables))
+                obj.serialize_variables.each do |serialize_variable|
+                    element_name = serialize_variable[:id].to_s.gsub(/^\@/,'').split('_').map do |m|
+                        m.capitalize
+                    end.join('')
+
+                    raw_var = obj.instance_variable_get("@#{serialize_variable[:id].to_s}")
+                    if raw_var != nil
+                        element = elem.add_element(element_name)
+                        if (raw_var.respond_to?(:serialize_variables))
+                            SerializeHelper::serialize_variables_rexml(element, raw_var)
+                        elsif (raw_var.is_a?(Array))
+                            raw_var.each do |raw_var_elem| 
+                                SerializeHelper::serialize_rexml(element, raw_var_elem) 
+                            end
+                        else
+                            element.text = raw_var.to_s.encode('UTF-8')
+                        end
+                    end
+                end
+                return
+            end
+            raise "Do not know how to handle #{obj.class} !!"
+        end
+
+        # @!visibility private
+        def self.serialize_rexml(elem, obj)
+            if obj.respond_to?(:to_rexml)
+                obj.to_rexml(elem)
+            elsif (obj.respond_to?(:serialize_variables))
+                element_name = obj.serialize_name
+                SerializeHelper::serialize_variables_rexml(elem.add_element(element_name), obj)
+            else
+                elem.text = obj.to_s
+            end
+        end
+
+        # @!visibility private
+        def self.serialize(obj, indent= 2)
+            # indent -1 to avoid indent
+            if obj.respond_to?(:to_rexml)
+                doc = REXML::Document.new()
+                SerializeHelper::serialize_rexml(doc, obj)
+                doc.write( xml_str = "" , indent, true)
+                xml_str
+            elsif (obj.respond_to?(:serialize_variables))
+                element_name = obj.serialize_name
+                doc = REXML::Document.new()
+                SerializeHelper::serialize_variables_rexml(doc.add_element(element_name), obj)
+                doc.write( xml_str = "", indent, true)
+                xml_str
+            else
+                obj.to_s.encode(:xml => :text)
+            end
+        end
+
+        # @!visibility private
+        def self.serialize_to_file(file, obj)
+            File.open(file, 'w') do |f|
+                f.write(SerializeHelper::serialize(obj))
+            end
+        end
+
+        # @!visibility private
+        def symbol_to_name(symbol)
+            symbol.to_s.split('_').join(' ').capitalize
+        end
+
+        # @!visibility private
+        def map_symbol_to_row(symbol,type)
+            {
+                :id => symbol.to_s,
+                :name => symbol == :id ? 'Go id' : symbol_to_name(symbol),
+                :type =>type
+            }
+        end
+
+        # @!visibility private
+        def map_to_row(p)
+            case p[:type]
+            when :string then
+                map_symbol_to_row(p[:id],p[:type])
+            when :bool then
+                map_symbol_to_row(p[:id],p[:type])
+            when :date then
+                map_symbol_to_row(p[:id],p[:type])
+            when :notes then
+                {
+                    :id => p[:id].to_s,
+                    :name => symbol_to_name(p[:id]),
+                    :type => p[:type],
+                    :models => SerializeHelper.get_import_rows(:note)
+                }
+            when :tags then
+                {
+                    :id => p[:id].to_s,
+                    :type => p[:type],
+                    :name => symbol_to_name(p[:id]),
+                }
+            when :persons then
+                {
+                    :id => p[:id].to_s,
+                    :type => p[:type],
+                    :name => symbol_to_name(p[:id]),
+                    :models => SerializeHelper.get_import_rows(:person)
+                }
+            when :custom_fields then
+                {
+                    :id => p[:id].to_s,
+                    :type => p[:type],
+                    :name => symbol_to_name(p[:id]),
+                    :models => SerializeHelper.get_import_rows(:custom_field)
+                }
+            when :custom_values then
+                {
+                    :id => p[:id].to_s,
+                    :type => p[:type],
+                    :name => symbol_to_name(p[:id]),
+                    :models => SerializeHelper.get_import_rows(:custom_value)
+                }
+            else
+                {
+                    :id => p[:id].to_s,
+                    :name => symbol_to_name(p[:id]),
+                    :type => p[:type],
+                    :model => SerializeHelper.get_import_rows(p[:type])
+                }
+            end
+        end
+
+        # What fields/rows on the class is supposed to be used by the Gem to generate the xml
+        # This method uses #serialize_variables.
+        def get_import_rows
+            serialize_variables.map do |p|
+                map_to_row p
+            end
+        end
+
+        # @!visibility private
+        def self.get_import_rows(type)
+            case type
+            when :person then
+                Person.new
+            when :source_ref then
+                ReferenceToSource.new
+            when :note then
+                Note.new
+            when :address then
+                Address.new
+            when :organization then
+                Organization.new
+            when :coworker_reference then
+                CoworkerReference.new
+            when :organization_reference then
+                OrganizationReference.new
+            when :custom_field then
+                CustomField.new
+            when :custom_value then
+                CustomValue.new
+            when :custom_field_reference then
+                CustomFieldReference.new
+            when :settings then
+                Settings.new
+            when :class_settings then
+                ClassSettings.new
+            else
+                raise "Unknown type: #{type}"
+            end.get_import_rows
+        end
+    end
+end

data/lib/go_import/source.rb

@@ -0,0 +1,87 @@
+require 'fileutils'
+require 'open3'
+
+module GoImport
+    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
+
+        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/go_import/templating.rb

@@ -0,0 +1,52 @@
+require "fileutils"
+require 'open3'
+module GoImport
+    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/go_import.rb

@@ -0,0 +1,19 @@
+module GoImport
+    private
+    def self.require_all_in(folder)
+        Dir.glob(File.join( File.dirname(File.absolute_path(__FILE__)),folder), &method(:require))
+    end
+
+    require 'go_import/errors'
+    require 'go_import/serialize_helper'
+    require 'go_import/model_helpers'
+    #FruitToLime::require_all_in 'go_import/model/*.rb'
+    GoImport::require_all_in 'go_import/model/*.rb'
+    require 'go_import/csv_helper'
+    require 'go_import/roo_helper'
+    require 'go_import/phone_helper'
+    require 'go_import/email_helper'
+    require 'go_import/excel_helper'
+    require 'go_import/templating'
+    require 'go_import/source'
+end

data/sources/csv/.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/csv/.go_import/runner.rb

@@ -0,0 +1,62 @@
+
+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 CSV source to LIME Go..."
+
+    converter = Converter.new
+
+    # A rootmodel is used to represent all entitite/models that is
+    # exported
+    rootmodel = GoImport::RootModel.new
+
+    converter.configure(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|
+            rootmodel.add_organization(converter.to_organization(row, rootmodel))
+        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/csv/Gemfile

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

data/sources/csv/Rakefile.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/sources/csv/converter.rb

@@ -0,0 +1,179 @@
+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.
+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 = ""
+
+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
+        # 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
+
+        # Tags are set and defined at the same place
+        # Setting a tag: Imported is useful for the user
+        organization.set_tag("Imported")
+
+        # 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/csv/data/coworkers.csv

@@ -0,0 +1,2 @@
+id;first_name;last_name
+666;Evil;Elvis

data/sources/csv/data/deals.csv

@@ -0,0 +1,2 @@
+id;name;value;responsible_id;customer_id;customer_contact_id;status
+333;Feta affären;10000;666;6;123;Vunnen

data/sources/csv/data/organizations.csv

@@ -0,0 +1,2 @@
+id;name;responsible_id
+6;Alfs Mjukvaruutveckling;666

data/sources/csv/data/persons.csv

@@ -0,0 +1,2 @@
+id;employer_id;first_name;last_name
+123;6;Rune;Rebellion

data/sources/csv/spec/exporter_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require 'tomodel'
+
+describe 'Exporter' do
+    before(:all) do
+        exporter = Exporter.new
+        organizations_file = File.join(File.dirname(__FILE__), 'sample_data', 'organizations.csv')
+        coworkers_file = File.join(File.dirname(__FILE__), 'sample_data', 'coworkers.csv')
+        persons_file = File.join(File.dirname(__FILE__), 'sample_data', 'persons.csv')
+        deals_file = File.join(File.dirname(__FILE__), 'sample_data', 'deals.csv')
+        @model = exporter.to_model(coworkers_file, organizations_file, persons_file, deals_file)
+    end
+    it "will find something with a name" do
+        organization = @model.organizations[0]
+        organization.name.length.should > 0
+    end
+end

data/sources/csv/spec/sample_data/coworkers.csv

@@ -0,0 +1,2 @@
+id;first_name;last_name
+666;Evil;Elvis

data/sources/csv/spec/sample_data/deals.csv

@@ -0,0 +1,2 @@
+id;name;value;responsible_id;customer_id;customer_contact_id;status
+333;Feta affären;10000;666;6;123;Vunnen

data/sources/csv/spec/sample_data/organizations.csv

@@ -0,0 +1,2 @@
+id;name;responsible_id
+6;Alfs Mjukvaruutveckling;666

data/sources/csv/spec/sample_data/persons.csv

@@ -0,0 +1,2 @@
+id;employer_id;first_name;last_name
+123;6;Rune;Rebellion