rogerio-augusto-highrise 2.0.2

data/.gitignore

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

data/CHANGELOG

@@ -0,0 +1,136 @@
+Author: Marcos Tapajós <tapajos@gmail.com>
+Date:   Wed Aug 25 23:05:00 2010 -0300
+
+    Version bump to 2.0.1 -- Add Gemspec. It is necessary to use GemBundler with :git => repository...
+
+Author: Kenneth Mayer <kmayer@bitwrangler.com>
+Date:   Wed Feb 17 09:42:25 2010 -1000
+
+    Version bump to 2.0.0 -- Complete rewrite of Cachable. Interface has changed, see docs and examples.
+
+Author: Kenneth Mayer <kmayer@bitwrangler.com>
+Date:   Mon Feb 15 13:41:28 2010 -1000
+
+    Version bump to 1.2.0
+
+    Added Account class to handle the /account.xml end point.
+
+Author: Marcos Tapajós <tapajos@gmail.com>
+Date:   Wed Feb 10 22:57:34 2010 -0200
+
+    Version bump to 1.1.0 -- Added Deal class, .add_note helper, /me.xml endpoint
+
+Author: Kenneth Mayer <kmayer@bitwrangler.com>
+Date:   Wed Sep 2 08:56:42 2009 -1000
+
+    Version bump to 1.0.1
+
+    Added a couple of convenience methods.
+
+Author: Kenneth Mayer <kmayer@bitwrangler.com>
+Date:   Tue Sep 1 21:32:19 2009 -1000
+
+    Version bump to 1.0.0
+
+    Revised Taggable interface to support new tag API from 37Sigs and (removed curl dependencies)
+
+    Refactored Cachable
+
+Author: Kenneth Mayer <kmayer@bitwrangler.com>
+Date:   Fri May 29 22:34:03 2009 -1000
+
+    Version bump to 0.13.0
+
+    Added Tag.find_by_name
+
+2009-05-27 Ken Mayer <kmayer@bitwrangler.com>
+
+  * Version 0.12.0
+
+  * Added store_options attribute, so fetches will work work with
+    :mem_cache_store and :expires_in
+
+2009-05-20 Ken Mayer <kmayer@bitwrangler.com>
+
+  * Version 0.11.0
+
+  * Added untag_id! to Taggable, in case you already know the id and don't
+    need to search for it again.
+
+2009-05-16 Ken Mayer <kmayer@bitwrangler.com>
+
+  * Version 0.10.0
+
+  * Simplified caching store interface, left configuration up to end-user with
+    less magic
+
+  * Removed version.rb module & tests. No one will ever use it, why clutter up
+    the code.
+
+2009-05-05 Ken Mayer <kmayer@bitwrangler.com>
+
+  * Version 0.9.2
+  
+  * Refactored cachable to be more idiomatic ruby
+  
+  * Dropped the SHA1 hashing from cache_key
+
+2009-05-04 Ken Mayer <kmayer@bitwrangler.com>
+
+  * Version 0.9.0
+
+  * Changed cache_store= interface to accept :none (to disable caching),
+    :rails (to use the default Rails cache, whatever that happens to be), and,
+    consequently, restores the lookup_store default behavior (given nil or
+    empty options returns a new, default cache_store).
+
+  * Documentation update. Created and back-filled CHANGELOG
+  
+2009-05-01 Ken Mayer <kmayer@bitwrangler.com>
+
+  * Version 0.8.0
+  
+  * Added caching feature
+  
+  * Added example code
+  
+  * Documentation update
+  
+  * Updated gemspec
+  
+2009-04-26 Ken Mayer <kmayer@bitwrangler.com>
+  
+  * Version 0.7.0
+
+  * Refactored Tag & Taggable so ::Tag is a subclass of Base. This adds
+    ::Tag.find(:all) to your quiver of tools. All existing functionality
+    passes tests, but the interface to ::Tag.new has changed. You have to
+    treat it like all of other ARes, that is, use a Hash (instead of
+    positional parameters) to initialize the model.
+
+2009-04-22 Luis Bepop
+
+  * Version 0.6.3
+
+  * Support to tags refactored. Include curl helper to improve support for
+    objects without ActiveResource base like 'tag' which needs a parse in a
+    html document from a httprequest.
+
+2009-04-06 slainer68
+
+  * Version 0.6.2
+  
+  * Modularize Taggable
+  
+2009-03-31 ThiagoLelis
+
+  * Version 0.6.1
+
+  * Add Person.tag that show a array of tags, and Perton.tag(name), add a new
+    tag to a person.
+
+2009-01-14 Marcos Tapajós
+
+  * Version 0.5.0
+  
+  * Initial import

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.mkdn

