vonage 7.2.1 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc5bab327c1d3fb5c689bdd5c8958e3441332ad3e498da73bd1a82a67df6aaf9
-  data.tar.gz: 9c9964bd8cfc08afd014ec8f9af1e4ba1f3c3a58b9c53b223c62e64a2f86bfa2
+  metadata.gz: 71e2807806583d50e0ce062ffaaafbcb69f1629e3ba010a6cedbcc22cfcc0741
+  data.tar.gz: da726714cefba39cd4e78f7356dbc566e4c7a61718b968281e1625c4787f5d84
 SHA512:
-  metadata.gz: b6d915e490cbe3908dc5d62bfc3b2cf245611fcc5bbcd27b10a0c8af41fbc356f2322bd6c98c0fa46623e2a48dffef0ea1f5b831c059d9dd85380f0678eb03bf
-  data.tar.gz: e2abd40a4876cb74772884aaddedfd73726282939a9f1ef361684ff67963155cbe79374571e01a022270060c91a185180e384cf82a74d1ea0fa17a2a1ee3646b
+  metadata.gz: 13e4ce32d69d4bdc899e7143137e926891423e4d838d3ede9d606481e4da5840c47d6c4c4368ee428e1df6264ab36980cecfd485fbf4aa5b183cc340f4b05d72
+  data.tar.gz: 711085663db7d880b0b5fe7d1acee074c08052a13fef61982df704681c6b2482178126ff9b0d3d868514e5b18ef61a7a39259be7095db362699f0778aa0a9918

data/README.md

@@ -1,6 +1,7 @@
 # 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=master)](https://coveralls.io/github/Vonage/vonage-ruby-sdk?branch=master)
