Merge pull request #86 from hellosign/AS-174

Embedded Bulk Send

Author: jyoung488

library/HelloSign/Client.php

@@ -41,7 +41,7 @@
 class Client
 {
 
-    const VERSION = '3.5.6';
+    const VERSION = '3.5.7';
 
     const API_URL = "https://api.hellosign.com/v3/";
 
@@ -60,7 +60,8 @@ class Client
     const SIGNATURE_REQUEST_FILES_PATH             = "signature_request/files";
     const SIGNATURE_REQUEST_EMBEDDED_PATH          = "signature_request/create_embedded";
     const SIGNATURE_REQUEST_EMBEDDED_TEMPLATE_PATH = "signature_request/create_embedded_with_template";
-    const SIGNATURE_REQUEST_BULK_SEND              = "signature_request/bulk_send_with_template";
+    const SIGNATURE_REQUEST_BULK_SEND_PATH         = "signature_request/bulk_send_with_template";
+    const SIGNATURE_REQUEST_EMBEDDED_BULK_SEND_PATH = "signature_request/bulk_create_embedded_with_template";
 
     const TEMPLATE_PATH                   = "template";
     const TEMPLATE_LIST_PATH              = "template/list";
@@ -1135,7 +1136,28 @@ public function sendBulkSendJobWithTemplate(BulkSendJob $request)
         $params = $request->toParams();
 
         $response = $this->rest->post(
-            static::SIGNATURE_REQUEST_BULK_SEND,
+            static::SIGNATURE_REQUEST_BULK_SEND_PATH,
+            $params
+        );
+
+        $this->checkResponse($response);
+
+        return new BulkSendJob($response);
+    }
+
+    /**
+     * Creates a new embedded Bulk Send Job using the specified Template
+     *
+     * @param  EmbeddedBulkSendJob $request
+     * @return BulkSendJob
+     * @throws BaseException
+     */
+    public function sendEmbeddedBulkSendJobWithTemplate(EmbeddedBulkSendJob $request)
+    {
+        $params = $request->toParams();
+
+        $response = $this->rest->post(
+            static::SIGNATURE_REQUEST_EMBEDDED_BULK_SEND_PATH,
             $params
         );
 

library/HelloSign/EmbeddedBulkSendJob.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * HelloSign PHP SDK (https://github.com/hellosign/hellosign-php-sdk/)
+ */
+
+/**
+ * The MIT License (MIT)
+ *
+ * Copyright (C) 2014 hellosign.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace HelloSign;
+
+/**
+ * Represents a HelloSign BulkSendJob to send Embedded SignatureRequests based on a Template
+ *
+ * An embedded SignatureRequest is one that can be signed from within an
+ * iFrame on your website.
+ */
+class EmbeddedBulkSendJob extends AbstractSignatureRequestWrapper
+{
+    /**
+     * @return array
+     * @ignore
+     */
+    public function toParams()
+    {
+        /**
+         * Here we combine (using the + operator) the param arrays for the
+         * BulkSendJob object with itself (the Embedded BulkSendJob
+         * object) to get the final params array. The order of this union is
+         * important! The params from $this->request must be left of the union
+         * operator so that its values (e.g. test_mode) take precedence over
+         * our defaults.
+         */
+        return $this->request->toParams(array(
+            'except' => array(
+            )
+        )) + $this->toArray(array(
+            'except' => array(
+                'request',
+                'skip_me_now'
+            )
+        ));
+    }
+}

library/HelloSign/Test/BulkSendTest.php

@@ -28,6 +28,7 @@
 
 use HelloSign\Template;
 use HelloSign\BulkSendJob;
+use HelloSign\EmbeddedBulkSendJob;
 
 class BulkSendTest extends AbstractTest
 {
@@ -160,6 +161,33 @@ public function testSendBulkSendJobWithAllParameters()
    $this->assertNotNull($response->getId());
   }
 
+  /**
+   * @group embedded
+   */
+  public function testSendEmbeddedBulkSendJob()
+  {
+   $templates = $this->client->getTemplates();
+   $template = $templates[0];
+
+   $signers = __DIR__ . "/bulk_send_test_signers.csv";
+
+   $request = new BulkSendJob;
+   $request->enableTestMode();
+   $request->setTitle('Embedded Bulk Send Job Example Title');
+   $request->setTemplateId($template->getId());
+   $request->addSignerFile($signers);
+
+   // Turn it into an embedded request
+   $client_id = $_ENV['CLIENT_ID'];
+   $embedded_request = new EmbeddedBulkSendJob($request, $client_id);
+
+   // Send it to HelloSign
+   $response = $this->client->sendEmbeddedBulkSendJobWithTemplate($embedded_request);
+
+   $this->assertInstanceOf('HelloSign\BulkSendJob', $response);
+   $this->assertNotNull($response->getId());
+  }
+
   /**
    * @group list
    */