plivo 4.6.0 → 4.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50ebb6885dd7e4cf94686ac3d869347ab86d17bf
-  data.tar.gz: 9f1810e64cac9201e96bf3b65fd445d935ca5284
+  metadata.gz: d2abbec45f547e53a13a247ee7bdb26f31989ecd
+  data.tar.gz: 104fb33b21b5b76110bf5a8c1e163fdfe1aff1aa
 SHA512:
-  metadata.gz: 2b06b067eee857a96bab7daa65d0939a086f14ab195f9c351e922d469707de3c049ac4c7ab4533eb2718e4e8c8b4289296633844f12991487ad77d5ffc0861cf
-  data.tar.gz: 4934198948c682574caf6b64c3fa35db2fc0055d092d3712ec216218d7667b8cf11a568860669ba422d3e36a8c0d3e61fe4c72eceb23536d031eae01ee3c9565
+  metadata.gz: 04c349f9f8d3679c55758fa6cf3f99ea2f259b5d433197c1c24e1fd624e625ae879330d9f207a241a1bf2f368ce0025714c99f74d46a7ea5ec15d05b76048d92
+  data.tar.gz: 600404b7732b9943bd1a302ca05baa68e38da599eff55f86a4c90bdb6dfb6af60c282fa9e842a31a25ffefb2a87df487e7b35b161eac6b56ee97d0d030a0e53e

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## [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.
+
 ## [4.6.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.6.0) (2020-03-31)
 - Add application cascade delete support.
 

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

data/examples/jwt.rb

@@ -0,0 +1,23 @@
+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, till)
+  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
+rescue ValidationError => e
+  puts 'Exception: ' + e.message
+end

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_client.rb

@@ -167,7 +167,7 @@ module Plivo
           req.body = data
         end
       else
-        if data.has_key? 'is_callinsights_request'
+        if !data.nil? && (data.has_key? 'is_callinsights_request')
           callinsight_base_url = data['callinsight_base_url']
           resource_path = data['request_url']
           data.delete('is_callinsights_request')

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

@@ -186,18 +186,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)

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/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.0'.freeze
-
+  VERSION = '4.8.1'.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.0
+  version: 4.8.1
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-06-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