vonage 7.8.2 → 7.36.0

data/lib/vonage/namespace.rb

@@ -1,6 +1,9 @@
 # typed: true
 # frozen_string_literal: true
+
 require 'net/http'
+require 'net/http/persistent'
+require 'net/http/post/multipart'
 require 'json'
 
 module Vonage
@@ -8,10 +11,9 @@ module Vonage
     def initialize(config)
       @config = config
 
-      @host = self.class.host == :api_host ? @config.api_host : @config.rest_host
+      @host = set_host
 
-      @http = Net::HTTP.new(@host, Net::HTTP.https_default_port, p_addr = nil)
-      @http.use_ssl = true
+      @http = Net::HTTP::Persistent.new
 
       @config.http.set(@http) unless @config.http.nil?
     end
@@ -21,8 +23,7 @@ module Vonage
     end
 
     def self.host=(host)
-      raise ArgumentError unless host == :rest_host
-
+      raise ArgumentError unless %i[rest_host video_host vonage_host].include?(host)
       @host = host
     end
 
@@ -47,40 +48,42 @@ module Vonage
     end
 
     protected
+
     # :nocov:
 
     Get = Net::HTTP::Get
     Put = Net::HTTP::Put
+    Patch = Net::HTTP::Patch
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 
-    def build_request(path:, type: Get, params: {})
+    def build_request(path:, type: Get, params: {}, auth_data: nil)
       authentication = self.class.authentication.new(@config)
-      authentication.update(params)
+      authentication.update(params, auth_data)
 
-      uri = URI('https://' + @host + path)
+      uri = URI("https://" + @host + path)
       unless type.const_get(:REQUEST_HAS_BODY) || params.empty?
         uri.query = Params.encode(params)
       end
 
-      # Set BasicAuth if neeeded
-      authentication.update(uri)
-
       # instantiate request
       request = type.new(uri)
 
       # set headers
