kmayer-highrise 0.7.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.mkdn

@@ -0,0 +1,69 @@
+# Highrise
+
+## What
+
+[Highrise][h] is a gem that provides an easy way to use the [Highrise API][api].
+
+## Installing
+
+    gem install kmayer-highrise
+
+## Dependencies
+
+* ActiveResorce >= 2.2.2
+* ActiveSupport >= 2.1
+* Curb
+* Hpricot
+
+## Configure your key.
+    
+    require 'rubygems'
+    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][h].
+
+These are the list of classes:
+
+    Comment, Company, Email, Group, Case, Membership, Note, Person, Subject, Tag, 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]
+
+## Contributors
+
+* [Nicolas Bianco][nb]
+* [Luis Gustavo][lg]
+* [Thiago Lelis][tl]
+* [Ken Mayer][km]
+
+## Shameless advertisement
+
+(From the original author) 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://github.com/kmayer
+[mit]:http://www.opensource.org/licenses/mit-license.php
+[h]:  http://www.highrisehq.com/
+[km]: http://github.com/kmayer
+[lg]: http://github.com/luisbebop
+[nb]: http://github.com/slainer86
+[tl]: http://github.com/ThiagoLelis
+[api]: http://developer.37signals.com/highrise

data/Rakefile

@@ -0,0 +1,68 @@
+require 'rake'
+require 'rubygems'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'spec/rake/spectask'
+require "date"
+require "fileutils"
+require "rubygems"
+require "rake/gempackagetask"
+
+require File.join(File.dirname(__FILE__), 'lib', 'highrise', 'version')
+
+VERSION=Highrise::VERSION::STRING
+
+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          = "Ruby wrapper around Highrise API"
+  s.description      = %{
+                        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 'rubygems'
+                        require 'highrise'
+                        Highrise::Base.site = 'http://your_api:login@your_site.highrisehq.com/'
+                        }
+  s.authors          = ["Marcos Tapajós", "Ken Mayer"]
+  s.email            = "kmayer@bitwrangler.com"
+  s.homepage         = "http://github.com/kmayer/highrise"
+  s.require_path     = "lib"
+  s.autorequire      = "highrise"
+  s.files            = %w(README.mkdn Rakefile MIT-LICENSE spec.opts spec_helper.rb) + 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,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/curlhelper.rb

@@ -0,0 +1,27 @@
+module Highrise
+  class CurlHelper 
+    
+    # thanks mislav ;) http://github.com/mislav/curly/tree/master
+    
+    def initialize
+      @curly = Curly.new
+      @curly.http_auth_types = Curl::CURLAUTH_BASIC
+    end
+    
+    def get_userpwd_from_url(url)
+      userpwd_from_url_regex = /(http|https):\/\/((?:[\w\.\-\+%!$&'\(\)*\+,;=]+:)*[\w\.\-\+%!$&'\(\)*\+,;=]+)?/
+      match = userpwd_from_url_regex.match(url)
+      match.captures[1] unless match.nil?
+    end
+    
+    def get_document(url)
+      @curly.userpwd = get_userpwd_from_url(url)
+      @curly.get(url).doc
+    end
+    
+    def get_document_from_id(collection_name_and_id)
+      get_document("#{Highrise::Base.site.to_s}#{collection_name_and_id}")
+    end
+    
+  end
+end

data/lib/highrise/curly.rb

@@ -0,0 +1,96 @@
+class Curly < ActiveSupport::BasicObject
+  attr_reader :uri
+  
+  def initialize(uri = nil)
+    @curl = Curl::Easy.new
+    self.uri = uri
+    self.follow_location = true
+    yield self if block_given?
+  end
+  
+  def uri=(obj)
+    case obj
+    when String
+      unless @uri
+        @uri = URI.parse(obj)
+      else
+        @uri += obj
+      end
+    when URI::HTTP
+      @uri = obj
+    when nil
+      return
+    else
+      raise "unsupported URI type (#{obj.class.name} given)"
+    end
+    
+    self.url = @uri.to_s
+  end
+  
+  def method_missing(method, *args, &block)
+    @curl.send(method, *args, &block)
+  end
+  
+  def cookiejar=(filename)
+    self.enable_cookies = true
+    @curl.cookiejar = filename
+  end
+  
+  def get(uri = nil)
+    self.uri = uri
+    http_get
+    raise "expected 2xx, got #{response_code} (GET #{url})" unless success?
+    self
+  end
+  
+  def success?
+    response_code >= 200 and response_code < 300
+  end
+  
+  def doc
+    Hpricot body_unicode
+  end
+  
+  def encoding
+    return @encoding unless @encoding == false
+    @encoding = if body_str =~ /;\s*charset=([\w-]+)\s*['"]/
+      $1.downcase
+    else
+      false
+    end
+  end
+  
+  def post(params)
+    fields = params.map do |key, value|
+      Curl::PostField.content(key.to_s, value.to_s)
+    end
+    http_post *fields
+  end
+  
+  class Form
+    def initialize(element)
+      @node = element
+    end
+    
+    def elements
+      @node.search('input, button, select, textarea')
+    end
+  end
+  
+  protected
+  
+    def body_unicode
+      body = body_str
+      if encoding and encoding != 'utf-8'
+        body = Iconv.conv('UTF-8', encoding, body)
+      end
+      body
+    end
+    
+end
+
+Hpricot::Doc.class_eval do
+  def forms
+    search('form').map { |f| Curly::Form.new(f) }
+  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,20 @@
+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
+    
+  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,7 @@
+module Highrise
+  class Tag < Base
+    def ==(object)
+      (object.instance_of?(self.class) && object.id == self.id && object.name == self.name)
+    end
+  end
+end

data/lib/highrise/taggable.rb

@@ -0,0 +1,29 @@
+module Highrise
+  module Taggable
+    
+    # thanks for the user Inka, http://forum.37signals.com/highrise/forums/15/topics/1312?page=2
+        
+    def tag!(tag_name)
+      self.post(:tags, :name => tag_name) unless tag_name.blank?
+    end
+    
+    def untag!(tag_name)
+      to_delete = self.tags.find{|t| t.name==tag_name} unless tag_name.blank?
+      self.delete("tags/#{to_delete.id}") unless to_delete.nil?
+    end
+            
+    def tags      
+      tags = []
+      get_document.search("#show_tags a").each{ |a|
+       tags << Highrise::Tag.new(:id => a['href'].gsub(/.*\//, ''), :name => a.inner_html) if a['class'] == "grey tag"
+      }
+      tags
+    end
+        
+    def get_document
+      @curl_helper ||= CurlHelper.new
+      @doc = @curl_helper.get_document_from_id("#{self.class.collection_name}/#{self.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/lib/highrise/version.rb

@@ -0,0 +1,9 @@
+module Highrise
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 7
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/highrise.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'active_resource'
+require 'uri'
+require 'curb'
+gem 'activesupport', '>= 2.1'
+require 'active_support/basic_object'
+require 'hpricot'
+require 'iconv'
+
+require File.dirname(__FILE__) + '/highrise/pagination'
+require File.dirname(__FILE__) + '/highrise/curly'
+require File.dirname(__FILE__) + '/highrise/curlhelper'
+require File.dirname(__FILE__) + '/highrise/taggable'
+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'
+require File.dirname(__FILE__) + '/highrise/tag'

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