hubspot-api-ruby 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b5da1c5b3161e39ad26020948f72dc349ec275140714ed29b470e9081c0e22d
-  data.tar.gz: e0fbef872458028ef540fe2fac43816980f2a4ad6862ee3acdaf68f6c12fc907
+  metadata.gz: 1c10bc271fecc20b749272010f29ca4d5e667872c39ed5ecd68a2cfd564b8311
+  data.tar.gz: c4b4459027deb4700a09876fd9d4e46a450753f26c83e982383f15121379571f
 SHA512:
-  metadata.gz: 2ddeb851b64faacbed0a42a1019d28c7a04b0899454db482188a7c53f6f9c397ad929fdf445d1143b9cfd85742d595b085e7e58c37b2de988307bc74e15665da
-  data.tar.gz: f2bfebd54dfecd85121f49399d271a1bd3a917b58db832639f983ca98897610e064525a43e645dda305f16d57b4316bae633b65a57289c2211a724c9ac934e8f
+  metadata.gz: a7d72b4aef781a7ba1857859d1572e7df94ba10635ebd13687012e9b2895bc1d0b7e16e19b6ce48cbc5fd736137eab144d7bed289a5c70607a576421404a779e
+  data.tar.gz: 160173f51c195de7214027940d471ee999fdf7df351a05f36654ba669aa50091c1e3d16cd7e0da1d6fe355398bedeec60777a92615cbd9bd63ce84b07924172f

data/hubspot-api-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "hubspot-api-ruby"
-  s.version = "0.15.0"
+  s.version = "0.17.0"
   s.require_paths = ["lib"]
   s.authors = ["Jonathan"]
   s.email = ["jonathan@hoggo.com"]
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
     "changelog_uri" => "https://github.com/captaincontrat/hubspot-api-ruby/blob/master/History.md"
   }
 
-  s.required_ruby_version = ">= 2.7"
+  s.required_ruby_version = ">= 3.1"
 
   # Add runtime dependencies here
   s.add_runtime_dependency "activesupport", ">= 4.2.2"

data/lib/hubspot/association.rb

@@ -17,6 +17,18 @@ class Hubspot::Association
     },
     "Contact" => {
       "Deal" => 4
+    },
+    "Ticket" => {
+      "Contact" => 16,
+      "Deal" => 28,
+      "Company" => 339,
+      "Task" => 229
+    },
+    "Task" => {
+      "Contact" => 204,
+      "Deal" => 216,
+      "Company" => 192,
+      "Ticket" => 230
     }
   }.freeze
 

data/lib/hubspot/connection.rb

@@ -10,30 +10,33 @@ module Hubspot
         handle_response(response).parsed_response
       end
 
-      def post_json(path, opts)
-        no_parse = opts[:params].delete(:no_parse) { false }
+      def post_json(path, options)
+        modification_query(:post, path, options)
+      end
 
-        url = generate_url(path, opts[:params])
-        response = post(
-          url,
-          body: opts[:body].to_json,
-          headers: { 'Content-Type' => 'application/json' },
-          format: :json,
-          read_timeout: read_timeout(opts),
-          open_timeout: open_timeout(opts)
-        )
+      def put_json(path, options)
+        modification_query(:put, path, options)
+      end
+
+      def patch_json(path, options)
+        modification_query(:patch, path, options)
+      end
 
+      def delete_json(path, opts)
+        url = generate_url(path, opts)
+        response = delete(url, format: :json, read_timeout: read_timeout(opts), open_timeout: open_timeout(opts))
         log_request_and_response url, response, opts[:body]
-        handle_response(response).yield_self do |r|
-          no_parse ? r : r.parsed_response
-        end
+        handle_response(response)
       end
 
-      def put_json(path, options)
+      protected
+
+      def modification_query(verb, path, options)
         no_parse = options[:params].delete(:no_parse) { false }
         url = generate_url(path, options[:params])
 
