twilio-ruby 5.6.0 → 5.33.1

data/spec/integration/wireless/v1/usage_record_spec.rb

@@ -0,0 +1,111 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+require 'spec_helper.rb'
+
+describe 'UsageRecord' do
+  it "can read" do
+    @holodeck.mock(Twilio::Response.new(500, ''))
+
+    expect {
+      @client.wireless.v1.usage_records.list()
+    }.to raise_exception(Twilio::REST::TwilioError)
+
+    values = {}
+    expect(
+    @holodeck.has_request?(Holodeck::Request.new(
+        method: 'get',
+        url: 'https://wireless.twilio.com/v1/UsageRecords',
+    ))).to eq(true)
+  end
+
+  it "receives fetch responses" do
+    @holodeck.mock(Twilio::Response.new(
+        200,
+      %q[
+      {
+          "usage_records": [
+              {
+                  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+                  "commands": {
+                      "billing_units": "USD",
+                      "billed": 0,
+                      "total": 3,
+                      "from_sim": 1,
+                      "to_sim": 2,
+                      "home": {
+                          "billing_units": "USD",
+                          "billed": 0,
+                          "total": 3,
+                          "from_sim": 1,
+                          "to_sim": 2
+                      },
+                      "national_roaming": {
+                          "billing_units": "USD",
+                          "billed": 0,
+                          "total": 0,
+                          "from_sim": 0,
+                          "to_sim": 0
+                      },
+                      "international_roaming": []
+                  },
+                  "data": {
+                      "billing_units": "USD",
+                      "billed": 0.35,
+                      "total": 3494609,
+                      "upload": 731560,
+                      "download": 2763049,
+                      "units": "bytes",
+                      "home": {
+                          "billing_units": "USD",
+                          "billed": 0.35,
+                          "total": 3494609,
+                          "upload": 731560,
+                          "download": 2763049,
+                          "units": "bytes"
+                      },
+                      "national_roaming": {
+                          "billing_units": "USD",
+                          "billed": 0,
+                          "total": 0,
+                          "upload": 0,
+                          "download": 0,
+                          "units": "bytes"
+                      },
+                      "international_roaming": []
+                  },
+                  "period": {
+                      "start": "2015-07-30T20:00:00Z",
+                      "end": "2015-07-30T20:00:00Z"
+                  }
+              },
+              {
+                  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+                  "commands": {},
+                  "data": {},
+                  "period": {}
+              }
+          ],
+          "meta": {
+              "first_page_url": "https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0",
+              "key": "usage_records",
+              "next_page_url": null,
+              "page": 0,
+              "page_size": 50,
+              "previous_page_url": null,
+              "url": "https://wireless.twilio.com/v1/UsageRecords?Start=2015-07-30T20%3A00%3A00Z&End=2015-07-30T20%3A00%3A00Z&PageSize=50&Page=0"
+          }
+      }
+      ]
+    ))
+
+    actual = @client.wireless.v1.usage_records.list()
+
+    expect(actual).to_not eq(nil)
+  end
+end

data/spec/jwt/access_token_spec.rb

@@ -75,6 +75,7 @@ describe Twilio::JWT::AccessToken do
 
       it 'Voice grant' do
         voice_grant = Twilio::JWT::AccessToken::VoiceGrant.new
+        voice_grant.incoming_allow = true
         voice_grant.outgoing_application_sid = 'AP123'
         voice_grant.outgoing_application_params = {:foo => 'bar'}
         voice_grant.push_credential_sid = 'PC123'
@@ -82,6 +83,7 @@ describe Twilio::JWT::AccessToken do
         @scat.add_grant(voice_grant)
         payload, _ = JWT.decode @scat.to_s, 'secret'
         expect(payload['grants'].count).to eq(1)
+        expect(payload['grants']['voice']['incoming']['allow']).to eq(true)
         expect(payload['grants']['voice']['outgoing']['application_sid']).to eq('AP123')
         expect(payload['grants']['voice']['outgoing']['params']['foo']).to eq('bar')
         expect(payload['grants']['voice']['push_credential_sid']).to eq('PC123')

data/spec/rest/client_spec.rb

@@ -47,3 +47,37 @@ describe Twilio::REST::TrunkingClient do
     expect { Twilio::REST::TrunkingClient.new }.to raise_error(Twilio::REST::ObsoleteError)
   end
 end
