highrise 2.0.1 → 3.0.0

data/lib/highrise/deal.rb

@@ -1,5 +1,8 @@
 module Highrise
   class Deal < Subject
-
+    def update_status(status)
+      raise ArgumentError, "status must be one of 'pending', 'won', or 'lost'" unless %w[pending won lost].include?(status)
+      self.put(:status, :status => {:name => status})
+    end
   end
 end

data/lib/highrise/deal_category.rb

@@ -0,0 +1,3 @@
+module Highrise
+  class DealCategory < Base; end
+end

data/lib/highrise/group.rb

@@ -1,4 +1,3 @@
 module Highrise
-  class Group < Base
-  end
+  class Group < Base; end
 end

data/lib/highrise/kase.rb

@@ -1,8 +1,19 @@
 module Highrise
   class Kase < Subject
+    def open!
+      update_attribute(:closed_at, nil)
+    end
+
     def close!
-      self.closed_at = Time.now.utc
-      save
+      update_attribute(:closed_at, Time.now.utc)
+    end
+
+    def self.open
+      Kase.find(:all, :from => "/kases/open.xml")
+    end
+
+    def self.closed
+      Kase.find(:all, :from => "/kases/closed.xml")
     end
   end
 end

data/lib/highrise/membership.rb

@@ -1,4 +1,3 @@
 module Highrise
-  class Membership < Base
-  end
+  class Membership < Base; end
 end

data/lib/highrise/pagination.rb

@@ -11,12 +11,19 @@ module Highrise
         records
       end
 
+      # This only is usefull for company, person & recordings, but should be safely ignored by other classes
+      def find_all_across_pages_since(time)
+        find_all_across_pages(:params => { :since => time.utc.strftime("%Y%m%d%H%M%S") })
+      end
+
+      private
+      
       def each(options = {})
         options[:params] ||= {}
         options[:params][:n] = 0
 
         loop do
-          if (records = self.find(:all, options)).any?
+          if (records = self.find(:all, options)).try(:any?)
             records.each { |record| yield record }
             options[:params][:n] += records.size
           else

data/lib/highrise/party.rb

@@ -0,0 +1,11 @@
+module Highrise
+  class Party < Base
+    def self.recently_viewed
+      find(:all, :from => "/parties/recently_viewed.xml")
+    end
+    
+    def self.deletions_since(time)
+      find(:all, :from => "/parties/deletions.xml", :params => { :since => time.utc.strftime("%Y%m%d%H%M%S") })
+    end
+  end
+end

data/lib/highrise/person.rb

@@ -2,11 +2,8 @@ module Highrise
   class Person < Subject
     include Pagination
     include Taggable
+    include Searchable
     
-    def self.find_all_across_pages_since(time)
-      find_all_across_pages(:params => { :since => time.utc.to_s(:db).gsub(/[^\d]/, '') })
-    end
-  
     def company
       Company.find(company_id) if company_id
     end

data/lib/highrise/recording.rb

@@ -0,0 +1,5 @@
+module Highrise
+  class Recording < Base
+    include Pagination
+  end
+end

data/lib/highrise/searchable.rb

@@ -0,0 +1,22 @@
+module Highrise
+  module Searchable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # List By Search Criteria
+      # Ex: Highrise::Person.search(:email => "john.doe@example.com", :country => "CA")
+      # Available criteria are: city, state, country, zip, phone, email
+      def search(options = {})
+        search_params = options.inject({}) { |h, (k, v)| h["criteria[#{k}]"] = v; h }
+        # This might have to be changed in the future if other non-pagable resources become searchable
+        if self.respond_to?(:find_all_across_pages)
+          self.find_all_across_pages(:from => "/#{self.collection_name}/search.xml", :params => search_params)
+        else
+          self.find(:all, {:from => "/#{self.collection_name}/search.xml", :params => search_params})
+        end
+      end
+    end
+  end
+end

data/lib/highrise/subject.rb

@@ -9,6 +9,12 @@ module Highrise
       attrs[:subject_type] = self.label
       Note.create attrs
     end
+    
+    def add_task(attrs={})
+      attrs[:subject_id] = self.id
+      attrs[:subject_type] = self.label
+      Task.create attrs
+    end
 
     def emails
       Email.find_all_across_pages(:from => "/#{self.class.collection_name}/#{id}/emails.xml")

data/lib/highrise/tag.rb

@@ -3,10 +3,5 @@ module Highrise
     def ==(object)
       (object.instance_of?(self.class) && object.id == self.id && object.name == self.name)
     end
-    
-    # You can't find :one because that finds all *objects* with that tag
-    def self.find_by_name(arg)
-      tags = self.find(:all).detect{|tag| tag.name == arg}
-    end
   end
 end

data/lib/highrise/taggable.rb

@@ -3,13 +3,16 @@ module Highrise
     def tags
       self.get(:tags)
     end
+
     def tag!(tag_name)
       self.post(:tags, :name => tag_name) unless tag_name.blank?
     end    