-        response = put(
+        response = send(
+          verb,
           url,
           body: options[:body].to_json,
           headers: { "Content-Type" => "application/json" },
@@ -48,15 +51,6 @@ module Hubspot
         end
       end
 
-      def delete_json(path, opts)
-        url = generate_url(path, opts)
-        response = delete(url, format: :json, read_timeout: read_timeout(opts), open_timeout: open_timeout(opts))
-        log_request_and_response url, response, opts[:body]
-        handle_response(response)
-      end
-
-      protected
-
       def read_timeout(opts = {})
         opts.delete(:read_timeout) || Hubspot::Config.read_timeout
       end

data/lib/hubspot/meeting.rb

@@ -26,8 +26,11 @@ module Hubspot
         }
       end
 
-      def find(id)
-        response = Hubspot::Connection.get_json(MEETING_PATH, { meeting_id: id, properties: BASE_PROPERTIES.join(',') })
+      def find(id, opts = {})
+        input_properties = opts[:properties].presence || []
+        properties = BASE_PROPERTIES | input_properties.compact
+
+        response = Hubspot::Connection.get_json(MEETING_PATH, { meeting_id: id, properties: properties.join(',') })
         new(response)
       end
 
@@ -36,6 +39,7 @@ module Hubspot
           limit: opts[:limit].presence || 100,
           after: opts[:after].presence
         }.compact
+        properties = opts[:properties].presence || []
 
         default_filters = [{ propertyName: 'associations.contact', 'operator': 'EQ', value: contact_id }]
         default_sorts = [{ propertyName: "hs_lastmodifieddate", direction: "DESCENDING" }]
@@ -44,7 +48,7 @@ module Hubspot
             params: {},
             body: {
               **params,
-              properties: BASE_PROPERTIES,
+              properties: BASE_PROPERTIES | properties.compact,
               filters: (opts[:filters].presence || []) + default_filters,
               sorts: opts[:sorts].presence || default_sorts
             }

data/lib/hubspot/task.rb

@@ -0,0 +1,46 @@
+require 'hubspot/utils'
+
+module Hubspot
+  #
+  # HubSpot Tasks API
+  #
+  # {https://developers.hubspot.com/beta-docs/guides/api/crm/engagements/tasks}
+  #
+  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'
+
+    attr_reader :properties, :id
+
+    def initialize(response_hash)
+      @id = response_hash['id']
+      @properties = response_hash['properties'].deep_symbolize_keys
+    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
+        properties = { hs_task_status: 'NOT_STARTED', hs_task_type: 'TODO' }.merge(params)
+        post_data = associations_hash.merge({ properties: 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 })
+        new(response)
+      end
+    end
+  end
+end

data/lib/hubspot/ticket.rb

@@ -0,0 +1,62 @@
+require 'hubspot/utils'
+
+module Hubspot
+  #
+  # HubSpot Tickets API
+  #
+  # {https://developers.hubspot.com/beta-docs/guides/api/crm/objects/tickets}
+  #
+  class Ticket
+    TICKETS_PATH = '/crm/v3/objects/tickets'
+    TICKET_PATH  = '/crm/v3/objects/tickets/:ticket_id'
+
+    attr_reader :properties, :id
+
+    def initialize(response_hash)
+      @id = response_hash['id']
+      @properties = response_hash['properties'].deep_symbolize_keys
+    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
+        post_data = associations_hash.merge({ properties: params })
+
+        response = Hubspot::Connection.post_json(TICKETS_PATH, params: {}, body: post_data)
+        new(response)
+      end
+
+      def update!(id, properties = {})
+        request = { properties: properties }
+        response = Hubspot::Connection.patch_json(TICKET_PATH, params: { ticket_id: id }, body: request)
+        new(response)
+      end
+
+      def find(ticket_id)
+        response = Hubspot::Connection.get_json(TICKET_PATH, { ticket_id: ticket_id })
+        new(response)
+      end
+    end
+  end
+end

