@@ -1,4 +1,4 @@ -# Highrise (0.12.0) +# Highrise (0.13.0) ## What is it? README.mkdn @@ -27,10 +27,8 @@ 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.2') - gemspec.add_dependency('activesupport', '>=2.1') - gemspec.add_dependency('curb') - gemspec.add_dependency('hpricot') + gemspec.add_dependency('activeresource', '>= 2.1') + gemspec.add_dependency('activesupport', '>= 2.1') end rescue LoadError puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gems.github.com" Rakefile @@ -1,4 +1,4 @@ --- -:minor: 13 +:minor: 0 :patch: 0 -:major: 0 +:major: 1 VERSION.yml @@ -1,3 +1,6 @@ +# Generated by jeweler +# DO NOT EDIT THIS FILE +# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec` # -*- encoding: utf-8 -*- Gem::Specification.new do |s| @@ -6,7 +9,7 @@ Gem::Specification.new do |s| 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{2009-05-29} + s.date = %q{2009-09-01} 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 @@ -40,8 +43,6 @@ Highrise::Base.user = 'your_api_auth_token' "lib/highrise/base.rb", "lib/highrise/comment.rb", "lib/highrise/company.rb", - "lib/highrise/curlhelper.rb", - "lib/highrise/curly.rb", "lib/highrise/email.rb", "lib/highrise/group.rb", "lib/highrise/kase.rb", @@ -57,17 +58,13 @@ Highrise::Base.user = 'your_api_auth_token' "spec/cachable_spec.rb", "spec/highrise/base_spec.rb", "spec/highrise/comment_spec.rb", - "spec/highrise/companies/16883216.html", "spec/highrise/company_spec.rb", - "spec/highrise/curlhelper_spec.rb", - "spec/highrise/curly_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/people/16887003.html", "spec/highrise/person_spec.rb", "spec/highrise/subject_spec.rb", "spec/highrise/tag_spec.rb", @@ -80,15 +77,13 @@ Highrise::Base.user = 'your_api_auth_token' s.homepage = %q{http://github.com/kmayer/highrise} s.rdoc_options = ["--charset=UTF-8"] s.require_paths = ["lib"] - s.rubygems_version = %q{1.3.3} + s.rubygems_version = %q{1.3.5} s.summary = %q{Ruby wrapper around Highrise API} s.test_files = [ "spec/cachable_spec.rb", "spec/highrise/base_spec.rb", "spec/highrise/comment_spec.rb", "spec/highrise/company_spec.rb", - "spec/highrise/curlhelper_spec.rb", - "spec/highrise/curly_spec.rb", "spec/highrise/email_spec.rb", "spec/highrise/group_spec.rb", "spec/highrise/kase_spec.rb", @@ -111,20 +106,14 @@ Highrise::Base.user = 'your_api_auth_token' s.specification_version = 3 if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then - s.add_runtime_dependency(%q<activeresource>, [">= 2.2"]) + s.add_runtime_dependency(%q<activeresource>, [">= 2.1"]) s.add_runtime_dependency(%q<activesupport>, [">= 2.1"]) - s.add_runtime_dependency(%q<curb>, [">= 0"]) - s.add_runtime_dependency(%q<hpricot>, [">= 0"]) else - s.add_dependency(%q<activeresource>, [">= 2.2"]) + s.add_dependency(%q<activeresource>, [">= 2.1"]) s.add_dependency(%q<activesupport>, [">= 2.1"]) - s.add_dependency(%q<curb>, [">= 0"]) - s.add_dependency(%q<hpricot>, [">= 0"]) end else - s.add_dependency(%q<activeresource>, [">= 2.2"]) + s.add_dependency(%q<activeresource>, [">= 2.1"]) s.add_dependency(%q<activesupport>, [">= 2.1"]) - s.add_dependency(%q<curb>, [">= 0"]) - s.add_dependency(%q<hpricot>, [">= 0"]) end end highrise.gemspec @@ -9,9 +9,7 @@ # # module CachedResource # class Base < ActiveResource::Base -# end -# class ActiveResource::Connection -# include Cachable +# include ::Cachable # end # end # @@ -23,14 +21,14 @@ # 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") +# CachedResource.cache_store = ActiveSupport::Cache.lookup_store :memory_store +# CachedResource.cache_store = ActiveSupport::Cache.lookup_store :file_store, "/path/to/cache/directory" +# CachedResource.cache_store = ActiveSupport::Cache.lookup_store :drb_store, "druby://localhost:9192" +# CachedResource.cache_store = ActiveSupport::Cache.lookup_store :mem_cache_store, "localhost" +# CachedResource.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 } +# CachedResource.store_options = { :expires_in => 60.seconds } # # Note: To ensure that caching is turned off, set CachedResource.connection.cache_store = nil # @@ -38,13 +36,16 @@ module Cachable def self.included(base) + base.extend ClassMethods base.class_eval do - include InstanceMethods - alias_method_chain :get, :cache + class << self + alias_method_chain :find_every, :cache + alias_method_chain :find_single, :cache + end end end - module InstanceMethods + module ClassMethods attr_writer :cache_store, :store_options def cache_store @@ -61,9 +62,19 @@ module Cachable private - def get_with_cache(path, headers = {}) - return get_without_cache(path, headers) unless is_caching? - fetch(path) { get_without_cache(path, headers) } + # A little hacky -- we need to intercept the finds, but not get too deep inside the connection + def find_every_with_cache(options) + return find_every_without_cache(options) unless is_caching? + prefix_options, query_options = split_options(options[:params]) + path = collection_path(prefix_options, query_options) + fetch(path) { find_every_without_cache(options)} + end + + def find_single_with_cache(scope, options) + return find_single_without_cache(scope, options) unless is_caching? + prefix_options, query_options = split_options(options[:params]) + path = element_path(scope, prefix_options, query_options) + fetch(path) { find_single_without_cache(scope, options)} end def cache_key(*args) lib/cachable.rb @@ -1,11 +1,7 @@ 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' lib/highrise.rb @@ -2,8 +2,6 @@ require File.dirname(__FILE__) + '/../cachable' module Highrise class Base < ActiveResource::Base - end - class ActiveResource::Connection - include Cachable + include ::Cachable end end lib/highrise/base.rb @@ -1,33 +1,17 @@ module Highrise - module Taggable - - # thanks for the user Inka, http://forum.37signals.com/highrise/forums/15/topics/1312?page=2 - + module Taggable + def tags + self.get(:tags) + end def tag!(tag_name) self.post(:tags, :name => tag_name) unless tag_name.blank? - end - + end def untag!(tag_name) - to_delete = self.tags.find{|t| t.name==tag_name} unless tag_name.blank? - self.untag_id!(to_delete.id) unless to_delete.nil? - end - + to_delete = self.tags.find{|t| t['name'] == tag_name} unless tag_name.blank? + self.untag_id!(to_delete['id']) unless to_delete.nil? + end def untag_id!(tag_id) self.delete("tags/#{tag_id}") 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 lib/highrise/taggable.rb @@ -3,44 +3,42 @@ 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 = ActiveSupport::Cache.lookup_store :memory_store - @connection.is_caching?.should == true + Highrise::Base.cache_store = ActiveSupport::Cache.lookup_store :memory_store + Highrise::Base.is_caching?.should == true end it "should tell us if caching is not active" do - @connection.cache_store = nil - @connection.is_caching?.should == false + Highrise::Base.cache_store = nil + Highrise::Base.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 = ActiveSupport::Cache.lookup_store :memory_store + Highrise::Base.cache_store = ActiveSupport::Cache.lookup_store :memory_store end after(:all) do - @connection.cache_store = :none + Highrise::Base.cache_store = :none end before(:each) do @thing = Highrise::Base.new @key = :key - @connection.stub!(:cache_key).and_return(@key) + Highrise::Base.stub!(:cache_key).and_return(@key) end context "when a cached response is available" do before(:each) do - @connection.cache_store.write(@key, @thing.attributes) + Highrise::Base.cache_store.write(@key, @thing) end it "should NOT make a request to the RESTful server" do - ActiveResource::Connection.should_not_receive(:get_without_cache) + Highrise::Base.should_not_receive(:find_single_without_cache) Highrise::Base.find(1) end @@ -51,18 +49,18 @@ describe Highrise::Base do context "when a cached response is NOT available" do before(:each) do - @connection.cache_store.delete(@key) + Highrise::Base.cache_store.delete(@key) end it "SHOULD perform an ARes request" do - @connection.should_receive(:get_without_cache).and_return(@thing.attributes) + Highrise::Base.should_receive(:find_single_without_cache).and_return(@thing) Highrise::Base.find(1) end it "should cache the response using the caching key" do - @connection.should_receive(:get_without_cache).and_return(@thing.attributes) + Highrise::Base.should_receive(:find_single_without_cache).and_return(@thing) Highrise::Base.find(1) - @connection.cache_store.read(@key).should == @thing.attributes + Highrise::Base.cache_store.read(@key).should == @thing end end end \ No newline at end of file spec/cachable_spec.rb @@ -4,11 +4,11 @@ describe Highrise::Company do before(:each) do Highrise::Base.site = 'http://example.com.i:3000' - @company = Highrise::Company.new + @company = Highrise::Company.new(:id => 1) returning @tags = [] do - @tags << Highrise::Tag.new(:id => "414578", :name => "cliente") - @tags << Highrise::Tag.new(:id => "414580", :name => "ged") - @tags << Highrise::Tag.new(:id => "414579", :name => "iepc") + @tags << {'id' => "414578", 'name' => "cliente"} + @tags << {'id' => "414580", 'name' => "ged"} + @tags << {'id' => "414579", 'name' => "iepc"} end end @@ -39,8 +39,7 @@ describe Highrise::Company do describe ".tags" do it "should return an array of all tags for that company." do - file_path = File.dirname(__FILE__) + "/companies/16883216.html" - @company.stub!(:get_document).and_return(Hpricot(File.open(file_path,"r"){|f| f.read})) + @company.should_receive(:get).with(:tags).and_return(@tags) @company.tags.should == @tags end @@ -49,7 +48,7 @@ describe Highrise::Company do describe "tag!(tag_name)" do it "should create a tag for this company." do - @company.should_receive(:post).with(:tags, :name => "client" ).at_least(1).times.and_return(true) + @company.should_receive(:post).with(:tags, :name => "client" ).and_return(true) @company.tag!("client").should be_true end @@ -58,9 +57,8 @@ describe Highrise::Company do describe "untag!(tag_name)" do it "should delete a tag for this company." do - file_path = File.dirname(__FILE__) + "/companies/16883216.html" - @company.stub!(:get_document).and_return(Hpricot(File.open(file_path,"r"){|f| f.read})) - @company.should_receive(:delete).with("tags/414578").at_least(1).times.and_return(true) + @company.should_receive(:get).with(:tags).and_return(@tags) + @company.should_receive(:delete).with("tags/414578").and_return(true) @company.untag!("cliente").should be_true end spec/highrise/company_spec.rb @@ -4,10 +4,10 @@ describe Highrise::Person do before(:each) do Highrise::Base.site = 'http://example.com.i:3000' - @person = Highrise::Person.new + @person = Highrise::Person.new(:id => 1) returning @tags = [] do - @tags << Highrise::Tag.new(:id => "414578", :name => "cliente") - @tags << Highrise::Tag.new(:id => "414587", :name => "walk") + @tags << {'id' => "414578", 'name' => "cliente"} + @tags << {'id' => "414587", 'name' => "walk"} end end @@ -53,8 +53,7 @@ describe Highrise::Person do describe ".tags" do it "should return an array of all tags for that user." do - file_path = File.dirname(__FILE__) + "/people/16887003.html" - @person.stub!(:get_document).and_return(Hpricot(File.open(file_path,"r"){|f| f.read})) + @person.should_receive(:get).with(:tags).and_return(@tags) @person.tags.should == @tags end @@ -63,7 +62,7 @@ describe Highrise::Person do describe "tag!(tag_name)" do it "should create a tag for this user." do - @person.should_receive(:post).with(:tags, :name => "Forum_User" ).at_least(1).times.and_return(true) + @person.should_receive(:post).with(:tags, :name => "Forum_User" ).and_return(true) @person.tag!("Forum_User").should be_true end @@ -72,9 +71,8 @@ describe Highrise::Person do describe "untag!(tag_name)" do it "should delete a tag for this user." do - file_path = File.dirname(__FILE__) + "/people/16887003.html" - @person.stub!(:get_document).and_return(Hpricot(File.open(file_path,"r"){|f| f.read})) - @person.should_receive(:delete).with("tags/414578").at_least(1).times.and_return(true) + @person.should_receive(:get).with(:tags).and_return(@tags) + @person.should_receive(:delete).with("tags/414578").and_return(true) @person.untag!("cliente").should be_true end spec/highrise/person_spec.rb @@ -4,4 +4,5 @@ progress --loadby mtime --reverse --rubygems \ No newline at end of file +-rubygems +--debugger \ No newline at end of file spec/spec.opts @@ -1,17 +1,17 @@ require File.dirname(__FILE__) + '/../lib/highrise' -def turn_methods_public(classe, method_name = nil) +def turn_methods_public(klass, method_name = nil) if method_name - classe.class_eval do + klass.class_eval do public method_name end else - turn_all_methods_public classe + turn_all_methods_public klass end end -def turn_all_methods_public(classe) - classe.class_eval do +def turn_all_methods_public(klass) + klass.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 } spec/spec_helper.rb lib/highrise/curlhelper.rb lib/highrise/curly.rb spec/highrise/companies/16883216.html spec/highrise/curlhelper_spec.rb spec/highrise/curly_spec.rb spec/highrise/people/16887003.html b65222c0f1b2e41038113b64e34cd7a099426229 Kenneth Mayer kmayer@bitwrangler.com http://github.com/tapajos/highrise/commit/6071801ffe2a6676a126ac338e93cd7b481cdd41 6071801ffe2a6676a126ac338e93cd7b481cdd41 2009-09-02T00:32:53-07:00 2009-09-02T00:32:19-07:00 Version bump to 1.0.0 Revised Taggable interface to support new tag API from 37Sigs and (removed curl dependencies) Refactored Cachable 95db4367feb65faf3e84e2f58edc9c1798a19889 Kenneth Mayer kmayer@bitwrangler.com