fruit_to_lime 2.1.1 → 2.1.2

data/lib/fruit_to_lime/errors.rb

@@ -0,0 +1,4 @@
+module FruitToLime
+    class AlreadyAddedError < StandardError
+    end
+end

data/lib/fruit_to_lime/model/class_settings.rb

@@ -21,10 +21,15 @@ module FruitToLime
             "ClassSettings"
         end
 
+        # 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
 
-            field = CustomField.new(obj)
+            if obj.is_a?(CustomField)
+                field = obj
+            else
+                field = CustomField.new(obj)
+            end
 
             index = @custom_fields.find_index do |custom_field| 
                 custom_field.same_as?(field)
@@ -38,13 +43,28 @@ module FruitToLime
             return field
         end
 
+        # Add custom field. If there is already an existing custom field, then an AlreadyAddedError will be raised.
         def add_custom_field(obj)
             @custom_fields = [] if @custom_fields==nil
 
-            field = CustomField.new(obj)
+            if obj.is_a?(CustomField)
+                field = obj
+            else
+                field = CustomField.new(obj)
+            end
+
+            index = @custom_fields.find_index do |custom_field| 
+                custom_field.same_as?(field)
+            end
+
+            if index
+                raise AlreadyAddedError, "Already added a custom same as #{obj}"
+            end
+
             @custom_fields.push field
 
             return field
         end
+
     end
 end

data/lib/fruit_to_lime/model/coworker.rb

@@ -1,7 +1,7 @@
 module FruitToLime
     class Coworker
         include SerializeHelper
-        attr_accessor :id, :integration_id, :first_name, :last_name, :email, :direct_phone_number,
+        attr_accessor :id, :integration_id, :email, :first_name, :last_name, :direct_phone_number,
         :mobile_phone_number, :home_phone_number
 
         def initialize(opt = nil)
@@ -15,7 +15,7 @@ module FruitToLime
 
         def serialize_variables
             [
-             :id, :integration_id, :first_name, :last_name, :email,
+             :id, :integration_id, :email, :first_name, :last_name, 
              :direct_phone_number, :mobile_phone_number, :home_phone_number
             ].map {|p| { :id => p, :type => :string } }
         end
@@ -40,8 +40,6 @@ module FruitToLime
 
             if that.is_a? Coworker
                 return @integration_id == that.integration_id
-            elsif that.is_a? String
-                return @integration_id == that
             end
 
             return false

data/lib/fruit_to_lime/model/note.rb

@@ -30,9 +30,5 @@ module FruitToLime
         def serialize_name
             "Note"
         end
-
-        # def with_organization
-        #     yield org
-        # end
     end
 end

data/lib/fruit_to_lime/model/organization.rb

@@ -47,28 +47,60 @@ module FruitToLime
 
             if that.is_a? Organization
                 return @integration_id == that.integration_id
-            elsif that.is_a? String
-                return @integration_id == that
             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
+            @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
+            @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
+            @source = ReferenceToSource.new if @source == nil
             yield @source
         end
 
+        # @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 
+        # @see CoworkerReference responsible_coworker
+        def with_responsible_coworker
+            @responsible_coworker = CoworkerReference.new if @responsible_coworker==nil
+            yield @responsible_coworker
+        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
@@ -76,6 +108,8 @@ module FruitToLime
             person
         end
 
+        # TODO! Remove, it's obsolete
+        # @!visibility private
         def add_responsible_coworker(val)
             coworker = if val.is_a? CoworkerReference then val else CoworkerReference.new(val) end
             @responsible_coworker = coworker

data/lib/fruit_to_lime/model/person.rb

@@ -34,14 +34,23 @@ module FruitToLime
                 end
             end
         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
+            @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
+            @source = ReferenceToSource.new if @source == nil
             yield @source
         end
 

data/lib/fruit_to_lime/model/rootmodel.rb

