vonage 7.2.0

data/lib/vonage/numbers/list_response.rb

@@ -0,0 +1,11 @@
+# typed: ignore
+
+class Vonage::Numbers::ListResponse < Vonage::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity.numbers.each { |item| yield item }
+  end
+end

data/lib/vonage/numbers/response.rb

@@ -0,0 +1,8 @@
+# typed: false
+# frozen_string_literal: true
+
+class Vonage::Numbers::Response < Vonage::Response
+  def success?
+    error_code == '200'
+  end
+end

data/lib/vonage/params.rb

@@ -0,0 +1,27 @@
+# typed: ignore
+# frozen_string_literal: true
+require 'cgi'
+
+module Vonage
+  module Params
+    def self.encode(params)
+      params.flat_map { |k, vs| Array(vs).map { |v| "#{escape(k)}=#{escape(v)}" } }.join('&')
+    end
+
+    def self.join(string, params)
+      encoded = encode(params)
+
+      return encoded if string.nil?
+
+      string + '&' + encoded
+    end
+
+    def self.escape(component)
+      CGI.escape(component.to_s)
+    end
+
+    private_class_method :escape
+  end
+
+  private_constant :Params
+end

data/lib/vonage/pricing.rb

@@ -0,0 +1,30 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Pricing < Namespace
+    self.host = :rest_host
+
+    def initialize(config, type: nil)
+      raise ArgumentError if type.nil?
+
+      @type = type
+
+      super config
+    end
+
+    attr_reader :type
+
+    def get(country)
+      request('/account/get-pricing/outbound/' + @type, params: {country: country})
+    end
+
+    def list
+      request('/account/get-full-pricing/outbound/' + @type)
+    end
+
+    def prefix(prefix)
+      request('/account/get-prefix-pricing/outbound/' + @type, params: {prefix: prefix})
+    end
+  end
+end

data/lib/vonage/pricing_types.rb

@@ -0,0 +1,18 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class PricingTypes
+    def initialize(config)
+      @config = config
+    end
+
+    def sms
+      @sms ||= Pricing.new(@config, type: 'sms')
+    end
+
+    def voice
+      @voice ||= Pricing.new(@config, type: 'voice')
+    end
+  end
+end

data/lib/vonage/redact.rb

@@ -0,0 +1,37 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class Redact < Namespace
+    extend T::Sig
+
+    self.authentication = Basic
+
+    self.request_body = JSON
+
+    # Redact a specific message.
+    #
+    # @example
+    #   response = client.redact.transaction(id: '00A0B0C0', product: 'sms')
+    #
+    # @option params [required, String] :id
+    #   The transaction ID to redact.
+    #
+    # @option params [required, String] :product
+    #   Product name that the ID provided relates to.
+    #
+    # @option params [required, String] :type
+    #   Required if redacting SMS data.
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/redact#redact-message
+    #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Vonage::Response) }
+    def transaction(params)
+      request('/v1/redact/transaction', params: params, type: Post)
+    end
+  end
+end

data/lib/vonage/response.rb

@@ -0,0 +1,25 @@
+# typed: true
+
+module Vonage
+  class Response
+    def initialize(entity=nil, http_response=nil)
+      @entity = entity
+
+      @http_response = http_response
+    end
+
+    attr_reader :http_response
+
+    def respond_to_missing?(name, include_private = false)
+      return super if @entity.nil?
+
+      @entity.respond_to?(name)
+    end
+
+    def method_missing(name, *args)
+      return super if @entity.nil?
+
+      @entity.public_send(name, *args)
+    end
+  end
+end

data/lib/vonage/secrets.rb

@@ -0,0 +1,85 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Secrets < Namespace
+    self.authentication = Basic
+
+    self.request_body = JSON
+
+    # Create API Secret.
+    #
+    # @example
+    #   response = client.secrets.create(secret: 'T0ps3cr3t')
+    #
+    # @option params [required, String] :secret
+    #   The new secret must follow these rules:
+    #   - minimum 8 characters
+    #   - maximum 25 characters
+    #   - minimum 1 lower case character
+    #   - minimum 1 upper case character
+    #   - minimum 1 digit
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/account#createAPISecret
+    #
+    def create(params)
+      request('/accounts/' + account_id + '/secrets', params: params, type: Post)
+    end
+
+    # Retrieve API Secrets.
+    #
+    # @example
+    #   response = client.secrets.list
+    #   response.each do |item|
+    #     puts "#{item.created_at} #{item.id}"
+    #   end
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.nexmo.com/api/account#retrieveAPISecrets
+    #
+    def list
+      request('/accounts/' + account_id + '/secrets', response_class: ListResponse)
+    end
+
+    # Retrieve one API Secret.
+    #
+    # @example
+    #   response = client.secrets.get(secret_id)
+    #
+    # @param [String] secret_id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/account#retrieveAPISecret
+    #
+    def get(secret_id)
+      request('/accounts/' + account_id + '/secrets/' + secret_id)
+    end
+
+    # Revoke an API Secret.
+    #
+    # @example
+    #   response = client.secrets.revoke(secret_id)
+    #
+    # @param [String] secret_id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/account#revokeAPISecret
+    #
+    def revoke(secret_id)
+      request('/accounts/' + account_id + '/secrets/' + secret_id, type: Delete)
+    end
+
+    private
+
+    def account_id
+      @config.api_key
+    end
+  end
+end

