plivo 4.8.1 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2abbec45f547e53a13a247ee7bdb26f31989ecd
-  data.tar.gz: 104fb33b21b5b76110bf5a8c1e163fdfe1aff1aa
+  metadata.gz: bb94696da06990a70578e5b44e4eb14df13ff9ab
+  data.tar.gz: c8d2d47ddd432b5f15adc75a8fc09d3c0c8f7a82
 SHA512:
-  metadata.gz: 04c349f9f8d3679c55758fa6cf3f99ea2f259b5d433197c1c24e1fd624e625ae879330d9f207a241a1bf2f368ce0025714c99f74d46a7ea5ec15d05b76048d92
-  data.tar.gz: 600404b7732b9943bd1a302ca05baa68e38da599eff55f86a4c90bdb6dfb6af60c282fa9e842a31a25ffefb2a87df487e7b35b161eac6b56ee97d0d030a0e53e
+  metadata.gz: 1a08ee7057cae689aedd2608b23a2fc5184a94ac13786b9a43a47d588e8d987c86ad2a4a86487826a0f8056e0fcd44a2e362d38fb806c95b9ba4ac11751a068c
+  data.tar.gz: 1b8e9f01eaf93503fca9924c045455c7c18500d2a3e081259b3d6175e36ab33ae2f14d7b12ba4445d3c0c4920a457ef798ae6672fa1a1918047b21a0250acc88

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## [4.9.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.9.0) (2020-07-23)
+- Add retries to multiple regions for voice requests.
+
 ## [4.8.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.8.1) (2020-06-05)
 - Fix Record a Conference API response.
 

data/README.md

