hubspot-api-client 17.0.0.pre.beta.3 → 17.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf03f85e815cda2314c5d9433d05baf61dc9cff1578027fbf719df17346b2a22
-  data.tar.gz: b10c430908fde3591fbe586ec97a1078ea4d5dfc6b5c151c02468d5650a76b61
+  metadata.gz: abbad95ec7ed2eab3eec2d180f721b54f7de216328c1df44670c32b3e14a882e
+  data.tar.gz: 0ac955e55206a6cd81881825c3f2669eb8cc5a792af273cb24cfaf1342230d6f
 SHA512:
-  metadata.gz: ba61d9af22ac49d15c2ca40bf8545bd036441eba289b13faa18d657717ae40bc5d2c830a220ac44fd625a31020bc7844d2bfd5a6ce84c6dd5ba8a7d02f239ac7
-  data.tar.gz: 24b656e117c4d7515ef257ba111634ecff1267831934361bf59046090bfd3aabf20929b966dc041c3a548ede2aabce7770a31841c16988c297d54ffd032de766
+  metadata.gz: 3961b180b6ca01a771749514c85d48cbca3b7ba18344038c39d2aed54c53389e6a3c1490a5f77913d67cbf9897ec9f101ac8ece545e528d0c2e54c73749c6da0
+  data.tar.gz: 579b92cbc0cb4c1db21a313866953d586a7e1c61ec200400265007625fcd5f817b6b4653c99e6d7ee6e5768a6685a036905391b83bde016b6c49daac4a985d41

data/CHANGELOG.md

@@ -5,9 +5,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/HubSpot/hubspot-api-ruby/compare/v17.0.0-beta.3...HEAD)
+## [Unreleased](https://github.com/HubSpot/hubspot-api-ruby/compare/v17.0.0...HEAD)
 
 
+## [17.0.0.pre.beta.4] - 2023-06-14
+
+## Updated
+
+- Fix `Hubspot::OAuthHelper.authorize_url()` (don't add empty scopes or optional scopes to OAuth url)
+
+## [17.0.0.pre.beta.4] - 2023-05-17
+
+## Added
+
+- added custom exceptions for Signature
+- add associations types
+
+## Updated
+
+- remove deprecated `validate_signature`
+
 ## [17.0.0-beta.3] - 2023-05-12
 
 ## Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (17.0.0-beta.3)
+    hubspot-api-client (17.0.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.4.0)
 

data/lib/hubspot/client.rb

@@ -19,7 +19,7 @@ module Hubspot
         events
         files
         marketing
-        o_auth
+        oauth
         settings
         webhooks
       ].freeze

data/lib/hubspot/discovery/oauth/client.rb

@@ -13,10 +13,6 @@ module Hubspot
             tokens
           ].freeze
         end
-
-        def discovery_module_path
-          super.gsub('o_auth', 'oauth')
-        end
       end
     end
   end

data/lib/hubspot/exceptions.rb

@@ -1,14 +1,16 @@
 module Hubspot
   class ConfigurationError < StandardError; end
-
-  class InvalidSignatureError < StandardError
-    def initialize(msg: nil, signature: nil, signature_version: nil, hash_result: nil)
-      @signature = signature
+  class InvalidSignatureVersionError < StandardError
+    def initialize(signature_version)
       @signature_version = signature_version
-      @hash_result = hash_result
-      msg = "Invalid signature passed to request" if msg.nil?
+      super("Invalid signature version passed to request: #{@signature_version}")
+    end
+  end
 
-      super(msg)
+  class InvalidSignatureTimestampError < StandardError
+    def initialize(timestamp)
+      @timestamp = timestamp
+      super("Signature timestamp is invalid: #{@timestamp}.")
     end
   end
 end

data/lib/hubspot/helpers/association_type.rb