@@ -0,0 +1,84 @@
+# Highrise (2.0.0)
+
+## 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, 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 highrise
+
+### Dependencies (see the Rakefile or run <code>rake check_dependencies</code>)
+
+### Documentation
+
+  I'm on [rdoc.info][rdoc] and here're some [metrics][caliper]
+
+### Configure your key
+    
+    require 'rubygems'
+    require 'highrise'
+    
+    Highrise::Base.site = 'http://your_site.highrisehq.com'
+    Highrise::Base.user = 'api-auth-token'
+
+and, if you want [caching][c]:
+
+    Highrise::Base.connection.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]
+
+## 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
+[e]:  http://github.com/primedia/endeca/tree/master
+[h]:  http://www.highrisehq.com/
+[i]:  http://github.com/tapajos/highrise/issues
+[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/tapajos/highrise
+[caliper]: https://devver.net/caliper/project?repo=git%3A%2F%2Fgithub.com%2Ftapajos%2Fhighrise.git

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+gem 'rspec', ">= 1.3.0"
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "highrise"
+    gemspec.summary = "Ruby wrapper around Highrise API"
+    gemspec.email = ["marcos@tapajos.me", "kmayer@bitwrangler.com"]
+    gemspec.homepage = "http://github.com/tapajos/highrise"
+    gemspec.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 'highrise'
+Highrise::Base.site = 'http://your_site.highrisehq.com/'
+Highrise::Base.user = 'your_api_auth_token'
+                          }
+    gemspec.authors = ["Marcos Tapajós", "Ken Mayer"]
+    gemspec.add_dependency('activeresource', '>= 2.1')
+    gemspec.add_dependency('activesupport', '>= 2.1')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+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/spec.opts']
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 2
+:minor: 0
+:build: 
+:patch: 1

data/autotest/discover.rb

@@ -0,0 +1,3 @@
+Autotest.add_discovery do
+  "rspec"
+end

data/examples/config_initializers_highrise.rb

@@ -0,0 +1,12 @@
+if Rails.env != 'test' then
+  Highrise::Base.site = 'https://example.com.i'
+  # For backward compatability
+  if Highrise::Base.respond_to? :user
+    Highrise::Base.user = 'my_fancy_auth_token'
+  else 
+    Highrise::Base.site = 'https://my_fancy_auth_token@example.com.i'
+  end
+  # The cache store can be anything that ActiveSupport can handle
+  Highrise::Base.connection.cache_store = ActiveSupport::Cache.lookup_store :mem_cache_store
+  Highrise::Base.connection.store_options = { :expires_in => 60.seconds }
+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,10 @@
+require 'highrise'
+require 'pp'
+
+Highrise::Base.site = 'https://yoursite.highrisehq.com'
+Highrise::Base.user = 'xxx'
+Highrise::Base.connection.cache_store = :memory_store
+
+@tags = Highrise::Tag.find(:all)
+
+pp @tags

data/highrise.gemspec

