insightly 0.2.8 → 0.2.9

data/README.md

@@ -6,6 +6,11 @@ This is a rest client library to handle talking to http://Insight.ly
 The official API for Insigh.ly was released on August 12, 2012.  This library is in the very early stages of implementing access to everything expose in
 that API.  The focus is primarily on opportunities and tasks.
 
+Freedom isn't Free - Neither is the API
+===========
+
+You have to be a paying customer of Insight.ly to use the API. If you are on a free plan, then it will give you 401 errors when you try to do anything with the API
+
 Getting Started
 =========
 

data/lib/insightly/base.rb

@@ -1,17 +1,20 @@
+#METODO need to be able to delete records
+#METODO create a script that can talk to the remote insightly install and confirm that everything still workd
+#METODO re-write all the tests so that they store local data to work against
 #METODO contacts allow you to set special dates to remember - can we access that via api?
-#METODO It should have a method for converting date/time to the Insightly format
 #METODO custom fields expect text,drop down, or date - add better handling (text should cast to_s)
 #METODO contact infos should auto filter out duplicate entries
 #METODO all the helpers should auto filter out duplicates (links,contact info,address etc)
 #METODO only allow build to set fields that are part of the API fields
 #METODO Fix all tests so they don't require the existence of certain object ids
-
+#METODO add support for $top $skip and Brief=true for the things that suppor them
 #METODO make a distinction between fields that you can set and save and ones you can only read - like DATE_UPDATED_UTC
+
 module Insightly
   class Base
 
     class << self
-      attr_accessor :api_fields,:url_base
+      attr_accessor :api_fields, :url_base, :remote_id_field
     end
     self.api_fields = []
 
@@ -46,6 +49,9 @@ module Insightly
       end
     end
 
+    def self.date_to_insightly(date = Date.today)
+      date.strftime("%Y-%m-%d %H:%M:%S")
+    end
     def initialize(id = nil)
       @data = {}
       load(id) if id
@@ -55,8 +61,22 @@ module Insightly
     def url_base
       self.class.url_base
     end
+
+    def remote_id_field
+      return self.class.remote_id_field if self.class.remote_id_field
+      self.class.to_s.downcase.gsub("insightly::", "") + "_id"
+    end
+
     def remote_id
-      raise ScriptError, "This should be overridden in the subclass"
+      self.send(remote_id_field.to_sym)
+    end
+
+    def remote_id=(value)
+      self.send("#{remote_id_field}=", value)
+    end
+
+    def remote_id?
+      self.remote_id.nil? || self.remote_id.to_s.empty? ? false : true
     end
 
     def load(id)
@@ -67,9 +87,11 @@ module Insightly
     def reload
       load(remote_id)
     end
+
     def to_json
-       @data.to_json
-     end
+      @data.to_json
+    end
+
     def build(data)
       @data = data
       self
@@ -123,7 +145,9 @@ module Insightly
       end
       list
     end
-
+    #def self.to_insightly_date(date)
+    #   date.strftime("%Y-%m-%d 00:00:00")
+    #end
 
   end
 end

data/lib/insightly/comment.rb

@@ -1,7 +1,8 @@
 #METODO Add support for FileAttachment xml
+#METODO the load via xml and load via json do not return the same format data
 module Insightly
   class Comment < ReadWrite
-    URL_BASE = "Comments"
+    self.url_base = "Comments"
 
     api_field "COMMENT_ID",
               "BODY",
@@ -41,7 +42,6 @@ module Insightly
 
     def load(id)
       load_from_xml(get_collection("#{url_base}/#{id}", :xml_raw))
-
     end
 
     def save

data/lib/insightly/link.rb

@@ -29,4 +29,4 @@ module Insightly
       item
     end
   end
-end
+end

data/lib/insightly/link_helper.rb

@@ -1,16 +1,43 @@
+#METODO be able to ask the object for a list of project_ids and projects
 module Insightly
   module LinkHelper
     def links
       @data["LINKS"] ||= []