+
     def untag!(tag_name)
       to_delete = self.tags.find{|tag| tag['name'] == tag_name} unless tag_name.blank?
       self.untag_id!(to_delete['id']) unless to_delete.nil?
-    end     
+    end
+    protected
     def untag_id!(tag_id)
       self.delete("tags/#{tag_id}")
     end

data/lib/highrise/task_category.rb

@@ -0,0 +1,3 @@
+module Highrise
+  class TaskCategory < Base; end
+end

data/lib/highrise/version.rb

@@ -0,0 +1,3 @@
+module Highrise
+  VERSION = "3.0.0"
+end

data/spec/highrise/account_spec.rb

@@ -1,16 +1,10 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Highrise::Account do
-  before(:each) do
-    @account = Highrise::Account.new
-  end
-  
-  it "should be instance of Highrise::Base" do
-    @account.kind_of?(Highrise::Base).should be_true
-  end
+  it { should be_a_kind_of Highrise::Base }
   
-  it "should delegate to find(:one, :from => '/account.xml') when account is called" do
-    Highrise::Account.should_receive(:find).with(:one, {:from => "/account.xml"}).and_return(@account)
-    Highrise::Account.me.should == @account
+  it ".me" do
+    Highrise::Account.should_receive(:find).with(:one, {:from => "/account.xml"}).and_return(subject)
+    Highrise::Account.me.should == subject
   end
 end

data/spec/highrise/base_spec.rb

@@ -1,13 +1,48 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Highrise::Base do
-  
-  before(:each) do
-    @base = Highrise::Base.new
-  end
-  
-  it "should be instance of ActiveResource::Base" do
-    @base.kind_of?(ActiveResource::Base).should be_true
+  it { subject.should be_a_kind_of ActiveResource::Base }
+
+  describe "dynamic finder methods" do
+    context "without pagination" do
+      before do
+        @deal_one   = Highrise::Base.new(:id => 1, :name => "A deal")
+        @deal_two   = Highrise::Base.new(:id => 2, :name => "A deal")
+        @deal_three = Highrise::Base.new(:id => 3, :name => "Another deal")
+        Highrise::Base.should_receive(:find).with(:all).and_return([@deal_one, @deal_two, @deal_three])
+      end
+      it ".find_by_(attribute) finds one" do
+        Highrise::Base.find_by_name("A deal").should == @deal_one
+      end
+
+      it ".find_all_by_(attribute) finds all" do
+        Highrise::Base.find_all_by_name("A deal").should == [@deal_one, @deal_two]
+      end
+    end
+
+    context "with pagination" do
+      before do
+        class PaginatedBaseClass < Highrise::Base; include Highrise::Pagination; end
+        @john_doe   = PaginatedBaseClass.new(:id => 1, :first_name => "John")
+        @john_baker = PaginatedBaseClass.new(:id => 2, :first_name => "John")
+        @joe_smith  = PaginatedBaseClass.new(:id => 3, :first_name => "Joe")
+        PaginatedBaseClass.should_receive(:find_all_across_pages).and_return([@john_doe, @john_baker, @joe_smith])
+      end
+      it ".find_by_(attribute) finds one" do
+        PaginatedBaseClass.find_by_first_name("John").should == @john_doe
+      end
+
+      it ".find_all_by_(attribute) finds all" do
+        PaginatedBaseClass.find_all_by_first_name("John").should == [@john_doe, @john_baker]
+      end
+    end
+
+    it "expects arguments to the finder" do
+      expect { Highrise::Base.find_all_by_first_name }.to raise_error(ArgumentError)
+    end
+
+    it "falls back to regular method missing" do
+      expect { Highrise::Base.any_other_method }.to raise_error(NoMethodError)
+    end
   end
-  
-end
+end

data/spec/highrise/comment_spec.rb

@@ -1,14 +1,5 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Highrise::Comment do
-
-  before(:each) do
-    @comment = Highrise::Comment.new
-  end
-  
-  it "should be instance of Highrise::Base" do
-    @comment.kind_of?(Highrise::Base).should be_true
-  end
-
-
+  it { should be_a_kind_of Highrise::Base }
 end

data/spec/highrise/company_spec.rb

@@ -1,79 +1,17 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Highrise::Company do
-
-  before(:each) do
-    Highrise::Base.site = 'http://example.com.i:3000'
-    @company = Highrise::Company.new(:id => 1)
-    returning @tags = [] do 
-      @tags << {'id' => "414578", 'name' => "cliente"}
-      @tags << {'id' => "414580", 'name' => "ged"}
-      @tags << {'id' => "414579", 'name' => "iepc"}
-    end
-  end
-  
-  it "should be instance of Highrise::Base" do
-    @company.kind_of?(Highrise::Base).should be_true
-  end
-  
-  describe ".find_all_across_pages_since" do
-    
-    it "should delegate to find_all_across_pages with correct params" do
-      time = Time.parse("Wed Jan 14 15:43:11 -0200 2009")
-      Highrise::Company.should_receive(:find_all_across_pages).with({:params=>{:since=>"20090114174311"}}).and_return("result")
-      Highrise::Company.find_all_across_pages_since(time).should == "result"
-    end
-
-  end
+  subject { Highrise::Company.new(:id => 1) }
   
