fruit_to_lime 2.6.0 → 2.6.1

data/lib/fruit_to_lime/errors.rb

@@ -13,4 +13,7 @@ module FruitToLime
             super("#{value} is not a valid value.")
         end
     end
+
+    class InvalidDealStatusError < StandardError
+    end
 end

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

data/lib/fruit_to_lime/model/deal.rb

@@ -91,6 +91,14 @@ module FruitToLime
                 error = "A name is required for deal.\n}"
             end
 
+            if !@status.nil? && @status.status_reference.nil?
+                error = "#{error}\nStatus must have a status reference."
+            end
+
+            if !@status.nil? && !@status.status_reference.nil? && @status.status_reference.validate.length > 0
+                error = "#{error}\n#{@status.status_reference.validate}"
+            end
+
             if error.length > 0
                 error = "#{error}\n#{serialize()}"
             end
@@ -98,11 +106,25 @@ module FruitToLime
             return error
         end
 
+
         def with_status
-            @status = DealStatus.new
+            @status = DealStatus.new if @status.nil?
             yield @status
         end
 
+        # Sets the deal's status to the specifed status. The specifed
+        # status could be either a DealStatusSetting, a string or an
+        # integer. Use DealStatusSetting if you want to create new
+        # statuses during import (you will probably add the
+        # DealStatusSettings to the settings model). If the statuses
+        # already exists in the application use the status label
+        # (String) or id (Integer) here.
+        def status=(status)
+            @status = DealStatus.new if @status.nil?
+
+            @status.status_reference = DealStatusReference.from_deal_status(status)
+        end
+
         def customer=(customer)
             @customer = OrganizationReference.from_organization(customer)
         end

data/lib/fruit_to_lime/model/deal_class_settings.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+module FruitToLime
+    class DealClassSettings < ClassSettings
+        attr_reader :statuses
+
+        def initialize(opt = nil)
+            @statuses = []
+            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
+            super() + [{:id => :statuses, :type => :statuses }]
+        end
+
+        def add_status(obj)
+            @statuses = [] if @statuses.nil?
+
+            if obj.is_a?(DealStatusSetting)
+                status = obj
+            else
+                status = DealStatusSetting.new(obj)
+            end
+
+            if status.label.nil? || status.label.empty?
+                raise InvalidDealStatusError, "Deal status must have a label"
+            end
+
+            if status.assessment.nil?
+                status.assessment = DealState::NotAnEndState
+            end
+
+            index = @statuses.find_index do |deal_status|
+                deal_status.same_as?(status)
+            end
+            if index
+                @statuses.delete_at index
+            end
+
+            @statuses.push status
+
+            return status
+        end
+
+        def find_status_by_label(label)
+            return nil if @statuses.nil?
+
+            return @statuses.find do |status|
+                !status.label.nil? && status.label.casecmp(label) == 0
+            end
+        end
+
+        def find_status_by_integration_id(integration_id)
+            return nil if @statuses.nil?
+
+            return @statuses.find do |status|
+                !status.integration_id.nil? && status.integration_id.casecmp(integration_id) == 0
+            end
+        end
+
+        def find_status_by_id(id)
+            return nil if @statuses.nil?
+
+            return @statuses.find do |status|
+                !status.id.nil? && status.id.casecmp(integration_id) == 0
+            end
+        end
+    end
+end

data/lib/fruit_to_lime/model/deal_state.rb

@@ -0,0 +1,15 @@
+module FruitToLime
+    module DealState
+        # This is the default, a deal with a status with this state is
+        # currently being worked on.
+        NotAnEndState = 0
+
+        # The deal has reached a positive end state, eg we have won
+        # the deal.
+        PositiveEndState = 1
+
+        # The deal has reached a negative end state, eg we have lost
+        # the deal.
+        NegativeEndState = -1
+    end
+end

data/lib/fruit_to_lime/model/deal_status.rb

@@ -2,11 +2,22 @@ module FruitToLime
     class DealStatus
         include SerializeHelper
 
-        attr_accessor :id, :label, :date, :note
+        attr_accessor :id, :date, :status_reference, :note
+
+        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, :label, :note ].map{ |p| { :id => p, :type => :string } } +
-            [ :date ].map { |p| { :id => p, :type => :date } }
+                [ :date ].map { |p| { :id => p, :type => :date } } +
+                [ :status_reference ].map { |p| { :id => p, :type => :deal_status_reference } }
         end
+
     end
 end

data/lib/fruit_to_lime/model/deal_status_reference.rb

