fruit_to_lime 2.3.1 → 2.3.2

data/lib/fruit_to_lime/model/class_settings.rb

@@ -23,7 +23,7 @@ module FruitToLime
 
         # Set custom field. If there is already an existing custom field, then it is overwritten.
         def set_custom_field(obj)
-            @custom_fields = [] if @custom_fields==nil
+            @custom_fields = [] if @custom_fields == nil
 
             if obj.is_a?(CustomField)
                 field = obj
@@ -31,7 +31,11 @@ module FruitToLime
                 field = CustomField.new(obj)
             end
 
-            index = @custom_fields.find_index do |custom_field| 
+            if field.integration_id == "" && field.id == ""
+                raise InvalidCustomFieldError, "Custom field must have either id or integration_id"
+            end
+
+            index = @custom_fields.find_index do |custom_field|
                 custom_field.same_as?(field)
             end
             if index
@@ -42,6 +46,5 @@ module FruitToLime
 
             return field
         end
-
     end
-end
+end

data/lib/fruit_to_lime/model/coworker.rb

@@ -16,7 +16,7 @@ module FruitToLime
 
         def serialize_variables
             [
-             :id, :integration_id, :email, :first_name, :last_name, 
+             :id, :integration_id, :email, :first_name, :last_name,
              :direct_phone_number, :mobile_phone_number, :home_phone_number
             ].map {|p| { :id => p, :type => :string } }
         end
@@ -54,7 +54,7 @@ module FruitToLime
 
             splitted = name.split(' ')
             @first_name = splitted[0]
-            if splitted.length > 1                
+            if splitted.length > 1
                 @last_name = splitted.drop(1).join(' ')
             end
         end

data/lib/fruit_to_lime/model/coworker_reference.rb

@@ -19,5 +19,15 @@ module FruitToLime
         def serialize_name
             "CoworkerReference"
         end
+
+        def self.from_coworker(coworker)
+            if coworker.nil?
+                return nil
+            elsif coworker.is_a?(Coworker)
+                return coworker.to_reference
+            elsif coworker.is_a?(CoworkerReference)
+                return coworker
+            end
+        end
     end
 end

data/lib/fruit_to_lime/model/deal.rb

@@ -3,10 +3,10 @@ module FruitToLime
     class Deal
         include SerializeHelper, ModelHasCustomFields, ModelHasTags
 
-        attr_accessor :id, :integration_id, :name, :description, :probability, :value, :order_date, :customer,
+        attr_accessor :id, :integration_id, :name, :description, :probability, :value, :order_date,
         :responsible_coworker, :customer_contact, :status
         # you add custom values by using {#set_custom_value}
-        attr_reader :custom_values
+        attr_reader :custom_values, :customer
 
         def serialize_variables
             [ :id, :integration_id, :name, :description, :probability, :value, :order_date ].map {
@@ -29,7 +29,13 @@ module FruitToLime
             "Deal"
         end
 
-        def initialize()
+        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
@@ -51,5 +57,8 @@ module FruitToLime
             yield @status
         end
 
+        def customer=(customer)
+            @customer = OrganizationReference.from_organization(customer)
+        end
     end
 end

data/lib/fruit_to_lime/model/note.rb

@@ -1,7 +1,18 @@
 module FruitToLime
     class Note
         include SerializeHelper
-        attr_accessor :id, :text, :integration_id, :classification, :date, :created_by, :organization, :person
+        attr_accessor :id, :text, :integration_id, :classification, :date
+
+        attr_reader :organization, :created_by, :person
+
+        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, :text, :integration_id, :classification ].map {
@@ -30,5 +41,35 @@ module FruitToLime
         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 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?
+                error = "#{error}Organization is required for note\n"
+            end
+
+            return error
+        end
     end
 end

data/lib/fruit_to_lime/model/organization.rb

@@ -1,5 +1,5 @@
 module FruitToLime
-   class OrganizationReference
+    class OrganizationReference
         include SerializeHelper
         attr_accessor :id, :integration_id, :heading
         def serialize_variables
@@ -9,7 +9,13 @@ module FruitToLime
             }
         end
 
-        def initalize()
+        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
@@ -19,6 +25,16 @@ module FruitToLime
         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
@@ -31,7 +47,13 @@ module FruitToLime
         # you add custom values by using {#set_custom_value}
         attr_reader :custom_values
 
-        def initialize()
+        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_reference()
@@ -76,8 +98,8 @@ module FruitToLime
 
         # @example Set the source to par id 4653
         #     o.with_source do |source|
