tapajos-highrise 0.6

data/README.mkdn

@@ -0,0 +1,54 @@
+# Highrise
+
+## What
+
+Highrise is a gem that provides an easy way to use the Highrise API.
+
+## Installing
+
+    gem install tapajos-highrise
+
+## Dependencies
+
+* ActiveResorce
+
+## Configure your key.
+    
+    require 'rubygens'
+    require 'highrise'
+    Highrise::Base.site = "http://your_api:login@your_site.highrisehq.com/"
+    
+## Usage
+
+This gem provides a set of classes to access all available informations on Highrise. 
+
+These are the list of classes:
+
+    Comment, Company, Email, Group, Note, Membership, Person, Subject, Task and User. 
+
+All these classes are inherited of ActiveResouce::Base. For more informations see the ActiveResouce documentation.
+
+## License
+
+This code is free to be used under the terms of the [MIT license][mit].
+
+## Contact
+
+Comments are welcome. Send your feedback through [this page][co]
+
+## Authors
+
+[Marcos Tapajós][mt]  
+
+## Shameless advertisement
+
+This plugin is brought to you by [Improve It][ii].
+
+[![Improve It][logo]][ii]
+
+[logo]: 	http://www.improveit.com.br/images/logo/logo_improve_it_screen.gif "Improve It"
+
+[mt]:		http://www.improveit.com.br/en/company/tapajos
+[ii]:		http://www.improveit.com.br/en
+[co]:		http://www.improveit.com.br/en/contact
+[mit]:	http://www.opensource.org/licenses/mit-license.php

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rake'
+require 'rubygems'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+require "date"
+require "fileutils"
+require "rubygems"
+require "rake/gempackagetask"
+
+VERSION = "0.6"
+
+highrise_gemspec = Gem::Specification.new do |s|
+  s.name             = "highrise"
+  s.version          = VERSION
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.extra_rdoc_files = ["README.mkdn"]
+  s.summary          = "Find awesome stuff"
+  s.description      = s.summary
+  s.authors          = ["Marcos Tapajós"]
+  s.email            = "tapajos@improveit.com.br"
+  s.homepage         = "http://www.improveit.com.br/en/company/tapajos"
+  s.require_path     = "lib"
+  s.autorequire      = "highrise"
+  s.files            = %w(README.mkdn Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(highrise_gemspec) do |pkg|
+  pkg.gem_spec = highrise_gemspec
+end
+
+namespace :gem do
+  namespace :spec do
+    desc "Update highrise.gemspec"
+    task :generate do
+      File.open("highrise.gemspec", "w") do |f|
+        f.puts(highrise_gemspec.to_ruby)
+      end
+    end
+  end
+end
+
+desc "Instal gem"
+task :install => :package do
+  sh %{sudo gem install --local pkg/highrise-#{VERSION}}
+end
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec.opts']
+end

data/lib/highrise/base.rb

@@ -0,0 +1,4 @@
+module Highrise
+  class Base < ActiveResource::Base
+  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,13 @@
+module Highrise
+  class Company < Subject
+    include Pagination
+
+    def self.find_all_across_pages_since(time)
+      find_all_across_pages(:params => { :since => time.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,17 @@
+module Highrise
+  class Person < Subject
+    include Pagination
+  
+    def self.find_all_across_pages_since(time)
+      find_all_across_pages(:params => { :since => time.to_s(:db).gsub(/[^\d]/, '') })
+    end
+  
+    def company
+      Company.find(company_id) if company_id
+    end
+  
+    def name
+      "#{first_name} #{last_name}".strip
+    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/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/lib/highrise.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'active_resource'
+require File.dirname(__FILE__) + '/highrise/pagination'
+require File.dirname(__FILE__) + '/highrise/base'
+require File.dirname(__FILE__) + '/highrise/subject'
+require File.dirname(__FILE__) + '/highrise/comment'
+require File.dirname(__FILE__) + '/highrise/company'
+require File.dirname(__FILE__) + '/highrise/email'
+require File.dirname(__FILE__) + '/highrise/group'
+require File.dirname(__FILE__) + '/highrise/kase'
+require File.dirname(__FILE__) + '/highrise/membership'
+require File.dirname(__FILE__) + '/highrise/note'
+require File.dirname(__FILE__) + '/highrise/person'
+require File.dirname(__FILE__) + '/highrise/task'
+require File.dirname(__FILE__) + '/highrise/user'

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,34 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Highrise::Company do
+
+  before(:each) do
+    @company = Highrise::Company.new
+  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=>"20090114154311"}}).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
+
+
+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 anda 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,7 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Highrise::Pagination do
+  
+  it "should be tested"
+
+end

data/spec/highrise/person_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Highrise::Person do
+
+  before(:each) do
+    @person = Highrise::Person.new
+  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=>"20090114154311"}}).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
+  
+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/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

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: tapajos-highrise
+version: !ruby/object:Gem::Version 
+  version: "0.6"
+platform: ruby
+authors: 
+- "Marcos Tapaj\xC3\xB3s"
+autorequire: highrise
+bindir: bin
+cert_chain: []
+
+date: 2009-01-14 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Find awesome stuff
+email: tapajos@improveit.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.mkdn
+files: 
+- README.mkdn
+- Rakefile
+- lib/highrise
+- 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/task.rb
+- lib/highrise/user.rb
+- lib/highrise.rb
+- spec/highrise
+- 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/task_spec.rb
+- spec/highrise/user_spec.rb
+has_rdoc: true
+homepage: http://www.improveit.com.br/en/company/tapajos
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Find awesome stuff
+test_files: []
+