hubspot-api-client 16.1.1 → 16.2.1

data/lib/hubspot/codegen/marketing/transactional/models/smtp_api_token_view.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Marketing
     module Transactional
+      # A SMTP API token provides both an ID and password that can be used to send email through the HubSpot SMTP API.
       class SmtpApiTokenView
         # User name to log into the HubSpot SMTP server.
         attr_accessor :id

data/lib/hubspot/codegen/settings/users/models/public_permission_set.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Settings
     module Users
+      # A role that can be assigned to a user
       class PublicPermissionSet
         # The role's unique ID
         attr_accessor :id

data/lib/hubspot/codegen/settings/users/models/public_team.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Settings
     module Users
+      # A team that can be assigned to a user
       class PublicTeam
         # The team's unique ID
         attr_accessor :id

data/lib/hubspot/codegen/settings/users/models/public_user.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Settings
     module Users
+      # A user
       class PublicUser
         # The user's unique ID
         attr_accessor :id

data/lib/hubspot/codegen/settings/users/models/public_user_update.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Settings
     module Users
+      # A user to update
       class PublicUserUpdate
         # The user's role
         attr_accessor :role_id

data/lib/hubspot/codegen/settings/users/models/user_provision_request.rb

@@ -16,6 +16,7 @@ require 'time'
 module Hubspot
   module Settings
     module Users
+      # A user creation request
       class UserProvisionRequest
         # The created user's email
         attr_accessor :email

data/lib/hubspot/discovery/marketing/events/api/search_api.rb

@@ -0,0 +1,13 @@
+require_relative '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Marketing
+      module Events
+        class SearchApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/marketing/events/client.rb

@@ -11,6 +11,7 @@ module Hubspot
             %i[
               attendance_subscriber_state_changes
               marketing_events_external
+              search
               settings_external
             ].freeze
           end

data/lib/hubspot/helpers/signature.rb

@@ -0,0 +1,62 @@
+require 'date'
+require 'openssl'
+
+module Hubspot
+  module Helpers
+    class Signature
+      MAX_ALLOWED_TIMESTAMP = 3000
+      def is_valid(
+        signature: String,
+        client_secret: String,
+        request_body: String,
+        http_uri: nil,
+        http_method: 'POST',
+        signature_version: 'v2',
+        timestamp: nil
+      )
+        if signature_version == "v3"
+          current_time = DateTime.now.strftime("%s").to_i
+          if current_time - timestamp.to_i > MAX_ALLOWED_TIMESTAMP
+            raise StandardError("Timestamp is invalid, reject request.")
+          end
+        end
+        hashed_signature = get_signature(
+          client_secret: client_secret,
+          request_body: request_body,
+          signature_version: signature_version,
+          http_uri: http_uri,
+          http_method: http_method,
+          timestamp: timestamp
+        )
+
+        signature == hashed_signature
+      end
+
+      def get_signature(
+        client_secret: String,
+        request_body: String,
+        signature_version: String,
+        http_uri: nil,
+        http_method: "POST",
+        timestamp: nil
+      )
+        case signature_version
+          when "v1"
+            source_string = "#{client_secret}#{request_body}"
+            hash_result = Digest::SHA2.hexdigest(source_string.encode('utf-8'))
+            return hash_result
+          when "v2"
+            source_string =  "#{client_secret}#{http_method}#{http_uri}#{request_body}"
+            hash_result = Digest::SHA2.hexdigest(source_string.encode('utf-8'))
+            return hash_result
+          when "v3"
+            source_string = "#{http_method}#{http_uri}#{request_body}#{timestamp}"
+            hash_result =  OpenSSL::HMAC.base64digest('SHA256', client_secret, source_string.encode('utf-8'))
+            return hash_result
+           else
+             raise StandardError("Not supported signature version: #{signature_version}")
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/helpers/webhooks_helper.rb

