plivo 4.22.0 → 4.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99a81ae9a72d5cd9f5332d84de77f442c565b9a5
-  data.tar.gz: 274d0f0c5e278e9fb003eda9c2b022a6840a99b0
+  metadata.gz: 3f443da345e9dd7008e4da7feb9fb380aa600d2d
+  data.tar.gz: f0a9c52fc349c4741cb0efd72bff4d1ffa72d35d
 SHA512:
-  metadata.gz: 8e5703701787286d5a30a520dedb09bd7c03593f0ac7f8d54a1cfa0ceafaaec31a8b91e135282022f8fcf2fc3fb79191e794bafe844733ac7fc09c337c1d86a3
-  data.tar.gz: edf485c5a4d6e3429dc1dec71fe32fe3d31662627bec06d2de407ee6320fc6b5b0bc1d5dce6ef79d6e88305fe76264dfbea5c848bc77e7f829a5168e3577cda9
+  metadata.gz: f2bf6055224a1feb6411d683ed13100681b0350e60ab3d76869a8d7cd97dacddbacb16522e8ba6daa685c80792d7d0d13c33f0bf14cf6ca3613eec4638625d8f
+  data.tar.gz: c8c2e8e68cd4c71a4a416f70883b99e3ee73aa2a6ebe4cc3a518382f55f48353dfb89d19b0c3e144c2046c2d3f906a9e82738db5bb9d02341e2e0ed30807919c

data/.github/workflows/unitTests.yml