@@ -0,0 +1,49 @@
+module FruitToLime
+    class DealStatusReference
+        include SerializeHelper
+
+        attr_accessor :id, :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
+            [:id, :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})
+            elsif deal_status.is_a?(Integer)
+                return DealStatusReference.new({:id => deal_status.to_s })
+            end
+
+            raise InvalidDealStatusError
+        end
+
+        def validate
+            error = ""
+
+            if (@id.nil? || @id.empty?) && (@label.nil? || @label.empty?) && (@integration_id.nil? || @integration_id.empty?)
+                error = "id, label and integration_id can't all be nil or empty"
+            end
+
+            return error
+        end
+    end
+end

data/lib/fruit_to_lime/model/deal_status_setting.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+module FruitToLime
+    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.id = @id
+            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/fruit_to_lime/model/settings.rb

@@ -3,7 +3,7 @@ module FruitToLime
     class Settings
         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"})
@@ -37,7 +37,7 @@ module FruitToLime
         # @see CustomField
         # @see RootModel
         def with_deal
-            @deal = ClassSettings.new if @deal ==nil
+            @deal = DealClassSettings.new if @deal ==nil
             yield @deal
         end
 
@@ -58,4 +58,4 @@ module FruitToLime
             "Settings"
         end
     end
-end
+end

data/spec/deal_class_settings_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+require "fruit_to_lime"
+
+describe "DealClassSettings" do
+    let(:deal_class_settings) {
+        FruitToLime::DealClassSettings.new
+    }
+
+    it "should not allow new deal status without a label" do
+        # given, when
+        begin
+            deal_class_settings.add_status({:integration_id => "123"})
+        rescue FruitToLime::InvalidDealStatusError
+        end
+
+        # then
+        deal_class_settings.statuses.length.should eq 0
+    end
+
+    it "should set assessment to NotAnEndState as default" do
+        # given, when
+        status = deal_class_settings.add_status({:label => "1. Kvalificering"})
+
+        # then
+        status.assessment.should eq FruitToLime::DealState::NotAnEndState
+    end
+
+    it "should set assessment if specified" do
+        # given, when
+        status = deal_class_settings.add_status({
+                                                    :label => "4. Won deal",
+                                                    :assessment => FruitToLime::DealState::PositiveEndState
+                                                })
+
+        # then
+        status.assessment.should eq FruitToLime::DealState::PositiveEndState
+    end
+
+    it "should find a status by case insensitive label" do
+        # given
+        deal_class_settings.add_status({:label => "1. Kvalificering"})
+        deal_class_settings.add_status({:label => "2. Skickat offert"})
+
+        # when
+        status = deal_class_settings.find_status_by_label("2. skICkat OfFert")
+
+        # then
+        status.label.should eq "2. Skickat offert"
+    end
+
+    it "should find a status by integration id" do
+        # given
+        deal_class_settings.add_status({:label => "1. Kvalificering", :integration_id => "qualify"})
+        deal_class_settings.add_status({:label => "2. Skickat offert", :integration_id => "tender sent"})
+
+        # when
+        status = deal_class_settings.find_status_by_integration_id("tender SeNT")
+
+        # then
+        status.label.should eq "2. Skickat offert"
+    end
+
+    it "should find nil by label if no statuses are defined" do
+        # given, when
+        status = deal_class_settings.find_status_by_label("3. Won")
+
+        # then
+        status.should eq nil
+    end
+
+    it "should find nil by integration id if no statuses are defined" do
+        # given, when
+        status = deal_class_settings.find_status_by_integration_id("3. Won")
+
+        # then
+        status.should eq nil
+    end
+
+end
+
+

data/spec/deal_spec.rb

@@ -6,15 +6,6 @@ describe "Deal" do
         FruitToLime::Deal.new
     }
 
-    it "can attach a current status" do
-        deal.with_status do |status|
-            status.label = 'xyz'
-            status.id = '123'
-            status.date = DateTime.now
-            status.note = 'ho ho'
-        end
-    end
-
     it "will auto convert org to org.ref during assignment" do
         # given
         org = FruitToLime::Organization.new({:integration_id => "123", :name => "Lundalogik"})
@@ -50,10 +41,44 @@ describe "Deal" do
 
     it "will fail on validation if name is empty" do
         # given
-        deal.name = "The big deal"
+        deal.name = ""
+        deal.status = "required status"
+
+        # when, then
+        deal.validate.length.should be > 0
+    end
+
+    it "will fail on validation if name is nil" do
+        # given
+        deal.name = nil
+        deal.status = "required status"
 
         # when, then
