hubspot-api-client 16.1.1 → 16.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab1a325bccd8f06760d9b2f7149517c100ff5e1504df7ebbf46137bfd8076633
-  data.tar.gz: a7fabc27a9272be1b7750e4f4ff23294bf9a6b927539ef5c1877df42d6f868b1
+  metadata.gz: 9a6993298296b428873f8f86f587f92e2b18adf83ee04ac71d9cd86d9afab75b
+  data.tar.gz: 5251f556603bd39e792c1ca547ad1579ef49aaff70a16ed5f9c041e0d0cdeeaa
 SHA512:
-  metadata.gz: d5ee0a0ed6eb7dd47c14259eaaeea1c1cef382158d85e8467eada47bd7419502c49b3234c5498a1d4c62b0b8101ec948706aedaf99f9b23268c36a61aec7e34f
-  data.tar.gz: 54946b4829ccde4b96309e02a740f3e86fb907718392e3274157eb237101869ccd94a386def9f89265bc7b2fcba13e126e93f6b131ff3af19312f96bca9a9e14
+  metadata.gz: c2c69d897384df239639611305f031c59dfe574c9539f26605e014a140d52276084d6801858dc1676cb984c73e64dd5fd1e5b9adf926c99afd0bcd017f42535a
+  data.tar.gz: f65599a6db559b53f46c5125c699736d126568169c12985d4d7667022d94015b6802e625e89fdf812704d05d246ba3f7a0f448efb8a342d4c77ab93f82a13c4d

data/CHANGELOG.md

@@ -5,7 +5,17 @@ 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/v16.1.1...HEAD)
+## [Unreleased](https://github.com/HubSpot/hubspot-api-ruby/compare/v16.2.0...HEAD)
+
+
+## [16.2.0] - 2023-01-09
+### Added
+
+- Signature's util 'HubSpot.utils.signature'
+
+### Deprecated
+
+- webhook's util 'HubSpot.utils.webhooks'
 
 ## [16.1.1] - 2022-12-23
 ### Fixed

data/Gemfile

@@ -4,4 +4,5 @@ gemspec
 
 group :development, :test do
   gem 'rake', '~> 12.3.3'
+  gem 'openssl'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot-api-client (16.1.1)
+    hubspot-api-client (16.2.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.4.0)
 
@@ -25,6 +25,7 @@ GEM
     hashdiff (1.0.1)
     json (2.6.2)
     method_source (1.0.0)
+    openssl (3.1.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -62,6 +63,7 @@ DEPENDENCIES
   autotest-growl (~> 0.2, >= 0.2.16)
   autotest-rails-pure (~> 4.1, >= 4.1.2)
   hubspot-api-client!
+  openssl
   pry (~> 0.14)
   rake (~> 12.3.3)
   rake-release (~> 1.3)

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.0'
+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.0
 platform: ruby
 authors:
 - HubSpot
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2023-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1655,6 +1655,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
@@ -1805,6 +1806,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:
@@ -1976,4 +1979,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