plivo 4.3.0 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 20e60eae3b619e892f6e4dd181a0756611f1869049b6c76ee281c1a3422be9c0
-  data.tar.gz: 126529c60e9c738b3421f286a7a4c836fa94b5269c31db185b44b4b5fbd3186e
+SHA1:
+  metadata.gz: a6eff6ff164e91f98639704c53c4a20d9e68357a
+  data.tar.gz: b101bbc03a5276a24bde4d488d73abbbd2fa748a
 SHA512:
-  metadata.gz: '0804aa44814f59c59a3d4b7336fc7dc1477b59038917b4697b15ce9354ad6f9dcdaaf36a7d37674e746e401721b5f103b517c7bdef8d44bb054bdace0f7bc984'
-  data.tar.gz: 8d9a9763408b9eefb3fd88384e59f4824148eb8ce472568ad1569b19169b928d67e6eb51b64320acf4e03a7b33525f6284b4e20ad846f9e4b51fe2c116ed06f5
+  metadata.gz: 1022252f290644d4fd32dd0deca29332a2ccf292b360d645c1d853c3ca8162a0101116d332b4530123e9ccad9fdcb4de753da22f9fa9a7ed12429487b3b22f44
+  data.tar.gz: 2427aafbfe52987e671fbdc8642daeb4a96cdabe8be7ebfad9c2c05c050b5e52a624f29b78d78a435e2071d79b874b67a1d9241538631edacb21d1464ba1ac2e

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## [4.3.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.3.1) (2019-10-16)
+- Add SSML support
+
 ## [4.3.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.3.0) (2019-03-12)
 - Add PHLO support
 - Add Multi-Party Call triggers

data/Jenkinsfile

@@ -0,0 +1,7 @@
+#!groovy
+
+@Library('plivo_standard_libs@sdks') _
+
+sdksPipeline ([
+	buildContainer: 'plivo/jenkins-ci/plivo-rubysdk:master'
+])

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.1.6'
+gem 'plivo', '>= 4.3.1'
 ```
 
 And then execute:
@@ -19,6 +19,10 @@ Or install it yourself as:
 
     $ gem install plivo
 
+For features in beta, use the beta branch:
+
+    $ gem install plivo --pre
+
 If you have the `0.3.19` version (a.k.a legacy) already installed, you may have to first uninstall it before installing the new version.
 
 ## Getting started
@@ -125,6 +129,37 @@ This generates the following XML:
 </Response>
 ```
 
+### Run a PHLO
+
+```ruby
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+AUTH_ID = 'AUTH_ID'
+AUTH_TOKEN = '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:
+# client = Phlo.new
+
+# run a phlo:
+begin
+    #parameters set in PHLO - params
+    params = {
+       from: '9999999999',
+       to: '0000000000'
+    }
+    response = phlo.run(params)
+    puts response
+  rescue PlivoRESTError => e
+    puts 'Exception: ' + e.message
+  end
+```
+
 ### 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.
 

data/ci/config.yml

@@ -0,0 +1,7 @@
+---
+parent: central
+serviceName: plivo-ruby
+language: ruby-sdk
+build:
+  command: |
+      gem build plivo.gemspec

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = '4.3.0'.freeze
+  VERSION = '4.3.1'.freeze
 end

data/lib/plivo/xml.rb

@@ -17,6 +17,16 @@ require_relative 'xml/redirect'
 require_relative 'xml/speak'
 require_relative 'xml/user'
 require_relative 'xml/wait'
+require_relative 'xml/break'
+require_relative 'xml/emphasis'
+require_relative 'xml/lang'
+require_relative 'xml/p'
+require_relative 'xml/phoneme'
+require_relative 'xml/prosody'
+require_relative 'xml/s'
+require_relative 'xml/say_as'
+require_relative 'xml/sub'
+require_relative 'xml/w'
 require_relative 'xml/plivo_xml'
 
 include Plivo::Exceptions

data/lib/plivo/xml/break.rb