-         @data["LINKS"].collect {|a| Insightly::Link.build(a)}
-     end
-     def links=(list)
-       @data["LINKS"] = list ? list.collect {|a| fix_for_link(a).remote_data} : []
-     end
-     def add_link(link)
-       @data["LINKS"] ||= []
-       @data["LINKS"] << fix_for_link(link).remote_data
-       true
-     end
+      @data["LINKS"].collect { |a| Insightly::Link.build(a) }
+    end
+
+    def links=(list)
+      @data["LINKS"] = list ? list.collect { |a| fix_for_link(a).remote_data } : []
+    end
+
+    def add_link(link)
+      @data["LINKS"] ||= []
+      @data["LINKS"] << fix_for_link(link).remote_data
+      true
+    end
+    def contact_ids
+      self.links.collect { |link| link.contact_id}.compact
+    end
+    def opportunity_ids
+      self.links.collect { |link| link.opportunity_id}.compact
+    end
+    def organisation_ids
+      self.links.collect { |link| link.organisation_id}.compact
+    end
+    def contacts
+      self.contact_ids.collect { |id| Insightly::Contact.new(id)}
+    end
+    def opportunities
+      self.opportunity_ids.collect { |id| Insightly::Opportunity.new(id)}
+    end
+    def organisations
+      self.organisation_ids.collect { |id| Insightly::Organisation.new(id)}
+    end
+    #def project_ids
+    #    self.links.collect { |link| link.project_id}.compact
+    #end
+    #def projects
+    #  self.project_ids.collect { |id| Insightly::Project.new(id)}
+    #end
   end
-end
+end

data/lib/insightly/opportunity.rb

@@ -37,11 +37,6 @@ module Insightly
               "RESPONSIBLE_USER_ID",
               "OPPORTUNITY_DETAILS"
 
-
-    def remote_id
-      opportunity_id
-    end
-
     def tasks
       list = []
       Insightly::TaskLink.search_by_opportunity_id(opportunity_id).each do |x|

data/lib/insightly/organisation.rb

@@ -44,4 +44,4 @@ module Insightly
 
   end
 
-end
+end

data/lib/insightly/task.rb

@@ -1,5 +1,3 @@
-#METODO make it so you can just say task.add_contact(contact/contact_id) (for opportunity and organisation as well)
-#METODO warn them about how you have to save a task before you can link it up
 module Insightly
   class Task < ReadWrite
     include Insightly::TaskLinkHelper
@@ -61,12 +59,7 @@ module Insightly
     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

data/lib/insightly/task_link.rb

@@ -1,3 +1,5 @@
+#METODO add support for project
+
 module Insightly
   class TaskLink < ReadOnly
     self.url_base ="TaskLinks"

data/lib/insightly/task_link_helper.rb

@@ -1,16 +1,89 @@
+#METODO add support for project
 module Insightly
   module TaskLinkHelper
     def task_links
       @data["TASKLINKS"] ||= []
-         @data["TASKLINKS"].collect {|a| Insightly::TaskLink.build(a)}
-     end
-     def task_links=(list)
-       @data["TASKLINKS"] = list ? list.collect {|a| fix_for_link(a).remote_data} : []
-     end
-     def add_task_link(link)
-       @data["TASKLINKS"] ||= []
-       @data["TASKLINKS"] << fix_for_link(link).remote_data
-       true
-     end
+      @data["TASKLINKS"].collect { |a| Insightly::TaskLink.build(a) }
+    end
+
+    def task_links=(list)
+      @data["TASKLINKS"] = list ? list.collect { |a| fix_for_link(a).remote_data } : []
+    end
+
+    def add_task_link(link)
+      raise(ScriptError, "You must save the #{self.class} before adding a link.") if !remote_id
+      @data["TASKLINKS"] ||= []
+      @data["TASKLINKS"] << fix_for_link(link).remote_data
+      true
+    end
+    def contact_ids
+        list_ids_by_type("contact")
+      end
+  
+      def contacts
+        list_objs_by_type("contact", Insightly::Contact)
+      end
+  
+      def add_contact_id(contact_id)
+        add_by_id("contact", contact_id)
+      end
+  
+      def add_contact(contact)
+        add_by_obj("contact", contact)
+      end
+    
+    
+    
+    def opportunity_ids
+      list_ids_by_type("opportunity")
+    end
+
+    def opportunities
+      list_objs_by_type("opportunity", Insightly::Opportunity)
+    end
+
+    def add_opportunity_id(opportunity_id)
+      add_by_id("opportunity", opportunity_id)
+    end
+
+    def add_opportunity(opportunity)
+      add_by_obj("opportunity", opportunity)
+    end
+    def organisation_ids
+      list_ids_by_type("organisation")
+    end
+
+    def organisations
+      list_objs_by_type("organisation", Insightly::Organisation)
+    end
+
+    def add_organisation_id(organisation_id)
+      add_by_id("organisation", organisation_id)
+    end
+
+    def add_organisation(organisation)
+      add_by_obj("organisation", organisation)
+    end
+
+    def list_ids_by_type(type)
+      self.task_links.collect { |task_link| task_link.send("#{type}_id".to_sym) }.compact
+    end
+
+    def list_objs_by_type(type,klass)
+      self.send("#{type}_ids".to_sym).collect { |id| klass.new(id) }
+    end
+
+    def add_by_id(type, id)
+      return false if !id
+         self.save if !remote_id?
+         add_task_link(Insightly::TaskLink.send("add_#{type}".to_sym,id))
+         self.save
+    end
+
+    def add_by_obj(type, obj)
+      obj.save if !obj.remote_id?
+      self.send("add_#{type}_id".to_sym, obj.remote_id)
+    end
+    protected :list_ids_by_type, :list_objs_by_type, :add_by_id, :add_by_obj
   end
 end

