hubspot-api-ruby 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8c321bf08699c556e265ef8bb24a6f66ad0993ed284a66adb4dacbcc5263748
-  data.tar.gz: 9a9fd7fccb6ac668affde2373ed824a3f5ac95fc7ed1ca6afc90e7e523dcd83e
+  metadata.gz: 5039b18c952923db03dbe7f0ae2f1ae676008179860804e34182298e6acbbcfb
+  data.tar.gz: 13a047c2ff4858e64cd00c173513bf0643d79ba9dc9b815d6017c148af6bf2fb
 SHA512:
-  metadata.gz: 872f7fc25b8acfd21ca29fa0223f36506993581ced761f90838adcb5425bad857bec190f5b804f9c466f1919988d76e80b5834004228e722ca920216b2b92406
-  data.tar.gz: f9608077e1a5346205baf9216259fbfdee3e6d49f1abac18ac05e5226b3c05db86b61c0ed6d0e266510c2b9cd898e899da66e12335bdf8a4b2796677bac788ff
+  metadata.gz: 17ac11777f8b4c3bb6e95f29a43ffb3ae6b1cba2ab1a27f37c423390fd6603bad8a9b140ebcaaca3df2a74995407dbcafadeceeb853a950fdb0fb8d5a0f289a3
+  data.tar.gz: ae7cfcbbdf2a34c7cec6505f34144436f055f7902cb1d8497845d33fff0fc25f90376c6bd221c2c4fb9c59b8cf4dc44efdb75479a6a2322bcd6970bb3b76ff43

data/README.md

