vonage 7.30.0 → 8.0.0.beta

data/lib/vonage/namespace.rb

@@ -1,9 +1,6 @@
 # typed: true
 # frozen_string_literal: true
-
 require 'net/http'
-require 'net/http/persistent'
-require 'net/http/post/multipart'
 require 'json'
 
 module Vonage
@@ -13,7 +10,8 @@ module Vonage
 
       @host = set_host
 
-      @http = Net::HTTP::Persistent.new
+      @http = Net::HTTP.new(@host, Net::HTTP.https_default_port, p_addr = nil)
+      @http.use_ssl = true
 
       @config.http.set(@http) unless @config.http.nil?
     end
@@ -23,7 +21,8 @@ module Vonage
     end
 
     def self.host=(host)
-      raise ArgumentError unless %i[rest_host video_host vonage_host].include?(host)
+      raise ArgumentError unless host == :rest_host || host == :video_host
+
       @host = host
     end
 
@@ -48,7 +47,6 @@ module Vonage
     end
 
     protected
-
     # :nocov:
 
     Get = Net::HTTP::Get
@@ -57,33 +55,33 @@ module Vonage
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 
-    def build_request(path:, type: Get, params: {}, auth_data: nil)
+    def build_request(path:, type: Get, params: {})
       authentication = self.class.authentication.new(@config)
-      authentication.update(params, auth_data)
+      authentication.update(params)
 
-      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 { |key, value| request[key] = value }
+      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
 
-      # Set Authorization header if needed
-      authentication.update(request, auth_data)
+      # Set BearerToken if needed
+      authentication.update(request)
 
       # set body
-      if type.const_get(:REQUEST_HAS_BODY)
-        self.class.request_body.update(request, params)
-      end
+      self.class.request_body.update(request, params) if type.const_get(:REQUEST_HAS_BODY)
 
       request
     end
@@ -91,8 +89,7 @@ module Vonage
     def make_request!(request, &block)
       logger.log_request_info(request)
 
-      uri = URI("https://" + @host + request.path)
-      response = @http.request(uri, request, &block)
+      response = @http.request(request, &block)
 
       logger.log_response_info(response, @host)
 
@@ -103,32 +100,17 @@ module Vonage
       response
     end
 
-    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
-        )
+    def request(path, params: nil, type: Get, response_class: Response, &block)
+      auto_advance = !params.nil? && params.key?(:auto_advance) ? params[:auto_advance] : false
 
-      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, auth_data: auth_data)
+      request = build_request(path: path, params: params || {}, type: type)
 
       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
 
@@ -136,59 +118,22 @@ 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)
@@ -199,15 +144,11 @@ 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
 
@@ -215,51 +156,43 @@ module Vonage
     end
 
     def remaining_count(params)
-      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
-          )
+      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']))
       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
@@ -270,7 +203,7 @@ module Vonage
       when Net::HTTPNoContent
         response_class.new(nil, response)
       when Net::HTTPSuccess
-        if response['Content-Type'] && response['Content-Type'].split(';').first == 'application/json' && !response.body.empty?
+        if response['Content-Type'].split(';').first == 'application/json'
           entity = ::JSON.parse(response.body, object_class: Vonage::Entity)
 
           response_class.new(entity, response)
@@ -294,8 +227,6 @@ module Vonage
         @config.rest_host
       when :video_host
         @config.video_host
-      when :vonage_host
-        @config.vonage_host
       else
         @config.api_host
       end

data/lib/vonage/numbers.rb

@@ -5,8 +5,6 @@ module Vonage
   class Numbers < Namespace
     include Keys
 
-    self.authentication = Basic
-
     self.host = :rest_host
 
     # Retrieve all the inbound numbers associated with your Vonage account.
@@ -17,8 +15,6 @@ module Vonage
     #     puts "#{item.msisdn} #{item.country} #{item.type}"
     #   end
     #
-    # @param [Hash] params
-    #
     # @option params [String] :application_id
     #   The application that you want to return the numbers for.
     #
@@ -49,12 +45,14 @@ module Vonage
     #   Set this to `true` to auto-advance through all the pages in the record
     #   and collect all the data. The default is `false`.
     #