@@ -0,0 +1,129 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rogerio-augusto-highrise}
+  s.version = "2.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marcos Tapaj\303\263s", "Ken Mayer"]
+  s.date = %q{2010-08-25}
+  s.description = %q{
+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 'highrise'
+Highrise::Base.site = 'http://your_site.highrisehq.com/'
+Highrise::Base.user = 'your_api_auth_token'
+                          }
+  s.email = ["marcos@tapajos.me", "kmayer@bitwrangler.com"]
+  s.extra_rdoc_files = [
+    "README.mkdn"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.mkdn",
+     "Rakefile",
+     "VERSION.yml",
+     "autotest/discover.rb",
+     "examples/config_initializers_highrise.rb",
+     "examples/extending.rb",
+     "examples/sample.rb",
+     "highrise.gemspec",
+     "install.rb",
+     "lib/cachable.rb",
+     "lib/highrise.rb",
+     "lib/highrise/account.rb",
+     "lib/highrise/base.rb",
+     "lib/highrise/comment.rb",
+     "lib/highrise/company.rb",
+     "lib/highrise/deal.rb",
+     "lib/highrise/deal_category.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",
+     "spec/cachable_spec.rb",
+     "spec/highrise/account_spec.rb",
+     "spec/highrise/base_spec.rb",
+     "spec/highrise/comment_spec.rb",
+     "spec/highrise/company_spec.rb",
+     "spec/highrise/deal_spec.rb",
+     "spec/highrise/deal_category_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",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/tapajos/highrise}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby wrapper around Highrise API}
+  s.test_files = [
+    "spec/cachable_spec.rb",
+     "spec/highrise/account_spec.rb",
+     "spec/highrise/base_spec.rb",
+     "spec/highrise/comment_spec.rb",
+     "spec/highrise/company_spec.rb",
+     "spec/highrise/deal_spec.rb",
+     "spec/highrise/deal_category_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_helper.rb",
+     "examples/config_initializers_highrise.rb",
+     "examples/extending.rb",
+     "examples/sample.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activeresource>, [">= 2.1"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.1"])
+    else
+      s.add_dependency(%q<activeresource>, [">= 2.1"])
+      s.add_dependency(%q<activesupport>, [">= 2.1"])
+    end
+  else
+    s.add_dependency(%q<activeresource>, [">= 2.1"])
+    s.add_dependency(%q<activesupport>, [">= 2.1"])
+  end
+end
+

data/install.rb

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

data/lib/cachable.rb

@@ -0,0 +1,83 @@
+# 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 < ActiveResource::Base
+#     include ::Cachable
+#   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.cache_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 class, not just Highrise.
+
+module Cachable
+  def self.included(base)
+    ActiveResource::Connection.class_eval do
+      def cache_store
+        @cache_store ||= nil
+      end
+
+      def cache_store=(store)
+        @cache_store = store
+      end
+      
+      def cache_options
+        @cache_options ||= {}
+      end
+      alias :store_options :cache_options
+      
+      def cache_options=(options)
+        @cache_options = options
+      end
+      alias :store_options= :cache_options=
+      
+      def is_caching?
+        !@cache_store.nil?
+      end
+      
+      def get_with_cache(path, headers = {})
+        return get_without_cache(path, headers) unless is_caching?
+        cache_store.fetch(cache_key(path), cache_options) {get_without_cache(path, headers)}
+      end
+      alias_method_chain :get, :cache
+
+      def put_with_cache(path, body = '', headers = {})
+        cache_store.delete(cache_key(path))
+        put_without_cache(path, body, headers)
+      end
+      alias_method_chain :put, :cache
+      
+      def delete_with_cache(path, headers = {})
+        cache_store.delete(cache_key(path))
+        delete_without_cache(path, headers)
+      end
+      alias_method_chain :delete, :cache
+      
+      def cache_key(*args)
+        args.join(':')
+      end
+    end
+  end  
+end

data/lib/highrise/account.rb

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

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,18 @@
+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
+    
+    def label
+      'Party'
+    end
+  end
+end

data/lib/highrise/deal.rb

@@ -0,0 +1,5 @@
+module Highrise
+  class Deal < Subject
+
+  end
+end

data/lib/highrise/deal_category.rb

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