highrise 3.1.6 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c08fed70b2defee5d4cd4e6d2d6487b7d2bcefd3
-  data.tar.gz: 752cad37c686284545b11cfe15c2eeeb591048e7
+  metadata.gz: 71cd31f6f19cdaccbfee0fe9d620698930bdb284
+  data.tar.gz: 17e30e6d078c224e3c4b0d664e3a24fd2dfc1932
 SHA512:
-  metadata.gz: dbe2dd4fd7ab0a9984f4c757737a15446c71f175bd0435458567f59ea64fd5718c60bd54159a7fbe599f07f167f4f45d8df6d4be43f7008f35b224f5588d2420
-  data.tar.gz: ac73d6ec2703ad7629535d990ad29af33ee283c6a65eca4a8cdeee5014169ae4d5d5bb7c0e99b7dce2142e528cfa068b19e2ffc3a1ec0e05c514582ef608cea0
+  metadata.gz: 8bbd1dfa7c07273b73c00d078f98f405c209f3fa77b6eefa0dbd44afb57ab63bdf2d919b359356f0e13f8327dd6cc5224b51de2277f7fafec1e3f94ccaa14b09
+  data.tar.gz: 53891509f8ede23d45abe6e9f78de34c2784162c8fffd414a3d068ec5677234e722efbe0f5f5ee55d5344dd169c5b957c579baad21963f04b52b36b026e2c196

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    highrise (3.1.6)
+    highrise (3.2.1)
       activeresource (>= 3.2.13)
 
 GEM

data/highrise.gemspec

@@ -12,13 +12,13 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec"
   s.add_development_dependency "rake"
 
