highrise 1.0.4 → 1.2.0

data/.gitignore

@@ -1 +1,2 @@
 pkg/**
+highrise.gemspec

data/README.mkdn

@@ -1,10 +1,10 @@
-# Highrise (1.0)
+# Highrise (1.2.0)
 
 ## What is it?
 
 This gem provides a set of classes to access information on [Highrise][h] via the published [API][api]:
 
-    Comment, Company, Email, Group, Case, Membership, Note, Person, Subject, Tag, Task, User. 
+    Account, Comment, Company, Deal, Email, Group, Case, Membership, Note, Person, Subject, Tag, Task, User. 
 
 All these classes are inherited from ActiveResouce::Base. Refer to the [ActiveResouce][ar] documentation for more information.
 
@@ -16,17 +16,13 @@ All these classes are inherited from ActiveResouce::Base. Refer to the [ActiveRe
 
 ### Documentation
 
-  I'm on [rdoc.info][rdoc] and here're some [metrics][devver]
+  I'm on [rdoc.info][rdoc] and here're some [metrics][caliper]
 
 ### Configure your key
     
     require 'rubygems'
     require 'highrise'
     
-    Highrise::Base.site = 'http://your_api:login@your_site.highrisehq.com/'
-    
-or
-
     Highrise::Base.site = 'http://your_site.highrisehq.com'
     Highrise::Base.user = 'api-auth-token'
 
@@ -64,10 +60,6 @@ Comments are welcome. Send your feedback through the [issue tracker on GitHub][i
 * [Luis Gustavo][lg]
 * [Thiago Lelis][tl]
 
-## Shameless advertisement
-
-This plugin is brought to you by [Improve It][ii].
-
 ## Special Thanks
 
 [Rails Envy Podcast Episode #77][re] for mentioning
@@ -77,11 +69,9 @@ for writing an excellent tutorial and [posting your source][e] on GitHub.
 [api]: http://developer.37signals.com/highrise
 [ar]: http://api.rubyonrails.org/classes/ActiveResource/Base.html
 [c]:  http://api.rubyonrails.org/classes/ActiveSupport/Cache
-[co]: http://github.com/kmayer
 [e]:  http://github.com/primedia/endeca/tree/master
 [h]:  http://www.highrisehq.com/
-[i]:  http://github.com/kmayer/highrise/issues
-[ii]: http://www.improveit.com.br/en
+[i]:  http://github.com/tapajos/highrise/issues
 [km]: http://github.com/kmayer
 [lg]: http://github.com/luisbebop
 [mit]:http://www.opensource.org/licenses/mit-license.php
@@ -90,5 +80,5 @@ for writing an excellent tutorial and [posting your source][e] on GitHub.
 [re]: http://www.railsenvy.com/2009/4/29/rails-envy-podcast-episode-077-04-29-2009
 [rh]: http://reinh.com/blog/2009/04/27/how-to-cache-anything-with-activesupport.html
 [tl]: http://github.com/ThiagoLelis
-[rdoc]: http://rdoc.info/projects/kmayer/highrise
-[devver]: https://devver.net/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fkmayer%2Fhighrise.git
+[rdoc]: http://rdoc.info/projects/tapajos/highrise
+[caliper]: https://devver.net/caliper/project?repo=git%3A%2F%2Fgithub.com%2Ftapajos%2Fhighrise.git

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:minor: 0
-:patch: 4
+:patch: 0
 :major: 1
+:minor: 2
 :build: 

data/lib/cachable.rb

@@ -78,7 +78,7 @@ module Cachable
     end
 
     def cache_key(*args)
-      args.to_s
+      args.join('/')
     end
 
     def fetch(args, &block)

data/lib/highrise.rb

@@ -16,3 +16,5 @@ require 'highrise/person'
 require 'highrise/task'
 require 'highrise/user'
 require 'highrise/tag'
+require 'highrise/deal'
+require 'highrise/account'

data/lib/highrise/account.rb

@@ -0,0 +1,8 @@
+module Highrise
+  class Account < Base
+    def self.me
+      user = Account.new()
+      find(:one, :from => "/account.xml")
+    end
+  end
+end

data/lib/highrise/company.rb

@@ -10,5 +10,9 @@ module Highrise
     def people
       Person.find(:all, :from => "/companies/#{id}/people.xml")
     end
+    
+    def label
+      'Party'
+    end
   end
 end

data/lib/highrise/deal.rb

@@ -0,0 +1,5 @@
+module Highrise
+  class Deal < Subject
+
+  end
+end

data/lib/highrise/person.rb

@@ -22,5 +22,9 @@ module Highrise
     def web_address
       contact_data.web_addresses.first
     end
+    
+    def label
+      'Party'
+    end
   end
 end

data/lib/highrise/subject.rb

@@ -4,6 +4,12 @@ module Highrise
       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
@@ -11,5 +17,9 @@ module Highrise
     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

@@ -1,18 +1,25 @@
 module Highrise
-  class Tag < Base
-    @@tags = {}
+  class Tag < Base    
+    @cache = self.cache_store || ActiveSupport::Cache::MemoryStore.new
+    
     def ==(object)
       (object.instance_of?(self.class) && object.id == self.id && object.name == self.name)
     end
     
-    def self.find_by_name(arg)
-      if @@tags == {}
-        self.find(:all).each do |tag|
-          @@tags[tag.id] = tag
-          @@tags[tag.name] = tag
-        end
+    class << self
+      # This find(:all) is very expensive, so cache all tags, once.
+      def find_by_name(arg)
+        @cache.fetch(to_key([self.to_s, arg])) {
+          tags = self.find(:all).each{|tag| @cache.write(to_key([self.to_s, tag.name]), tag)}
+          tags.find{|tag| tag.name == arg}
+        }
+      end
+      
+      private
+      
+      def to_key(*args)
+        args.join('/')
       end
-      @@tags[arg]
     end
   end
 end

data/lib/highrise/user.rb

@@ -3,5 +3,15 @@ module Highrise
     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/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/company_spec.rb

@@ -29,7 +29,6 @@ describe Highrise::Company do
   describe "people" do
 
     it "should delegate to Highrise::Person.find with correct params" do
-      @company.should_receive(:id).and_return(1)
       Highrise::Person.should_receive(:find).with(:all, {:from=>"/companies/1/people.xml"}).and_return("people")
       @company.people.should == "people"
     end
@@ -64,5 +63,17 @@ describe Highrise::Company do
     
   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_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/note_spec.rb

@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/../spec_helper'
 describe Highrise::Note do
 
   before(:each) do
-    @note = Highrise::Note.new
+    @note = Highrise::Note.new(:id => 1)
   end
   
   it "should be instance of Highrise::Base" do
@@ -13,7 +13,6 @@ describe Highrise::Note do
   describe "comments" do
 
     it "should delegate to Highrise::Comment.find with correct params" do
-      @note.should_receive(:id).and_return(1)
       Highrise::Comment.should_receive(:find).with(:all, {:from=>"/notes/1/comments.xml"}).and_return("comments")
       @note.comments.should == "comments"
     end

data/spec/highrise/person_spec.rb

@@ -78,4 +78,17 @@ describe Highrise::Person do
     
   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

@@ -3,41 +3,47 @@ require File.dirname(__FILE__) + '/../spec_helper'
 describe Highrise::Subject do
 
   before(:each) do
-    @subject = Highrise::Subject.new
+    @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
-      @subject.should_receive(:id).and_return(1)
-      Highrise::Note.should_receive(:find_all_across_pages).with({:from=>"/subjects/1/notes.xml"}).and_return("notes")
+  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
-      @subject.should_receive(:id).and_return(1)
       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
-      @subject.should_receive(:id).and_return(1)
       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

data/spec/highrise/tag_spec.rb

@@ -1,7 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Tag do
-
   before(:each) do
     Highrise::Base.site = 'http://example.com.i/'
     @tag = Highrise::Tag.new(:id => 1, :name => "Name")

data/spec/highrise/user_spec.rb

@@ -10,11 +10,16 @@ describe Highrise::User do
     @user.kind_of?(Highrise::Base).should be_true
   end
   
+  it "should delegate to find(:one, :from => '/me.xml') when me is called" do
+    Highrise::User.should_receive(:find).with(:one, {:from => "/me.xml"}).and_return(@user)
+    Highrise::User.me.should == @user
+  end
+  
   def join(group)
     Membership.create(:user_id => id, :group_id => group.id)
   end
   
-  describe ".joind" do
+  describe ".join" do
 
     it "should delegate to Highrise::Membership.create" do
       group_mock = mock("group")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: highrise
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.2.0
 platform: ruby
 authors: 
 - "Marcos Tapaj\xC3\xB3s"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-11 00:00:00 -02:00
+date: 2010-02-15 00:00:00 -10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,13 +61,14 @@ files:
 - examples/config_initializers_highrise.rb
 - examples/extending.rb
 - examples/sample.rb
-- highrise.gemspec
 - install.rb
 - lib/cachable.rb
 - lib/highrise.rb
+- lib/highrise/account.rb
 - lib/highrise/base.rb
 - lib/highrise/comment.rb
 - lib/highrise/company.rb
+- lib/highrise/deal.rb
 - lib/highrise/email.rb
 - lib/highrise/group.rb
 - lib/highrise/kase.rb
@@ -81,9 +82,11 @@ files:
 - lib/highrise/task.rb
 - lib/highrise/user.rb
 - spec/cachable_spec.rb
+- spec/highrise/account_spec.rb
 - spec/highrise/base_spec.rb
 - spec/highrise/comment_spec.rb
 - spec/highrise/company_spec.rb
+- spec/highrise/deal_spec.rb
 - spec/highrise/email_spec.rb
 - spec/highrise/group_spec.rb
 - spec/highrise/kase_spec.rb
@@ -128,9 +131,11 @@ specification_version: 3
 summary: Ruby wrapper around Highrise API
 test_files: 
 - spec/cachable_spec.rb
+- spec/highrise/account_spec.rb
 - spec/highrise/base_spec.rb
 - spec/highrise/comment_spec.rb
 - spec/highrise/company_spec.rb
+- spec/highrise/deal_spec.rb
 - spec/highrise/email_spec.rb
 - spec/highrise/group_spec.rb
 - spec/highrise/kase_spec.rb

data/highrise.gemspec

@@ -1,119 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{highrise}
-  s.version = "1.0.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Marcos Tapaj\303\263s", "Ken Mayer"]
-  s.date = %q{2009-11-11}
-  s.description = %q{
-Based on the original API module from DHH, http://developer.37signals.com/highrise/, this
-gem is a cleaned up, tested version of the same. Contributors have added support for tags 
-which are not supported by the API directly
-
-Configure by adding the following:
-
-require 'highrise'
-Highrise::Base.site = 'http://your_site.highrisehq.com/'
-Highrise::Base.user = 'your_api_auth_token'
-                          }
-  s.email = ["marcos@tapajos.me", "kmayer@bitwrangler.com"]
-  s.extra_rdoc_files = [
-    "README.mkdn"
-  ]
-  s.files = [
-    ".gitignore",
-     "CHANGELOG",
-     "MIT-LICENSE",
-     "README.mkdn",
-     "Rakefile",
-     "VERSION.yml",
-     "autotest/discover.rb",
-     "examples/config_initializers_highrise.rb",
-     "examples/extending.rb",
-     "examples/sample.rb",
-     "install.rb",
-     "lib/cachable.rb",
-     "lib/highrise.rb",
-     "lib/highrise/base.rb",
-     "lib/highrise/comment.rb",
-     "lib/highrise/company.rb",
-     "lib/highrise/email.rb",
-     "lib/highrise/group.rb",
-     "lib/highrise/kase.rb",
-     "lib/highrise/membership.rb",
-     "lib/highrise/note.rb",
-     "lib/highrise/pagination.rb",
-     "lib/highrise/person.rb",
-     "lib/highrise/subject.rb",
-     "lib/highrise/tag.rb",
-     "lib/highrise/taggable.rb",
-     "lib/highrise/task.rb",
-     "lib/highrise/user.rb",
-     "spec/cachable_spec.rb",
-     "spec/highrise/base_spec.rb",
-     "spec/highrise/comment_spec.rb",
-     "spec/highrise/company_spec.rb",
-     "spec/highrise/email_spec.rb",
-     "spec/highrise/group_spec.rb",
-     "spec/highrise/kase_spec.rb",
-     "spec/highrise/membership_spec.rb",
-     "spec/highrise/note_spec.rb",
-     "spec/highrise/pagination_spec.rb",
-     "spec/highrise/person_spec.rb",
-     "spec/highrise/subject_spec.rb",
-     "spec/highrise/tag_spec.rb",
-     "spec/highrise/task_spec.rb",
-     "spec/highrise/user_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "uninstall.rb"
-  ]
-  s.homepage = %q{http://github.com/tapajos/highrise}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Ruby wrapper around Highrise API}
-  s.test_files = [
-    "spec/cachable_spec.rb",
-     "spec/highrise/base_spec.rb",
-     "spec/highrise/comment_spec.rb",
-     "spec/highrise/company_spec.rb",
-     "spec/highrise/email_spec.rb",
-     "spec/highrise/group_spec.rb",
-     "spec/highrise/kase_spec.rb",
-     "spec/highrise/membership_spec.rb",
-     "spec/highrise/note_spec.rb",
-     "spec/highrise/pagination_spec.rb",
-     "spec/highrise/person_spec.rb",
-     "spec/highrise/subject_spec.rb",
-     "spec/highrise/tag_spec.rb",
-     "spec/highrise/task_spec.rb",
-     "spec/highrise/user_spec.rb",
-     "spec/spec_helper.rb",
-     "examples/config_initializers_highrise.rb",
-     "examples/extending.rb",
-     "examples/sample.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activeresource>, [">= 2.1"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 2.1"])
-    else
-      s.add_dependency(%q<activeresource>, [">= 2.1"])
-      s.add_dependency(%q<activesupport>, [">= 2.1"])
-    end
-  else
-    s.add_dependency(%q<activeresource>, [">= 2.1"])
-    s.add_dependency(%q<activesupport>, [">= 2.1"])
-  end
-end
-