insightly 0.2.0 → 0.2.1

data/README.md

@@ -57,4 +57,12 @@ Organisation? Organization
 ===========
 
 The documentation for Insight.ly the mixes the use of Organization and Organisation. Insight.ly spells it Organisation in urls and in the API - so we
-only use that spelling in the library.
+only use that spelling in the library.
+
+
+Custom Fields vs Tags
+=========
+
+Insight.ly supports both custom fields (up to 10 on Opportunities, Organisations, and Contacts). Opportunities, Organisations,
+ Contacts also support tags. What is the difference?   Custom fields allow you to put data on the item. This data shows up when you look
+ at the details page of that record. Tags show up in the summary list, and also allow you to search/sort by.

data/lib/insightly/contact.rb

@@ -3,6 +3,8 @@ module Insightly
     include Insightly::AddressHelper
     include Insightly::ContactInfoHelper
     include Insightly::LinkHelper
+    include Insightly::TagHelper
+
     self.url_base = "Contacts"
     CUSTOM_FIELD_PREFIX = "CONTACT_FIELD"
     api_field "CONTACT_ID",

data/lib/insightly/country.rb

@@ -0,0 +1,22 @@
+module Insightly
+  class Country < ReadOnly
+    self.url_base = "Countries"
+    api_field "COUNTRY_NAME"
+
+    def build(data)
+      if data.respond_to? :keys
+        @data = data
+      else
+        @data = {"COUNTRY_NAME" => data}
+      end
+      self
+    end
+    def self.us
+      self.build("United States")
+    end
+    def self.canada
+      self.build("Canada")
+    end
+
+  end
+end

data/lib/insightly/currency.rb

@@ -0,0 +1,23 @@
+module Insightly
+  class Currency < ReadOnly
+    self.url_base = "Currencies"
+    api_field "CURRENCY_CODE",
+              "CURRENCY_SYMBOL"
+
+    def build(data)
+      if data.respond_to? :keys
+        @data = data
+      else
+        @data = {"CURRENCY_CODE" => data, "CURRENCY_SYMBOL" => "$"}
+      end
+      self
+    end
+    def self.us
+      self.build("USD")
+    end
+    def self.canada
+      self.build("CAD")
+    end
+
+  end
+end

data/lib/insightly/custom_field.rb

@@ -0,0 +1,21 @@
+#METODO add better handling for CUSTOM_FIELD_OPTIONS
+module Insightly
+  class CustomField < ReadOnly
+    self.url_base = "CustomFields"
+    api_field  "CUSTOM_FIELD_ID",
+               "FIELD_NAME",
+               "FIELD_HELP_TEXT",
+               "CUSTOM_FIELD_OPTIONS",
+               "ORDER_ID",
+               "FIELD_TYPE",
+               "FIELD_FOR"
+    def initialize(id = nil)
+      @data = {"CUSTOM_FIELD_OPTIONS" = []}
+      load(id) if id
+    end
+    def remote_id
+      self.custom_field_id
+    end
+
+  end
+end

data/lib/insightly/opportunity.rb

@@ -1,6 +1,7 @@
 module Insightly
   class Opportunity < ReadWrite
     include Insightly::LinkHelper
+    include Insightly::TagHelper
     self.url_base = "Opportunities"
     CUSTOM_FIELD_PREFIX = "OPPORTUNITY_FIELD"
     api_field "OPPORTUNITY_FIELD_10",
@@ -23,7 +24,6 @@ module Insightly
               "PIPELINE_ID",
               "CATEGORY_ID",
               "PROBABILITY",
-              "TAGS",
               "IMAGE_URL",
               "BID_AMOUNT",
               "VISIBLE_TEAM_ID",

data/lib/insightly/opportunity_category.rb

@@ -0,0 +1,15 @@
+module Insightly
+  class OpportunityCategory < ReadOnly
+    self.url_base = "OpportunityCategories"
+    api_field "CATEGORY_ID",
+              "ACTIVE",
+              "BACKGROUND_COLOR",
+              "CATEGORY_NAME"
+
+    def remote_id
+      self.category_id
+    end
+
+
+  end
+end

data/lib/insightly/organisation.rb

@@ -3,6 +3,8 @@ module Insightly
     include Insightly::AddressHelper
     include Insightly::ContactInfoHelper
     include Insightly::LinkHelper
+    include Insightly::TagHelper
+
     self.url_base = "Organisations"
     CUSTOM_FIELD_PREFIX = "ORGANISATION_FIELD"
     api_field "ORGANISATION_ID",

data/lib/insightly/relationship.rb

@@ -0,0 +1,16 @@
+module Insightly
+  class Relationship < ReadOnly
+    self.url_base = "Relationships"
+    api_field "RELATIONSHIP_ID",
+              "FOR_ORGANISATIONS",
+              "FOR_CONTACTS",
+              "REVERSE_TITLE",
+              "FORWARD",
+              "REVERSE",
+              "FORWARD_TITLE"
+
+    def remote_id
+      self.relationship_id
+    end
+  end
+end