@@ -1,3 +1,4 @@
+# @deprecated
 module Hubspot
   module Helpers
     class WebhooksHelper

data/lib/hubspot/version.rb

@@ -1,3 +1,3 @@
- module Hubspot
-  VERSION = '16.1.1'
- end
+module Hubspot
+VERSION = '16.2.1'
+end

data/spec/discovery/marketing/events/marketing_events_external_api_spec.rb

@@ -10,7 +10,6 @@ describe 'Hubspot::Discovery::Marketing::Events::MarketingEventsExternalApi' do
   it { is_expected.to respond_to(:do_cancel) }
   it { is_expected.to respond_to(:archive_batch) }
   it { is_expected.to respond_to(:do_email_upsert_by_id) }
-  it { is_expected.to respond_to(:do_search) }
   it { is_expected.to respond_to(:do_upsert) }
   it { is_expected.to respond_to(:do_upsert_by_id) }
   it { is_expected.to respond_to(:get_by_id) }

data/spec/discovery/marketing/events/search_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Marketing::Events::SearchApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').marketing.events.search_api }
+
+  it { is_expected.to respond_to(:do_search) }
+end

data/spec/helpers/camel_case_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe "Hubspot::Helpers::CamelCase" do
+  subject( :camel_case) { Hubspot::Helpers::CamelCase.new }
+
+    it "Method 'format' should convert all snake_case strings to CamelCase strings" do
+      result = camel_case.format("some_test_text_in_snake_case")
+      expect(result).to eql "SomeTestTextInSnakeCase"
+    end
+
+end

data/spec/helpers/signature_spec.rb

