Add more associations to tasks (#26)

* create utils to add association more quickly

* update task endpoint to add more associations

* bump gem version

* add spec to cover append_association nil case

* move append_association to Hubspot::Association

* Ticket.create! and Task.create! now take array association param

* make hashes more ruby3 compliant

History.md

@@ -1,3 +1,7 @@
+## 0.18.0
+
+* BREAKING CHANGE : Ticket#create! and Task#create now takes association param (array), build it using Association.build_association_param
+
 ## 0.17.1
 
 * Add default properties for Ticket#find

hubspot-api-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "hubspot-api-ruby"
-  s.version = "0.17.1"
+  s.version = "0.18.0"
   s.require_paths = ["lib"]
   s.authors = ["Jonathan"]
   s.email = ["jonathan@hoggo.com"]

lib/hubspot/association.rb

@@ -75,6 +75,15 @@ def all(object_type, object_id, to_object_type)
       response['results'].map { |result| klass.find(result["toObjectId"]) }
     end
 
+    # Utility function to build the association list required by some API endpoints
+    def build_association_param(origin, associated, associated_id)
+      {
+        to: { id: associated_id },
+        types: [{ associationCategory: 'HUBSPOT_DEFINED',
+                  associationTypeId: Hubspot::Association::ASSOCIATION_DEFINITIONS[origin][associated] }]
+      }
+    end
+
     private
 
     def build_create_association_body(association, definition_id)

lib/hubspot/task.rb

@@ -20,17 +20,10 @@ def initialize(response_hash)
     end
 
     class << self
-      def create!(params = {}, ticket_id: nil)
-        associations_hash = { 'associations' => [] }
-        if ticket_id.present?
-          associations_hash['associations'] << {
-            "to": { "id": ticket_id },
-            "types": [{ "associationCategory": 'HUBSPOT_DEFINED',
-                        "associationTypeId": Hubspot::Association::ASSOCIATION_DEFINITIONS['Task']['Ticket'] }]
-          }
-        end
+      def create!(params = {}, associations: [])
+        associations_hash = { associations: }
         properties = { hs_task_status: 'NOT_STARTED', hs_task_type: 'TODO' }.merge(params)
-        post_data = associations_hash.merge({ properties: properties })
+        post_data = associations_hash.merge(properties:)
 
         response = Hubspot::Connection.post_json(TASKS_PATH, params: {}, body: post_data)
         new(response)

lib/hubspot/ticket.rb

@@ -20,31 +20,9 @@ def initialize(response_hash)
     end
 
     class << self
-      def create!(params = {}, contact_id: nil, company_id: nil, deal_id: nil)
-        associations_hash = { 'associations' => [] }
-        if contact_id.present?
-          associations_hash['associations'] << {
-            "to": { "id": contact_id },
-            "types": [{ "associationCategory": 'HUBSPOT_DEFINED',
-                        "associationTypeId": Hubspot::Association::ASSOCIATION_DEFINITIONS['Ticket']['Contact'] }]
-          }
-        end
-        if company_id.present?
-          associations_hash['associations'] << {
-            "to": { "id": company_id },
-            "types": [{ "associationCategory": 'HUBSPOT_DEFINED',
-                        "associationTypeId": Hubspot::Association::ASSOCIATION_DEFINITIONS['Ticket']['Company'] }]
-          }
-        end
-        if deal_id.present?
-          associations_hash['associations'] << {
-            "to": { "id": deal_id },
-            "types": [{ "associationCategory": 'HUBSPOT_DEFINED',
-                        "associationTypeId": Hubspot::Association::ASSOCIATION_DEFINITIONS['Ticket']['Deal'] }]
-          }
-        end
+      def create!(params = {}, associations: [])
+        associations_hash = { associations: }
         post_data = associations_hash.merge({ properties: params })
-
         response = Hubspot::Connection.post_json(TICKETS_PATH, params: {}, body: post_data)
         new(response)
       end

spec/lib/hubspot/association_spec.rb

@@ -162,4 +162,17 @@
       end
     end
   end
+
+  describe '.build_association_param' do
+    it 'returns proper association hash' do
+      result = described_class.build_association_param('Ticket', 'Company', 1337)
+      expect(result).to eq(
+        {
+          "to": { "id": 1337 },
+          "types": [{ "associationCategory": 'HUBSPOT_DEFINED',
+                      "associationTypeId": 339 }]
+        }
+      )
+    end
+  end
 end

spec/lib/hubspot/task_spec.rb

@@ -6,7 +6,13 @@
         hs_task_subject: 'title of task',
         hs_timestamp: DateTime.now.strftime('%Q')
       }
-      described_class.create!(params, ticket_id: 16_174_569_112)
+      associations = [
+        Hubspot::Association.build_association_param('Task', 'Ticket', 16_174_569_112),
+        Hubspot::Association.build_association_param('Task', 'Contact', 75_761_595_194),
+        Hubspot::Association.build_association_param('Task', 'Company', 25_571_271_600),
+        Hubspot::Association.build_association_param('Task', 'Deal', 28_806_796_888),
+      ]
+      described_class.create!(params, associations:)
     end
 
     it 'creates a new task with valid properties' do

spec/lib/hubspot/ticket_spec.rb

@@ -7,7 +7,12 @@
         hs_ticket_priority: 'MEDIUM',
         subject: 'test ticket'
       }
-      described_class.create!(params, contact_id: 75_761_595_194, company_id: 25_571_271_600, deal_id: 28_806_796_888)
+      associations = [
+        Hubspot::Association.build_association_param('Ticket', 'Contact', 75_761_595_194),
+        Hubspot::Association.build_association_param('Ticket', 'Company', 25_571_271_600),
+        Hubspot::Association.build_association_param('Ticket', 'Deal', 28_806_796_888),
+      ]
+      described_class.create!(params, associations:)
     end
 
     it 'creates a new ticket with valid properties' do