Re-write unit tests for API License Endpoint, and clean up code

Author: jakejackson1

src/Api/V1/License/Api_License.php

@@ -5,8 +5,8 @@
 use GFPDF\Api\V1\Base_Api;
 use GFPDF\Helper\Helper_Data;
 use GFPDF\Helper\Helper_Abstract_Addon;
-
 use Psr\Log\LoggerInterface;
+use WP_Error;
 
 /**
  * @package     Gravity PDF
@@ -48,41 +48,31 @@
 class Api_License extends Base_Api {
 
 	/**
-	 * Holds our log class
-	 *
-	 * @var \Monolog\Logger
-	 *
-	 * @since 4.0
+	 * @var LoggerInterface
+	 * @since 5.2
 	 */
 	public $log;
 
 	/**
-	 * Holds our Helper_Data object
-	 * which we can autoload with any data needed
-	 *
 	 * @var \GFPDF\Helper\Helper_Data
-	 *
 	 * @since 5.2
 	 */
 	protected $data;
 
 	/**
 	 * Api_License constructor.
 	 *
-	 * @param Helper_Data $data
+	 * @param LoggerInterface $log
+	 * @param Helper_Data     $data
 	 *
 	 * @since 5.2
 	 */
 	public function __construct( LoggerInterface $log, Helper_Data $data ) {
-		$this->log 	= $log;
+		$this->log  = $log;
 		$this->data = $data;
 	}
 
 	/**
-	 * Register our PDF save font endpoint
-	 *
-	 * @Internal Use this endpoint to save fonts
-	 *
 	 * @since    5.2
 	 */
 	public function register() {
@@ -101,39 +91,36 @@ public function register() {
 	}
 
 	/**
-	 * Processes the rest API endpoint
+	 * Processes the REST API endpoint
 	 *
 	 * @param \WP_REST_Request $request
 	 *
-	 * @return array|\WP_Error
+	 * @return array|WP_Error
 	 *
 	 * @since 5.2
 	 */
 	public function process_license_deactivation( \WP_REST_Request $request ) {
-
 		$params = $request->get_json_params();
-
-		/* Get the required details */
-		/* do not proceed if these are empty/null */
-		if ( empty( $params['addon_name'] ) || empty( $params['license'] ) ) {
-			return new \WP_Error( 'process_license_deactivation', 'Required Field is missing, please try again', [ 'status' => 400 ] );
+		if ( ! isset( $params['addon_name'], $params['license'] ) ) {
+			return new WP_Error( 'license_deactivation_fields_missing', 'Required Field is missing, please try again', [ 'status' => 400 ] );
 		}
 
-		$addon = $this->data->addon( $params['addon_name'] );
-
 		/* Check add-on currently installed */
-		if ( empty( $addon ) ) {
-			return new \WP_Error( 'process_license_deactivation', 'An error occurred during deactivation, please try again', [ 'status' => 404 ] );
+		if ( empty( $this->data->addon[ $params['addon_name'] ] ) ) {
+			return new WP_Error( 'license_deactivation_addon_not_found', 'An error occurred during deactivation, please try again', [ 'status' => 404 ] );
 		}
 
+		$addon           = $this->data->addon[ $params['addon_name'] ];
 		$was_deactivated = $this->deactivate_license_key( $addon, $params['license'] );
-		
+
 		if ( ! $was_deactivated ) {
 			$license_info = $addon->get_license_info();
-			return new \WP_Error( 'schedule_license_check', $license_info['message'], [ 'status' => 400 ] );
+
+			return new WP_Error( 'license_deactivation_schedule_license_check', $license_info['message'], [ 'status' => 400 ] );
 		}
 
 		$this->log->addNotice( 'Successfully Deactivated License' );
+
 		return [ 'success' => esc_html__( 'License deactivated.', 'gravity-forms-pdf-extended' ) ];
 	}
 
@@ -147,7 +134,7 @@ public function process_license_deactivation( \WP_REST_Request $request ) {
 	 *
 	 * @since 5.2
 	 */
-	public function deactivate_license_key( Helper_Abstract_Addon $addon, $license_key ) {
+	protected function deactivate_license_key( Helper_Abstract_Addon $addon, $license_key ) {
 		$response = wp_remote_post(
 			$this->data->store_url,
 			[
@@ -161,18 +148,16 @@ public function deactivate_license_key( Helper_Abstract_Addon $addon, $license_k
 			]
 		);
 
-		/* If API error exit early */
-		if ( is_wp_error( $response ) || 200 !== wp_remote_retrieve_response_code( $response ) ) {
+		if ( is_wp_error( $response ) || wp_remote_retrieve_response_code( $response ) !== 200 ) {
 			return false;
 		}
 
-		/* Get API response and check license is now deactivated */
+		/* Verify license is now deactivated */
 		$license_data = json_decode( wp_remote_retrieve_body( $response ) );
 		if ( ! isset( $license_data->license ) || $license_data->license !== 'deactivated' ) {
 			return false;
 		}
 
-		/* Remove license data from database */
 		$addon->delete_license_info();
 
 		$this->log->addNotice(
@@ -185,4 +170,4 @@ public function deactivate_license_key( Helper_Abstract_Addon $addon, $license_k
 
 		return true;
 	}
-}
+}

…nit-tests/api/ApiFontsEndpointRoutes.php …nit-tests/Api/ApiFontsEndpointRoutes.phptests/phpunit/unit-tests/api/ApiFontsEndpointRoutes.php renamed to tests/phpunit/unit-tests/Api/ApiFontsEndpointRoutes.php tests/phpunit/unit-tests/api/ApiFontsEndpointRoutes.php renamed to tests/phpunit/unit-tests/Api/ApiFontsEndpointRoutes.php

@@ -0,0 +1,156 @@
+<?php
+
+namespace GFPDF\Api\V1\License;
+
+use GFPDF\Helper\Helper_Data;
+use GFPDF\Helper\Helper_Abstract_Addon;
+use GFPDF\Helper\Helper_Logger;
+use GFPDF\Helper\Helper_Singleton;
+use WP_UnitTestCase;
+use WP_REST_Request;
+use GPDFAPI;
+
+/**
+ * @package     Gravity PDF GravityPDF
+ * @copyright   Copyright (c) 2018, Blue Liquid Designs
+ * @license     http://opensource.org/licenses/gpl-2.0.php GNU Public License
+ * @since       1.0
+ */
+
+/* Exit if accessed directly */
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+/*
+    This file is part of Gravity PDF GravityPDF.
+
+    Copyright (C) 2018, Blue Liquid Designs
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
+/**
+ * Class TestApiLicenseEndpoint
+ *
+ * @package GFPDF\Tests\GravityPDF
+ *
+ * @group   REST-API
+ */
+class TestApiLicenseEndpointRoutes extends WP_UnitTestCase {
+
+	/**
+	 * @var Api_License
+	 * @since 5.2
+	 */
+	protected $class;
+
+	/**
+	 * @var Helper_Data
+	 */
+	protected $data;
+
+	/**
+	 * @since 5.2
+	 */
+	public function setUp() {
+		$this->data  = GPDFAPI::get_data_class();
+		$this->class = new Api_License( GPDFAPI::get_log_class(), $this->data );
+		$this->class->init();
+
+		parent::setUp();
+	}
+
+	/**
+	 * @since 5.2
+	 */
+	public function test_rest_api_license_endpoints() {
+		$wp_rest_server = rest_get_server();
+		do_action( 'rest_api_init' );
+
+		$this->assertContains( 'gravity-pdf/v1', $wp_rest_server->get_namespaces() );
+		$this->assertArrayHasKey( '/gravity-pdf/v1/license/(?P<id>\d+)/deactivate', $wp_rest_server->get_routes() );
+	}
+
+	/**
+	 * @param array $data
+	 *
+	 * @return WP_REST_Request
+	 *
+	 * @since 5.2
+	 */
+	protected function get_request( $data ) {
+		$request = new WP_REST_Request();
+		$request->set_body( json_encode( $data ) );
+		$request->set_header( 'content-type', 'application/json' );
+		$request->get_json_params();
+
+		return $request;
+	}
+
+	/**
+	 * @since 5.2
+	 */
+	public function test_deactivate_license_key_validation() {
+		$request  = $this->get_request( [ 'addon_name' => '', 'license' => '' ] );
+		$response = $this->class->process_license_deactivation( $request );
+		$this->assertSame( 400, $response->get_error_data( 'license_deactivation_fields_missing' )['status'] );
+
+		/* Test unregistered addon */
+		$request  = $this->get_request( [ 'addon_name' => 'test', 'license' => '12345' ] );
+		$response = $this->class->process_license_deactivation( $request );
+		$this->assertSame( 404, $response->get_error_data( 'license_deactivation_addon_not_found' )['status'] );
+	}
+
+	/**
+	 * @since 5.2
+	 */
+	public function test_deactivate_license_key_api() {
+		$request = $this->get_request( [ 'addon_name' => 'test', 'license' => '12345' ] );
+
+		/* Mock remote request and simulate success */
+		$this->data->addon['test'] = new TestAddon( 'test', 'Test', 'Gravity PDF', '1.0', '', $this->data, GPDFAPI::get_options_class(), new Helper_Singleton(), new Helper_Logger( 'test', 'Test' ), GPDFAPI::get_notice_class() );
+
+		$api_response = function() {
+			return new \WP_Error();
+		};
+
+		add_filter( 'pre_http_request', $api_response );
+
+		$response = $this->class->process_license_deactivation( $request );
+		$this->assertSame( 400, $response->get_error_data( 'license_deactivation_schedule_license_check' )['status'] );
+
+		remove_filter( 'pre_http_request', $api_response );
+
+		/* Get a success test */
+		$api_response = function() {
+			return [
+				'response' => [ 'code' => 200 ],
+				'body'     => json_encode( [ 'license' => 'deactivated' ] ),
+			];
+		};
+
+		add_filter( 'pre_http_request', $api_response );
+		$response = $this->class->process_license_deactivation( $request );
+		$this->assertArrayHasKey( 'success', $response );
+		remove_filter( 'pre_http_request', $api_response );
+	}
+}
+
+class TestAddon extends Helper_Abstract_Addon {
+	public function plugin_updater() {
+
+	}
+}