soleone-highrise 0.13.3

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/cachable.rb

@@ -0,0 +1,77 @@
+# 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
+#     end
+#     class ActiveResource::Connection
+#       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.connection.cache_store = ActiveSupport::Cache.lookup_store :memory_store
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :file_store, "/path/to/cache/directory"
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :drb_store, "druby://localhost:9192"
+#   CachedResource.connection.cache_store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost"
+#   CachedResource.connection.cache_store = MyOwnStore.new("parameter")
+#
+# === If you are using a store that has write options, you can set them
+#   CachedResource.connection.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.class_eval do
+      include InstanceMethods
+      alias_method_chain :get, :cache
+    end
+  end
+
+  module InstanceMethods
+    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
+
+    def get_with_cache(path, headers = {})
+      return get_without_cache(path, headers) unless is_caching?
+      fetch(path) { get_without_cache(path, headers) }
+    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,22 @@
+require 'active_resource'
+require 'activesupport'
+require 'active_support/basic_object'
+
+require File.dirname(__FILE__) + '/highrise/base'
+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/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'
+require File.dirname(__FILE__) + '/highrise/deal'

data/lib/highrise/base.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../cachable'
+
+module Highrise
+  class Base < ActiveResource::Base
+  end
+  class ActiveResource::Connection
+    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/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,101 @@
+require 'hpricot'
+require 'iconv'
+require 'curb'
+require 'uri'
+
+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/deal.rb

@@ -0,0 +1,35 @@
+module Highrise
+  # name
+  # background
+  # status (pending, won, lost)
+  # category-id
+  # ---------------------------
+  # account-id
+  # author-id
+  # created-at
+  # currency
+  # duration
+  # group-id
+  # owner-id
+  # party-id
+  # price type
+  # price-type
+  # responsible-party-id
+  # status-changed-on
+  # updated-at
+  # visible-to
+  class Deal < Subject
+    
+    class DealCategory < Base
+      def self.find_by_name(name)
+        find(:all).select{|category| category.name == name}.first
+      end
+      
+      def self.delete!(name)
+        category = self.find_by_name(name)
+        delete(category.id) if category
+      end
+    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,7 @@
+module Highrise
+  class Group < Base
+    def self.find_by_name(name)
+      find(:all).select{|category| category.name == name}.first
+    end
+  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,43 @@
+module Highrise
+  class Person < Subject
+    DATE_OCCASIONS = ["Birthday", "Anniversary", "First met", "Hired", "Fired"]
+    
+    include Pagination
+    include Taggable
+    
+    def self.search_by_name(name)                                               
+      find(:first, :from => "/people/search.xml", :params => {:term => name})
+    end
+    
+    def self.find_all_by_tag(tag_name)
+      tag = Tag.find_by_name(tag_name)
+      find(:all, :from => "/tags/#{tag.id}.xml")
+    end
+    
+    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 add_date!(description, date, task_owner_id=nil)
+      description_key = DATE_OCCASIONS.include?(description) ? :description : :custom_description
+      custom_date = { description_key => description, :month => date.month, :day => date.day, :year => date.year }
+      if task_owner_id
+        custom_date[:assign_task]   = true
+        custom_date[:task_owner_id] = task_owner_id 
+      end
+      # TODO: use different way to add date (current throws 406 from Highrise, but works anyways)
+      self.post(:contact_dates, :contact_date => custom_date) rescue nil
+    end
+    
+  end
+
+end

data/lib/highrise/subject.rb

@@ -0,0 +1,50 @@
+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
+    
+    def add_note!(note_body)
+      return if note_body.blank?
+      note = Note.new(:body => note_body)
+      self.post(:notes, {}, note.to_xml)
+    end
+    
+    def add_deal!(name, category, status=nil, background=nil)
+      category_object = Deal::DealCategory.find_by_name(category)
+      category_id = category_object ? category_object.id : nil
+      deal = Deal.new(:name => name, :background => background, :status => status || "pending", :category_id => category_id)
+      deal.price_type = 'fixed'
+      deal.party_id   = self.id
+      deal.save
+    end
+
+    def add_task!(body, due_date, arguments = {})
+      category = Task::TaskCategory.find_by_name(arguments[:category])
+      category_id = category ? category.id : nil
+
+      task = Task.new(arguments.merge(:body => body, :category_id => category_id))
+
+      if Task::DUE_DATES.include?(due_date.to_s)
+        task.frame = due_date
+      else
+        task.frame = 'specific'
+        task.due_at = due_date
+      end
+
+      task.subject_type = self.instance_of?(Kase) ? 'Kase' : 'Party'
+      task.subject_id   = self.id
+      task.save
+    end
+    
+    
+  end
+end