data/lib/hubspot/ticket_properties.rb

@@ -0,0 +1,10 @@
+module Hubspot
+  class TicketProperties < Properties
+    CREATE_PROPERTY_PATH = '/crm/v3/properties/ticket'
+    class << self
+      def create!(params = {})
+        superclass.create!(CREATE_PROPERTY_PATH, params)
+      end
+    end
+  end
+end

data/lib/hubspot-api-ruby.rb

@@ -29,6 +29,9 @@ require 'hubspot/subscription'
 require 'hubspot/oauth'
 require 'hubspot/file'
 require 'hubspot/meeting'
+require 'hubspot/ticket'
+require 'hubspot/ticket_properties'
+require 'hubspot/task'
 
 module Hubspot
   def self.configure(config={})

data/spec/factories/contacts.rb

@@ -5,6 +5,6 @@ FactoryBot.define do
 
     firstname { Faker::Name.first_name }
     lastname { Faker::Name.last_name }
-    email { Faker::Internet.safe_email(name: "#{Time.new.to_i.to_s[-5..-1]}#{(0..3).map { (65 + rand(26)).chr }.join}") }
+    email { Faker::Internet.email(name: "#{Time.new.to_i.to_s[-5..-1]}#{(0..3).map { (65 + rand(26)).chr }.join}") }
   end
 end

data/spec/lib/hubspot/connection_spec.rb

@@ -84,6 +84,56 @@ describe Hubspot::Connection do
     end
   end
 
+  describe ".patch_json" do
+    it "issues a PATCH request and returns the parsed body" do
+      path = "/some/path"
+      update_options = { params: {}, body: {} }
+
+      stub_request(:patch, "https://api.hubapi.com/some/path").to_return(status: 200, body: JSON.generate(vid: 123))
+
+      response = Hubspot::Connection.patch_json(path, update_options)
+
+      assert_requested(
+        :patch,
+        "https://api.hubapi.com/some/path",
+        {
+          body: "{}",
+          headers: { "Content-Type" => "application/json" },
+        }
+      )
+      expect(response).to eq({ "vid" => 123 })
+    end
+
+    it "logs information about the request and response" do
+      path = "/some/path"
+      update_options = { params: {}, body: {} }
+
+      logger = stub_logger
+
+      stub_request(:patch, "https://api.hubapi.com/some/path").to_return(status: 200,
+                                                                       body: JSON.generate("response body"))
+
+      Hubspot::Connection.patch_json(path, update_options)
+
+      expect(logger).to have_received(:info).with(<<~MSG)
+        Hubspot: https://api.hubapi.com/some/path.
+        Body: {}.
+        Response: 200 "response body"
+      MSG
+    end
+
+    it "raises when the request fails" do
+      path = "/some/path"
+      update_options = { params: {}, body: {} }
+
+      stub_request(:patch, "https://api.hubapi.com/some/path").to_return(status: 401)
+
+      expect {
+        Hubspot::Connection.patch_json(path, update_options)
+      }.to raise_error(Hubspot::RequestError)
+    end
+  end
+
   context 'private methods' do
     describe ".generate_url" do
       let(:path) { "/test/:email/profile" }

data/spec/lib/hubspot/contact_spec.rb

@@ -42,7 +42,7 @@ RSpec.describe Hubspot::Contact do
     context 'without properties' do
       cassette
 
-      let(:email) { Faker::Internet.safe_email(name: "#{(0..3).map { (65 + rand(26)).chr }.join}#{Time.new.to_i.to_s[-5..-1]}") }
+      let(:email) { Faker::Internet.email(name: "#{(0..3).map { (65 + rand(26)).chr }.join}#{Time.new.to_i.to_s[-5..-1]}") }
       subject { described_class.create email }
 
       it 'creates a new contact' do
@@ -54,7 +54,7 @@ RSpec.describe Hubspot::Contact do
     context 'with properties' do
       cassette
 