+[![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) [![codecov](https://codecov.io/gh/Vonage/vonage-ruby-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/vonage/vonage-ruby-sdk)
+
 
 <img src="https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg" height="48px" alt="Nexmo is now known as Vonage" />
 
@@ -14,6 +15,7 @@ need a Vonage account. Sign up [for free at vonage.com][signup].
     * [Overriding the default hosts](#overriding-the-default-hosts)
     * [JWT authentication](#jwt-authentication)
     * [Webhook signatures](#webhook-signatures)
+    * [Pagination](#pagination)
 * [Documentation](#documentation)
 * [Frequently Asked Questions](#frequently-asked-questions)
     * [Supported APIs](#supported-apis)
@@ -148,6 +150,22 @@ 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.
 
+## Pagination
+
+Vonage APIs paginate list requests. This means that if a collection is requested that is larger than the API default, the API will return the first page of items in the collection. The Ruby SDK provides an `auto_advance` parameter that will traverse through the pages and return all the results in one response object.
+
+The `auto_advance` parameter is set to a default of `true` for the following APIs:
+
+* [Account API](https://developer.nexmo.com/api/developer/account)
+* [Application API](https://developer.nexmo.com/api/application.v2)
+* [Conversation API](https://developer.nexmo.com/api/conversation)
+* [Voice API](https://developer.nexmo.com/api/voice)
+
+To modify the `auto_advance` behavior you can specify it in your method:
+
+```ruby
+client.applications.list(auto_advance: false)
+```
 
 ## Documentation
 

data/lib/vonage/abstract_authentication.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: true
 
 module Vonage
   class AbstractAuthentication

data/lib/vonage/applications.rb

@@ -69,14 +69,22 @@ module Vonage
     # @option params [Integer] :page
     #   The current page number (starts at 1).
     #
+    # @option params [Boolean] :auto_advance
+    #   Set this to `false` to not auto-advance through all the pages in the record
+    #   and collect all the data. The default is `true`.
     # @param [Hash] params
-    #
+    #  
     # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/application.v2#listApplication
     #
-    sig { params(params: T.nilable(T::Hash[Symbol, Integer])).returns(Vonage::Response) }
-    def list(params = nil)
+    sig { params(
+      params: T.nilable(T::Hash[Symbol, Integer]), auto_advance: T::Boolean).returns(Vonage::Applications::ListResponse) }
+    def list(params = nil, auto_advance = true)
+      if params && !params.key?(:auto_advance)
+        params.merge!(auto_advance: true)
+      end
+
       request('/v2/applications', params: params, response_class: ListResponse)
     end
 

data/lib/vonage/applications/list_response.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: true
 
 class Vonage::Applications::ListResponse < Vonage::Response
   include Enumerable

data/lib/vonage/basic.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: true
 
 module Vonage
   class Basic < AbstractAuthentication

data/lib/vonage/bearer_token.rb

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

data/lib/vonage/conversations.rb

@@ -60,14 +60,21 @@ module Vonage
     # @option params ['asc', 'desc'] :order
     #   Return the records in ascending or descending order.
     #
+    # @option params [Boolean] :auto_advance
+    #   Set this to `false` to not auto-advance through all the pages in the record
+    #   and collect all the data. The default is `true`.
     # @param [Hash, nil] params
-    #
+    #  
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#replaceConversation
     #
-    sig { params(params: T.nilable(T::Hash[Symbol, T.untyped])).returns(Vonage::Response) }
-    def list(params = nil)
+    sig { params(params: T.nilable(T::Hash[Symbol, T.untyped]), auto_advance: T::Boolean).returns(Vonage::Response) }
+    def list(params = nil, auto_advance = true)
+      if params && !params.key?(:auto_advance)
+        params.merge!(auto_advance: true)
+      end
+      
       request('/beta/conversations', params: params)
     end
 

data/lib/vonage/conversations/events.rb

@@ -36,12 +36,16 @@ module Vonage
     #
     # @param [String] conversation_id
     #
+    # @option params [Boolean] :auto_advance
+    #   Set this to `false` to not auto-advance through all the pages in the record
+    #   and collect all the data. The default is `true`.
+    #    
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#getEvents
     #
-    def list(conversation_id)
-      request('/beta/conversations/' + conversation_id + '/events')
+    def list(conversation_id, params = nil, auto_advance = true)
+      request('/beta/conversations/' + conversation_id + '/events', params: params)
     end
 
     # Retrieve an event.

data/lib/vonage/conversations/legs.rb

@@ -7,12 +7,16 @@ module Vonage
 
     # List legs.
     #
+    # @option params [Boolean] :auto_advance
+    #   Set this to `false` to not auto-advance through all the pages in the record
+    #   and collect all the data. The default is `true`.     
+    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#listLegs
     #
-    def list
-      request('/beta/legs')
+    def list(params = nil, auto_advance = true)
+      request('/beta/legs', params: params)
     end
 
     # Delete a leg.

data/lib/vonage/conversations/members.rb

@@ -47,12 +47,16 @@ module Vonage
     #
     # @param [String] conversation_id
     #
+    # @option params [Boolean] :auto_advance
+    #   Set this to `false` to not auto-advance through all the pages in the record
+    #   and collect all the data. The default is `true`.
+    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#getMembers
     #
-    def list(conversation_id)
-      request('/beta/conversations/' + conversation_id + '/members')
+    def list(conversation_id, params = nil, auto_advance = true)
+      request('/beta/conversations/' + conversation_id + '/members', params: params)
     end
 
     # Retrieve a member.

data/lib/vonage/conversations/users.rb

@@ -31,12 +31,16 @@ module Vonage
 
     # List users.
     #
+    # @option params [Boolean] :auto_advance
+    #   Set this to `false` to not auto-advance through all the pages in the record
+    #   and collect all the data. The default is `true`.
+    #
     # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#getUsers
     #
-    def list
-      request('/beta/users')
+    def list(params = nil, auto_advance = true)
+      request('/beta/users', params: params)
     end
 
     # Retrieve a user.

data/lib/vonage/entity.rb

@@ -36,8 +36,6 @@ module Vonage
 
     attr_reader :attributes
 
-    protected :attributes
-
     def each_pair(&block)
       return to_enum(:each_pair) unless block
 

data/lib/vonage/form_data.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: true
 
 module Vonage
   module FormData

data/lib/vonage/gsm7.rb

@@ -1,11 +1,14 @@
-# typed: ignore
+# typed: strong
 
 module Vonage
   module GSM7
+    extend T::Sig
+    
     CHARACTERS = "\n\f\r !\"\#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_abcdefghijklmnopqrstuvwxyz{|}~ ¡£¤¥§¿ÄÅÆÉÑÖØÜßàäåæçèéìñòöøùüΓΔΘΛΞΠΣΦΨΩ€"
 
     REGEXP = /\A[#{Regexp.escape(CHARACTERS)}]*\z/
 
+    sig { params(string: T.nilable(String)).returns(T.nilable(Integer)) }
     def self.encoded?(string)
       REGEXP =~ string
     end

data/lib/vonage/json.rb

@@ -6,7 +6,7 @@ module Vonage
   module JSON
     extend T::Sig
 
-    sig { params(http_request: T.any(Net::HTTP::Put, Net::HTTP::Post), params: T::Hash[Symbol, T.untyped]).void }
+    sig { params(http_request: T.any(Net::HTTP::Put, Net::HTTP::Post, Net::HTTP::Get), params: T::Hash[Symbol, T.untyped]).void }
     def self.update(http_request, params)
       http_request['Content-Type'] = 'application/json'
       http_request.body = ::JSON.generate(params)

data/lib/vonage/jwt.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 require 'securerandom'
 require 'openssl'

data/lib/vonage/namespace.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: true
 # frozen_string_literal: true
 require 'net/http'
 require 'json'
@@ -47,41 +47,47 @@ module Vonage
     end
 
     protected
+    # :nocov:
 
     Get = Net::HTTP::Get
     Put = Net::HTTP::Put
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 
-    def request(path, params: nil, type: Get, response_class: Response, &block)
-      uri = URI('https://' + @host + path)
-
-      params ||= {}
-
+    def build_request(path:, type: Get, params: {})
       authentication = self.class.authentication.new(@config)
       authentication.update(params)
 
-      unless type::REQUEST_HAS_BODY || params.empty?
+      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)
 
-      message = type.new(uri)
-
-      message['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
+      # instantiate request
+      request = type.new(uri)
 
+      # set headers
+      request['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
       self.class.request_headers.each do |key, value|
-        message[key] = value
+        request[key] = value
       end
 
-      authentication.update(message)
+      # Set BearerToken if needed
+      authentication.update(request)
+
+      # set body
+      self.class.request_body.update(request, params) if type.const_get(:REQUEST_HAS_BODY)
 
-      self.class.request_body.update(message, params) if type::REQUEST_HAS_BODY
+      request
+    end
 
-      logger.log_request_info(message)
+    def make_request!(request, &block)
+      logger.log_request_info(request)
 
-      response = @http.request(message, &block)
+      response = @http.request(request, &block)
 
       logger.log_response_info(response, @host)
 
@@ -89,7 +95,105 @@ module Vonage
 
       logger.debug(response.body) if response.body
 
-      parse(response, response_class)
+      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
+
+      params = params.tap { |params| params.delete(:auto_advance) } if !params.nil? && params.key?(:auto_advance)
+
+      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, &block)
+      else
+        return if block
+
+        parse(response, response_class)
+      end
+    end
+
+    def iterable_request(path, response: nil, response_class: nil, &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'])
+        end
+
+        if json_response['total_pages']
+          params[:page] = json_response['page'] + 1
+        end
+
+        request = build_request(path: path, type: Get, params: params)
+
+        # Make request...
+        paginated_response = make_request!(request)
+        next_response = parse(paginated_response, response_class)
+        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])
+        else
+          response[collection_name(response)].push(*next_response[collection_name(next_response)])
+        end
+      end
+
+      response
+    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']))
+      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'
+        else
+          params.entity.attributes.keys[0].to_s
+        end
     end
 
     def parse(response, response_class)
@@ -115,4 +219,5 @@ module Vonage
   end
 
   private_constant :Namespace
+  # :nocov:
 end

data/lib/vonage/numbers.rb

@@ -40,7 +40,11 @@ module Vonage
     #
     # @option params [Integer] :index
     #   Page index.
-    #
+    # 
+    # @option params [Boolean] :auto_advance
+    #   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]
@@ -85,6 +89,10 @@ module Vonage
     # @option params [Integer] :index
     #   Page index.
     #
+    # @option params [Boolean] :auto_advance
+    #   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]

data/lib/vonage/numbers/list_response.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: true
 
 class Vonage::Numbers::ListResponse < Vonage::Response
   include Enumerable

data/lib/vonage/numbers/response.rb

@@ -1,8 +1,8 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 class Vonage::Numbers::Response < Vonage::Response
   def success?
-    error_code == '200'
+    T.unsafe(self).error_code == '200'
   end
 end

data/lib/vonage/params.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: true
 # frozen_string_literal: true
 require 'cgi'
 

data/lib/vonage/response.rb

@@ -9,6 +9,7 @@ module Vonage
     end
 
     attr_reader :http_response
+    attr_reader :entity
 
     def respond_to_missing?(name, include_private = false)
       return super if @entity.nil?

data/lib/vonage/secrets.rb

@@ -38,12 +38,16 @@ module Vonage
     #     puts "#{item.created_at} #{item.id}"
     #   end
     #
+    # @option params [Boolean] :auto_advance
+    #   Set this to `false` to not auto-advance through all the pages in the record
+    #   and collect all the data. The default is `true`.
+    #
     # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/account#retrieveAPISecrets
     #
-    def list
-      request('/accounts/' + account_id + '/secrets', response_class: ListResponse)
+    def list(params = nil, auto_advance = true)
+      request('/accounts/' + account_id + '/secrets', params: params, response_class: ListResponse)
     end
 
     # Retrieve one API Secret.

data/lib/vonage/secrets/list_response.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: true
 
 class Vonage::Secrets::ListResponse < Vonage::Response
   include Enumerable

data/lib/vonage/user_agent.rb

@@ -1,8 +1,11 @@
-# typed: ignore
+# typed: strong
 # frozen_string_literal: true
 
 module Vonage
   module UserAgent
+    extend T::Sig
+
+    sig { params(app_name: T.nilable(String), app_version: T.nilable(String)).returns(String) }
     def self.string(app_name, app_version)
       identifiers = []
       identifiers << 'vonage-ruby/' + VERSION

data/lib/vonage/verify.rb

@@ -42,7 +42,7 @@ module Vonage
     #   Use this parameter to explicitly control the language, accent and gender used for the Verify request.
     #
     # @option params [Integer] :pin_expiry
-    #   How log the generated verification code is valid for, in seconds.
+    #   How long the generated verification code is valid for, in seconds.
     #   When you specify both **:pin_expiry** and **:next_event_wait** then **:pin_expiry** must be an integer multiple of **:next_event_wait** otherwise **:pin_expiry** is defaulted to equal **:next_event_wait**.
     #   See [changing the event timings](https://developer.nexmo.com/verify/guides/changing-default-timings).
     #

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = '7.2.1'
+  VERSION = '7.3.0'
 end

data/lib/vonage/voice.rb

@@ -87,13 +87,21 @@ module Vonage
     # @option params [String] :conversation_uuid
     #   Return all the records associated with a specific conversation.
     #
+    # @option params [Boolean] :auto_advance
+    #   Set this to `false` to not auto-advance through all the pages in the record
+    #   and collect all the data. The default is `true`.
+    #
     # @param [Hash] params
     #
     # @return [ListResponse]
     #
     # @see https://developer.nexmo.com/api/voice#getCalls
     #
-    def list(params = nil)
+    def list(params = nil, auto_advance = true)
+      if params && !params.key?(:auto_advance)
+        params.merge!(auto_advance: true)
+      end
+      
       request('/v1/calls', params: params, response_class: ListResponse)
     end
 

data/lib/vonage/voice/list_response.rb

@@ -1,4 +1,4 @@
-# typed: ignore
+# typed: true
 
 class Vonage::Voice::ListResponse < Vonage::Response
   include Enumerable

data/vonage.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.add_dependency('nexmo-jwt', '~> 0.1.2')
   s.add_dependency('zeitwerk', '~> 2', '>= 2.2')
   s.add_dependency('sorbet-runtime', '~> 0.5')
+  s.add_runtime_dependency('rexml')
   s.require_path = 'lib'
   s.metadata = {
     'homepage' => 'https://github.com/Vonage/vonage-ruby-sdk',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.2.1
+  version: 7.3.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nexmo-jwt
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Vonage Server SDK for Ruby
 email:
 - devrel@vonage.com
@@ -147,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.0
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: This is the Ruby Server SDK for Vonage APIs. To use it you'll need a Vonage