move-to-go 5.0.0

data/lib/move-to-go/model/deal_status_reference.rb

@@ -0,0 +1,47 @@
+module MoveToGo
+    class DealStatusReference
+        include SerializeHelper
+
+        attr_accessor :label, :integration_id
+
+        def initialize(opt = nil)
+            if opt != nil
+                serialize_variables.each do |myattr|
+                    val = opt[myattr[:id]]
+                    instance_variable_set("@" + myattr[:id].to_s, val) if val != nil
+                end
+            end
+        end
+
+        def serialize_variables
+            [:integration_id, :label].map {|p| {:id => p, :type => :string} }
+        end
+
+        def serialize_name
+            "StatusReference"
+        end
+
+        # Converts the specifed status to a status reference.
+        def self.from_deal_status(deal_status)
+            if deal_status.nil?
+                return nil
+            elsif deal_status.is_a?(DealStatusSetting)
+                return deal_status.to_reference
+            elsif deal_status.is_a?(String)
+                return DealStatusReference.new({:label => deal_status, :integration_id => deal_status})
+            end
+
+            raise InvalidDealStatusError
+        end
+
+        def validate
+            error = ""
+
+            if (@label.nil? || @label.empty?) && (@integration_id.nil? || @integration_id.empty?)
+                error = "label and integration_id can't all be nil or empty"
+            end
+
+            return error
+        end
+    end
+end

data/lib/move-to-go/model/deal_status_setting.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+module MoveToGo
+    class DealStatusSetting
+        include SerializeHelper
+
+        attr_accessor :id, :integration_id, :label, :assessment
+
+        def initialize(opt = nil)
+            if opt != nil
+                serialize_variables.each do |myattr|
+                    val = opt[myattr[:id]]
+                    instance_variable_set("@" + myattr[:id].to_s, val) if val != nil
+                end
+            end
+        end
+
+        def serialize_variables
+            [ :id, :integration_id, :label, :assessment ].map{ |p| { :id => p, :type => :string } }
+        end
+
+        def serialize_name
+            "DealStatus"
+        end
+
+        def to_reference()
+            reference = DealStatusReference.new
+            reference.label = @label
+            reference.integration_id = @integration_id
+
+            return reference
+        end
+
+        def same_as?(other)
+            if @integration_id != nil && @integration_id == other.integration_id
+                return true
+            end
+
+            if @id != nil && @id == other.id
+                return true
+            end
+
+            if @label != nil && @label == other.label
+                return true
+            end
+
+            return false
+        end
+    end
+end

data/lib/move-to-go/model/documents.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+module MoveToGo
+    #  This class is the container for all documents, ie links and
+    #  files.
+    class Documents
+        include SerializeHelper
+
+        attr_reader :links, :files
+
+        def serialize_variables
+            [
+             {:id => :links, @type => :links},
+             {:id => :files, @type => :files}
+            ]
+        end
+
+        def serialize_name
+            "Documents"
+        end
+
+        def initialize
+            @links = []
+            @files = []
+        end
+
+        def add_link(link)
+            @links = [] if @links == nil
+
+            if link.nil?
+                return nil
+            end
+
+            link = Link.new(link) if !link.is_a?(Link)
+
+            if (!link.integration_id.nil? && link.integration_id.length > 0) &&
+                    find_link_by_integration_id(link.integration_id) != nil
+                raise AlreadyAddedError, "Already added a link with integration_id '#{link.integration_id}'."
+            end
+
+            @links.push link
+
+            return link
+        end
+
+        def find_link_by_integration_id(integration_id)
+            return @links.find do |link|
+                link.integration_id == integration_id
+            end
+        end
+
+        def add_file(file)
+            @files = [] if @files == nil
+
+            if file.nil?
+                return nil
+            end
+
+            file = File.new(file) if !file.is_a?(File)
+
+            if (!file.integration_id.nil? && file.integration_id.length > 0) &&
+                    find_file_by_integration_id(file.integration_id) != nil
+                raise AlreadyAddedError, "Already added a file with integration_id '#{file.integration_id}'."
+            end
+
+            @files.push file
+
+            return file
+        end
+
+        def find_file_by_integration_id(integration_id)
+            return @files.find do |file|
+                file.integration_id == integration_id
+            end
+        end
+    end
+end

data/lib/move-to-go/model/file.rb