+
+describe Twilio::REST::Client do
+  before do
+    Twilio.configure do |config|
+      config.account_sid = 'someSid'
+      config.auth_token = 'someToken'
+      config.http_client = 'someClient'
+    end
+  end
+
+  it 'uses the global configuration by default' do
+    @client = Twilio::REST::Client.new
+    expect(@client.account_sid).to eq('someSid')
+    expect(@client.auth_token).to eq('someToken')
+    expect(@client.http_client).to eq('someClient')
+  end
+
+  it 'uses the arguments over global configuration' do
+    @client = Twilio::REST::Client.new('myUser', 'myPassword', nil, nil, 'myClient')
+    expect(@client.account_sid).to eq('myUser')
+    expect(@client.auth_token).to eq('myPassword')
+    expect(@client.http_client).to eq('myClient')
+  end
+
+  it 'successfully validates the working SSL certificate' do
+    @holodeck.mock Twilio::Response.new(200, '')
+    expect { @client.validate_ssl_certificate }.not_to raise_error
+  end
+
+  it 'fails to validate broken SSL certificates' do
+    @holodeck.mock Twilio::Response.new(504, '')
+    expect { @client.validate_ssl_certificate }.to raise_error(Twilio::REST::RestError)
+  end
+end

data/spec/security/request_validator_spec.rb

@@ -30,84 +30,96 @@ 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) { '0a1ff7634d9ab3b95db5c9a2dfe9416e41502b283a80c7cf19632632f96e6620' }
+
+    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 hash body correctly' do
+      expect(validator.build_hash_for(body)).to eq(body_hash)
+    end
+
+    it 'should validate requests with body correctly' do
+      url_with_hash = "#{url}&bodySHA256=#{body_hash}"
+      expect(validator.validate(url_with_hash, body, 'a9nBmqA0ju/hNViExpshrM61xv4=')).to eq(true)
+    end
+
+    it 'should validate with no other GET parameters' do
+      url_with_hash = "https://mycompany.com/myapp.php?bodySHA256=#{body_hash}"
+      expect(validator.validate(url_with_hash, body, 'y77kIzt2vzLz71DgmJGsen2scGs=')).to eq(true)
+    end
+
+    it 'should fail validation with body but no signature' do
+      expect(validator.validate(url, body, default_signature)).to eq(false)
+    end
+
+    it 'should validate https urls with ports by stripping them' do
+      url_with_port = url.sub('.com', '.com:1234')
+      expect(validator.validate(url_with_port, params, default_signature)).to eq(true)
+    end
+
+    it 'should validate http urls with ports' do
+      http_url_with_port = url.sub('.com', '.com:1234')
+      http_url_with_port = http_url_with_port.sub('https', 'http')
+      signature = 'Zmvh+3yNM1Phv2jhDCwEM3q5ebU=' # hash of http url with port 1234
+      expect(validator.validate(http_url_with_port, params, signature)).to eq(true)
+    end
+
+    it 'should validate https urls without ports by adding standard port 443' do
+      signature = 'kvajT1Ptam85bY51eRf/AJRuM3w=' # hash of https url with port 443
+      expect(validator.validate(url, params, signature)).to eq(true)
     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 validate http urls without ports by adding standard port 80' do
+      http_url = url.sub('https', 'http')
+      signature = '0ZXoZLH/DfblKGATFgpif+LLRf4=' # hash of http url with port 80
+      expect(validator.validate(http_url, params, signature)).to eq(true)
     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 urls with credentials' do
+      url_with_creds = 'https://user:pass@mycompany.com/myapp.php?foo=1&bar=2'
+      signature = 'CukzLTc1tT5dXEDIHm/tKBanW10=' # expected hash of the url
+      expect(validator.validate(url_with_creds, params, signature)).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 urls with just username' do
+      url_with_creds = 'https://user@mycompany.com/myapp.php?foo=1&bar=2'
+      signature = '2YRLlVAflCqxaNicjMpJcSTgzSs=' # expected hash of the url
+      expect(validator.validate(url_with_creds, params, signature)).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 validate urls with credentials by adding port' do
+      url_with_creds = 'https://user:pass@mycompany.com/myapp.php?foo=1&bar=2'
+      signature = 'ZQFR1PTIZXF2MXB8ZnKCvnnA+rI=' # expected hash of the url with port 443
+      expect(validator.validate(url_with_creds, params, signature)).to eq(true)
     end
   end
 end

data/spec/spec_helper.rb

@@ -10,6 +10,8 @@ require_relative './holodeck/hologram.rb'
 
 require 'twilio-ruby'
 require 'rack'
+require 'rspec/matchers'
+require 'equivalent-xml'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
@@ -30,3 +32,7 @@ end
 def auth_token
   ENV['AUTH_TOKEN']
 end
+
+def parse(twiml_response)
+  Nokogiri::XML::Document.parse(twiml_response.to_s, &:noblanks)
+end

