insightly 0.1.8 → 0.2.0

data/README.md

@@ -47,7 +47,14 @@ The API allows you to change the state of an opportunity directly by modifying t
 that the opportunity state was changed.  In order to store the reason, you have to PUT to OpportunityStateChange with a valid OpportunityStateReason.
 OpportunityStateReasons can only be created manually in the web interface and then referred to via the API.
 
-This is important if you want to have it show you the state changes in the Opportuity details. Direct modifications don't create a log entry.
+This is important if you want to have it show you the state changes in the Opportunity details. Direct modifications don't create a log entry.
 Whereas the log entry is created if you do create them. In order for your code to work, you need to make sure you have valid Opportunity State Reasons for all the states.
 
 We default to creating two for open -  "Created by API", and "Reopened by API". This allows us to set those as reasons if they exist.
+
+
+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.

data/lib/insightly.rb

@@ -4,11 +4,24 @@ require 'logger'
 require 'insightly/configuration'
 require "active_support/core_ext"  #Needed for Hash.from_xml
 
+require 'insightly/address_helper'
+require 'insightly/contact_info_helper'
+require 'insightly/link_helper'
+require 'insightly/task_link_helper'
+
+
 require 'insightly/base'
+require 'insightly/base_data'
 require 'insightly/read_write'
 require 'insightly/read_only'
+require "insightly/address"
+require "insightly/contact_info"
+require 'insightly/contact'
 require 'insightly/task'
 require 'insightly/task_link'
 require 'insightly/comment'
 require 'insightly/opportunity_state_reason'
 require 'insightly/opportunity'
+require 'insightly/organisation'
+require "insightly/link"
+

data/lib/insightly/address.rb

@@ -0,0 +1,20 @@
+module Insightly
+  class Address < BaseData
+    api_field "ADDRESS_ID",
+              "ADDRESS_TYPE",
+              "STREET",
+              "CITY",
+              "STATE",
+              "POSTCODE",
+              "COUNTRY"
+
+    def same_address?(other)
+      self.address_type == other.address_type &&
+      self.street == other.street &&
+          self.city == other.city &&
+          self.state == other.state &&
+          self.postcode == other.postcode &&
+          self.country == other.country
+    end
+  end
+end

data/lib/insightly/address_helper.rb

@@ -0,0 +1,21 @@
+module Insightly
+  module AddressHelper
+    def addresses
+         @data["ADDRESSES"].collect {|a| Insightly::Address.build(a)}
+     end
+     def addresses=(list)
+       @data["ADDRESSES"] = list.collect {|a| a.remote_data}
+     end
+     def add_address(address)
+
+       @data["ADDRESSES"].each do |a|
+         if  address.same_address?(Insightly::Address.build(a))
+
+           return false
+         end
+       end
+       @data["ADDRESSES"] << address.remote_data
+       true
+     end
+  end
+end

data/lib/insightly/base.rb

@@ -60,7 +60,9 @@ module Insightly
     def reload
       load(remote_id)
     end
-
+    def to_json
+       @data.to_json
+     end
     def build(data)
       @data = data
       self

data/lib/insightly/base_data.rb

@@ -0,0 +1,49 @@
+module Insightly
+  class BaseData
+    class << self
+      attr_accessor :api_fields
+    end
+    self.api_fields = []
+
+
+    def self.api_field(*args)
+      args.each do |field|
+        self.api_fields = [] if !self.api_fields
+        self.api_fields << field
+        method_name = field.downcase.to_sym
+        send :define_method, method_name do
+          @data[field]
+        end
+        method_name = "#{field.downcase}=".to_sym
+        send :define_method, method_name do |value|
+          @data[field] = value
+        end
+      end
+    end
+
+    def initialize
+      @data = {}
+    end
+
+    def to_json
+      @data.to_json
+    end
+
+    def build(data)
+      @data = data
+      self
+    end
+
+    def self.build(data)
+      self.new.build(data)
+    end
+
+    def ==(other)
+      self.remote_data == other.remote_data
+    end
+
+    def remote_data
+      @data
+    end
+  end
+end

data/lib/insightly/contact.rb

@@ -0,0 +1,42 @@
+module Insightly
+  class Contact < ReadWrite
+    include Insightly::AddressHelper
+    include Insightly::ContactInfoHelper
+    include Insightly::LinkHelper
+    self.url_base = "Contacts"
+    CUSTOM_FIELD_PREFIX = "CONTACT_FIELD"
+    api_field "CONTACT_ID",
+              "SALUTATION",
+              "FIRST_NAME",
+              "LAST_NAME",
+              "BACKGROUND",
+              "CONTACT_FIELD_1",
+              "CONTACT_FIELD_2",
+              "CONTACT_FIELD_3",
+              "CONTACT_FIELD_4",
+              "CONTACT_FIELD_5",
+              "CONTACT_FIELD_6",
+              "CONTACT_FIELD_7",
+              "CONTACT_FIELD_8",
+              "CONTACT_FIELD_9",
+              "CONTACT_FIELD_10",
+              "DATE_CREATED_UTC",
+              "DATE_UPDATED_UTC",
+              "VISIBLE_TO",
+              "VISIBLE_TEAM_ID"
+
+    def initialize(id = nil)
+      @data = {}
+      @data["ADDRESSES"] = []
+      load(id) if id
+    end
+    def remote_id
+      contact_id
+    end
+    def fix_for_link(link)
+      #This needs to auto set the org id on the item
+      link.contact_id = self.remote_id
+      link
+    end
+  end
+end

