fruit_to_lime 2.5.6 → 2.5.7

data/lib/fruit_to_lime/model/rootmodel.rb

@@ -62,8 +62,8 @@ module FruitToLime
         def add_coworker(coworker)
             @coworkers = [] if @coworkers == nil
 
-            if coworker == nil
-                raise "Missing coworker to add!"
+            if coworker.nil?
+                return nil
             end
 
             coworker = Coworker.new(coworker) if !coworker.is_a?(Coworker)
@@ -103,7 +103,7 @@ module FruitToLime
             @organizations = [] if @organizations.nil?
 
             if organization.nil?
-                raise "Missing organization to add"
+                return nil
             end
 
             organization = Organization.new(organization) if !organization.is_a?(Organization)
@@ -143,7 +143,7 @@ module FruitToLime
             @deals = [] if @deals.nil?
 
             if deal.nil?
-                raise "Missing deal to add"
+                return nil
             end
 
             deal = Deal.new(deal) if !deal.is_a?(Deal)
@@ -187,8 +187,8 @@ module FruitToLime
             @notes = [] if @notes == nil
 
             if note.nil?
-                raise "Missing note to add"
-            end
+                return nil
+             end
 
             note = Note.new(note) if !note.is_a?(Note)
 
@@ -202,13 +202,13 @@ module FruitToLime
             return note
         end
 
-        def with_new_note
-            @notes = [] if @notes == nil
+        # def with_new_note
+        #     @notes = [] if @notes == nil
 
-            note = Note.new
-            @notes.push note
-            yield note
-        end
+        #     note = Note.new
+        #     @notes.push note
+        #     yield note
+        # end
 
         def find_coworker_by_integration_id(integration_id)
             return @coworkers.find do |coworker|
@@ -335,7 +335,7 @@ module FruitToLime
 
         def with_non_empty_integration_id(objects)
             return objects.select do |obj|
-                obj.integration_id!=nil && !obj.integration_id.empty?
+                obj.integration_id != nil && !obj.integration_id.empty?
             end
         end
     end

data/spec/rootmodel_spec.rb

@@ -191,6 +191,39 @@ describe "RootModel" do
         rootmodel.notes.length.should eq 1
     end
 
