plivo 4.17.1 → 4.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e0cf782f59b0fdc5751760de942c004c486b88e
-  data.tar.gz: '059f69a1d0dbba6f854a5d36f9dae7b84f18acaf'
+  metadata.gz: d4221884a48c30837e399b3cccf82a2b316b1c8b
+  data.tar.gz: 439b0e03c1e2208bc8c00670decba683c9c4a8d9
 SHA512:
-  metadata.gz: 2cf38bfcd9981dba0492dbd15fbb7698140a6ff65a58498887289de19d04cac4885fc5468b84e24f3ad80d1232c62af9b80e07def7b64845d0ed92a0592df5f4
-  data.tar.gz: abbcd68c9a8b41abd9a7f5dcad3d0bfdf22dc72ab49f87ade0138dd954d71c95bd1a990f829c90e1c14b1d6c728bb2071eb4b9090833bfe12e7c628233b58872
+  metadata.gz: d349d186ca2bd0b10e6b38b29bb1d44f431e9e00fc97643e72f82c78ff154f1850df29a030bc6fcad71cf7e9e74831d0049b94a2eb5eb3c091fe833d364e461e
+  data.tar.gz: f2cc7bdb7e9aafa70a7954c20f6344a25833e565ad8db8d3bff362de546bb46139a886757b3290e4c3f5ca2ecb8e6726aedc3ebbf81dbd4563d0fed70758b656

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## [4.21.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.21.0) (2021-10-11)
+**Features - Messaging**
+- This version includes advancements to the Messaging Interface that deals with the [Send SMS/MMS](https://www.plivo.com/docs/sms/api/message#send-a-message) interface, Creating a standard structure for `request/input` arguments to make implementation easier and incorporating support for the older interface.
+
+  Example for [send SMS](https://github.com/plivo/plivo-ruby#send-a-message)
+
+## [4.20.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.20.0) (2021-08-04)
+- Added continue speak XML element support.
+
+## [4.19.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.19.0) (2021-07-19)
+- Add support for Voice MultiPartyCall APIs (includes retry) and XML, validate voice UTs
+
+## [4.18.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.18.0) (2021-07-13)
+- Power pack ID has been included to the response for the [list all messages API](https://www.plivo.com/docs/sms/api/message/list-all-messages/) and the [get message details API](https://www.plivo.com/docs/sms/api/message#retrieve-a-message).
+- Support for filtering messages by Power pack ID has been added to the [list all messages API](https://www.plivo.com/docs/sms/api/message#list-all-messages).
+
 ## [4.17.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.17.1) (2021-06-18)
 - **WARNING**: Remove total_count field from meta data for list MDR response
 

data/README.md

@@ -8,9 +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.17.1'
-
+gem 'plivo', '>= 4.21.0'
 ```
 
 And then execute:
@@ -41,7 +39,7 @@ client = RestClient.new;
 Alternatively, you can specifiy the authentication credentials while initializing the `RestClient`.
 
 ```ruby
-client = RestClient.new('your_auth_id', 'your_auth_token');
+client = RestClient.new('<auth_id>', '<auth_token>');
 ```
 
 ### The basics
@@ -78,17 +76,15 @@ end
 ### Send a message
 
 ```ruby
-require 'rubygems'
-require 'plivo'
-
+require "plivo"
 include Plivo
 
 client = RestClient.new
-message_created = client.messages.create(
-  'your_source_number',
-  %w[your_destination_number_1 your_destination_number_2],
-  'Hello, world!'
-)
+response = client.messages.create(
+  src: '+14156667778',
+  dst: '+14156667777',
+  text: 'Hello, this is a sample text'
+  )
 ```
 
 ### Make a call
@@ -101,8 +97,8 @@ include Plivo
 
 client = RestClient.new
 call_made = client.calls.create(
-  'your_source_number',
-  ['your_destination_number'],
+  '+14156667778',
+  ['+14156667777'],
   'https://answer.url'
 )
 ```
@@ -151,10 +147,7 @@ require 'plivo'
 
 include Plivo
 
-AUTH_ID = 'AUTH_ID'
-AUTH_TOKEN = 'AUTH_TOKEN'
-
-client = Phlo.new(AUTH_ID, AUTH_TOKEN)
+client = Phlo.new('<auth_id>', '<auth_token>')
 
 # if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
 # then initialize client as:
@@ -164,8 +157,8 @@ client = Phlo.new(AUTH_ID, AUTH_TOKEN)
 begin
     #parameters set in PHLO - params
     params = {
-       from: '9999999999',
-       to: '0000000000'
+       from: '+14156667778',
+       to: '+14156667777'
     }
     response = phlo.run(params)
     puts response
@@ -175,7 +168,7 @@ begin
 ```
 
 ### More examples
-Refer to the [Ruby API Reference](https://api-reference.plivo.com/latest/ruby/introduction/overview) for more examples. Also refer to the [guide to setting up dev environment](https://developers.plivo.com/getting-started/setting-up-dev-environment/) on [Plivo Developers Portal](https://developers.plivo.com) to setup a Sinatra server & use it to test out your integration in under 5 minutes.
+More examples are available [here](https://github.com/plivo/plivo-examples-ruby). Also refer to the [guides for configuring the Rails server to run various scenarios](https://www.plivo.com/docs/sms/quickstart/ruby-rails/) & use it to test out your integration in under 5 minutes.
 
 ## Reporting issues
 Report any feedback or problems with this version by [opening an issue on Github](https://github.com/plivo/plivo-ruby/issues).

data/lib/plivo/base/resource.rb

@@ -114,5 +114,35 @@ module Plivo
         Response.new(response_json, @_identifier_string)
       end
     end
+
+    class SecondaryResource < Resource
+      attr_reader :secondary_id
+      def initialize(client, options = nil)
+        super
+        configure_secondary_options(options) if options
+        configure_secondary_resource_uri
+      end
+
+      def configure_secondary_options(options)
+        valid_param?(:options, options, Hash, false)
+        @secondary_id = options[:member_id] if options.key?(:member_id)
+        secondary_parse_and_set(options[:resource_json]) if options.key?(:resource_json)
+      end
+
+      def secondary_parse_and_set(resource_json)
+        return unless resource_json
+
+        valid_param?(:resource_json, resource_json, Hash, true)
+        return unless @_secondary_identifier_string && (resource_json.key? @_secondary_identifier_string)
+        @secondary_id = resource_json[@_secondary_identifier_string]
+      end
+
+      def configure_secondary_resource_uri
+        to_join = @secondary_id ? [@_client.auth_id, @_name, @id, @_secondary_name, @secondary_id] : [@_client.auth_id, @_name, @id]
+        to_join = ['', 'v1', 'Account'] << to_join
+        to_join << ''
+        @_resource_uri = to_join.join('/')
+      end
+    end
   end
 end

data/lib/plivo/base_client.rb

@@ -33,7 +33,7 @@ module Plivo
           raise Exceptions::PlivoRESTError, "Resource at #{response[:url]} "\
           'couldn\'t be deleted'
         end
-      elsif !([200, 201, 202, 207].include? response[:status])
+      elsif !([200, 201, 202, 204, 207].include? response[:status])
         raise Exceptions::PlivoRESTError, "Received #{response[:status]} for #{method}"
       end
       @@voice_retry_count = 0
@@ -266,6 +266,7 @@ module Plivo
           req.url resource_path
           req.options.timeout = timeout if timeout
           req.body = data
+          puts req
         end
       else
         if !data.nil? && (data.has_key? 'is_callinsights_request')

data/lib/plivo/resources/messages.rb

@@ -29,6 +29,7 @@ module Plivo
           to_number: @to_number,
           total_amount: @total_amount,
           total_rate: @total_rate,
+          powerpack_id: @powerpack_id,
           units: @units
         }.to_s
       end
@@ -68,72 +69,160 @@ module Plivo
       # @option options [String] :method The method used to call the url. Defaults to POST.
       # @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)
-        valid_param?(:text, text, [String, Symbol], false)
-        valid_param?(:dst, dst, Array, true)
-        valid_param?(:powerpack_uuid, powerpack_uuid, [String, Symbol], false)
-        dst.each do |dst_num|
-          valid_param?(:dst_num, dst_num, [Integer, String, Symbol], true)
-        end
+      # @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 = nil, dst = nil, text = nil, options = nil, powerpack_uuid = nil)
+        #All params in One HASH
+        value = src
+        if(value.is_a?(Hash))
+          valid_param?(:src, value[:src], [Integer, String, Symbol], false)
+          valid_param?(:text, value[:text], [String, Symbol], true)
+          valid_param?(:dst, value[:dst], [String, Array], true)
+          valid_param?(:powerpack_uuid, value[:powerpack_uuid], [String, Symbol], false)
 
-        if dst.include? src
-          raise InvalidRequestError, 'src and dst cannot be same'
-        end
+          if (value[:dst] == value[:src])
+            raise InvalidRequestError, 'src and dst cannot be same'
+          end
 
-        if src.nil? && powerpack_uuid.nil?
-          raise InvalidRequestError, 'src and powerpack uuid both cannot be nil'
-        end
+          if value.key?(:value).nil? && value.key(:powerpack_uuid).nil?
+            raise InvalidRequestError, 'value and powerpack uuid both cannot be nil'
+          end
 
-        if !src.nil? && !powerpack_uuid.nil?
-          raise InvalidRequestError, 'src and powerpack uuid both cannot be present'
-        end
+          if !value.key?(:value).nil? && !value.key(:powerpack_uuid).nil?
+            raise InvalidRequestError, 'value and powerpack uuid both cannot be present'
+          end
 
-        params = {
-          src: src,
-          dst: dst.join('<'),
-          text: text,
-          powerpack_uuid: powerpack_uuid
-        }
+          if !value.key?(:dst).nil? && !value.key(:powerpack_uuid).nil?
+            raise InvalidRequestError, 'dst is a required parameter'
+          end
 
-        return perform_create(params) if options.nil?
-        valid_param?(:options, options, Hash, true)
+          params = {
+            src: value[:src],
+            dst: value[:dst],
+            text: value[:text],
+            powerpack_uuid: value[:powerpack_uuid]
+          }
 
-        if options.key?(:type) &&
-          valid_param?(:type, options[:type], String, true, ['sms', 'mms'])
-          params[:type] = options[:type]
-        end
+          #Handling optional params in One HASH
+          if value.key?(:type) && valid_param?(:type, value[:type],String, true, %w[sms mms])
+            params[:type] = value[:type]
+          end
+
+          if value.key?(:url) && valid_param?(:url, value[:url], String, true)
+             params[:url] = value[:url]
+             if value.key?(:method) &&
+              valid_param?(:method, value[:method], String, true, %w[POST GET])
+              params[:method] = value[:method]
+             else
+               params[:method] = 'POST'
+             end
+          end         
+          
+          if value.key?(:log) &&
+            valid_param?(:log, value[:log], [TrueClass, FalseClass], true)
+              params[:log] = value[:log]
+          end         
+
+          if value.key?(:trackable) &&
+              valid_param?(:trackable, value[:trackable], [TrueClass, FalseClass], true)
+              params[:trackable] = value[:trackable]
+          end
+
+          if value.key?(:media_urls) &&
+            valid_param?(:media_urls, value[:media_urls], Array, true)
+           params[:media_urls] = value[:media_urls]
+          end
+
+          if value.key?(:media_ids) &&
+            valid_param?(:media_ids, value[:media_ids], Array, true)
+           params[:media_ids] = value[:media_ids]
+          end
+
+        #legacy code compatibility
+        else
+          valid_param?(:src, src, [Integer, String, Symbol], false)
+          valid_param?(:text, text, [String, Symbol], true)
+          valid_param?(:dst, dst, [String, Array], true)
+          valid_param?(:powerpack_uuid, powerpack_uuid, [String, Symbol], false)
+          dst.each do |dst_num|
+            valid_param?(:dst_num, dst_num, [Integer, String, Symbol], true)
+          end
+  
+          if dst.include? src
+            raise InvalidRequestError, 'src and dst cannot be same'
+          end
 
-        if options.key?(:url) && valid_param?(:url, options[:url], String, true)
-          params[:url] = options[:url]
-          if options.key?(:method) &&
-             valid_param?(:method, options[:method], String, true, %w[POST GET])
-            params[:method] = options[:method]
+          if src.nil? && powerpack_uuid.nil?
+            raise InvalidRequestError, 'src and powerpack uuid both cannot be nil'
+          end
+
+          if !src.nil? && !powerpack_uuid.nil?
+            raise InvalidRequestError, 'src and powerpack uuid both cannot be present'
+          end
+
+          params = {
+            src: src,
+            text: text,
+            powerpack_uuid: powerpack_uuid
+          }
+
+          if (dst.is_a?(Array))
+            dst.each do |dst_num|
+              valid_param?(:dst_num, dst_num, [Integer, String, Symbol], true)
+              params[:dst] = dst.join('<')
+            end
           else
-            params[:method] = 'POST'
+            params[:dst] = dst
           end
-        end
 
-        if options.key?(:log) &&
-           valid_param?(:log, options[:log], [TrueClass, FalseClass], true)
-          params[:log] = options[:log]
-        end
+          return perform_create(params) if options.nil?
+          valid_param?(:options, options, Hash, true)
 
-        if options.key?(:trackable) &&
-          valid_param?(:trackable, options[:trackable], [TrueClass, FalseClass], true)
-         params[:trackable] = options[:trackable]
-        end
+          if options.key?(:type) &&
+             valid_param?(:type, options[:type], String, true, %w[sms mms])
+            params[:type] = options[:type]
+          end
 
-        if options.key?(:media_urls) &&
-          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]
+          if options.key?(:url) && valid_param?(:url, options[:url], String, true)
+            params[:url] = options[:url]
+            if options.key?(:method) &&
+               valid_param?(:method, options[:method], String, true, %w[POST GET])
+              params[:method] = options[:method]
+            else
+              params[:method] = 'POST'
+            end
+          end
+
+          if options.key?(:media_urls) &&
+            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
+
+          if options.key?(:log) &&
+             valid_param?(:log, options[:log], [TrueClass, FalseClass], true)
+            params[:log] = options[:log]
+          end
+
+          if options.key?(:media_urls) &&
+            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
+
+          if options.key?(:trackable) &&
+            valid_param?(:trackable, options[:trackable], [TrueClass, FalseClass], true)
+           params[:trackable] = options[:trackable]
+          end
         end
         perform_create(params)
       end
@@ -152,8 +241,9 @@ module Plivo
       # @option options [Int] :limit Used to display the number of results per page. The maximum number of results that can be fetched is 20.
       # @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'])
+      # @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'])
+      # @option options [String] :powerpack_id Filter the results by powerpack id
       def list(options = nil)
         return perform_list if options.nil?
         valid_param?(:options, options, Hash, true)
@@ -161,7 +251,7 @@ module Plivo
         params = {}
         params_expected = %i[
           subaccount message_time message_time__gt message_time__gte
-          message_time__lt message_time__lte error_code
+          message_time__lt message_time__lte error_code powerpack_id
         ]
         params_expected.each do |param|
           if options.key?(param) &&