-      request['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
-      request['Accept'] = 'application/json'
-      self.class.request_headers.each do |key, value|
-        request[key] = value
-      end
+      request["User-Agent"] = UserAgent.string(
+        @config.app_name,
+        @config.app_version
+      )
+      request["Accept"] = "application/json"
+      self.class.request_headers.each { |key, value| request[key] = value }
 
-      # Set BearerToken if needed
-      authentication.update(request)
+      # Set Authorization header if needed
+      authentication.update(request, auth_data)
 
       # set body
-      self.class.request_body.update(request, params) if type.const_get(:REQUEST_HAS_BODY)
+      if type.const_get(:REQUEST_HAS_BODY)
+        self.class.request_body.update(request, params)
+      end
 
       request
     end
@@ -88,7 +91,8 @@ module Vonage
     def make_request!(request, &block)
       logger.log_request_info(request)
 
-      response = @http.request(request, &block)
+      uri = URI("https://" + @host + request.path)
+      response = @http.request(uri, request, &block)
 
       logger.log_response_info(response, @host)
 
@@ -99,17 +103,32 @@ module Vonage
       response
     end
 
-    def request(path, params: nil, type: Get, response_class: Response, &block)
-      auto_advance = !params.nil? && params.key?(:auto_advance) ? params[:auto_advance] : false
+    def request(path, params: nil, type: Get, response_class: Response, auth_data: nil, &block)
+      auto_advance =
+        (
+          if !params.nil? && params.key?(:auto_advance)
+            params[:auto_advance]
+          else
+            false
+          end
+        )
 
-      params = params.tap { |params| params.delete(:auto_advance) } if !params.nil? && params.key?(:auto_advance)
+      params =
+        params.tap { |params| params.delete(:auto_advance) } if !params.nil? &&
+        params.key?(:auto_advance)
 
-      request = build_request(path: path, params: params || {}, type: type)
+      request = build_request(path: path, params: params || {}, type: type, auth_data: auth_data)
 
       response = make_request!(request, &block)
 
       if auto_advance
-        iterable_request(path, response: response, response_class: response_class, params: params, &block)
+        iterable_request(
+          path,
+          response: response,
+          response_class: response_class,
+          params: params,
+          &block
+        )
       else
         return if block
 
@@ -117,22 +136,59 @@ module Vonage
       end
     end
 
+    def multipart_post_request(path, filepath:, file_name:, mime_type:, params: {}, override_uri: nil, no_auth: false, response_class: Response, auth_data: nil, &block)
+      authentication = self.class.authentication.new(@config) unless no_auth
+
+      uri = override_uri ? URI(override_uri) : URI('https://' + @host + path)
+
+      http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port, p_addr = nil)
+      http.use_ssl = true
+      http.set_debug_output($stdout)
+
+      response = File.open(filepath) do |file|
+        request = Net::HTTP::Post::Multipart.new(
+          uri,
+          params.merge(file: Multipart::Post::UploadIO.new(file, mime_type, file_name))
+        )
+
+        request['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
+
+        # Set Authorization header if needed
+        authentication.update(request, auth_data) unless no_auth
+
+        logger.log_request_info(request)
+
+        http.request(request, &block)
+      end
+
+      logger.log_response_info(response, @host)
+
+      return if block
+
+      logger.debug(response.body) if response.body
+
+      parse(response, response_class)
+    end
+
     def iterable_request(path, response: nil, response_class: nil, params: {}, &block)
       json_response = ::JSON.parse(response.body)
       response = parse(response, response_class)
       remainder = remaining_count(json_response)
 
       while remainder > 0
-        params = { page_size: json_response['page_size'] }
-
-        if json_response['record_index'] && json_response['record_index'] == 0
-          params[:record_index] = json_response['page_size']
-        elsif json_response['record_index'] && json_response['record_index'] != 0
-          params[:record_index] = (json_response['record_index'] + json_response['page_size'])
+        params = { page_size: json_response["page_size"] }
+
+        if json_response["record_index"] && json_response["record_index"] == 0
+          params[:record_index] = json_response["page_size"]
+        elsif json_response["record_index"] &&
+              json_response["record_index"] != 0
+          params[:record_index] = (
+            json_response["record_index"] + json_response["page_size"]
+          )
         end
 
-        if json_response['total_pages']
-          params[:page] = json_response['page'] + 1
+        if json_response["total_pages"]
+          params[:page] = json_response["page"] + 1
         end
 
         request = build_request(path: path, type: Get, params: params)
@@ -143,11 +199,15 @@ module Vonage
         json_response = ::JSON.parse(paginated_response.body)
         remainder = remaining_count(json_response)
 
-        if response.respond_to?('_embedded')
-          collection_name = collection_name(response['_embedded'])
-          response['_embedded'][collection_name].push(*next_response['_embedded'][collection_name])
+        if response.respond_to?("_embedded")
+          collection_name = collection_name(response["_embedded"])
+          response["_embedded"][collection_name].push(
+            *next_response["_embedded"][collection_name]
+          )
         else
-          response[collection_name(response)].push(*next_response[collection_name(next_response)])
+          response[collection_name(response)].push(
+            *next_response[collection_name(next_response)]
+          )
         end
       end
 
@@ -155,43 +215,51 @@ module Vonage
     end
 
     def remaining_count(params)
-      if params.key?('total_pages')
-        params['total_pages'] - params['page']
-      elsif params.key?('count')
-        params['count'] - (params['record_index'] == 0 ? params['page_size'] : (params['record_index'] + params['page_size']))
+      if params.key?("total_pages")
+        params["total_pages"] - params["page"]
+      elsif params.key?("count")
+        params["count"] -
+          (
+            if params["record_index"] == 0
+              params["page_size"]
+            else
+              (params["record_index"] + params["page_size"])
+            end
+          )
       else
         0
       end
     end
 
     def collection_name(params)
-      @collection_name ||= case
-        when params.respond_to?('calls')
-          'calls'
-        when params.respond_to?('users')
-          'users'
-        when params.respond_to?('legs')
-          'legs'
-        when params.respond_to?('data')
-          'data'
-        when params.respond_to?('conversations')
-          'conversations'
-        when params.respond_to?('applications')
-          'applications'
-        when params.respond_to?('records')
-          'records'
-        when params.respond_to?('reports')
-          'reports'
-        when params.respond_to?('networks')
-          'networks'
-        when params.respond_to?('countries')
-          'countries'
-        when params.respond_to?('media')
-          'media'
-        when params.respond_to?('numbers')
-          'numbers'
-        when params.respond_to?('events')
-          'events'
+      @collection_name ||=
+        case
+        when params.respond_to?("calls")
+          "calls"
+        when params.respond_to?("users")
+          "users"
+        when params.respond_to?("legs")
+          "legs"
+        when params.respond_to?("data")
+          "data"
+        when params.respond_to?("conversations")
+          "conversations"
+        when params.respond_to?("applications")
+          "applications"
+        when params.respond_to?("records")
+          "records"
+        when params.respond_to?("reports")
+          "reports"
+        when params.respond_to?("networks")
+          "networks"
+        when params.respond_to?("countries")
+          "countries"
+        when params.respond_to?("media")
+          "media"
+        when params.respond_to?("numbers")
+          "numbers"
+        when params.respond_to?("events")
+          "events"
         else
           params.entity.attributes.keys[0].to_s
         end
@@ -202,7 +270,7 @@ module Vonage
       when Net::HTTPNoContent
         response_class.new(nil, response)
       when Net::HTTPSuccess
-        if response['Content-Type'].split(';').first == 'application/json'
+        if response['Content-Type'] && response['Content-Type'].split(';').first == 'application/json' && !response.body.empty?
           entity = ::JSON.parse(response.body, object_class: Vonage::Entity)
 
           response_class.new(entity, response)
@@ -217,6 +285,21 @@ module Vonage
     def logger
       @config.logger
     end
+
+    private
+
+    def set_host
+      case self.class.host
+      when :rest_host
+        @config.rest_host
+      when :video_host
+        @config.video_host
+      when :vonage_host
+        @config.vonage_host
+      else
+        @config.api_host
+      end
+    end
   end
 
   private_constant :Namespace

data/lib/vonage/network_authentication/client_authentication.rb

@@ -0,0 +1,39 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class NetworkAuthentication::ClientAuthentication < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.host = :vonage_host
+
+    self.request_headers['Content-Type'] = 'application/x-www-form-urlencoded'
+
+    def token(oidc_auth_code:, redirect_uri:, **params)
+      request(
+        '/oauth2/token',
+        params: {
+          grant_type: 'authorization_code',
+          code: oidc_auth_code,
+          redirect_uri: redirect_uri
+        },
+        type: Post
+      ).access_token
+    end
+
+    def generate_oidc_uri(purpose:, api_scope:, login_hint:, redirect_uri:, state:)
+      scope = "openid%20dpv:#{purpose}%23#{api_scope}"
+      uri = "https://oidc.idp.vonage.com/oauth2/auth?" +
+        "client_id=#{@config.application_id}" +
+        "&response_type=code" +
+        "&scope=#{scope}" +
+        "&login_hint=#{login_hint}" +
+        "&redirect_uri=#{redirect_uri}" +
+        "&state=#{state}"
+
+      uri
+    end
+  end
+end

data/lib/vonage/network_authentication/server_authentication.rb

@@ -0,0 +1,47 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class NetworkAuthentication::ServerAuthentication < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.host = :vonage_host
+
+    self.request_headers['Content-Type'] = 'application/x-www-form-urlencoded'
+
+    def token(purpose:, api_scope:, login_hint:, **params)
+      auth_req_id = bc_authorize(
+        purpose: purpose,
+        api_scope: api_scope,
+        login_hint: login_hint
+      ).auth_req_id
+
+      request_access_token(auth_req_id: auth_req_id).access_token
+    end
+
+    def bc_authorize(purpose:, api_scope:, login_hint:)
+      scope = "openid dpv:#{purpose}##{api_scope}"
+      request(
+        "/oauth2/bc-authorize",
+        params: {
+          scope: scope,
+          login_hint: login_hint
+        },
+        type: Post
+      )
+    end
+
+    def request_access_token(auth_req_id:)
+      request(
+        "/oauth2/token",
+        params: {
+          grant_type: 'urn:openid:params:grant-type:ciba',
+          auth_req_id: auth_req_id
+        },
+        type: Post
+      )
+    end
+  end
+end

data/lib/vonage/network_authentication.rb

@@ -0,0 +1,22 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class NetworkAuthentication < AbstractAuthentication
+    def update(object, data)
+      return unless object.is_a?(Net::HTTPRequest)
+
+      token = self.public_send(data[:auth_flow]).token(**data)
+
+      object['Authorization'] = 'Bearer ' + token
+    end
+
+    def client_authentication
+      @client_authentication ||= ClientAuthentication.new(@config)
+    end
+
+    def server_authentication
+      @server_authentication ||= ServerAuthentication.new(@config)
+    end
+  end
+end

data/lib/vonage/network_number_verification.rb

@@ -0,0 +1,92 @@
+# typed: strict
+# frozen_string_literal: true
+require 'phonelib'
+
+module Vonage
+  class NetworkNumberVerification < Namespace
+    extend T::Sig
+    include Keys
+
+    self.authentication = NetworkAuthentication
+
+    self.host = :vonage_host
+
+    self.request_body = JSON
+
+    # Verifies if the specified phone number (plain text or hashed format) matches the one that the user is currently using.
+    #
+    # @example
+    #   response = client.network_number_verification.verify(
+    #     phone_number: '+447900000000',
+    #     auth_data: {
+    #       oidc_auth_code: '0dadaeb4-7c79-4d39-b4b0-5a6cc08bf537',
+    #       redirect_uri: 'https://example.com/callback'
+    #     }
+    #   )
+    #
+    # @param [required, String] :phone_number The phone number to check, in the E.164 format, prepended with a `+`.
+    #
+    # @param [required, Hash] :auth_data A hash of authentication data required for the client token request. Must contain the following keys:
+    # @option auth_data [required, String] :oidc_auth_code The OIDC auth code.
+    # @option auth_data [required, String] :redirect_uri The redirect URI.
+    # @see https://developer.vonage.com/en/getting-started-network/authentication#client-authentication-flow
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/camara/number-verification#verifyNumberVerification
+    #
+    sig { params(phone_number: String, auth_data: Hash).returns(Vonage::Response) }
+    def verify(phone_number:, auth_data:)
+      raise ArgumentError.new("`phone_number` must be in E.164 format") unless Phonelib.parse(phone_number).valid?
+      raise ArgumentError.new("`phone_number` must be prepended with a `+`") unless phone_number.start_with?('+')
+      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}
+
+      request(
+        '/camara/number-verification/v031/verify',
+        params: camelcase(params),
+        type: Post,
+        auth_data: {
+          oidc_auth_code: auth_data[:oidc_auth_code],
+          redirect_uri: auth_data[:redirect_uri],
+          auth_flow: :client_authentication
+        }
+      )
+    end
+
+    # Creates a URL for a client-side OIDC request.
+    #
+    # @example
+    #   response = client.network_number_verification.generate_oidc_uri(
+    #     phone_number: '+447900000000',
+    #     redirect_uri: 'https://example.com/callback'
+    #   )
+    #
+    # @param [required, String] :phone_number The phone number that will be checked during the verification request.
+    #
+    # @param [required, String] :redirect_uri The URI that will receive the callback containing the OIDC auth code.
+    #
+    # @param [required, String] :state A string that you can use for tracking. 
+    #   Used to set a unique identifier for each access token you generate.
+    #
+    # @return [String]
+    #
+    # @see https://developer.vonage.com/en/getting-started-network/authentication#1-make-an-oidc-request
+    sig { params(phone_number: String, redirect_uri: String, state: String).returns(String) }
+    def generate_oidc_uri(phone_number:, redirect_uri:, state:)
+      params = {
+        purpose: 'FraudPreventionAndDetection',
+        api_scope: 'number-verification-verify-read',
+        login_hint: phone_number,
+        redirect_uri: redirect_uri,
+        state: state
+      }
+
+      Vonage::NetworkAuthentication::ClientAuthentication.new(@config).generate_oidc_uri(**params)
+    end
+  end
+end