-  s.files         = [".gitignore", ".travis.yml", "Gemfile", "Gemfile.lock", "MIT-LICENSE", "README.md", "Rakefile", "autotest/discover.rb", "certs/gem-public_cert.pem", "examples/config_initializers_highrise.rb", "examples/extending.rb", "examples/sample.rb", "highrise.gemspec", "highrise.gemspec.erb", "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/party.rb", "lib/highrise/person.rb", "lib/highrise/recording.rb", "lib/highrise/searchable.rb", "lib/highrise/subject.rb", "lib/highrise/tag.rb", "lib/highrise/taggable.rb", "lib/highrise/task.rb", "lib/highrise/task_category.rb", "lib/highrise/user.rb", "lib/highrise/version.rb", "spec/highrise/account_spec.rb", "spec/highrise/base_spec.rb", "spec/highrise/comment_spec.rb", "spec/highrise/company_spec.rb", "spec/highrise/deal_category_spec.rb", "spec/highrise/deal_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_behavior.rb", "spec/highrise/pagination_spec.rb", "spec/highrise/party_spec.rb", "spec/highrise/person_spec.rb", "spec/highrise/recording_spec.rb", "spec/highrise/searchable_behavior.rb", "spec/highrise/searchable_spec.rb", "spec/highrise/subject_spec.rb", "spec/highrise/tag_spec.rb", "spec/highrise/taggable_behavior.rb", "spec/highrise/taggable_spec.rb", "spec/highrise/task_category_spec.rb", "spec/highrise/task_spec.rb", "spec/highrise/user_spec.rb", "spec/spec_helper.rb"]
-  s.test_files    = ["examples/config_initializers_highrise.rb", "examples/extending.rb", "examples/sample.rb", "spec/highrise/account_spec.rb", "spec/highrise/base_spec.rb", "spec/highrise/comment_spec.rb", "spec/highrise/company_spec.rb", "spec/highrise/deal_category_spec.rb", "spec/highrise/deal_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_behavior.rb", "spec/highrise/pagination_spec.rb", "spec/highrise/party_spec.rb", "spec/highrise/person_spec.rb", "spec/highrise/recording_spec.rb", "spec/highrise/searchable_behavior.rb", "spec/highrise/searchable_spec.rb", "spec/highrise/subject_spec.rb", "spec/highrise/tag_spec.rb", "spec/highrise/taggable_behavior.rb", "spec/highrise/taggable_spec.rb", "spec/highrise/task_category_spec.rb", "spec/highrise/task_spec.rb", "spec/highrise/user_spec.rb", "spec/spec_helper.rb"]
+  s.files         = [".gitignore", ".ruby-version", ".travis.yml", "Gemfile", "Gemfile.lock", "MIT-LICENSE", "README.md", "Rakefile", "autotest/discover.rb", "certs/gem-public_cert.pem", "examples/config_initializers_highrise.rb", "examples/extending.rb", "examples/sample.rb", "highrise.gemspec", "highrise.gemspec.erb", "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/party.rb", "lib/highrise/person.rb", "lib/highrise/recording.rb", "lib/highrise/searchable.rb", "lib/highrise/subject.rb", "lib/highrise/subject_data.rb", "lib/highrise/subject_field.rb", "lib/highrise/tag.rb", "lib/highrise/taggable.rb", "lib/highrise/task.rb", "lib/highrise/task_category.rb", "lib/highrise/user.rb", "lib/highrise/version.rb", "spec/highrise/account_spec.rb", "spec/highrise/base_spec.rb", "spec/highrise/comment_spec.rb", "spec/highrise/company_spec.rb", "spec/highrise/deal_category_spec.rb", "spec/highrise/deal_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_behavior.rb", "spec/highrise/pagination_spec.rb", "spec/highrise/party_spec.rb", "spec/highrise/person_spec.rb", "spec/highrise/recording_spec.rb", "spec/highrise/searchable_behavior.rb", "spec/highrise/searchable_spec.rb", "spec/highrise/subject_data_spec.rb", "spec/highrise/subject_field_spec.rb", "spec/highrise/subject_spec.rb", "spec/highrise/tag_spec.rb", "spec/highrise/taggable_behavior.rb", "spec/highrise/taggable_spec.rb", "spec/highrise/task_category_spec.rb", "spec/highrise/task_spec.rb", "spec/highrise/user_spec.rb", "spec/spec_helper.rb"]
+  s.test_files    = ["examples/config_initializers_highrise.rb", "examples/extending.rb", "examples/sample.rb", "spec/highrise/account_spec.rb", "spec/highrise/base_spec.rb", "spec/highrise/comment_spec.rb", "spec/highrise/company_spec.rb", "spec/highrise/deal_category_spec.rb", "spec/highrise/deal_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_behavior.rb", "spec/highrise/pagination_spec.rb", "spec/highrise/party_spec.rb", "spec/highrise/person_spec.rb", "spec/highrise/recording_spec.rb", "spec/highrise/searchable_behavior.rb", "spec/highrise/searchable_spec.rb", "spec/highrise/subject_data_spec.rb", "spec/highrise/subject_field_spec.rb", "spec/highrise/subject_spec.rb", "spec/highrise/tag_spec.rb", "spec/highrise/taggable_behavior.rb", "spec/highrise/taggable_spec.rb", "spec/highrise/task_category_spec.rb", "spec/highrise/task_spec.rb", "spec/highrise/user_spec.rb", "spec/spec_helper.rb"]
   s.require_paths = ["lib"]
 
   s.authors       = ["Marcos Tapaj\303\263s", "Ken Mayer"]
   s.email         = ["marcos@tapajos.me", "kmayer@bitwrangler.com"]
-  s.homepage      = "http://github.com/lucasmartins/highrise"
+  s.homepage      = "http://github.com/tapajos/highrise"
   s.summary       = "Ruby wrapper around Highrise API"
   s.description   = <<-EOT
     Based on the original API module from DHH, http://developer.37signals.com/highrise/, this

data/highrise.gemspec.erb

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
 
   s.required_rubygems_version = ">= 1.3.6"
-  s.add_dependency "activeresource", "~> 3.2.13"
+  s.add_dependency "activeresource", ">= 3.2.13"
   s.add_development_dependency "rspec"
   s.add_development_dependency "rake"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
 
   s.authors       = ["Marcos Tapaj\303\263s", "Ken Mayer"]
   s.email         = ["marcos@tapajos.me", "kmayer@bitwrangler.com"]
-  s.homepage      = "http://github.com/lucasmartins/highrise"
+  s.homepage      = "http://github.com/tapajos/highrise"
   s.summary       = "Ruby wrapper around Highrise API"
   s.description   = <<-EOT
     Based on the original API module from DHH, http://developer.37signals.com/highrise/, this

data/lib/highrise.rb

