insightly 0.1.1

data/lib/insightly/opportunity_state_reason.rb

@@ -0,0 +1,46 @@
+module Insightly
+  class OpportunityStateReason < ReadOnly
+    self.url_base = "OpportunityStateReasons"
+    STATES = ["Abandoned", "Lost", "Open", "Suspended", "Won"]
+    api_field "STATE_REASON_ID",
+              "FOR_OPPORTUNITY_STATE",
+              "STATE_REASON"
+
+
+    def self.find_by_state(state)
+      list = []
+      OpportunityStateReason.all.each.each do |x|
+        if x.for_opportunity_state && x.for_opportunity_state.match(state)
+          list << x
+        end
+      end
+      list
+    end
+
+    def self.find_by_state_reason(state,reason)
+      OpportunityStateReason.all.each.each do |x|
+              return x if x.for_opportunity_state && x.for_opportunity_state.match(state) && x.state_reason == reason
+      end
+      nil
+    end
+    STATES.each do |state|
+
+      (
+      class << self;
+        self;
+      end).instance_eval do
+        define_method state.downcase.to_sym do |*args|
+          reason = args.first
+          if reason
+            OpportunityStateReason.find_by_state_reason(state,reason)
+          else
+            OpportunityStateReason.find_by_state(state)
+          end
+
+        end
+      end
+
+    end
+
+  end
+end

data/lib/insightly/read_only.rb

@@ -0,0 +1,52 @@
+module Insightly
+  class ReadOnly < Base
+    def initialize
+      @data = {}
+
+    end
+
+    def url_base
+      self.class.const_get(:URL_BASE)
+    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 process(result, content_type)
+      puts result
+      if content_type == :json
+        JSON.parse(result.to_str)
+      elsif content_type == :xml
+        Hash.from_xml(result.to_str)
+      else
+        result.to_str
+      end
+    end
+
+    def config
+      Insightly::Configuration.instantiate
+    end
+
+    def get_collection(path, content_type = :json)
+      response = RestClient::Request.new(:method => :get,
+                                         :url => "#{config.endpoint}/#{path.to_s}",
+                                         :user => config.api_key,
+                                         :password => "",
+                                         :headers => {:accept => content_type, :content_type => content_type}).execute
+      process(response, content_type)
+    end
+
+
+
+  end
+end

data/lib/insightly/read_write.rb

@@ -0,0 +1,44 @@
+module Insightly
+  class ReadWrite < Base
+    def save
+      if !remote_id
+        @data = post_collection("#{url_base}", @data.to_json)
+      else
+
+        @data = put_collection("#{url_base}/#{remote_id}", @data.to_json)
+
+      end
+
+    end
+
+    def post_collection(path, params, content_selector = :json)
+      if content_selector == :xml_raw
+        content_type = :xml
+      else
+        content_type = content_selector
+      end
+      response = RestClient::Request.new(:method => :post,
+                                         :url => "#{config.endpoint}/#{path.to_s}",
+                                         :user => config.api_key,
+                                         :password => "",
+                                         :payload => params,
+                                         :headers => {:accept => content_type, :content_type => content_type}).execute
+      process(response, content_selector)
+    end
+
+    def put_collection(path, params, content_selector = :json)
+      if content_selector == :xml_raw
+        content_type = :xml
+      else
+        content_type = content_selector
+      end
+      response = RestClient::Request.new(:method => :put,
+                                         :url => "#{config.endpoint}/#{path.to_s}",
+                                         :user => config.api_key,
+                                         :password => "",
+                                         :payload => params,
+                                         :headers => {:accept => content_type, :content_type => content_type}).execute
+      process(response, content_selector)
+    end
+  end
+end

data/lib/insightly/task.rb