-        #          source.par_se('4653') 
-        #     end 
+        #          source.par_se('4653')
+        #     end
         # @see ReferenceToSource source
         def with_source
             @source = ReferenceToSource.new if @source == nil
@@ -87,7 +109,7 @@ module FruitToLime
         # @example Set the responsible coworker of the organization to the coworker with integration id 943
         #     o.with_responsible_coworker do |responsible_coworker|
         #          responsible_coworker.integration_id = "943"
-        #     end 
+        #     end
         # @see CoworkerReference responsible_coworker
         def with_responsible_coworker
             @responsible_coworker = CoworkerReference.new if @responsible_coworker==nil
@@ -151,7 +173,7 @@ module FruitToLime
         def to_s
             return "#{name}"
         end
-        
+
         def validate
             error = String.new
 

data/lib/fruit_to_lime/model/person.rb

@@ -8,22 +8,34 @@ module FruitToLime
 
         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 coworker.is?(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,
-            :organization
+            :position, :email, :alternative_email, :postal_address, :currently_employed
+
         # you add custom values by using {#set_custom_value}
-        attr_reader :custom_values
+        attr_reader :custom_values, :organization
 
         def initialize(opt = nil)
             @currently_employed = true
@@ -34,6 +46,11 @@ module FruitToLime
                 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"
@@ -46,8 +63,8 @@ module FruitToLime
 
         # @example Set the source to par id 4653
         #     p.with_source do |source|
-        #          source.par_se('4653') 
-        #     end 
+        #          source.par_se('4653')
+        #     end
         # @see ReferenceToSource source
         def with_source
             @source = ReferenceToSource.new if @source == nil
@@ -76,9 +93,9 @@ module FruitToLime
              {:id => :home_phone_number, :type => :string},
 
              {:id => :position, :type => :string},
-             
+
              {:id => :tags, :type => :tags},
-             
+
              {:id => :email, :type => :string},
              {:id => :alternative_email, :type => :string},
 
@@ -86,7 +103,7 @@ module FruitToLime
              {:id => :custom_values, :type => :custom_values},
              {:id => :currently_employed, :type => :bool},
              {:id => :organization, :type => :organization_reference},
-             
+
             ]
         end
 
@@ -126,7 +143,7 @@ module FruitToLime
 
             splitted = name.split(' ')
             @first_name = splitted[0]
-            if splitted.length > 1                
+            if splitted.length > 1
                 @last_name = splitted.drop(1).join(' ')
             end
         end

data/lib/fruit_to_lime/model/rootmodel.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 module FruitToLime
-    # The root model for Go import. This class is the container for everything else.  
+    # The root model for Go import. This class is the container for everything else.
     class RootModel
         # the import_coworker is a special coworker that is set as
         # responsible for objects that requires a coworker, eg a note.
         attr_accessor :import_coworker
