peterosullivan-highrise 3.0.2

data/lib/highrise/task_category.rb

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

data/lib/highrise/user.rb

@@ -0,0 +1,17 @@
+module Highrise
+  class User < Base
+    def join(group)
+      Membership.create(:user_id => id, :group_id => group.id)
+    end
+
+    # Permits API-key retrieval using name and password.
+    #     Highrise::User.site = "https://yourcompany.highrise.com"
+    #     Highrise::User.user = "your_user_name"
+    #     Highrise::User.password = "s3kr3t"
+    #     Highrise::User.me.token # contains the API token for "your_user_name"  
+    def self.me
+      user = User.new()
+      find(:one, :from => "/me.xml")
+    end
+  end
+end

data/lib/highrise/version.rb

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

data/lib/highrise.rb

@@ -0,0 +1,22 @@
+require 'highrise/base'
+require 'highrise/pagination'
+require 'highrise/taggable'
+require 'highrise/searchable'
+require 'highrise/subject'
+require 'highrise/comment'
+require 'highrise/company'
+require 'highrise/email'
+require 'highrise/group'
+require 'highrise/kase'
+require 'highrise/membership'
+require 'highrise/note'
+require 'highrise/person'
+require 'highrise/task'
+require 'highrise/user'
+require 'highrise/tag'
+require 'highrise/deal'
+require 'highrise/account'
+require 'highrise/deal_category'
+require 'highrise/task_category'
+require 'highrise/party'
+require 'highrise/recording'

data/spec/highrise/account_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Highrise::Account do
+  it { should be_a_kind_of Highrise::Base }
+  
+  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

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Highrise::Base do
+  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

data/spec/highrise/comment_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Highrise::Comment do
+  it { should be_a_kind_of Highrise::Base }
+end

data/spec/highrise/company_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Highrise::Company do
+  subject { Highrise::Company.new(:id => 1) }
+  
+  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
+  
+  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

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Highrise::Deal do
+  subject { Highrise::Deal.new(:id => 1) }
+    
+  it { should be_a_kind_of Highrise::Subject }
+  
+  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 ".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

data/spec/highrise/email_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Highrise::Email do
+  it { should be_a_kind_of Highrise::Base }
+
+  it_should_behave_like "a paginated class"
+  
+  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

data/spec/highrise/group_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Highrise::Group do
+  it { should be_a_kind_of Highrise::Base }
+end

data/spec/highrise/kase_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Highrise::Kase do
+  it { should be_a_kind_of Highrise::Subject }
+  
+  it "#close!" do
+    mocked_now = Time.parse("Wed Jan 14 15:43:11 -0200 2009")
+    Time.should_receive(:now).and_return(mocked_now)
+    subject.should_receive(:update_attribute).with(:closed_at, mocked_now.utc)
+    subject.close!
+  end
+
+  it "#open!" do
+    subject.should_receive(:update_attribute).with(:closed_at, nil)
+    subject.open!
+  end
+end

data/spec/highrise/membership_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Highrise::Membership do
+  it { should be_a_kind_of Highrise::Base }
+end

data/spec/highrise/note_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Highrise::Note do
+  subject { Highrise::Note.new(:id => 1) }
+  
+  it { should be_a_kind_of Highrise::Base }
+
+  it_should_behave_like "a paginated class"
+  
+  it "#comments" do
+    Highrise::Comment.should_receive(:find).with(:all, {:from=>"/notes/1/comments.xml"}).and_return("comments")
+    subject.comments.should == "comments"
+  end
+end

data/spec/highrise/pagination_behavior.rb