@@ -8,7 +8,7 @@ The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby a
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'plivo', '>= 4.8.1'
+gem 'plivo', '>= 4.9.0'
 ```
 
 And then execute:

data/examples/jwt.rb

@@ -13,11 +13,20 @@ begin
     '{username}',
     '{uid}'
   )
-  # update token validity (from, lifetime, till)
+  # update token validity (from, lifetime)
   acctkn.update_validity(Time.now, 300)
   # add voice grants (incoming, outgoing)
   acctkn.add_voice_grants(Plivo::Token::VoiceGrants.new(true, true))
   puts acctkn.to_jwt
+
+  # update token validity (from, nil, till)
+  acctkn.update_validity(Time.now, nil, Time.now + 300)
+  # add voice grants (incoming, outgoing)
+  acctkn.add_voice_grants(Plivo::Token::VoiceGrants.new(true, true))
+  puts acctkn.to_jwt
 rescue ValidationError => e
   puts 'Exception: ' + e.message
 end
+
+# Sample Response:
+#

data/lib/plivo/base.rb

@@ -5,6 +5,11 @@ require_relative 'base/response'
 module Plivo
   module Base
     PLIVO_API_URL = 'https://api.plivo.com'.freeze
+
+    API_VOICE = 'https://voice.plivo.com'.freeze
+    API_VOICE_FALLBACK_1 = 'https://voice-usw1.plivo.com'.freeze
+    API_VOICE_FALLBACK_2 = 'https://voice-use1.plivo.com'.freeze
+
     CALLINSIGHTS_API_URL = 'https://stats.plivo.com'.freeze
     PHLO_API_URL = 'https://phlorunner.plivo.com'.freeze
   end

data/lib/plivo/base/resource.rb

@@ -8,6 +8,7 @@ module Plivo
         configure_client(client)
         configure_options(options) if options
         configure_resource_uri
+        @_is_voice_request = false
       end
 
       private
@@ -56,7 +57,7 @@ module Plivo
           'without an identifier')
         end
 
-        response_json = @_client.send_request(@_resource_uri, 'POST', params, nil, use_multipart_conn)
+        response_json = @_client.send_request(@_resource_uri, 'POST', params, nil, use_multipart_conn, is_voice_request: @_is_voice_request)
 
         parse_and_set(params)
         parse_and_set(response_json)
@@ -65,7 +66,7 @@ module Plivo
 
       def perform_action(action = nil, method = 'GET', params = nil, parse = false)
         resource_path = action ? @_resource_uri + action + '/' : @_resource_uri
-        response = @_client.send_request(resource_path, method, params)
+        response = @_client.send_request(resource_path, method, params,nil,false,is_voice_request: @_is_voice_request)
         parse ? parse_and_set(response) : self
         method == 'POST' ? parse_and_set(params) : self
         self
@@ -73,7 +74,7 @@ module Plivo
       
       def perform_custome_action(action = nil, method = 'GET', params = nil, parse = false)
         resource_path = action ? @_resource_uri + action + '/' : @_resource_uri
-        response = @_client.send_request(resource_path, method, params)
+        response = @_client.send_request(resource_path, method, params,nil,false,is_voice_request: @_is_voice_request)
         parse ? parse_and_set(response) : self
         method == 'POST' ? parse_and_set(params) : self
         self
@@ -81,7 +82,7 @@ module Plivo
 
       def perform_action_apiresponse(action = nil, method = 'GET', params = nil, parse = false)
         resource_path = action ? @_resource_uri + action + '/' : @_resource_uri
-        response = @_client.send_request(resource_path, method, params)
+        response = @_client.send_request(resource_path, method, params,nil,false,is_voice_request: @_is_voice_request)
         parse ? parse_and_set(response) : self
         method == 'POST' ? parse_and_set(params) : self
         method == 'DELETE' ? parse_and_set(params) : self
@@ -90,7 +91,7 @@ module Plivo
 
       def perform_custom_action_apiresponse(action = nil, method = 'GET', params = nil, parse = false)
         resource_path = action ? '/v1/Account/' + @_client.auth_id + '/'+ action + '/' : @_resource_uri
-        response = @_client.send_request(resource_path, method, params)
+        response = @_client.send_request(resource_path, method, params,nil,false,is_voice_request: @_is_voice_request)
         parse ? parse_and_set(response) : self
         method == 'POST' ? parse_and_set(params) : self
         method == 'DELETE' ? parse_and_set(params) : self
@@ -103,12 +104,12 @@ module Plivo
           'without an identifier')
         end
 
-        Response.new(@_client.send_request(@_resource_uri, 'DELETE', params),
+        Response.new(@_client.send_request(@_resource_uri, 'DELETE', params, nil, false, is_voice_request: @_is_voice_request),
                      @_identifier_string)
       end
 
       def perform_run(params)
-        response_json = @_client.send_request(@_resource_uri, 'POST', params, nil)
+        response_json = @_client.send_request(@_resource_uri, 'POST', params, nil,false,is_voice_request: @_is_voice_request)
         parse_and_set(response_json)
         Response.new(response_json, @_identifier_string)
       end

data/lib/plivo/base/resource_interface.rb

@@ -6,6 +6,7 @@ module Plivo
         configure_client(client)
         configure_resource_uri
         parse_and_set(resource_list_json) if resource_list_json
+        @_is_voice_request = false
       end
 
       private
@@ -41,25 +42,25 @@ module Plivo
 
       def perform_get(identifier, params = nil)
         valid_param?(:identifier, identifier, [String, Symbol], true)
-        response_json = @_client.send_request(@_resource_uri + identifier.to_s + '/', 'GET', params)
+        response_json = @_client.send_request(@_resource_uri + identifier.to_s + '/', 'GET', params, nil, false, is_voice_request: @_is_voice_request)
         @_resource_type.new(@_client, resource_json: response_json)
       end
 
       def perform_get_without_identifier(params)
         valid_param?(:params, params, Hash, true)
-        response_json = @_client.send_request(@_resource_uri, 'GET', params)
+        response_json = @_client.send_request(@_resource_uri, 'GET', params, nil, false, is_voice_request: @_is_voice_request)
         @_resource_type.new(@_client, resource_json: response_json)
       end
 
       def perform_create(params, use_multipart_conn=false)
         Response.new(
-          @_client.send_request(@_resource_uri, 'POST', params, nil, use_multipart_conn),
+          @_client.send_request(@_resource_uri, 'POST', params, nil, use_multipart_conn, is_voice_request: @_is_voice_request),
           @_identifier_string
         )
       end
 
       def perform_post(params)
-        response_json = @_client.send_request(@_resource_uri, 'POST', params)
+        response_json = @_client.send_request(@_resource_uri, 'POST', params, nil, false, is_voice_request: @_is_voice_request)
 
         parse_and_set(response_json)
         self
@@ -74,7 +75,7 @@ module Plivo
       end
 
       def perform_list(params = nil)
-        response_json = @_client.send_request(@_resource_uri, 'GET', params)
+        response_json = @_client.send_request(@_resource_uri, 'GET', params, nil, false, is_voice_request: @_is_voice_request)
         parse_and_set(response_json)
         {
           api_id: @api_id,
@@ -85,14 +86,14 @@ module Plivo
       
       def perform_action(action = nil, method = 'GET', params = nil, parse = false)
         resource_path = action ? @_resource_uri + action + '/' : @_resource_uri
-        response = @_client.send_request(resource_path, method, params)
+        response = @_client.send_request(resource_path, method, params, nil, false, is_voice_request: @_is_voice_request)
         parse ? parse_and_set(response) : self
         method == 'POST' ? parse_and_set(params) : self
         self
       end
 
       def perform_list_without_object(params = nil)
-        response_json = @_client.send_request(@_resource_uri, 'GET', params)
+        response_json = @_client.send_request(@_resource_uri, 'GET', params, nil, false, is_voice_request: @_is_voice_request)
         parse_and_set(response_json)
         response_json
       end

data/lib/plivo/base_client.rb

@@ -13,7 +13,7 @@ module Plivo
   class BaseClient
     # Base stuff
     attr_reader :headers, :auth_credentials
-
+    @@voice_retry_count = 0
     def initialize(auth_id = nil, auth_token = nil, proxy_options = nil, timeout=5)
       configure_credentials(auth_id, auth_token)
       configure_proxies(proxy_options)
@@ -36,21 +36,42 @@ module Plivo
       elsif !([200, 201, 202, 207].include? response[:status])
         raise Exceptions::PlivoRESTError, "Received #{response[:status]} for #{method}"
       end
-
+      @@voice_retry_count = 0
       response[:body]
     end
 
-    def send_request(resource_path, method = 'GET', data = {}, timeout = nil, use_multipart_conn = false)
+    def send_request(resource_path, method = 'GET', data = {}, timeout = nil, use_multipart_conn = false, options = nil)
       timeout ||= @timeout
 
-      response = case method
-                 when 'GET' then send_get(resource_path, data, timeout)
-                 when 'POST' then send_post(resource_path, data, timeout, use_multipart_conn)
-                 when 'DELETE' then send_delete(resource_path, data, timeout)
-                 else raise_invalid_request("#{method} not supported by Plivo, yet")
-                 end
+      if options[:is_voice_request] == true
+        response = case method
+                   when 'GET' then send_get(resource_path, data, timeout, is_voice_request: options[:is_voice_request], voice_retry_count: @@voice_retry_count)
+                   when 'POST' then send_post(resource_path, data, timeout, use_multipart_conn, is_voice_request: options[:is_voice_request], voice_retry_count: @@voice_retry_count)
+                   when 'DELETE' then send_delete(resource_path, data, timeout, is_voice_request: options[:is_voice_request], voice_retry_count: @@voice_retry_count)
+                   else raise_invalid_request("#{method} not supported by Plivo, yet")
+                   end
+
+        if response.status >= 500
+          @@voice_retry_count += 1
+          if @@voice_retry_count > 2
+            return process_response(method, response.to_hash)
+          end
+          is_voice_request = true
+          send_request(resource_path, method, data, timeout, use_multipart_conn, is_voice_request: is_voice_request)
+        else
+          process_response(method, response.to_hash)
+        end
 
-      process_response(method, response.to_hash)
+      else
+        response = case method
+                   when 'GET' then send_get(resource_path, data, timeout)
+                   when 'POST' then send_post(resource_path, data, timeout, use_multipart_conn)
+                   when 'DELETE' then send_delete(resource_path, data, timeout)
+                   else raise_invalid_request("#{method} not supported by Plivo, yet")
+                   end
+
+        process_response(method, response.to_hash)
+      end
     end
     
     private
@@ -118,6 +139,45 @@ module Plivo
         faraday.adapter Faraday.default_adapter
       end
 
+      @voice_conn_no_retry = Faraday.new(@voice_base_uri) do |faraday|
+        faraday.headers = @headers
+
+        # DANGER: Basic auth should always come after headers, else
+        # The headers will replace the basic_auth
+
+        faraday.basic_auth(auth_id, auth_token)
+
+        faraday.proxy=@proxy_hash if @proxy_hash
+        faraday.response :json, content_type: /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
+
+      @voice_conn_retry_1 = Faraday.new(@voice_base_uri_fallback_1) do |faraday|
+        faraday.headers = @headers
+
+        # DANGER: Basic auth should always come after headers, else
+        # The headers will replace the basic_auth
+
+        faraday.basic_auth(auth_id, auth_token)
+
+        faraday.proxy=@proxy_hash if @proxy_hash
+        faraday.response :json, content_type: /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
+
+      @voice_conn_retry_2 = Faraday.new(@voice_base_uri_fallback_2) do |faraday|
+        faraday.headers = @headers
+
+        # DANGER: Basic auth should always come after headers, else
+        # The headers will replace the basic_auth
+
+        faraday.basic_auth(auth_id, auth_token)
+
+        faraday.proxy=@proxy_hash if @proxy_hash
+        faraday.response :json, content_type: /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
+
       @callinsights_conn = Faraday.new(@callinsights_base_uri) do |faraday|
         faraday.headers = @headers
 
@@ -133,15 +193,34 @@ module Plivo
 
     end
 
-    def send_get(resource_path, data, timeout)
-      response = @conn.get do |req|
-        req.url resource_path, data
-        req.options.timeout = timeout if timeout
+    def send_get(resource_path, data, timeout, options = nil)
+      if options
+        if options[:voice_retry_count] == 0 and options[:is_voice_request] == true
+          response = @voice_conn_no_retry.get do |req|
+            req.url resource_path, data
+            req.options.timeout = timeout if timeout
+          end
+        elsif options[:voice_retry_count] == 1 and options[:is_voice_request] == true
+          response = @voice_conn_retry_1.get do |req|
+            req.url resource_path, data
+            req.options.timeout = timeout if timeout
+          end
+        elsif options[:voice_retry_count] == 2 and options[:is_voice_request] == true
+          response = @voice_conn_retry_2.get do |req|
+            req.url resource_path, data
+            req.options.timeout = timeout if timeout
+          end
+        end
+      else
+        response = @conn.get do |req|
+          req.url resource_path, data
+          req.options.timeout = timeout if timeout
+        end
       end
       response
     end
 
-    def send_post(resource_path, data, timeout, use_multipart_conn)
+    def send_post(resource_path, data, timeout, use_multipart_conn, options = nil)
       if use_multipart_conn
         multipart_conn = Faraday.new(@base_uri) do |faraday|
           faraday.headers = {
@@ -178,7 +257,26 @@ module Plivo
             req.options.timeout = timeout if timeout
             req.body = JSON.generate(data) if data
           end
-
+        elsif options
+          if options[:voice_retry_count] == 0 and options[:is_voice_request] == true
+            response = @voice_conn_no_retry.post do |req|
+              req.url resource_path
+              req.options.timeout = timeout if timeout
+              req.body = JSON.generate(data) if data
+            end
+          elsif options[:voice_retry_count] == 1 and options[:is_voice_request] == true
+            response = @voice_conn_retry_1.post do |req|
+              req.url resource_path
+              req.options.timeout = timeout if timeout
+              req.body = JSON.generate(data) if data
+            end
+          elsif options[:voice_retry_count] == 2 and options[:is_voice_request] == true
+            response = @voice_conn_retry_2.post do |req|
+              req.url resource_path
+              req.options.timeout = timeout if timeout
+              req.body = JSON.generate(data) if data
+            end
+          end
         else
           response = @conn.post do |req|
             req.url resource_path
@@ -190,11 +288,33 @@ module Plivo
       response
     end
 
-    def send_delete(resource_path, data, timeout)
-      response = @conn.delete do |req|
-        req.url resource_path
-        req.options.timeout = timeout if timeout
-        req.body = JSON.generate(data) if data
+    def send_delete(resource_path, data, timeout, options = nil)
+      if options
+        if options[:voice_retry_count] == 0 and options[:is_voice_request] == true
+          response = @voice_conn_no_retry.delete do |req|
+            req.url resource_path
+            req.options.timeout = timeout if timeout
+            req.body = JSON.generate(data) if data
+          end
+        elsif options[:voice_retry_count] == 1 and options[:is_voice_request] == true
+          response = @voice_conn_retry_1.delete do |req|
+            req.url resource_path
+            req.options.timeout = timeout if timeout
+            req.body = JSON.generate(data) if data
+          end
+        elsif options[:voice_retry_count] == 2 and options[:is_voice_request] == true
+          response = @voice_conn_retry_2.delete do |req|
+            req.url resource_path
+            req.options.timeout = timeout if timeout
+            req.body = JSON.generate(data) if data
+          end
+        end
+      else
+        response = @conn.delete do |req|
+          req.url resource_path
+          req.options.timeout = timeout if timeout
+          req.body = JSON.generate(data) if data
+        end
       end
       response
     end

data/lib/plivo/resources/applications.rb

@@ -8,6 +8,7 @@ module Plivo
         @_name = 'Application'
         @_identifier_string = 'app_id'
         super
+        @_is_voice_request = true
       end
 
       # @param [Hash] options
@@ -109,6 +110,7 @@ module Plivo
         @_resource_type = Application
         @_identifier_string = 'app_id'
         super
+        @_is_voice_request = true
       end
 
       # @param [String] app_id

data/lib/plivo/resources/calls.rb

@@ -6,6 +6,7 @@ module Plivo
         @_name = 'Call'
         @_identifier_string = 'call_uuid'
         super
+        @_is_voice_request = true
       end
 
       def update(options)
@@ -199,7 +200,7 @@ module Plivo
 
       def cancel_request
         resource_path = @_resource_uri.sub('Call', 'Request')
-        @_client.send_request(resource_path, 'DELETE', nil)
+        @_client.send_request(resource_path, 'DELETE', nil, nil, false , is_voice_request: @_is_voice_request)
       end
 
       def to_s
@@ -240,6 +241,7 @@ module Plivo
         @_resource_type = Call
         @_identifier_string = 'call_uuid'
         super
+        @_is_voice_request = true
       end
 
       ##
@@ -288,9 +290,9 @@ module Plivo
           answer_method: answer_method
         }
 
-        return perform_create(params) if options.nil?
+        return perform_create(params, false) if options.nil?
 
-        perform_create(params.merge(options))
+        perform_create(params.merge(options), false)
       end
 
       ##

data/lib/plivo/resources/conferences.rb

@@ -6,6 +6,7 @@ module Plivo
         @_name = 'Conference'
         @_identifier_string = 'conference_name'
         super
+        @_is_voice_request = true
       end
 
       def delete
@@ -215,6 +216,7 @@ module Plivo
         @_resource_type = Conference
         @_identifier_string = 'conference_name'
         super
+        @_is_voice_request = true
       end
 
       def get(conference_name)

data/lib/plivo/resources/endpoints.rb

@@ -6,6 +6,7 @@ module Plivo
         @_name = 'Endpoint'
         @_identifier_string = 'endpoint_id'
         super
+        @_is_voice_request = true
       end
 
       # @param [Hash] options
@@ -71,6 +72,7 @@ module Plivo
         @_resource_type = Endpoint
         @_identifier_string = 'endpoint_id'
         super
+        @_is_voice_request = true
       end
 
       # @param [String] endpoint_id

data/lib/plivo/resources/recordings.rb

@@ -6,6 +6,7 @@ module Plivo
         @_name = 'Recording'
         @_identifier_string = 'recording_id'
         super
+        @_is_voice_request = true
       end
 
       def delete
@@ -36,6 +37,7 @@ module Plivo
         @_resource_type = Recording
         @_identifier_string = 'recording_id'
         super
+        @_is_voice_request = true
       end
 
       # @param [Hash] options

data/lib/plivo/rest_client.rb

@@ -24,6 +24,9 @@ module Plivo
 
     def configure_base_uri
       @base_uri = Base::PLIVO_API_URL
+      @voice_base_uri = Base::API_VOICE
+      @voice_base_uri_fallback_1 = Base::API_VOICE_FALLBACK_1
+      @voice_base_uri_fallback_2 = Base::API_VOICE_FALLBACK_2
       @callinsights_base_uri = Base::CALLINSIGHTS_API_URL
     end
 

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = '4.8.1'.freeze
+  VERSION = '4.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.8.1
+  version: 4.9.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday