Code cleanup

Separated common parts into AbstractFinisher class
gmediaat · Apr 24, 2018 · 01a2d5b · 01a2d5b
1 parent 0d8c0cc
commit 01a2d5b
Show file tree

Hide file tree

Showing 7 changed files with 131 additions and 71 deletions.
diff --git a/Classes/AbstractFinisher.php b/Classes/AbstractFinisher.php
@@ -0,0 +1,55 @@
+<?php
+namespace GradinaruFelix\Pipedrive;
+
+use Neos\Flow\Annotations as Flow;
+use Neos\Form\Core\Model\AbstractFinisher as NeosFormAbstractFinisher;
+use Neos\Form\Exception\FinisherException;
+use GradinaruFelix\Pipedrive\Utility\Api as PipedriveApi;
+
+abstract class AbstractFinisher extends NeosFormAbstractFinisher
+{
+
+  const OMITTED_OPTIONS = array(
+    'testMode',
+    'identifier',
+  );
+
+
+
+  protected function getIdentifier() {
+    $scope = $this->scope;
+    $customIdentifier = $this->parseOption('identifier');
+
+    if($customIdentifier) {
+      $identifier = "Pipedrive." . $customIdentifier;
+    } else {
+      $identifier = "Pipedrive." . $scope . "Finisher";
+    }
+
+    return $identifier;
+  }
+
+  /**
+   * Runs the API request for the given data
+   *
+   * @return bool
+   * @throws FinisherException
+   */
+  protected function callAPI($data) {
+    $apiUtility = new PipedriveApi($this->apiEndpoint);
+    $apiUtility->setData($data);
+
+    $formState = $this->finisherContext->getFormRuntime()->getFormState();
+
+    $response = $apiUtility->execute();
+
+    if($response->data->id) {
+      $formState->setFormValue($this->getIdentifier() . ".ID", $response->data->id);
+      return true;
+    } else {
+      throw new FinisherException("Something went wrong while calling the API!");
+      return false;
+    }
+  }
+
+}
diff --git a/Classes/Finishers/ActivityFinisher.php b/Classes/Finishers/ActivityFinisher.php
@@ -2,34 +2,43 @@
 namespace GradinaruFelix\Pipedrive\Finishers;
 
 use Neos\Flow\Annotations as Flow;
-use Neos\Form\Core\Model\AbstractFinisher;
 use Neos\Form\Exception\FinisherException;
+use GradinaruFelix\Pipedrive\AbstractFinisher;
 use GradinaruFelix\Pipedrive\Utility\Api as PipedriveApi;
 
 /**
- * This finisher creates a activity in Pipedrive
+ * This finisher creates an activity in Pipedrive
  */
 
 class ActivityFinisher extends AbstractFinisher
 {
 
-    const OMITTED_OPTIONS = array(
-      'testMode',
-    );
-
     /**
      * Default activity type
      * @Flow\InjectConfiguration(path="Form.Finisher.Activity.defaultValue")
      * @var String
      */
     protected $defaultType = '';
 
+    /**
+     * API endpoint name
+     * @var String
+     */
+    protected $apiEndpoint = 'activities';
+
+    /**
+     * Name of the scope
+     * @var String
+     */
+    protected $scope = 'Activity';
+
     /**
      * @var array
      */
     protected $defaultOptions = array(
         'subject' => '',
         'done' => true,
+        'identifier' => '',
         'testMode' => false,
     );
 
@@ -54,17 +63,10 @@ protected function executeInternal()
           }
         }
 
-        $apiUtility = new PipedriveApi('activities');
-        $apiUtility->setData($data);
-
-        $formState = $this->finisherContext->getFormRuntime()->getFormState();
-
         if ($testMode === true) {
-
+          \Neos\Flow\var_dump($data);
         } else {
-          $response = $apiUtility->execute();
-          $formState->setFormValue("Pipedrive.ActivityFinisher.ID", $response->data->id);
-          print_r($formState->getFormValues());
+          $this->callAPI($data);
         }
     }
 }
diff --git a/Classes/Finishers/DealFinisher.php b/Classes/Finishers/DealFinisher.php
@@ -2,20 +2,28 @@
 namespace GradinaruFelix\Pipedrive\Finishers;
 
 use Neos\Flow\Annotations as Flow;
-use Neos\Form\Core\Model\AbstractFinisher;
 use Neos\Form\Exception\FinisherException;