@@ -0,0 +1,32 @@
+name: UnitTest
+
+on:
+  push:
+    branches: [ unitTests ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: UnitTest
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+         ruby-version: [ '2.4', '2.5', '2.6' ,'2.7', '3.0' ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Dependencies Installation
+        run: |
+          bundle install --without development
+      - name: Run Tests
+        run: |
+          ruby --version
+          bundle exec rake
+          rm Gemfile.lock
+  

data/CHANGELOG.md

@@ -1,7 +1,23 @@
 # Change Log
 
+## [4.25.1](https://github.com/plivo/plivo-ruby/tree/v4.25.1) (2022-02-02)
+**Bugfix - Recording**
+- Fix for Start Recording API response issue
+
+## [4.25.0](https://github.com/plivo/plivo-ruby/tree/v4.25.0) (2022-01-27)
+**Features - MPCStartCallRecording**
+- parameter name change from statusCallback to recordingCallback
+
+## [4.24.0](https://github.com/plivo/plivo-ruby/tree/v4.24.0) (2021-12-14)
+**Features - Voice**
+- Routing SDK traffic through Akamai endpoints for all the [Voice APIs](https://www.plivo.com/docs/voice/api/overview/)
+
+## [4.23.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.23.0) (2021-12-02)
+**Features - Messaging: 10 DLC**
+- 10DLC API's for brand and campaign support.
+
 ## [4.22.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.22.0) (2021-11-11)
-**Features - Voice: Multiparty calls**
+**Features - Voice: Multiparty call**
 - The [Add Multiparty Call API](https://www.plivo.com/docs/voice/api/multiparty-call/participants#add-a-participant) allows for greater functionality by accepting options like `start recording audio`, `stop recording audio`, and their HTTP methods.
 - [Multiparty Calls](https://www.plivo.com/docs/voice/api/multiparty-call/) now has new APIs to `stop` and `play` audio.
 

data/Gemfile

@@ -7,4 +7,5 @@ group :test do
   gem 'rspec', '~> 3.0'
   gem 'simplecov'
   gem 'json'
+  gem 'rexml'
 end

data/README.md

@@ -1,6 +1,7 @@
 # plivo-ruby
 
-[![Build Status](https://travis-ci.org/plivo/plivo-ruby.svg?branch=4.0)](https://travis-ci.org/plivo/plivo-ruby)
+[![UnitTest](https://github.com/plivo/plivo-ruby/actions/workflows/unitTests.yml/badge.svg?branch=ns-ut-fix)](https://github.com/plivo/plivo-ruby/actions/workflows/unitTests.yml)
+[![Gem Version](https://badge.fury.io/rb/plivo.svg)](https://badge.fury.io/rb/plivo)
 
 The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby applications using the Plivo REST API. Using the SDK, you will be able to make voice calls, send SMS and generate Plivo XML to control your call flows.
 
@@ -8,7 +9,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.22.0'
+gem 'plivo', '>= 4.25.1'
 ```
 
 And then execute:

data/lib/plivo/base.rb

@@ -6,9 +6,9 @@ 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
+    API_VOICE = 'https://api.plivo.com'.freeze
+    API_VOICE_FALLBACK_1 = 'https://api.plivo.com'.freeze
+    API_VOICE_FALLBACK_2 = 'https://api.plivo.com'.freeze
 
     CALLINSIGHTS_API_URL = 'https://stats.plivo.com'.freeze
     PHLO_API_URL = 'https://phlorunner.plivo.com'.freeze

data/lib/plivo/resources/brand.rb

@@ -0,0 +1,62 @@
+module Plivo
+  module Resources
+    include Plivo::Utils
+    class Brand < Base::Resource
+      def initialize(client, options = nil)
+        @_name = '10dlc/Brand'
+        @_identifier_string = 'brand_id'
+        super
+      end
+  
+      def to_s
+        {
+          api_id: @api_id,
+          brand: @brand
+        }.to_s
+      end
+    end
+  
+    class BrandInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = '10dlc/Brand'
+        @_resource_type = Brand
+        @_identifier_string = 'brand_id'
+        super
+      end
+  
+        ##
+        # Get an Brand
+        # @param [String] brand_id
+        # @return [Brand] Brand
+      def get(brand_id)
+        valid_param?(:brand_id, brand_id, [String, Symbol], true)
+        perform_get(brand_id)
+      end
+  
+        ##
+        # List all Brand
+        # @param [Hash] options
+        # @option options [String] :type
+        # @option options [Status] :status
+        # @return [Hash]
+      def list(options=nil)
+        return perform_list_without_object if options.nil?
+  
+        params = {}
+        %i[status type].each do |param|
+          if options.key?(param) && valid_param?(param, options[param],
+                                                   [String], true)
+            params[param] = options[param]
+          end
+        end  
+        perform_list_without_object(params)
+      end
+  
+        ##
+        # Create a new brand
+      def create(params)
+        perform_create(params)
+      end
+    end
+  end
+end

data/lib/plivo/resources/calls.rb

@@ -492,7 +492,11 @@ module Plivo
       # @option options [String] :callback_method - The method which is used to invoke the callback_url URL. Defaults to POST.
       def record(call_uuid, options = nil)
         valid_param?(:call_uuid, call_uuid, [String, Symbol], true)
-        Call.new(@_client, resource_id: call_uuid).record(options)
+        response = Call.new(@_client, resource_id: call_uuid).record(options)
+        return Base::Response.new(Hash["api_id" => response.api_id,
+                                       "recording_id" => response.recording_id,
+                                       "message" => response.message,
+                                       "url" => response.url])
       end
 
       # @param [String] call_uuid

data/lib/plivo/resources/campaign.rb

@@ -0,0 +1,62 @@
+module Plivo
+  module Resources
+    include Plivo::Utils
+    class Campaign < Base::Resource
+      def initialize(client, options = nil)
+        @_name = '10dlc/Campaign'
+        @_identifier_string = 'campaign_id'
+        super
+      end
+  
+      def to_s
+        {
+          api_id: @api_id,
+          campaign: @campaign
+        }.to_s
+      end
+    end
+  
+    class CampaignInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = '10dlc/Campaign'
+        @_resource_type = Campaign
+        @_identifier_string = 'campaign_id'
+        super
+      end
+  
+        ##
+        # Get an Campaign
+        # @param [String] campaign_id
+        # @return [Campaign] Campaign
+      def get(campaign_id)
+        valid_param?(:campaign_id, campaign_id, [String, Symbol], true)
+        perform_get(campaign_id)
+      end
+  
+        ##
+        # List all Campaign
+        # @param [Hash] options
+        # @option options [String] :brand
+        # @option options [Status] :usecase
+        # @return [Hash]
+      def list(options=nil)
+        return perform_list_without_object if options.nil?
+  
+        params = {}
+        %i[usecase brand].each do |param|
+          if options.key?(param) && valid_param?(param, options[param],
+                                                   [String], true)
+            params[param] = options[param]
+          end
+        end  
+        perform_list_without_object(params)
+      end
+  
+        ##
+        # Create a new Camapign
+      def create(params)
+          perform_create(params)
+      end
+    end
+  end
+end

data/lib/plivo/resources/multipartycalls.rb

@@ -191,15 +191,15 @@ module Plivo
         perform_action_apiresponse(nil, 'DELETE', nil, true)
       end
 
-      def start_recording(file_format = 'mp3', status_callback_url = nil, status_callback_method='POST')
+      def start_recording(file_format = 'mp3', recording_callback_url = nil, recording_callback_method='POST')
         valid_param?(:file_format, file_format, String, false , %w[mp3 wav])
-        valid_url?(:status_callback_url, status_callback_url, false) unless status_callback_url.nil?
-        valid_param?(:status_callback_method, status_callback_method.upcase,String, false, %w[GET POST])
+        valid_url?(:recording_callback_url, recording_callback_url, false) unless recording_callback_url.nil?
+        valid_param?(:recording_callback_method, recording_callback_method.upcase,String, false, %w[GET POST])
 
         params = {}
         params[:file_format] = file_format.downcase unless file_format.nil?
-        params[:status_callback_url] = status_callback_url unless status_callback_url.nil?
-        params[:status_callback_method] = status_callback_method.upcase unless status_callback_method.nil?
+        params[:recording_callback_url] = recording_callback_url unless recording_callback_url.nil?
+        params[:recording_callback_method] = recording_callback_method.upcase unless recording_callback_method.nil?
 
         perform_action_apiresponse('Record', 'POST', params, true)
       end
@@ -216,9 +216,9 @@ module Plivo
         perform_action_apiresponse('Record/Resume', 'POST')
       end
 
-      def start_participant_recording(member_id, file_format='mp3', status_callback_url=nil, status_callback_method='POST')
+      def start_participant_recording(member_id, file_format='mp3', recording_callback_url=nil, recording_callback_method='POST')
         valid_param?(:member_id, member_id, [String, Integer], true)
-        MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], member_id: member_id).start_participant_recording(file_format, status_callback_url, status_callback_method)
+        MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], member_id: member_id).start_participant_recording(file_format, recording_callback_url, recording_callback_method)
       end
 
       def stop_participant_recording(member_id)
@@ -288,15 +288,15 @@ module Plivo
         configure_secondary_resource_uri
       end
 
-      def start_participant_recording(file_format = 'mp3', status_callback_url = nil, status_callback_method='POST')
+      def start_participant_recording(file_format = 'mp3', recording_callback_url = nil, recording_callback_method='POST')
         valid_param?(:file_format, file_format, String, false , %w[mp3 wav])
-        valid_url?(:status_callback_url, status_callback_url, false) unless status_callback_url.nil?
-        valid_param?(:status_callback_method, status_callback_method.upcase,String, false, %w[GET POST])
+        valid_url?(:recording_callback_url, recording_callback_url, false) unless recording_callback_url.nil?
+        valid_param?(:recording_callback_method, recording_callback_method.upcase,String, false, %w[GET POST])
 
         params = {}
         params[:file_format] = file_format.downcase unless file_format.nil?
-        params[:status_callback_url] = status_callback_url unless status_callback_url.nil?
-        params[:status_callback_method] = status_callback_method.upcase unless status_callback_method.nil?
+        params[:recording_callback_url] = recording_callback_url unless recording_callback_url.nil?
+        params[:recording_callback_method] = recording_callback_method.upcase unless recording_callback_method.nil?
 
         perform_action_apiresponse('Record', 'POST', params, true)
       end
@@ -480,11 +480,11 @@ module Plivo
       def start_recording(options = {})
         valid_param?(:options, options, Hash, false)
         options[:file_format] = 'mp3' unless options.key?(:file_format)
-        options[:status_callback_method] = 'POST' unless options.key?(:status_callback_method)
+        options[:recording_callback_method] = 'POST' unless options.key?(:recording_callback_method)
         valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
         valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
         mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
-        MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).start_recording(options[:file_format], options[:status_callback_url], options[:status_callback_method])
+        MultiPartyCall.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0]).start_recording(options[:file_format], options[:recording_callback_url], options[:recording_callback_method])
       end
 
       def stop_recording(options = {})
@@ -517,12 +517,12 @@ module Plivo
           raise_invalid_request("Member Id is mandatory")
         end
         options[:file_format] = 'mp3' unless options.key?(:file_format)
-        options[:status_callback_method] = 'POST' unless options.key?(:status_callback_method)
+        options[:recording_callback_method] = 'POST' unless options.key?(:recording_callback_method)
         valid_param?(:member_id, options[:member_id], [String, Integer], true)
         valid_param?(:uuid, options[:uuid], String, false) unless options[:uuid].nil?
         valid_param?(:friendly_name, options[:friendly_name], String, false) unless options[:friendly_name].nil?
         mpc_id = make_mpc_id(options[:uuid], options[:friendly_name])
-        MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).start_participant_recording(options[:file_format], options[:status_callback_url], options[:status_callback_method])
+        MultiPartyCallParticipant.new(@_client, resource_id: mpc_id[1], multi_party_prefix: mpc_id[0], member_id: options[:member_id]).start_participant_recording(options[:file_format], options[:recording_callback_url], options[:recording_callback_method])
       end
 
       def stop_participant_recording(options = {})

data/lib/plivo/resources.rb

@@ -15,6 +15,8 @@ require_relative 'resources/nodes'
 require_relative 'resources/phlo_member'
 require_relative 'resources/call_feedback'
 require_relative 'resources/media'
+require_relative 'resources/brand'
+require_relative 'resources/campaign'
 require_relative 'resources/lookup'
 require_relative 'resources/regulatory_compliance'
 require_relative 'resources/multipartycalls'

data/lib/plivo/rest_client.rb

@@ -14,6 +14,7 @@ module Plivo
     attr_reader :powerpacks
     attr_reader :powerpacks, :media
     attr_reader :lookup
+    attr_reader :brand, :campaign
     attr_reader :end_users
     attr_reader :compliance_document_types, :compliance_documents, :compliance_requirements, :compliance_applications
 
@@ -39,6 +40,8 @@ module Plivo
       @messages = Resources::MessagesInterface.new(self)
       @powerpacks = Resources::PowerpackInterface.new(self)
       @media = Resources::MediaInterface.new(self)
+      @brand = Resources::BrandInterface.new(self)
+      @campaign = Resources::CampaignInterface.new(self)
       @subaccounts = Resources::SubaccountInterface.new(self)
       @recordings = Resources::RecordingInterface.new(self)
       @pricings = Resources::PricingInterface.new(self)

data/lib/plivo/utils.rb

@@ -227,7 +227,7 @@ module Plivo
         uri += "?"
       end
       if parsed_uri.query.to_s.length > 0
-        parsed_uri_query = URI.decode(parsed_uri.query)
+        parsed_uri_query = URI.decode_www_form_component(parsed_uri.query)
         if method == "GET"
           queryParamMap = getMapFromQueryString?(parsed_uri_query)
           params.keys.sort.each { |key|

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.22.0".freeze
+  VERSION = "4.25.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.22.0
+  version: 4.25.1
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -152,6 +152,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/unitTests.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -182,8 +183,10 @@ files:
 - lib/plivo/resources/accounts.rb
 - lib/plivo/resources/addresses.rb
 - lib/plivo/resources/applications.rb
+- lib/plivo/resources/brand.rb
 - lib/plivo/resources/call_feedback.rb
 - lib/plivo/resources/calls.rb
+- lib/plivo/resources/campaign.rb
 - lib/plivo/resources/conferences.rb
 - lib/plivo/resources/endpoints.rb
 - lib/plivo/resources/identities.rb