kmayer-highrise 0.7.1 → 0.8.0

data/README.mkdn

@@ -1,9 +1,17 @@
-# Highrise
+# Highrise (0.8.0)
 
 ## What
 
 [Highrise][h] is a gem that provides an easy way to use the [Highrise API][api].
 
+This gem provides a set of classes to access available information 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][ar] documentation.
+
 ## Installing
 
     gem install kmayer-highrise
@@ -19,51 +27,60 @@
     
     require 'rubygems'
     require 'highrise'
+    
     Highrise::Base.site = 'http://your_api:login@your_site.highrisehq.com/'
     
-## Usage
+or
 
-This gem provides a set of classes to access all available informations on [Highrise][h].
+    Highrise::Base.site = 'http://your_site.highrisehq.com'
+    Highrise::Base.user = 'api-auth-token'
 
-These are the list of classes:
+and, if you want caching(!)
 
-    Comment, Company, Email, Group, Case, Membership, Note, Person, Subject, Tag, Task and User. 
+    Highrise::Base.connection.cache_store= <your normal ActiveSupport::Caching options>
+    
+## Usage
 
-All these classes are inherited of ActiveResouce::Base. For more informations see the ActiveResouce documentation.
+    @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].
 
-## Contact
-
-Comments are welcome. Send your feedback through [this page][co]
+## Bugs, Issues, Kudos and Catcalls
 
-## Authors
-
-[Marcos Tapajós][mt]
+Comments are welcome. Send your feedback through the [issue tracker on GitHub][i]
 
 ## Contributors
 
+* [Marcos Tapajós][mt]
 * [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].
+## Special Thanks
 