@@ -0,0 +1,193 @@
+require 'pathname'
+require_relative '../serialize_helper'
+
+# Note that we name this class File and ruby alread have a File class.
+# To refrence to this
+
+module MoveToGo
+    class File
+        DEFAULT_MAX_FILE_SIZE = 100000000 # 100 Mb
+
+        include SerializeHelper
+        attr_accessor :id, :integration_id, :description
+
+        attr_reader :organization, :created_by, :deal
+
+        attr_reader :path
+
+        attr_reader :name
+
+        # location_in_zip_file is used internally when the file is
+        # stored in the zip file that is sent to LIME Go. You should
+        # not modify this property
+        attr_accessor :location_in_zip_file
+
+        def initialize(opt = nil)
+            if !opt.nil?
+                serialize_variables.each do |myattr|
+                    val = opt[myattr[:id]]
+                    instance_variable_set("@" + myattr[:id].to_s, val) if val != nil
+                end
+            end
+        end
+
+        def serialize_name
+            "File"
+        end
+
+        def serialize_variables
+            [ :id, :integration_id, :path, :name, :description, :location_in_zip_file ].map {
+                |p| {
+                    :id => p,
+                    :type => :string
+                }
+            } +
+                [
+                 { :id => :created_by_reference, :type => :coworker_reference, :element_name => :created_by },
+                 { :id => :organization_reference, :type => :organization_reference, :element_name => :organization },
+                 { :id => :deal_reference, :type => :deal_reference, :element_name => :deal }
+                ]
+        end
+
+        def path=(path)
+            @path = path
+
+            # when path is set, we should set the name to the path's
+            # filename if name is NOT set already
+
+            # Hm. this might introduce a bug if we set path twice and
+            # never explicity set the name (it will get the name of
+            # the first file)
+
+            if (@name.nil? || @name.empty?) && (!@path.nil? && !@path.empty?)
+                @name = Pathname.new(path).basename.to_s
+            end
+            @location_in_zip_file = "files/#{SecureRandom.uuid}#{::File.extname(@path).to_s}"
+
+        end
+
+        def name=(name)
+            @name = name
+
+            # a file must have a name, hence this.
+
+            if @name.nil? || @name.empty?
+                if !@path.nil? && !@path.empty?
+                    @name = Pathname.new(@path).basename.to_s
+                end
+            end
+        end
+
+        def has_relative_path?()
+            return !@path.match(/[a-zA-Z]{1}\:[\\\/]/)&&Pathname.new(@path).relative?
+        end
+
+        def organization=(org)
+            @organization_reference = OrganizationReference.from_organization(org)
+
+            if org.is_a?(Organization)
+                @organization = org
+            end
+        end
+
+        def deal=(deal)
+            @deal_reference = DealReference.from_deal(deal)
+
+            if deal.is_a?(Deal)
+                @deal = deal
+            end
+        end
+
+        def created_by=(coworker)
+            @created_by_reference = CoworkerReference.from_coworker(coworker)
+
+            if coworker.is_a?(Coworker)
+                @created_by = coworker
+            end
+        end
+
+        # This is the path to where the file should be accessed
+        # from within the project.
+        def path_for_project
+            if @path.nil? || @path.empty?
+                return ""
+            end
+
+            # Get the folder where files should be accessed from
+            # during the import. If not defined in converter.rb use
+            # the current directory
+            if defined?(FILES_FOLDER) && !FILES_FOLDER.empty?()
+                root_folder = FILES_FOLDER
+            else
+                root_folder = Dir.pwd
+            end
+
+            if has_relative_path?()
+                # since this file is stored with a relative file name
+                # we should get it from the root folder
+                path_for_project = ::File.expand_path(@path, root_folder)
+            else
+                # the file is stored with an absolute path, if the
+                # file cant be access using that path we must change
+                # it to a path that is accessible from this computer.
+                # The FILES_FOLDER_AT_CUSTOMER constant states what
+                # part of the path that should be replaced with the
+                # root folder.
+
+                # We assume that the original system used ONE location
+                # for all its files. If not, we should change
+                # FILES_FOLDER_AT_CUSTOMER to a list of folders.
+                if defined?(FILES_FOLDER_AT_CUSTOMER) && !FILES_FOLDER_AT_CUSTOMER.empty?()
+                    files_folder_at_customer = FILES_FOLDER_AT_CUSTOMER
+                else
+                    files_folder_at_customer = ""
+                end
+
+                if files_folder_at_customer.empty?
+                    path_for_project = @path
+                else
+                    path_for_project = ::File.expand_path(@path.downcase.sub(files_folder_at_customer.downcase, root_folder))
+                end
+            end
+
+            return path_for_project
+        end
+
+        def add_to_zip_file(zip_file)
+            zip_file.add(@location_in_zip_file, path_for_project)
+        end
+
+        def validate(ignore_invalid_files = false, max_file_size = DEFAULT_MAX_FILE_SIZE)
+            error = String.new
+            warning = String.new
+
+            if @name.nil? || @name.empty?
+                error = "#{error}A file must have a name.\n"
+            end
+
+            if @path.nil? || @path.empty?
+                error = "Path is required for file.\n"
+            elsif !ignore_invalid_files
+                if !::File.exists?(path_for_project())
+                    error = "#{error}Can't find file with name '#{@name}' and original path '#{@path}' at '#{path_for_project()}'."
+                elsif ::File.exists?(path_for_project) && ::File.size(path_for_project()) > max_file_size
+                    error = "#{error}File '#{@name}' is bigger than #{max_file_size} bytes."
+                end
+            end
+
+            if @created_by_reference.nil?
+                error = "#{error}Created_by is required for file (#{@name}).\n"
+            end
+
+            if @organization_reference.nil? && @deal_reference.nil?
+                error = "#{error}The file (#{@name}) must have either an organization or a deal.\n"
+            end
+
+            if !@organization_reference.nil? && !@deal_reference.nil?
+                error = "#{error}The file (#{@name}) can't be attached to both an organization and a deal."
+            end
+
+            return error
+        end
+    end
+end

data/lib/move-to-go/model/history.rb

@@ -0,0 +1,148 @@
+module MoveToGo
+    class History < CanBecomeImmutable
+        include SerializeHelper
+        immutable_accessor :id
+        immutable_accessor :integration_id
+        immutable_accessor :date
+
+        attr_reader :text
+        attr_reader :organization, :created_by, :person, :deal
+
+        # The history classification. It should be a value from
+        # {#HistoryClassification}. The default value is Comment.
+        attr_reader :classification
+
+        def initialize(opt = nil)
+            if !opt.nil?
+                serialize_variables.each do |myattr|
+                    val = opt[myattr[:id]]
+                    instance_variable_set("@" + myattr[:id].to_s, val) if val != nil
+                end
+            end
+
+            @classification = HistoryClassification::Comment if @classification.nil?
+        end
+
+        def serialize_variables
+            [ :id, :text, :integration_id, :classification ].map {
+                |p| {
+                    :id => p,
+                    :type => :string
+                }
+            } +
+                [
+                 { :id => :date, :type => :date },
+                 { :id => :created_by_reference, :type => :coworker_reference, :element_name => :created_by },
+                 { :id => :organization_reference, :type => :organization_reference, :element_name => :organization },
+                 { :id => :deal_reference, :type => :deal_reference, :element_name => :deal },
+                 { :id => :person_reference, :type => :person_reference, :element_name => :person }
+                ]
+        end
+
+        def get_import_rows
+            (serialize_variables + [
+                { :id => :organization, :type => :organization_reference},
+                { :id => :person, :type => :person_reference}
+                ]).map do |p|
+                map_to_row p
+            end
+        end
+
+        def serialize_name
+            "History"
+        end
+
+        def organization=(org)
+            raise_if_immutable
+            @organization_reference = OrganizationReference.from_organization(org)
+
+            if org.is_a?(Organization)
+                @organization = org
+            end
+        end
+
+        def created_by=(coworker)
+            raise_if_immutable
+            @created_by_reference = CoworkerReference.from_coworker(coworker)
+
+            if coworker.is_a?(Coworker)
+                @created_by = coworker
+            end
+        end
+
+        def person=(person)
+            raise_if_immutable
+            @person_reference = PersonReference.from_person(person)
+
+            if person.is_a?(Person)
+                @person = person
+            end
+        end
+
+        def deal=(deal)
+            raise_if_immutable
+            @deal_reference = DealReference.from_deal(deal)
+
+            if deal.is_a?(Deal)
+                @deal = deal
+            end
+        end
+
+        def classification=(classification)
+            raise_if_immutable
+            if classification == HistoryClassification::Comment || classification == HistoryClassification::SalesCall ||
+                    classification == HistoryClassification::TalkedTo || classification == HistoryClassification::TriedToReach ||
+                    classification == HistoryClassification::ClientVisit
+                @classification = classification
+            else
+                raise InvalidHistoryClassificationError, classification
+            end
+        end
+
+        def text=(text)
+            raise_if_immutable
+            @text = text
+
+            if @text.nil?
+                return
+            end
+
+            if @text.length == 0
+                return
+            end
+
+            @text.strip!
+            
+            # remove form feeds
+            @text.gsub!("\f", "")
+
+            # remove vertical spaces
+            @text.gsub!("\v", "")
+
+            # remove backspace
+            @text.gsub!("\b", "")
+        end
+
+        def validate
+            error = String.new
+
+            if (@classification.nil? || @classification.empty?)
+                error = "Classification is required for history\n"
+            end
+
+            if (@text.nil? || @text.empty?) && classification != HistoryClassification::TriedToReach
+                error = "Text is required for history\n"
+            end
+
+            if @created_by.nil?
+                error = "#{error}Created_by is required for history\n"
+            end
+
+            if @organization.nil? && @deal.nil? && @person.nil?
+                error = "#{error}Organization, deal or person is required for history\n"
+            end
+
+            return error
+        end
+    end
+end

data/lib/move-to-go/model/history_classification.rb

@@ -0,0 +1,26 @@
+module MoveToGo
+    # Defines a history type. This defines what kind of
+    # action that happened before the history was written.
+    module HistoryClassification
+        # We talked to the client about a sale. This might be a phone call
+        # or a talk in person.
+        SalesCall = 'SalesCall'
+
+        # This is a general comment about the organization or deal.
+        Comment = 'Comment'
+
+        # This is a general comment regarding a talk we had with
+        # someone at the client.
+        TalkedTo = 'TalkedTo'
+
+        # We tried to reach someone but failed.
+        TriedToReach = 'TriedToReach'
+
+        # We had a meeting at the client's site.
+        ClientVisit = 'ClientVisit'
+    end
+end
+
+
+
+ 

data/lib/move-to-go/model/link.rb

@@ -0,0 +1,82 @@
+module MoveToGo
+    class Link
+        include SerializeHelper
+        attr_accessor :id, :integration_id, :url, :name, :description
+
+        attr_reader :organization, :created_by, :deal
+
+        def initialize(opt = nil)
+            if !opt.nil?
+                serialize_variables.each do |myattr|
+                    val = opt[myattr[:id]]
+                    instance_variable_set("@" + myattr[:id].to_s, val) if val != nil
+                end
+            end
+        end
+
+        def serialize_name
+            "Link"
+        end
+
+        def serialize_variables
+            [ :id, :integration_id, :url, :name, :description ].map {
+                |p| {
+                    :id => p,
+                    :type => :string
+                }
+            } +
+                [
+                 { :id => :created_by_reference, :type => :coworker_reference, :element_name => :created_by },
+                 { :id => :organization_reference, :type => :organization_reference, :element_name => :organization },
+                 { :id => :deal_reference, :type => :deal_reference, :element_name => :deal }
+                ]
+        end
+
+        def organization=(org)
+            @organization_reference = OrganizationReference.from_organization(org)
+
+            if org.is_a?(Organization)
+                @organization = org
+            end
+        end
+
+        def deal=(deal)
+            @deal_reference = DealReference.from_deal(deal)
+
+            if deal.is_a?(Deal)
+                @deal = deal
+            end
+        end
+
+        def created_by=(coworker)
+            @created_by_reference = CoworkerReference.from_coworker(coworker)
+
+            if coworker.is_a?(Coworker)
+                @created_by = coworker
+            end
+        end
+
+        def validate
+            error = String.new
+
+            if @url.nil? || @url.empty?
+                error = "Url is required for link\n"
+            end
+
+            if @created_by_reference.nil?
+                error = "#{error}Created_by is required for link\n"
+            end
+
+            if @organization_reference.nil? && @deal_reference.nil?
+                error = "#{error}A link must have either an organization or a deal\n"
+            end
+
+            if !@organization_reference.nil? && !@deal_reference.nil?
+                error = "#{error}A link can't be attached to both an organization and a deal"
+            end
+
+            return error
+        end
+    end
+end
+