rogerio-augusto-highrise 2.0.2

data/lib/highrise/pagination.rb

@@ -0,0 +1,29 @@
+module Highrise
+  module Pagination
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def find_all_across_pages(options = {})
+        records = []
+        each(options) { |record| records << record }
+        records
+      end
+
+      def each(options = {})
+        options[:params] ||= {}
+        options[:params][:n] = 0
+
+        loop do
+          if (records = self.find(:all, options)).any?
+            records.each { |record| yield record }
+            options[:params][:n] += records.size
+          else
+            break # no people included on that page, thus no more people total
+          end
+        end
+      end
+    end
+  end
+end

data/lib/highrise/person.rb

@@ -0,0 +1,30 @@
+module Highrise
+  class Person < Subject
+    include Pagination
+    include Taggable
+    
+    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
+  
+    def name
+      "#{first_name rescue ''} #{last_name rescue ''}".strip
+    end
+    
+    def address
+      contact_data.addresses.first
+    end
+    
+    def web_address
+      contact_data.web_addresses.first
+    end
+    
+    def label
+      'Party'
+    end
+  end
+end

data/lib/highrise/subject.rb

@@ -0,0 +1,25 @@
+module Highrise
+  class Subject < Base
+    def notes
+      Note.find_all_across_pages(:from => "/#{self.class.collection_name}/#{id}/notes.xml")
+    end
+
+    def add_note(attrs={})
+      attrs[:subject_id] = self.id
+      attrs[:subject_type] = self.label
+      Note.create attrs
+    end
+
+    def emails
+      Email.find_all_across_pages(:from => "/#{self.class.collection_name}/#{id}/emails.xml")
+    end
+
+    def upcoming_tasks
+      Task.find(:all, :from => "/#{self.class.collection_name}/#{id}/tasks.xml")
+    end
+    
+    def label
+      self.class.name.split('::').last
+    end
+  end
+end

data/lib/highrise/tag.rb

@@ -0,0 +1,12 @@
+module Highrise
+  class Tag < Base  
+    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

@@ -0,0 +1,17 @@
+module Highrise
+  module Taggable        
+    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     
+    def untag_id!(tag_id)
+      self.delete("tags/#{tag_id}")
+    end
+  end
+end

data/lib/highrise/task.rb

@@ -0,0 +1,11 @@
+module Highrise
+  class Task < Base
+    # find(:all, :from => :upcoming)
+    # find(:all, :from => :assigned)  
+    # find(:all, :from => :completed)  
+
+    def complete!
+      load_attributes_from_response(post(:complete))
+    end
+  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.rb

@@ -0,0 +1,22 @@
+gem 'activeresource', " >= 2.3.8"
+require 'active_resource'
+$:.unshift(File.dirname(__FILE__))
+
+require 'highrise/base'
+require 'highrise/pagination'
+require 'highrise/taggable'
+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'

data/spec/cachable_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class CachedResource < ActiveResource::Base
+  include ::Cachable
+end
+
+describe CachedResource, "class configuration" do
+  before(:each) do
+    CachedResource.site = 'http://example.com.i:3000'
+  end
+    
+  it "should tell us if caching is active" do
+    CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+    CachedResource.connection.is_caching?.should == true
+  end
+  
+  it "should tell us if caching is not active" do
+    CachedResource.connection.cache_store = nil
+    CachedResource.connection.is_caching?.should == false
+  end
+end
+
+describe CachedResource do
+  before(:all) do
+    CachedResource.site = 'http://example.com.i:3000'
+    CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+  end
+  
+  after(:all) do
+    CachedResource.connection.cache_store = :none
+  end
+  
+  before(:each) do
+    @thing = CachedResource.new(:id => 1)
+    @key = :key
+    CachedResource.connection.stub!(:cache_key).and_return(@key)
+  end
+  
+  context "when a cached response is available" do
+    before(:each) do
+      CachedResource.connection.cache_store.write(@key, @thing.attributes)
+    end
+    
+    it "should NOT make a request to the RESTful server" do
+      CachedResource.connection.should_not_receive(:get_without_cache)
+      CachedResource.find(1)
+    end
+    
+    it "should read from the cache" do
+      CachedResource.find(1).should == @thing
+    end
+    
+    it "should delete from the cache when an object is DELETEd" do
+      CachedResource.connection.should_receive(:delete_without_cache)
+      CachedResource.delete(1)
+      CachedResource.connection.cache_store.read(@key).should == nil
+    end
+
+    it "should delete from the cache when an object is modified" do
+      thing = CachedResource.find(1)
+      thing.stub(:load_attributes_from_response).and_return(@thing.attributes)
+      CachedResource.connection.should_receive(:put_without_cache)
+      thing.save
+      CachedResource.connection.cache_store.read(@key).should == nil
+    end
+  end
+  
+  context "when a cached response is NOT available" do
+    before(:each) do
+      CachedResource.connection.cache_store.delete(@key)
+    end
+    
+    it "SHOULD perform an ActiveResource request" do
+      CachedResource.connection.should_receive(:get_without_cache).and_return(@thing.attributes)
+      CachedResource.find(1)
+    end
+    
+    it "should cache the response using the caching key" do
+      CachedResource.connection.should_receive(:get_without_cache).and_return(@thing.attributes)
+      CachedResource.find(1)
+      CachedResource.connection.cache_store.read(@key).should == @thing.attributes
+    end
+  end
+end