@@ -0,0 +1,72 @@
+#METODO Find a way to link a task to an opportunity
+
+module Insightly
+  class Task < ReadWrite
+    self.url_base = "Tasks"
+
+    def comments
+      list = []
+      get_collection("#{url_base}/#{task_id}/comments").each do |d|
+        list << Insightly::Comment.build(d)
+      end
+      list
+    end
+    def comment_on(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
+
+    def in_progress?
+      status == "IN PROGRESS"
+    end
+
+    def waiting?
+      status == "WAITING"
+    end
+
+    def completed?
+      status == "COMPLETED"
+    end
+
+    def deferred?
+      status == "DEFERRED"
+    end
+
+    def task_id
+      @data["TASK_ID"]
+    end
+
+    def remote_id
+      task_id
+    end
+
+
+
+  end
+end

data/lib/insightly/task_link.rb

@@ -0,0 +1,22 @@
+module Insightly
+  class TaskLink < ReadOnly
+    self.url_base ="TaskLinks"
+
+    def opportunity_id
+      @data["OPPORTUNITY_ID"]
+    end
+    def task_id
+      @data["TASK_ID"]
+    end
+
+    def self.search_by_opportunity_id(opportunity_id)
+      list = []
+      TaskLink.all.each do |x|
+        if  !x.task_id.nil? && x.opportunity_id == opportunity_id
+          list << x
+        end
+      end
+      list
+    end
+  end
+end

data/lib/insightly/version.rb

@@ -0,0 +1,10 @@
+#This file is based heavily off of the Braintree::Version
+#Copyright (c) 2009-2010 Braintree Payment Solutions
+module Insightly
+  module Version
+    Major = 0
+    Minor = 1
+    Tiny = 1
+    String = "#{Major}.#{Minor}.#{Tiny}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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 "insightly"
+require File.expand_path(File.dirname(__FILE__) + "/../api_key")
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end

data/spec/unit/base_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Insightly::Base do
+  before(:each) do
+  end
+end

data/spec/unit/comment_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Insightly::Comment do
+  before(:each) do
+    Insightly::Configuration.api_key = INSIGHTLY_API_KEY
+    Insightly::Configuration.logger = Insightly::Configuration._debug_logger
+    @comment = Insightly::Comment.new.build({
+                                                "COMMENT_ID" => 132456,
+                                                "BODY" => "test comment",
+                                                "OWNER_USER_ID" => 12345,
+                                                "DATE_CREATED_UTC" => "2012-03-09 11:59:19",
+                                                "DATE_UPDATED_UTC" => "2012-03-09 11:59:19",
+                                                "FILE_ATTACHMENTS" =>
+                                                    {
+                                                        "FILE_ID" => 4567899,
+                                                        "FILE_NAME" => "test.docx",
+                                                        "CONTENT_TYPE" => "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+                                                        "FILE_SIZE" => 2489,
+                                                        "FILE_CATEGORY_ID" => nil,
+                                                        "OWNER_USER_ID" => 12345,
+                                                        "DATE_CREATED_UTC" => "2012-03-09 11:59:20",
+                                                        "DATE_UPDATED_UTC" => "2012-03-09 11:59:20",
+                                                        "URL" => "/api/fileattachments/4567899"
+                                                    }
+                                            }
+    )
+
+    # @comment = Insightly::Comment.new(3216775)
+  end
+  it "should be able to create a comment" do
+  end
+  it "should have a url base" do
+    @comment.url_base.should == "Comments"
+  end
+  it "should know the comment id" do
+    @comment.comment_id.should == 132456
+  end
+  it "should know that the remote id and the comment id are the same" 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
+  end
+  it "should allow you to build an object from a hash" do
+    comment = Insightly::Comment.new.build({"BODY" => "Other"})
+    comment.remote_data.should == {"BODY" => "Other"}
+  end
+  context "xml" do
+    before(:each) do
+      @raw_xml = <<-END_XML
+<?xml version="1.0" encoding="utf-8"?>
+        <Comment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+        <COMMENT_ID>132456</COMMENT_ID>
+        <BODY>test comment</BODY>
+        <OWNER_USER_ID>12345</OWNER_USER_ID>
+        <DATE_CREATED_UTC>2012-03-09T23:59:19.503</DATE_CREATED_UTC>
+        <DATE_UPDATED_UTC>2012-03-09T23:59:19.503</DATE_UPDATED_UTC>
+        <FILE_ATTACHMENTS></FILE_ATTACHMENTS>
+        </Comment>
+      END_XML
+    end
+    it "should be able to parse the xml into a valid comment" do
+      @comment = Insightly::Comment.new.load_from_xml(@raw_xml)
+      @comment.comment_id.should == 132456
+      @comment.body.should == "test comment"
+      @comment.date_created_utc.should == "2012-03-09T23:59:19.503"
+      @comment.date_updated_utc.should == "2012-03-09T23:59:19.503"
+      @comment.owner_user_id.should == 12345
+
+    end
+    it "should be able to generate xml from the commment" do
+      @comment = Insightly::Comment.new.load_from_xml(@raw_xml)
+      @comment.to_xml.should == @raw_xml
+    end
+  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
+  end
+
+
+end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Insightly::Configuration do
+  #customer_user_agent
+  #endpoint
+  #logger
+  #api_key
+  before(:each) do
+    Insightly::Configuration.custom_user_agent = nil
+    Insightly::Configuration.api_key = "123"
+    Insightly::Configuration.endpoint = nil
+  end
+  it "should provide a default user agent" do
+
+    Insightly::Configuration.instantiate.custom_user_agent.should be_nil
+    Insightly::Configuration.instantiate.user_agent.should == "Insightly Ruby Gem 0.1.0"
+  end
+  it "should allow you to override the user agent" do
+
+    Insightly::Configuration.custom_user_agent = "Bob"
+    Insightly::Configuration.instantiate.user_agent.should == "Insightly Ruby Gem 0.1.0 (Bob)"
+  end
+  it "should provide a default endpoint" do
+    Insightly::Configuration.instantiate.endpoint.should == "https://api.insight.ly/v1"
+  end
+  it "should allow you to override the endpoint" do
+    Insightly::Configuration.endpoint = "Bob"
+    Insightly::Configuration.instantiate.endpoint.should == "Bob"
+  end
+  it "should raise an error if you do not set an api key" do
+    Insightly::Configuration.instance_variable_set(:@api_key, nil)
+    expect do
+      Insightly::Configuration.api_key
+    end.to raise_error(Insightly::ConfigurationError, "Insightly::Configuration.api_key needs to be set")
+    expect do
+         Insightly::Configuration.instantiate.api_key
+       end.to raise_error(Insightly::ConfigurationError, "Insightly::Configuration.api_key needs to be set")
+  end
+  it "should allow you to set the api_key" do
+    Insightly::Configuration.api_key = "Bob"
+    Insightly::Configuration.api_key.should == "Bob"
+    Insightly::Configuration.instantiate.api_key.should == "Bob"
+  end
+  it "should be able to set custom fields for opportunities" do
+    Insightly::Opportunity.should_receive(:custom_fields).with(:rank, :branch_of_service)
+
+    Insightly::Configuration.custom_fields_for_opportunities(:rank, :branch_of_service)
+
+  end
+end

data/spec/unit/opportunity_spec.rb

@@ -0,0 +1,180 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Insightly::Opportunity do
+  before(:each) do
+    Insightly::Configuration.api_key = INSIGHTLY_API_KEY
+    Insightly::Configuration.logger = Insightly::Configuration._debug_logger
+    @opportunity = Insightly::Opportunity.build({
+                                                    "OPPORTUNITY_FIELD_10" => nil,
+                                                    "OPPORTUNITY_FIELD_9" => nil,
+                                                    "OPPORTUNITY_FIELD_8" => "Bob Roberts",
+                                                    "OPPORTUNITY_FIELD_7" => "r26D Trucking",
+                                                    "OPPORTUNITY_FIELD_6" => "TruckingOffice",
+                                                    "OPPORTUNITY_FIELD_5" => "Owner/Operator",
+                                                    "OPPORTUNITY_FIELD_4" => "Central",
+                                                    "OPPORTUNITY_FIELD_3" => "210-555-1212",
+                                                    "OPPORTUNITY_FIELD_2" => "http://www.truckingoffice.com/522",
+                                                    "OPPORTUNITY_FIELD_1" => nil,
+                                                    "VISIBLE_TO" => "EVERYONE",
+                                                    "BID_TYPE" => "Fixed Bid",
+                                                    "ACTUAL_CLOSE_DATE" => nil,
+                                                    "DATE_UPDATED_UTC" => "2012-06-06 02:05:34",
+                                                    "OWNER_USER_ID" => 226277,
+                                                    "BID_DURATION" => nil,
+                                                    "BID_CURRENTY" => "USD",
+                                                    "PIPELINE_ID" => 24377,
+                                                    "CATEGORY_ID" => 628187,
+                                                    "PROBABILITY" => nil,
+                                                    "TAGS" => [],
+                                                    "IMAGE_URL" => "http://s3.amazonaws.com/insightly.userfiles/20562/",
+                                                    "BID_AMOUNT" => 20,
+                                                    "VISIBLE_TEAM_ID" => nil,
+                                                    "STAGE_ID" => 71162,
+                                                    "DATE_CREATED_UTC" => "2012-09-06 02:04:47",
+                                                    "OPPORTUNITY_STATE" => "OPEN",
+                                                    "FORECAST_CLOSE_DATE" => "2012-10-05 00:00:00",
+                                                    "OPPORTUNITY_NAME" => "Sample Opportunity",
+                                                    "OPPORTUNITY_ID" => 957168,
+                                                    "VISIBLE_USER_IDS" => nil,
+                                                    "LINKS" => [],
+                                                    "RESPONSIBLE_USER_ID" => 226277,
+                                                    "OPPORTUNITY_DETAILS" => "This is a description."
+
+                                                })
+  end
+  it "should be able to create a opportunity" do
+  end
+  it "should have a url base" do
+    @opportunity.url_base.should == "Opportunities"
+  end
+  it "should know the opportunity id" do
+    @opportunity.opportunity_id.should == 957168
+  end
+  it "should know that the remote id and the opportunity id are the same" do
+    @opportunity.remote_id.should == @opportunity.opportunity_id
+  end
+  it "should allow you to load based on an id"
+  it "should allow you to build an object from a hash" do
+    opportunity = Insightly::Opportunity.new.build({"TITLE" => "Other"})
+    opportunity.remote_data.should == {"TITLE" => "Other"}
+  end
+  it "should have allow you to read and write all fields" do
+    fields = Insightly::Opportunity.api_fields
+
+    Insightly::Opportunity.api_fields.each do |f|
+      @opportunity.send(f.downcase.to_sym).should == @opportunity.remote_data[f]
+      @opportunity.send("#{f.downcase}=".to_sym, "Bob")
+      @opportunity.send(f.downcase.to_sym).should == "Bob"
+    @opportunity.remote_data[f].should == "Bob"
+    end
+  end
+  it "should allow you to define custom field labels" do
+    Insightly::Opportunity.custom_fields(:dummy1, :dummy2, :dummy3)
+    @opportunity.dummy1.should == @opportunity.remote_data["OPPORTUNITY_FIELD_1"]
+    @opportunity.dummy2.should == "http://www.truckingoffice.com/522"
+    @opportunity.dummy3.should == @opportunity.remote_data["OPPORTUNITY_FIELD_3"]
+
+    @opportunity.dummy1 = "Bob1"
+    @opportunity.dummy2 = "Bob2"
+    @opportunity.dummy3 = "Bob3"
+
+    @opportunity.dummy1.should == "Bob1"
+    @opportunity.dummy2.should == "Bob2"
+    @opportunity.dummy3.should == "Bob3"
+    @opportunity.remote_data["OPPORTUNITY_FIELD_1"].should == "Bob1"
+    @opportunity.remote_data["OPPORTUNITY_FIELD_2"].should == "Bob2"
+    @opportunity.remote_data["OPPORTUNITY_FIELD_3"].should == "Bob3"
+  end
+  it "should handle special fields" do
+    Insightly::Opportunity.custom_fields(:dummy1, :admin_url, :phone_number, :timezone, :plan, :organization, :company_name, :contact_name)
+    @opportunity.admin_url.should == "http://www.truckingoffice.com/522"
+    @opportunity.phone_number.should == "210-555-1212"
+    @opportunity.timezone.should == "Central"
+    @opportunity.plan.should == "Owner/Operator"
+    @opportunity.organization.should == "TruckingOffice"
+    @opportunity.company_name.should == "r26D Trucking"
+    @opportunity.contact_name.should == "Bob Roberts"
+  end
+  context "search/find" do
+    before(:each) do
+      @opp1 = Insightly::Opportunity.build(@opportunity.remote_data.clone)
+      @opp1.opportunity_name = "Apple Sale"
+      @opp2 = Insightly::Opportunity.build(@opportunity.remote_data.clone)
+      @opp2.opportunity_name = "Apple Sale 2"
+      @opp3 = Insightly::Opportunity.build(@opportunity.remote_data.clone)
+      @opp3.opportunity_name = "Box Sale"
+      @opp4 = Insightly::Opportunity.build(@opportunity.remote_data.clone)
+      @opp4.opportunity_name = nil
+
+      Insightly::Opportunity.should_receive(:all).and_return([@opp1, @opp2, @opp3, @opp4])
+
+    end
+    it "should find all the names that match" do
+  Insightly::Opportunity.search_by_name("Apple").should == [@opp1, @opp2]
+    end
+    it "should return an empty array if there are not matches" do
+      Insightly::Opportunity.search_by_name("Cobra").should == []
+    end
+    it "should find the first one that is exactly the right" do
+      Insightly::Opportunity.find_by_name("Apple Sale 2").should == @opp2
+    end
+    it "should return nil if no opportunity name is found" do
+      Insightly::Opportunity.find_by_name("Cobra").should == nil
+    end
+  end
+
+  context "State" do
+    it "should have state booleans" do
+
+      states = Insightly::OpportunityStateReason::STATES
+      states.each do |state|
+        opportunity = Insightly::Opportunity.build({"OPPORTUNITY_STATE" => state})
+
+        states.each do |current_state|
+          if state == current_state
+            opportunity.send("#{current_state.downcase}?".to_sym).should be_true
+
+          else
+            opportunity.send("#{current_state.downcase}?".to_sym).should be_false
+          end
+        end
+      end
+
+    end
+    it "should be able to search by state" do
+
+    end
+    it "should allow you to change the state without a reason" do
+      @opportunity = Insightly::Opportunity.new(957168)
+
+      @opportunity.open!
+      @opportunity.lost!
+      @opportunity.should be_lost
+      @opportunity.reload
+      @opportunity.should be_lost
+    end
+    it "should allow you to provide a reason - and the state should change if the reason isn't valid" do
+      @opportunity = Insightly::Opportunity.new(957168)
+
+      @opportunity.open!
+      @opportunity.won!("Bobobob")
+      @opportunity.reload
+      @opportunity.should be_won
+    end
+
+    it "should allow you to change the state and set the reason" do
+      @opportunity = Insightly::Opportunity.new(957168)
+      Insightly::OpportunityStateReason.find_by_state_reason("Won", "They converted").should_not be_nil
+
+      @opportunity.open!
+      @opportunity.won!("They converted")
+      @opportunity.reload
+      @opportunity.should be_won
+      # Currently there is no way to test the reason is set
+
+    end
+    it "should set the reason to Created by API if you create an opportunity"
+
+  end
+
+end