+    # @param [Hash] params
+    #
     # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#getOwnedNumbers
     #
     def list(params = nil)
-      request("/account/numbers", params: params, response_class: ListResponse)
+      request('/account/numbers', params: params, response_class: ListResponse)
     end
 
     # Retrieve inbound numbers that are available for the specified country.
@@ -65,8 +63,6 @@ module Vonage
     #     puts "#{item.msisdn} #{item.type} #{item.cost}"
     #   end
     #
-    # @param [Hash] params
-    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -84,7 +80,7 @@ module Vonage
     #   - `2` - Search for numbers that end with **:pattern**
     #
     # @option params [String] :features
-    #   Available features are `SMS`, `MMS`, and `VOICE`.
+    #   Available features are `SMS` and `VOICE`.
     #   To look for numbers that support both, use a comma-separated value: `SMS,VOICE`.
     #
     # @option params [Integer] :size
@@ -97,12 +93,14 @@ module Vonage
     #   Set this to `true` to auto-advance through all the pages in the record
     #   and collect all the data. The default is `false`.
     #
+    # @param [Hash] params
+    #
     # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#getAvailableNumbers
     #
     def search(params)
-      request("/number/search", params: params, response_class: ListResponse)
+      request('/number/search', params: params, response_class: ListResponse)
     end
 
     # Request to purchase a specific inbound number.
@@ -110,8 +108,6 @@ module Vonage
     # @example
     #   response = client.numbers.buy(country: 'GB', msisdn: '447700900000')
     #
-    # @param [Hash] params
-    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -122,17 +118,14 @@ module Vonage
     #   If you'd like to perform an action on a subaccount, provide the `api_key` of that account here.
     #   If you'd like to perform an action on your own account, you do not need to provide this field.
     #
+    # @param [Hash] params
+    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#buyANumber
     #
     def buy(params)
-      request(
-        "/number/buy",
-        params: params,
-        type: Post,
-        response_class: Response
-      )
+      request('/number/buy', params: params, type: Post, response_class: Response)
     end
 
     # Cancel your subscription for a specific inbound number.
@@ -140,8 +133,6 @@ module Vonage
     # @example
     #   response = client.numbers.cancel(country: 'GB', msisdn: '447700900000')
     #
-    # @param [Hash] params
-    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -152,17 +143,14 @@ module Vonage
     #   If you'd like to perform an action on a subaccount, provide the `api_key` of that account here.
     #   If you'd like to perform an action on your own account, you do not need to provide this field.
     #
+    # @param [Hash] params
+    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#cancelANumber
     #
     def cancel(params)
-      request(
-        "/number/cancel",
-        params: params,
-        type: Post,
-        response_class: Response
-      )
+      request('/number/cancel', params: params, type: Post, response_class: Response)
     end
 
     # Change the behaviour of a number that you own.
@@ -177,8 +165,6 @@ module Vonage
     #
     #   response = client.numbers.update(params)
     #
-    # @param [Hash] params
-    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -205,30 +191,21 @@ module Vonage
     # @option params [String] :voice_status_callback
     #   A webhook URI for Vonage to send a request to when a call ends.
     #
+    # @param [Hash] params
+    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/developer/numbers#updateANumber
     #
     def update(params)
-      request(
-        "/number/update",
-        params: camelcase(params),
-        type: Post,
-        response_class: Response
-      )
+      request('/number/update', params: camelcase(params), type: Post, response_class: Response)
     end
 
     private
 
     # A specific implementation of iterable_request for Numbers, because the Numbers API
     # handles pagination differently to other Vonage APIs
-    def iterable_request(
-      path,
-      response: nil,
-      response_class: nil,
-      params: {},
-      &block
-    )
+    def iterable_request(path, response: nil, response_class: nil, params: {}, &block)
       response = parse(response, response_class)
       params[:index] = 1 unless params.has_key?(:index)
       size = params.fetch(:size, 10)

data/lib/vonage/server_error.rb

@@ -1,6 +1,6 @@
 # typed: strong
 
 module Vonage
-  class ServerError < APIError
+  class ServerError < Error
   end
 end