data/spec/highrise/account_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/../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 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
+  end
+end

data/spec/highrise/base_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../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
+  end
+  
+end

data/spec/highrise/comment_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../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
+
+
+end

data/spec/highrise/company_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/../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
+  
+  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
+
+  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
+
+end

data/spec/highrise/deal_category_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::DealCategory do
+
+  before(:each) do
+    @deal_category = Highrise::DealCategory.new
+  end
+  
+  it "should be instance of Highrise::Base" do
+    @deal_category.kind_of?(Highrise::Base).should be_true
+  end
+end

data/spec/highrise/deal_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Deal do
+
+  before(:each) do
+    @deal = Highrise::Deal.new(:id => 1)
+  end
+  
+  it "should be instance of Highrise::Subject" do
+    @deal.kind_of?(Highrise::Subject).should be_true
+  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'
+    end
+  end
+
+end

data/spec/highrise/email_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Email do
+
+  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
+  
+  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
+
+  end
+  
+
+
+end

data/spec/highrise/group_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Group do
+
+  before(:each) do
+    @group = Highrise::Group.new
+  end
+  
+  it "should be instance of Highrise::Base" do
+    @group.kind_of?(Highrise::Base).should be_true
+  end
+
+
+end

data/spec/highrise/kase_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Kase do
+
+  before(:each) do
+    @kase = Highrise::Kase.new
+  end
+  
+  it "should be instance of Highrise::Subject" do
+    @kase.kind_of?(Highrise::Subject).should be_true
+  end
+  
+  describe ".close!" do
+
+    it "should set close date and save" do
+      time = Time.parse("Wed Jan 14 15:43:11 -0200 2009")
+      Time.should_receive(:now).and_return(time)
+      @kase.should_receive(:closed_at=).with(time.utc)
+      @kase.should_receive(:save)
+      @kase.close!
+    end
+
+  end
+
+end

data/spec/highrise/membership_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Membership do
+
+  before(:each) do
+    @member = Highrise::Membership.new
+  end
+  
+  it "should be instance of Highrise::Base" do
+    @member.kind_of?(Highrise::Base).should be_true
+  end
+
+
+end

data/spec/highrise/note_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Note do
+
+  before(:each) do
+    Highrise::Base.site = 'http://example.com.i:3000'
+    @note = Highrise::Note.new(:id => 1)
+  end
+  
+  it "should be instance of Highrise::Base" do
+    @note.kind_of?(Highrise::Base).should be_true
+  end
+  
+  describe "comments" do
+
+    it "should delegate to Highrise::Comment.find with correct params" do
+      Highrise::Comment.should_receive(:find).with(:all, {:from=>"/notes/1/comments.xml"}).and_return("comments")
+      @note.comments.should == "comments"
+    end
+
+  end
+  
+end

