twilio-ruby 5.10.7 → 5.11.0

data/lib/twilio-ruby/rest/video.rb

@@ -28,15 +28,6 @@ module Twilio
         @v1 ||= V1.new self
       end
 
-      ##
-      # @param [String] sid `CJxx…xx` A system-generated 34-character string that
-      #   uniquely identifies this Composition.
-      # @return [Twilio::REST::Video::V1::CompositionInstance] if sid was passed.
-      # @return [Twilio::REST::Video::V1::CompositionList]
-      def compositions(sid=:unset)
-        self.v1.compositions(sid)
-      end
-
       ##
       # @return [Twilio::REST::Video::V1::CompositionSettingsInstance]
       def composition_settings
@@ -58,6 +49,15 @@ module Twilio
         self.v1.recording_settings()
       end
 
+      ##
+      # @param [String] sid `CJxx…xx` A system-generated 34-character string that
+      #   uniquely identifies this Composition.
+      # @return [Twilio::REST::Video::V1::CompositionInstance] if sid was passed.
+      # @return [Twilio::REST::Video::V1::CompositionList]
+      def compositions(sid=:unset)
+        self.v1.compositions(sid)
+      end
+
       ##
       # @param [String] sid A system-generated 34-character string that uniquely
       #   identifies this resource.

data/lib/twilio-ruby/rest/video/v1.rb

@@ -15,28 +15,13 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
-          @compositions = nil
           @composition_settings = nil
           @recordings = nil
           @recording_settings = nil
+          @compositions = nil
           @rooms = nil
         end
 
-        ##
-        # @param [String] sid The Composition Sid that uniquely identifies the Composition
-        #   to fetch.
-        # @return [Twilio::REST::Video::V1::CompositionContext] if sid was passed.
-        # @return [Twilio::REST::Video::V1::CompositionList]
-        def compositions(sid=:unset)
-          if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @compositions ||= CompositionList.new self
-          else
-            CompositionContext.new(self, sid)
-          end
-        end
-
         ##
         # @return [Twilio::REST::Video::V1::CompositionSettingsContext]
         def composition_settings
@@ -64,6 +49,21 @@ module Twilio
           @recording_settings ||= RecordingSettingsContext.new self
         end
 