@@ -0,0 +1,117 @@
+require 'date'
+require_relative "../../lib/hubspot/helpers/signature"
+
+TEST_DATA = {
+  :client_secret=> "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
+  :request_body=> "{'example_field':'example_value'}",
+  :url=> "https://www.example.com/webhook_uri",
+  :http_method=> "POST",
+  :timestamp=> 15000000,
+  :v1_hash=> "69fc6631a867edd4f9e9e627fc5c1148e3fbdd8b21837b6d2b8901c1fa57f750",
+  :v2_hash=> "4fe4e3a7d3cf09db53be39d0a58130e2aaba074ec123a9e355b876a689a1c383",
+  :v3_hash=> "HPW73RUtKmcYoEDADG0s6MmGFWUzWJKAW07r8RDgcQw=",
+}
+
+
+
+describe "Hubspot::Helpers::Signature.get_signature" do
+  subject( :signature) { Hubspot::Helpers::Signature.new }
+
+    it "should return hashed data for v3 signature version" do
+      result = signature.get_signature(
+        client_secret: TEST_DATA[:client_secret],
+        request_body: TEST_DATA[:request_body],
+        signature_version: "v3",
+        http_uri: TEST_DATA[:url],
+        timestamp: TEST_DATA[:timestamp]
+        )
+      expect(result).to eql TEST_DATA[:v3_hash]
+    end
+  it "should return hashed data for v2 signature version" do
+    result = signature.get_signature(
+      client_secret: TEST_DATA[:client_secret],
+      request_body: TEST_DATA[:request_body],
+      signature_version: "v2",
+      http_uri: TEST_DATA[:url],
+    )
+    expect(result).to eql TEST_DATA[:v2_hash]
+  end
+  it "should return hashed data for v1 signature version" do
+    result = signature.get_signature(
+      client_secret: TEST_DATA[:client_secret],
+      request_body: TEST_DATA[:request_body],
+      signature_version: "v1"
+    )
+    expect(result).to eql TEST_DATA[:v1_hash]
+  end
+  it "should raise exception for wrong signature version" do
+    expect{  signature.get_signature(
+      client_secret: TEST_DATA[:client_secret],
+      request_body: TEST_DATA[:request_body],
+      signature_version: "wrong_signature_version"
+    ) }.to raise_error(StandardError)
+    end
+
+end
+
+describe "Hubspot::Helpers::Signature.is_valid" do
+  subject( :signature) { Hubspot::Helpers::Signature.new }
+  it "should return true for v1 signature version" do
+    result = signature.is_valid(
+      signature: TEST_DATA[:v1_hash],
+      client_secret: TEST_DATA[:client_secret],
+      request_body: TEST_DATA[:request_body],
+      signature_version: "v1"
+    )
+    expect(result).to be true
+  end
+  it "should return true for v2 signature version" do
+    result = signature.is_valid(
+      signature: TEST_DATA[:v2_hash],
+      client_secret: TEST_DATA[:client_secret],
+      request_body: TEST_DATA[:request_body],
+      http_uri: TEST_DATA[:url],
+      signature_version: "v2"
+    )
+    expect(result).to be true
+  end
+  it "should return true for v3 signature version" do
+    test_timestamp = DateTime.now.strftime("%s")
+    test_signature = signature.get_signature(
+      client_secret: TEST_DATA[:client_secret],
+      request_body: TEST_DATA[:request_body],
+      http_uri: TEST_DATA[:http_uri],
+      timestamp: test_timestamp,
+      signature_version: "v3"
+    )
+
+    result = signature.is_valid(
+      signature: test_signature,
+      client_secret: TEST_DATA[:client_secret],
+      request_body: TEST_DATA[:request_body],
+      http_uri: TEST_DATA[:http_uri],
+      timestamp: test_timestamp,
+      signature_version: "v3"
+    )
+    expect(result).to be true
+  end
+  it "should raise exception if :signature_version=>v3 and :timestamp=>nil" do
+    expect {  signature.is_valid(
+      signature: TEST_DATA[:v3_hash],
+      client_secret: TEST_DATA[:client_secret],
+      request_body: TEST_DATA[:request_body],
+      http_uri: TEST_DATA[:http_uri],
+      signature_version: "v3"
+    ) }.to raise_error(StandardError)
+  end
+  it "should raise exception if :signature_version=>v3 and :timestamp=>wrong_timestamp" do
+    expect {  signature.is_valid(
+      signature: TEST_DATA[:v3_hash],
+      client_secret: TEST_DATA[:client_secret],
+      request_body: TEST_DATA[:request_body],
+      http_uri: TEST_DATA[:http_uri],
+      timestamp: "wrong_timestamp",
+      signature_version: "v3"
+    ) }.to raise_error(StandardError)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-api-client
 version: !ruby/object:Gem::Version
-  version: 16.1.1
+  version: 16.2.1
 platform: ruby
 authors:
 - HubSpot
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -437,13 +437,18 @@ files:
 - lib/hubspot/codegen/crm/associations/models/batch_input_public_object_id.rb
 - lib/hubspot/codegen/crm/associations/models/batch_response_public_association.rb
 - lib/hubspot/codegen/crm/associations/models/batch_response_public_association_multi.rb
+- lib/hubspot/codegen/crm/associations/models/batch_response_public_association_multi_with_errors.rb
+- lib/hubspot/codegen/crm/associations/models/batch_response_public_association_with_errors.rb
+- lib/hubspot/codegen/crm/associations/models/collection_response_public_association_definition_no_paging.rb
 - lib/hubspot/codegen/crm/associations/models/collection_response_public_association_definiton.rb
 - lib/hubspot/codegen/crm/associations/models/error.rb
 - lib/hubspot/codegen/crm/associations/models/error_category.rb
 - lib/hubspot/codegen/crm/associations/models/error_detail.rb
 - lib/hubspot/codegen/crm/associations/models/next_page.rb
 - lib/hubspot/codegen/crm/associations/models/paging.rb
+- lib/hubspot/codegen/crm/associations/models/previous_page.rb
 - lib/hubspot/codegen/crm/associations/models/public_association.rb
