nexmo 6.0.1 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc8163571414c0618c708aafb97c3dc3069430fcc3a6bb9c4e2398bd97e628f2
-  data.tar.gz: 78545b0d8f5faff46c8c43f88eebf4944ed410d7faa2a392dc8b6ef8001e1027
+  metadata.gz: 041a5d88df4780900cec2813647b6cfb45c71031374a824905cc2839cb9e46dd
+  data.tar.gz: c5fb8b4dc6f75c19a55ff1005364eff154b326bb0bbff82cc7874127a37da1e0
 SHA512:
-  metadata.gz: 40b060620adbe2190b86549e40d2ce9e309c4dedad9e4cd2a90e226cbaedcedd27df5e025afbc5985fd9fc628e494dbae0a574d069e76c008b2bf0bdeacff6ed
-  data.tar.gz: 227e5733e84a23d5a44634d63c1bed0550d4189fccdef1b1ae80d7d2c9db8b4ec40d6c6dfdced97d9a3aa6b9d78171cc79ae44ab6403cc5076242f194f7f486b
+  metadata.gz: 9c923d6ca80704f3e6fd68f8311ff2e7d737a75d6892ba24866a8d2e82e6db566ad8c8cb84335302830ec71fe1a1e6e1466ab890fd1746e5d25a4b6c0f4de789
+  data.tar.gz: af9df8e503ea622f9221f9c8c8bf6414e03d6c806b4648829093ff80155f0e05bb32c678795d1e750f2edc4b0c0c11681a318bed9eb0b6edcec1c8fbb5f7e70c

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2019 Nexmo Inc
+Copyright (c) 2016-2020 Nexmo Inc
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -2,15 +2,18 @@
 
 [![Gem Version](https://badge.fury.io/rb/nexmo.svg)](https://badge.fury.io/rb/nexmo) [![Build Status](https://api.travis-ci.org/Nexmo/nexmo-ruby.svg?branch=master)](https://travis-ci.org/Nexmo/nexmo-ruby) [![Coverage Status](https://coveralls.io/repos/github/Nexmo/nexmo-ruby/badge.svg?branch=coveralls)](https://coveralls.io/github/Nexmo/nexmo-ruby?branch=master)
 
+<img src="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg" height="48px" alt="Nexmo is now known as Vonage" />
+
 This is the Ruby client library for Nexmo's API. To use it you'll
 need a Nexmo account. Sign up [for free at nexmo.com][signup].
 
 * [Requirements](#requirements)
 * [Installation](#installation)
 * [Usage](#usage)
-* [Logging](#logging)
-* [JWT authentication](#jwt-authentication)
-* [Webhook signatures](#webhook-signatures)
+    * [Logging](#logging)
+    * [Overriding the default hosts](#overriding-the-default-hosts)
+    * [JWT authentication](#jwt-authentication)
+    * [Webhook signatures](#webhook-signatures)
 * [Documentation](#documentation)
 * [License](#license)
 
@@ -73,6 +76,21 @@ By default the library sets the logger to `Rails.logger` if it is defined.
 To disable logging set the logger to `nil`.
 
 
+## Overriding the default hosts
+
+To override the default hosts that the SDK uses for HTTP requests, you need to
+specify the `api_host`, `rest_host` or both in the client configuration. For example:
+
+```ruby
+client = Nexmo::Client.new(
+  api_host: 'api-sg-1.nexmo.com',
+  rest_host: 'rest-sg-1.nexmo.com'
+)
+```
+
+By default the hosts are set to `api.nexmo.com` and `rest.nexmo.com`, respectively.
+
+
 ## JWT authentication
 
 To call newer endpoints that support JWT authentication such as the Voice API you'll
@@ -112,7 +130,9 @@ client = Nexmo::Client.new(token: token)
 To check webhook signatures you'll also need to specify the `signature_secret` option. For example:
 
 ```ruby
-client = Nexmo::Client.new(signature_secret: 'secret')
+client = Nexmo::Client.new
+client.config.signature_secret = 'secret'
+client.config.signature_method = 'sha512'
 
 if client.signature.check(request.GET)
   # valid signature

data/lib/nexmo.rb

@@ -1,23 +1,21 @@
+# typed: true
 # frozen_string_literal: true
 require 'zeitwerk'
+require 'sorbet-runtime'
 
 module Nexmo
-  class ZeitwerkInflector < Zeitwerk::Inflector
-    def camelize(basename, _abspath)
-      case basename
-      when 'http', 'json', 'jwt', 'sms', 'tfa', 'gsm7', 'dtmf', 'version'
-        basename.upcase
-      else
-        super
-      end
-    end
-  end
-
-  private_constant :ZeitwerkInflector
-
   loader = Zeitwerk::Loader.new
   loader.tag = File.basename(__FILE__, '.rb')
-  loader.inflector = ZeitwerkInflector.new
+  loader.inflector.inflect({
+    'dtmf' => 'DTMF',
+    'gsm7' => 'GSM7',
+    'http' => 'HTTP',
+    'json' => 'JSON',
+    'jwt' => 'JWT',
+    'sms' => 'SMS',
+    'tfa' => 'TFA',
+    'version' => 'VERSION',
+  })
   loader.push_dir(__dir__)
   loader.setup
 

data/lib/nexmo/abstract_authentication.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 module Nexmo
   class AbstractAuthentication
     def initialize(config)

data/lib/nexmo/account.rb

@@ -1,10 +1,12 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Account < Namespace
+    extend T::Sig
     include Keys
 
-    self.host = 'rest.nexmo.com'
+    self.host = :rest_host
 
     # Retrieve your account balance.
     #
@@ -12,6 +14,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/developer/account#get-balance
     #
+    sig { returns(Nexmo::Response) }
     def balance
       request('/account/get-balance')
     end
@@ -34,6 +37,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/developer/account#settings
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def update(params)
       request('/account/settings', params: camelcase(params), type: Post)
     end
@@ -49,6 +53,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/developer/account#top-up
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def topup(params)
       request('/account/top-up', params: params, type: Post)
     end

data/lib/nexmo/alerts.rb

@@ -1,8 +1,10 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Alerts < Namespace
-    self.host = 'rest.nexmo.com'
+    extend T::Sig
+    self.host = :rest_host
 
     # Request the list of phone numbers opted out from your campaign.
     #
@@ -10,6 +12,7 @@ module Nexmo
     #
     # @return [Response]
     #
+    sig { returns(Nexmo::Response) }
     def list
       request('/sc/us/alert/opt-in/query/json')
     end
@@ -25,6 +28,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/subscription
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def remove(params)
       request('/sc/us/alert/opt-in/manage/json', params: params, type: Post)
     end
@@ -60,6 +64,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/sending
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def send(params)
       request('/sc/us/alert/json', params: params, type: Post)
     end

data/lib/nexmo/applications.rb

@@ -1,7 +1,9 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Applications < Namespace
+    extend T::Sig
     self.authentication = Basic
 
     self.request_body = JSON
@@ -13,9 +15,20 @@ module Nexmo
     # @example
     #   params = {
     #     name: 'Example App',
-    #     type: 'voice',
-    #     answer_url: answer_url,
-    #     event_url: event_url
+    #     capabilities: {
+    #       'messages': {
+    #         'webhooks': {
+    #           'inbound_url': {
+    #             'address': 'https://example.com/webhooks/inbound',
+    #             'http_method': 'POST'
+    #           },
+    #           'status_url': {
+    #             'address': 'https://example.com/webhooks/status',
+    #             'http_method': 'POST'
+    #           }
+    #         }
+    #       }
+    #     }
     #   }
     #
     #   response = client.applications.create(params)
@@ -37,6 +50,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/application.v2#createApplication
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def create(params)
       request('/v2/applications', params: params, type: Post)
     end
@@ -61,6 +75,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/application.v2#listApplication
     #
+    sig { params(params: T.nilable(T::Hash[Symbol, Integer])).returns(Nexmo::Response) }
     def list(params = nil)
       request('/v2/applications', params: params, response_class: ListResponse)
     end
@@ -76,6 +91,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/application.v2#getApplication
     #
+    sig { params(id: String).returns(Nexmo::Response) }
     def get(id)
       request('/v2/applications/' + id)
     end
@@ -103,6 +119,10 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/application.v2#updateApplication
     #
+    sig { params(
+      id: String,
+      params: T::Hash[Symbol, T.untyped]
+    ).returns(Nexmo::Response) }
     def update(id, params)
       request('/v2/applications/' + id, params: params, type: Put)
     end
@@ -120,6 +140,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/application.v2#deleteApplication
     #
+    sig { params(id: String).returns(Nexmo::Response) }
     def delete(id)
       request('/v2/applications/' + id, type: Delete)
     end

data/lib/nexmo/applications/list_response.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 class Nexmo::Applications::ListResponse < Nexmo::Response
   include Enumerable
 

data/lib/nexmo/authentication_error.rb

@@ -1,3 +1,5 @@
+# typed: strong
+
 module Nexmo
   class AuthenticationError < ClientError
   end

data/lib/nexmo/basic.rb

@@ -1,3 +1,5 @@
+# typed: ignore
+
 module Nexmo
   class Basic < AbstractAuthentication
     def update(object)

data/lib/nexmo/bearer_token.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/client.rb

@@ -1,111 +1,134 @@
+# typed: strict
+
 module Nexmo
   class Client
+    extend T::Sig
+
+    sig { returns(Nexmo::Config) }
     attr_reader :config
 
+    sig { params(options: T.nilable(T::Hash[Symbol, T.untyped])).void }
     def initialize(options = nil)
-      @config = Nexmo.config.merge(options)
+      @config = T.let(Nexmo.config.merge(options), Nexmo::Config)
     end
 
     # @return [Signature]
     #
+    sig { returns(T.nilable(Nexmo::Signature)) }
     def signature
-      @signature ||= Signature.new(config.signature_secret)
+      @signature ||= T.let(Signature.new(config), T.nilable(Nexmo::Signature))
     end
 
     # @return [Account]
     #
+    sig { returns(T.nilable(Nexmo::Account)) }
     def account
-      @account ||= Account.new(config)
+      @account ||= T.let(Account.new(config), T.nilable(Nexmo::Account))
     end
 
     # @return [Alerts]
     #
+    sig { returns(T.nilable(Nexmo::Alerts)) }
     def alerts
-      @alerts ||= Alerts.new(config)
+      @alerts ||= T.let(Alerts.new(config), T.nilable(Nexmo::Alerts))
     end
 
     # @return [Applications]
     #
+    sig { returns(T.nilable(Nexmo::Applications)) }
     def applications
-      @applications ||= Applications.new(config)
-    end
-
-    # @return [Calls]
-    #
-    def calls
-      @calls ||= Calls.new(config)
+      @applications ||= T.let(Applications.new(config), T.nilable(Nexmo::Applications))
     end
 
     # @return [Conversations]
     #
+    sig { returns(T.nilable(Nexmo::Conversations)) }
     def conversations
-      @conversations ||= Conversations.new(config)
+      @conversations ||= T.let(Conversations.new(config), T.nilable(Nexmo::Conversations))
     end
 
     # @return [Conversions]
     #
+    sig { returns(T.nilable(Nexmo::Conversions)) }
     def conversions
-      @conversions ||= Conversions.new(config)
+      @conversions ||= T.let(Conversions.new(config), T.nilable(Nexmo::Conversions))
     end
 
     # @return [Files]
     #
+    sig { returns(T.nilable(Nexmo::Files)) }
     def files
-      @files ||= Files.new(config)
+      @files ||= T.let(Files.new(config), T.nilable(Nexmo::Files))
     end
 
     # @return [Messages]
     #
+    sig { returns(T.nilable(Nexmo::Messages)) }
     def messages
-      @messages ||= Messages.new(config)
+      @messages ||= T.let(Messages.new(config), T.nilable(Nexmo::Messages))
     end
 
     # @return [NumberInsight]
     #
+    sig { returns(T.nilable(Nexmo::NumberInsight)) }
     def number_insight
-      @number_insight ||= NumberInsight.new(config)
+      @number_insight ||= T.let(NumberInsight.new(config), T.nilable(Nexmo::NumberInsight))
     end
 
     # @return [Numbers]
     #
+    sig { returns(T.nilable(Nexmo::Numbers)) }
     def numbers
-      @numbers ||= Numbers.new(config)
+      @numbers ||= T.let(Numbers.new(config), T.nilable(Nexmo::Numbers))
     end
 
     # @return [PricingTypes]
     #
+    sig { returns(T.nilable(Nexmo::PricingTypes)) }
     def pricing
-      @pricing ||= PricingTypes.new(config)
+      @pricing ||= T.let(PricingTypes.new(config), T.nilable(Nexmo::PricingTypes))
     end
 
     # @return [Redact]
     #
+    sig { returns(T.nilable(Nexmo::Redact)) }
     def redact
-      @redact ||= Redact.new(config)
+      @redact ||= T.let(Redact.new(config), T.nilable(Nexmo::Redact))
     end
 
     # @return [Secrets]
     #
+    sig { returns(T.nilable(Nexmo::Secrets)) }
     def secrets
-      @secrets ||= Secrets.new(config)
+      @secrets ||= T.let(Secrets.new(config), T.nilable(Nexmo::Secrets))
     end
 
     # @return [SMS]
     #
+    sig { returns(T.nilable(Nexmo::SMS)) }
     def sms
-      @sms ||= SMS.new(config)
+      @sms ||= T.let(SMS.new(config), T.nilable(Nexmo::SMS))
     end
 
     # @return [TFA]
     #
+    sig { returns(T.nilable(Nexmo::TFA)) }
     def tfa
-      @tfa ||= TFA.new(config)
+      @tfa ||= T.let(TFA.new(config), T.nilable(Nexmo::TFA))
     end
 
     # @return [Verify]
     #
+    sig { returns(T.nilable(Nexmo::Verify)) }
     def verify
-      @verify ||= Verify.new(config)
+      @verify ||= T.let(Verify.new(config), T.nilable(Nexmo::Verify))
+    end
+
+    # @return [Voice]
+    #
+    sig { returns(T.nilable(Nexmo::Voice)) }
+    def voice
+      @voice ||= T.let(Voice.new(config), T.nilable(Nexmo::Voice))
     end
   end
 end