-        
+
         attr_accessor :settings, :organizations, :coworkers, :deals, :notes
         def serialize_variables
             [
@@ -43,7 +43,7 @@ module FruitToLime
         #        :last_name=>"Anka",
         #        :email=>"kalle.anka@vonanka.com"
         #    })
-        # 
+        #
         # @example Add a coworker from a new coworker
         #    coworker = FruitToLime::Coworker.new
         #    coworker.integration_id = "123"
@@ -67,19 +67,135 @@ module FruitToLime
             end
 
             coworker = Coworker.new(coworker) if !coworker.is_a?(Coworker)
-            
-            if find_coworker_by_integration_id(coworker.integration_id)!=nil
+
+            if find_coworker_by_integration_id(coworker.integration_id) != nil
                 raise AlreadyAddedError, "Already added a coworker with integration_id #{coworker.integration_id}"
             end
 
             @coworkers.push(coworker)
+
+            return coworker
         end
 
-        # TODO! Remove, it's obsolete
-        # @!visibility private
-        def add_note(text)
+        # Adds the specifed organization object to the model.
+        # @example Add an organization from a hash
+        #    rootmodel.add_organization({
+        #        :integration_id => "123",
+        #        :name => "Beagle Boys",
+        #    })
+        #
+        # @example Add an organization from a new organization
+        #    organization = FruitToLime::Organization.new
+        #    organization.integration_id = "123"
+        #    organization.name = "Beagle Boys"
+        #    rootmodel.add_organization(organization)
+        #
+        # @example If you want to keep adding organizations and dont
+        # care about duplicates not being added. Your model might not
+        # be saved due to duplicate integration_ids.
+        #    begin
+        #       rootmodel.add_organization(organization)
+        #    rescue FruitToLime::AlreadyAddedError
+        #       puts "Warning: already added organization"
+        #    end
+        # @see Coworker
+        def add_organization(organization)
+            @organizations = [] if @organizations.nil?
+
+            if organization.nil?
+                raise "Missing organization to add"
+            end
+
+            organization = Organization.new(organization) if !organization.is_a?(Organization)
+
+            if find_organization_by_integration_id(organization.integration_id) != nil
+                raise AlreadyAddedError, "Already added an organization with integration_id #(organization.integration_id)"
+            end
+
+            @organizations.push(organization)
+
+            return organization
+        end
+
+        # Adds the specifed deal object to the model.
+        # @example Add an deal from a hash
+        #    rootmodel.add_deal({
+        #        :integration_id => "123",
+        #        :name => "Big deal",
+        #    })
+        #
+        # @example Add a deal from a new deal
+        #    deal = FruitToLime::Deal.new
+        #    deal.integration_id = "123"
+        #    deal.name = "Big deal"
+        #    rootmodel.add_deal(deal)
+        #
+        # @example If you want to keep adding deals and dont
+        # care about duplicates not being added. Your model might not
+        # be saved due to duplicate integration_ids.
+        #    begin
+        #       rootmodel.add_deal(deal)
+        #    rescue FruitToLime::AlreadyAddedError
+        #       puts "Warning: already added deal"
+        #    end
+        # @see Coworker
+        def add_deal(deal)
+            @deals = [] if @deals.nil?
+
+            if deal.nil?
+                raise "Missing deal to add"
+            end
+
+            deal = Deal.new(deal) if !deal.is_a?(Deal)
+
+            if find_deal_by_integration_id(deal.integration_id) != nil
+                raise AlreadyAddedError, "Already added a deal with integration_id #{deal.integration_id}"
+            end
+
+            @deals.push(deal)
+
+            return deal
+        end
+
+        # Adds the specifed note object to the model.
+        # @example Add an deal from a hash
+        #    rootmodel.add_note({
+        #        :integration_id => "123",
+        #        :text => "This is a note",
+        #    })
+        #
+        # @example Add a note from a new note
+        #    note = FruitToLime::Note.new
+        #    note.integration_id = "123"
+        #    note.text = "Big deal"
+        #    rootmodel.add_note(note)
+        #
+        # @example If you want to keep adding deals and dont
+        # care about duplicates not being added. Your model might not
+        # be saved due to duplicate integration_ids.
+        #    begin
+        #       rootmodel.add_deal(deal)
+        #    rescue FruitToLime::AlreadyAddedError
+        #       puts "Warning: already added deal"
+        #    end
+        # @see Coworker
+        def add_note(note)
             @notes = [] if @notes == nil
-            @notes.push(if text.is_a? Note then text else Note.new(text) end)
+
+            if note.nil?
+                raise "Missing note to add"
+            end
+
+            note = Note.new(note) if !note.is_a?(Note)
+
+            if (!note.integration_id.nil? && note.integration_id.length > 0) &&
+                    find_note_by_integration_id(note.integration_id) != nil
+                raise AlreadyAddedError, "Already added a note with integration_id #{note.integration_id}"
+            end
+
+            @notes.push(note)
+
+            return note
         end
 
         def with_new_note
@@ -102,6 +218,12 @@ module FruitToLime
             end
         end
 
+        def find_note_by_integration_id(integration_id)
+            return @notes.find do |note|
+                note.integration_id == integration_id
+            end
+        end
+
         # find deals for organization using {Organization#integration_id}
         def find_deals_for_organization(organization)
             deals = []
@@ -113,6 +235,12 @@ module FruitToLime
             return deals
         end
 
+        def find_deal_by_integration_id(integration_id)
+            return @deals.find do |deal|
+                deal.integration_id == integration_id
+            end
+        end
+
         # Returns a string describing problems with the data. For instance if integration_id for any entity is not unique.
         def sanity_check
             error = String.new
@@ -164,6 +292,14 @@ module FruitToLime
                 end
             end
 
+            @notes.each do |note|
+                validation_message = note.validate
+
+                if !validation_message.empty?
+                    error = "#{error}\n#{validation_message}"
+                end
+            end
+
             return error.strip
         end
 

data/lib/fruit_to_lime/phone_helper.rb

@@ -0,0 +1,74 @@
+require 'global_phone'
+
+module FruitToLime
+    # The PhoneHelper helps you parse and format phone number strings
+    # into pretty looking numbers.
+    class PhoneHelper
+        GlobalPhone.db_path = File.join(File.dirname(__FILE__), 'global_phone.json')
+        GlobalPhone.default_territory_name = :se
+
+        # Sets the country code used during parsning. The default is
+        # swedish (:se) and if you are parsing swedish numbers you
+        # dont need to set the country code.
+        def self.set_country_code(country_code)
+            GlobalPhone.default_territory_name = country_code
+        end
+
+        # Parses the specifed number_string and returns only valid
+        # numbers.
+        # @see parse_numbers
+        def self.parse_numbers_strict(number_string, delimiters = ',')
+            parse_numbers number_string, delimiters, true
+        end
+
+        # Parses the specified number_string into one or more phone
+        # numbers using the specified delimiters. If strict_mode is
+        # true only valid numbers are returned, otherwise are invalid
+        # numbers returned as found in the number_string.
+        #
+        # @example Parse a number
+        #    number = FruitToLime::PhoneHelper.parse_numbers("046 - 270 48 00")
+        #
+        # @example Parses a string with two numbers and a custom delimiter
+        #    source = "046 - 270 48 00/ 031-712 44 00"
+        #    number1, number2 = FruitToLime::PhoneHelper.parse_numbers(source, '/')
+        def self.parse_numbers(number_string, delimiters = ',', strict_mode = false)
+            numbers = []
+
+            if delimiters.is_a?(Array)
+                # we have several delimiters, replace all delimiters
+                # in the number_string with the first delimiter
+                delimiters.each do |del|
+                    number_string = number_string.sub(del, delimiters[0])
+                end
+                delimiter = delimiters[0]
+            elsif delimiters.is_a?(String)
+                delimiter = delimiters
+            else
+                raise "delimiters should be either a string or and array of strings"
+            end
+
+            number_string.split(delimiter).each do |possible_number|
+                if !possible_number.empty?
+                    number = GlobalPhone.parse([possible_number])
+
+                    if !number.nil? && number.valid?
+                        numbers.push number.to_s
+                    else
+                        if !strict_mode
+                            numbers.push possible_number
+                        end
+                    end
+                end
+            end
+
+            if numbers.length == 0
+                return ""
+            elsif numbers.length == 1
+                return numbers[0]
+            else
+                return numbers
+            end
+        end
+    end
+end

data/lib/fruit_to_lime.rb

@@ -3,12 +3,15 @@ module FruitToLime
     def self.require_all_in(folder)
         Dir.glob(File.join( File.dirname(File.absolute_path(__FILE__)),folder), &method(:require))
     end
-    
+
     require 'fruit_to_lime/errors'
     require 'fruit_to_lime/serialize_helper'
     require 'fruit_to_lime/model_helpers'
     FruitToLime::require_all_in 'fruit_to_lime/model/*.rb'
     require 'fruit_to_lime/csv_helper'
     require 'fruit_to_lime/roo_helper'
+    require 'fruit_to_lime/phone_helper'
+    require 'fruit_to_lime/email_helper'
+    require 'fruit_to_lime/excel_helper'
     require 'fruit_to_lime/templating'
 end

data/spec/class_settings_spec.rb

@@ -7,11 +7,31 @@ describe "ClassSettings" do
     }
 
     it "can set custom field and if there is already an existing custom field, then it is overwritten." do