data/spec/highrise/pagination_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Pagination do
+  
+  it "should be tested" do
+    Highrise::Person.should_receive(:find).with(:all,{:params=>{:n=>0}}).and_return(["people"])
+    Highrise::Person.should_receive(:find).with(:all,{:params=>{:n=>1}}).and_return([])
+    Highrise::Person.find_all_across_pages.should == ["people"]
+  end
+end

data/spec/highrise/person_spec.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Person do
+
+  before(:each) do
+    Highrise::Base.site = 'http://example.com.i:3000'
+    @person = Highrise::Person.new(:id => 1)
+    returning @tags = [] do 
+      @tags << {'id' => "414578", 'name' => "cliente"}
+      @tags << {'id' => "414587", 'name' => "walk"}
+    end
+  end
+  
+  it "should be instance of Highrise::Subject" do
+    @person.kind_of?(Highrise::Subject).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::Person.should_receive(:find_all_across_pages).with({:params=>{:since=>"20090114174311"}}).and_return("result")
+      Highrise::Person.find_all_across_pages_since(time).should == "result"
+    end
+
+  end
+  
+  describe ".company" do
+
+    it "should return nil when doesn't have company_id" do
+      @person.should_receive(:company_id).and_return(nil)
+      @person.company.should be_nil
+    end
+
+    it "should delegate to Highrise::Company when have company_id" do
+      @person.should_receive(:company_id).at_least(2).times.and_return(1)
+      Highrise::Company.should_receive(:find).with(1).and_return("company")
+      @person.company.should == "company"
+    end
+
+  end
+  
+  describe ".name" do
+
+    it "should concat fist_name with last_name and strip" do
+      @person.should_receive(:first_name).and_return("Marcos")
+      @person.should_receive(:last_name).and_return("Tapajós     ")
+      @person.name.should == "Marcos Tapajós"
+    end
+
+  end
+  
+  describe ".tags" do
+    
+    it "should return an array of all tags for that user." do
+      @person.should_receive(:get).with(:tags).and_return(@tags)
+      @person.tags.should == @tags
+    end
+    
+  end
+  
+  describe "tag!(tag_name)" do
+  
+    it "should create a tag for this user." do
+      @person.should_receive(:post).with(:tags, :name => "Forum_User" ).and_return(true)
+      @person.tag!("Forum_User").should be_true
+    end
+    
+  end
+  
+  describe "untag!(tag_name)" do
+  
+    it "should delete a tag for this user." do
+      @person.should_receive(:get).with(:tags).and_return(@tags)
+      @person.should_receive(:delete).with("tags/414578").and_return(true)
+      @person.untag!("cliente").should be_true
+    end
+    
+  end
+  
+  describe ".label" do
+    it "should return 'Party' for label" do
+      @person.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'))
+      @person.add_note :body=>'body'
+    end
+  end
+  
+end

data/spec/highrise/subject_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Subject do
+
+  before(:each) do
+    @subject = Highrise::Subject.new(:id => 1)
+  end
+
+  it "should be instance of Highrise::Base" do
+    @subject.kind_of?(Highrise::Base).should be_true
+  end
+
+  describe ".notes" do
+    it "should delegate to Highrise::Note with correct params" do      Highrise::Note.should_receive(:find_all_across_pages).with({:from=>"/subjects/1/notes.xml"}).and_return("notes")
+      @subject.notes.should == "notes"
+    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=>'Subject'}).and_return(mock('note'))
+      @subject.add_note :body=>'body'
+    end
+  end
+
+  describe ".emails" do
+    it "should delegate to Highrise::Email with correct params" do
+      Highrise::Email.should_receive(:find_all_across_pages).with({:from=>"/subjects/1/emails.xml"}).and_return("emails")
+      @subject.emails.should == "emails"
+    end
+  end
+
+
+  describe ".upcoming_tasks" do
+
+    it "should delegate to Highrise::Task with correct params" do
+      Highrise::Task.should_receive(:find).with(:all, {:from=>"/subjects/1/tasks.xml"}).and_return("tasks")
+      @subject.upcoming_tasks.should == "tasks"
+    end
+
+  end
+  
+  describe ".label" do
+    it "should return the class name as a string" do
+      @subject.label.should == "Subject"
+    end
+  end
+
+end