data/lib/vonage/secrets/list_response.rb

@@ -0,0 +1,11 @@
+# typed: ignore
+
+class Vonage::Secrets::ListResponse < Vonage::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity._embedded.secrets.each { |item| yield item }
+  end
+end

data/lib/vonage/server_error.rb

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

data/lib/vonage/signature.rb

@@ -0,0 +1,53 @@
+# typed: true
+# frozen_string_literal: true
+require 'openssl'
+require 'digest/md5'
+require 'jwt'
+
+module Vonage
+  class Signature
+    def initialize(config)
+      @config = config
+    end
+
+    # Check webhook request signature.
+    #
+    # @example
+    #   client = Vonage::Client.new
+    #   client.config.signature_secret = 'secret'
+    #   client.config.signature_method = 'sha512'
+    #
+    #   if client.signature.check(request.GET)
+    #     # valid signature
+    #   else
+    #     # invalid signature
+    #   end
+    #
+    # @param [Hash] params
+    #
+    # @see https://developer.nexmo.com/concepts/guides/signing-messages
+    #
+    def check(params, signature_method: @config.signature_method)
+      params = params.dup
+
+      signature = params.delete('sig')
+
+      ::JWT::SecurityUtils.secure_compare(signature, digest(params, signature_method))
+    end
+
+    private
+
+    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, @config.signature_secret, digest_string).upcase
+      when 'md5hash'
+        Digest::MD5.hexdigest("#{digest_string}#{@config.signature_secret}")
+      else
+        raise ArgumentError, "Unknown signature algorithm: #{signature_method}. Expected: md5hash, md5, sha1, sha256, or sha512."
+      end
+    end
+  end
+end

data/lib/vonage/sms.rb

@@ -0,0 +1,121 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class SMS < Namespace
+    extend T::Sig
+    include Keys
+
+    self.host = :rest_host
+
+    # Send an outbound SMS from your Vonage account.
+    #
+    # @example
+    #   response = client.sms.send(from: 'Ruby', to: '447700900000', text: 'Hello world')
+    #
+    #   puts "Sent message id=#{response.messages.first.message_id}"
+    #
+    # @option params [required, String] :from
+    #   The name or number the message should be sent from.
+    #   Alphanumeric senderID's are not supported in all countries, see [Global Messaging](https://developer.nexmo.com/messaging/sms/guides/global-messaging#country-specific-features) for more details.
+    #   If alphanumeric, spaces will be ignored. Numbers are specified in E.164 format.
+    #
+    # @option params [required, String] :to
+    #   The number that the message should be sent to.
+    #   Numbers are specified in E.164 format.
+    #
+    # @option params [String] :text
+    #   The body of the message being sent.
+    #   If your message contains characters that can be encoded according to the GSM Standard and Extended tables then you can set the **:type** to `text`.
+    #   If your message contains characters outside this range, then you will need to set the **:type** to `unicode`.
+    #
+    # @option params [Integer] :ttl
+    #   The duration in milliseconds the delivery of an SMS will be attempted.
+    #   By default Vonage attempt delivery for 72 hours, however the maximum effective value depends on the operator and is typically 24 - 48 hours.
+    #   We recommend this value should be kept at its default or at least 30 minutes.
+    #
+    # @option params [Boolean] :status_report_req
+    #   Boolean indicating if you like to receive a [Delivery Receipt](https://developer.nexmo.com/messaging/sms/building-blocks/receive-a-delivery-receipt).
+    #
+    # @option params [String] :callback
+    #   The webhook endpoint the delivery receipt for this sms is sent to.
+    #   This parameter overrides the webhook endpoint you set in Dashboard.
+    #
+    # @option params [Integer] :message_class
+    #   The Data Coding Scheme value of the message.
+    #
+    # @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`.
+    #
+    # @option params [String] :udh
+    #   Your custom Hex encoded [User Data Header](https://en.wikipedia.org/wiki/User_Data_Header).
+    #   Depends on **:type** option having the value `binary`.
+    #
+    # @option params [Integer] :protocol_id
+    #   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.
+    #
+    # @option params [String] :account_ref
+    #   An optional string used to identify separate accounts using the SMS endpoint for billing purposes.
+    #   To use this feature, please email [support@nexmo.com](mailto:support@nexmo.com).
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/sms#send-an-sms
+    #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Vonage::Response) }
+    def send(params)
+      if unicode?(params.fetch(:text)) && params[:type] != 'unicode'
+        message = 'Sending unicode text SMS without setting the type parameter to "unicode". ' \
+          'See https://developer.nexmo.com/messaging/sms for details, ' \
+          'or email support@nexmo.com if you have any questions.'
+
+        logger.warn(message)
+      end
+
+      response = request('/sms/json', params: hyphenate(params), type: Post)
+
+      unless response.messages.first.status == '0'
+        raise Error, response.messages.first[:error_text]
+      end
+
+      response
+    end
+
+    private
+
+    sig { params(text: String).returns(T::Boolean) }
+    def unicode?(text)
+      !Vonage::GSM7.encoded?(text)
+    end
+  end
+end