@@ -0,0 +1,31 @@
+module Plivo
+  module XML
+    class Break < Element
+      @nestables = []
+      @valid_attributes = %w(strength time)
+      VALID_STRENGTH_VALUES= %w(none x-weak weak medium strong x-strong)
+
+      def initialize(attributes = {})
+        if attributes && attributes[:strength] && !VALID_STRENGTH_VALUES.include?(attributes[:strength])
+          raise PlivoXMLError, "invalid attribute value #{attributes[:strength]} for strength"
+        end
+        if attributes && attributes[:time]
+          if attributes[:time].downcase().include?('ms')
+            time = attributes[:time].split('ms')[0].to_i
+            if  time<= 0 || time >10000
+              raise PlivoXMLError, "invalid attribute value #{attributes[:time]} for time attribute. Value for time in milliseconds should be > 0 or < 10000"
+            end
+          elsif attributes[:time].downcase().include?('s')
+            time = attributes[:time].split('s')[0].to_i
+            if  time<= 0 || time >10
+              raise PlivoXMLError, "invalid attribute value #{attributes[:time]} for time attribute. Value for time in seconds should be > 0 or < 10"
+            end
+          else
+            raise PlivoXMLError, "invalid attribute value #{attributes[:time]} for time attribute"
+          end
+        end
+        super(nil, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/element.rb

@@ -6,13 +6,25 @@ module Plivo
       end
       @nestables = []
       @valid_attributes = []
+      SSML_TAGS=%w[Break Emphasis Lang P Phoneme Prosody S SayAs Sub W]
 
       attr_accessor :node, :name
 
-      def initialize(body = nil, attributes = {})
+      def hyphenate(pascal_cased_word)
+        pascal_cased_word.to_s.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1-\2').
+          gsub(/([a-z\d])([A-Z])/,'\1-\2').
+          downcase
+      end
+
+      def initialize(body = nil, attributes = {}, nestables=self.class.nestables)
         @name = self.class.name.split('::')[2]
         @body = body
-        @node = REXML::Element.new @name
+        tagname = @name
+        if SSML_TAGS.include?(@name)
+          tagname = hyphenate(@name)
+        end
+        @node = REXML::Element.new tagname
         attributes.each do |k, v|
           if self.class.valid_attributes.include?(k.to_s)
             @node.attributes[k.to_s] = convert_value(v)
@@ -20,7 +32,7 @@ module Plivo
             raise PlivoXMLError, "invalid attribute #{k} for #{@name}"
           end
         end
-
+        @nestables = nestables
         @node.text = @body if @body
 
         # Allow for nested "nestable" elements using a code block
@@ -33,6 +45,10 @@ module Plivo
         yield(self) if block_given?
       end
 
+      def add_attribute(attribute, value)
+        @node.add_attribute(attribute, value)
+      end
+
       def method_missing(method, *args, &block)
         # Handle the addElement methods
         method = Regexp.last_match(1).to_sym if method.to_s =~ /^add(.*)/
@@ -63,7 +79,7 @@ module Plivo
 
       def add(element)
         raise PlivoXMLError, 'invalid element' unless element
-        if self.class.nestables.include?(element.name)
+        if @nestables.include?(element.name)
           @node.elements << element.node
           element
         else

data/lib/plivo/xml/emphasis.rb

@@ -0,0 +1,17 @@
+module Plivo
+  module XML
+    class Emphasis < Element
+      @nestables = %w(Break Emphasis Lang Phoneme Prosody SayAs Sub W)
+      @valid_attributes = %w(level)
+
+      VALID_LEVEL_ATTRIBUTE_VALUE=%w(strong moderate reduced)
+
+      def initialize(body, attributes = {})
+        if attributes && attributes[:level] && !VALID_LEVEL_ATTRIBUTE_VALUE.include?(attributes[:level])
+          raise PlivoXMLError, "invalid attribute value #{attributes[:level]} for level"
+        end
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/lang.rb

@@ -0,0 +1,29 @@
+module Plivo
+  module XML
+    class Lang < Element
+      @nestables = %w(Break Emphasis Lang P Phoneme Prosody S SayAs Sub W)
+      @valid_attributes = %w(xmllang)
+
+       VALID_LANG_ATTRIBUTE_VALUES = [
+        'arb', 'cmn-CN','da-DK','nl-NL','en-AU',
+        'en-GB', 'en-IN','en-US','en-GB-WLS','fr-FR',
+        'fr-CA','de-DE','hi-IN','is-IS','it-IT',
+        'ja-JP','ko-KR','nb-NO','pl-PL','pt-BR',
+        'pt-PT','ro-RO','ru-RU','es-ES','es-MX',
+        'es-US','sv-SE','tr-TR','cy-GB']
+
+
+      def initialize(body, attributes = {})
+        if attributes && attributes[:xmllang]
+          unless VALID_LANG_ATTRIBUTE_VALUES.include?(attributes[:xmllang])
+            raise PlivoXMLError, "invalid attribute value #{attributes[:xmllang]} for xmllang"
+          end
+          super(body, {})
+          add_attribute("xml:lang", attributes[:xmllang])
+        else
+          raise PlivoXMLError, 'xmllang attribute is a required attribute for lang'
+        end
+      end
+    end
+  end
+end

data/lib/plivo/xml/p.rb

@@ -0,0 +1,12 @@
+module Plivo
+  module XML
+    class P < Element
+      @nestables = %w(Break Emphasis Lang Phoneme Prosody SayAs Sub S W)
+      @valid_attributes = []
+
+      def initialize(body)
+        super(body)
+      end
+    end
+  end
+end

data/lib/plivo/xml/phoneme.rb

@@ -0,0 +1,20 @@
+module Plivo
+  module XML
+    class Phoneme < Element
+      @nestables = []
+      @valid_attributes = %w(alphabet ph)
+
+      VALID_ALPHABET_ATTRIBUTE_VALUES=%w(ipa x-sampa x-amazon-pinyin)
+
+      def initialize(body, attributes = {})
+        unless attributes && attributes[:ph]
+          raise PlivoXMLError, 'ph attribute is required for Phoneme'
+        end
+        if attributes && attributes[:alphabet] && !VALID_ALPHABET_ATTRIBUTE_VALUES.include?(attributes[:alphabet])
+          raise PlivoXMLError, "invalid attribute value #{attributes[:alphabet]} for alphabet"
+        end
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/prosody.rb

@@ -0,0 +1,28 @@
+module Plivo
+  module XML
+    class Prosody < Element
+      @nestables = %w(Break Emphasis Lang P Phoneme Prosody S SayAs Sub W)
+      @valid_attributes = %w(volume rate pitch)
+
+      VALID_VOLUME_ATTRIBUTE_VALUES=%w(default silent x-soft soft medium loud x-loud)
+      VALID_RATE_ATTRIBUTE_VALUES=%w(x-slow slow medium fast x-fast)
+      VALID_PITCH_ATTRIBUTE_VALUES=%w(default x-low low medium high x-high)
+
+      def initialize(body, attributes = {})
+        if attributes.nil? || attributes.length == 0
+          raise PlivoXMLError, 'Specify at least one attribute for Prosody tag'
+        end
+        if attributes[:volume] && !VALID_VOLUME_ATTRIBUTE_VALUES.include?(attributes[:volume]) && !attributes[:volume].include?('dB')
+          raise PlivoXMLError, "invalid attribute value #{attributes[:volume]} for volume"
+        end
+        if attributes[:rate] && !VALID_RATE_ATTRIBUTE_VALUES.include?(attributes[:rate]) && (!attributes[:rate].include?('%') || attributes[:rate].split('%')[0].to_i < 0)
+          raise PlivoXMLError, "invalid attribute value #{attributes[:rate]} for rate"
+        end
+        if attributes[:pitch] && !VALID_PITCH_ATTRIBUTE_VALUES.include?(attributes[:pitch]) && !attributes[:pitch].include?('%')
+          raise PlivoXMLError, "invalid attribute value #{attributes[:pitch]} for pitch"
+        end
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/s.rb

@@ -0,0 +1,12 @@
+module Plivo
+  module XML
+    class S < Element
+      @nestables = %w(Break Emphasis Lang Phoneme Prosody SayAs Sub W)
+      @valid_attributes = []
+
+      def initialize(body)
+        super(body)
+      end
+    end
+  end
+end

data/lib/plivo/xml/say_as.rb

@@ -0,0 +1,24 @@
+module Plivo
+  module XML
+    class SayAs < Element
+      @nestables = []
+      @valid_attributes = %w(interpret-as format)
+
+      VALID_INTERPRET_AS_ATTRIBUTE_VALUES=%w(characters spell-out cardinal number ordinal digits fraction unit date time address expletive telephone)
+      VALID_FORMAT_ATTRIBUTE_VALUES=%w(mdy dmy ymd md dm ym my d m y yyyymmdd)
+
+      def initialize(body, attributes = {})
+        unless attributes && attributes["interpret-as"]
+          raise PlivoXMLError, 'interpret-as is a required attribute for say-as element'
+        end
+        if !VALID_INTERPRET_AS_ATTRIBUTE_VALUES.include?(attributes["interpret-as"])
+          raise PlivoXMLError, "invalid attribute value #{attributes["interpret-as"]} for interpret-as"
+        end
+        if attributes["interpret-as"]=='date' && attributes[:format] && !VALID_FORMAT_ATTRIBUTE_VALUES.include?(attributes[:format])
+          raise PlivoXMLError, "invalid attribute value #{attributes[:format]} for format"
+        end
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/speak.rb

@@ -1,16 +1,27 @@
 module Plivo
   module XML
     class Speak < Element
-      @nestables = []
       @valid_attributes = %w[voice language loop]
 
+      SUPPORTED_ENGINES=%w(Polly)
+      SUPPORTED_VOICES=%w(Nicole Russell Vitoria Ricardo Chantal Naja Mads Lotte Ruben Lea Celine Mathieu Vicki Marlene Hans Aditi Dora Karl Raveena Aditi Carla Giorgio Mizuki Takumi Seoyeon Zhiyu Liv Ewa Maja Jacek Jan Ines Cristiano Carmen Tatyana Maxim Conchita Enrique Astrid Filiz Amy Emma Brian Joanna Matthew Salli Justin Kendra Joey Kimberly Ivy Penelope Miguel Gwyneth Geraint Zeina Mia)
+
       def initialize(body, attributes = {})
+        if attributes.nil? || attributes[:voice].nil? || ['MAN', 'WOMAN'].include?(attributes[:voice])
+          @nestables = []
+        else
+          engine = attributes[:voice].split('.')[0]
+          voice = attributes[:voice].split('.')[1]
+          if SUPPORTED_ENGINES.include?(engine) && SUPPORTED_VOICES.include?(voice)
+            @nestables = %w(Break Emphasis Lang P Phoneme Prosody S SayAs Sub W)
+          else
+            raise PlivoXMLError, "<Speak> voice #{attributes[:voice]} is not valid."
+          end
+        end
         if !body
           raise PlivoXMLError, 'No text set for Speak'
-        else
-          body = HTMLEntities.new(:html4).encode(body, :decimal)
         end
-        super(body, attributes)
+        super(body, attributes, @nestables)
       end
     end
   end

data/lib/plivo/xml/sub.rb

@@ -0,0 +1,16 @@
+module Plivo
+  module XML
+    class Sub < Element
+      @nestables = []
+      @valid_attributes = %w(alias)
+
+      def initialize(body, attributes = {})
+        raise PlivoXMLError, 'No text set for sub element' unless body
+        unless attributes && attributes[:alias]
+          raise PlivoXMLError, 'alias is a required attribute for sub element'
+        end
+        super(body, attributes)
+      end
+    end
+  end
+end

data/lib/plivo/xml/w.rb

@@ -0,0 +1,17 @@
+module Plivo
+  module XML
+    class W < Element
+      @nestables = %w(Break Emphasis Phoneme Prosody SayAs Sub)
+      @valid_attributes = %w(role)
+
+      VALID_ROLE_ATTRIBUTE_VALUES=%w(amazon:VB amazon:VBD amazon:SENSE_1)
+
+      def initialize(body, attributes = {})
+        if attributes && attributes[:role] && !VALID_ROLE_ATTRIBUTE_VALUES.include?(attributes[:role])
+          raise PlivoXMLError, "invalid attribute value #{attributes[:role]} for role"
+        end
+        super(body, attributes)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.3.1
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-12 00:00:00.000000000 Z
+date: 2019-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -144,9 +144,11 @@ files:
 - AUTHORS.md
 - CHANGELOG.md
 - Gemfile
+- Jenkinsfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- ci/config.yml
 - examples/conference_bridge.rb
 - examples/multi_party_call.rb
 - examples/phlos.rb
@@ -177,22 +179,32 @@ files:
 - lib/plivo/utils.rb
 - lib/plivo/version.rb
 - lib/plivo/xml.rb
+- lib/plivo/xml/break.rb
 - lib/plivo/xml/conference.rb
 - lib/plivo/xml/dial.rb
 - lib/plivo/xml/dtmf.rb
 - lib/plivo/xml/element.rb
+- lib/plivo/xml/emphasis.rb
 - lib/plivo/xml/get_digits.rb
 - lib/plivo/xml/hangup.rb
+- lib/plivo/xml/lang.rb
 - lib/plivo/xml/message.rb
 - lib/plivo/xml/number.rb
+- lib/plivo/xml/p.rb
+- lib/plivo/xml/phoneme.rb
 - lib/plivo/xml/play.rb
 - lib/plivo/xml/plivo_xml.rb
 - lib/plivo/xml/pre_answer.rb
+- lib/plivo/xml/prosody.rb
 - lib/plivo/xml/record.rb
 - lib/plivo/xml/redirect.rb
 - lib/plivo/xml/response.rb
+- lib/plivo/xml/s.rb
+- lib/plivo/xml/say_as.rb
 - lib/plivo/xml/speak.rb
+- lib/plivo/xml/sub.rb
 - lib/plivo/xml/user.rb
+- lib/plivo/xml/w.rb
 - lib/plivo/xml/wait.rb
 - plivo.gemspec
 homepage: https://github.com/plivo/plivo-ruby
@@ -215,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: A Ruby SDK to make voice calls & send SMS using Plivo and to generate Plivo