+- lib/hubspot/codegen/crm/associations/models/public_association_definition.rb
 - lib/hubspot/codegen/crm/associations/models/public_association_definiton.rb
 - lib/hubspot/codegen/crm/associations/models/public_association_multi.rb
 - lib/hubspot/codegen/crm/associations/models/public_object_id.rb
@@ -1307,6 +1312,7 @@ files:
 - lib/hubspot/codegen/files/files/models/standard_error.rb
 - lib/hubspot/codegen/marketing/events/api/attendance_subscriber_state_changes_api.rb
 - lib/hubspot/codegen/marketing/events/api/marketing_events_external_api.rb
+- lib/hubspot/codegen/marketing/events/api/search_api.rb
 - lib/hubspot/codegen/marketing/events/api/settings_external_api.rb
 - lib/hubspot/codegen/marketing/events/api_client.rb
 - lib/hubspot/codegen/marketing/events/api_error.rb
@@ -1632,6 +1638,7 @@ files:
 - lib/hubspot/discovery/marketing/client.rb
 - lib/hubspot/discovery/marketing/events/api/attendance_subscriber_state_changes_api.rb
 - lib/hubspot/discovery/marketing/events/api/marketing_events_external_api.rb
+- lib/hubspot/discovery/marketing/events/api/search_api.rb
 - lib/hubspot/discovery/marketing/events/api/settings_external_api.rb
 - lib/hubspot/discovery/marketing/events/client.rb
 - lib/hubspot/discovery/marketing/forms/api/forms_api.rb
@@ -1655,6 +1662,7 @@ files:
 - lib/hubspot/helpers/camel_case.rb
 - lib/hubspot/helpers/get_all_helper.rb
 - lib/hubspot/helpers/path.rb
+- lib/hubspot/helpers/signature.rb
 - lib/hubspot/helpers/snake_case.rb
 - lib/hubspot/helpers/webhooks_helper.rb
 - lib/hubspot/oauth_helper.rb
@@ -1793,6 +1801,7 @@ files:
 - spec/discovery/files/files/folders_api_spec.rb
 - spec/discovery/marketing/events/attendance_subscriber_state_changes_api_spec.rb
 - spec/discovery/marketing/events/marketing_events_external_api_spec.rb
+- spec/discovery/marketing/events/search_api_spec.rb
 - spec/discovery/marketing/events/settings_external_api_spec.rb
 - spec/discovery/marketing/forms/forms_api_spec.rb
 - spec/discovery/marketing/transactional/public_smtp_tokens_api_spec.rb
@@ -1805,6 +1814,8 @@ files:
 - spec/discovery/settings/users/users_api_spec.rb
 - spec/discovery/webhooks/settings_api_spec.rb
 - spec/discovery/webhooks/subscriptions_api_spec.rb
+- spec/helpers/camel_case_spec.rb
+- spec/helpers/signature_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/HubSpot/hubspot-api-ruby
 licenses:
@@ -1825,7 +1836,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: HubSpot Ruby API Gem
@@ -1964,6 +1975,7 @@ test_files:
 - spec/discovery/files/files/files_api_spec.rb
 - spec/discovery/files/files/folders_api_spec.rb
 - spec/discovery/marketing/forms/forms_api_spec.rb
+- spec/discovery/marketing/events/search_api_spec.rb
 - spec/discovery/marketing/events/marketing_events_external_api_spec.rb
 - spec/discovery/marketing/events/attendance_subscriber_state_changes_api_spec.rb
 - spec/discovery/marketing/events/settings_external_api_spec.rb
@@ -1976,4 +1988,6 @@ test_files:
 - spec/discovery/events/events_api_spec.rb
 - spec/discovery/webhooks/settings_api_spec.rb
 - spec/discovery/webhooks/subscriptions_api_spec.rb
+- spec/helpers/signature_spec.rb
+- spec/helpers/camel_case_spec.rb
 - spec/spec_helper.rb