@@ -36,20 +36,53 @@ module FruitToLime
         end
 
         # Adds the specifed coworker object to the model.
+        # @example Add a coworker from a hash
+        #    rootmodel.add_coworker({
+        #        :integration_id=>"123",
+        #        :first_name=>"Kalle",
+        #        :last_name=>"Anka",
+        #        :email=>"kalle.anka@vonanka.com"
+        #    })
+        # 
+        # @example Add a coworker from a new coworker
+        #    coworker = FruitToLime::Coworker.new
+        #    coworker.integration_id = "123"
+        #    coworker.first_name="Kalle"
+        #    coworker.last_name="Anka"
+        #    coworker.email = "kalle.anka@vonanka.com"
+        #    rootmodel.add_coworker(coworker)
+        #
+        # @example If you want to keep adding coworkers and dont care about duplicates not being added
+        #    begin
+        #       rootmodel.add_coworker(coworker)
+        #    rescue FruitToLime::AlreadyAddedError
+        #       puts "Warning: already added coworker"
+        #    end
+        # @see Coworker
         def add_coworker(coworker)
             @coworkers = [] if @coworkers == nil
 
-            if coworker != nil && coworker.is_a?(Coworker) && !@coworkers.include?(coworker)
-                @coworkers.push(coworker)
+            if coworker == nil
+                raise "Missing coworker to add!"
             end
+
+            coworker = Coworker.new(coworker) if !coworker.is_a?(Coworker)
+            
+            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)
         end
 
+        # TODO! Remove, it's obsolete
+        # @!visibility private
         def add_note(text)
             @notes = [] if @notes == nil
             @notes.push(if text.is_a? Note then text else Note.new(text) end)
         end
 
-        def with_note
+        def with_new_note
             @notes = [] if @notes == nil
 
             note = Note.new
@@ -59,13 +92,13 @@ module FruitToLime
 
         def find_coworker_by_integration_id(integration_id)
             return @coworkers.find do |coworker|
-                coworker == integration_id
+                coworker.integration_id == integration_id
             end
         end
 
         def find_organization_by_integration_id(integration_id)
             return @organizations.find do |organization|
-                organization == integration_id
+                organization.integration_id == integration_id
             end
         end
 
@@ -107,7 +140,9 @@ module FruitToLime
 
         # returns all items from the object array with duplicate keys.
         # To get all organizations with the same integration_id use
-        # `get_duplicates(organizations, {|org| org.integration_id})`
+        # @example Get all the organization duplicates with the same integration id
+        #      rm.get_duplicates(rm.organizations, {|org| org.integration_id})
+        #
         def get_duplicates(objects, &key)
             uniq_items = objects.uniq {|item| key.call(item)}.compact
 

data/lib/fruit_to_lime/model/settings.rb

@@ -4,14 +4,38 @@ module FruitToLime
         include SerializeHelper
         attr_reader :organization, :person, :deal
         
+        # @example Add custom fields available for organization
+        #    rootmodel.settings.with_organization do |organization_settings|
+        #        organization_settings.set_custom_field({:integration_id=>"link_to_bi_system", :title=>"Link to BI system"})
+        #        organization_settings.set_custom_field({:integration_id=>"yield_quota", :title=>"Yield quota"})
+        #    end
+        # @see ClassSettings
+        # @see CustomField
+        # @see RootModel
         def with_organization
             @organization = ClassSettings.new if @organization ==nil
             yield @organization
         end
+
+        # @example Add custom fields available for person
+        #    rootmodel.settings.with_person do |person_settings|
+        #        person_settings.set_custom_field({:integration_id=>"link_to_bi_system", :title=>"Link to BI system"})
+        #    end
+        # @see ClassSettings
+        # @see CustomField
+        # @see RootModel
         def with_person
             @person = ClassSettings.new if @person ==nil
             yield @person
         end