@@ -20,3 +20,5 @@ require 'highrise/deal_category'
 require 'highrise/task_category'
 require 'highrise/party'
 require 'highrise/recording'
+require 'highrise/subject_data'
+require 'highrise/subject_field'

data/lib/highrise/person.rb

@@ -4,10 +4,6 @@ module Highrise
     include Taggable
     include Searchable
 
-    def tags
-      self.attributes.has_key?("tags") ? self.attributes["tags"] : super
-    end
-
     def company
       Company.find(company_id) if company_id
     end
@@ -27,5 +23,68 @@ module Highrise
     def label
       'Party'
     end
+    
+    def field(field_label)
+      custom_fields = attributes["subject_datas"] ||= []
+      field = custom_fields.detect do |field|
+        field.subject_field_label == field_label
+      end
+      field ? field.value : nil
+    end
+    
+    def new_subject_data(field, value)
+      Highrise::SubjectData.new(:subject_field_id => field.id, :subject_field_label => field.label, :value => value)
+    end
+    
+    def set_field_value(field_label, new_value)
+      custom_fields = attributes["subject_datas"] ||= []
+      custom_fields.each do |field|
+        return field.value = new_value if field.subject_field_label== field_label
+      end
+  
+      SubjectField.find(:all).each do |custom_field| 
+        if custom_field.label == field_label
+          return attributes["subject_datas"] << new_subject_data(custom_field, new_value)
+        end
+      end
+    end
+
+    def transform_subject_field_label field_label
+      field_label.downcase.tr(' ', '_')
+    end
+    
+    def convert_method_to_field_label method
+      custom_fields = attributes["subject_datas"] ||= []
+      custom_fields.each do |field|
+        method_name_from_field = transform_subject_field_label(field.subject_field_label)
+        return field if method_name_from_field == method
+      end
+      nil
+    end
+    
+    def method_missing(method_symbol, *args)
+      method_name = method_symbol.to_s
+      
+      if method_name[-1,1] == "="
+        attribute_name = method_name[0...-1]
+        field = convert_method_to_field_label(attribute_name)
+        return set_field_value(field.subject_field_label, args[0]) if field
+        
+        return super if attributes[attribute_name]        
+        
+        subject_fields = SubjectField.find(:all)
+        unless subject_fields.nil?
+          subject_fields.each do |custom_field| 
+            if transform_subject_field_label(custom_field.label) == attribute_name
+              return attributes["subject_datas"] << new_subject_data(custom_field, args[0])
+            end
+          end
+        end
+      else
+        field = convert_method_to_field_label(method_name)
+        return field(field.subject_field_label) if field
+      end
+      super
+    end    
   end
 end

data/lib/highrise/subject_data.rb

@@ -0,0 +1,8 @@
+module Highrise
+  class SubjectData < Base
+    def==other
+      attributes["value"] == other.attributes["value"] &&
+      attributes["subject_field_label"] == other.attributes["subject_field_label"]
+    end
+  end
+end

data/lib/highrise/subject_field.rb

@@ -0,0 +1,26 @@
+module Highrise
+  class SubjectField < Base
+
+    def initialize(attributes = {}, persisted = false)
+      super
+      @use_cache = false
+    end
+
+    def self.use_cache(use_cache = true)
+      @use_cache = use_cache
+    end
+
+    def self.find_every(options)
+      if @use_cache
+        @subject_field_cache ||= super
+      else
+        super
+      end
+    end
+
+    def self.invalidate_cache
+      @subject_field_cache = nil
+    end
+  end
+end
+

data/lib/highrise/taggable.rb

@@ -1,7 +1,7 @@
 module Highrise
   module Taggable        
     def tags
-      self.get(:tags)
+      self.attributes.has_key?("tags") ? self.attributes["tags"] : self.get(:tags)
     end
 
     def tag!(tag_name)

data/lib/highrise/version.rb

@@ -1,3 +1,3 @@
 module Highrise
-  VERSION = "3.1.6"
+  VERSION = "3.2.1"
 end

data/spec/highrise/person_spec.rb

@@ -42,6 +42,73 @@ describe Highrise::Person do
       subject.tags.should == @tags
     }
   end