-        class_settings.set_custom_field({:integration_id=>"link_to_bi_system", :title=>"Link to BI system"})
-        class_settings.set_custom_field({:integration_id=>"link_to_bi_system", :title=>"Link to BI system 2"})
+        class_settings.set_custom_field({:integration_id => "link_to_bi_system", :title => "Link to BI system"})
+        class_settings.set_custom_field({:integration_id => "link_to_bi_system", :title => "Link to BI system 2"})
         class_settings.custom_fields.length.should eq 1
-        class_settings.custom_fields[0].title.should eq "Link to BI system 2" 
+        class_settings.custom_fields[0].title.should eq "Link to BI system 2"
     end
 
+    it "should not allow new custom fields without id and integration id" do
+        begin
+            class_settings.set_custom_field({:integration_id => "", :id => "", :title => "Link to BI system"})
+        rescue
+        end
+
+        class_settings.custom_fields.length.should eq 0
+    end
+
+    it "should allow new custom field with integration_id" do
+        class_settings.set_custom_field({:integration_id => "link_to_bi_system", :title => "Link to BI system"})
+        class_settings.custom_fields.length.should eq 1
+        class_settings.custom_fields[0].title.should eq "Link to BI system"
+    end
+
+    it "should allow new custom field with id" do
+        class_settings.set_custom_field({:id => "123", :title => "Link to BI system"})
+        class_settings.custom_fields.length.should eq 1
+        class_settings.custom_fields[0].title.should eq "Link to BI system"
+    end
 end