highrise 1.0.2

data/README.mkdn

@@ -0,0 +1,94 @@
+# Highrise (1.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. 
+
+All these classes are inherited from ActiveResouce::Base. Refer to the [ActiveResouce][ar] documentation for more information.
+
+## Installing
+
+    gem install tapajos-highrise
+
+### Dependencies (see the Rakefile or run <code>rake check_dependencies</code>)
+
+### Documentation
+
+  I'm on [rdoc.info][rdoc] and here're some [metrics][devver]
+
+### 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'
+
+and, if you want [caching][c]:
+
+    Highrise::Base.cache_store= <your normal ActiveSupport::Caching options>
+    
+If you are using this in a Rails application, putting this code in a config/initializers/highrise.rb
+file is recommended. See config_initializers_highrise.rb in the examples/ directory.
+
+## Usage
+
+    @tags = Highrise::Tag.find(:all)
+    
+    @people = Highrise::Person.find_all_across_pages(:params => {:tag_id => 12345})
+    
+    @person.tag!("VIP")
+
+## License
+
+This code is free to be used under the terms of the [MIT license][mit].
+
+## Bugs, Issues, Kudos and Catcalls
+
+Comments are welcome. Send your feedback through the [issue tracker on GitHub][i]
+
+## Authors
+
+* [Marcos Tapajós][mt]
+* [Ken Mayer][km]
+
+## Contributors
+
+* [Nicolas Bianco][nb]
+* [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
+[How to Cache Anything With ActiveSupport][rh] on the very *day* I started writing the cache code. Thank you, Rein
+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
+[km]: http://github.com/kmayer
+[lg]: http://github.com/luisbebop
+[mit]:http://www.opensource.org/licenses/mit-license.php
+[mt]: http://www.improveit.com.br/en/company/tapajos
+[nb]: http://github.com/slainer86
+[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]: http://devver.net/caliper/stats?repo=git://github.com/kmayer/highrise

data/VERSION.yml

@@ -0,0 +1,3 @@
+:minor: 0
+:patch: 2
+:major: 1

data/lib/cachable.rb

@@ -0,0 +1,88 @@
+# Caching is a way to speed up slow ActiveResource queries by keeping the result of
+# a request around to be reused by subsequent requests. 
+# 
+# Caching is turned OFF by default.
+#
+# == Usage
+# 
+#   require 'cachable'
+# 
+#   module CachedResource
+#     class Base < ActiveResource::Base
+#       include ::Cachable
+#     end
+#   end
+#
+#
+# == Caching stores
+#
+# All the caching stores from ActiveSupport::Cache are available
+# as backends for caching. See the Rails rdoc for more information on
+# these stores
+#
+# === Configuration examples ('off' is the default):
+#   CachedResource.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+#   CachedResource.cache_store = ActiveSupport::Cache.lookup_store :file_store, "/path/to/cache/directory"
+#   CachedResource.cache_store = ActiveSupport::Cache.lookup_store :drb_store, "druby://localhost:9192"
+#   CachedResource.cache_store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost"
+#   CachedResource.cache_store = MyOwnStore.new("parameter")
+#
+# === If you are using a store that has write options, you can set them
+#   CachedResource.store_options = { :expires_in => 60.seconds }
+#
+# Note: To ensure that caching is turned off, set CachedResource.connection.cache_store = nil
+#
+# FYI: You can use this with *any* active resource interface, not just Highrise.
+
+module Cachable
+  def self.included(base)
+    base.extend ClassMethods
+    base.class_eval do
+      class << self
+        alias_method_chain :find_every, :cache
+        alias_method_chain :find_single, :cache
+      end
+    end
+  end
+
+  module ClassMethods
+    attr_writer :cache_store, :store_options
+    
+    def cache_store
+      @cache_store ||= nil
+    end
+    
+    def store_options
+      @store_options ||= {}
+    end
+    
+    def is_caching?
+      !@cache_store.nil?
+    end
+
+  private
+
+    # A little hacky -- we need to intercept the finds, but not get too deep inside the connection
+    def find_every_with_cache(options)
+      return find_every_without_cache(options) unless is_caching?
+      prefix_options, query_options = split_options(options[:params])
+      path = collection_path(prefix_options, query_options)
+      fetch(path) { find_every_without_cache(options)}
+    end
+
+    def find_single_with_cache(scope, options)
+      return find_single_without_cache(scope, options) unless is_caching?
+      prefix_options, query_options = split_options(options[:params])
+      path = element_path(scope, prefix_options, query_options)
+      fetch(path) { find_single_without_cache(scope, options)}
+    end
+
+    def cache_key(*args)
+      args.to_s
+    end
+
+    def fetch(args, &block)
+      cache_store.fetch(cache_key(args), store_options, &block).dup
+    end
+  end
+end

data/lib/highrise.rb

@@ -0,0 +1,18 @@
+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'

data/lib/highrise/base.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../cachable'
+
+module Highrise
+  class Base < ActiveResource::Base
+    include ::Cachable
+  end
+end

data/lib/highrise/comment.rb

@@ -0,0 +1,4 @@
+module Highrise
+  class Comment < Base
+  end
+end

data/lib/highrise/company.rb

@@ -0,0 +1,14 @@
+module Highrise
+  class Company < 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 people
+      Person.find(:all, :from => "/companies/#{id}/people.xml")
+    end
+  end
+end

data/lib/highrise/email.rb

@@ -0,0 +1,9 @@
+module Highrise
+  class Email < Base
+    include Pagination
+
+    def comments
+      Comment.find(:all, :from => "/emails/#{email_id}/comments.xml")
+    end
+  end
+end

data/lib/highrise/group.rb

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

data/lib/highrise/kase.rb

@@ -0,0 +1,8 @@
+module Highrise
+  class Kase < Subject
+    def close!
+      self.closed_at = Time.now.utc
+      save
+    end
+  end
+end

data/lib/highrise/membership.rb

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

data/lib/highrise/note.rb

@@ -0,0 +1,9 @@
+module Highrise
+  class Note < Base
+    include Pagination
+
+    def comments
+      Comment.find(:all, :from => "/notes/#{id}/comments.xml")
+    end
+  end
+end

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,26 @@
+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
+  end
+end

data/lib/highrise/subject.rb

@@ -0,0 +1,15 @@
+module Highrise
+  class Subject < Base
+    def notes
+      Note.find_all_across_pages(:from => "/#{self.class.collection_name}/#{id}/notes.xml")
+    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
+  end
+end

data/lib/highrise/tag.rb

@@ -0,0 +1,18 @@
+module Highrise
+  class Tag < Base
+    @@tags = {}
+    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
+      end
+      @@tags[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,7 @@
+module Highrise
+  class User < Base
+    def join(group)
+      Membership.create(:user_id => id, :group_id => group.id)
+    end
+  end
+end

data/spec/cachable_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Highrise::Base, "class configuration" do
+  before(:each) do
+    Highrise::Base.site = 'http://example.com.i:3000'
+  end
+    
+  it "should tell us if caching is active" do
+    Highrise::Base.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+    Highrise::Base.is_caching?.should == true
+  end
+  
+  it "should tell us if caching is not active" do
+    Highrise::Base.cache_store = nil
+    Highrise::Base.is_caching?.should == false
+  end
+end
+
+describe Highrise::Base do
+  before(:all) do
+    Highrise::Base.site = 'http://example.com.i:3000'
+    Highrise::Base.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+  end
+  
+  after(:all) do
+    Highrise::Base.cache_store = :none
+  end
+  
+  before(:each) do
+    @thing = Highrise::Base.new
+    @key = :key
+    Highrise::Base.stub!(:cache_key).and_return(@key)
+  end
+  
+  context "when a cached response is available" do
+    before(:each) do
+      Highrise::Base.cache_store.write(@key, @thing)
+    end
+    
+    it "should NOT make a request to the RESTful server" do
+      Highrise::Base.should_not_receive(:find_single_without_cache)
+      Highrise::Base.find(1)
+    end
+    
+    it "should read from the cache" do
+      Highrise::Base.find(1).should == @thing
+    end
+  end
+  
+  context "when a cached response is NOT available" do
+    before(:each) do
+      Highrise::Base.cache_store.delete(@key)
+    end
+    
+    it "SHOULD perform an ARes request" do
+      Highrise::Base.should_receive(:find_single_without_cache).and_return(@thing)
+      Highrise::Base.find(1)
+    end
+    
+    it "should cache the response using the caching key" do
+      Highrise::Base.should_receive(:find_single_without_cache).and_return(@thing)
+      Highrise::Base.find(1)
+      Highrise::Base.cache_store.read(@key).should == @thing
+    end
+  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,68 @@
+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
+      @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
+
+  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
+
+
+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
+    @note = Highrise::Note.new
+  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
+      @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
+
+  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,81 @@
+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
+  
+end

data/spec/highrise/subject_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Subject do
+
+  before(:each) do
+    @subject = Highrise::Subject.new
+  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")
+      @subject.notes.should == "notes"
+    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
+
+end

data/spec/highrise/tag_spec.rb

@@ -0,0 +1,24 @@
+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")
+  end
+  
+  it "should be instance of Highrise::Base" do
+    @tag.kind_of?(Highrise::Base).should be_true
+  end
+
+  it "should support equality" do
+    tag = Highrise::Tag.new(:id => 1, :name => "Name")
+    @tag.should == tag
+  end
+  
+  it "it should find_by_name" do
+    tag = Highrise::Tag.new(:id => 2, :name => "Next")
+    Highrise::Tag.should_receive(:find).with(:all).and_return([tag, @tag])
+    Highrise::Tag.find_by_name("Name").should == @tag
+  end
+end

data/spec/highrise/task_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Task do
+
+  before(:each) do
+    @task = Highrise::Task.new
+  end
+  
+  it "should be instance of Highrise::Base" do
+    @task.kind_of?(Highrise::Base).should be_true
+  end
+  
+  describe ".complete!" do
+    
+    it "should delegate to load_attributes_from_response" do
+      @task.should_receive(:load_attributes_from_response).with("post")
+      @task.should_receive(:post).with(:complete).and_return("post")
+      @task.complete!
+    end
+
+  end
+
+end

data/spec/highrise/user_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::User do
+
+  before(:each) do
+    @user = Highrise::User.new
+  end
+  
+  it "should be instance of Highrise::Base" do
+    @user.kind_of?(Highrise::Base).should be_true
+  end
+  
+  def join(group)
+    Membership.create(:user_id => id, :group_id => group.id)
+  end
+  
+  describe ".joind" do
+
+    it "should delegate to Highrise::Membership.create" do
+      group_mock = mock("group")
+      group_mock.should_receive(:id).and_return(2)
+      @user.should_receive(:id).and_return(1)
+      Highrise::Membership.should_receive(:create).with({:user_id=>1, :group_id=>2})
+      @user.join(group_mock)
+    end
+
+  end
+
+
+end

data/spec/spec.opts

@@ -0,0 +1,8 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse
+-rubygems
+--debugger

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../lib/highrise'
+
+def turn_methods_public(klass, method_name = nil)
+  if method_name
+    klass.class_eval do
+      public method_name
+    end
+  else
+    turn_all_methods_public klass
+  end
+end
+
+def turn_all_methods_public(klass)
+  klass.class_eval do
+    private_instance_methods.each { |instance_method| public instance_method }
+    private_methods.each { |method| public_class_method method } 
+    protected_instance_methods.each { |instance_method| public instance_method }
+    protected_methods.each { |method| public_class_method method } 
+  end  
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: highrise
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
+platform: ruby
+authors: 
+- "Marcos Tapaj\xC3\xB3s"
+- Ken Mayer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-17 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+    version: 
+description: "\n\
+  Based on the original API module from DHH, http://developer.37signals.com/highrise/, this\n\
+  gem is a cleaned up, tested version of the same. Contributors have added support for tags \n\
+  which are not supported by the API directly\n\n\
+  Configure by adding the following:\n\n\
+  require 'highrise'\n\
+  Highrise::Base.site = 'http://your_site.highrisehq.com/'\n\
+  Highrise::Base.user = 'your_api_auth_token'\n                          "
+email: marcos@tapajos.me, kmayer@bitwrangler.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.mkdn
+- VERSION.yml
+- lib/cachable.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
+- lib/highrise.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
+has_rdoc: true
+homepage: http://github.com/tapajos/highrise
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper around Highrise API
+test_files: []
+