Updating network number verification implementation

Author: superchilled

lib/vonage/keys.rb

@@ -36,6 +36,7 @@ def camelcase(hash)
         'status_callback_url',
         'audio_rate',
         'phone_number',
+        'hashed_phone_number',
         'max_age'
       ]
       hash.transform_keys do |k|

lib/vonage/namespace.rb

@@ -80,7 +80,7 @@ def build_request(path:, type: Get, params: {}, auth_data: nil)
       request["Accept"] = "application/json"
       self.class.request_headers.each { |key, value| request[key] = value }
 
-      # Set BearerToken if needed
+      # Set Authorization header if needed
       authentication.update(request, auth_data)
 
       # set body
@@ -156,7 +156,7 @@ def multipart_post_request(path, filepath:, file_name:, mime_type:, params: {},
 
         request['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
 
-        # Set BearerToken if needed
+        # Set Authorization header if needed
         authentication.update(request, auth_data) unless no_auth
 
         logger.log_request_info(request)

lib/vonage/network_number_verification.rb

@@ -34,6 +34,10 @@ class NetworkNumberVerification < Namespace
     def verify(phone_number:, auth_data:, hashed: false)
       raise ArgumentError.new("`phone_number` must be in E.164 format") unless Phonelib.parse(phone_number).valid? || hashed == true
       raise ArgumentError.new("`phone_number` must be prepended with a `+`") unless phone_number.start_with?('+') || hashed == true
+      raise ArgumentError.new("`auth_data` must contain key `:oidc_auth_code`") unless auth_data.has_key?(:oidc_auth_code)
+      raise ArgumentError.new("`auth_data[:oidc_auth_code]` must be a String") unless auth_data[:oidc_auth_code].is_a?(String)
+      raise ArgumentError.new("`auth_data` must contain key `:redirect_uri`") unless auth_data.has_key?(:redirect_uri)
+      raise ArgumentError.new("`auth_data[:redirect_uri]` must be a String") unless auth_data[:redirect_uri].is_a?(String)
 
       params = {phone_number: phone_number}
       params[:hashed_phone_number] = params.delete(:phone_number) if hashed == true

test/vonage/network_number_verification_test.rb

@@ -0,0 +1,153 @@
+# typed: false
+require_relative './test'
+
+class Vonage::NetworkNumberVerificationTest < Vonage::Test
+  def network_number_verification
+    Vonage::NetworkNumberVerification.new(config)
+  end
+
+  def uri
+    'https://api-eu.vonage.com/camara/number-verification/v031'
+  end
+
+  def phone_number
+    '+447900000000'
+  end
+
+  def hashed_phone_number
+    '32f67ab4e4312618b09cd23ed8ce41b13e095fe52b73b2e8da8ef49830e50dba'
+  end
+
+  def example_redirect_uri
+    'https://example.com/callback'
+  end
+
+  def example_oidc_auth_code
+    '0dadaeb4-7c79-4d39-b4b0-5a6cc08bf537'
+  end
+
+  def test_verify_method
+    request_access_token_request_params = {
+      grant_type: 'authorization_code',
+      code: example_oidc_auth_code,
+      redirect_uri: example_redirect_uri
+    }
+
+    number_verification_verify_params = {phoneNumber: phone_number}
+
+    stub_request(:post, "https://api-eu.vonage.com/oauth2/token").with(request(body: request_access_token_request_params, headers: headers)).to_return(network_authentication_token_response)
+    stub_request(:post, uri + '/verify').with(body: number_verification_verify_params).to_return(response)
+
+    response = network_number_verification.verify(
+      phone_number: phone_number,
+      auth_data: {
+        oidc_auth_code: example_oidc_auth_code,
+        redirect_uri: example_redirect_uri
+      }
+    )
+
+    assert_kind_of Vonage::Response, response
+  end
+
+  def test_verify_method_with_hashed_phone_number
+    request_access_token_request_params = {
+      grant_type: 'authorization_code',
+      code: example_oidc_auth_code,
+      redirect_uri: example_redirect_uri
+    }
+
+    number_verification_verify_params = {hashedPhoneNumber: hashed_phone_number}
+
+    stub_request(:post, "https://api-eu.vonage.com/oauth2/token").with(request(body: request_access_token_request_params, headers: headers)).to_return(network_authentication_token_response)
+    stub_request(:post, uri + '/verify').with(body: number_verification_verify_params).to_return(response)
+
+    response = network_number_verification.verify(
+      phone_number: hashed_phone_number,
+      hashed: true,
+      auth_data: {
+        oidc_auth_code: example_oidc_auth_code,
+        redirect_uri: example_redirect_uri
+      }
+    )
+
+    assert_kind_of Vonage::Response, response
+  end
+
+  def test_check_method_without_phone_number
+    assert_raises(ArgumentError) do
+      network_number_verification.verify(
+      auth_data: {
+        oidc_auth_code: example_oidc_auth_code,
+        redirect_uri: example_redirect_uri
+      }
+    )
+    end
+  end
+
+  def test_check_method_with_invalid_phone_number
+    auth_data = {
+      oidc_auth_code: example_oidc_auth_code,
+      redirect_uri: example_redirect_uri
+    }
+
+    assert_raises(TypeError) { network_number_verification.verify(phone_number: 447904603505, auth_data: auth_data) }
+    assert_raises(ArgumentError) { network_number_verification.verify(phone_number: '07904603505', auth_data: auth_data) }
+    assert_raises(ArgumentError) { network_number_verification.verify(phone_number: '447904603505', auth_data: auth_data) }
+  end
+
+  def test_check_method_with_invalid_hashed
+    auth_data = {
+      oidc_auth_code: example_oidc_auth_code,
+      redirect_uri: example_redirect_uri
+    }
+
+    assert_raises(TypeError) { network_number_verification.verify(phone_number: hashed_phone_number, auth_data: auth_data, hashed: 'true') }
+  end
+
+  def test_check_method_without_auth_data
+    assert_raises(ArgumentError) { network_number_verification.verify(phone_number: phone_number) }
+  end
+
+  def test_check_method_with_invalid_auth_data
+    auth_data = [
+      example_oidc_auth_code,
+      example_redirect_uri
+    ]
+
+    assert_raises(TypeError) { network_number_verification.verify(phone_number: phone_number, auth_data: auth_data) }
+  end
+
+  def test_check_method_without_oidc_auth_code
+    auth_data = {
+      redirect_uri: example_redirect_uri
+    }
+
+    assert_raises(ArgumentError) { network_number_verification.verify(phone_number: phone_number, auth_data: auth_data) }
+  end
+
+  def test_check_method_with_invalid_oidc_auth_code
+    auth_data = {
+      oidc_auth_code: 12345,
+      redirect_uri: example_redirect_uri
+    }
+
+    assert_raises(ArgumentError) { network_number_verification.verify(phone_number: phone_number, auth_data: auth_data) }
+  end
+
+  def test_check_method_without_redirect_uri
+    auth_data = {
+      oidc_auth_code: example_oidc_auth_code
+    }
+
+    assert_raises(ArgumentError) { network_number_verification.verify(phone_number: phone_number, auth_data: auth_data) }
+  end
+
+  def test_check_method_with_invalid_redirect_uri
+    auth_data = {
+      oidc_auth_code: example_oidc_auth_code,
+      redirect_uri: 12345
+    }
+
+    assert_raises(ArgumentError) { network_number_verification.verify(phone_number: phone_number, auth_data: auth_data) }
+  end
+end