+use GradinaruFelix\Pipedrive\AbstractFinisher;
 use GradinaruFelix\Pipedrive\Utility\Api as PipedriveApi;
 
 /**
- * This finisher sends an email to one or more recipients
+ * This finisher creates a deal in Pipedrive
  */
 
 class DealFinisher extends AbstractFinisher
 {
 
-    const OMITTED_OPTIONS = array(
-      'testMode',
-    );
+    /**
+     * API endpoint name
+     * @var String
+     */
+    protected $apiEndpoint = 'deals';
+
+    /**
+     * Name of the scope
+     * @var String
+     */
+    protected $scope = 'Deal';
 
     /**
      * @var array
@@ -44,17 +52,10 @@ protected function executeInternal()
           }
         }
 
-        $apiUtility = new PipedriveApi('deals');
-        $apiUtility->setData($data);
-
-        $formState = $this->finisherContext->getFormRuntime()->getFormState();
-
         if ($testMode === true) {
-
+          \Neos\Flow\var_dump($data);
         } else {
-          $response = $apiUtility->execute();
-          $formState->setFormValue("Pipedrive.DealFinisher.ID", $response->data->id);
-          print_r($formState->getFormValues());
+          $this->callAPI($data);
         }
     }
 }
diff --git a/Classes/Finishers/NoteFinisher.php b/Classes/Finishers/NoteFinisher.php
@@ -2,20 +2,28 @@
 namespace GradinaruFelix\Pipedrive\Finishers;
 
 use Neos\Flow\Annotations as Flow;
-use Neos\Form\Core\Model\AbstractFinisher;
 use Neos\Form\Exception\FinisherException;
+use GradinaruFelix\Pipedrive\AbstractFinisher;
 use GradinaruFelix\Pipedrive\Utility\Api as PipedriveApi;
 
 /**
- * This finisher sends an email to one or more recipients
+ * This finisher creates a note in Pipedrive
  */
 
 class NoteFinisher extends AbstractFinisher
 {
 
-    const OMITTED_OPTIONS = array(
-      'testMode',
-    );
+    /**
+     * API endpoint name
+     * @var String
+     */
+    protected $apiEndpoint = 'notes';
+
+    /**
+     * Name of the scope
+     * @var String
+     */
+    protected $scope = 'Note';
 
     /**
      * @var array
@@ -43,17 +51,10 @@ protected function executeInternal()
           }
         }
 
-        $apiUtility = new PipedriveApi('notes');
-        $apiUtility->setData($data);
-
-        $formState = $this->finisherContext->getFormRuntime()->getFormState();
-
         if ($testMode === true) {
-
+          \Neos\Flow\var_dump($data);
         } else {
-          $response = $apiUtility->execute();
-          $formState->setFormValue("Pipedrive.ActivityFinisher.ID", $response->data->id);
-          print_r($formState->getFormValues());
+          $this->callAPI($data);
         }
     }
 }
diff --git a/Classes/Finishers/OrganizationFinisher.php b/Classes/Finishers/OrganizationFinisher.php
@@ -1,20 +1,28 @@
 <?php
 namespace GradinaruFelix\Pipedrive\Finishers;
 
-use Neos\Form\Core\Model\AbstractFinisher;
 use Neos\Form\Exception\FinisherException;
+use GradinaruFelix\Pipedrive\AbstractFinisher;
 use GradinaruFelix\Pipedrive\Utility\Api as PipedriveApi;
 
 /**
- * This finisher sends an email to one or more recipients
+ * This finisher creates an organization in Pipedrive
  */
 
 class OrganizationFinisher extends AbstractFinisher
 {
 
-    const OMITTED_OPTIONS = array(
-      'testMode',
-    );
+    /**
+     * API endpoint name
+     * @var String
+     */
+    protected $apiEndpoint = 'organizations';
+
+    /**
+     * Name of the scope
+     * @var String
+     */
+    protected $scope = 'Organization';
 
     /**
      * @var array
@@ -42,17 +50,10 @@ protected function executeInternal()
           }
         }
 
-        $apiUtility = new PipedriveApi('organizations');
-        $apiUtility->setData($data);
-
-        $formState = $this->finisherContext->getFormRuntime()->getFormState();
-
         if ($testMode === true) {
-
+          \Neos\Flow\var_dump($data);
         } else {
-          $response = $apiUtility->execute();
-          $formState->setFormValue("Pipedrive.OrganizationFinisher.ID", $response->data->id);
-          print_r($formState->getFormValues());
+          $this->callAPI($data);
         }
     }
 }
diff --git a/Classes/Finishers/PersonFinisher.php b/Classes/Finishers/PersonFinisher.php
@@ -1,8 +1,8 @@
 <?php
 namespace GradinaruFelix\Pipedrive\Finishers;
 
-use Neos\Form\Core\Model\AbstractFinisher;
 use Neos\Form\Exception\FinisherException;
+use GradinaruFelix\Pipedrive\AbstractFinisher;
 use GradinaruFelix\Pipedrive\Utility\Api as PipedriveApi;
 
 /**
@@ -12,9 +12,17 @@
 class PersonFinisher extends AbstractFinisher
 {
 
-    const OMITTED_OPTIONS = array(
-      'testMode',
-    );
+    /**
+     * API endpoint name
+     * @var String
+     */
+    protected $apiEndpoint = 'persons';
+
+    /**
+     * Name of the scope
+     * @var String
+     */
+    protected $scope = 'Person';
 
     /**
      * @var array
@@ -42,17 +50,10 @@ protected function executeInternal()
           }
         }
 
-        $apiUtility = new PipedriveApi('persons');
-        $apiUtility->setData($data);
-
-        $formState = $this->finisherContext->getFormRuntime()->getFormState();
-
         if ($testMode === true) {
-
+          \Neos\Flow\var_dump($data);
         } else {
-          $response = $apiUtility->execute();
-          $formState->setFormValue("Pipedrive.PersonFinisher.ID", $response->data->id);
-          print_r($formState->getFormValues());
+          $this->callAPI($data);
         }
     }
 }
diff --git a/Classes/Utility/Api.php b/Classes/Utility/Api.php
@@ -74,7 +74,6 @@ public function execute()
   {
     $ch = curl_init();
     curl_setopt($ch, CURLOPT_URL, $this->getURI());
-    var_dump($this->getURI());
     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
     curl_setopt($ch, CURLOPT_POST, true);
     curl_setopt($ch, CURLOPT_POSTFIELDS, $this->data);