hubspot-api-ruby 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c10bc271fecc20b749272010f29ca4d5e667872c39ed5ecd68a2cfd564b8311
-  data.tar.gz: c4b4459027deb4700a09876fd9d4e46a450753f26c83e982383f15121379571f
+  metadata.gz: 84790661e8f1582c8b58fc95c7979549d703b6852ee340b80f11f22ec72f5703
+  data.tar.gz: 02ae5c6663904594004f87f922130643cc962fdf2a6d4dbc16d9d860a6c168c8
 SHA512:
-  metadata.gz: a7d72b4aef781a7ba1857859d1572e7df94ba10635ebd13687012e9b2895bc1d0b7e16e19b6ce48cbc5fd736137eab144d7bed289a5c70607a576421404a779e
-  data.tar.gz: 160173f51c195de7214027940d471ee999fdf7df351a05f36654ba669aa50091c1e3d16cd7e0da1d6fe355398bedeec60777a92615cbd9bd63ce84b07924172f
+  metadata.gz: 7e5fa62a26ffe1c2508ef02e805886abfc81295511f9745fd08c52555723f3dd7c0cbe38beb0a535884b856b821c7e09475b2209c01419471f79ab1ec288f943
+  data.tar.gz: bc94ed7bf54229971748b30c00ad3e31626469b70fdfb5c9a9e16b59b38bc6ceb1b2eb299ea8ae9798079ef546a164da5a6c864712d63671d35491c015b5afd8

data/hubspot-api-ruby.gemspec

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

data/lib/hubspot/association.rb

@@ -75,6 +75,15 @@ class Hubspot::Association
       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)

data/lib/hubspot/task.rb

@@ -20,25 +20,17 @@ module Hubspot
     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)
       end
 
       def find(task_id, properties = DEFAULT_TASK_FIELDS)
-        response = Hubspot::Connection.get_json(TASK_PATH, { task_id: task_id,
-                                                             properties: properties })
+        response = Hubspot::Connection.get_json(TASK_PATH, task_id: task_id, properties:)
         new(response)
       end
     end

data/lib/hubspot/ticket.rb

@@ -9,6 +9,8 @@ module Hubspot
   class Ticket
     TICKETS_PATH = '/crm/v3/objects/tickets'
     TICKET_PATH  = '/crm/v3/objects/tickets/:ticket_id'
+    DEFAULT_TICKET_FIELDS='content,createdate,hs_lastmodifieddate,hs_object_id,hs_pipeline,hs_pipeline_stage,'\
+      'hs_ticket_category,hs_ticket_priority,hubspot_owner_id,subject'
 
     attr_reader :properties, :id
 
@@ -18,31 +20,9 @@ module Hubspot
     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
@@ -53,8 +33,8 @@ module Hubspot
         new(response)
       end
 
-      def find(ticket_id)
-        response = Hubspot::Connection.get_json(TICKET_PATH, { ticket_id: ticket_id })
+      def find(ticket_id, properties = DEFAULT_TICKET_FIELDS)
+        response = Hubspot::Connection.get_json(TICKET_PATH, ticket_id: ticket_id, properties:)
         new(response)
       end
     end

data/spec/lib/hubspot/association_spec.rb

@@ -162,4 +162,17 @@ RSpec.describe Hubspot::Association do
       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

data/spec/lib/hubspot/task_spec.rb

@@ -6,7 +6,13 @@ RSpec.describe Hubspot::Task do
         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

data/spec/lib/hubspot/ticket_spec.rb

@@ -7,13 +7,19 @@ RSpec.describe Hubspot::Ticket do
         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
       VCR.use_cassette 'ticket' do
         expect(new_ticket.id).not_to be_nil
         expect(new_ticket.properties[:subject]).to eq('test ticket')
+        expect(new_ticket.properties[:hubspot_owner_id]).to be_nil
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Jonathan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -352,7 +352,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: hubspot-api-ruby is a wrapper for the HubSpot REST API