-  describe "people" do
-
-    it "should delegate to Highrise::Person.find with correct params" do
-      Highrise::Person.should_receive(:find).with(:all, {:from=>"/companies/1/people.xml"}).and_return("people")
-      @company.people.should == "people"
-    end
+  it { should be_a_kind_of Highrise::Base }
+  it_should_behave_like "a paginated class"
+  it_should_behave_like "a taggable class"
+  it_should_behave_like "a searchable class"
 
+  it "#people" do
+    Highrise::Person.should_receive(:find_all_across_pages).with(:from=>"/companies/1/people.xml").and_return("people")
+    subject.people.should == "people"
   end
   
-  describe ".tags" do
-    
-    it "should return an array of all tags for that company." do
-      @company.should_receive(:get).with(:tags).and_return(@tags)
-      @company.tags.should == @tags
-    end
-    
-  end
-  
-  describe "tag!(tag_name)" do
-  
-    it "should create a tag for this company." do
-      @company.should_receive(:post).with(:tags, :name => "client" ).and_return(true)
-      @company.tag!("client").should be_true
-    end
-    
-  end
-  
-  describe "untag!(tag_name)" do
-  
-    it "should delete a tag for this company." do
-      @company.should_receive(:get).with(:tags).and_return(@tags)
-      @company.should_receive(:delete).with("tags/414578").and_return(true)
-      @company.untag!("cliente").should be_true
-    end
-    
-  end
-
-  describe ".label" do
-    it "should return 'Party' for label" do
-      @company.label.should == 'Party'
-    end
-  end
-
-  describe ".add_note" do
-    it "should delegate to Highrise::Note.create with correct params" do
-      Highrise::Note.should_receive(:create).with({:body=>"body", :subject_id=>1, :subject_type=>'Party'}).and_return(mock('note'))
-      @company.add_note :body=>'body'
-    end
-  end
-
+  it { subject.label.should == 'Party' }
 end

data/spec/highrise/deal_category_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Highrise::DealCategory do
+  subject { Highrise::DealCategory.new(:id => 1, :name => "Deal Category") }
+  
+  it { should be_a_kind_of Highrise::Base }
+  
+  it ".find_by_name" do
+    deal_category = Highrise::DealCategory.new(:id => 2, :name => "Another Deal Category")
+    Highrise::DealCategory.should_receive(:find).with(:all).and_return([deal_category, subject])
+    Highrise::DealCategory.find_by_name("Deal Category").should == subject
+  end
+end

data/spec/highrise/deal_spec.rb

@@ -1,20 +1,23 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Highrise::Deal do
-
-  before(:each) do
-    @deal = Highrise::Deal.new(:id => 1)
-  end
+  subject { Highrise::Deal.new(:id => 1) }
+    
+  it { should be_a_kind_of Highrise::Subject }
   
-  it "should be instance of Highrise::Subject" do
-    @deal.kind_of?(Highrise::Subject).should be_true
+  it ".add_note" do
+    Highrise::Note.should_receive(:create).with({:body=>"body", :subject_id=>1, :subject_type=>'Deal'}).and_return(mock('note'))
+    subject.add_note :body=>'body'
   end
   
-  describe ".add_note" do
-    it "should delegate to Highrise::Note.create with correct params" do
-      Highrise::Note.should_receive(:create).with({:body=>"body", :subject_id=>1, :subject_type=>'Deal'}).and_return(mock('note'))
-      @deal.add_note :body=>'body'
+  describe ".update_status" do
+    it { expect { subject.update_status("invalid") }.to raise_error(ArgumentError) }
+    
+    %w[pending won lost].each do |status|
+      it "updates status to #{status}" do
+        subject.should_receive(:put).with(:status, :status => {:name => status})
+        subject.update_status(status)
+      end
     end
   end
-
-end
+end

data/spec/highrise/email_spec.rb

@@ -1,25 +1,13 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Highrise::Email do
+  it { should be_a_kind_of Highrise::Base }
 
-  before(:each) do
-    @mail = Highrise::Email.new
-  end
-  
-  it "should be instance of Highrise::Base" do
-    @mail.kind_of?(Highrise::Base).should be_true
-  end
+  it_should_behave_like "a paginated class"
   
-  describe "comments" do
-
-    it "should delegate to Highrise::Comment.find with correct params" do
-      @mail.should_receive(:email_id).and_return(1)
-      Highrise::Comment.should_receive(:find).with(:all, {:from=>"/emails/1/comments.xml"}).and_return("comments")
-      @mail.comments.should == "comments"
-    end
-
+  it "#comments" do
+    subject.should_receive(:email_id).and_return(1)
+    Highrise::Comment.should_receive(:find).with(:all, {:from=>"/emails/1/comments.xml"}).and_return("comments")
+    subject.comments.should == "comments"
   end
-  
-
-
 end