data/lib/insightly/version.rb

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

data/spec/spec_helper.rb

@@ -7,12 +7,30 @@
 require "rubygems"
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __FILE__)
 
+
+
 require 'bundler/setup'  if File.exists?(ENV['BUNDLE_GEMFILE'])
 Bundler.require(:default, :testing) if defined?(Bundler)
 
+
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'cassettes'
+  c.hook_into :webmock
+  c.default_cassette_options = {:record => :new_episodes} # :new_episodes, :none, :all
+  c.ignore_localhost = true
+ # c.allow_http_connections_when_no_cassette = true
+  c.filter_sensitive_data('<API_KEY>') { INSIGHTLY_API_KEY }
+end
+
+
+
 require "insightly"
 require File.expand_path(File.dirname(__FILE__) + "/../api_key")
 RSpec.configure do |config|
+  config.extend VCR::RSpec::Macros
+
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
@@ -23,3 +41,39 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
 end
+
+def simple_insightly_user
+
+  VCR.use_cassette('all insightly users', :allow_playback_repeats => true) do
+      return Insightly::User.all.first
+  end
+
+end
+
+def simple_insightly_task(title = nil)
+  VCR.use_cassette('simple task', :allow_playback_repeats => true) do
+        task = Insightly::Task.new.build({"STATUS" => "Completed",
+                                           "RESPONSIBLE_USER_ID" => simple_insightly_user.user_id,
+                                           "OWNER_USER_ID" => simple_insightly_user.user_id,
+                                           "TITLE" => title ? title : "000 Test Task #{Date.today}"
+                                          })
+        task.save
+    return task
+  end
+
+end
+def simple_insightly_organisation(title = nil)
+  VCR.use_cassette('simple contact') do
+
+  end
+end
+def simple_insightly_opportunity(title = nil)
+  VCR.use_cassette('simple contact') do
+
+  end
+end
+def simple_insightly_contact(first_name = nil, last_name = nil)
+  VCR.use_cassette('simple contact') do
+
+  end
+end

data/spec/unit/comment_spec.rb

@@ -39,9 +39,25 @@ describe Insightly::Comment do
     @comment.remote_id.should == @comment.comment_id
   end
   it "should allow you to load based on an id" do
-    #METODO This should create the comment so we can make sure it exists - once that feature is available
-    @comment = Insightly::Comment.new(768880)
-    @comment.comment_id.should == 768880
+    VCR.use_cassette('create and load comment') do
+      @user = Insightly::User.all.first
+
+      @task = Insightly::Task.new
+      @task.title = "000 Test Task"
+      @task.status = "Completed"
+      @task.owner_user_id = @user.user_id
+      @task.responsible_user_id = @user.user_id
+      @task.save
+      @task.comment_on("Sample Comment")
+      @saved_comment = @task.comments.first
+
+
+      @comment = Insightly::Comment.new(@saved_comment.comment_id)
+      @comment.comment_id.should == @saved_comment.comment_id
+      @comment.body.should == @saved_comment.body
+
+
+    end
   end
   it "should allow you to build an object from a hash" do
     comment = Insightly::Comment.new.build({"BODY" => "Other"})
@@ -77,15 +93,34 @@ describe Insightly::Comment do
   end
 
   it "should allow you to modify a comment" do
-    @comment = Insightly::Comment.new(769043)
-    before_body = @comment.body
-    value = "Test Comment Edit #{Time.now}"
-    @comment.body = value
-    @comment.save
-    @comment.body.should == value
-
-    @comment.reload
-    @comment.body.should == value
+    VCR.use_cassette('first insightly user') do
+      @user = Insightly::User.all.first
+    end
+    VCR.use_cassette('create and modify comment') do
+
+
+      @task = Insightly::Task.new
+      @task.title = "000 Test Task"
+      @task.status = "Completed"
+      @task.owner_user_id = @user.user_id
+      @task.responsible_user_id = @user.user_id
+      @task.save
+      @task.comment_on("Sample Comment")
+      @saved_comment = @task.comments.first
+
+      @comment = Insightly::Comment.new(@saved_comment.comment_id)
+      @comment.body.should == "Sample Comment"
+
+      value = "Test Comment Edit Now"
+      @comment.body = value
+      @comment.save
+      @comment.body.should == value
+      @comment.reload
+      @comment.body.should == value
+
+    end
+
+
   end