-      let(:email) { Faker::Internet.safe_email(name: "#{(0..3).map { (65 + rand(26)).chr }.join}#{Time.new.to_i.to_s[-5..-1]}") }
+      let(:email) { Faker::Internet.email(name: "#{(0..3).map { (65 + rand(26)).chr }.join}#{Time.new.to_i.to_s[-5..-1]}") }
       let(:firstname) { "Allison" }
       let(:properties) { { firstname: firstname } }
 

data/spec/lib/hubspot/meeting_spec.rb

@@ -94,8 +94,10 @@ RSpec.describe Hubspot::Meeting do
       end
     end
 
-    context 'when custom filters' do
-      let(:opts) { { filters: [{ propertyName: 'hs_meeting_title', 'operator': 'EQ', value: 'Hello World' }] } }
+    context 'when custom filters and props' do
+      let(:filters) { [{ propertyName: 'hs_meeting_title', 'operator': 'EQ', value: 'Hello World' }] }
+      let(:properties) { [:hs_timestamp] }
+      let(:opts) { { filters: filters, properties: properties } }
 
       it 'retrieves meetings' do
         VCR.use_cassette 'meeting_find_by_contact_custom_filters' do
@@ -110,6 +112,7 @@ RSpec.describe Hubspot::Meeting do
           expect(first_meeting.properties[:hs_meeting_body]).not_to be nil
           expect(first_meeting.properties[:hs_meeting_start_time]).not_to be nil
           expect(first_meeting.properties[:hs_meeting_end_time]).not_to be nil
+          expect(first_meeting.properties[:hs_timestamp]).not_to be nil
         end
       end
     end
@@ -131,6 +134,7 @@ RSpec.describe Hubspot::Meeting do
           expect(first_meeting.properties[:hs_meeting_body]).not_to be nil
           expect(first_meeting.properties[:hs_meeting_start_time]).not_to be nil
           expect(first_meeting.properties[:hs_meeting_end_time]).not_to be nil
+          expect(first_meeting.properties[:hs_timestamp]).to be nil
         end
       end
     end

data/spec/lib/hubspot/task_spec.rb

@@ -0,0 +1,44 @@
+RSpec.describe Hubspot::Task do
+  describe 'create!' do
+    subject(:new_task) do
+      params = {
+        hs_task_body: 'i am a task',
+        hs_task_subject: 'title of task',
+        hs_timestamp: DateTime.now.strftime('%Q')
+      }
+      described_class.create!(params, ticket_id: 16_174_569_112)
+    end
+
+    it 'creates a new task with valid properties' do
+      VCR.use_cassette 'task' do
+        expect(new_task.id).not_to be_nil
+        expect(new_task.properties[:hs_task_status]).to eq('NOT_STARTED')
+        expect(new_task.properties[:hs_task_subject]).to eq('title of task')
+        expect(new_task.properties[:hs_body_preview]).to eq('i am a task')
+      end
+    end
+  end
+
+  describe 'find' do
+    let(:task_id) { 64_075_014_222 }
+
+    subject(:existing_task) { described_class.find(task_id, 'hs_task_subject,hs_task_status') }
+
+    it 'gets existing task' do
+      VCR.use_cassette 'task_find' do
+        expect(existing_task.id).not_to be_nil
+        expect(existing_task.properties[:hs_task_subject]).to eq('title of task')
+      end
+    end
+
+    context 'when task does not exist' do
+      let(:task_id) { 996_174_569_112 }
+
+      it 'returns nil' do
+        VCR.use_cassette 'task_find' do
+          expect { existing_task }.to raise_error Hubspot::NotFoundError
+        end
+      end
+    end
+  end
+end

data/spec/lib/hubspot/ticket_properties_spec.rb