+  
+  describe "Custom fields" do
+    
+    before (:each) do
+      @fruit_person = Highrise::Person.new({ :person => { 
+                        :id => 1, 
+                        :first_name => "John", 
+                        :last_name => "Doe",
+                        :subject_datas => [{
+                          :subject_field_label => "Fruit Banana",
+                          :value => "Yellow"
+                        }, {
+                          :subject_field_label => "Fruit Grape",
+                          :value => "Green"
+                        }]
+                      }
+                    })
+      @subject_field_blueberry = Highrise::SubjectField.new ({:id => 1, :label => "Fruit Blueberry"})
+      @subject_field_papaya = Highrise::SubjectField.new ({:id => 2, :label => "Fruit Papaya"})
+    end    
+    
+    it "Can get the value of a custom field via the field method" do
+      @fruit_person.field("Fruit Banana").should== "Yellow"
+    end
+    
+    it "Can get the value of a custom field using a custom method call" do
+      @fruit_person.fruit_grape.should== "Green"
+    end
+    
+    it "Will raise an exception on an unknown field" do
+      expect {@fruit_person.unknown_fruit}.to raise_exception(NoMethodError)
+    end
+    
+    it "Can set the value of a custom field via the field method" do
+      @fruit_person.set_field_value("Fruit Grape", "Red")
+      @fruit_person.field("Fruit Grape").should== "Red"
+    end
+    
+    it "Can set the value of a custom field" do
+      @fruit_person.fruit_grape= "Red"
+      @fruit_person.fruit_grape.should== "Red"
+    end
+    
+    it "Assignment just returns the arguments (like ActiveResource base does)" do
+      Highrise::SubjectField.should_receive(:find).with(:all).and_return []
+      (@fruit_person.unknown_fruit = 10).should== 10
+    end
+    
+    it "Can deal with the find returning nil (which is a bit ugly in the ActiveResource API)" do
+      Highrise::SubjectField.should_receive(:find).with(:all).and_return nil
+      (@fruit_person.unknown_fruit = 10).should== 10      
+    end
+    
+    it "Can set the value of a custom field that wasn't there via the field method, but that was defined (happens on new Person)" do
+      Highrise::SubjectField.should_receive(:find).with(:all).and_return([@subject_field_papaya, @subject_field_blueberry])
+      @fruit_person.set_field_value("Fruit Blueberry", "Purple")
+      @fruit_person.field("Fruit Blueberry").should== "Purple"
+      @fruit_person.attributes["subject_datas"][2].subject_field_id.should == 1
+    end
+    
+    it "Can still set and read the usual way of reading attrivutes" do
+      @fruit_person.first_name = "Jacob"
+      @fruit_person.first_name.should== "Jacob"
+    
+    end
+    
+  end
 
   it { subject.label.should == 'Party' }
 end

data/spec/highrise/subject_data_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Highrise::SubjectData do
+  it { should be_a_kind_of Highrise::Base }  
+  
+  it "Two different subject datas with different values are not equal" do
+    martini = Highrise::SubjectData.new({:id => 1, :value => "Martini", :subject_field_id => 3, :subject_field_label => "Cocktail"})
+    sling = Highrise::SubjectData.new({:id => 2, :value => "Singapore Sling", :subject_field_id => 4, :subject_field_label => "Cocktail"})
+    martini.should_not==sling
+  end
+
+  it "Two different subject datas with different labels are not equal" do
+    martini = Highrise::SubjectData.new({:id => 1, :value => "Martini", :subject_field_id => 3, :subject_field_label => "Cocktail"})
+    sling = Highrise::SubjectData.new({:id => 2, :value => "Martini", :subject_field_id => 4, :subject_field_label => "Vermouth Brands"})
+    martini.should_not==sling
+  end
+  
+  it "Two the same subject datas are equal" do
+    martini = Highrise::SubjectData.new({:id => 1, :value => "Martini", :subject_field_id => 3, :subject_field_label => "Cocktail"})
+    another_martini = Highrise::SubjectData.new({:id => 2, :value => "Martini", :subject_field_id => 4, :subject_field_label => "Cocktail"})
+    martini.should==another_martini
+  end
+  
+end