data/lib/vonage/signature.rb

@@ -27,24 +27,24 @@ module Vonage
     #
     # @see https://developer.nexmo.com/concepts/guides/signing-messages
     #
-    def check(params, signature_secret: @config.signature_secret, signature_method: @config.signature_method)
+    def check(params, signature_method: @config.signature_method)
       params = params.dup
 
       signature = params.delete('sig')
 
-      ::JWT::JWA::Hmac::SecurityUtils.secure_compare(signature, digest(params, signature_secret, signature_method))
+      ::JWT::SecurityUtils.secure_compare(signature, digest(params, signature_method))
     end
 
     private
 
-    def digest(params, signature_secret, signature_method)
+    def digest(params, signature_method)
       digest_string = params.sort.map { |k, v| "&#{k}=#{v.tr('&=', '_')}" }.join
 
       case signature_method
       when 'md5', 'sha1', 'sha256', 'sha512'
-        OpenSSL::HMAC.hexdigest(signature_method, signature_secret, digest_string).upcase
+        OpenSSL::HMAC.hexdigest(signature_method, @config.signature_secret, digest_string).upcase
       when 'md5hash'
-        Digest::MD5.hexdigest("#{digest_string}#{signature_secret}")
+        Digest::MD5.hexdigest("#{digest_string}#{@config.signature_secret}")
       else
         raise ArgumentError, "Unknown signature algorithm: #{signature_method}. Expected: md5hash, md5, sha1, sha256, or sha512."
       end

data/lib/vonage/sms.rb

@@ -47,6 +47,14 @@ module Vonage
     # @option params [String] :type
     #   The format of the message body.
     #
+    # @option params [String] :vcard
+    #   A business card in [vCard format](https://en.wikipedia.org/wiki/VCard).
+    #   Depends on **:type** option having the value `vcard`.
+    #
+    # @option params [String] :vcal
+    #   A calendar event in [vCal format](https://en.wikipedia.org/wiki/VCal).
+    #   Depends on **:type** option having the value `vcal`.
+    #
     # @option params [String] :body
     #   Hex encoded binary data.
     #   Depends on **:type** option having the value `binary`.
@@ -59,6 +67,18 @@ module Vonage
     #   The value of the [protocol identifier](https://en.wikipedia.org/wiki/GSM_03.40#Protocol_Identifier) to use.
     #   Ensure that the value is aligned with **:udh**.
     #
+    # @option params [String] :title
+    #   The title for a wappush SMS.
+    #   Depends on **:type** option having the value `wappush`.
+    #
+    # @option params [String] :url
+    #   The URL of your website.
+    #   Depends on **:type** option having the value `wappush`.
+    #
+    # @option params [String] :validity
+    #   The availability for an SMS in milliseconds.
+    #   Depends on **:type** option having the value `wappush`.
+    #
     # @option params [String] :client_ref
     #   You can optionally include your own reference of up to 40 characters.
     #
@@ -91,31 +111,11 @@ module Vonage
       response
     end
 
-    # Validate a Signature from an SMS API Webhook.
-    #
-    # @param [Hash, required] :webhook_params The parameters from the webhook request body
-    # @param [String, optional] :signature_secret The account signature secret. Required, unless `signature_secret`
-    #   is set in `Config`
-    # @param [String, optional] :signature_method The account signature method. Required, unless `signature_method`
-    #   is set in `Config`
-    #
-    # @return [Boolean] true, if the JWT is verified, false otherwise
-    def verify_webhook_sig(webhook_params:, signature_secret: @config.signature_secret, signature_method: @config.signature_method)
-      signature.check(webhook_params, signature_secret: signature_secret, signature_method: signature_method)
-    end
-
     private
 
     sig { params(text: String).returns(T::Boolean) }
     def unicode?(text)
       !Vonage::GSM7.encoded?(text)
     end
-
-    # @return [Signature]
-    #
-    sig { returns(T.nilable(Vonage::Signature)) }
-    def signature
-      @signature ||= T.let(Signature.new(@config), T.nilable(Vonage::Signature))
-    end
   end
 end

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = '7.30.0'
+  VERSION = '8.0.0.beta'
 end