OPENTOK-35108 Add from support on SIP calls

Author: Guillermo López Leal

sample/SipCall/README.md

@@ -19,6 +19,7 @@ Next, input your own API Key, API Secret, and SIP configuration into the `run-de
   export SIP_USERNAME=
   export SIP_PASSWORD=
   export SIP_SECURE=false
+  export [email protected]
 ```
 
 Finally, start the PHP CLI development server (requires PHP >= 5.4) using the `run-demo` script

sample/SipCall/run-demo

@@ -11,6 +11,9 @@ then
   export SIP_USERNAME=
   export SIP_PASSWORD=
   export SIP_SECURE=false
+
+  # SIP from (optional)
+  export [email protected]
 fi
 
 if [ -d "cache" ]

sample/SipCall/run-demo.bat

@@ -15,6 +15,9 @@ SET SIP_USERNAME=
 SET SIP_PASSWORD=
 SET SIP_SECURE=false
 
+:: SIP from (optional)
+SET SIP_FROM=
+
 :skipdef
 
 RD /q /s cache

sample/SipCall/web/index.php

@@ -49,7 +49,8 @@
   'uri' => getenv('SIP_URI'),
   'username' => getenv('SIP_USERNAME'),
   'password' => getenv('SIP_PASSWORD'),
-  'secure' => (getenv('SIP_SECURE') === 'true')
+  'secure' => (getenv('SIP_SECURE') === 'true'),
+  'from' => getenv('SIP_FROM'),
 );
 
 // Configure routes
@@ -79,7 +80,8 @@
 
     // create the options parameter
     $options = array(
-      'secure' => $app->sip['secure']
+      'secure' => $app->sip['secure'],
+      'from' => $app->$sip['from'],
     );
     if ($app->sip['username'] !== false) {
         $options['auth'] = array('username' => $app->sip['username'], 'password' => $app->sip['password']);

src/OpenTok/OpenTok.php

@@ -531,9 +531,10 @@ public function dial($sessionId, $token, $sipUri, $options=array())
             'auth' => null,
             'headers' => null,
             'secure' => true,
+            'from' => null,
         );
         $options = array_merge($defaults, array_intersect_key($options, $defaults));
-        list($headers, $secure) = array_values($options);
+        list($headers, $secure, $from) = array_values($options);
 
         // validate arguments
         Validators::validateSessionIdBelongsToKey($sessionId, $this->apiKey);

src/OpenTok/Util/Client.php

@@ -262,6 +262,9 @@ public function dial($sessionId, $token, $sipUri, $options)
         if (isset($options) && array_key_exists('auth', $options)) {
             $body['sip']['auth'] = $options['auth'];
         }
+        if (isset($options) && array_key_exists('from', $options)) {
+            $body['sip']['from'] = $options['from'];
+        }
 
         // set up the request
         $request = $this->post('/v2/project/'.$this->apiKey.'/call');

tests/OpenTok/OpenTokTest.php

@@ -1232,5 +1232,43 @@ public function testFailedSipCall()
           $this->assertNull($sipCall);
       }
     }
+
+    public function testSipCallFrom()
+    {
+      // Arrange
+      $mock = new MockPlugin();
+      $response = MockPlugin::getMockFile(
+          self::$mockBasePath . 'v2/project/APIKEY/dial'
+      );
+      $mock->addResponse($response);
+      $this->client->addSubscriber($mock);
+
+      $sessionId = '1_MX4xMjM0NTY3OH4-VGh1IEZlYiAyNyAwNDozODozMSBQU1QgMjAxNH4wLjI0NDgyMjI';
+      $bogusApiKey = '12345678';
+      $bogusApiSecret = '0123456789abcdef0123456789abcdef0123456789';
+      $bogusToken = 'T1==TEST';
+      $bogusSipUri = 'sip:[email protected]';
+      $opentok = new OpenTok($bogusApiKey, $bogusApiSecret);
+
+      $from = "[email protected]";
+
+      // Act
+      $sipCall = $this->opentok->dial($sessionId, $bogusToken, $bogusSipUri, array(
+        'from' => $from
+      ));
+
+      // Assert
+      $this->assertInstanceOf('OpenTok\SipCall', $sipCall);
+      $this->assertNotNull($sipCall->id);
+      $this->assertNotNull($sipCall->connectionId);
+      $this->assertNotNull($sipCall->streamId);
+
+      $requests = $mock->getReceivedRequests();
+      $this->assertCount(1, $requests);
+      $request = $requests[0];
+
+      $body = json_decode($request->getBody());
+      $this->assertEquals($from, $body->sip->from);
+    }
 }
 /* vim: set ts=4 sw=4 tw=100 sts=4 et :*/