Merge pull request #237 from HubSpot/feature/add_custom_exceptions

 add custom exceptions for signature

Author: alzheltkovskiy-hubspot

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

lib/hubspot/helpers/signature.rb

@@ -17,7 +17,7 @@ def is_valid(
         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 @@ def get_signature(
             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

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 @@
       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 @@
       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 @@
       http_uri: TEST_DATA[:http_uri],
       timestamp: "wrong_timestamp",
       signature_version: "v3"
-    ) }.to raise_error(StandardError)
+    ) }.to raise_error(Hubspot::InvalidSignatureTimestampError)
   end
 end