@@ -0,0 +1,50 @@
+shared_examples_for "a paginated class" do
+  it { subject.class.included_modules.should include(Highrise::Pagination) }
+
+  it ".find_all_across_pages" do
+    subject.class.should_receive(:find).with(:all,{:params=>{:n=>0}}).and_return(["things"])
+    subject.class.should_receive(:find).with(:all,{:params=>{:n=>1}}).and_return([])
+    subject.class.find_all_across_pages.should == ["things"]
+  end
+  
+  it ".find_all_across_pages with zero results" do
+    subject.class.should_receive(:find).with(:all,{:params=>{:n=>0}}).and_return(nil)
+    subject.class.find_all_across_pages.should == []
+  end
+
+  it ".find_all_across_pages_since" do
+    time = Time.parse("Wed Jan 14 15:43:11 -0200 2009")
+    subject.class.should_receive(:find_all_across_pages).with({:params=>{:since=>"20090114174311"}}).and_return("result")
+    subject.class.find_all_across_pages_since(time).should == "result"
+  end
+  
+  it ".find_all_deletions_across_pages" do
+    class TestClass2 < Highrise::Base; include Highrise::Pagination; end
+    subject_type = subject.class.to_s.split('::').last
+    deleted_resource_1 = subject.class.new(:id => 12, :type => subject_type)
+    deleted_resource_2 = TestClass2.new(:id => 34, :type => 'TestClass2')
+    deleted_resource_3 = subject.class.new(:id => 45, :type => subject_type)
+    
+    subject.class.should_receive(:find).with(:all,{:from => '/deletions.xml', :params=>{:n=>1}}).and_return([deleted_resource_1, deleted_resource_2, deleted_resource_3])
+    subject.class.should_receive(:find).with(:all,{:from => '/deletions.xml', :params=>{:n=>2}}).and_return([])
+    subject.class.find_all_deletions_across_pages.should == [deleted_resource_1, deleted_resource_3]
+  end
+  
+  it ".find_all_deletions_across_pages with zero results" do
+    subject.class.should_receive(:find).with(:all,{:from => '/deletions.xml', :params=>{:n=>1}}).and_return(nil)
+    subject.class.find_all_deletions_across_pages.should == []
+  end
+
+  it ".find_all_deletions_across_pages_since" do
+    class TestClass2 < Highrise::Base; include Highrise::Pagination; end
+    subject_type = subject.class.to_s.split('::').last
+    time = Time.parse("Wed Jan 14 15:43:11 -0200 2009")
+    deleted_resource_1 = subject.class.new(:id => 12, :type => subject_type)
+    deleted_resource_2 = TestClass2.new(:id => 34, :type => 'TestClass2')
+    deleted_resource_3 = subject.class.new(:id => 45, :type => subject_type)
+
+    subject.class.should_receive(:find).with(:all,{:from => '/deletions.xml', :params=>{:n=>1, :since=>"20090114174311"}}).and_return([deleted_resource_1, deleted_resource_2, deleted_resource_3])
+    subject.class.should_receive(:find).with(:all,{:from => '/deletions.xml', :params=>{:n=>2, :since=>"20090114174311"}}).and_return([])
+    subject.class.find_all_deletions_across_pages_since(time).should == [deleted_resource_1, deleted_resource_3]
+  end
+end

data/spec/highrise/pagination_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Highrise::Pagination do
+  class TestClass < Highrise::Base; include Highrise::Pagination; end
+  subject { TestClass.new }
+  
+  it_should_behave_like "a paginated class"
+end

data/spec/highrise/party_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Highrise::Party do
+  it { should be_a_kind_of Highrise::Base }
+
+  it ".recently_viewed" do
+    Highrise::Party.should_receive(:find).with(:all, {:from => '/parties/recently_viewed.xml'})
+    Highrise::Party.recently_viewed
+  end
+  
+  it ".deletions_since" do
+    time = Time.parse("Wed Jan 14 15:43:11 -0200 2009")
+    Highrise::Party.should_receive(:find).with(:all, {:from => '/parties/deletions.xml', :params=>{:since=>"20090114174311"}}).and_return("result")
+    Highrise::Party.deletions_since(time).should == "result"
+  end
+end

data/spec/highrise/person_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Highrise::Person do
+  subject { Highrise::Person.new(:id => 1) }
+  
+  it { should be_a_kind_of Highrise::Subject }
+
+  it_should_behave_like "a paginated class"
+  it_should_behave_like "a taggable class"
+  it_should_behave_like "a searchable class"
+
+  describe "#company" do
+    it "returns nil when it doesn't have a company" do
+      subject.should_receive(:company_id).and_return(nil)
+      subject.company.should be_nil
+    end
+
+    it "delegate to Highrise::Company when have company_id" do
+      subject.should_receive(:company_id).at_least(2).times.and_return(1)
+      Highrise::Company.should_receive(:find).with(1).and_return("company")
+      subject.company.should == "company"
+    end
+  end
+  
+  it "#name" do
+    subject.should_receive(:first_name).and_return("Marcos")
+    subject.should_receive(:last_name).and_return("Tapajós     ")
+    subject.name.should == "Marcos Tapajós"
+  end
+  
+  it { subject.label.should == 'Party' }
+end

data/spec/highrise/recording_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Highrise::Recording do
+  it { should be_a_kind_of Highrise::Base }
+
+  it_should_behave_like "a paginated class"
+end

data/spec/highrise/searchable_behavior.rb

@@ -0,0 +1,13 @@
+shared_examples_for "a searchable class" do
+  it { subject.class.included_modules.should include(Highrise::Searchable) }
+
+  it ".search" do
+    find_args = {:from => "/#{subject.class.collection_name}/search.xml", :params => {"criteria[email]" => "john.doe@example.com", "criteria[zip]" => "90210"}}
+    if subject.class.respond_to?(:find_all_across_pages)
+      subject.class.should_receive(:find_all_across_pages).with(find_args)
+    else
+      subject.class.should_receive(:find).with(:all, find_args)
+    end
+    subject.class.search(:email => "john.doe@example.com", :zip => "90210")
+  end
+end