-        deal.validate.should eq ""
+        deal.validate.length.should be > 0
+    end
+
+    it "will fail on validation if status dont have a status reference" do
+        # given
+        deal.name = "Deal must have a name"
+        # this will create a status with a status_reference
+        deal.status = "Driv"
+
+        # when
+        # and this will set the reference to nil (this will probably
+        # never happen in the real world).
+        deal.status.status_reference = nil
+
+        # then
+        deal.validate.length.should be > 0
+    end
+
+    it "will fail on validation if status has an invalid status reference" do
+        # given
+        deal.name = "Deal must have a name"
+        deal.status = ""
+
+        # when, then
+        deal.validate.length.should be > 0
     end
 
     it "should convert value strings that looks like number to number" do
@@ -109,4 +134,66 @@ describe "Deal" do
         # then
         deal.value.should eq 0
     end
+
+    it "should set status_reference from status_setting" do
+        # This case should be used when the status is defined in the rootmodel
+
+        # given
+        deal.name = "Deal with status from deal_status_setting"
+        deal_status_setting = FruitToLime::DealStatusSetting.new({:integration_id => "123", :label => "Driv"})
+
+        # when
+        deal.status = deal_status_setting
+
+        # then
+        deal.status.is_a?(FruitToLime::DealStatus).should eq true
+        deal.status.status_reference.is_a?(FruitToLime::DealStatusReference).should eq true
+        deal.status.status_reference.label.should eq "Driv"
+        deal.status.status_reference.integration_id.should eq "123"
+    end
+
+    it "should set status_reference from label if status is a string" do
+        # This case should be used when the status is already defined
+        # in the appliation and is referenced by label
+
+        # given
+        deal.name = "Deal with status from label"
+
+        # when
+        deal.status = "Driv"
+
+        # then
+        deal.status.is_a?(FruitToLime::DealStatus).should eq true
+        deal.status.status_reference.is_a?(FruitToLime::DealStatusReference).should eq true
+        deal.status.status_reference.label.should eq "Driv"
+        deal.status.status_reference.id.nil?.should eq true
+    end
+
+    it "should set status_reference from id if status is an integer" do
+        # This case should be used when the status is already defined
+        # in the application and is referenced by id
+
+        # given
+        deal.name = "Deal with status from id"
+
+        # when
+        deal.status = 123
+
+        # then
+        deal.status.is_a?(FruitToLime::DealStatus).should eq true
+        deal.status.status_reference.is_a?(FruitToLime::DealStatusReference).should eq true
+        deal.status.status_reference.label.nil?.should eq true
+        deal.status.status_reference.id.should eq "123"
+    end
+
+    it "should raise error if status reference cant be created" do
+        # given
+        deal.name = "Deal with failed status"
+
+        # when, then
+        expect {
+            deal.status = FruitToLime::DealStatus.new({:id => 123})
+        }.to raise_error(FruitToLime::InvalidDealStatusError)
+    end
+
 end

data/spec/deal_status_reference_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+require 'fruit_to_lime'
+
+describe "DealStatusReference" do
+    let(:deal_status_reference){
+        FruitToLime::DealStatusReference.new
+    }
+
+    it "should fail on validation if name, id and integration_id is nil" do
+        # given
+        #deal_status_reference
+
+        # when, then
+        deal_status_reference.validate.length.should be > 0
+    end
+end
+

data/spec/spec_helper.rb

@@ -1,24 +1,30 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
 #require File.expand_path("../../config/environment", __FILE__)
-require 'rspec/autorun'
+#require 'rspec/autorun'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[File.join(File.dirname(File.absolute_path(__FILE__)),"support/**/*.rb")].each { |f| require f }
 
 RSpec.configure do |config|
-  # ## Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
+    # ## Mock Framework
+    #
+    # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+    #
+    # config.mock_with :mocha
+    # config.mock_with :flexmock
+    # config.mock_with :rr
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = "random"
+    # Run specs in random order to surface order dependencies. If you find an
+    # order dependency and want to debug it, you can fix the order by providing
+    # the seed, which is printed after each run.
+    #     --seed 1234
+    config.order = "random"
+
+    # Allow both should and expect syntax
+    # http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    config.expect_with :rspec do |c|
+        c.syntax = [:should, :expect]
+    end
 end
 

data/templates/csv/lib/tomodel.rb

@@ -7,9 +7,9 @@ class Exporter
     # coworker
     def to_organization(row, rootmodel)
         organization = FruitToLime::Organization.new
