peterosullivan-highrise 3.0.2

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/**
+.rvmrc

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.2
+  - 1.8.7
+  - ree-1.8.7
+  - 1.8.7-p249
+  - jruby
+# branches:
+#   only:
+#     - master

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    highrise (3.0.1)
+      activeresource (~> 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activeresource (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    bcrypt-ruby (3.0.0)
+    bcrypt-ruby (3.0.0-java)
+    builder (3.0.0)
+    diff-lcs (1.1.2)
+    i18n (0.6.0)
+    multi_json (1.0.3)
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  activeresource (~> 3.0)
+  highrise!
+  rake (= 0.8.7)
+  rspec (~> 2.0.1)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Ken Mayer & Marcos Tapajos
+
+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.md

@@ -0,0 +1,89 @@
+##whats in this fork
+
+This fork is very close to the orginal gem. I have added a few features and shortcut methods;
+
+
+    Highrise::Tag.delete_by_name('tag_name')
+    
+    Highrise::Person.url_for(123)
+    Highrise::Person.find(123).tagged?('tag_name')
+    Highrise::Person.find(123).email_address
+    Highrise::Person.find(123).email_valid?
+    Highrise::Person.find(123).phone_number
+
+# Highrise (3.0.0) [![Build Status](https://secure.travis-ci.org/tapajos/highrise.png)](http://travis-ci.org/tapajos/highrise)
+
+## What is it?
+
+This gem provides a set of classes to access information on [Highrise][h] via the published [API][api]:
+
+    Account, Comment, Company, Deal, DealCategory, Email, Group, Case, Membership, Note, Party, Person, Recording, Subject, Tag, Task, TaskCategory and User.
+
+All these classes are inherited from ActiveResouce::Base. Refer to the [ActiveResouce][ar] documentation for more information.
+
+## Installing
+
+    gem install peterosullivan-highrise
+
+### Dependencies (see <code>highrise.gemspec</code> or run <code>bundle check</code>)
+
+### Documentation
+
+  I'm on [rdoc.info][rdoc]
+
+### Configure your key
+    
+    require 'highrise'
+    
+    Highrise::Base.site = 'https://your_site.highrisehq.com'
+    Highrise::Base.user = 'api-auth-token'
+
+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]
+
+If you have fixes: Submit via pull requests. Do not include version changes to the 
+version file. 
+
+## Authors
+
+* [Marcos Tapajós][tapajos]
+* [Ken Mayer][kmayer]
+
+## Contributors
+
+* [Nicolas Bianco][slainer86]
+* [Luis Gustavo][luisbebop]
+* [Thiago Lelis][ThiagoLelis]
+* [Denis Odorcic][odorcicd]
+
+
+
+[api]: http://developer.37signals.com/highrise
+[ar]: http://api.rubyonrails.org/classes/ActiveResource/Base.html
+[c]:  http://api.rubyonrails.org/classes/ActiveSupport/Cache
+[h]:  http://www.highrisehq.com/
+[i]:  https://github.com/tapajos/highrise/issues
+[kmayer]: https://github.com/kmayer
+[luisbebop]: https://github.com/luisbebop
+[mit]:http://www.opensource.org/licenses/mit-license.php
+[slainer86]: https://github.com/slainer86
+[odorcicd]: https://github.com/odorcicd
+[rdoc]: http://rdoc.info/projects/tapajos/highrise
+[tapajos]: http://www.improveit.com.br/en/company/tapajos
+[ThiagoLelis]: https://github.com/ThiagoLelis

data/Rakefile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ["-c", "-f progress"]
+end

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/examples/config_initializers_highrise.rb

@@ -0,0 +1,4 @@
+if Rails.env != 'test' then
+  Highrise::Base.site = 'https://example.com.i'
+  Highrise::Base.user = 'my_fancy_auth_token'
+end

data/examples/extending.rb

@@ -0,0 +1,31 @@
+#
+# Example of extending a class when you need to synthesize an attribute.
+#
+# Adds Highrise::Person.{phone,fax,email} to the Person class inside your
+# module
+#
+
+module MyModule
+  include Highrise
+  
+  Highrise::Person.class_eval do
+    class << self
+      def lookup(id, list, item, location)
+        module_eval <<-EOT
+          def #{id}
+            contact_data.#{list}.each do |i|
+              return i.#{item}.strip if i.location == "#{location}"
+            end
+            ''
+          end
+        EOT
+      end
+    
+      private :lookup
+    end
+  
+    lookup(:phone, 'phone_numbers',   'number',  'Work')
+    lookup(:fax,   'phone_numbers',   'number',  'Fax')
+    lookup(:email, 'email_addresses', 'address', 'Work')
+  end
+end

data/examples/sample.rb

@@ -0,0 +1,9 @@
+require 'highrise'
+require 'pp'
+
+Highrise::Base.site = 'https://yoursite.highrisehq.com'
+Highrise::Base.user = 'xxx'
+
+@tags = Highrise::Tag.find(:all)
+
+pp @tags

data/highrise.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "highrise/version"
+
+Gem::Specification.new do |s|
+  s.name        = "peterosullivan-highrise"
+  s.version     = Highrise::VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.add_dependency "activeresource", "~>3.0"
+  s.add_development_dependency "rspec", "~>2.0.1"
+  s.add_development_dependency "rake", "=0.8.7"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features,examples}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.authors       = ["Marcos Tapaj\303\263s", "Ken Mayer", "Peter O'Sullivan"]
+  s.email         = ["marcos@tapajos.me", "kmayer@bitwrangler.com", "peter@peterosullivan.net"]
+  s.homepage      = "https://github.com/peterosullivan/highrise"
+  s.summary       = %q{Ruby wrapper around Highrise API}
+  s.description   = <<-EOT
+    Based on the original API module from DHH, http://developer.37signals.com/highrise/, this
+    gem is a cleaned up, tested version of the same. A fork of Tapaj gem. See the homepage for add features.
+
+    Configure by adding the following:
+
+    require 'highrise'
+    Highrise::Base.site = 'http://your_site.highrisehq.com/'
+    Highrise::Base.user = 'your_api_auth_token'
+  EOT
+end

data/lib/highrise/account.rb

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

data/lib/highrise/base.rb

@@ -0,0 +1,25 @@
+require 'active_resource'
+
+module Highrise
+  class Base < ActiveResource::Base
+    
+    def self.url_for(n)
+      base  = site.to_s.split('@')[1]
+      File.join('https://', base, element_path(n)).gsub(".xml",'')
+    end
+
+    protected
+    # Dynamic finder for attributes
+    def self.method_missing(method, *args)
+      if method.to_s =~ /^find_(all_)?by_([_a-zA-Z]\w*)$/
+        raise ArgumentError, "Dynamic finder method must take an argument." if args.empty?
+        options = args.extract_options!
+        resources = respond_to?(:find_all_across_pages) ? send(:find_all_across_pages, options) : send(:find, :all)
+        resources.send($1 == 'all_' ? 'select' : 'detect') { |container| container.send($2) == args.first }
+      else
+        super
+      end
+    end
+   
+  end
+end

data/lib/highrise/comment.rb

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

data/lib/highrise/company.rb

@@ -0,0 +1,15 @@
+module Highrise
+  class Company < Subject
+    include Pagination
+    include Taggable
+    include Searchable
+
+    def people
+      Person.find_all_across_pages(:from => "/companies/#{id}/people.xml")
+    end
+    
+    def label
+      'Party'
+    end
+  end
+end

data/lib/highrise/deal.rb

@@ -0,0 +1,8 @@
+module Highrise
+  class Deal < Subject
+    def update_status(status)
+      raise ArgumentError, "status must be one of 'pending', 'won', or 'lost'" unless %w[pending won lost].include?(status)
+      self.put(:status, :status => {:name => status})
+    end
+  end
+end

data/lib/highrise/deal_category.rb

@@ -0,0 +1,3 @@
+module Highrise
+  class DealCategory < Base; 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,3 @@
+module Highrise
+  class Group < Base; end
+end

data/lib/highrise/kase.rb

@@ -0,0 +1,19 @@
+module Highrise
+  class Kase < Subject
+    def open!
+      update_attribute(:closed_at, nil)
+    end
+
+    def close!
+      update_attribute(:closed_at, Time.now.utc)
+    end
+
+    def self.open
+      Kase.find(:all, :from => "/kases/open.xml")
+    end
+
+    def self.closed
+      Kase.find(:all, :from => "/kases/closed.xml")
+    end
+  end
+end

data/lib/highrise/membership.rb

@@ -0,0 +1,3 @@
+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,72 @@
+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
+
+      # This only is usefull for company, person & recordings, but should be safely ignored by other classes
+      def find_all_across_pages_since(time)
+        find_all_across_pages(:params => { :since => time.utc.strftime("%Y%m%d%H%M%S") })
+      end
+
+      # This is useful only for Company, Person, Note, Comment, Email and Task, but should be safely ignored by other classes
+      def find_all_deletions_across_pages(options = {})
+        # point to the global deletions feed
+        options[:from] = '/deletions.xml'
+
+        records = []
+        each_deletions(options) { |record| records << record }
+        records
+      end
+
+      # This is useful only for Company, Person, Note, Comment, Email and Task, but should be safely ignored by other classes
+      def find_all_deletions_across_pages_since(time)
+        find_all_deletions_across_pages(:params => { :since => time.utc.strftime("%Y%m%d%H%M%S") })
+      end
+
+      private
+      
+      def each(options = {})
+        options[:params] ||= {}
+        options[:params][:n] = 0
+
+        loop do
+          if (records = self.find(:all, options)).try(: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
+
+      def each_deletions(options = {})
+        options[:params] ||= {}
+        # first index for deletions is 1
+        options[:params][:n] = 1
+
+        loop do
+          if (records = self.find(:all, options)).try(:any?)
+            # reject the records whose resource type is different from self
+            records.reject!{|r| r.class.to_s.split('::').last != self.to_s.split('::').last}
+
+            records.each{ |record| yield record }
+
+            # index increment for deletions is 1 per page of 500 resources
+            options[:params][:n] += 1
+          else
+            break # no deletions included on that page, thus no more deletions
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/highrise/party.rb

@@ -0,0 +1,11 @@
+module Highrise
+  class Party < Base
+    def self.recently_viewed
+      find(:all, :from => "/parties/recently_viewed.xml")
+    end
+    
+    def self.deletions_since(time)
+      find(:all, :from => "/parties/deletions.xml", :params => { :since => time.utc.strftime("%Y%m%d%H%M%S") })
+    end
+  end
+end

data/lib/highrise/person.rb

@@ -0,0 +1,45 @@
+module Highrise
+  class Person < Subject
+    require 'highrise/rfc822'
+    include Pagination
+    include Taggable
+    include Searchable
+    
+    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
+    
+    def label
+      'Party'
+    end
+    
+    def phone_number
+      contact_data.phone_numbers.first.number rescue nil
+    end
+    
+    def email_valid?
+      !!(email_address && (email_address =~ RFC822::EmailAddress))
+    end
+    
+    def email_address
+      contact_data.email_addresses.first.address rescue nil
+    end
+    
+    def tagged? name
+     tags.any?{ | tag | tag['name'].to_s == name}  
+    end
+    
+  end
+end

data/lib/highrise/recording.rb

@@ -0,0 +1,5 @@
+module Highrise
+  class Recording < Base
+    include Pagination
+  end
+end

data/lib/highrise/rfc822.rb

@@ -0,0 +1,30 @@
+#
+# RFC822 Email Address Regex
+# --------------------------
+# 
+# Originally written by Cal Henderson
+# c.f. http://iamcal.com/publish/articles/php/parsing_email/
+#
+# Translated to Ruby by Tim Fletcher, with changes suggested by Dan Kubb.
+#
+# Licensed under a Creative Commons Attribution-ShareAlike 2.5 License
+# http://creativecommons.org/licenses/by-sa/2.5/
+# 
+module RFC822
+  EmailAddress = begin
+    qtext = '[^\\x0d\\x22\\x5c\\x80-\\xff]'
+    dtext = '[^\\x0d\\x5b-\\x5d\\x80-\\xff]'
+    atom = '[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-' +
+      '\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+'
+    quoted_pair = '\\x5c[\\x00-\\x7f]'
+    domain_literal = "\\x5b(?:#{dtext}|#{quoted_pair})*\\x5d"
+    quoted_string = "\\x22(?:#{qtext}|#{quoted_pair})*\\x22"
+    domain_ref = atom
+    sub_domain = "(?:#{domain_ref}|#{domain_literal})"
+    word = "(?:#{atom}|#{quoted_string})"
+    domain = "#{sub_domain}(?:\\x2e#{sub_domain})*"
+    local_part = "#{word}(?:\\x2e#{word})*"
+    addr_spec = "#{local_part}\\x40#{domain}"
+    pattern = /\A#{addr_spec}\z/
+  end
+end

data/lib/highrise/searchable.rb

@@ -0,0 +1,23 @@
+module Highrise
+  module Searchable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # List By Search Criteria
+      # Ex: Highrise::Person.search(:email => "john.doe@example.com", :country => "CA")
+      # Available criteria are: city, state, country, zip, phone, email
+      def search(options = {})
+        raise ArgumentError, "cannot convert #{options}:#{options.class} to hash" if options.kind_of?(String)
+        search_params = options.inject({}) { |h, (k, v)| h["criteria[#{k}]"] = v; h }
+        # This might have to be changed in the future if other non-pagable resources become searchable
+        if self.respond_to?(:find_all_across_pages)
+          self.find_all_across_pages(:from => "/#{self.collection_name}/search.xml", :params => search_params)
+        else
+          self.find(:all, {:from => "/#{self.collection_name}/search.xml", :params => search_params})
+        end
+      end
+    end
+  end
+end

data/lib/highrise/subject.rb

@@ -0,0 +1,31 @@
+module Highrise
+  class Subject < Base
+    def notes
+      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 add_task(attrs={})
+      attrs[:subject_id] = self.id
+      attrs[:subject_type] = self.label
+      Task.create attrs
+    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 label
+      self.class.name.split('::').last
+    end
+  end
+end

data/lib/highrise/tag.rb

@@ -0,0 +1,12 @@
+module Highrise
+  class Tag < Base  
+    def ==(object)
+      (object.instance_of?(self.class) && object.id == self.id && object.name == self.name)
+    end
+    
+    def self.delete_by_name(name)
+     tag = find_by_name(name)
+     tag.destroy if tag
+    end
+  end
+end

data/lib/highrise/taggable.rb

@@ -0,0 +1,20 @@
+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
+    protected
+    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