-[![Improve It][logo]][ii]
+[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.
 
-[logo]:http://www.improveit.com.br/images/logo/logo_improve_it_screen.gif "Improve It"
+[ar]: http://api.rubyonrails.org/classes/ActiveResource/Base.html
 [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/
+[i]:  http://github.com/kmayer/highrise/issues
 [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
+[api]: http://developer.37signals.com/highrise
+[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
+[e]:  http://github.com/primedia/endeca/tree/master

data/Rakefile

@@ -27,9 +27,13 @@ Configure by adding the following:
 require 'highrise'
 Highrise::Base.site = 'http://your_site.highrisehq.com/'
 Highrise::Base.user = 'your_api_auth_token'q
+Highrise::Base.connection.cache_store = :memory_store # for caching
                           }
     gemspec.authors = ["Marcos Tapajós", "Ken Mayer"]
-    gemspec.add_dependency('activeresource', '>=2.2.2')
+    gemspec.add_dependency('activeresource', '>=2.2')
+    gemspec.add_dependency('activesupport', '>=2.1')
+    gemspec.add_dependency('curb')
+    gemspec.add_dependency('hpricot')
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gems.github.com"
@@ -41,5 +45,5 @@ 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']
+  t.spec_opts = ['--options', 'spec/spec.opts']
 end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
+:patch: 0
 :major: 0
-:minor: 7
-:patch: 1
+:minor: 8

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/lib/cachable.rb

@@ -0,0 +1,65 @@
+require 'digest/sha1'
+
+# Caching is a way to speed up slow ActiveResource queries by keeping the result of
+# an ActiveResource request around to be reused by subequest requests. Caching is
+# turned off by default.
+#
+# == Usage
+# 
+#   require 'lib/cachable'
+# 
+#   module CachedResource
+#     class Base < ActiveResource::Base
+#     end
+#     include Cachable
+#   end
+#
+# == Caching stores
+#
+# All the caching stores from ActiveSupport::Cache are available to be used
+# as backends for caching. See the Rails rdoc for more information on
+# these stores
+#
+# Configuration examples ('off' is the default):
+#
+#   CachedResource.connection.cache_store = :memory_store
+#   CachedResource.connection.cache_store = :file_store, "/path/to/cache/directory"
+#   CachedResource.connection.cache_store = :drb_store, "druby://localhost:9192"
+#   CachedResource.connection.cache_store = :mem_cache_store, "localhost"
+#   CachedResource.connection.cache_store = MyOwnStore.new("parameter")
+#
+# Note: To ensure that caching is turned off, set CachedResource.connection.cache_store = nil
+
+module Cachable
+  def self.included(base)
+    ActiveResource::Connection.alias_method_chain :get, :cache
+  end
+  ActiveResource::Connection.class_eval do
+    def cache_store
+      @cache_store ||= nil
+    end
+
+    def cache_store=(store_option)
+      @cache_store = store_option.nil? ? nil : ActiveSupport::Cache.lookup_store(store_option)
+    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)
+      Digest::SHA1.hexdigest args.to_s
+    end
+
+    def fetch(args, &block)
+      cache_store.fetch(cache_key(args), &block).dup
+    end
+  end
+end

data/lib/highrise/base.rb

@@ -1,4 +1,7 @@
+require 'lib/cachable'
+
 module Highrise
   class Base < ActiveResource::Base
   end
-end
+  include Cachable
+end

data/lib/highrise/curly.rb

@@ -1,3 +1,8 @@
+require 'hpricot'
+require 'iconv'
+require 'curb'
+require 'uri'
+
 class Curly < ActiveSupport::BasicObject
   attr_reader :uri
   

data/lib/highrise.rb

@@ -1,17 +1,13 @@
-require 'rubygems'
 require 'active_resource'
-require 'uri'
-require 'curb'
-gem 'activesupport', '>= 2.1'
+require 'activesupport'
 require 'active_support/basic_object'
-require 'hpricot'
-require 'iconv'
 
+require File.dirname(__FILE__) + '/highrise/base'
+require File.dirname(__FILE__) + '/highrise/version'
 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'
@@ -24,4 +20,3 @@ 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/version'

data/spec/highrise/base_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Base do
   

data/spec/highrise/cachable_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Highrise::Base, "class configuration" do
+  before(:each) do
+    Highrise::Base.site = 'http://example.com.i:3000'
+    @connection = Highrise::Base.connection
+  end
+    
+  it "should tell us if caching is active" do
+    @connection.cache_store = :memory_store
+    @connection.is_caching?.should == true
+  end
+  
+  it "should tell us if caching is not active" do
+    @connection.cache_store = nil
+    @connection.is_caching?.should == false
+  end
+end
+
+describe Highrise::Base do
+  before(:all) do
+    Highrise::Base.site = 'http://example.com.i:3000'
+    @connection = Highrise::Base.connection
+    @connection.cache_store = :memory_store
+  end
+  
+  after(:all) do
+    @connection.cache_store = nil
+  end
+  
+  before(:each) do
+    @thing = Highrise::Base.new
+    @key = :key
+    @connection.should_receive(:cache_key).and_return(@key)
+  end
+  
+  context "when a cached response is available" do
+    before(:each) do
+      @connection.cache_store.write(@key, @thing.attributes)
+    end
+    
+    it "should NOT make a request to the RESTful server" do
+      ActiveResource::Connection.should_not_receive(:get_without_cache)
+      Highrise::Base.find(1)
+    end
+    
+    it "should read from the cache" do
+      Highrise::Base.find(2).should == @thing
+    end
+  end
+  
+  context "when a cached response is NOT available" do
+    before(:each) do
+      @connection.cache_store.delete(@key)
+    end
+    
+    it "SHOULD perform an ARes request" do
+      @connection.should_receive(:get_without_cache).and_return(@thing.attributes)
+      Highrise::Base.find(3)
+    end
+    
+    it "should cache the response using the caching key" do
+      @connection.should_receive(:get_without_cache).and_return(@thing.attributes)
+      Highrise::Base.find(4)
+      @connection.cache_store.read(@key).should == @thing.attributes
+    end
+  end
+end

data/spec/highrise/comment_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Comment do
 

data/spec/highrise/company_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Company do
 

data/spec/highrise/curlhelper_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::CurlHelper do
   before do

data/spec/highrise/curly_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Curly do
   before do

data/spec/highrise/email_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Email do
 

data/spec/highrise/group_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Group do
 

data/spec/highrise/kase_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Kase do
 
@@ -12,7 +12,7 @@ describe Highrise::Kase do
   
   describe ".close!" do
 
-    it "should set close date anda save" do
+    it "should set close date and 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)

data/spec/highrise/membership_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Membership do
 

data/spec/highrise/note_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Note do
 

data/spec/highrise/pagination_spec.rb

@@ -1,7 +1,10 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Pagination do
   
-  it "should be tested"
-
+  it "should be tested" do
+    Highrise::Person.should_receive(:find).with(:all,{:params=>{:n=>0}}).and_return(["people"])
+    Highrise::Person.should_receive(:find).with(:all,{:params=>{:n=>1}}).and_return([])
+    Highrise::Person.find_all_across_pages.should == ["people"]
+  end
 end

data/spec/highrise/person_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Person do
 

data/spec/highrise/subject_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Subject do
 

data/spec/highrise/tag_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Tag do
 

data/spec/highrise/task_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::Task do
 

data/spec/highrise/user_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::User do
 

data/spec/highrise/version_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Highrise::VERSION do
   it "should return a version string" do

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse
+-rubygems

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../lib/highrise'
+
+def turn_methods_public(classe, method_name = nil)
+  if method_name
+    classe.class_eval do
+      public method_name
+    end
+  else
+    turn_all_methods_public classe
+  end
+end
+
+def turn_all_methods_public(classe)
+  classe.class_eval do
+    private_instance_methods.each { |instance_method| public instance_method }
+    private_methods.each { |method| public_class_method method } 
+    protected_instance_methods.each { |instance_method| public instance_method }
+    protected_methods.each { |method| public_class_method method } 
+  end  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kmayer-highrise
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors: 
 - "Marcos Tapaj\xC3\xB3s"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-30 00:00:00 -07:00
+date: 2009-05-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,9 +21,39 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.2.2
+        version: "2.2"
     version: 
-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'q"
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: curb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+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'q Highrise::Base.connection.cache_store = :memory_store # for caching"
 email: kmayer@bitwrangler.com
 executables: []
 
@@ -35,6 +65,9 @@ files:
 - README.mkdn
 - Rakefile
 - VERSION.yml
+- examples/extending.rb
+- examples/sample.rb
+- lib/cachable.rb
 - lib/highrise.rb
 - lib/highrise/base.rb
 - lib/highrise/comment.rb
@@ -55,6 +88,7 @@ files:
 - lib/highrise/user.rb
 - lib/highrise/version.rb
 - spec/highrise/base_spec.rb
+- spec/highrise/cachable_spec.rb
 - spec/highrise/comment_spec.rb
 - spec/highrise/companies/16883216.html
 - spec/highrise/company_spec.rb
@@ -73,6 +107,8 @@ files:
 - spec/highrise/task_spec.rb
 - spec/highrise/user_spec.rb
 - spec/highrise/version_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/kmayer/highrise
 post_install_message: 
@@ -101,6 +137,7 @@ specification_version: 3
 summary: Ruby wrapper around Highrise API
 test_files: 
 - spec/highrise/base_spec.rb
+- spec/highrise/cachable_spec.rb
 - spec/highrise/comment_spec.rb
 - spec/highrise/company_spec.rb
 - spec/highrise/curlhelper_spec.rb
@@ -117,3 +154,6 @@ test_files:
 - spec/highrise/task_spec.rb
 - spec/highrise/user_spec.rb
 - spec/highrise/version_spec.rb
+- spec/spec_helper.rb
+- examples/extending.rb
+- examples/sample.rb