-        # Integrationid is typically the id in the system that 
+        # Integrationid is typically the id in the system that
         # we are getting the csv from. Must be set to be able
-        # to import the same file more than once without 
+        # to import the same file more than once without
         # creating duplicates
         organization.integration_id = row['id']
         organization.name = row['name']
@@ -70,7 +70,7 @@ class Exporter
 
         # Tags and custom fields are set the same
         # way as on organizations
-        
+
         return coworker
     end
 
@@ -122,7 +122,13 @@ class Exporter
         deal.probability = 50           # should be between 0 - 100
         deal.order_date = '2014-01-05'  # Format ?
 
-        # status, how do we set this ?
+        # status, set this by either label, id or integration_id (use
+        # appropriate method to find status)
+        deal.status = rootmodel.settings.deal.find_status_by_label row['status']
+
+        # or set by existing status, search by label, integration_id
+        # (if string) or id (if integer).
+        # deal.status = "Won"
 
         return deal
     end
@@ -135,6 +141,14 @@ class Exporter
         model.settings.with_organization do |organization|
             organization.set_custom_field( { :integrationid => 'external_url', :title => 'Link to external system', :type => :Link } )
         end
+
+        model.settings.with_deal do |deal|
+            deal.add_status({:label => "1. Kvalificering", :integration_id => "qualification"})
+            deal.add_status({:label => "Vunnen", :integration_id => "won",
+                                :assessment => FruitToLime::DealState::PositiveEndState })
+            deal.add_status({:label => "Lost", :integration_id => "Lost",
+                                :assessment => FruitToLime::DealState::NegativeEndState })
+        end
     end
 
     def process_rows(file_name)

data/templates/easy/lib/tomodel.rb

@@ -215,10 +215,12 @@ class Exporter
         # remove everything that is not an intiger
         deal.probability = row['probability'].gsub(/[^\d]/,"").to_i unless row['probability'].nil?
 
-        # Create a status object and set it's label to the value of the Easy field
+        # Sets the deal's status to the value of the Easy field. This
+        # assumes that the status is already created in LIME Go. To
+        # create statuses during import add them to the settings
+        # during configure.
         if !row['Status'].empty?
-            deal.status = FruitToLime::DealStatus.new
-            deal.status.label = row['Status']
+            deal.status = row['Status']
         end
 
         # Tags
@@ -295,6 +297,13 @@ class Exporter
         model.settings.with_person  do |person|
             person.set_custom_field( { :integration_id => 'shoe_size', :title => 'Shoe size', :type => :String} )
         end
+
+        model.settings.with_deal do |deal|
+            # assessment is default DealState::NoEndState
+            deal.add_status( {:label => '1. Kvalificering' })
+            deal.add_status( {:label => '2. Deal closed', :assessment => DealState::PositiveEndState })
+            deal.add_status( {:label => '4. Deal lost', :assessment => DealState::NegativeEndState })
+        end
     end
 
     def process_rows(file_name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fruit_to_lime
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iso_country_codes
@@ -178,7 +178,11 @@ files:
 - lib/fruit_to_lime/model/coworker_reference.rb
 - lib/fruit_to_lime/model/customfield.rb
 - lib/fruit_to_lime/model/deal.rb
+- lib/fruit_to_lime/model/deal_class_settings.rb
+- lib/fruit_to_lime/model/deal_state.rb
 - lib/fruit_to_lime/model/deal_status.rb
+- lib/fruit_to_lime/model/deal_status_reference.rb
+- lib/fruit_to_lime/model/deal_status_setting.rb
 - lib/fruit_to_lime/model/note.rb
 - lib/fruit_to_lime/model/organization.rb
 - lib/fruit_to_lime/model/person.rb
@@ -232,7 +236,9 @@ files:
 - spec/class_settings_spec.rb
 - spec/coworker_spec.rb
 - spec/custom_field_spec.rb
+- spec/deal_class_settings_spec.rb
 - spec/deal_spec.rb
+- spec/deal_status_reference_spec.rb
 - spec/helpers/csv_helper_spec.rb
 - spec/helpers/email_helper_spec.rb
 - spec/helpers/phone_helper_spec.rb
@@ -274,7 +280,9 @@ test_files:
 - spec/class_settings_spec.rb
 - spec/coworker_spec.rb
 - spec/custom_field_spec.rb
+- spec/deal_class_settings_spec.rb
 - spec/deal_spec.rb
+- spec/deal_status_reference_spec.rb
 - spec/helpers/csv_helper_spec.rb
 - spec/helpers/email_helper_spec.rb
 - spec/helpers/phone_helper_spec.rb