hubspot-api-ruby 0.17.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b564d62844c37b49655f638b63d9f42d26b802df97c24c3b6655df9769101ae
-  data.tar.gz: 9b11ad78ab56c1fa39f52493804efae39d918ee605ef069228722e26ede03d25
+  metadata.gz: 45060ea19bf32fc857cbeb5d0a043b5c2c9668197ac25a518da74ecee2522e05
+  data.tar.gz: 68dfbf022d1580f26f51a7688151e8fc21c590e812e18b5b21475de9def30930
 SHA512:
-  metadata.gz: c99b28adb56c9b75b842166278ff6094c7d1c562ad3579c26a78854728b02a527dafd44fe82d08360637438f64ba29914a5b8b3351f825908c503bd722744e50
-  data.tar.gz: c9aa6f2112b7a3d9fc8b863c648971e54c4557659aa7c7ca509f5c2581f0bd038691a6254564bf9d06dc6199abc4d318960ffa7d0d3ff477b2d7ec080c900a26
+  metadata.gz: 413df289081df3767598dc9c5c542dfa4c5e729adf55d79631d101ff905440590cdcc8c532531e62d728940d624941a41031b584eb642e245b4990e7fdd1b268
+  data.tar.gz: 66f6e52964908bd067b9c43fc3a0f82b75328d4fb3588acf5c84f5ebe50660228ad3736a4ebb0f94dc4444619e011eaebd3d3e93afc3a63dc1ad072d4a762a7b

data/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.19.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

@@ -8,9 +8,10 @@ module Hubspot
   #
   class Task
     TASKS_PATH = '/crm/v3/objects/tasks'
-    TASK_PATH  = '/crm/v3/objects/tasks/:task_id'
-    DEFAULT_TASK_FIELDS = 'hs_timestamp,hs_task_body,hubspot_owner_id,hs_task_subject,hs_task_status,hs_task_priority,'\
-      'hs_task_type,hs_task_reminders'
+    SEARCH_PATH = '/crm/v3/objects/tasks/search'
+    TASK_PATH = '/crm/v3/objects/tasks/:task_id'
+    DEFAULT_TASK_FIELDS = %w[hs_timestamp hs_task_body hubspot_owner_id hs_task_subject hs_task_status hs_task_priority
+                             hs_task_type hs_task_reminders].freeze
 
     attr_reader :properties, :id
 
@@ -20,17 +21,10 @@ 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)
@@ -40,6 +34,15 @@ module Hubspot
         response = Hubspot::Connection.get_json(TASK_PATH, task_id: task_id, properties:)
         new(response)
       end
+
+      def search(properties = DEFAULT_TASK_FIELDS, body: {})
+        Hubspot::Connection.post_json(SEARCH_PATH, params: {}, body: { properties: }.merge(body))
+      end
+
+      def update!(task_id, properties = {})
+        response = Hubspot::Connection.patch_json(TASK_PATH, params: { task_id: }, body: { properties: })
+        new(response)
+      end
     end
   end
 end

data/lib/hubspot/ticket.rb

@@ -20,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

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
@@ -41,4 +47,35 @@ RSpec.describe Hubspot::Task do
       end
     end
   end
+
+  describe 'search' do
+    subject(:search) do
+      body = { filterGroups: [
+        { filters: [{ propertyName: 'associations.ticket', operator: 'EQ',
+                      value: '16676542642' }] }
+      ] }
+      described_class.search(%w[hs_task_subject hs_task_status], body:)
+    end
+
+    it 'returns list of tasks matching search body' do
+      VCR.use_cassette 'task_search' do
+        expect(search['total']).to eq(2)
+        expect(search['results'].map { |r| r['id'] }).to contain_exactly('65090432307', '65476695429')
+      end
+    end
+  end
+
+  describe 'update!' do
+    let(:task_id) { 64_483_143_324 }
+    let(:properties) { { hs_task_status: 'COMPLETED' } }
+
+    subject(:update_task) { described_class.update!(task_id, properties) }
+
+    it 'updates existing task, returns the updated entity' do
+      VCR.use_cassette 'task_update' do
+        task = update_task
+        expect(task.properties[:hs_task_status]).to eq('COMPLETED')
+      end
+    end
+  end
 end

data/spec/lib/hubspot/ticket_spec.rb

@@ -7,7 +7,12 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.19.0
 platform: ruby
 authors:
 - Jonathan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2024-12-11 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.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: hubspot-api-ruby is a wrapper for the HubSpot REST API