data/lib/insightly/contact_info.rb

@@ -0,0 +1,61 @@
+module Insightly
+  class ContactInfo
+    def initialize
+      @data = {}
+    end
+
+    def to_json
+      @data.to_json
+    end
+    def build(data)
+      @data = data
+      self
+    end
+
+    def self.build(data)
+      self.new.build(data)
+    end
+
+    def ==(other)
+      self.remote_data == other.remote_data
+    end
+
+    def remote_data
+      @data
+    end
+    def contact_info_id
+      @data["CONTACT_INFO_ID"]
+
+    end
+    def type
+      @data["TYPE"]
+    end
+    def subtype
+      @data["SUBTYPE"]
+    end
+    def label
+      @data["LABEL"]
+    end
+    def detail
+      @data["DETAIL"]
+    end
+
+    def contact_info_id=(value)
+      @data["CONTACT_INFO_ID"] = value
+
+    end
+    def type=(value)
+      @data["TYPE"] = value
+    end
+    def subtype=(value)
+      @data["SUBTYPE"] = value
+    end
+    def label=(value)
+      @data["LABEL"] = value
+    end
+    def detail=(value)
+      @data["DETAIL"] = value
+    end
+
+  end
+end

data/lib/insightly/contact_info_helper.rb

@@ -0,0 +1,14 @@
+module Insightly
+  module ContactInfoHelper
+    def contact_infos
+         @data["CONTACTINFOS"].collect {|a| Insightly::ContactInfo.build(a)}
+     end
+     def contact_infos=(list)
+       @data["CONTACTINFOS"] = list.collect {|a| a.remote_data}
+     end
+     def add_contact_info(contact_info)
+       @data["CONTACTINFOS"] << contact_info.remote_data
+       true
+     end
+  end
+end

data/lib/insightly/link.rb

@@ -0,0 +1,32 @@
+module Insightly
+  class Link < BaseData
+    api_field "LINK_ID",
+              "PROJECT_ID",
+              "CONTACT_ID",
+              "ROLE",
+              "OPPORTUNITY_ID",
+              "DETAILS",
+              "ORGANISATION_ID"
+    def self.add_contact(id,role = nil,detail = nil)
+      item = Link.new
+      item.contact_id = id
+      item.role = role
+      item.details = detail
+      item
+    end
+    def self.add_opportunity(id,role = nil,detail = nil)
+      item = Link.new
+      item.opportunity_id = id
+      item.role = role
+      item.details = detail
+      item
+    end
+    def self.add_organisation(id,role = nil,detail = nil)
+      item = Link.new
+      item.organisation_id = id
+      item.role = role
+      item.details = detail
+      item
+    end
+  end
+end

data/lib/insightly/link_helper.rb

@@ -0,0 +1,14 @@
+module Insightly
+  module LinkHelper
+    def links
+         @data["LINKS"].collect {|a| Insightly::Link.build(a)}
+     end
+     def links=(list)
+       @data["LINKS"] = list.collect {|a| fix_for_link(a).remote_data}
+     end
+     def add_link(link)
+       @data["LINKS"] << fix_for_link(link).remote_data
+       true
+     end
+  end
+end

data/lib/insightly/opportunity.rb

@@ -1,7 +1,6 @@
-
-#METODO Confirm that we can create an opportunity
 module Insightly
   class Opportunity < ReadWrite
+    include Insightly::LinkHelper
     self.url_base = "Opportunities"
     CUSTOM_FIELD_PREFIX = "OPPORTUNITY_FIELD"
     api_field "OPPORTUNITY_FIELD_10",
@@ -35,7 +34,6 @@ module Insightly
               "OPPORTUNITY_NAME",
               "OPPORTUNITY_ID",
               "VISIBLE_USER_IDS",
-              "LINKS",
               "RESPONSIBLE_USER_ID",
               "OPPORTUNITY_DETAILS"
 
@@ -111,5 +109,11 @@ module Insightly
       end
 
     end
+    def fix_for_link(link)
+       #This needs to auto set the org id on the item
+       link.opportunity_id = self.remote_id
+       link
+     end
   end
+
 end

data/lib/insightly/organisation.rb

