plivo 4.6.1 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d52c001b00cc47d25bea87d44a4ce09ae8f922f
-  data.tar.gz: 7938d6bd6d1d1d1612dd455132de25006c3fd30f
+  metadata.gz: bb94696da06990a70578e5b44e4eb14df13ff9ab
+  data.tar.gz: c8d2d47ddd432b5f15adc75a8fc09d3c0c8f7a82
 SHA512:
-  metadata.gz: f886ee8aa69fe4228c300a4476082ba0c05e4e179972b33768d1a73f9ece04b5e071d3f6005510c17e92335e8c9bec97929e22a0253e8fe50bbecac6b166a096
-  data.tar.gz: c3f02372894c4de3be0617b7c9727f54a9f681722c86e164212aba1585850d2f3568f9eca75ef038430e2d3ef186d4eea30b5453cc1700d8618de0c2aa7d05d8
+  metadata.gz: 1a08ee7057cae689aedd2608b23a2fc5184a94ac13786b9a43a47d588e8d987c86ad2a4a86487826a0f8056e0fcd44a2e362d38fb806c95b9ba4ac11751a068c
+  data.tar.gz: 1b8e9f01eaf93503fca9924c045455c7c18500d2a3e081259b3d6175e36ab33ae2f14d7b12ba4445d3c0c4920a457ef798ae6672fa1a1918047b21a0250acc88

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # 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.
+
+## [4.8.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.8.0) (2020-05-28)
+- Add JWT helper functions.
+
+## [4.7.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.7.1) (2020-05-06)
+- Fix Send MMS with existing media_ids.
+
+## [4.7.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.7.0) (2020-04-29)
+- Add V3 signature helper functions.
+
 ## [4.6.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.6.1) (2020-04-02)
 - Add nil check for API requests.
 

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.6.1'
+gem 'plivo', '>= 4.9.0'
 ```
 
 And then execute:

data/examples/jwt.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+AUTH_ID = 'MADADADADADADADADADA'
+AUTH_TOKEN = 'AUTH_TOKEN'
+
+begin
+  acctkn = Plivo::Token::AccessToken.new(
+    AUTH_ID,
+    AUTH_TOKEN,
+    '{username}',
+    '{uid}'
+  )
+  # 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.rb

@@ -5,6 +5,7 @@ require_relative 'plivo/base'
 require_relative 'plivo/resources'
 require_relative 'plivo/rest_client'
 require_relative 'plivo/xml'
+require_relative 'plivo/jwt'
 require_relative 'plivo/phlo_client'
 require_relative 'plivo/base_client'
 

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/jwt.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'uri'
+require 'base64'
+require 'date'
+require 'jwt'
+
+module Plivo
+  module Token
+    include Utils
+
+    class VoiceGrants
+      attr_reader :incoming_allow, :outgoing_allow
+
+      def initialize(incoming = nil, outgoing = nil)
+        Utils.valid_param?(:incoming, incoming, [TrueClass, FalseClass], false)
+        Utils.valid_param?(:outgoing, outgoing, [TrueClass, FalseClass], false)
+        @incoming_allow = incoming
+        @outgoing_allow = outgoing
+      end
+
+      def to_hash
+        hash = {}
+        instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
+        hash
+      end
+    end
+
+    class AccessToken
+      attr_reader :uid, :username, :valid_from, :lifetime, :grants
+      def initialize(auth_id = nil, auth_token = nil, username = nil, uid = nil)
+        configure_credentials(auth_id, auth_token)
+        Utils.valid_param?(:username, username, [String, Symbol], true)
+        @username = username
+
+        Utils.valid_param?(:uid, uid, [String, Symbol], false)
+        uid ||= username + '-' + Time.now.to_i
+        @uid = uid
+        update_validity
+      end
+
+      def update_validity(valid_from = nil, lifetime = nil, valid_till = nil)
+        Utils.valid_param?(:valid_from, valid_from, [Time, Integer], false)
+        Utils.valid_param?(:lifetime, lifetime, [Integer], false)
+        Utils.valid_param?(:valid_till, valid_till, [Time, Integer], false)
+
+        if valid_from.nil?
+          @lifetime = lifetime || 84_600
+          @valid_from = if valid_till.nil?
+                          Time.now
+                        else
+                          Time.at(valid_till.to_i - @lifetime).utc
+                        end
+
+        elsif valid_till.nil?
+          @lifetime = lifetime || 84_600
+          @valid_from = valid_from
+        else
+          unless lifetime.nil?
+            raise Exceptions::ValidationError, 'use any 2 of valid_from, lifetime and valid_till'
+          end
+
+          @valid_from = valid_from
+          @lifetime = valid_till.to_i - valid_from.to_i
+        end
+
+        return unless @lifetime < 180 || @lifetime > 84_600
+
+        raise Exceptions::ValidationError, 'validity out of [180, 84600] seconds'
+      end
+
+      def auth_id
+        @auth_credentials[:auth_id]
+      end
+
+      def add_voice_grants(grants)
+        Utils.valid_param?(:grants, grants, [VoiceGrants], true)
+        @grants = grants
+      end
+
+      def to_jwt
+        payload = {
+          jti: uid,
+          sub: username,
+          iss: auth_id,
+          nbf: valid_from.to_i,
+          exp: valid_from.to_i + lifetime,
+          grants: {
+            voice: grants.to_hash || {}
+          }
+        }
+        JWT.encode payload, key, 'HS256', {typ: 'JWT', cty: 'plivo;v=1'}
+      end
+
+      private
+
+      def key
+        @auth_credentials[:auth_token]
+      end
+
+      def configure_credentials(auth_id, auth_token)
+        # Fetches and sets the right credentials
+        auth_id ||= ENV['PLIVO_AUTH_ID']
+        auth_token ||= ENV['PLIVO_AUTH_TOKEN']
+
+        raise Exceptions::AuthenticationError, 'Couldn\'t find auth credentials' unless
+          auth_id && auth_token
+
+        raise Exceptions::AuthenticationError, "Invalid auth_id: '#{auth_id}'" unless
+          Utils.valid_account?(auth_id)
+
+        @auth_credentials = {
+          auth_id: auth_id,
+          auth_token: auth_token
+        }
+      end
+    end
+  end
+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
@@ -186,18 +187,12 @@ module Plivo
       end
 
       def to_s
-        unless @members.nil?
-          members_json = @members.map do |member|
-            JSON.parse(to_json_member(member))
-          end
+        response_json = {}
+        response_variables = self.instance_variables.drop(5)
+        response_variables.each do |variable|
+          response_json[variable.to_s[1..-1]] = self.instance_variable_get(variable)
         end
-        {
-          conference_name: @conference_name,
-          conference_run_time: @conference_run_time,
-          conference_member_count: @conference_member_count,
-          members: members_json,
-          api_id: @api_id
-        }.to_s
+        return response_json.to_s
       end
 
       def to_json_member(member)
@@ -221,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/messages.rb

@@ -69,6 +69,7 @@ module Plivo
       # @option options [String] :log If set to false, the content of this message will not be logged on the Plivo infrastructure and the dst value will be masked (e.g., 141XXXXX528). Default is set to true.
       # @option options [String] :trackable set to false
       #@option options[List]: media_urls Minimum one media url should be present in Media urls list to send mms. Maximum allowd 10 media urls inside the list (e.g, media_urls : ['https//example.com/test.jpg', 'https://example.com/abcd.gif'])
+      #@option options[List]: media_ids Minimum one media ids should be present in Media ids list to send mms. Maximum allowd 10 media ids inside the list (e.g, media_ids : ['1fs211ba-355b-11ea-bbc9-02121c1190q7'])
 
       def create(src, dst, text = nil, options = nil, powerpack_uuid = nil)
         valid_param?(:src, src, [Integer, String, Symbol], false)
@@ -130,6 +131,10 @@ module Plivo
           valid_param?(:media_urls, options[:media_urls], Array, true)
          params[:media_urls] = options[:media_urls]
         end
+        if options.key?(:media_ids) &&
+          valid_param?(:media_ids, options[:media_ids], Array, true)
+         params[:media_ids] = options[:media_ids]
+        end
         perform_create(params)
       end
 
@@ -148,6 +153,7 @@ module Plivo
       # @option options [Int] :offset Denotes the number of value items by which the results should be offset. Eg:- If the result contains a 1000 values and limit is set to 10 and offset is set to 705, then values 706 through 715 are displayed in the results. This parameter is also used for pagination of the results.
       # @option options [String] :error_code Delivery Response code returned by the carrier attempting the delivery. See Supported error codes {https://www.plivo.com/docs/api/message/#standard-plivo-error-codes}.
       #@option options[List]: media_urls Minimum one media url should be present in Media urls list to send mms. Maximum allowd 10 media urls inside the list (e.g, media_urls : ['https//example.com/test.jpg', 'https://example.com/abcd.gif'])
+      #@option options[List]: media_ids Minimum one media ids should be present in Media ids list to send mms. Maximum allowd 10 media ids inside the list (e.g, media_ids : ['1fs211ba-355b-11ea-bbc9-02121c1190q7'])
       def list(options = nil)
         return perform_list if options.nil?
         valid_param?(:options, options, Hash, true)

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/utils.rb

@@ -101,11 +101,83 @@ module Plivo
     # @param [String] auth_token
     def valid_signature?(uri, nonce, signature, auth_token)
       parsed_uri = URI.parse(uri)
-      uri_details = { host: parsed_uri.host, path: parsed_uri.path }
+      uri_details = {host: parsed_uri.host, path: parsed_uri.path}
       uri_builder_module = parsed_uri.scheme == 'https' ? URI::HTTPS : URI::HTTP
       data_to_sign = uri_builder_module.build(uri_details).to_s + nonce
       sha256_digest = OpenSSL::Digest.new('sha256')
       Base64.encode64(OpenSSL::HMAC.digest(sha256_digest, auth_token, data_to_sign)).strip() == signature
     end
+
+    def generate_url?(uri, params, method)
+      uri.sub!("+", "%20")
+      parsed_uri = URI.parse(uri)
+      uri = parsed_uri.scheme + "://" + parsed_uri.host + parsed_uri.path
+      if params.to_s.length > 0 || parsed_uri.query.to_s.length > 0
+        uri += "?"
+      end
+      if parsed_uri.query.to_s.length > 0
+        parsed_uri_query = URI.decode(parsed_uri.query)
+        if method == "GET"
+          queryParamMap = getMapFromQueryString?(parsed_uri_query)
+          params.keys.sort.each { |key|
+            queryParamMap[key] = params[key]
+          }
+          uri += GetSortedQueryParamString?(queryParamMap, true)
+        else
+          uri += GetSortedQueryParamString?(getMapFromQueryString?(parsed_uri_query), true) + "." + GetSortedQueryParamString?(params, false)
+          uri = uri.chomp(".")
+        end
+      else
+        if method == "GET"
+          uri += GetSortedQueryParamString?(params, true)
+        else
+          uri += GetSortedQueryParamString?(params, false)
+        end
+      end
+      return uri
+    end
+
+    def getMapFromQueryString?(query)
+      mp = Hash.new
+      if query.to_s.length == 0
+        return mp
+      end
+      keyValuePairs = query.split("&")
+      keyValuePairs.each { |key|
+        params = key.split("=", 2)
+        if params.length == 2
+          mp[params[0]] = params[1]
+        end
+      }
+      return mp
+    end
+
+    def GetSortedQueryParamString?(params, queryParams)
+      url = ""
+      if queryParams
+        params.keys.sort.each { |key|
+          url += key + "=" + params[key] + "&"
+        }
+        url = url.chomp("&")
+      else
+        params.keys.sort.each { |key|
+          url += key.to_s + params[key].to_s
+        }
+      end
+      return url
+    end
+
+
+    def compute_signatureV3?(url, auth_token, nonce)
+      sha256_digest = OpenSSL::Digest.new('sha256')
+      new_url = url + "." + nonce
+      return Base64.encode64(OpenSSL::HMAC.digest(sha256_digest, auth_token, new_url)).strip()
+    end
+
+    def valid_signatureV3?(uri, nonce, signature, auth_token, method, params={})
+      new_url = generate_url?(uri, params, method)
+      generated_signature = compute_signatureV3?(new_url, auth_token, nonce)
+      return signature.split(",").include? generated_signature
+    end
   end
 end

data/lib/plivo/version.rb

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

data/plivo.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday', '~> 0.9'
   spec.add_dependency 'faraday_middleware', '~> 0.12.2'
   spec.add_dependency 'htmlentities'
+  spec.add_dependency 'jwt'
 
   spec.add_development_dependency 'bundler', '>= 1.14', '<3.0'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.9.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,7 @@ files:
 - Rakefile
 - ci/config.yml
 - examples/conference_bridge.rb
+- examples/jwt.rb
 - examples/multi_party_call.rb
 - examples/phlos.rb
 - lib/plivo.rb
@@ -159,6 +174,7 @@ files:
 - lib/plivo/base/response.rb
 - lib/plivo/base_client.rb
 - lib/plivo/exceptions.rb
+- lib/plivo/jwt.rb
 - lib/plivo/phlo_client.rb
 - lib/plivo/resources.rb
 - lib/plivo/resources/accounts.rb