go_import 3.0.0

data/lib/go_import/model/documents.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+module GoImport
+    #  This class is the container for all documents, ie links and
+    #  files.
+    class Documents
+        # *** TODO: add files when supported by the backend.
+
+        include SerializeHelper
+
+        attr_accessor :links
+
+        def serialize_variables
+            [
+             {:id => :links, @type => :links}
+            ]
+        end
+
+        def serialize_name
+            "Documents"
+        end
+
+        def initialize
+            @links = []
+        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
+    end
+end

data/lib/go_import/model/link.rb

@@ -0,0 +1,70 @@
+module GoImport
+    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, :type => :coworker_reference },
+                 { :id => :organization, :type => :organization_reference },
+                 { :id => :deal, :type => :deal_reference }
+                ]
+        end
+
+        def organization=(org)
+            @organization = OrganizationReference.from_organization(org)
+        end
+
+        def deal=(deal)
+            @deal = DealReference.from_deal(deal)
+        end
+
+        def created_by=(coworker)
+            @created_by = CoworkerReference.from_coworker(coworker)
+        end
+
+        def validate
+            error = String.new
+
+            if @url.nil? || @url.empty?
+                error = "Url is required for link\n"
+            end
+
+            if @created_by.nil?
+                error = "#{error}Created_by is required for link\n"
+            end
+
+            if @organization.nil? && @deal.nil?
+                error = "#{error}A link must have either an organization or a deal\n"
+            end
+
+            if !@organization.nil? && !@deal.nil?
+                error = "#{error}A link can't be attached to both an organization and a deal"
+            end
+
+            return error
+        end
+    end
+end
+

data/lib/go_import/model/note.rb

@@ -0,0 +1,97 @@
+module GoImport
+    class Note
+        include SerializeHelper
+        attr_accessor :id, :text, :integration_id, :date
+
+        attr_reader :organization, :created_by, :person, :deal
+
+        # The note's classification. It should be a value from
+        # {#NoteClassification}. 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 = NoteClassification::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, :type => :coworker_reference },
+                 { :id => :organization, :type => :organization_reference },
+                 { :id => :deal, :type => :deal_reference },
+                 { :id => :person, :type => :person_reference }
+                ]
+        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
+            "Note"
+        end
+
+        def organization=(org)
+            @organization = OrganizationReference.from_organization(org)
+        end
+
+        def created_by=(coworker)
+            @created_by = CoworkerReference.from_coworker(coworker)
+        end
+
+        def person=(person)
+            @person = PersonReference.from_person(person)
+        end
+
+        def deal=(deal)
+            @deal = DealReference.from_deal(deal)
+        end
+
+        def classification=(classification)
+            if classification == NoteClassification::Comment || classification == NoteClassification::SalesCall ||
+                    classification == NoteClassification::TalkedTo || classification == NoteClassification::TriedToReach ||
+                    classification == NoteClassification::ClientVisit
+                @classification = classification
+            else
+                raise InvalidNoteClassificationError
+            end
+
+        end
+
+        def validate
+            error = String.new
+
+            if @text.nil? || @text.empty?
+                error = "Text is required for note\n"
+            end
+
+            if @created_by.nil?
+                error = "#{error}Created_by is required for note\n"
+            end
+
+            if @organization.nil? && @deal.nil? && @person.nil?
+                error = "#{error}Organization, deal or person is required for note\n"
+            end
+
+            return error
+        end
+    end
+end

data/lib/go_import/model/note_classification.rb

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

data/lib/go_import/model/organization.rb

@@ -0,0 +1,219 @@
+require 'date'
+module GoImport
+    class OrganizationReference
+        include SerializeHelper
+        attr_accessor :id, :integration_id, :heading
+        def serialize_variables
+            [ :id, :integration_id, :heading ].map { |prop| {
+                    :id => prop, :type => :string
+                }
+            }
+        end
+
+        def initialize(opt = nil)
+            if opt != nil
+                serialize_variables.each do |var|
+                    value = opt[var[:id]]
+                    instance_variable_set("@" + var[:id].to_s, value) if value != nil
+                end
+            end
+        end
+
+        def to_s
+            return "(#{id}, #{integration_id}, #{heading})"
+        end
+
+        def empty?
+            return !@integration_id && !@id && !@heading
+        end
+
+        def self.from_organization(organization)
+            if organization.nil?
+                return nil
+            elsif organization.is_a?(Organization)
+                return organization.to_reference
+            elsif organization.is_a?(OrganizationReference)
+                return organization
+            end
+        end
+    end
+
+    class Organization
+        include SerializeHelper, ModelHasCustomFields, ModelHasTags
+
+        attr_accessor :id, :integration_id, :name, :organization_number, :email, :web_site,
+        :postal_address, :visit_address, :central_phone_number, :source_data
+
+        # Sets/gets the date when this organization's relation was
+        # changed. Default is Now.
+        attr_reader :relation_last_modified
+
+        attr_reader :employees, :responsible_coworker, :relation
+        # you add custom values by using {#set_custom_value}
+        attr_reader :custom_values
+
+        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
+
+            @relation = Relation::NoRelation if @relation.nil?
+        end
+
+        def to_reference()
+            reference = OrganizationReference.new
+            reference.id = @id
+            reference.integration_id = @integration_id
+            reference.heading = @name
+            return reference
+        end
+
+        def ==(that)
+            if that.nil?
+                return false
+            end
+
+            if that.is_a? Organization
+                return @integration_id == that.integration_id
+            end
+
+            return false
+        end
+
+        # @example Set city of postal address to 'Lund'
+        #     o.with_postal_address do |addr|
+        #         addr.city = "Lund"
+        #     end
+        # @see Address address
+        def with_postal_address
+            @postal_address = Address.new if @postal_address == nil
+            yield @postal_address
+        end
+
+        # @example Set city of visit address to 'Lund'
+        #     o.with_visit_address do |addr|
+        #         addr.city = "Lund"
+        #     end
+        # @see Address address
+        def with_visit_address
+            @visit_address = Address.new if @visit_address == nil
+            yield @visit_address
+        end
+
+        # @example Set the source to par id 4653
+        #     o.with_source do |source|
+        #          source.par_se('4653')
+        #     end
+        # @see ReferenceToSource source
+        def with_source
+            @source = ReferenceToSource.new if @source == nil
+            yield @source
+        end
+
+        # @example Add an employee and then add additional info to that employee
+        #    employee = o.add_employee({
+        #        :integration_id => "79654",
+        #        :first_name => "Peter",
+        #        :last_name => "Wilhelmsson"
+        #    })
+        #    employee.direct_phone_number = '+234234234'
+        #    employee.currently_employed = true
+        # @see Person employee
+        def add_employee(val)
+            @employees = [] if @employees == nil
+            person = if val.is_a? Person then val else Person.new(val) end
+            @employees.push(person)
+            person
+        end
+
+        def responsible_coworker=(coworker)
+            @responsible_coworker = CoworkerReference.from_coworker(coworker)
+        end
+
+        # Sets the organization's relation to the specified value. The
+        # relation must be a valid value from the Relation module
+        # otherwise an InvalidRelationError error will be thrown.
+        def relation=(relation)
+            if relation == Relation::NoRelation || relation == Relation::WorkingOnIt ||
+                    relation == Relation::IsACustomer || relation == Relation::WasACustomer || relation == Relation::BeenInTouch
+                @relation = relation
+                @relation_last_modified = Time.now.strftime("%Y-%m-%d") if @relation_last_modified.nil? &&
+                    @relation != Relation::NoRelation
+            else
+                raise InvalidRelationError
+            end
+        end
+
+        def relation_last_modified=(date)
+            begin
+                @relation_last_modified = @relation != Relation::NoRelation ? Date.parse(date).strftime("%Y-%m-%d") : nil
+            rescue
+                raise InvalidValueError, date
+            end
+        end
+
+        def find_employee_by_integration_id(integration_id)
+            return nil if @employees.nil?
+            return @employees.find do |e|
+                e.integration_id == integration_id
+            end
+        end
+
+        def serialize_variables
+            [
+             { :id => :id, :type => :string },
+             { :id => :integration_id, :type => :string },
+             { :id => :source, :type => :source_ref },
+             { :id => :name, :type => :string },
+             { :id => :organization_number, :type => :string },
+             { :id => :postal_address, :type => :address },
+             { :id => :visit_address, :type => :address },
+             { :id => :central_phone_number, :type => :string },
+             { :id => :email, :type => :string },
+             { :id => :web_site, :type => :string },
+             { :id => :employees, :type => :persons },
+             { :id => :custom_values, :type => :custom_values },
+             { :id => :tags, :type => :tags },
+             { :id => :responsible_coworker, :type => :coworker_reference},
+             { :id => :relation, :type => :string },
+             { :id => :relation_last_modified, :type => :string }
+            ]
+        end
+
+        def serialize_name
+            "Organization"
+        end
+
+        def to_s
+            return "#{name}"
+        end
+
+        def validate
+            error = String.new
+
+            if @name.nil? || @name.empty?
+                error = "A name is required for organization.\n#{serialize()}"
+            end
+
+            if !@source.nil?
+                if @source.id.nil? || @source.id == ""
+                    error = "#{error}\nReference to source must have an id"
+                end
+            end
+
+            if @employees != nil
+                @employees.each do |person|
+                    validation_message = person.validate()
+                    if !validation_message.empty?
+                        error = "#{error}\n#{validation_message}"
+                    end
+                end
+            end
+
+            return error
+        end
+    end
+end

data/lib/go_import/model/person.rb

@@ -0,0 +1,151 @@
+module GoImport
+    class PersonReference
+        include SerializeHelper
+        attr_accessor :id, :integration_id
+        def serialize_variables
+            [ :id, :integration_id ].map { |prop| {:id=>prop,:type=>:string} }
+        end
+
+        def initalize()
+        end
+
+        def to_s
+            return "(#{id}, #{integration_id})"
+        end
+
+        def empty?
+            return !@integration_id && !@id
+        end
+
+        def self.from_person(person)
+            if person.nil?
+                return nil
+            elsif person.is_a?(Person)
+                return person.to_reference
+            elsif person.is_a?(PersonReference)
+                return person
+            end
+        end
+    end
+
+    class Person < PersonReference
+        include SerializeHelper, ModelHasCustomFields, ModelHasTags
+        attr_accessor :first_name, :last_name,
+            :direct_phone_number, :fax_phone_number, :mobile_phone_number, :home_phone_number,
+            :position, :email, :alternative_email, :postal_address, :currently_employed
+
+        # you add custom values by using {#set_custom_value}
+        attr_reader :custom_values, :organization
+
+        def initialize(opt = nil)
+            @currently_employed = true
+            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 organization=(org)
+            @organization = OrganizationReference.from_organization(org)
+        end
+
+        # @example Set city of postal address to 'Lund'
+        #     p.with_postal_address do |addr|
+        #         addr.city = "Lund"
+        #     end
+        # @see Address address
+        def with_postal_address
+            @postal_address = Address.new if @postal_address == nil
+            yield @postal_address
+        end
+
+        # @example Set the source to par id 4653
+        #     p.with_source do |source|
+        #          source.par_se('4653')
+        #     end
+        # @see ReferenceToSource source
+        def with_source
+            @source = ReferenceToSource.new if @source == nil
+            yield @source
+        end
+
+        def tags
+            @tags
+        end
+
+        def serialize_name
+            "Person"
+        end
+
+        def serialize_variables
+            [
+             {:id => :id, :type => :string},
+             {:id => :integration_id, :type => :string},
+             {:id => :source, :type => :source_ref},
+             {:id => :first_name, :type => :string},
+             {:id => :last_name, :type => :string},
+
+             {:id => :direct_phone_number, :type => :string},
+             {:id => :fax_phone_number, :type => :string},
+             {:id => :mobile_phone_number, :type => :string},
+             {:id => :home_phone_number, :type => :string},
+
+             {:id => :position, :type => :string},
+
+             {:id => :tags, :type => :tags},
+
+             {:id => :email, :type => :string},
+             {:id => :alternative_email, :type => :string},
+
+             {:id => :postal_address, :type => :address},
+             {:id => :custom_values, :type => :custom_values},
+             {:id => :currently_employed, :type => :bool},
+             {:id => :organization, :type => :organization_reference},
+
+            ]
+        end
+
+        def to_reference()
+            reference = PersonReference.new
+            reference.id = @id
+            reference.integration_id = @integration_id
+            return reference
+        end
+
+        def get_import_rows
+            (serialize_variables + [ { :id => :organization, :type => :organization_reference } ]).map do |p|
+                map_to_row p
+            end
+        end
+
+        def to_s
+            return "#{first_name} #{last_name}"
+        end
+
+        def validate
+            error = String.new
+
+            if (@first_name.nil? || @first_name.empty?) &&
+                    (@last_name.nil? || @last_name.empty?)
+                error = "A firstname or lastname is required for person.\n#{serialize()}"
+            end
+
+            return error
+        end
+
+        def parse_name_to_firstname_lastname_se(name, when_missing = '')
+            if name.nil? or name.empty?
+                @first_name = when_missing
+                return
+            end
+
+            splitted = name.split(' ')
+            @first_name = splitted[0]
+            if splitted.length > 1
+                @last_name = splitted.drop(1).join(' ')
+            end
+        end
+    end
+end

data/lib/go_import/model/referencetosource.rb

@@ -0,0 +1,46 @@
+module GoImport
+    class ReferenceToSource
+        include SerializeHelper
+        attr_accessor :name, :id, :format
+
+        def serialize_variables
+            [:name, :format, :id].map { |prop| { :id => prop, :type => :string } }
+        end
+
+        def serialize_name
+            "ReferenceToSource"
+        end
+
+        def get_import_rows
+            (serialize_variables + [{ :id => :value, :type => :string }]).map do |p|
+                map_to_row p
+            end
+        end
+
+        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 to_s
+            return "#{@name}_#{@format}_#{@id}"
+        end
+
+        def ==(other)
+            if other==nil 
+                return false
+            end
+            return @name == other.name && @id == other.id && @format== other.format
+        end
+        # Sets the id of this instance to the parameter supplied. Will also set {#name} and {#format} so that this reference is identified as a PAR identifier by Go.
+        def par_se(id)
+            @name = 'pase'
+            @format = 'External'
+            @id = id
+        end
+    end
+end

data/lib/go_import/model/relation.rb

@@ -0,0 +1,23 @@
+module GoImport
+    module Relation
+        # This is the default, we have not been in contact with this
+        # organization in any way.
+        NoRelation = 0
+
+        # Something is happening with this organization, we might have
+        # booked a meeting with them or created a deal, etc.
+        WorkingOnIt = 1
+
+        # We have made a deal with this organization.
+        IsACustomer = 2
+
+        # We have made a deal with this organization but it was some
+        # time ago and we don't consider them a customer any more.
+        WasACustomer = 3
+
+        # We had something going with this organization but we
+        # couldn't close the deal and we don't think they will be a
+        # customer to us in the foreseeable future.
+        BeenInTouch = 4
+    end
+end