data/spec/highrise/subject_field_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Highrise::SubjectField do
+  it { should be_a_kind_of Highrise::Base }
+  let(:two_subject_fields){ [
+    Highrise::SubjectField.new({:id => 1, :label => "Cabbage"}),
+    Highrise::SubjectField.new({:id => 2, :label => "Chicken"})]
+  }
+  let(:four_subject_fields){ [
+    two_subject_fields,
+    Highrise::SubjectField.new({:id => 3, :label => "Pasta"}),
+    Highrise::SubjectField.new({:id => 4, :label => "Beans"})].flatten
+  }
+  let(:subject_field_request){ ActiveResource::Request.new(:get, '/subject_fields.xml', nil, {"Authorization"=>"Bearer OAUTH_TOKEN", "Accept"=>"application/xml"}) }
+  let(:two_subject_fields_request_pair){ {subject_field_request => ActiveResource::Response.new(two_subject_fields.to_xml, 200, {})} }
+  let(:four_subject_fields_request_pair){ { subject_field_request => ActiveResource::Response.new(four_subject_fields.to_xml, 200, {})} }
+
+  context 'cache disabled (default)' do
+    it "does not use cache for queries" do
+      ActiveResource::HttpMock.respond_to(two_subject_fields_request_pair)
+      Highrise::SubjectField.find(:all)
+      ActiveResource::HttpMock.respond_to(four_subject_fields_request_pair)
+      Highrise::SubjectField.find(:all).size.should== 4
+    end
+  end
+
+  context 'cache enabled (opt-in)' do
+    before(:each) do
+      Highrise::SubjectField.use_cache(true)
+    end
+    it "caches 'find all' to prevent too much queries for the SubjectFields" do
+      ActiveResource::HttpMock.respond_to(two_subject_fields_request_pair)
+      Highrise::SubjectField.find(:all)
+      ActiveResource::HttpMock.reset!
+      Highrise::SubjectField.find(:all).size.should== 2
+    end
+    it "invalidates cache" do
+      ActiveResource::HttpMock.respond_to(two_subject_fields_request_pair)
+      Highrise::SubjectField.find(:all)
+      Highrise::SubjectField.invalidate_cache
+      ActiveResource::HttpMock.respond_to(four_subject_fields_request_pair)
+      Highrise::SubjectField.find(:all).size.should== 4
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -10,3 +10,5 @@ Highrise::Base.site        = ENV['HIGHRISE_SITE']    || 'https://www.example.com
 require 'highrise/pagination_behavior'
 require 'highrise/searchable_behavior'
 require 'highrise/taggable_behavior'
+require 'active_resource/http_mock'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: highrise
 version: !ruby/object:Gem::Version
-  version: 3.1.6
+  version: 3.2.1
 platform: ruby
 authors:
 - Marcos Tapajós
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -65,6 +65,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
 - .travis.yml
 - Gemfile
 - Gemfile.lock
@@ -96,6 +97,8 @@ files:
 - lib/highrise/recording.rb
 - lib/highrise/searchable.rb
 - lib/highrise/subject.rb
+- lib/highrise/subject_data.rb
+- lib/highrise/subject_field.rb
 - lib/highrise/tag.rb
 - lib/highrise/taggable.rb
 - lib/highrise/task.rb
@@ -120,6 +123,8 @@ files:
 - spec/highrise/recording_spec.rb
 - spec/highrise/searchable_behavior.rb
 - spec/highrise/searchable_spec.rb
+- spec/highrise/subject_data_spec.rb
+- spec/highrise/subject_field_spec.rb
 - spec/highrise/subject_spec.rb
 - spec/highrise/tag_spec.rb
 - spec/highrise/taggable_behavior.rb
@@ -128,7 +133,7 @@ files:
 - spec/highrise/task_spec.rb
 - spec/highrise/user_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/lucasmartins/highrise
+homepage: http://github.com/tapajos/highrise
 licenses: []
 metadata: {}
 post_install_message: 
@@ -173,6 +178,8 @@ test_files:
 - spec/highrise/recording_spec.rb
 - spec/highrise/searchable_behavior.rb
 - spec/highrise/searchable_spec.rb
+- spec/highrise/subject_data_spec.rb
+- spec/highrise/subject_field_spec.rb
 - spec/highrise/subject_spec.rb
 - spec/highrise/tag_spec.rb
 - spec/highrise/taggable_behavior.rb