data/spec/twilio_spec.rb

@@ -3,13 +3,15 @@ describe Twilio do
     Twilio.instance_variable_set('@configuration', nil)
   end
 
-  it 'should set the account sid and auth token with a config block' do
+  it 'should set the configuration with a config block' do
     Twilio.configure do |config|
       config.account_sid = 'someSid'
       config.auth_token = 'someToken'
+      config.http_client = 'someClient'
     end
 
     expect(Twilio.account_sid).to eq('someSid')
     expect(Twilio.auth_token).to eq('someToken')
+    expect(Twilio.http_client).to eq('someClient')
   end
 end

data/spec/twiml/messaging_response_spec.rb

@@ -3,93 +3,233 @@ require 'spec_helper'
 describe Twilio::TwiML::MessagingResponse do
   context 'Testing Response' do
     it 'should allow empty response' do
-      r = Twilio::TwiML::MessagingResponse.new
-      expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response/>')
+      expected_doc = parse <<-XML
+        <Response/>
+      XML
+      response = Twilio::TwiML::MessagingResponse.new.to_s
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
     end
 
     it 'should allow using to_xml instead of to_s' do
-      r = Twilio::TwiML::MessagingResponse.new
-      expect(r.to_xml).to eq('<?xml version="1.0" encoding="UTF-8"?><Response/>')
+      expected_doc = parse <<-XML
+        <Response/>
+      XML
+      response = Twilio::TwiML::MessagingResponse.new.to_xml
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
     end
 
-    it 'should allow populated response' do
-      r = Twilio::TwiML::MessagingResponse.new
-      r.message(body: 'Hello')
-      r.redirect('example.com')
+    it 'should allow comments' do
+      twiml = Twilio::TwiML::MessagingResponse.new
+      twiml.comment 'This is awesome'
+      expect(twiml.to_xml).to match(/<!--This is awesome-->/)
+    end
 
-      expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response><Message>Hello</Message><Redirect>example.com</Redirect></Response>')
+    it 'should allow text nodes' do
+      expected_doc = parse <<-XML
+        <Response>Look no tags</Response>
+      XML
+      twiml = Twilio::TwiML::MessagingResponse.new
+      twiml.add_text 'Look no tags'
+      expect(parse(twiml)).to be_equivalent_to(expected_doc).respecting_element_order
     end
 
-    it 'should allow chaining' do
-      r = Twilio::TwiML::MessagingResponse.new.message(body: 'Hello').redirect('example.com')
+    it 'should allow generic child nodes' do
+      expected_doc = parse <<-XML
+        <Response>
+          <message tag="global">
+            <bold>Hello</bold>
+          </alexa>
+        </Response>
+      XML
+
+      twiml = Twilio::TwiML::MessagingResponse.new
+      twiml.add_child('message', tag: 'global') do |custom|
+        custom.add_child('bold', 'Hello')
+      end
+
+      expect(parse(twiml)).to be_equivalent_to(expected_doc).respecting_element_order
+    end
 
-      expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response><Message>Hello</Message><Redirect>example.com</Redirect></Response>')
+    it 'should allow mixed text and generic nodes' do
+      expected_doc = parse <<-XML
+        <Response>
+          before
+          <Child>content</Child>
+          after
+        </Response>
+      XML
+
+      twiml = Twilio::TwiML::MessagingResponse.new
+      twiml.add_text('before')
+           .add_child('Child', 'content')
+           .add_text('after')
+
+      expect(parse(twiml)).to be_equivalent_to(expected_doc).respecting_element_order
+    end
+
+    it 'should allow populated response' do
+      expected_doc = parse <<-XML
+        <Response>
+          <Message>Hello</Message>
+          <Redirect>example.com</Redirect>
+        </Response>
+      XML
+      response = Twilio::TwiML::MessagingResponse.new
+      response.message(body: 'Hello')
+      response.redirect('example.com')
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
+    end
+
+    it 'should allow chaining' do
+      expected_doc = parse <<-XML
+        <Response>
+          <Message>Hello</Message>
+          <Redirect>example.com</Redirect>
+        </Response>
+      XML
+      response = Twilio::TwiML::MessagingResponse.new.message(body: 'Hello').redirect('example.com')
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
     end
 
     it 'should allow nesting' do
-      r = Twilio::TwiML::MessagingResponse.new
-      r.message(body: 'Hello') do |m|
-        m.media('foobar')
+      expected_doc = parse <<-XML
+        <Response>
+          <Message>
+            Hello
+            <Media>foobar</Media>
+          </Message>
+        </Response>
+      XML
+      response = Twilio::TwiML::MessagingResponse.new
+      response.message(body: 'Hello') do |message|
+        message.media('foobar')
       end
