feat: Add multi-auth support to Messages and Verify2 (#345)

* Adding Basic auth support to Messages and Verify2

* Initial update to README

* Updating Basic and JWT sections of the README

* Updating Sig Auth section of README

* Adding multi-auth section to README

* Updating menu links

Author: superchilled

README.md

@@ -0,0 +1,18 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class BasicAndBearerToken < AbstractAuthentication
+    def update(object, data)
+      return unless object.is_a?(Net::HTTPRequest)
+
+      if @config.authentication_preference == :basic
+        object.basic_auth(@config.api_key, @config.api_secret)
+      else
+        object['Authorization'] = 'Bearer ' + @config.token
+      end
+    end
+  end
+
+  private_constant :BasicAndBearerToken
+end

lib/vonage/basic_and_bearer_token.rb

@@ -18,5 +18,5 @@ def update(object, data)
     end
   end
 
-  private_constant :Basic
+  private_constant :BasicAndSignature
 end

lib/vonage/basic_and_signature.rb

@@ -6,7 +6,7 @@ module Vonage
   class Messaging < Namespace
     extend Forwardable
 
-    self.authentication = BearerToken
+    self.authentication = BasicAndBearerToken
 
     self.request_body = JSON
 

lib/vonage/messaging.rb

@@ -3,7 +3,7 @@
 
 module Vonage
   class Verify2 < Namespace
-    self.authentication = BearerToken
+    self.authentication = BasicAndBearerToken
 
     self.request_body = JSON
 

lib/vonage/verify2.rb

@@ -5,7 +5,7 @@ module Vonage
   class Verify2::TemplateFragments < Namespace
     CHANNELS = ['sms', 'voice'].freeze
 
-    self.authentication = BearerToken
+    self.authentication = BasicAndBearerToken
 
     self.request_body = JSON
 

lib/vonage/verify2/template_fragments.rb

@@ -3,7 +3,7 @@
 
 module Vonage
   class Verify2::Templates < Namespace
-    self.authentication = BearerToken
+    self.authentication = BasicAndBearerToken
 
     self.request_body = JSON
 

lib/vonage/verify2/templates.rb

@@ -6,6 +6,17 @@ def messaging
     Vonage::Messaging.new(config)
   end
 
+  def messaging_with_basic_auth
+    config = Vonage::Config.new.merge(
+      {
+        api_key: api_key,
+        api_secret: api_secret,
+        authentication_preference: :basic
+      }
+    )
+    Vonage::Messaging.new(config)
+  end
+
   def geo_specific_messaging_host
     'api-eu.vonage.com'
   end
@@ -80,6 +91,22 @@ def test_send_method_with_optional_params
     assert_kind_of Vonage::Response, messaging.send(to: "447700900000", from: "447700900001", **message)
   end
 
+  def test_send_method_with_basic_authentication
+    params = {
+      to: "447700900000",
+      from: "447700900001",
+      channel: "sms",
+      message_type: "text",
+      text: "Hello world!"
+    }
+
+    stub_request(:post, messaging_uri).with(request(body: params, auth_method: basic_authorization)).to_return(response)
+
+    message = messaging_with_basic_auth.sms(message: "Hello world!")
+
+    assert_kind_of Vonage::Response, messaging_with_basic_auth.send(to: "447700900000", from: "447700900001", **message)
+  end
+
   def test_send_method_without_to
     assert_raises(ArgumentError) { messaging.send(from: "447700900001", channel: 'sms', message_type: 'text', text: "Hello world!") }
   end

test/vonage/messaging_test.rb

@@ -112,8 +112,8 @@ def vonage_host
       "api-eu.vonage.com"
     end
 
-    def request(body: nil, query: nil, headers: {})
-      headers['Authorization'] = authorization
+    def request(body: nil, query: nil, headers: {}, auth_method: nil)
+      headers['Authorization'] = auth_method || authorization
       if body
         headers['Content-Type'] = 'application/json' unless headers.has_key?('Content-Type')
       end

test/vonage/test.rb

@@ -5,6 +5,17 @@ def template_fragments
     Vonage::Verify2::TemplateFragments.new(config)
   end
 
+  def template_fragments_with_basic_auth
+    config = Vonage::Config.new.merge(
+      {
+        api_key: api_key,
+        api_secret: api_secret,
+        authentication_preference: :basic
+      }
+    )
+    Vonage::Verify2::TemplateFragments.new(config)
+  end
+
   def template_id
     '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9'
   end
@@ -43,6 +54,15 @@ def test_list_method_with_optional_params
     template_fragments_list.each { |template_fragment| assert_kind_of Vonage::Entity, template_fragment }
   end
 
+  def test_list_method_with_basic_authentication
+    stub_request(:get, template_fragments_uri).with(request(auth_method: basic_authorization)).to_return(template_fragments_list_response)
+
+    template_fragments_list = template_fragments_with_basic_auth.list(template_id: template_id)
+
+    assert_kind_of Vonage::Verify2::TemplateFragments::ListResponse, template_fragments_list
+    template_fragments_list.each { |template_fragment| assert_kind_of Vonage::Entity, template_fragment }
+  end
+
   def test_list_method_without_template_id
     assert_raises(ArgumentError) { template_fragments.list }
   end
@@ -53,6 +73,12 @@ def test_info_method
     assert_kind_of Vonage::Response, template_fragments.info(template_id: template_id, template_fragment_id: template_fragment_id)
   end
 
+  def test_info_method_with_basic_authentication
+    stub_request(:get, template_fragment_uri).with(request(auth_method: basic_authorization)).to_return(response)
+
+    assert_kind_of Vonage::Response, template_fragments_with_basic_auth.info(template_id: template_id, template_fragment_id: template_fragment_id)
+  end
+
   def test_info_method_without_template_id
     assert_raises(ArgumentError) { template_fragments.info(template_fragment_id: template_fragment_id) }
   end
@@ -67,6 +93,12 @@ def test_create_method
     assert_kind_of Vonage::Response, template_fragments.create(template_id: template_id, channel: 'sms', locale: 'en-gb', text: 'Code: ${code}')
   end
 
+  def test_create_method_with_basic_authentication
+    stub_request(:post, template_fragments_uri).with(request(body: { channel: 'sms', locale: 'en-gb', text: 'Code: ${code}' }, auth_method: basic_authorization)).to_return(response)
+
+    assert_kind_of Vonage::Response, template_fragments_with_basic_auth.create(template_id: template_id, channel: 'sms', locale: 'en-gb', text: 'Code: ${code}')
+  end
+
   def test_create_method_without_template_id
     assert_raises(ArgumentError) { template_fragments.create(channel: 'sms', locale: 'en-gb', text: 'Code: ${code}') }
   end
@@ -93,6 +125,12 @@ def test_update_method
     assert_kind_of Vonage::Response, template_fragments.update(template_id: template_id, template_fragment_id: template_fragment_id, text: 'Your code is: ${code}')
   end
 
+  def test_update_method_with_basic_authentication
+    stub_request(:patch, template_fragment_uri).with(request(body: { text: 'Your code is: ${code}' }, auth_method: basic_authorization)).to_return(response)
+
+    assert_kind_of Vonage::Response, template_fragments_with_basic_auth.update(template_id: template_id, template_fragment_id: template_fragment_id, text: 'Your code is: ${code}')
+  end
+
   def test_update_method_without_template_id
     assert_raises(ArgumentError) { template_fragments.update(template_fragment_id: template_fragment_id, text: 'Your code is: ${code}') }
   end
@@ -111,6 +149,12 @@ def test_delete_method
     assert_kind_of Vonage::Response, template_fragments.delete(template_id: template_id, template_fragment_id: template_fragment_id)
   end
 
+  def test_delete_method_with_basic_authentication
+    stub_request(:delete, template_fragment_uri).with(request(auth_method: basic_authorization)).to_return(response)
+
+    assert_kind_of Vonage::Response, template_fragments_with_basic_auth.delete(template_id: template_id, template_fragment_id: template_fragment_id)
+  end
+
   def test_delete_method_without_template_id
     assert_raises(ArgumentError) { template_fragments.delete(template_fragment_id: template_fragment_id) }
   end