hubspot-api-ruby 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84790661e8f1582c8b58fc95c7979549d703b6852ee340b80f11f22ec72f5703
-  data.tar.gz: 02ae5c6663904594004f87f922130643cc962fdf2a6d4dbc16d9d860a6c168c8
+  metadata.gz: 98ed008fd84b2f589251de5d0419a1e22823df7767b59d1e19df1a8f30ac11c3
+  data.tar.gz: 5586bece57acb191f44e73eed781b6e122c3e072b84d6eadee6ee5cb0d4c8344
 SHA512:
-  metadata.gz: 7e5fa62a26ffe1c2508ef02e805886abfc81295511f9745fd08c52555723f3dd7c0cbe38beb0a535884b856b821c7e09475b2209c01419471f79ab1ec288f943
-  data.tar.gz: bc94ed7bf54229971748b30c00ad3e31626469b70fdfb5c9a9e16b59b38bc6ceb1b2eb299ea8ae9798079ef546a164da5a6c864712d63671d35491c015b5afd8
+  metadata.gz: cff09103b5a37c8a50a10ec24e1feba246af33b4d8f39512817ad6f1e505c1a37a5ca3b40fe5db7ca9d9da02f1ca6fd17ba1359d095a5952794e313b2398a5fa
+  data.tar.gz: dda419b3e0d59f80d1126b8bcb4e5d057c3e8ea869c0595be1ea8a21c6702d418630ec18431204817cf58943d25fecfaccc23727e99008f790e1c083f3fd105b

data/hubspot-api-ruby.gemspec

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

data/lib/hubspot/owner.rb

@@ -2,24 +2,21 @@ module Hubspot
   #
   # HubSpot Owners API
   #
-  # {http://developers.hubspot.com/docs/methods/owners/get_owners}
+  # {https://developers.hubspot.com/docs/reference/api/crm/owners/v3}
+  #
   #
-  # TODO: Create an Owner
-  # TODO: Update an Owner
-  # TODO: Delete an Owner
   class Owner
-    GET_OWNER_PATH    = '/owners/v2/owners/:owner_id' # GET
-    GET_OWNERS_PATH   = '/owners/v2/owners' # GET
-    CREATE_OWNER_PATH = '/owners/v2/owners' # POST
-    UPDATE_OWNER_PATH = '/owners/v2/owners/:owner_id' # PUT
-    DELETE_OWNER_PATH = '/owners/v2/owners/:owner_id' # DELETE
-
+    GET_OWNER_PATH    = '/crm/v3/owners/:owner_id' # GET
+    GET_OWNERS_PATH   = '/crm/v3/owners' # GET
+    CREATE_OWNER_PATH = "/crm/v3/owners" # POST
+    UPDATE_OWNER_PATH = '/crm/v3/owners/:owner_id' # PUT
+    DELETE_OWNER_PATH = '/crm/v3/owners/:owner_id' # DELETE
 
     attr_reader :properties, :owner_id, :email
 
     def initialize(property_hash)
       @properties = property_hash
-      @owner_id   = @properties['ownerId']
+      @owner_id   = @properties['id']
       @email      = @properties['email']
     end
 
@@ -28,29 +25,46 @@ module Hubspot
     end
 
     class << self
-      def all(include_inactive=false)
-        path     = GET_OWNERS_PATH
-        params   = { includeInactive: include_inactive }
+      def all(include_archived: false, limit: 100, after: nil)
+        path = GET_OWNERS_PATH
+        params = {
+          archived: include_archived,
+          limit: limit,
+          after: after
+        }.compact
+
         response = Hubspot::Connection.get_json(path, params)
-        response.map { |r| new(r) }
+        {
+          results: response['results'].map { |r| new(r) },
+          pagination: {
+            next: response['paging']&.dig('next', 'after'),
+            total: response['total']
+          }
+        }
       end
 
-      def find(id, include_inactive=false)
-        path     = GET_OWNER_PATH
-        response = Hubspot::Connection.get_json(path, owner_id: id,
-          include_inactive: include_inactive)
+      def find(id, id_property: nil)
+        path = GET_OWNER_PATH
+        params = { owner_id: id }
+        params[:idProperty] = id_property if id_property
+        response = Hubspot::Connection.get_json(path, params)
         new(response)
       end
 
-      def find_by_email(email, include_inactive=false)
-        path     = GET_OWNERS_PATH
-        params   = { email: email, includeInactive: include_inactive }
+      def find_by_email(email, include_archived: false, limit: 100, after: nil)
+        path = GET_OWNERS_PATH
+        params = {
+          email: email,
+          archived: include_archived,
+          limit: limit,
+          after: after
+        }.compact
         response = Hubspot::Connection.get_json(path, params)
-        response.blank? ? nil : new(response.first)
+        response['results'].blank? ? nil : new(response['results'].first)
       end
 
-      def find_by_emails(emails, include_inactive=false)
-        emails.map { |email| find_by_email(email, include_inactive) }.reject(&:blank?)
+      def find_by_emails(emails = [], include_archived: false)
+        emails.map { |email| find_by_email(email, include_archived: include_archived) }.reject(&:nil?)
       end
     end
   end

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
 
@@ -33,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/spec/lib/hubspot/owner_spec.rb

@@ -2,7 +2,7 @@ describe Hubspot::Owner do
   let(:example_owners) do
     VCR.use_cassette('owner_example') do
       headers = { Authorization: "Bearer #{ENV.fetch('HUBSPOT_ACCESS_TOKEN')}" }
-      HTTParty.get('https://api.hubapi.com/owners/v2/owners', headers: headers).parsed_response
+      HTTParty.get('https://api.hubapi.com/crm/v3/owners', headers: headers).parsed_response['results']
     end
   end
 
@@ -13,7 +13,22 @@ describe Hubspot::Owner do
       owners = Hubspot::Owner.all
 
       expect(owners.blank?).to be false
-      compare_owners(owners, example_owners)
+      expect(owners[:results].blank?).to be false
+      compare_owners(owners[:results], example_owners)
+    end
+  end
+
+  describe '.find' do
+    cassette 'owner_find_by_id'
+
+    let(:sample) { example_owners.first }
+    let(:id) { sample['id'] }
+
+    it 'should find a user via their id' do
+      owner = Hubspot::Owner.find(id)
+      sample.map do |key, val|
+        expect(owner[key]).to eq(val)
+      end
     end
   end
 

data/spec/lib/hubspot/task_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Hubspot::Task do
         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),
+        Hubspot::Association.build_association_param('Task', 'Deal', 28_806_796_888)
       ]
       described_class.create!(params, associations:)
     end
@@ -47,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Jonathan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2025-03-07 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.3
 signing_key:
 specification_version: 4
 summary: hubspot-api-ruby is a wrapper for the HubSpot REST API