-
-      expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response><Message>Hello<Media>foobar</Media></Message></Response>')
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
     end
 
     it 'should allow nesting and chaining' do
-      r = Twilio::TwiML::MessagingResponse.new
-      r.message(body: 'Hello') do |m|
-        m.media('foobar')
+      expected_doc = parse <<-XML
+        <Response>
+          <Message>
+            Hello
+            <Media>foobar</Media>
+          </Message>
+          <Redirect>example.com</Redirec>
+        </Response>
+      XML
+      response = Twilio::TwiML::MessagingResponse.new
+      response.message(body: 'Hello') do |message|
+        message.media('foobar')
       end
 
-      r.redirect('example.com')
+      response.redirect('example.com')
 
-      expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response><Message>Hello<Media>foobar</Media></Message><Redirect>example.com</Redirect></Response>')
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
     end
 
     it 'should allow nesting from the initializer' do
-      response = Twilio::TwiML::MessagingResponse.new do |r|
-        r.message(body: 'Hello')
-        r.redirect('example.com')
+      expected_doc = parse <<-XML
+        <Response>
+          <Message>Hello</Message>
+          <Redirect>example.com</Redirec>
+        </Response>
+      XML
+      response = Twilio::TwiML::MessagingResponse.new do |res|
+        res.message(body: 'Hello')
+        res.redirect('example.com')
       end
-      expect(response.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response><Message>Hello</Message><Redirect>example.com</Redirect></Response>')
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
     end
   end
 
   context 'Testing Message' do
     it 'should allow a body' do
-      r = Twilio::TwiML::MessagingResponse.new
-      r.message(body: 'Hello')
-
-      expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response><Message>Hello</Message></Response>')
+      expected_doc = parse <<-XML
+        <Response>
+          <Message>Hello</Message>
+        </Response>
+      XML
+      response = Twilio::TwiML::MessagingResponse.new
+      response.message(body: 'Hello')
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
     end
 
     it 'should allow appending Body' do
-      b = Twilio::TwiML::Body.new('Hello World')
-
-      r = Twilio::TwiML::MessagingResponse.new
-      r.append(b)
-
-      expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response><Body>Hello World</Body></Response>')
+      expected_doc = parse <<-XML
+        <Response>
+          <Message><Body>Hello World</Body></Message>
+        </Response>
+      XML
+      body = Twilio::TwiML::Body.new('Hello World')
+      message = Twilio::TwiML::Message.new
+
+      response = Twilio::TwiML::MessagingResponse.new
+      message.append(body)
+      response.append(message)
+
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
     end
 
     it 'should allow appending Body and Media' do
-      b = Twilio::TwiML::Body.new('Hello World')
-      m = Twilio::TwiML::Media.new('hey.jpg')
+      expected_doc = parse <<-XML
+        <Response>
+          <Message>
+            <Body>Hello World</Body>
+            <Media>hey.jpg</Media>
+          </Message>
+        </Response>
+      XML
+      body = Twilio::TwiML::Body.new('Hello World')
+      media = Twilio::TwiML::Media.new('hey.jpg')
+      message = Twilio::TwiML::Message.new
+
+      response = Twilio::TwiML::MessagingResponse.new
+      message.append(body)
+      message.append(media)
+      response.append(message)
+
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
+    end
 
-      r = Twilio::TwiML::MessagingResponse.new
-      r.append(b)
-      r.append(m)
+    it 'should allow and preserve new lines in messages' do
+      expected_doc = parse <<-XML
+        <Response>
+          <Message>Hello
+World
+          </Message>
+        </Response>
+      XML
 
-      expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response><Body>Hello World</Body><Media>hey.jpg</Media></Response>')
+      response = Twilio::TwiML::MessagingResponse.new
+      response.message(body: "Hello\nWorld")
+
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
     end
   end
 
   context 'Testing Redirect' do
     it 'should allow MessagingResponse.redirect' do
-      r = Twilio::TwiML::MessagingResponse.new
-      r.redirect('example.com')
-
-      expect(r.to_s).to eq('<?xml version="1.0" encoding="UTF-8"?><Response><Redirect>example.com</Redirect></Response>')
+      expected_doc = parse <<-XML
+        <Response>
+          <Redirect>example.com</Redirect>
+        </Response>
+      XML
+      response = Twilio::TwiML::MessagingResponse.new
+      response.redirect('example.com')
+
+      doc = parse(response)
+      expect(doc).to be_equivalent_to(expected_doc).respecting_element_order
     end
   end
 end