data/lib/insightly/tag.rb

@@ -0,0 +1,44 @@
+module Insightly
+  class Tag < ReadOnly
+    self.url_base = "Tags"
+    api_field "TAG_NAME"
+
+    def build(data)
+      if data.respond_to? :keys
+        @data = data
+      else
+        @data = {"TAG_NAME" => data}
+      end
+      self
+    end
+    def self.contact_tags
+
+      self.tags_by_type("Contacts")
+
+    end
+    def self.organisation_tags
+      self.tags_by_type("Organisations")
+
+    end
+    def self.opportunity_tags
+      self.tags_by_type("Opportunities")
+
+    end
+    def self.project_tags
+      self.tags_by_type("Projects")
+    end
+    def self.email_tags
+      self.tags_by_type("Emails")
+
+    end
+    def self.tags_by_type(type)
+      item = self.new
+      list = []
+      item.get_collection("#{item.url_base}/#{type}").each do |d|
+        list << self.new.build(d)
+      end
+      list
+    end
+  end
+
+end

data/lib/insightly/tag_helper.rb

@@ -0,0 +1,15 @@
+module Insightly
+  module TagHelper
+    def tags
+         @data["TAGS"].collect {|a| Insightly::Tag.build(a)}
+     end
+     def tags=(list)
+       @data["TAGS"] = list.collect {|a| a.remote_data}
+     end
+     def add_tag(tag)
+       @data["TAGS"]  ||= []
+       @data["TAGS"] << tag.remote_data
+       true
+     end
+  end
+end

data/lib/insightly/task_category.rb

@@ -0,0 +1,15 @@
+module Insightly
+  class TaskCategory < ReadOnly
+    self.url_base = "TaskCategories"
+    api_field "CATEGORY_ID",
+              "ACTIVE",
+              "BACKGROUND_COLOR",
+              "CATEGORY_NAME"
+
+    def remote_id
+      self.category_id
+    end
+
+
+  end
+end

data/lib/insightly/team_member.rb

@@ -0,0 +1,13 @@
+module Insightly
+  class TeamMember < ReadOnly
+    self.url_base = "TeamMembers"
+    api_field "MEMBER_TEAM_ID",
+              "TEAM_ID",
+              "MEMBER_USER_ID",
+              "PERMISSION_ID"
+
+    def remote_id
+      self.team_id
+    end
+  end
+end

data/lib/insightly/user.rb

@@ -0,0 +1,46 @@
+module Insightly
+  class User < ReadOnly
+    self.url_base = "Users"
+    api_field "DATE_UPDATED_UTC",
+              "ACTIVE",
+              "TIMEZONE_ID",
+              "DATE_CREATED_UTC",
+              "EMAIL_ADDRESS",
+              "ACCOUNT_OWNER",
+              "CONTACT_ID",
+              "USER_ID",
+              "ADMINISTRATOR",
+              "LAST_NAME",
+              "FIRST_NAME"
+
+    def remote_id
+      self.user_id
+    end
+    def self.find_all_by_email(email)
+      User.all.collect {|x| x if x.email_address && x.email_address.match(email)}.compact
+    end
+    def self.find_by_email(email)
+      User.all.each do |x|
+        return x if x.email_address && x.email_address.match(email)
+      end
+      nil
+    end
+    def self.find_all_by_name(name)
+      User.all.collect {|x|  x if x.name && x.name.match(name) }.compact
+
+    end
+    def self.find_by_name(name)
+      User.all.collect do |x|
+        return x if x.name && x.name.match(name)
+      end
+      nil
+    end
+    def name
+           "#{self.first_name} #{self.last_name}".strip
+    end
+    def last_name_first
+      result = "#{self.last_name},#{self.first_name}".strip
+      result == "," ? "" : result
+    end
+  end
+end

data/lib/insightly/version.rb

@@ -4,7 +4,7 @@ module Insightly
   module Version
     Major = 0
     Minor = 2
-    Tiny = 0
+    Tiny = 1
     String = "#{Major}.#{Minor}.#{Tiny}"
   end
 end

data/lib/insightly.rb

@@ -8,6 +8,7 @@ require 'insightly/address_helper'
 require 'insightly/contact_info_helper'
 require 'insightly/link_helper'
 require 'insightly/task_link_helper'
+require 'insightly/tag_helper'
 
 
 require 'insightly/base'
@@ -24,4 +25,13 @@ require 'insightly/opportunity_state_reason'
 require 'insightly/opportunity'
 require 'insightly/organisation'
 require "insightly/link"
+require "insightly/tag"
+require "insightly/user"
+require "insightly/country"
+require "insightly/currency"
+require "insightly/team_member"
+require "insightly/relationship"
+require "insightly/opportunity_category"
+require "insightly/task_category"
+require "insightly/custom_field"