+
+        # @example Add custom fields available for deal
+        #    rootmodel.settings.with_deal do |deal_settings|
+        #        deal_settings.set_custom_field({:integration_id=>"link_to_bi_system", :title=>"Link to BI system"})
+        #    end
+        # @see ClassSettings
+        # @see CustomField
+        # @see RootModel
         def with_deal
             @deal = ClassSettings.new if @deal ==nil
             yield @deal

data/lib/fruit_to_lime.rb

@@ -3,7 +3,8 @@ 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'

data/spec/class_settings_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+require 'fruit_to_lime'
+
+describe "ClassSettings" do
+    let(:class_settings) {
+        FruitToLime::ClassSettings.new
+    }
+
+    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.custom_fields.length.should eq 1
+        class_settings.custom_fields[0].title.should eq "Link to BI system 2" 
+    end
+
+    it "can add custom field and if there is already an existing custom field, then an AlreadyAddedError will be raised (and nothing is added)." do
+        class_settings.add_custom_field({:integration_id=>"link_to_bi_system", :title=>"Link to BI system"})
+        expect { 
+            class_settings.add_custom_field({:integration_id=>"link_to_bi_system", :title=>"Link to BI system 2"})
+        }.to raise_error(FruitToLime::AlreadyAddedError)
+        class_settings.custom_fields.length.should eq 1
+        class_settings.custom_fields[0].title.should eq "Link to BI system" 
+    end
+
+end
+

data/spec/helpers/csv_helper_spec.rb

@@ -12,4 +12,18 @@ describe FruitToLime::CsvHelper do
 1;Bj\u{00F6}rk")
     v.should include({"id"=>"1","navn"=>"Bj\u{00F6}rk"})
   end