@@ -0,0 +1,41 @@
+describe Hubspot::TicketProperties do
+  describe '.create' do
+    context 'with all valid parameters' do
+      let(:params) do
+        {
+          'name' => 'my_new_property',
+          'label' => 'This is my new property',
+          'description' => 'How much money do you have?',
+          'groupName' => 'ticketinformation',
+          'type' => 'string',
+          'fieldType' => 'text',
+          'hidden' => false,
+          'deleted' => false,
+          'displayOrder' => 0,
+          'formField' => true,
+          'readOnlyValue' => false,
+          'readOnlyDefinition' => false,
+          'mutableDefinitionNotDeletable' => false,
+          'calculated' => false,
+          'externalOptions' => false,
+          'displayMode' => 'current_value'
+        }
+      end
+
+      it 'should return the valid parameters' do
+        VCR.use_cassette 'ticket_create_property' do
+          response = Hubspot::TicketProperties.create!(params)
+          expect(Hubspot::TicketProperties.same?(params, response.compact.except('options'))).to be true
+        end
+      end
+    end
+
+    context 'with invalid parameters' do
+      it 'should return nil' do
+        VCR.use_cassette 'ticket_fail_to_create_property' do
+          expect(Hubspot::TicketProperties.create!({})).to be(nil)
+        end
+      end
+    end
+  end
+end

data/spec/lib/hubspot/ticket_spec.rb

@@ -0,0 +1,63 @@
+RSpec.describe Hubspot::Ticket do
+  describe 'create!' do
+    subject(:new_ticket) do
+      params = {
+        hs_pipeline: '0',
+        hs_pipeline_stage: '1',
+        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)
+    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')
+      end
+    end
+  end
+
+  describe 'find' do
+    let(:ticket_id) { 16_174_569_112 }
+
+    subject(:existing_ticket) { described_class.find(ticket_id) }
+
+    it 'gets existing ticket' do
+      VCR.use_cassette 'ticket_find' do
+        expect(existing_ticket.id).not_to be_nil
+        expect(existing_ticket.properties[:subject]).to eq('test ticket')
+      end
+    end
+
+    context 'when ticket does not exist' do
+      let(:ticket_id) { 996_174_569_112 }
+
+      it 'returns nil' do
+        VCR.use_cassette 'ticket_find' do
+          expect { existing_ticket }.to raise_error Hubspot::NotFoundError
+        end
+      end
+    end
+  end
+
+  describe 'update!' do
+    let(:ticket_id) { 16_174_569_112 }
+    let(:properties) do
+      {
+        hs_ticket_priority: 'HIGH',
+        subject: 'New name'
+      }
+    end
+
+    subject(:update_ticket) { described_class.update!(ticket_id, properties) }
+
+    it 'updates existing ticket, returns the updated entity' do
+      VCR.use_cassette 'ticket_update' do
+        ticket = update_ticket
+        ticket.properties[:subject] = 'New name'
+        ticket.properties[:subject] = 'HIGH'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Jonathan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -292,6 +292,9 @@ files:
 - lib/hubspot/railtie.rb
 - lib/hubspot/resource.rb
 - lib/hubspot/subscription.rb
+- lib/hubspot/task.rb
+- lib/hubspot/ticket.rb
+- lib/hubspot/ticket_properties.rb
 - lib/hubspot/topic.rb
 - lib/hubspot/utils.rb
 - spec/factories/companies.rb
@@ -319,6 +322,9 @@ files:
 - spec/lib/hubspot/owner_spec.rb
 - spec/lib/hubspot/properties_spec.rb
 - spec/lib/hubspot/resource_spec.rb
+- spec/lib/hubspot/task_spec.rb
+- spec/lib/hubspot/ticket_properties_spec.rb
+- spec/lib/hubspot/ticket_spec.rb
 - spec/lib/hubspot/utils_spec.rb
 - spec/shared_examples/saveable_resource.rb
 - spec/shared_examples/updateable_resource.rb
@@ -331,7 +337,7 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/captaincontrat/hubspot-api-ruby/blob/master/History.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -339,15 +345,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: hubspot-api-ruby is a wrapper for the HubSpot REST API
 test_files: []