vonage 7.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9290165780002d6158c32755f7f1cd8d1aaa76001d99e146b4f7e3b2a941b0b
+  data.tar.gz: 16ec9178b751f692f6e263889d5ecd85ab2da79fbd691fbe5f0fd2cfd8f4ccf2
+SHA512:
+  metadata.gz: 483502202f3872cc10e1dcfa17dacde39acfc31f2b0c6abfb5f5c0bb78ce7f2d16ef32b393a4ff7ad2a13c3f23b5cb9aa2318bf9786e422571404d8eabd3516b
+  data.tar.gz: 9e19e1170e37eec1e1e48eb39fad55a1c05f6e691974eccd575c6d47ae12d2d446ee4373dcea638b1f4e5ac9bb6de847a483856dff53c2b94f182750c76f4447

data/LICENSE.txt

@@ -0,0 +1,190 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2020 Vonage
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,191 @@
+# Vonage Server SDK for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/vonage.svg)](https://badge.fury.io/rb/vonage) [![Coverage Status](https://github.com/Vonage/vonage-ruby-sdk/workflows/CI/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/Vonage/vonage-ruby-sdk/badge.svg?branch=coveralls)](https://coveralls.io/github/Vonage/vonage-ruby-sdk?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 Server SDK for Vonage APIs. To use it you'll
+need a Vonage account. Sign up [for free at vonage.com][signup].
+
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [Usage](#usage)
+    * [Logging](#logging)
+    * [Overriding the default hosts](#overriding-the-default-hosts)
+    * [JWT authentication](#jwt-authentication)
+    * [Webhook signatures](#webhook-signatures)
+* [Documentation](#documentation)
+* [Frequently Asked Questions](#frequently-asked-questions)
+    * [Supported APIs](#supported-apis)
+* [License](#license)
+
+
+## Requirements
+
+Vonage Ruby supports MRI/CRuby (2.5 or newer), JRuby (9.2.x), and Truffleruby.
+
+
+## Installation
+
+To install the Ruby Server SDK using Rubygems:
+
+    gem install vonage
+
+Alternatively you can clone the repository:
+
+    git clone git@github.com:Vonage/vonage-ruby-sdk.git
+
+
+## Usage
+
+Begin by requiring the Vonage library:
+
+```ruby
+require 'vonage'
+```
+
+Then construct a client object with your key and secret:
+
+```ruby
+client = Vonage::Client.new(api_key: 'YOUR-API-KEY', api_secret: 'YOUR-API-SECRET')
+```
+
+You can now use the client object to call Vonage APIs. For example, to send an SMS:
+
+```ruby
+client.sms.send(from: 'Ruby', to: '447700900000', text: 'Hello world')
+```
+
+For production you can specify the `VONAGE_API_KEY` and `VONAGE_API_SECRET`
+environment variables instead of specifying the key and secret explicitly,
+keeping your credentials out of source control.
+
+
+## Logging
+
+Use the logger option to specify a logger. For example:
+
+```ruby
+require 'logger'
+
+logger = Logger.new(STDOUT)
+
+client = Vonage::Client.new(logger: logger)
+```
+
+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 = Vonage::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
+also need to specify the `application_id` and `private_key` options. For example:
+
+```ruby
+client = Vonage::Client.new(application_id: application_id, private_key: private_key)
+```
+
+Both arguments should have string values corresponding to the `id` and `private_key`
+values returned in a ["create an application"](https://developer.nexmo.com/api/application.v2#createApplication)
+response. These credentials can be stored in a datastore, in environment variables,
+on disk outside of source control, or in some kind of key management infrastructure.
+
+By default the library generates a short lived JWT per request. To generate a long lived
+JWT for multiple requests or to specify JWT claims directly use `Vonage::JWT.generate` and
+the token option. For example:
+
+```ruby
+claims = {
+  application_id: application_id,
+  private_key: 'path/to/private.key',
+  nbf: 1483315200,
+  ttl: 800
+}
+
+token = Vonage::JWT.generate(claims)
+
+client = Vonage::Client.new(token: token)
+````
+
+Documentation for the Vonage Ruby JWT generator gem can be found at
+[https://www.rubydoc.info/github/nexmo/nexmo-jwt-ruby](https://www.rubydoc.info/github/nexmo/nexmo-jwt-ruby).
+The documentation outlines all the possible parameters you can use to customize and build a token with.
+
+## Webhook signatures
+
+To check webhook signatures you'll also need to specify the `signature_secret` option. For example:
+
+```ruby
+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
+```
+
+Alternatively you can set the `VONAGE_SIGNATURE_SECRET` environment variable.
+
+Note: you'll need to contact support@nexmo.com to enable message signing on your account.
+
+
+## Documentation
+
+Vonage Ruby documentation: https://www.rubydoc.info/github/Vonage/vonage-ruby-sdk
+
+Vonage Ruby code examples: https://github.com/Nexmo/nexmo-ruby-code-snippets
+
+Vonage APIs API reference: https://developer.nexmo.com/api
+
+## Frequently Asked Questions
+
+## Supported APIs
+
+The following is a list of Vonage APIs and whether the Ruby SDK provides support for them:
+
+| API   | API Release Status |  Supported?
+|----------|:---------:|:-------------:|
+| Account API | General Availability |✅|
+| Alerts API | General Availability |✅|
+| Application API | General Availability |✅|
+| Audit API | Beta |❌|
+| Conversation API | Beta |❌|
+| Dispatch API | Beta |❌|
+| External Accounts API | Beta |❌|
+| Media API | Beta | ❌|
+| Messages API | Beta |❌|
+| Number Insight API | General Availability |✅|
+| Number Management API | General Availability |✅|
+| Pricing API | General Availability |✅|
+| Redact API | Developer Preview |✅|
+| Reports API | Beta |❌|
+| SMS API | General Availability |✅|
+| Verify API | General Availability |✅|
+| Voice API | General Availability |✅|
+
+## License
+
+This library is released under the [Apache 2.0 License][license]
+
+[signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library
+[license]: LICENSE.txt

data/lib/vonage.rb

@@ -0,0 +1,29 @@
+# typed: true
+# frozen_string_literal: true
+require 'zeitwerk'
+require 'sorbet-runtime'
+
+module Vonage
+  loader = Zeitwerk::Loader.new
+  loader.tag = File.basename(__FILE__, '.rb')
+  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
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure(&block)
+    block.call(config)
+  end
+end

data/lib/vonage/abstract_authentication.rb

@@ -0,0 +1,9 @@
+# typed: ignore
+
+module Vonage
+  class AbstractAuthentication
+    def initialize(config)
+      @config = config
+    end
+  end
+end

data/lib/vonage/account.rb

@@ -0,0 +1,61 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class Account < Namespace
+    extend T::Sig
+    include Keys
+
+    self.host = :rest_host
+
+    # Retrieve your account balance.
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/developer/account#get-balance
+    #
+    sig { returns(Vonage::Response) }
+    def balance
+      request('/account/get-balance')
+    end
+
+    # Update the default callback URLs (where the webhooks are sent to) associated with your account.
+    #
+    # @note The URLs you provide must be valid and active. Vonage will check that they return a 200 OK response before the setting is saved.
+    #
+    # @option params [String] :mo_call_back_url
+    #   The URL where Vonage will send a webhook when an SMS is received to a Vonage number that does not have SMS handling configured.
+    #   Send an empty string to unset this value.
+    #
+    # @option params [String] :dr_call_back_url
+    #   The URL where Vonage will send a webhook when an delivery receipt is received without a specific callback URL configured.
+    #   Send an empty string to unset this value.
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/developer/account#settings
+    #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Vonage::Response) }
+    def update(params)
+      request('/account/settings', params: camelcase(params), type: Post)
+    end
+
+    # Top-up your account balance.
+    #
+    # @option params [required, String] :trx
+    #   The ID associated with your original auto-reload transaction.
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/developer/account#top-up
+    #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Vonage::Response) }
+    def topup(params)
+      request('/account/top-up', params: params, type: Post)
+    end
+  end
+end