data/spec/highrise/searchable_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Highrise::Searchable do
+  class TestClass < Highrise::Base; include Highrise::Searchable; end
+  subject { TestClass.new }
+  
+  it_should_behave_like "a searchable class"
+end

data/spec/highrise/subject_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Highrise::Subject do
+  subject { Highrise::Subject.new(:id => 1) }
+
+  it { should be_a_kind_of Highrise::Base }
+
+  it "#notes" do
+    Highrise::Note.should_receive(:find_all_across_pages).with({:from=>"/subjects/1/notes.xml"}).and_return("notes")
+    subject.notes.should == "notes"
+  end
+
+  it "#add_note" do
+    Highrise::Note.should_receive(:create).with({:body=>"body", :subject_id=>1, :subject_type=>'Subject'}).and_return(mock('note'))
+    subject.add_note :body=>'body'
+  end
+  
+  it "#add_task" do
+    Highrise::Task.should_receive(:create).with({:body=>"body", :subject_id=>1, :subject_type=>'Subject'}).and_return(mock('task'))
+    subject.add_task :body=>'body'
+  end
+
+  it "#emails" do
+    Highrise::Email.should_receive(:find_all_across_pages).with({:from=>"/subjects/1/emails.xml"}).and_return("emails")
+    subject.emails.should == "emails"
+  end
+
+  it "#upcoming_tasks" do
+    Highrise::Task.should_receive(:find).with(:all, {:from=>"/subjects/1/tasks.xml"}).and_return("tasks")
+    subject.upcoming_tasks.should == "tasks"
+  end
+  
+  it { subject.label.should == "Subject" }
+end

data/spec/highrise/tag_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Highrise::Tag do
+  subject { Highrise::Tag.new(:id => 1, :name => "Name") }
+  
+  it { should be_a_kind_of Highrise::Base }
+
+  it "supports equality" do
+    tag = Highrise::Tag.new(:id => 1, :name => "Name")
+    subject.should == tag
+  end
+  
+  it ".find_by_name" do
+    tag = Highrise::Tag.new(:id => 2, :name => "Next")
+    Highrise::Tag.should_receive(:find).with(:all).and_return([tag, subject])
+    Highrise::Tag.find_by_name("Name").should == subject
+  end
+end

data/spec/highrise/taggable_behavior.rb

@@ -0,0 +1,27 @@
+shared_examples_for "a taggable class" do
+  before(:each) do
+    (@tags = []).tap do 
+      @tags << {'id' => "414578", 'name' => "cliente"}
+      @tags << {'id' => "414580", 'name' => "ged"}
+      @tags << {'id' => "414579", 'name' => "iepc"}
+    end
+  end
+
+  it { subject.class.included_modules.should include(Highrise::Taggable) }
+
+  it "#tags" do
+    subject.should_receive(:get).with(:tags).and_return(@tags)
+    subject.tags.should == @tags
+  end
+  
+  it "#tag!(tag_name)" do
+    subject.should_receive(:post).with(:tags, :name => "client" ).and_return(true)
+    subject.tag!("client").should be_true
+  end
+  
+  it "#untag!(tag_name)" do
+    subject.should_receive(:get).with(:tags).and_return(@tags)
+    subject.should_receive(:delete).with("tags/414578").and_return(true)
+    subject.untag!("cliente").should be_true
+  end
+end

data/spec/highrise/taggable_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Highrise::Taggable do
+  class TestClass < Highrise::Base; include Highrise::Taggable; end
+  
+  subject { TestClass.new }
+  
+  it_should_behave_like "a taggable class"
+end

data/spec/highrise/task_category_spec.rb

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

data/spec/highrise/task_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Highrise::Task do
+  it { should be_a_kind_of Highrise::Base }
+  
+  it "#complete!" do
+    subject.should_receive(:load_attributes_from_response).with("post")
+    subject.should_receive(:post).with(:complete).and_return("post")
+    subject.complete!
+  end
+end

data/spec/highrise/user_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Highrise::User do
+  it { should be_a_kind_of Highrise::Base }
+  
+  it ".me" do
+    Highrise::User.should_receive(:find).with(:one, {:from => "/me.xml"}).and_return(subject)
+    Highrise::User.me.should == subject
+  end
+  
+  it "#join" do
+    group_mock = mock("group")
+    group_mock.should_receive(:id).and_return(2)
+    subject.should_receive(:id).and_return(1)
+    Highrise::Membership.should_receive(:create).with({:user_id=>1, :group_id=>2})
+    subject.join(group_mock)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler.setup
+
+require File.join(File.dirname(__FILE__), '/../lib/highrise')
+
+Highrise::Base.user = ENV['HIGHRISE_USER'] || 'x'
+Highrise::Base.site = ENV['HIGHRISE_SITE'] || 'https://www.example.com'
+
+require 'highrise/pagination_behavior'
+require 'highrise/searchable_behavior'
+require 'highrise/taggable_behavior'