@@ -109,149 +109,9 @@ At this time, OAuth tokens are configured globally rather than on a per-connecti
 
 Classes have been created that map to Hubspot resource types and attempt to abstract away as much of the API specific details as possible. These classes generally follow the [ActiveRecord](https://en.wikipedia.org/wiki/Active_record_pattern) pattern and general Ruby conventions. Anyone familiar with [Ruby On Rails](https://rubyonrails.org/) should find this API closely maps with familiar concepts.
 
+### Example
 
-### Creating a new resource
-
-```ruby
-irb(main):001:0> company = Hubspot::Company.new(name: "My Company LLC.")
-=> #<Hubspot::Company:0x000055b9219cc068 @changes={"name"=>"My Company LLC."}, @properties={}, @id=nil, @persisted=false, @deleted=false>
-
-irb(main):002:0> company.persisted?
-=> false
-
-irb(main):003:0> company.save
-=> true
-
-irb(main):004:0> company.persisted?
-=> true
-```
-
-```ruby
-irb(main):001:0> company = Hubspot::Company.create(name: "Second Financial LLC.")
-=> #<Hubspot::Company:0x0000557ea7119fb0 @changes={}, @properties={"hs_lastmodifieddate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceId"=>nil, "versions"=>[{"name"=>"hs_lastmodifieddate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "name"=>{"value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"name", "value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "createdate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"createdate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}, {"name"=>"createdate", "value"=>"1552234087467", "timestamp"=>1552234087467, "sourceId"=>"API", "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}}, @id=1726317857, @persisted=true, @deleted=false, @metadata={"portalId"=>62515, "companyId"=>1726317857, "isDeleted"=>false, "additionalDomains"=>[], "stateChanges"=>[], "mergeAudits"=>[]}>
-
-irb(main):002:0> company.persisted?
-=> true
-```
-
-
-### Find an existing resource
-
-**Note:** Hubspot uses a combination of different names for the "ID" property of a resource based on what type of resource it is (eg. vid for Contact). This library attempts to abstract that away and generalizes an `id` property for all resources
-
-```ruby
-irb(main):001:0> company = Hubspot::Company.find(1726317857)
-=> #<Hubspot::Company:0x0000562e4988c9a8 @changes={}, @properties={"hs_lastmodifieddate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceId"=>nil, "versions"=>[{"name"=>"hs_lastmodifieddate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "name"=>{"value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"name", "value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "createdate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"createdate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}}, @id=1726317857, @persisted=true, @deleted=false, @metadata={"portalId"=>62515, "companyId"=>1726317857, "isDeleted"=>false, "additionalDomains"=>[], "stateChanges"=>[], "mergeAudits"=>[]}>
-
-irb(main):002:0> company = Hubspot::Company.find(1)
-Traceback (most recent call last):
-        6: from ./hubspot-api-ruby/bin/console:20:in `<main>'
-        5: from (irb):2
-        4: from ./hubspot-api-ruby/lib/hubspot/resource.rb:17:in `find'
-        3: from ./hubspot-api-ruby/lib/hubspot/resource.rb:81:in `reload'
-        2: from ./hubspot-api-ruby/lib/hubspot/connection.rb:10:in `get_json'
-        1: from ./hubspot-api-ruby/lib/hubspot/connection.rb:52:in `handle_response'
-Hubspot::RequestError (Response body: {"status":"error","message":"resource not found","correlationId":"7c8ba50e-16a4-4a52-a304-ff249175a8f1","requestId":"b4898274bf8992924082b4a460b90cbe"})
-```
-
-
-### Updating resource properties
-
-```ruby
-irb(main):001:0> company = Hubspot::Company.find(1726317857)
-=> #<Hubspot::Company:0x0000563b9f3ee230 @changes={}, @properties={"hs_lastmodifieddate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceId"=>nil, "versions"=>[{"name"=>"hs_lastmodifieddate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "name"=>{"value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"name", "value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "createdate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"createdate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}}, @id=1726317857, @persisted=true, @deleted=false, @metadata={"portalId"=>62515, "companyId"=>1726317857, "isDeleted"=>false, "additionalDomains"=>[], "stateChanges"=>[], "mergeAudits"=>[]}>
-
-irb(main):002:0> company.name
-=> "Second Financial LLC."
-
-irb(main):003:0> company.name = "Third Financial LLC."
-=> "Third Financial LLC."
-
-irb(main):004:0> company.changed?
-=> true
-
-irb(main):005:0> company.changes
-=> {:name=>"Third Financial LLC."}
-
-irb(main):006:0> company.save
-=> true
-
-irb(main):007:0> company.changed?
-=> false
-
-irb(main):008:0> company.changes
-=> {}
-```
-
-**Note:** Unlike ActiveRecord in Rails, in some cases not all properties of a resource are known. If these properties are not returned by the API then they will not have a getter method defined for them until they've been set first. This may change in the future to improve the user experience and different methods are being tested.
-
-```ruby
-irb(main):001:0> company = Hubspot::Company.new
-=> #<Hubspot::Company:0x0000561d0a8bdff8 @changes={}, @properties={}, @id=nil, @persisted=false, @deleted=false>
-
-irb(main):002:0> company.name
-Traceback (most recent call last):
-        3: from ./hubspot-api-ruby/bin/console:20:in `<main>'
-        2: from (irb):2
-        1: from ./hubspot-api-ruby/lib/hubspot/resource.rb:215:in `method_missing'
-NoMethodError (undefined method `name' for #<Hubspot::Company:0x0000561d0a8bdff8>)
-
-irb(main):003:0> company.name = "Foobar"
-=> "Foobar"
-
-irb(main):004:0> company.name
-=> "Foobar"
-```
-
-### Collections
-
-To make working with API endpoints that return multiple resources easier, the returned instances will be wrapped in a collection instance. Just like in Rails, the collection instance provides helper methods for limiting the number of returned resources, paging through the results, and handles passing the options each time a new API call is made. The collection exposes all Ruby Array methods so you can use things like `size()`, `first()`, `last()`, and `map()`.
-
-```ruby
-irb(main):001:0> contacts = Hubspot::Contact.all
-=> #<Hubspot::PagedCollection:0x000055ba3c2b55d8 @limit_param="limit", @limit=25, @offset_param="offset", @offset=nil, @options={}, @fetch_proc=#<Proc:0x000055ba3c2b5538@./hubspot-api-ruby/lib/hubspot/contact.rb:18>, @resources=[...snip...], @next_offset=9242374, @has_more=true>
-
-irb(main):002:0> contacts.more?
-=> true
-
-irb(main):003:0> contacts.next_offset
-=> 9242374
-
-irb(main):004:0> contacts.size
-=> 25
-
-irb(main):005:0> contacts.first
-=> #<Hubspot::Contact:0x000055ba3c29bac0 @changes={}, @properties={"firstname"=>{"value"=>"My Street X 1551971239 => My Street X 1551971267 => My Street X 1551971279"}, "lastmodifieddate"=>{"value"=>"1551971286841"}, "company"=>{"value"=>"MadKudu"}, "lastname"=>{"value"=>"Test0830181615"}}, @id=9153674, @persisted=true, @deleted=false, @metadata={"addedAt"=>1535664601481, "vid"=>9153674, "canonical-vid"=>9153674, "merged-vids"=>[], "portal-id"=>62515, "is-contact"=>true, "profile-token"=>"AO_T-mPNHk6O7jh8u8D2IlrhZn7GO91w-weZrC93_UaJvdB0U4o6Uc_PkPJ3DOpf15sUplrxMzG9weiTTpPI05Nr04zxnaNYBVcWHOlMbVlJ2Avq1KGoCBVbIoQucOy_YmCBIfOXRtcc", "profile-url"=>"https://app.hubspot.com/contacts/62515/contact/9153674", "form-submissions"=>[], "identity-profiles"=>[{"vid"=>9153674, "saved-at-timestamp"=>1535664601272, "deleted-changed-timestamp"=>0, "identities"=>[{"type"=>"EMAIL", "value"=>"test.0830181615@test.com", "timestamp"=>1535664601151, "is-primary"=>true}, {"type"=>"LEAD_GUID", "value"=>"01a107c4-3872-44e0-ab2e-47061507ffa1", "timestamp"=>1535664601259}]}], "merge-audits"=>[]}>
-
-irb(main):006:0> contacts.next_page
-=> #<Hubspot::PagedCollection:0x000055ba3c2b55d8 @limit_param="limit", @limit=25, @offset_param="offset", @offset=9242374, @options={}, @fetch_proc=#<Proc:0x000055ba3c2b5538@./hubspot-api-ruby/lib/hubspot/contact.rb:18>, @resources=[...snip...], @next_offset=9324874, @has_more=true>
-```
-
-For Hubspot resources that support batch updates for updating multiple resources, the collection provides an `update_all()` method:
-
-```ruby
-irb(main):001:0> companies = Hubspot::Company.all(limit: 5)
-=> #<Hubspot::PagedCollection:0x000055d5314fe0c8 @limit_param="limit", @limit=5, @offset_param="offset", @offset=nil, @options={}, @fetch_proc=#<Proc:0x000055d5314fe028@./hubspot-api-ruby/lib/hubspot/company.rb:21>, @resources=[...snip...], @next_offset=116011506, @has_more=true>
-
-irb(main):002:0> companies.size
-=> 5
-
-irb(main):003:0> companies.update_all(lifecyclestage: "opportunity")
-=> true
-
-irb(main):004:0> companies.refresh
-=> #<Hubspot::PagedCollection:0x000055d5314fe0c8 @limit_param="limit", @limit=5, @offset_param="offset", @offset=nil, @options={}, @fetch_proc=#<Proc:0x000055d5314fe028@./hubspot-api-ruby/lib/hubspot/company.rb:21>, @resources=[...snip...], @next_offset=116011506, @has_more=true>
-```
-
-### Deleting a resource
-
-```ruby
-irb(main):001:0> contact = Hubspot::Contact.find(9324874)
-=> #<Hubspot::Contact:0x000055a87c87aee0 ...snip... >
-
-irb(main):002:0> contact.delete
-=> true
-```
+https://github.com/lounna-sas/hubspot-api-ruby/wiki
 
 ## Resource types
 

data/hubspot-api-ruby.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name = "hubspot-api-ruby"
-  s.version = "0.8.0"
+  s.version = "0.8.1"
   s.require_paths = ["lib"]
-  s.authors = ["Jonathan", "Juliette"]
-  s.email = ["jonathan@hoggo.com", "juliette@hoggo.com"]
+  s.authors = ["Jonathan"]
+  s.email = ["jonathan@hoggo.com"]
   s.description = "hubspot-api-ruby is a wrapper for the HubSpot REST API"
   s.licenses = ["MIT"]
   s.files = [".rspec", "Gemfile", "Guardfile", "LICENSE.txt", "README.md", "RELEASING.md", "Rakefile", "hubspot-api-ruby.gemspec"]

data/lib/hubspot-api-ruby.rb

@@ -20,6 +20,7 @@ require 'hubspot/topic'
 require 'hubspot/deal'
 require 'hubspot/deal_pipeline'
 require 'hubspot/deal_properties'
+require 'hubspot/association'
 require 'hubspot/deprecator'
 require 'hubspot/owner'
 require 'hubspot/engagement'

data/lib/hubspot/association.rb

@@ -0,0 +1,80 @@
+class Hubspot::Association
+  COMPANY_TO_CONTACT = 2
+  DEAL_TO_CONTACT = 3
+  CONTACT_TO_DEAL = 4
+  DEAL_TO_COMPANY = 5
+  COMPANY_TO_DEAL = 6
+  DEFINITION_TARGET_TO_CLASS = {
+    2 => Hubspot::Contact,
+    3 => Hubspot::Contact,
+    4 => Hubspot::Deal,
+    5 => Hubspot::Company,
+    6 => Hubspot::Deal
+  }.freeze
+
+  BATCH_CREATE_PATH = '/crm-associations/v1/associations/create-batch'
+  BATCH_DELETE_PATH = '/crm-associations/v1/associations/delete-batch'
+  ASSOCIATIONS_PATH = '/crm-associations/v1/associations/:resource_id/HUBSPOT_DEFINED/:definition_id'
+
+  class << self
+    def create(from_id, to_id, definition_id)
+      batch_create([{ from_id: from_id, to_id: to_id, definition_id: definition_id }])
+    end
+
+    # Make multiple associations in a single API call
+    # {https://developers.hubspot.com/docs/methods/crm-associations/batch-associate-objects}
+    # usage:
+    # Hubspot::Association.batch_create([{ from_id: 1, to_id: 2, definition_id: Hubspot::Association::COMPANY_TO_CONTACT }])
+    def batch_create(associations)
+      request = associations.map { |assocation| build_association_body(assocation) }
+      Hubspot::Connection.put_json(BATCH_CREATE_PATH, params: { no_parse: true }, body: request).success?
+    end
+
+    def delete(from_id, to_id, definition_id)
+      batch_delete([{from_id: from_id, to_id: to_id, definition_id: definition_id}])
+    end
+
+    # Remove multiple associations in a single API call
+    # {https://developers.hubspot.com/docs/methods/crm-associations/batch-delete-associations}
+    # usage:
+    # Hubspot::Association.batch_delete([{ from_id: 1, to_id: 2, definition_id: Hubspot::Association::COMPANY_TO_CONTACT }])
+    def batch_delete(associations)
+      request = associations.map { |assocation| build_association_body(assocation) }
+      Hubspot::Connection.put_json(BATCH_DELETE_PATH, params: { no_parse: true }, body: request).success?
+    end
+
+    # Retrieve all associated resources given a source (resource_id) and a kind (definition_id)
+    # Example: if resource_id is a deal, using DEAL_TO_CONTACT will find every contact associated with the deal
+    # {https://developers.hubspot.com/docs/methods/crm-associations/get-associations}
+    # Warning: it will make N+M queries, where
+    #   N is the number of PagedCollection requests necessary to get all ids,
+    #   and M is the number of results, each resulting in a find
+    # usage:
+    # Hubspot::Association.all(42, Hubspot::Association::DEAL_TO_CONTACT)
+    def all(resource_id, definition_id)
+      opts = { resource_id: resource_id, definition_id: definition_id }
+      klass = DEFINITION_TARGET_TO_CLASS[definition_id]
+      raise(Hubspot::InvalidParams, 'Definition not supported') unless klass.present?
+
+      collection = Hubspot::PagedCollection.new(opts) do |options, offset, limit|
+        params = options.merge(offset: offset, limit: limit)
+        response = Hubspot::Connection.get_json(ASSOCIATIONS_PATH, params)
+
+        resources = response['results'].map { |result| klass.find(result) }
+        [resources, response['offset'], response['has-more']]
+      end
+      collection.resources
+    end
+
+    private
+
+    def build_association_body(assocation)
+      {
+        fromObjectId: assocation[:from_id],
+        toObjectId: assocation[:to_id],
+        category: 'HUBSPOT_DEFINED',
+        definitionId: assocation[:definition_id]
+      }
+    end
+  end
+end

data/lib/hubspot/company.rb

@@ -2,7 +2,6 @@ class Hubspot::Company < Hubspot::Resource
   self.id_field = "companyId"
   self.property_name_field = "name"
 
-  ADD_CONTACT_PATH        = '/companies/v2/companies/:id/contacts/:contact_id'
   ALL_PATH                = '/companies/v2/companies/paged'
   BATCH_UPDATE_PATH       = '/companies/v1/batch-async/update'
   CONTACTS_PATH           = '/companies/v2/companies/:id/contacts'
@@ -12,7 +11,6 @@ class Hubspot::Company < Hubspot::Resource
   FIND_PATH               = '/companies/v2/companies/:id'
   RECENTLY_CREATED_PATH   = '/companies/v2/companies/recent/created'
   RECENTLY_MODIFIED_PATH  = '/companies/v2/companies/recent/modified'
-  REMOVE_CONTACT_PATH     = '/companies/v2/companies/:id/contacts/:contact_id'
   SEARCH_DOMAIN_PATH      = '/companies/v2/domains/:domain/companies'
   UPDATE_PATH             = '/companies/v2/companies/:id'
 
@@ -80,20 +78,11 @@ class Hubspot::Company < Hubspot::Resource
     end
 
     def add_contact(id, contact_id)
-      Hubspot::Connection.put_json(
-        ADD_CONTACT_PATH,
-        params: { id: id, contact_id: contact_id }
-      )
-      true
+      Hubspot::Association.create(id, contact_id, Hubspot::Association::COMPANY_TO_CONTACT)
     end
 
     def remove_contact(id, contact_id)
-      Hubspot::Connection.delete_json(
-        REMOVE_CONTACT_PATH,
-        { id: id, contact_id: contact_id }
-      )
-
-      true
+      Hubspot::Association.delete(id, contact_id, Hubspot::Association::COMPANY_TO_CONTACT)
     end
 
     def batch_update(companies, opts = {})

data/lib/hubspot/deal.rb

@@ -12,8 +12,6 @@ module Hubspot
     DEAL_PATH = "/deals/v1/deal/:deal_id"
     RECENT_UPDATED_PATH = "/deals/v1/deal/recent/modified"
     UPDATE_DEAL_PATH = '/deals/v1/deal/:deal_id'
-    ASSOCIATE_DEAL_PATH = '/deals/v1/deal/:deal_id/associations/:OBJECTTYPE?id=:objectId'
-    ASSOCIATED_DEAL_PATH = "/deals/v1/deal/associated/:objectType/:objectId"
 
     attr_reader :properties
     attr_reader :portal_id
@@ -61,25 +59,33 @@ module Hubspot
         response.success?
       end
 
-       # Associate a deal with a contact or company
-       # {http://developers.hubspot.com/docs/methods/deals/associate_deal}
-       # Usage
-       # Hubspot::Deal.associate!(45146940, [], [52])
-       def associate!(deal_id, company_ids=[], vids=[])
-         objecttype = company_ids.any? ? 'COMPANY' : 'CONTACT'
-         object_ids = (company_ids.any? ? company_ids : vids).join('&id=')
-         Hubspot::Connection.put_json(ASSOCIATE_DEAL_PATH, params: { deal_id: deal_id, OBJECTTYPE: objecttype, objectId: object_ids}, body: {})
-       end
-
-       # Didssociate a deal with a contact or company
-       # {https://developers.hubspot.com/docs/methods/deals/delete_association}
-       # Usage
-       # Hubspot::Deal.dissociate!(45146940, [], [52])
-       def dissociate!(deal_id, company_ids=[], vids=[])
-         objecttype = company_ids.any? ? 'COMPANY' : 'CONTACT'
-         object_ids = (company_ids.any? ? company_ids : vids).join('&id=')
-         Hubspot::Connection.delete_json(ASSOCIATE_DEAL_PATH, { deal_id: deal_id, OBJECTTYPE: objecttype, objectId: object_ids })
-       end
+      # Associate a deal with a contact or company
+      # {http://developers.hubspot.com/docs/methods/deals/associate_deal}
+      # Usage
+      # Hubspot::Deal.associate!(45146940, [32], [52])
+      def associate!(deal_id, company_ids=[], vids=[])
+        associations = company_ids.map do |id|
+          { from_id: deal_id, to_id: id, definition_id: Hubspot::Association::DEAL_TO_COMPANY }
+        end
+        associations += vids.map do |id|
+          { from_id: deal_id, to_id: id, definition_id: Hubspot::Association::DEAL_TO_CONTACT }
+        end
+        Hubspot::Association.batch_create(associations)
+      end
+
+      # Didssociate a deal with a contact or company
+      # {https://developers.hubspot.com/docs/methods/deals/delete_association}
+      # Usage
+      # Hubspot::Deal.dissociate!(45146940, [32], [52])
+      def dissociate!(deal_id, company_ids=[], vids=[])
+        associations = company_ids.map do |id|
+          { from_id: deal_id, to_id: id, definition_id: Hubspot::Association::DEAL_TO_COMPANY }
+        end
+        associations += vids.map do |id|
+          { from_id: deal_id, to_id: id, definition_id: Hubspot::Association::DEAL_TO_CONTACT }
+        end
+        Hubspot::Association.batch_delete(associations)
+      end
 
       def find(deal_id)
         response = Hubspot::Connection.get_json(DEAL_PATH, { deal_id: deal_id })
@@ -125,20 +131,15 @@ module Hubspot
       end
 
       # Find all deals associated to a contact or company
-      # {http://developers.hubspot.com/docs/methods/deals/get-associated-deals}
       # @param object [Hubspot::Contact || Hubspot::Company] a contact or company
       # @return [Array] Array of Hubspot::Deal records
       def find_by_association(object)
-        path = ASSOCIATED_DEAL_PATH
-        objectType =  case object
-                      when Hubspot::Company then :company
-                      when Hubspot::Contact then :contact
-                      else raise(Hubspot::InvalidParams, "Instance type not supported")
-                      end
-
-        params = { objectType: objectType, objectId: object.id }
-        response = Hubspot::Connection.get_json(path, params)
-        response["results"].map { |deal_id| find(deal_id) }
+        definition = case object
+                     when Hubspot::Company then Hubspot::Association::COMPANY_TO_DEAL
+                     when Hubspot::Contact then Hubspot::Association::CONTACT_TO_DEAL
+                     else raise(Hubspot::InvalidParams, 'Instance type not supported')
+                     end
+        Hubspot::Association.all(object.id, definition)
       end
     end
 

data/lib/hubspot/resource.rb

@@ -98,7 +98,7 @@ module Hubspot
     end
 
     def [](name)
-      @changes[name] || @properties[name]
+      @changes[name] || @properties.dig(name, 'value')
     end
 
     def reload
@@ -238,7 +238,7 @@ module Hubspot
       singleton_class.instance_eval do
         keys.each do |k|
           # Define a getter
-          define_method(k) { @changes[k.to_sym] || @properties.dig(k, "value") }
+          define_method(k) { @changes[k.to_sym] || @properties.dig(k, 'value') }
 
           # Define a setter
           define_method("#{k}=") do |v|
@@ -257,7 +257,7 @@ module Hubspot
         # Call the new setter
         return send(method_name, arguments[0])
       elsif @properties.key?(method_name)
-        return @properties[method_name]
+        return @properties[method_name]['value']
       else
         super
       end
@@ -267,4 +267,4 @@ module Hubspot
       (@properties && @properties.key?(method_name)) || super
     end
   end
-end
+end

data/spec/lib/hubspot/association_spec.rb

@@ -0,0 +1,160 @@
+RSpec.describe Hubspot::Association do
+  before { Hubspot.configure(hapikey: 'demo') }
+
+  let(:portal_id) { 62515 }
+  let(:company) { create :company }
+  let(:contact) { create :contact }
+
+  describe '.create' do
+    context 'with a valid ID' do
+      cassette
+      subject { described_class.create(company.id, contact.id, described_class::COMPANY_TO_CONTACT) }
+
+      it 'associates the resources' do
+        expect(subject).to be true
+        expect(company.contact_ids.resources).to eq [contact.id]
+      end
+    end
+
+    context 'with an invalid ID' do
+      cassette
+      subject { described_class.create(company.id, 1234, described_class::COMPANY_TO_CONTACT) }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(Hubspot::RequestError, /One or more associations are invalid/)
+      end
+    end
+  end
+
+  describe '.batch_create' do
+    let(:deal) { Hubspot::Deal.create!(portal_id, [], [], {}) }
+
+    subject { described_class.batch_create(associations) }
+
+    context 'with a valid request' do
+      cassette
+      let(:associations) do
+        [
+          { from_id: deal.deal_id, to_id: contact.id, definition_id: described_class::DEAL_TO_CONTACT },
+          { from_id: deal.deal_id, to_id: company.id, definition_id: described_class::DEAL_TO_COMPANY }
+        ]
+      end
+
+      it 'associates the resources' do
+        expect(subject).to be true
+        find_deal = Hubspot::Deal.find(deal.deal_id)
+        expect(find_deal.vids).to eq [contact.id]
+        expect(find_deal.company_ids).to eq [company.id]
+      end
+    end
+
+    context 'with an invalid ID' do
+      cassette
+      let(:associations) do
+        [
+          { from_id: deal.deal_id, to_id: 1234, definition_id: described_class::DEAL_TO_CONTACT },
+          { from_id: deal.deal_id, to_id: company.id, definition_id: described_class::DEAL_TO_COMPANY }
+        ]
+      end
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(Hubspot::RequestError, /One or more associations are invalid/)
+        find_deal = Hubspot::Deal.find(deal.deal_id)
+        expect(find_deal.vids).to eq []
+        expect(find_deal.company_ids).to eq []
+      end
+    end
+  end
+
+  describe '.delete' do
+    subject { described_class.delete(company.id, contact_id_to_dissociate, described_class::COMPANY_TO_CONTACT) }
+    before { described_class.create(company.id, contact.id, described_class::COMPANY_TO_CONTACT) }
+
+    context 'with a valid ID' do
+      cassette
+      let(:contact_id_to_dissociate) { contact.id }
+
+      it 'dissociates the resources' do
+        expect(subject).to be true
+        expect(company.contact_ids.resources).to eq []
+      end
+    end
+
+    context 'with an invalid ID' do
+      cassette
+      let(:contact_id_to_dissociate) { 1234 }
+
+      it 'does not raise an error' do
+        expect(subject).to be true
+        expect(company.contact_ids.resources).to eq [contact.id]
+      end
+    end
+  end
+
+  describe '.batch_delete' do
+    let(:deal) { Hubspot::Deal.create!(portal_id, [company.id], [contact.id], {}) }
+
+    subject { described_class.batch_delete(associations) }
+
+    context 'with a valid request' do
+      cassette
+      let(:associations) do
+        [
+          { from_id: deal.deal_id, to_id: contact.id, definition_id: described_class::DEAL_TO_CONTACT },
+          { from_id: deal.deal_id, to_id: company.id, definition_id: described_class::DEAL_TO_COMPANY }
+        ]
+      end
+
+      it 'dissociates the resources' do
+        expect(subject).to be true
+        find_deal = Hubspot::Deal.find(deal.deal_id)
+        expect(find_deal.vids).to eq []
+        expect(find_deal.company_ids).to eq []
+      end
+    end
+
+    context 'with an invalid ID' do
+      cassette
+      let(:associations) do
+        [
+          { from_id: deal.deal_id, to_id: 1234, definition_id: described_class::DEAL_TO_CONTACT },
+          { from_id: deal.deal_id, to_id: company.id, definition_id: described_class::DEAL_TO_COMPANY }
+        ]
+      end
+
+      it 'does not raise an error, removes the valid associations' do
+        expect(subject).to be true
+        find_deal = Hubspot::Deal.find(deal.deal_id)
+        expect(find_deal.vids).to eq [contact.id]
+        expect(find_deal.company_ids).to eq []
+      end
+    end
+  end
+
+  describe '.all' do
+    subject { described_class.all(resource_id, definition_id) }
+
+    context 'with valid params' do
+      cassette
+
+      let(:resource_id) { deal.deal_id }
+      let(:definition_id) { described_class::DEAL_TO_CONTACT }
+      let(:deal) { Hubspot::Deal.create!(portal_id, [], contact_ids, {}) }
+      let(:contact_ids) { [contact.id, second_contact.id] }
+      let(:second_contact) { create :contact }
+
+      it 'finds the resources' do
+        expect(subject.map(&:id)).to contain_exactly(*contact_ids)
+      end
+    end
+
+    context 'with unsupported definition' do
+      let(:resource_id) { 1234 }
+      let(:definition_id) { -1 }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(Hubspot::InvalidParams, 'Definition not supported')
+      end
+    end
+  end
+end

data/spec/lib/hubspot/company_spec.rb

@@ -1,16 +1,5 @@
 RSpec.describe Hubspot::Company do
-  # let(:example_company_hash) do
-  #   VCR.use_cassette("company_example") do
-  #     HTTParty.get("https://api.hubapi.com/companies/v2/companies/21827084?hapikey=demo").parsed_response
-  #   end
-  # end
-  # let(:company_with_contacts_hash) do
-  #   VCR.use_cassette("company_with_contacts") do
-  #     HTTParty.get("https://api.hubapi.com/companies/v2/companies/115200636?hapikey=demo").parsed_response
-  #   end
-  # end
-
-  before{ Hubspot.configure(hapikey: "demo") }
+  before { Hubspot.configure(hapikey: 'demo') }
 
   it_behaves_like "a saveable resource", :company do
     def set_property(company)
@@ -279,13 +268,11 @@ RSpec.describe Hubspot::Company do
       subject { described_class.add_contact company.id, contact.id }
 
       it 'returns success' do
-        expect(subject).to be_truthy
+        expect(subject).to be true
       end
 
       it 'adds the contact to the company' do
-        expect {
-          subject
-        }.to change { company.contact_ids }.by([contact.id])
+        expect { subject }.to change { company.contact_ids }.by([contact.id])
       end
     end
 
@@ -294,12 +281,10 @@ RSpec.describe Hubspot::Company do
 
       let(:company) { create :company }
 
-      subject { described_class.add_contact company.id, 1 }
+      subject { described_class.add_contact company.id, 1234 }
 
       it 'raises an error' do
-        expect {
-          subject
-        }.to raise_error(Hubspot::RequestError, /Contact with the vid/)
+        expect { subject }.to raise_error(Hubspot::RequestError, /CONTACT=1234 is not valid/)
       end
     end
 
@@ -309,32 +294,30 @@ RSpec.describe Hubspot::Company do
       subject { described_class.add_contact 1, 1 }
 
       it 'raises an error' do
-        expect {
-          subject
-        }.to raise_error(Hubspot::RequestError, /company with the ID/)
+        expect { subject }.to raise_error(Hubspot::RequestError, /COMPANY=1 is not valid/)
       end
     end
   end
 
   describe '.remove_contact' do
     context 'with a valid company ID and contact ID' do
-      cassette allow_playback_repeats: true
+      cassette
 
-      let!(:company) { create :company }
-      let!(:contact) { create :contact, associatedCompanyId: company.id }
+      let(:company) { create :company }
+      let(:contact) { create :contact }
 
+      before { described_class.add_contact(company.id, contact.id) }
       subject { described_class.remove_contact company.id, contact.id }
 
       it 'returns success' do
-        expect(subject).to be_truthy
+        expect(subject).to be true
       end
 
-      # Testing this turns out to be hard since using associatedCompanyId doesn't immediately add
-      # the contact to the company but triggers some background job to perform the update. Since
-      # we're testing the gem interface and not the API (that's Hubspot's job) this should be OK to
-      # leave out.
-      #
-      # it 'removes the contact from the company'
+      it 'removes the contact from the company' do
+        expect(company.contact_ids.resources).to eq [contact.id]
+        subject
+        expect(company.contact_ids.resources).to eq []
+      end
     end
   end
 end

data/spec/lib/hubspot/deal_spec.rb

@@ -11,7 +11,7 @@ describe Hubspot::Deal do
     end
   end
 
-  before{ Hubspot.configure(hapikey: "demo") }
+  before { Hubspot.configure(hapikey: 'demo') }
 
   describe "#initialize" do
     subject{ Hubspot::Deal.new(example_deal_hash) }
@@ -107,6 +107,35 @@ describe Hubspot::Deal do
       end
     end
   end
+  
+  
+  describe '.associate' do
+    cassette
+    let(:deal) { Hubspot::Deal.create!(portal_id, [], [], {}) }
+    let(:company) { create :company }
+    let(:contact) { create :contact }
+    let(:contact_id) { contact.id }
+
+    subject { Hubspot::Deal.associate!(deal.deal_id, [company.id], [contact_id]) }
+
+    it 'associates the deal to the contact and the company' do
+      subject
+      find_deal = Hubspot::Deal.find(deal.deal_id)
+      find_deal.company_ids.should eql [company.id]
+      find_deal.vids.should eql [contact.id]
+    end
+
+    context 'when an id is invalid' do
+      let(:contact_id) { 1234 }
+
+      it 'raises an error and do not changes associations' do
+        expect { subject }.to raise_error(Hubspot::RequestError)
+        find_deal = Hubspot::Deal.find(deal.deal_id)
+        find_deal.company_ids.should eql []
+        find_deal.vids.should eql []
+      end
+    end
+  end
 
   describe ".find" do
     cassette "deal_find"
@@ -119,9 +148,9 @@ describe Hubspot::Deal do
   end
 
   describe '.find_by_company' do
-    cassette 'deal_find_by_company'
-    let(:company) { Hubspot::Company.create(name: 'Test Company') }
-    let(:company_id) { company.id }
+    cassette
+    let(:company) { create :company }
+    let!(:deal) { Hubspot::Deal.create!(portal_id, [company.id], [], { amount: amount }) }
 
     it 'returns company deals' do
       deals = Hubspot::Deal.find_by_company(company)
@@ -130,6 +159,18 @@ describe Hubspot::Deal do
     end
   end
 
+  describe '.find_by_contact' do
+    cassette
+    let(:contact) { create :contact }
+    let!(:deal) { Hubspot::Deal.create!(portal_id, [], [contact.id], { amount: amount }) }
+
+    it 'returns contact deals' do
+      deals = Hubspot::Deal.find_by_contact(contact)
+      deals.first.deal_id.should eql deal.deal_id
+      deals.first.properties['amount'].should eql amount
+    end
+  end
+
   describe '.recent' do
     cassette 'find_all_recent_updated_deals'
 

data/spec/lib/hubspot/resource_spec.rb

@@ -51,4 +51,44 @@ RSpec.describe Hubspot::Resource do
       end
     end
   end
-end
+
+  describe '#[]' do
+    context 'using new' do
+      let(:resource) { described_class.new(properties) }
+      let(:properties) { { id: 1, firstname: 'John', lastname: 'Wayne' } }
+
+      it { expect(resource[:firstname]).to eq 'John' }
+      it { expect(resource['lastname']).to eq 'Wayne' }
+      it { expect(resource[:middlename]).to be nil }
+    end
+
+    context 'using from_result' do
+      let(:resource) { described_class.from_result({ properties: properties }) }
+      let(:properties) { { id: { 'value' => 1 }, firstname: { 'value' => 'John' }, lastname: { 'value' => 'Wayne' } } }
+
+      it { expect(resource[:firstname]).to eq 'John' }
+      it { expect(resource['lastname']).to eq 'Wayne' }
+      it { expect(resource[:middlename]).to be nil }
+    end
+  end
+
+  describe '#adding_accessors' do
+    describe 'getters' do
+      context 'using new' do
+        let(:resource) { described_class.new(properties) }
+        let(:properties) { { id: 1, firstname: 'John', lastname: 'Wayne' } }
+
+        it { expect(resource.firstname).to eq 'John' }
+        it { expect(resource.lastname).to eq 'Wayne' }
+      end
+
+      context 'using from_result' do
+        let(:resource) { described_class.from_result({ properties: properties }) }
+        let(:properties) { { id: { 'value' => 1 }, firstname: { 'value' => 'John' }, lastname: { 'value' => 'Wayne' } } }
+
+        it { expect(resource.firstname).to eq 'John' }
+        it { expect(resource.lastname).to eq 'Wayne' }
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Jonathan
-- Juliette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2019-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -266,7 +265,6 @@ dependencies:
 description: hubspot-api-ruby is a wrapper for the HubSpot REST API
 email:
 - jonathan@hoggo.com
-- juliette@hoggo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -280,6 +278,7 @@ files:
 - Rakefile
 - hubspot-api-ruby.gemspec
 - lib/hubspot-api-ruby.rb
+- lib/hubspot/association.rb
 - lib/hubspot/blog.rb
 - lib/hubspot/collection.rb
 - lib/hubspot/company.rb
@@ -311,6 +310,7 @@ files:
 - spec/factories/companies.rb
 - spec/factories/contacts.rb
 - spec/lib/hubspot-ruby_spec.rb
+- spec/lib/hubspot/association_spec.rb
 - spec/lib/hubspot/blog_spec.rb
 - spec/lib/hubspot/company_properties_spec.rb
 - spec/lib/hubspot/company_spec.rb