change validation boolean arguments to enum

cleanup abstract transport a bit

Author: dormin

src/Riskified/Common/Env.php

@@ -22,4 +22,10 @@ class Env {
     const STAGING = 'staging';
     const SANDBOX = 'sandbox';
     const DEV = 'development';
-} 
+}
+
+class Validations {
+    const SKIP = 'skip';
+    const IGNORE_MISSING = 'ignore_missing';
+    const ALL = 'all';
+}

src/Riskified/Common/Riskified.php

@@ -20,7 +20,7 @@
  * @package Riskified\Common
  */
 class Riskified {
-    const VERSION = '1.0.9';
+    const VERSION = '1.1.0';
     const API_VERSION = '2';
 
     /**
@@ -36,28 +36,31 @@ class Riskified {
      */
     public static $env;
     /**
-     * @var boolean indicates validation should ignore missing key errors
+     * @var string validation mode [SKIP, IGNORE_MISSING, ALL]
      */
-    public static $ignore_missing_keys;
-    /**
-     * @var boolean skips all validations when true
-     */
-    public static $skip_all_validations;
+    public static $validations;
+
 
     /**
      * Sets up Riskified credentials. Must be called before any other method can be used.
      * @param $domain string Riskified Shop Domain
      * @param $auth_token string Riskified Auth_Token
      * @param $env string Riskified environment
-     * @param $ignore_missing_keys boolean ignores missing keys when true
-     * @param $skip_all_validations boolean skips all validations when true
+     * @param $validations string SDK validation mode
      */
-    public static function init($domain, $auth_token, $env = Env::SANDBOX, $ignore_missing_keys = false, $skip_all_validations = false) {
+    public static function init($domain, $auth_token, $env = Env::SANDBOX, $validations = Validations::ALL) {
         self::$domain = $domain;
         self::$auth_token = $auth_token;
         self::$env = $env;
-        self::$ignore_missing_keys = $ignore_missing_keys;
-        self::$skip_all_validations = $skip_all_validations;
+
+        // for backward compatibility (versions 1.0.*)
+        if (is_bool($validations))
+            $validations = ($validations) ? Validations::SKIP : Validations::ALL;
+
+        self::$validations = $validations;
+
+        // suppress timezone warnings:
+        date_default_timezone_set(@date_default_timezone_get());
     }
 
     public static function getHostByEnv(){

src/Riskified/OrderWebhook/Model/AbstractModel.php

@@ -14,7 +14,6 @@
  * permissions and limitations under the License.
  */
 
-use Riskified\Common\Riskified;
 use Riskified\OrderWebhook\Exception;
 
 /**
@@ -116,7 +115,7 @@ public function toXml() {
      * @throws \Riskified\OrderWebhook\Exception\MultiplePropertiesException on any or multiple issues
      */
     public function validate($enforce_required_keys=true) {
-        $exceptions = $this->validation_exceptions($enforce_required_keys && !Riskified::$ignore_missing_keys);
+        $exceptions = $this->validation_exceptions($enforce_required_keys);
         if ($exceptions)
             throw new Exception\MultiplePropertiesException($exceptions);
         return true;

src/Riskified/OrderWebhook/Transport/AbstractTransport.php

@@ -16,6 +16,7 @@
 
 use Riskified\Common\Env;
 use Riskified\Common\Riskified;
+use Riskified\Common\Validations;
 
 /**
  * Class AbstractTransport
@@ -60,9 +61,7 @@ public function __construct($signature, $url = null) {
      * @throws \Riskified\Common\Exception\BaseException on any issue
      */
     public function submitOrder($order) {
-        if ($this->validate_order($order))
-            return $this->send_order($order, 'submit');
-        return null;
+        return $this->send_order($order, 'submit', true);
     }
 
     /**
@@ -72,9 +71,7 @@ public function submitOrder($order) {
      * @throws \Riskified\Common\Exception\BaseException on any issue
      */
     public function createOrder($order) {
-        if ($this->validate_order($order))
-            return $this->send_order($order, 'create');
-        return null;
+        return $this->send_order($order, 'create', true);
     }
 
     /**
@@ -84,9 +81,7 @@ public function createOrder($order) {
      * @throws \Riskified\Common\Exception\BaseException on any issue
      */
     public function updateOrder($order) {
-        if ($this->validate_order($order, false))
-            return $this->send_order($order, 'update');
-        return null;
+        return $this->send_order($order, 'update', false);
     }
 
     /**
@@ -96,9 +91,7 @@ public function updateOrder($order) {
      * @throws \Riskified\Common\Exception\BaseException on any issue
      */
     public function cancelOrder($order) {
-        if ($this->validate_order($order, false))
-            return $this->send_order($order, 'cancel');
-        return null;
+        return $this->send_order($order, 'cancel', false);
     }
 
     /**
@@ -108,9 +101,7 @@ public function cancelOrder($order) {
      * @throws \Riskified\Common\Exception\BaseException on any issue
      */
     public function refundOrder($order) {
-        if ($this->validate_order($order, false))
-            return $this->send_order($order, 'refund');
-        return null;
+        return $this->send_order($order, 'refund', false);
     }
 
     public function sendHistoricalOrders($orders) {
@@ -119,15 +110,18 @@ public function sendHistoricalOrders($orders) {
         return $this->send_json_request($json, 'historical');
     }
 
-    protected function validate_order($order, $enforce_required_keys=true) {
-        if (Riskified::$skip_all_validations)
-            return true;
-        return $order->validate($enforce_required_keys);
+    protected function send_order($order, $endpoint, $enforce_required_keys) {
+        if ($this->validate($order, $enforce_required_keys)) {
+            $json = '{"order":' . $order->toJson() . '}';
+            return $this->send_json_request($json, $endpoint);
+        }
+        return null;
     }
 
-    protected function send_order($order, $endpoint) {
-        $json = '{"order":'.$order->toJson().'}';
-        return $this->send_json_request($json, $endpoint);
+    protected function validate($order, $enforce_required_keys=true) {
+        if (Riskified::$validations == Validations::SKIP)
+            return true;
+        return $order->validate($enforce_required_keys && Riskified::$validations == Validations::ALL);
     }
 
     /**