data/lib/vonage/network_sim_swap.rb

@@ -0,0 +1,84 @@
+# typed: strict
+# frozen_string_literal: true
+require 'phonelib'
+
+module Vonage
+  class NetworkSIMSwap < Namespace
+    extend T::Sig
+    include Keys
+
+    self.authentication = NetworkAuthentication
+
+    self.host = :vonage_host
+
+    self.request_body = JSON
+
+    # Check if SIM swap has been performed during a past period.
+    #
+    # @example
+    #   response = client.network_sim_swap.check(phone_number: '+447900000000')
+    #
+    # @param [required, String] :phone_number The phone number to check, in the E.164 format, prepended with a `+`.
+    #
+    # @param [optional, Integer] :max_age Period in hours to be checked for SIM swap
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/camara/sim-swap#checkSimSwap
+    #
+    sig { params(phone_number: String, max_age: T.nilable(Integer)).returns(Vonage::Response) }
+    def check(phone_number:, max_age: nil)
+      raise ArgumentError.new("`phone_number` must be in E.164 format") unless Phonelib.parse(phone_number).valid?
+      raise ArgumentError.new("`phone_number` must be prepended with a `+`") unless phone_number.start_with?('+')
+      if max_age
+        raise ArgumentError.new("`max_age` must between 1 and 2400") unless max_age.between?(1, 2400)
+      end
+
+      params = {phone_number: phone_number}
+      params[:max_age] = max_age if max_age
+
+      request(
+        '/camara/sim-swap/v040/check',
+        params: camelcase(params),
+        type: Post,
+        auth_data: {
+          login_hint: phone_number,
+          purpose: 'FraudPreventionAndDetection',
+          api_scope: 'check-sim-swap',
+          auth_flow: :server_authentication
+        }
+      )
+    end
+
+    # Get timestamp of last MSISDN <-> IMSI pairing change for a mobile user account provided with MSIDN.
+    #
+    # @example
+    #   response = client.network_sim_swap.retrieve_date(phone_number: '+447900000000')
+    #
+    # @param [required, String] :phone_number The phone number to check, in the E.164 format, prepended with a `+`.
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/camara/sim-swap#retrieveSimSwapDate
+    #
+    sig { params(phone_number: String).returns(Vonage::Response) }
+    def retrieve_date(phone_number:)
+      raise ArgumentError.new("`phone_number` must be in E.164 format") unless Phonelib.parse(phone_number).valid?
+      raise ArgumentError.new("`phone_number` must be prepended with a `+`") unless phone_number.start_with?('+')
+
+      params = {phone_number: phone_number}
+
+      request(
+        '/camara/sim-swap/v040/retrieve-date',
+        params: camelcase(params),
+        type: Post,
+        auth_data: {
+          login_hint: phone_number,
+          purpose: 'FraudPreventionAndDetection',
+          api_scope: 'retrieve-sim-swap-date',
+          auth_flow: :server_authentication
+        }
+      )
+    end
+  end
+end

data/lib/vonage/number_insight.rb

@@ -3,6 +3,7 @@
 
 module Vonage
   class NumberInsight < Namespace
+    self.authentication = Basic
     # Provides basic number insight information about a number.
     #
     # @example

data/lib/vonage/number_insight_2.rb

@@ -0,0 +1,21 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class NumberInsight2 < Namespace
+    extend T::Sig
+
+    self.authentication = Basic
+
+    self.request_body = JSON
+
+   # @deprecated
+    sig { params(type: String, phone: String, insights: T::Array[String]).returns(Vonage::Response) }
+    def fraud_check(type:, phone:, insights:)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      raise ArgumentError.new("`insights` must not be an empty") if insights.empty?
+
+      request('/v2/ni', params: {type: type, phone: phone, insights: insights}, type: Post)
+    end
+  end
+end