+        ##
+        # @param [String] sid The Composition Sid that uniquely identifies the Composition
+        #   to fetch.
+        # @return [Twilio::REST::Video::V1::CompositionContext] if sid was passed.
+        # @return [Twilio::REST::Video::V1::CompositionList]
+        def compositions(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @compositions ||= CompositionList.new self
+          else
+            CompositionContext.new(self, sid)
+          end
+        end
+
         ##
         # @param [String] sid The sid
         # @return [Twilio::REST::Video::V1::RoomContext] if sid was passed.

data/lib/twilio-ruby/security/request_validator.rb

@@ -3,17 +3,58 @@
 module Twilio
   module Security
     class RequestValidator
+      ##
+      # Initialize a Request Validator. auth_token will either be grabbed from the global Twilio object or you can
+      # pass it in here.
+      #
+      # @param [String] auth_token Your account auth token, used to sign requests
       def initialize(auth_token = nil)
         @auth_token = auth_token || Twilio.auth_token
         raise ArgumentError, 'Auth token is required' if @auth_token.nil?
       end
 
+      ##
+      # Validates that after hashing a request with Twilio's request-signing algorithm
+      # (https://www.twilio.com/docs/usage/security#validating-requests), the hash matches the signature parameter
+      #
+      # @param [String] url The url sent to your server, including any query parameters
+      # @param [String, Hash, #to_unsafe_h] params In most cases, this is the POST parameters as a hash. If you received
+      #   a bodySHA256 parameter in the query string, this parameter can instead be the POST body as a string to
+      #   validate JSON or other text-based payloads that aren't x-www-form-urlencoded.
+      # @param [String] signature The expected signature, from the X-Twilio-Signature header of the request
+      #
+      # @return [Boolean] whether or not the computed signature matches the signature parameter
       def validate(url, params, signature)
-        params_hash = params_to_hash(params)
-        expected = build_signature_for(url, params_hash)
-        secure_compare(expected, signature)
+        params_hash = body_or_hash(params)
+        if params_hash.is_a? Enumerable
+          expected = build_signature_for(url, params_hash)
+          secure_compare(expected, signature)
+        else
+          expected_signature = build_signature_for(url, {})
+          body_hash = URI.decode_www_form(URI(url).query).to_h['bodySHA256']
+          expected_hash = build_hash_for(params)
+          secure_compare(expected_signature, signature) && secure_compare(expected_hash, body_hash)
+        end
       end
 
+      ##
+      # Build a SHA256 hash for a body string
+      #
+      # @param [String] body String to hash
+      #
+      # @return [String] A base64-encoded SHA256 of the body string
+      def build_hash_for(body)
+        hasher = OpenSSL::Digest.new('sha256')
+        Base64.encode64(hasher.digest(body)).strip
+      end
+
+      ##
+      # Build a SHA1-HMAC signature for a url and parameter hash
+      #
+      # @param [String] url The request url, including any query parameters
+      # @param [#join] params The POST parameters
+      #
+      # @return [String] A base64 encoded SHA1-HMAC
       def build_signature_for(url, params)
         data = url + params.sort.join
         digest = OpenSSL::Digest.new('sha1')
@@ -44,11 +85,11 @@ module Twilio
       #
       # We use `to_unsafe_h` as `to_h` returns a hash of the permitted
       # parameters only and we need all the parameters to create the signature.
-      def params_to_hash(params)
-        if params.respond_to?(:to_unsafe_h)
-          params.to_unsafe_h
+      def body_or_hash(params_or_body)
+        if params_or_body.respond_to?(:to_unsafe_h)
+          params_or_body.to_unsafe_h
         else
-          params
+          params_or_body
         end
       end
     end

data/lib/twilio-ruby/twiml/voice_response.rb

@@ -175,8 +175,11 @@ module Twilio
       # loop:: Times to loop message
       # language:: Message langauge
       # keyword_args:: additional attributes
-      def say(message, voice: nil, loop: nil, language: nil, **keyword_args)
-        append(Say.new(message, voice: voice, loop: loop, language: language, **keyword_args))
+      def say(message: nil, voice: nil, loop: nil, language: nil, **keyword_args)
+        say = Say.new(message: message, voice: voice, loop: loop, language: language, **keyword_args)
+
+        yield(say) if block_given?
+        append(say)
       end
 
       ##
@@ -207,10 +210,192 @@ module Twilio
     ##
     # <Say> TwiML Verb
     class Say < TwiML
-      def initialize(message, **keyword_args)
+      def initialize(message: nil, **keyword_args)
         super(**keyword_args)
         @name = 'Say'
-        @value = message
+        @value = message unless message.nil?
+        yield(self) if block_given?
+      end
+
+      ##
+      # Create a new <Break> element
+      # strength:: Set a pause based on strength
+      # time:: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms
+      # keyword_args:: additional attributes
+      def break(strength: nil, time: nil, **keyword_args)
+        append(SsmlBreak.new(strength: strength, time: time, **keyword_args))
+      end
+
+      ##
+      # Create a new <Emphasis> element
+      # words:: Words to emphasize
+      # level:: Specify the degree of emphasis
+      # keyword_args:: additional attributes
+      def emphasis(words, level: nil, **keyword_args)
+        append(SsmlEmphasis.new(words, level: level, **keyword_args))
+      end
+
+      ##
+      # Create a new <P> element
+      # words:: Words to speak
+      # keyword_args:: additional attributes
+      def p(words, **keyword_args)
+        append(SsmlP.new(words, **keyword_args))
+      end
+
+      ##
+      # Create a new <Phoneme> element
+      # words:: Words to speak
+      # alphabet:: Specify the phonetic alphabet
+      # ph:: Specifiy the phonetic symbols for pronunciation
+      # keyword_args:: additional attributes
+      def phoneme(words, alphabet: nil, ph: nil, **keyword_args)
+        append(SsmlPhoneme.new(words, alphabet: alphabet, ph: ph, **keyword_args))
+      end
+
+      ##
+      # Create a new <Prosody> element
+      # words:: Words to speak
+      # volume:: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB
+      # rate:: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n%
+      # pitch:: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n%
+      # keyword_args:: additional attributes
+      def prosody(words, volume: nil, rate: nil, pitch: nil, **keyword_args)
+        append(SsmlProsody.new(words, volume: volume, rate: rate, pitch: pitch, **keyword_args))
+      end
+
+      ##
+      # Create a new <S> element
+      # words:: Words to speak
+      # keyword_args:: additional attributes
+      def s(words, **keyword_args)
+        append(SsmlS.new(words, **keyword_args))
+      end
+
+      ##
+      # Create a new <Say-As> element
+      # words:: Words to be interpreted
+      # interpret-as:: Specify the type of words are spoken
+      # role:: Specify the format of the date when interpret-as is set to date
+      # keyword_args:: additional attributes
+      def say_as(words, interpretAs: nil, role: nil, **keyword_args)
+        append(SsmlSayAs.new(words, interpretAs: interpretAs, role: role, **keyword_args))
+      end
+
+      ##
+      # Create a new <Sub> element
+      # words:: Words to be substituted
+      # alias:: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation
+      # keyword_args:: additional attributes
+      def sub(words, aliasAttribute: nil, **keyword_args)
+        append(SsmlSub.new(words, aliasAttribute: aliasAttribute, **keyword_args))
+      end
+
+      ##
+      # Create a new <W> element
+      # words:: Words to speak
+      # role:: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning
+      # keyword_args:: additional attributes
+      def w(words, role: nil, **keyword_args)
+        append(SsmlW.new(words, role: role, **keyword_args))
+      end
+    end
+
+    ##
+    # Improving Pronunciation by Specifying Parts of Speech in <Say>
+    class SsmlW < TwiML
+      def initialize(words, **keyword_args)
+        super(**keyword_args)
+        @name = 'W'
+        @value = words
+        yield(self) if block_given?
+      end
+    end
+
+    ##
+    # Pronouncing Acronyms and Abbreviations in <Say>
+    class SsmlSub < TwiML
+      def initialize(words, **keyword_args)
+        super(**keyword_args)
+        @name = 'Sub'
+        @value = words
+        yield(self) if block_given?
+      end
+    end
+
+    ##
+    # Controlling How Special Types of Words Are Spoken in <Say>
+    class SsmlSayAs < TwiML
+      def initialize(words, **keyword_args)
+        super(**keyword_args)
+        @name = 'Say-As'
+        @value = words
+        yield(self) if block_given?
+      end
+    end
+
+    ##
+    # Adding A Pause Between Sentences in <Say>
+    class SsmlS < TwiML
+      def initialize(words, **keyword_args)
+        super(**keyword_args)
+        @name = 'S'
+        @value = words
+        yield(self) if block_given?
+      end
+    end
+
+    ##
+    # Controling Volume, Speaking Rate, and Pitch in <Say>
+    class SsmlProsody < TwiML
+      def initialize(words, **keyword_args)
+        super(**keyword_args)
+        @name = 'Prosody'
+        @value = words
+        yield(self) if block_given?
+      end
+    end
+
+    ##
+    # Using Phonetic Pronunciation in <Say>
+    class SsmlPhoneme < TwiML
+      def initialize(words, **keyword_args)
+        super(**keyword_args)
+        @name = 'Phoneme'
+        @value = words
+        yield(self) if block_given?
+      end
+    end
+
+    ##
+    # Adding a Pause Between Paragraphs in <Say>
+    class SsmlP < TwiML
+      def initialize(words, **keyword_args)
+        super(**keyword_args)
+        @name = 'P'
+        @value = words
+        yield(self) if block_given?
+      end
+    end
+
+    ##
+    # Emphasizing Words in <Say>
+    class SsmlEmphasis < TwiML
+      def initialize(words, **keyword_args)
+        super(**keyword_args)
+        @name = 'Emphasis'
+        @value = words
+        yield(self) if block_given?
+      end
+    end
+
+    ##
+    # Adding a Pause in <Say>
+    class SsmlBreak < TwiML
+      def initialize(**keyword_args)
+        super(**keyword_args)
+        @name = 'Break'
+
         yield(self) if block_given?
       end
     end
@@ -320,8 +505,11 @@ module Twilio
       # loop:: Times to loop message
       # language:: Message langauge
       # keyword_args:: additional attributes
-      def say(message, voice: nil, loop: nil, language: nil, **keyword_args)
-        append(Say.new(message, voice: voice, loop: loop, language: language, **keyword_args))
+      def say(message: nil, voice: nil, loop: nil, language: nil, **keyword_args)
+        say = Say.new(message: message, voice: voice, loop: loop, language: language, **keyword_args)
+
+        yield(say) if block_given?
+        append(say)
       end
 
       ##

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-    VERSION = '5.10.7'
+    VERSION = '5.11.0'
 end

data/spec/integration/api/v2010/account/sip/ip_access_control_list/ip_address_spec.rb

@@ -41,7 +41,7 @@ describe 'IpAddress' do
                   "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000",
                   "friendly_name": "friendly_name",
                   "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
-                  "ip_address": "ip_address",
+                  "ip_address": "192.168.1.1",
                   "cidr_prefix_length": 32,
                   "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
                   "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
@@ -120,7 +120,7 @@ describe 'IpAddress' do
           "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000",
           "friendly_name": "friendly_name",
           "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
-          "ip_address": "ip_address",
+          "ip_address": "192.168.1.1",
           "cidr_prefix_length": 32,
           "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
           "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
@@ -164,7 +164,7 @@ describe 'IpAddress' do
           "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000",
           "friendly_name": "friendly_name",
           "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
-          "ip_address": "ip_address",
+          "ip_address": "192.168.1.1",
           "cidr_prefix_length": 32,
           "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
           "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
@@ -208,7 +208,7 @@ describe 'IpAddress' do
           "date_updated": "Mon, 20 Jul 2015 17:27:10 +0000",
           "friendly_name": "friendly_name",
           "ip_access_control_list_sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
-          "ip_address": "ip_address",
+          "ip_address": "192.168.1.1",
           "cidr_prefix_length": 32,
           "sid": "IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
           "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/IpAccessControlLists/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAddresses/IPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"

data/spec/security/request_validator_spec.rb

@@ -30,84 +30,57 @@ describe Twilio::Security::RequestValidator do
   end
 
   describe 'validations' do
-    let(:token) { '2bd9e9638872de601313dc77410d3b23' }
+    let(:token) { '12345' }
 
     let(:validator) { Twilio::Security::RequestValidator.new token }
 
-    let(:voice_url) { 'http://twiliotests.heroku.com/validate/voice' }
+    let(:url) { 'https://mycompany.com/myapp.php?foo=1&bar=2' }
 
-    let(:sms_url) { 'http://twiliotests.heroku.com/validate/sms' }
+    let(:default_signature) { 'RSOYDt4T1cUTdK1PDd93/VVr8B8=' }
 
-    let(:voice_params) do
+    let(:body) { '{"property": "value", "boolean": true}' }
+
+    let(:body_hash) { 'Ch/3Y02as7ldtcmi3+lBbkFQKyg6gMfPGWMmMvluZiA=' }
+
+    let(:body_hash_encoded) { body_hash.gsub('+', '%2B').gsub('=', '%3D') }
+
+    let(:params) do
       {
-        'ToState' => 'California',
-        'CalledState' => 'California',
-        'Direction' => 'inbound',
-        'FromState' => 'CA',
-        'AccountSid' => 'ACba8bc05eacf94afdae398e642c9cc32d',
-        'Caller' => '+14153595711',
-        'CallerZip' => '94108',
-        'CallerCountry' => 'US',
-        'From' => '+14153595711',
-        'FromCity' => 'SAN FRANCISCO',
-        'CallerCity' => 'SAN FRANCISCO',
-        'To' => '+14157669926',
-        'FromZip' => '94108',
-        'FromCountry' => 'US',
-        'ToCity' => '',
-        'CallStatus' => 'ringing',
-        'CalledCity' => '',
-        'CallerState' => 'CA',
-        'CalledZip' => '',
-        'ToZip' => '',
-        'ToCountry' => 'US',
-        'CallSid' => 'CA136d09cd59a3c0ec8dbff44da5c03f31',
-        'CalledCountry' => 'US',
-        'Called' => '+14157669926',
-        'ApiVersion' => '2010-04-01',
-        'ApplicationSid' => 'AP44efecad51364e80b133bb7c07eb8204'
+        'From' => '+14158675309',
+        'To' => '+18005551212',
+        'CallSid' => 'CA1234567890ABCDE',
+        'Caller' => '+14158675309',
+        'Digits' => '1234'
       }
     end
 
-    let(:sms_params) do
-      {
-        'ToState' => 'CA',
-        'FromState' => 'CA',
-        'AccountSid' => 'ACba8bc05eacf94afdae398e642c9cc32d',
-        'SmsMessageSid' => 'SM2003cbd5e6a3701999aa3e5f20ff2787',
-        'Body' => 'Orly',
-        'From' => '+14159354345',
-        'FromCity' => 'SAN FRANCISCO',
-        'SmsStatus' => 'received',
-        'FromZip' => '94107',
-        'FromCountry' => 'US',
-        'To' => '+14158141819',
-        'ToCity' => 'SAN FRANCISCO',
-        'ToZip' => '94105',
-        'ToCountry' => 'US',
-        'ApiVersion' => '2010-04-01',
-        'SmsSid' => 'SM2003cbd5e6a3701999aa3e5f20ff2787'
-      }
+    it 'should build a correct signature' do
+      expect(validator.build_signature_for(url, params)).to eq(default_signature)
+    end
+    it 'should validate an authentic Twilio request' do
+      expect(validator.validate(url, params, default_signature)).to eq(true)
+    end
+
+    it 'should not validate a request with wrong signature' do
+      expect(validator.validate(url, params, 'fake_signature')).to eq(false)
     end
 
-    it 'should validate an authentic Twilio Voice request' do
-      signature = 'oVb2kXoVy8GEfwBDjR8bk/ZZ6eA='
-      expect(validator.validate(voice_url, voice_params, signature)).to eq(true)
+    it 'should hash body correctly' do
+      expect(validator.build_hash_for(body)).to eq(body_hash)
     end
 
-    it 'should validate an authentic Twilio SMS request' do
-      signature = 'mxeiv65lEe0b8L6LdVw2jgJi8yw='
-      expect(validator.validate(sms_url, sms_params, signature)).to eq(true)
+    it 'should validate requests with body correctly' do
+      url_with_hash = "#{url}&bodySHA256=#{body_hash_encoded}"
+      expect(validator.validate(url_with_hash, body, 'afcFvPLPYT8mg/JyIVkdnqQKa2s=')).to eq(true)
     end
 
-    it 'should not validate a Twilio Voice request with wrong signature' do
-      signature = 'foo'
-      expect(validator.validate(voice_url, voice_params, signature)).to eq(false)
+    it 'should validate with no other GET parameters' do
+      url_with_hash = "https://mycompany.com/myapp.php?bodySHA256=#{body_hash_encoded}"
+      expect(validator.validate(url_with_hash, body, 'DXnNFCj8DJ/hZmiSg4UzaDHw5Og=')).to eq(true)
     end
 
-    it 'should not validate a Twilio SMS request with wrong signature' do
-      signature = 'bar'
-      expect(validator.validate(sms_url, sms_params, signature)).to eq(false)
+    it 'should fail validation with body but no signature' do
+      expect(validator.validate(url, body, default_signature)).to eq(false)
     end
   end
 end