+    it "will not add a nil note" do
+        # given, when
+        rootmodel.add_note(nil)
+
+        # then
+        rootmodel.notes.length.should eq 0
+    end
+
+    it "will not add a nil organization" do
+        # given, when
+        rootmodel.add_organization(nil)
+
+        # then
+        rootmodel.organizations.length.should eq 0
+    end
+
+    it "will not add a nil deal" do
+        # given, when
+        rootmodel.add_deal(nil)
+
+        # then
+        rootmodel.deals.length.should eq 0
+    end
+
+    it "will not add a nil coworker" do
+        # given, when
+        rootmodel.add_coworker(nil)
+
+        # then
+        # 1 since we always have the import coworker
+        rootmodel.coworkers.length.should eq 1
+    end
+
     it "will not add a new organizations when the organizations is already added (same integration id)" do
         # given
         rootmodel.add_note({

data/templates/easy/lib/tomodel.rb

@@ -7,7 +7,7 @@ class Exporter
     def to_coworker(row)
         coworker = FruitToLime::Coworker.new
         # integration_id is typically the userId in Easy
-        # Must be set to be able to import the same file more 
+        # Must be set to be able to import the same file more
         # than once without creating duplicates
         coworker.integration_id = row['userId']
         coworker.parse_name_to_firstname_lastname_se(row['Name'])
@@ -15,20 +15,21 @@ class Exporter
         return coworker
     end
 
-    # turns a row from the Easy exported Company.txt file into
-    # a fruit_to_lime model that is used to generate xml
-    # Uses rootmodel to locate other related stuff such coworker
-    def to_organization(row, rootmodel, coworkers)
+    # Turns a row from the Easy exported Company.txt file into a
+    # fruit_to_lime model that is used to generate xml
+    def to_organization(row, coworkers)
         organization = FruitToLime::Organization.new
         # integration_id is typically the company Id in Easy
-        # Must be set to be able to import the same file more 
+        # Must be set to be able to import the same file more
         # than once without creating duplicates
-        
+
         # Easy standard fields
         organization.integration_id = row['companyId']
         organization.name = row['company name']
         organization.central_phone_number = row['Telephone']
 
+        # NOTE!! if a bisnode-id is present maybe you want to
+        # consider not setting this.
         # 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
@@ -44,15 +45,16 @@ class Exporter
         organization.email = row['e-mail']
         organization.web_site = row['website']
 
+        # Same as postal address
         organization.with_visit_address do |addr|
             addr.street = row['visit street']
             addr.zip_code = row['visit zip']
             addr.city = row['visit city']
         end
-        
+
         # Set Bisnode Id if present
         bisnode_id = row['Bisnode-id']
-        
+
         if bisnode_id && !bisnode_id.empty?
             organization.with_source do |source|
                 source.par_se(bisnode_id)
@@ -64,10 +66,10 @@ class Exporter
             organization.organization_number = row['orgnr']
         end
 
+        # Responsible coworker for the organization.
+        # For instance responsible sales rep.
         coworker_id = coworkers[row['userIndex - our reference']]
-        organization.responsible_coworker = rootmodel.find_coworker_by_integration_id(coworker_id)
-        
-        # relation
+        organization.responsible_coworker = @rootmodel.find_coworker_by_integration_id(coworker_id)
 
         # Tags are set and defined at the same place
         # Setting a tag: Imported is useful for the user
@@ -78,13 +80,41 @@ class Exporter
         # has the options "A-customer", "B-customer", and "C-customer"
         organization.set_tag(row['customer category'])
 
+        # Relation
+        # let's say that there is a option field in Easy called 'Customer relation'
+        # with the options '1.Customer', '2.Prospect' '3.Partner' and '4.Lost customer'
+        if row['Customer relation'] == '1.Customer'
+            # We have made a deal with this organization.
+            organization.relation = Relation::IsACustomer
+        elsif row['Customer relation'] == '3.Partner'
+            # We have made a deal with this organization.
+            organization.relation = Relation::IsACustomer
+        elsif row['Customer relation'] == '2.Prospect'
+            # Something is happening with this organization, we might have
+            # booked a meeting with them or created a deal, etc.
+            organization.relation = Relation::WorkingOnIt
+        elsif row['Customer relation'] == '4.Lost customer'
+            # 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.
+            organization.relation = Relation::BeenInTouch
+        else
+            organization.relation = Relation::NoRelation
+        end
+
         return organization
     end
 
-    def to_person(row, rootmodel)
+    # Turns a row from the Easy exported Company-Person.txt file into
+    # a fruit_to_lime model that is used to generate xml
+    def to_person(row)
         person = FruitToLime::Person.new
-        
-        # Easy standard fields
+
+        # Easy standard fields created in configure method Easy
+        # persons don't have a globally unique Id, they are only
+        # unique within the scope of the company, so we combine the
+        # referenceId and the companyId to make a globally unique
+        # integration_id
         person.integration_id = "#{row['referenceId']}-#{row['companyId']}"
         person.first_name = row['First name']
         person.last_name = row['Last name']
@@ -95,100 +125,122 @@ class Exporter
         person.email = row['e-mail']
         person.position = row['position']
 
-        person.set_custom_value("intrests", row['intrests'])
+        # Populate a Go custom field
         person.set_custom_value("shoe_size", row['shoe size'])
-        
+
         # Tags
         person.set_tag("Imported")
 
+        # Checkbox fields
         # Xmas card field is a checkbox in Easy
         if row['Xmas card'] == "1"
             person.set_tag("Xmas card")
         end
 
+        # Multioption fields or "Set"- fields
+        intrests = row['intrests'].split(';')
+        intrests.each do |intrest|
+            person.set_tag(intrest)
+        end
+
         # set employer connection
-        employer = rootmodel.find_organization_by_integration_id(row['companyId'])
+        employer = @rootmodel.find_organization_by_integration_id(row['companyId'])
         if employer
             employer.add_employee person
         end
     end
 
-    def to_deal(row, rootmodel, includes, coworkers)
+    # Turns a row from the Easy exported Project.txt file into
+    # a fruit_to_lime model that is used to generate xml.
+    # Uses includes hash to lookup organizations to connect
+    # Uses coworkers hash to lookup coworkers to connect
+    def to_deal(row, includes, coworkers)
         deal = FruitToLime::Deal.new
         # Easy standard fields
         deal.integration_id = row['projectId']
         deal.name = row['Name']
         deal.description = row['Description']
 
-        # Easy superfields        
+        # Easy superfields
         deal.order_date = row[' order date']
 
         coworker_id = coworkers[row['userIndex']]
-        deal.responsible_coworker = rootmodel.find_coworker_by_integration_id coworker_id
-        
-        # should be integer
-        # make the currency used in Easy matches the one used in Go
+        deal.responsible_coworker = @rootmodel.find_coworker_by_integration_id coworker_id
+
+        # Should be integer
+        # The currency used in Easy should match the one used in Go
         deal.value = row['value']
 
         # should be between 0 - 100
         # remove everything that is not an intiger
         deal.probability = row['probability'].gsub(/[^\d]/,"").to_i
 
+        # Create a status object and set it's label to the value of the Easy field
         deal.status = FruitToLime::DealStatus.new
-            deal.status.label = row['Status']
-        
+        deal.status.label = row['Status']
 
-        # tags
+        # Tags
         deal.set_tag("Imported")
 
-        # find stuff connected to deal
+        # Make the deal - organization connection
         if includes
             organization_id = includes[row['projectId']]
-            organization = rootmodel.find_organization_by_integration_id(organization_id)
+            organization = @rootmodel.find_organization_by_integration_id(organization_id)
             if organization
                 deal.customer = organization
             end
         end
-        
+
         return deal
     end
 
-    def to_organization_note(row, rootmodel, coworkers, people)
-        note = FruitToLime::Note.new()
-        
-        organization = rootmodel.find_organization_by_integration_id(row['companyId'])
-        
+    # Turns a row from the Easy exported Company-History.txt file into
+    # a fruit_to_lime model that is used to generate xml.
+    # Uses coworkers hash to lookup coworkers to connect
+    # Uses people hash to lookup persons to connect
+    def to_organization_note(row, coworkers, people)
+        organization = @rootmodel.find_organization_by_integration_id(row['companyId'])
+
         coworker_id = coworkers[row['userIndex']]
-        coworker = rootmodel.find_coworker_by_integration_id(coworker_id)
+        coworker = @rootmodel.find_coworker_by_integration_id(coworker_id)
 
         if organization && coworker
+            note = FruitToLime::Note.new()
             note.organization = organization
             note.created_by = coworker
             note.person = organization.find_employee_by_integration_id(people[row['personIndex']])
             note.date = row['Date']
             note.text = "#{row['Category']}: #{row['History']}"
 
-            rootmodel.add_note(note) unless note.text.empty?
+            return note.text.empty? ? nil : note
         end
 
         return note
     end
 
-    def to_deal_note(row, rootmodel, coworkers)
+    # Turns a row from the Easy exported Project-History.txt file into
+    # a fruit_to_lime model that is used to generate xml
+    # Uses coworkers hash to lookup coworkers to connect
+    def to_deal_note(row, coworkers)
+        # 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
+        # it's not a straight forward task
         note = FruitToLime::Note.new()
 
-        deal = rootmodel.find_deal_by_integration_id(row['projectId'])
-        
+        deal = @rootmodel.find_deal_by_integration_id(row['projectId'])
+
         coworker_id = coworkers[row['userIndex']]
-        coworker = rootmodel.find_coworker_by_integration_id(coworker_id)
+        coworker = @rootmodel.find_coworker_by_integration_id(coworker_id)
 
         if deal && coworker
             note.deal = deal
             note.created_by = coworker
             note.date = row['Date']
+            # Raw history looks like this <category>: <person>: <text>
             note.text = row['RawHistory']
 
-            rootmodel.add_note(note) unless note.text.empty?
+            return note.text.empty? ? nil : note
         end
 
         return note
@@ -200,8 +252,7 @@ class Exporter
         # :String and :Link. If no type is specified :String is used
         # as default.
         model.settings.with_person  do |person|
-            person.set_custom_field( { :integration_id => 'intrests', :title => 'Intrests', :type => :String} )
-            person.set_custom_field( { :integration_id => 'shoe_size', :title => 'Shoe size'} )
+            person.set_custom_field( { :integration_id => 'shoe_size', :title => 'Shoe size', :type => :String} )
         end
     end
 
@@ -219,12 +270,12 @@ class Exporter
     def to_model(coworkers_filename, organization_filename, persons_filename, orgnotes_filename, includes_filename, deals_filename, dealnotes_filename)
         # A rootmodel is used to represent all entitite/models
         # that is exported
-        rootmodel = FruitToLime::RootModel.new
+        @rootmodel = FruitToLime::RootModel.new
         coworkers = Hash.new
         includes = Hash.new
         people = Hash.new
 
-        configure rootmodel
+        configure @rootmodel
 
         # coworkers
         # start with these since they are referenced
@@ -232,15 +283,14 @@ class Exporter
         if coworkers_filename && !coworkers_filename.empty?
             process_rows coworkers_filename do |row|
                 coworkers[row['userIndex']] = row['userId']
-                rootmodel.add_coworker(to_coworker(row))
-
+                @rootmodel.add_coworker(to_coworker(row))
             end
         end
 
         # organizations
         if organization_filename && !organization_filename.empty?
             process_rows organization_filename do |row|
-                rootmodel.add_organization(to_organization(row, rootmodel, coworkers))
+                @rootmodel.add_organization(to_organization(row, coworkers))
             end
         end
 
@@ -250,40 +300,45 @@ class Exporter
             process_rows persons_filename do |row|
                 people[row['personIndex']] = "#{row['referenceId']}-#{row['companyId']}"
                 # adds it self to the employer
-                to_person(row, rootmodel)
+                to_person(row)
             end
         end
 
+        # organization notes
         if orgnotes_filename && !orgnotes_filename.empty?
             process_rows orgnotes_filename do |row|
                 # adds itself if applicable
-                to_organization_note(row, rootmodel, coworkers, people)
+                @rootmodel.add_note(to_organization_note(row, coworkers, people))
             end
         end
 
-        # deals
-        # deals can reference coworkers (responsible), organizations
-        # and persons (contact)
+        # Organization - Deal connection
+        # Reads the includes.txt and creats a hash
+        # that connect organizations to deals
         if includes_filename && !includes_filename.empty?
             process_rows includes_filename do |row|
                 includes[row['projectId']] = row['companyId']
             end
         end
-        
+
+        # deals
+        # deals can reference coworkers (responsible), organizations
+        # and persons (contact)
         if deals_filename && !deals_filename.empty?
             process_rows deals_filename do |row|
-                rootmodel.add_deal(to_deal(row, rootmodel, includes, coworkers))    
+                @rootmodel.add_deal(to_deal(row, includes, coworkers))
             end
         end
 
+        # deal notes
         if dealnotes_filename && !dealnotes_filename.empty?
             process_rows dealnotes_filename do |row|
                 # adds itself if applicable
-                to_deal_note(row, rootmodel, coworkers)
+                @rootmodel.add_note(to_deal_note(row, coworkers))
             end
         end
 
-        return rootmodel
+        return @rootmodel
     end
 
     def save_xml(file)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fruit_to_lime
 version: !ruby/object:Gem::Version
-  version: 2.5.6
+  version: 2.5.7
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso_country_codes