@@ -0,0 +1,92 @@
+module Hubspot
+  module Helpers
+    class AssociationType
+      PRIMARY_CONTACT_TO_COMPANY = 1
+      PRIMARY_COMPANY_TO_CONTACT = 2
+      DEAL_TO_CONTACT = 3
+      CONTACT_TO_DEAL = 4
+      PRIMARY_DEAL_TO_COMPANY = 5
+      PRIMARY_COMPANY_TO_DEAL = 6
+      CONTACT_TO_TICKET = 15
+      TICKET_TO_CONTACT = 16
+      DEAL_TO_LINE_ITEM = 19
+      LINE_ITEM_TO_DEAL = 20
+      PRIMARY_COMPANY_TO_TICKET = 25
+      PRIMARY_TICKET_TO_COMPANY = 26
+      DEAL_TO_TICKET = 27
+      TICKET_TO_DEAL = 28
+      DEAL_TO_QUOTE = 63
+      QUOTE_TO_DEAL = 64
+      QUOTE_TO_LINE_ITEM = 67
+      LINE_ITEM_TO_QUOTE = 68
+      QUOTE_TO_CONTACT = 69
+      CONTACT_TO_QUOTE = 70
+      QUOTE_TO_COMPANY = 71
+      COMPANY_TO_QUOTE = 72
+      CONTACT_TO_FEEDBACK_SUBMISSION = 97
+      FEEDBACK_SUBMISSION_TO_CONTACT = 98
+      TICKET_TO_FEEDBACK_SUBMISSION = 99
+      FEEDBACK_SUBMISSION_TO_TICKET = 100
+      COMPANY_TO_CALL = 181
+      CALL_TO_COMPANY = 182
+      COMPANY_TO_EMAIL = 185
+      EMAIL_TO_COMPANY = 186
+      COMPANY_TO_MEETING = 187
+      MEETING_TO_COMPANY = 188
+      COMPANY_TO_NOTE = 189
+      NOTE_TO_COMPANY = 190
+      COMPANY_TO_TASK = 191
+      TASK_TO_COMPANY = 192
+      CONTACT_TO_CALL = 193
+      CALL_TO_CONTACT = 194
+      CONTACT_TO_EMAIL = 197
+      EMAIL_TO_CONTACT = 198
+      CONTACT_TO_MEETING = 199
+      MEETING_TO_CONTACT = 200
+      CONTACT_TO_NOTE = 201
+      NOTE_TO_CONTACT = 202
+      CONTACT_TO_TASK = 203
+      TASK_TO_CONTACT = 204
+      DEAL_TO_CALL = 205
+      CALL_TO_DEAL = 206
+      DEAL_TO_EMAIL = 209
+      EMAIL_TO_DEAL = 210
+      DEAL_TO_MEETING = 211
+      MEETING_TO_DEAL = 212
+      DEAL_TO_NOTE = 213
+      NOTE_TO_DEAL = 214
+      DEAL_TO_TASK = 215
+      TASK_TO_DEAL = 216
+      QUOTE_TO_TASK = 217
+      TASK_TO_QUOTE = 218
+      TICKET_TO_CALL = 219
+      CALL_TO_TICKET = 220
+      TICKET_TO_EMAIL = 223
+      EMAIL_TO_TICKET = 224
+      TICKET_TO_MEETING = 225
+      MEETING_TO_TICKET = 226
+      TICKET_TO_NOTE = 227
+      NOTE_TO_TICKET = 228
+      TICKET_TO_TASK = 229
+      TASK_TO_TICKET = 230
+      CONTACT_TO_COMPANY = 279
+      COMPANY_TO_CONTACT = 280
+      TICKET_TO_COMPANY = 339
+      COMPANY_TO_TICKET = 340
+      DEAL_TO_COMPANY = 341
+      COMPANY_TO_DEAL = 342
+      CALL_TO_MEETING = 399
+      MEETING_TO_CALL = 400
+      POSTAL_MAIL_TO_CONTACT = 453
+      CONTACT_TO_POSTAL_MAIL = 454
+      POSTAL_MAIL_TO_TICKET = 455
+      TICKET_TO_POSTAL_MAIL = 456
+      POSTAL_MAIL_TO_DEAL = 457
+      DEAL_TO_POSTAL_MAIL = 458
+      POSTAL_MAIL_TO_COMPANY = 459
+      COMPANY_TO_POSTAL_MAIL = 460
+    end
+  end
+end
+
+

data/lib/hubspot/helpers/camel_case.rb

@@ -2,7 +2,11 @@ module Hubspot
   module Helpers
     class CamelCase
       def format(string)
-        string.split('_').collect(&:capitalize).join
+        if string == 'oauth'
+          'OAuth'
+        else
+          string.split('_').collect(&:capitalize).join
+        end
       end
     end
   end

data/lib/hubspot/helpers/path.rb

@@ -8,12 +8,11 @@ module Hubspot
       end
 
       def require_with_mapping(path)
-        require path.gsub('o_auth', 'oauth')
+        require path
       end
 
       def require_with_codegen_mapping(path)
         require path
-          .gsub('o_auth', 'oauth')
           .gsub('audit_logs/', 'audit-logs/')
           .gsub('blog_posts/', 'blog-posts/')
           .gsub('site_search', 'site-search')

data/lib/hubspot/helpers/signature.rb

@@ -17,7 +17,7 @@ module Hubspot
         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.")
+            raise InvalidSignatureTimestampError.new(timestamp)
           end
         end
         hashed_signature = get_signature(
@@ -54,7 +54,7 @@ module Hubspot
             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}")
+             raise InvalidSignatureVersionError.new(signature_version)
         end
       end
     end

data/lib/hubspot/helpers/snake_case.rb

@@ -2,7 +2,8 @@ module Hubspot
   module Helpers
     class SnakeCase
       def format(string)
-        string.gsub(/::/, '/').
+        string.gsub('OAuth', 'Oauth').
+        gsub(/::/, '/').
         gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
         gsub(/([a-z\d])([A-Z])/,'\1_\2').
         tr("-", "_").

data/lib/hubspot/oauth_helper.rb

@@ -2,15 +2,19 @@ module Hubspot
   class OAuthHelper
     AUTHORIZE_URL = 'https://app.hubspot.com/oauth/authorize'.freeze
     class << self
-      def authorize_url(client_id:, redirect_uri:, scope:, optional_scope: [])
-        query = URI.encode_www_form(
-          client_id: client_id,
-          redirect_uri: redirect_uri,
-          scope: Array(scope),
-          optional_scope: Array(optional_scope)
-        )
+      def authorize_url(client_id, redirect_uri, scopes = nil, optional_scopes = nil, state = nil)
+        query_params = {
+          "client_id" => client_id,
+          "redirect_uri" => redirect_uri
+        }
 
-        "#{AUTHORIZE_URL}?#{query}"
+        query_params["scope"] = scopes.join(' ') if scopes
+        query_params["optional_scope"] = optional_scopes.join(' ') if optional_scopes
+        query_params['state'] ||= state if state
+
+        params = URI.encode_www_form(query_params)
+
+        "#{AUTHORIZE_URL}?#{params}"
       end
     end
   end

data/lib/hubspot/version.rb

@@ -1,3 +1,3 @@
 module Hubspot
-VERSION = '17.0.0-beta.3'
+VERSION = '17.0.0'
 end

data/spec/discovery/client_spec.rb

@@ -11,6 +11,6 @@ describe 'Hubspot::Client' do
   it { is_expected.to respond_to(:events) }
   it { is_expected.to respond_to(:files) }
   it { is_expected.to respond_to(:marketing) }
-  it { is_expected.to respond_to(:o_auth) }
+  it { is_expected.to respond_to(:oauth) }
   it { is_expected.to respond_to(:webhooks) }
 end

data/spec/discovery/oauth/access_tokens_api_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'Hubspot::Discovery::OAuth::AccessTokensApi' do
-  subject(:api) { Hubspot::Client.new(access_token: 'test').o_auth.access_tokens_api }
+  subject(:api) { Hubspot::Client.new(access_token: 'test').oauth.access_tokens_api }
   
   it { is_expected.to respond_to(:get) }
 end

data/spec/discovery/oauth/refresh_tokens_api_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'Hubspot::Discovery::OAuth::RefreshTokensApi' do
-  subject(:api) { Hubspot::Client.new(access_token: 'test').o_auth.refresh_tokens_api }
+  subject(:api) { Hubspot::Client.new(access_token: 'test').oauth.refresh_tokens_api }
   
   it { is_expected.to respond_to(:archive) }
   it { is_expected.to respond_to(:get) }

data/spec/discovery/oauth/tokens_api_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'Hubspot::Discovery::OAuth::TokensApi' do
-  subject(:api) { Hubspot::Client.new(access_token: 'test').o_auth.tokens_api }
+  subject(:api) { Hubspot::Client.new(access_token: 'test').oauth.tokens_api }
   
   it { is_expected.to respond_to(:create) }
 end

data/spec/helpers/authorize_url_spec.rb

@@ -0,0 +1,75 @@
+require 'uri'
+require 'rspec'
+
+require_relative "../../lib/hubspot/oauth_helper"
+
+describe 'get_auth_url' do
+  AUTHORIZE_URL = 'https://app.hubspot.com/oauth/authorize'
+
+  let(:data) do
+    {
+      client_id: 'client_id',
+      redirect_uri: 'http://localhost',
+      scope: ['contacts', 'timeline'],
+      optional_scope: ['scope1', 'scope3']
+    }
+  end
+
+  it 'returns the correct URL with empty scope' do
+    expected_params = {
+      client_id: data[:client_id],
+      redirect_uri: data[:redirect_uri]
+    }
+    expected_url = "#{AUTHORIZE_URL}?#{URI.encode_www_form(expected_params)}"
+
+    result = Hubspot::OAuthHelper.authorize_url(data[:client_id], data[:redirect_uri])
+
+    expect(result).to eq(expected_url)
+  end
+
+  it 'returns the correct URL with scope' do
+    expected_params = {
+      client_id: data[:client_id],
+      redirect_uri: data[:redirect_uri],
+      scope: data[:scope].join(' ')
+    }
+    expected_url = "#{AUTHORIZE_URL}?#{URI.encode_www_form(expected_params)}"
+
+    result = Hubspot::OAuthHelper.authorize_url(data[:client_id], data[:redirect_uri], data[:scope])
+
+    expect(result).to eq(expected_url)
+  end
+
+  it 'returns the correct URL with optional_scope' do
+    expected_params = {
+      client_id: data[:client_id],
+      redirect_uri: data[:redirect_uri],
+      scope: data[:optional_scope].join(' ')
+    }
+    expected_url = "#{AUTHORIZE_URL}?#{URI.encode_www_form(expected_params)}"
+
+    result = Hubspot::OAuthHelper.authorize_url(data[:client_id], data[:redirect_uri], data[:optional_scope])
+
+    expect(result).to eq(expected_url)
+  end
+  it 'returns the correct URL' do
+    expected_params = {
+      client_id: data[:client_id],
+      redirect_uri: data[:redirect_uri],
+      scope: data[:scope].join(' '),
+      optional_scope: data[:optional_scope].join(' '),
+      state: "test_state"
+    }
+    expected_url = "#{AUTHORIZE_URL}?#{URI.encode_www_form(expected_params)}"
+
+    result = Hubspot::OAuthHelper.authorize_url(
+      data[:client_id],
+      data[:redirect_uri],
+      data[:scope],
+      data[:optional_scope],
+      "test_state"
+    )
+
+    expect(result).to eq(expected_url)
+  end
+end

data/spec/helpers/signature_spec.rb

@@ -1,5 +1,6 @@
 require 'date'
 require_relative "../../lib/hubspot/helpers/signature"
+require_relative "../../lib/hubspot/exceptions"
 
 TEST_DATA = {
   :client_secret=> "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
@@ -49,7 +50,7 @@ describe "Hubspot::Helpers::Signature.get_signature" do
       client_secret: TEST_DATA[:client_secret],
       request_body: TEST_DATA[:request_body],
       signature_version: "wrong_signature_version"
-    ) }.to raise_error(StandardError)
+    ) }.to raise_error(Hubspot::InvalidSignatureVersionError)
     end
 
 end
@@ -102,7 +103,7 @@ describe "Hubspot::Helpers::Signature.is_valid" do
       request_body: TEST_DATA[:request_body],
       http_uri: TEST_DATA[:http_uri],
       signature_version: "v3"
-    ) }.to raise_error(StandardError)
+    ) }.to raise_error(Hubspot::InvalidSignatureTimestampError)
   end
   it "should raise exception if :signature_version=>v3 and :timestamp=>wrong_timestamp" do
     expect {  signature.is_valid(
@@ -112,6 +113,6 @@ describe "Hubspot::Helpers::Signature.is_valid" do
       http_uri: TEST_DATA[:http_uri],
       timestamp: "wrong_timestamp",
       signature_version: "v3"
-    ) }.to raise_error(StandardError)
+    ) }.to raise_error(Hubspot::InvalidSignatureTimestampError)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot-api-client
 version: !ruby/object:Gem::Version
-  version: 17.0.0.pre.beta.3
+  version: 17.0.0
 platform: ruby
 authors:
 - HubSpot
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1783,12 +1783,12 @@ files:
 - lib/hubspot/discovery/webhooks/api/subscriptions_api.rb
 - lib/hubspot/discovery/webhooks/client.rb
 - lib/hubspot/exceptions.rb
+- lib/hubspot/helpers/association_type.rb
 - 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
 - lib/hubspot/version.rb
 - spec/discovery/automation/actions/callbacks_api_spec.rb
@@ -1939,6 +1939,7 @@ 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/authorize_url_spec.rb
 - spec/helpers/camel_case_spec.rb
 - spec/helpers/signature_spec.rb
 - spec/spec_helper.rb
@@ -1957,9 +1958,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.3
 signing_key:
@@ -2114,6 +2115,7 @@ 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/authorize_url_spec.rb
 - spec/helpers/signature_spec.rb
 - spec/helpers/camel_case_spec.rb
 - spec/spec_helper.rb

data/lib/hubspot/helpers/webhooks_helper.rb

@@ -1,32 +0,0 @@
-# @deprecated
-module Hubspot
-  module Helpers
-    class WebhooksHelper
-      def self.validate_signature(
-        signature:,
-        client_secret:,
-        http_uri:,
-        request_body:,
-        http_method: 'POST',
-        signature_version: 'v2'
-      )
-
-        if signature_version == 'v1'
-          source_string = client_secret + request_body.to_s
-        else
-          source_string = client_secret + http_method + http_uri + request_body.to_s
-        end
-
-        hash_result = Digest::SHA2.hexdigest(source_string.encode('utf-8'))
-
-        if hash_result != signature
-          raise InvalidSignatureError.new(
-            signature: signature,
-            signature_version: signature_version,
-            hash_result: hash_result
-          )
-        end
-      end
-    end
-  end
-end