Merge pull request #2 from duckdev/dev

Merge new changes

Author: Joel-James

README.md

@@ -30,7 +30,7 @@ $freemius = DuckDev\Freemius\Freemius::get_instance(
     12345, // Your Freemius product ID.
     array(
         'slug' => 'loggedin', // Your plugin's unique Freemius slug.
-	    'main_file'  => LOGGEDIN_FILE, // The path to your plugin's main file.
+        'main_file'  => LOGGEDIN_FILE, // The path to your plugin's main file.
         'public_key' => 'pk_XXXXXXXXXXXXXXXXX', // Your plugin's public key.
     )
 );

src/api/class-api.php

@@ -6,6 +6,8 @@
  * @license    http://www.gnu.org/licenses/ GNU General Public License
  * @author     Joel James <[email protected]>
  * @since      1.0.0
+ * @package    Freemius
+ * @subpackage API
  */
 
 namespace DuckDev\Freemius\Api;
@@ -187,7 +189,7 @@ public function delete( string $endpoint, array $data = array() ) {
 	 * @return mixed|WP_Error
 	 */
 	public function prepare_response( $response ) {
-		// If WP error, return.
+		// If WP error, return as it is.
 		if ( is_wp_error( $response ) ) {
 			return $response;
 		}
@@ -225,7 +227,7 @@ protected function prepare_request( string $method, string $endpoint, array $dat
 
 		$headers = array();
 
-		// Sign the request for auth.
+		// Sign the request for auth if both pub and secret keys are set.
 		if ( $this->public_key && $this->secret_key ) {
 			$headers = $this->get_signed_headers(
 				$endpoint,
@@ -237,6 +239,7 @@ protected function prepare_request( string $method, string $endpoint, array $dat
 			);
 		}
 
+		// Perform the request.
 		return $this->perform_http_request( $method, $url, $data, $headers );
 	}
 
@@ -254,6 +257,7 @@ protected function prepare_request( string $method, string $endpoint, array $dat
 	protected function prepare_url( string $method, string $endpoint, array $data = array() ): string {
 		$url = $this->base_url . $endpoint;
 
+		// For GET request add query params.
 		if ( $method === 'GET' && ! empty( $data ) ) {
 			$url = add_query_arg( $data, $url );
 		}
@@ -297,11 +301,13 @@ protected function prepare_endpoint( string $endpoint ): string {
 	protected function perform_http_request( string $method, string $url, array $data = array(), array $headers = array() ) {
 		$method = strtoupper( $method );
 		$body   = null;
+		// Make sure the content type is JSON.
 		if ( in_array( $method, array( 'POST', 'PUT', 'DELETE' ) ) ) {
 			$headers['Content-type'] = 'application/json';
 			$body                    = json_encode( $data );
 		}
 
+		// Request args.
 		$args = array(
 			'method'           => $method,
 			'connect_timeout'  => 10,
@@ -381,6 +387,7 @@ private function get_signed_headers(
 		$content_type = '';
 		$date         = date( 'r', time() );
 
+		// Make sure the content type is JSON.
 		if ( in_array( $method, array( 'POST', 'PUT' ) ) ) {
 			$content_type = 'application/json';
 		}

src/data/class-plugin.php

@@ -6,6 +6,8 @@
  * @license    http://www.gnu.org/licenses/ GNU General Public License
  * @author     Joel James <[email protected]>
  * @since      1.0.0
+ * @package    Freemius
+ * @subpackage Data
  */
 
 namespace DuckDev\Freemius\Data;
@@ -54,6 +56,33 @@ class Plugin {
 	 */
 	private string $public_key = '';
 
+	/**
+	 * Is a premium plugin.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var bool
+	 */
+	private bool $is_premium;
+
+	/**
+	 * Has addons.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var bool
+	 */
+	private bool $has_addons;
+
+	/**
+	 * Plugin data.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @var array
+	 */
+	private array $data = array();
+
 	/**
 	 * Plugin class constructor.
 	 *
@@ -67,6 +96,8 @@ class Plugin {
 	public function __construct( int $id, array $args ) {
 		$this->id         = $id;
 		$this->slug       = $args['slug'] ?? '';
+		$this->is_premium = $args['is_premium'] ?? false;
+		$this->has_addons = $args['has_addons'] ?? false;
 		$this->main_file  = $args['main_file'] ?? '';
 		$this->public_key = $args['public_key'] ?? '';
 	}
@@ -114,4 +145,45 @@ public function get_main_file(): string {
 	public function get_public_key(): string {
 		return $this->public_key;
 	}
+
+	/**
+	 * Check if current plugin is premium.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return bool
+	 */
+	public function is_premium(): bool {
+		return $this->is_premium;
+	}
+
+	/**
+	 * Check if current plugin has addons.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return bool
+	 */
+	public function has_addons(): bool {
+		return $this->has_addons;
+	}
+
+	/**
+	 * Get current plugin data.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @return array
+	 */
+	public function get_data(): array {
+		if ( empty( $this->data ) ) {
+			if ( ! function_exists( '\get_plugin_data' ) ) {
+				require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
+			}
+
+			$this->data = \get_plugin_data( $this->main_file );
+		}
+
+		return $this->data;
+	}
 }

src/freemius.php

@@ -2,6 +2,13 @@
 /**
  * The Freemius SDK for Duck Dev plugins.
  *
+ * This library does not perform any permission checks or nonce
+ * verifications. Plugins should do it before processing any forms.
+ *
+ * References:
+ * - https://github.com/Freemius/wp-sdk-lite
+ * - https://github.com/gambitph/freemius-lite-activation
+ *
  * @link    https://duckdev.com/
  * @license http://www.gnu.org/licenses/ GNU General Public License
  * @author  Joel James <[email protected]>
@@ -59,7 +66,9 @@ class Freemius {
 	 * @param array $args Arguments.
 	 */
 	protected function __construct( int $id, array $args ) {
-		$plugin        = new Plugin( $id, $args );
+		// Create a plugin data instance.
+		$plugin = new Plugin( $id, $args );
+		// Create services.
 		$this->license = new License( $plugin );
 		$this->update  = new Update( $plugin );
 		$this->addon   = new Addon( $plugin );

src/services/class-addon.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * This class handles addons.
+ * This class handles addons data.
  *
  * @license    http://www.gnu.org/licenses/ GNU General Public License
  * @author     Joel James <[email protected]>
@@ -30,9 +30,15 @@ class Addon extends Service {
 	 * @return array
 	 */
 	public function get_addons(): array {
+		// Only if current plugin has addons.
+		if ( $this->plugin->has_addons() ) {
+			return array();
+		}
+
 		// Get from cache first.
 		$addons = $this->get_transient( 'addons' );
-		if ( ! empty( $addons ) ) {
+		// If found is cache, return it.
+		if ( false !== $addons ) {
 			return $addons;
 		}
 
@@ -56,9 +62,14 @@ public function get_addons(): array {
 	 *
 	 * @since 1.0.0
 	 *
-	 * @return array|string|WP_Error
+	 * @return array|WP_Error
 	 */
 	protected function get_remote_addons() {
+		// Avoid multiple requests.
+		if ( $this->is_duplicate_request( 'addons_check' ) ) {
+			return new WP_Error( 'too_many_requests', __( 'Too many requests. Slow down.', 'duckdev-freemius' ) );
+		}
+
 		// Get authenticated API instance using public key.
 		$api = Api::get_auth_instance(
 			$this->plugin->get_id(),
@@ -67,7 +78,7 @@ protected function get_remote_addons() {
 			'plugin'
 		);
 
-		// Addon list from API.
+		// Addon list from the API.
 		$response = $api->get(
 			'addons.json',
 			array(
@@ -76,6 +87,9 @@ protected function get_remote_addons() {
 			)
 		);
 
+		// To prevent multiple requests for 5 mins.
+		$this->set_request_time( 'addons_check' );
+
 		if ( is_wp_error( $response ) ) {
 			return $response;
 		}
@@ -84,7 +98,7 @@ protected function get_remote_addons() {
 	}
 
 	/**
-	 * Get the list of addons from the API.
+	 * Format the addon list to add additional data.
 	 *
 	 * @since 1.0.0
 	 *
@@ -96,6 +110,14 @@ protected function format_addon_data( $addon ): array {
 		// Premium if pricing is visible.
 		$addon['is_premium'] = $addon['is_pricing_visible'] ?? false;
 
-		return $addon;
+		/**
+		 * Filter to modify addon data.
+		 *
+		 * @since 1.0.0
+		 *
+		 * @param array $addon Addon data.
+		 * @param Addon $this  Current class instance.
+		 */
+		return apply_filters( 'duckdev_freemius_format_addon_data', $addon, $this );
 	}
 }