+  it "should handle escaped newlines" do
+    v = FruitToLime::CsvHelper.text_to_hashes("id;navn
+1;\"Bj\u{00F6}rk
+And a new line\"")
+    v.should include({"id"=>"1","navn"=>"Bj\u{00F6}rk
+And a new line"})
+  end
+  it "should handle escaped newlines with ',' as delim" do
+    v = FruitToLime::CsvHelper.text_to_hashes("id,navn
+1,\"Bj\u{00F6}rk
+And a new line\"")
+    v.should include({"id"=>"1","navn"=>"Bj\u{00F6}rk
+And a new line"})
+  end
 end

data/spec/helpers/xsd_validate_spec.rb

@@ -11,6 +11,12 @@ describe FruitToLime::SerializeHelper do
                 s.set_custom_field({:integration_id=>"2", :title=>"cf title"})
                 s.set_custom_field({:integration_id=>"3", :title=>"cf title2"})
             end
+            i.add_coworker({
+                :integration_id=>"123",
+                :first_name=>"Kalle",
+                :last_name=>"Anka",
+                :email=>"kalle.anka@vonanka.com"
+            })
             o = FruitToLime::Organization.new
             o.name = "Ankeborgs bibliotek"
             o.with_source do |source|
@@ -27,9 +33,9 @@ describe FruitToLime::SerializeHelper do
             o.with_visit_address do |addr|
                 addr.city = "Gaaseborg"
             end
-            o.add_responsible_coworker({
-                :integration_id => "1"
-            })
+            o.with_responsible_coworker do |coworker|
+                coworker.integration_id = "1"
+            end
             emp = o.add_employee({
                 :integration_id => "1",
                 :first_name => "Kalle",

data/spec/rootmodel_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+require 'fruit_to_lime'
+
+describe "RootModel" do
+    let(:rootmodel) {
+        FruitToLime::RootModel.new
+    }
+
+    it "will contain integration coworker by default" do
+        rootmodel.find_coworker_by_integration_id("import").first_name.should eq "Import"
+        rootmodel.coworkers.length.should eq 1
+    end
+
+
+    it "can add a coworker from a hash" do
+        rootmodel.add_coworker({
+            :integration_id=>"123key",
+            :first_name=>"Kalle",
+            :last_name=>"Anka",
+            :email=>"kalle.anka@vonanka.com"
+        })
+        rootmodel.find_coworker_by_integration_id("123key").first_name.should eq "Kalle"
+        rootmodel.coworkers.length.should eq 2
+    end
+
+    it "can add a coworker from a new coworker" do
+        coworker = FruitToLime::Coworker.new
+        coworker.integration_id = "123key"
+        coworker.first_name="Kalle"
+        coworker.last_name="Anka"
+        coworker.email = "kalle.anka@vonanka.com"
+        rootmodel.add_coworker(coworker)
+        rootmodel.find_coworker_by_integration_id("123key").first_name.should eq "Kalle"
+        rootmodel.coworkers.length.should eq 2
+    end
+
+    it "will not add a new coworker when the coworker is already added (same integration id)" do
+        rootmodel.add_coworker({
+            :integration_id=>"123key",
+            :first_name=>"Kalle",
+            :last_name=>"Anka",
+            :email=>"kalle.anka@vonanka.com"
+        })
+        rootmodel.coworkers.length.should eq 2
+        expect { 
+            rootmodel.add_coworker({
+                :integration_id=>"123key",
+                :first_name=>"Knatte",
+                :last_name=>"Anka",
+                :email=>"knatte.anka@vonanka.com"
+            })
+        }.to raise_error(FruitToLime::AlreadyAddedError)
+        rootmodel.find_coworker_by_integration_id("123key").first_name.should eq "Kalle"
+        rootmodel.coworkers.length.should eq 2
+    end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fruit_to_lime
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso_country_codes
@@ -136,6 +136,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/fruit_to_lime/csv_helper.rb
+- lib/fruit_to_lime/errors.rb
 - lib/fruit_to_lime/model/address.rb
 - lib/fruit_to_lime/model/class_settings.rb
 - lib/fruit_to_lime/model/coworker.rb
@@ -157,7 +158,6 @@ files:
 - lib/fruit_to_lime.rb
 - bin/fruit_to_lime
 - templates/csv/convert.rb
-- templates/csv/export.xml
 - templates/csv/Gemfile
 - templates/csv/lib/tomodel.rb
 - templates/csv/Rakefile.rb
@@ -181,12 +181,14 @@ files:
 - templates/sqlserver/spec/spec_helper.rb
 - templates/sqlserver/spec/tomodel_spec.rb
 - spec/address_spec.rb
+- spec/class_settings_spec.rb
 - spec/custom_field_spec.rb
 - spec/helpers/csv_helper_spec.rb
 - spec/helpers/roo_helper_spec.rb
 - spec/helpers/serialize_helper_spec.rb
 - spec/helpers/xsd_validate_spec.rb
 - spec/person_spec.rb
+- spec/rootmodel_spec.rb
 - spec/spec_helper.rb
 - spec/templating_spec.rb
 homepage: 
@@ -215,11 +217,14 @@ specification_version: 3
 summary: Library to generate Lime Go xml import format
 test_files:
 - spec/address_spec.rb
+- spec/class_settings_spec.rb
 - spec/custom_field_spec.rb
 - spec/helpers/csv_helper_spec.rb
 - spec/helpers/roo_helper_spec.rb
 - spec/helpers/serialize_helper_spec.rb
 - spec/helpers/xsd_validate_spec.rb
 - spec/person_spec.rb
+- spec/rootmodel_spec.rb
 - spec/spec_helper.rb
 - spec/templating_spec.rb
+has_rdoc: 

data/templates/csv/export.xml

@@ -1,152 +0,0 @@
-<GoImport Version='v2_0'
-><Settings
-  ><Organization
-    ><CustomFields
-      ><CustomField
-        ><Title
-          >Link to external system</Title
-          ><Type
-          >Link</Type
-          ></CustomField
-        ></CustomFields
-      ></Organization
-    ></Settings
-  ><Coworkers
-  ><Coworker
-    ><IntegrationId
-      >import</IntegrationId
-      ><FirstName
-      >Import</FirstName
-      ></Coworker
-    ><Coworker
-    ><IntegrationId
-      >666</IntegrationId
-      ><FirstName
-      >Evil</FirstName
-      ><LastName
-      >Elvis</LastName
-      ><Email
-      >t@e.com</Email
-      ><DirectPhoneNumber
-      >+46121212</DirectPhoneNumber
-      ><MobilePhoneNumber
-      >+46324234</MobilePhoneNumber
-      ><HomePhoneNumber
-      >+46234234</HomePhoneNumber
-      ></Coworker
-    ></Coworkers
-  ><Organizations
-  ><Organization
-    ><IntegrationId
-      >6</IntegrationId
-      ><Name
-      >Alfs Mjukvaruutveckling</Name
-      ><OrganizationNumber
-      >a number</OrganizationNumber
-      ><PostalAddress
-      ><Street
-        >postal street</Street
-        ><ZipCode
-        >226 48</ZipCode
-        ><City
-        >LUND</City
-        ></PostalAddress
-      ><VisitAddress
-      ><Street
-        >visit street</Street
-        ><ZipCode
-        >visit zip</ZipCode
-        ><City
-        >visit city</City
-        ></VisitAddress
-      ><CentralPhoneNumber
-      >0000</CentralPhoneNumber
-      ><Email
-      >email to organizaiton, not the person</Email
-      ><WebSite
-      >www.whatever.com</WebSite
-      ><Employees
-      ><Person
-        ><IntegrationId
-          >123</IntegrationId
-          ><FirstName
-          >Rune</FirstName
-          ><LastName
-          >Rebellion</LastName
-          ><DirectPhoneNumber
-          >+4611111</DirectPhoneNumber
-          ><FaxPhoneNumber
-          >+4623234234234</FaxPhoneNumber
-          ><MobilePhoneNumber
-          >+462321212</MobilePhoneNumber
-          ><Email
-          >x@y.com</Email
-          ><AlternativeEmail
-          >y@x.com</AlternativeEmail
-          ><PostalAddress
-          ><Street
-            >postal street</Street
-            ><ZipCode
-            >226 48</ZipCode
-            ><City
-            >LUND</City
-            ></PostalAddress
-          ><CurrentlyEmployed
-          >true</CurrentlyEmployed
-          ></Person
-        ></Employees
-      ><CustomValues
-      ><CustomValue
-        ><Field
-          >external_url</Field
-          ><Value
-          >http://something.com?key=6</Value
-          ></CustomValue
-        ></CustomValues
-      ><Tags
-      ><Tag
-        >Imported</Tag
-        ></Tags
-      ><ResponsibleCoworker
-      ><Heading
-        >Evil Elvis</Heading
-        ><IntegrationId
-        >666</IntegrationId
-        ></ResponsibleCoworker
-      ></Organization
-    ></Organizations
-  ><Deals
-  ><Deal
-    ><IntegrationId
-      >333</IntegrationId
-      ><Name
-      >Feta affären</Name
-      ><Probability
-      >50</Probability
-      ><Value
-      >10000</Value
-      ><OfferDate
-      >2013-12-01</OfferDate
-      ><OrderDate
-      >2014-01-05</OrderDate
-      ><Customer
-      ><IntegrationId
-        >6</IntegrationId
-        ><Heading
-        >Alfs Mjukvaruutveckling</Heading
-        ></Customer
-      ><ResponsibleCoworker
-      ><Heading
-        >Evil Elvis</Heading
-        ><IntegrationId
-        >666</IntegrationId
-        ></ResponsibleCoworker
-      ><CustomerContact
-      ><IntegrationId
-        >123</IntegrationId
-        ></CustomerContact
-      ></Deal
-    ></Deals
-  ><Notes
-  /></GoImport
->