@@ -0,0 +1,45 @@
+module Insightly
+  class Organisation < ReadWrite
+    include Insightly::AddressHelper
+    include Insightly::ContactInfoHelper
+    include Insightly::LinkHelper
+    self.url_base = "Organisations"
+    CUSTOM_FIELD_PREFIX = "ORGANISATION_FIELD"
+    api_field "ORGANISATION_ID",
+              "ORGANISATION_NAME",
+              "BACKGROUND",
+              "ORGANISATION_FIELD_1",
+              "ORGANISATION_FIELD_2",
+              "ORGANISATION_FIELD_3",
+              "ORGANISATION_FIELD_4",
+              "ORGANISATION_FIELD_5",
+              "ORGANISATION_FIELD_6",
+              "ORGANISATION_FIELD_7",
+              "ORGANISATION_FIELD_8",
+              "ORGANISATION_FIELD_9",
+              "ORGANISATION_FIELD_10",
+              "OWNER_USER_ID",
+              "DATE_CREATED_UTC",
+              "DATE_UPDATED_UTC",
+              "VISIBLE_TO",
+              "VISIBLE_TEAM_ID"
+
+    def initialize(id = nil)
+      @data = {}
+      @data["ADDRESSES"] = []
+      load(id) if id
+    end
+
+    def remote_id
+      organisation_id
+    end
+
+    def fix_for_link(link)
+      #This needs to auto set the org id on the item
+      link.organisation_id = self.remote_id
+      link
+    end
+
+  end
+
+end

data/lib/insightly/read_only.rb

@@ -4,7 +4,6 @@ module Insightly
       @data = {}
 
     end
-
     def build(data)
       @data = data
       self

data/lib/insightly/read_write.rb

@@ -1,11 +1,17 @@
 module Insightly
   class ReadWrite < Base
+    def to_json
+      @data.to_json
+    end
+    def update_data(data)
+      @data = data
+    end
     def save
       if !remote_id
-        @data = post_collection("#{url_base}", @data.to_json)
+        update_data(post_collection("#{url_base}", self.to_json))
       else
 
-        @data = put_collection("#{url_base}/#{remote_id}", @data.to_json)
+        update_data(put_collection("#{url_base}/#{remote_id}", self.to_json))
 
       end
 

data/lib/insightly/task.rb

@@ -1,8 +1,28 @@
-#METODO Find a way to link a task to an opportunity
-
 module Insightly
   class Task < ReadWrite
+    include Insightly::TaskLinkHelper
     self.url_base = "Tasks"
+    api_field "TASK_ID",
+              "TITLE",
+              "CATEGORY_ID",
+              "DUE_DATE",
+              "COMPLETED_DATE_UTC",
+              "PUBLICLY_VISIBLE",
+              "COMPLETED",
+              "PROJECT_ID",
+              "DETAILS",
+              "STATUS",
+              "PRIORITY",
+              "PERCENT_COMPLETE",
+              "START_DATE",
+              "ASSIGNED_BY_USER_ID",
+              "PARENT_TASK_ID",
+              "RECURRENCE",
+              "RESPONSIBLE_USER_ID",
+              "OWNER_USER_ID",
+              "DATE_CREATED_UTC",
+              "DATE_UPDATED_UTC",
+              "TASKLINKS"
 
     def comments
       list = []
@@ -11,33 +31,13 @@ module Insightly
       end
       list
     end
+
     def comment_on(body)
-      comment = Insightly::Comment.new.build({ "BODY" => body})
+      comment = Insightly::Comment.new.build({"BODY" => body})
       result = post_collection("#{url_base}/#{task_id}/comments", comment.remote_data.to_json)
       comment.build(result)
     end
-    #def comment_on(body)
-    #  user_id = 226277
-    #  xml_data = '<?xml version="1.0" encoding="utf-8"?><Comment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><BODY>&lt;p&gt;&amp;nbsp;Hello Nurse&lt;/p&gt;</BODY><OWNER_USER_ID>226277</OWNER_USER_ID><FILE_ATTACHMENTS/></Comment>'
-    #
-    #
-    #  post_collection("#{url_base}/#{task_id}/comments", xml_data, :xml)
-    #end
-    #
-    #def comments
-    #  data = get_collection("#{url_base}/#{task_id}/Comments")
-    #  list = []
-    #  data.each do |x|
-    #  end
-    #  list
-    #end
 
-    def status
-      @data["STATUS"]
-    end
-    def status=(new_status)
-      @data["STATUS"] = new_status
-    end
     def not_started?
       status == "NOT STARTED"
     end
@@ -58,15 +58,16 @@ module Insightly
       status == "DEFERRED"
     end
 
-    def task_id
-      @data["TASK_ID"]
-    end
 
     def remote_id
       task_id
     end
 
-
+    def fix_for_link(link)
+      #This needs to auto set the org id on the item
+      link.task_id = self.remote_id
+      link
+    end
 
   end
 end