Merge pull request 'dev' (#3) from dev into main

Reviewed-on: #3

.gitignore

@@ -47,3 +47,9 @@ wp-config.php
 # Note: If you wish to whitelist themes,
 # uncomment the next line
 #/wp-content/themes
+
+# ---> Node.js
+/node_modules/
+/package-lock.json
+
+

README.md

@@ -1,3 +1,24 @@
-# wp-api-consumer
+# WordPress SpaceAPI Consumer
 
-Small WprdPress plugin to consume an API 
+# wp-spaceapi-consumer
+
+Small WordPress plugin to consume an SpaceAPI endpoint and indicate on the WordPress website if the Space is Open or Closed
+
+## Usage 
+
+### WordPress Editor Block (Gutenberg)
+
+You can use the `Space Status` block in the WordPress editor to display the status of the SpaceAPI endpoint.
+
+### Shortcode
+
+You can use the shortcode `[space_status]` to display the status of the SpaceAPI endpoint on your WordPress site.
+
+### Widget
+
+You can also use the widget `SpaceAPI Status` to display the status of the SpaceAPI endpoint in your WordPress sidebar or footer.
+
+## Changes
+
+### 0.4.x
+- Added WordPress Editor Block (Gutenberg) support

blocks-register.php

@@ -0,0 +1,21 @@
+<?php
+// Exit if accessed directly.
+if ( ! defined( 'ABSPATH' ) ) {
+	return;
+}
+
+function ssi_register_space_status_block() : void {
+	$asset_path = plugin_dir_path( __FILE__ ) . 'build/space-status';
+	register_block_type( $asset_path, [
+		'render_callback' => 'ssi_render_block',
+	] );
+}
+add_action( 'init', 'ssi_register_space_status_block' );
+
+/**
+ * Server‑side markup for the block.
+ */
+function ssi_render_block( array $attributes, string $content ) : string {
+	// Re‑use existing helper & CSS class logic.
+	return ssi_shortcode();
+}

build/space-status/block.json

@@ -0,0 +1,15 @@
+{
+  "apiVersion": 3,
+  "name": "wp-spaceapi-consumer/space-status",
+  "title": "Space Status",
+  "description": "Show whether the space is open or closed (SpaceAPI consumer).",
+  "category": "widgets",
+  "icon": "building",
+  "textdomain": "wp-spaceapi-consumer",
+  "style": "file:./style.css",
+  "editorStyle": "file:./editor.css",
+  "editorScript": "file:./index.js",
+  "supports": {
+    "html": false
+  }
+}

build/space-status/index.asset.php

@@ -0,0 +1 @@
+<?php return array('dependencies' => array('react-jsx-runtime', 'wp-blocks', 'wp-i18n', 'wp-server-side-render'), 'version' => 'e81eff0b8644d0be4dac');

build/space-status/index.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e={n:r=>{var s=r&&r.__esModule?()=>r.default:()=>r;return e.d(s,{a:s}),s},d:(r,s)=>{for(var t in s)e.o(s,t)&&!e.o(r,t)&&Object.defineProperty(r,t,{enumerable:!0,get:s[t]})},o:(e,r)=>Object.prototype.hasOwnProperty.call(e,r)};window.wp.i18n;const r=window.wp.blocks,s=window.wp.serverSideRender;var t=e.n(s);const o=window.ReactJSXRuntime;(0,r.registerBlockType)("wp-spaceapi-consumer/space-status",{edit:()=>(0,o.jsx)(t(),{block:"wp-spaceapi-consumer/space-status"}),save:()=>null})})();

door-status-config.php

@@ -1,5 +0,0 @@
-<?php
-
-define( 'DSI_API_URL',   'https://nodered.jfig.net/api/v1/door-open' );
-define( 'DSI_CACHE_KEY', 'dsi_door_open_status' );
-define( 'DSI_CACHE_TTL', 10 );

package.json

@@ -0,0 +1,15 @@
+{
+  "name": "wp-spaceapi-consumer",
+  "version": "0.0.0-private",
+  "private": true,
+  "scripts": {
+    "build": "wp-scripts build",
+    "start": "wp-scripts start"
+  },
+  "devDependencies": {
+    "@wordpress/scripts": "^30.18.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

src/space-status/block.json

@@ -0,0 +1,13 @@
+{
+  "apiVersion": 3,
+  "name": "wp-spaceapi-consumer/space-status",
+  "title": "Space Status",
+  "description": "Show whether the space is open or closed (SpaceAPI consumer).",
+  "category": "widgets",
+  "icon": "building",
+  "textdomain": "wp-spaceapi-consumer",
+  "style": "file:./style.css",
+  "editorStyle": "file:./editor.css",
+  "editorScript": "file:./index.js",
+  "supports": { "html": false }
+}

src/space-status/editor.css

@@ -0,0 +1,7 @@
+/* Editor-only: make the pill obvious & easy to select */
+.wp-block-wp-spaceapi-consumer-space-status {
+    display: inline-block;
+    padding: 4px 8px;
+    border: 1px dashed var(--wp-admin-theme-color, #007cba);
+    border-radius: 9999px;
+}

src/space-status/index.js

@@ -0,0 +1,12 @@
+import { __ } from '@wordpress/i18n';
+import { registerBlockType } from '@wordpress/blocks';
+import ServerSideRender from '@wordpress/server-side-render';
+
+registerBlockType( 'wp-spaceapi-consumer/space-status', {
+	edit: () => (
+		<ServerSideRender
+			block="wp-spaceapi-consumer/space-status"
+		/>
+	),
+	save: () => null, // dynamic block — markup comes from PHP
+} );

src/space-status/style.css

@@ -0,0 +1 @@
+@import url('../../wp-spaceapi-consumer-style.css');

wp-api-consumer.php

@@ -1,163 +0,0 @@
-<?php
-/**
- * Plugin Name: Door Status Indicator
- * Plugin URI:  https://example.com/
- * Description: Lightweight, dependency‑free plugin that polls a JSON endpoint (default: https://nodered.jfig.net/api/v1/door-open), caches the value for a few seconds, and shows a real‑time door open/closed indicator (🟢/🔴) via the [door_status] shortcode and the Admin Bar.
- * Version:     1.1.1
- * Author:      J (ChatGPT helper)
- * Author URI:  https://example.com/
- * License:     GPL v2 or later
- * License URI: https://www.gnu.org/licenses/gpl-2.0.html
- * Text Domain: door-status-indicator
- */
-
-if ( ! defined( 'ABSPATH' ) ) {
-    exit; // Exit if accessed directly.
-}
-
-/*
-|--------------------------------------------------------------------------
-| Configuration
-|--------------------------------------------------------------------------
-| Constants are expected in door-status-config.php located in the same
-| directory. If that file is missing, sane defaults are used so the plugin
-| still works out‑of‑the‑box.
-*/
-
-$config_file = plugin_dir_path( __FILE__ ) . 'door-status-config.php';
-if ( file_exists( $config_file ) ) {
-    require_once $config_file;
-}
-
-// Fallback defaults (only if not already defined by the config file).
-! defined( 'DSI_API_URL' )   && define( 'DSI_API_URL',   'https://nodered.jfig.net/api/v1/door-open' );
-! defined( 'DSI_CACHE_KEY' ) && define( 'DSI_CACHE_KEY', 'dsi_door_open_status' );
-! defined( 'DSI_CACHE_TTL' ) && define( 'DSI_CACHE_TTL', 10 ); // seconds
-
-/*
-|--------------------------------------------------------------------------
-| Core – fetch & cache
-|--------------------------------------------------------------------------
-*/
-
-/**
- * Retrieves door‑open status (boolean) with transient caching.
- *
- * Supported JSON payloads (any case):
- *   – true / false (bare boolean)
- *   – {"open": true}
- *   – {"doorOpen": true}
- *
- * @return bool True if open, false if closed (or on error).
- */
-function dsi_get_status() : bool {
-    $cached = get_transient( DSI_CACHE_KEY );
-    if ( false !== $cached ) {
-        return (bool) $cached;
-    }
-
-    $response = wp_remote_get( DSI_API_URL, [
-        'timeout'    => 3,
-        'user-agent' => 'DoorStatusIndicator/1.1.1 (+https://wordpress.org/)',
-    ] );
-
-    if ( is_wp_error( $response ) ) {
-        set_transient( DSI_CACHE_KEY, false, DSI_CACHE_TTL );
-        return false;
-    }
-
-    $body    = wp_remote_retrieve_body( $response );
-    $decoded = json_decode( $body, true );
-    $status  = false; // default to closed
-
-    if ( is_bool( $decoded ) ) {
-        $status = $decoded;
-    } elseif ( is_array( $decoded ) ) {
-        if ( isset( $decoded['open'] ) ) {
-            $status = (bool) $decoded['open'];
-        } elseif ( isset( $decoded['doorOpen'] ) ) {
-            $status = (bool) $decoded['doorOpen'];
-        }
-    }
-
-    set_transient( DSI_CACHE_KEY, $status, DSI_CACHE_TTL );
-    return $status;
-}
-
-/*
-|--------------------------------------------------------------------------
-| Shortcode [door_status]
-|--------------------------------------------------------------------------
-*/
-
-function dsi_shortcode() : string {
-    $open  = dsi_get_status();
-    $emoji = $open ? '<div class="door-status-indicator open">🟢 Open</div>' : '<div class="door-status-indicator closed">🔴 Closed</div>';
-
-    return sprintf(
-        '<span class="door-status-indicator" aria-label="Door is %s">%s</span>',
-        $open ? 'open' : 'closed',
-        $emoji
-    );
-}
-add_shortcode( 'door_status', 'dsi_shortcode' );
-
-/*
-|--------------------------------------------------------------------------
-| Admin Bar indicator
-|--------------------------------------------------------------------------
-*/
-
-function dsi_admin_bar( WP_Admin_Bar $bar ) : void {
-    if ( ! current_user_can( 'read' ) ) {
-        return; // Logged‑in users only.
-    }
-
-    $open  = dsi_get_status();
-    $emoji = $open ? '🟢' : '🔴';
-    $text  = $open ? __( 'Door Open', 'door-status-indicator' ) : __( 'Door Closed', 'door-status-indicator' );
-
-    $bar->add_node( [
-        'id'    => 'door-status-indicator',
-        'title' => "$emoji $text",
-        'href'  => '#',
-        'meta'  => [ 'title' => $text ],
-    ] );
-}
-add_action( 'admin_bar_menu', 'dsi_admin_bar', 1000 );
-
-/*
-|--------------------------------------------------------------------------
-| Front‑end inline CSS (kept minimal)
-|--------------------------------------------------------------------------
-*/
-
-/**
- * Front-end + admin-bar styles for the indicator.
- */
-function dsi_enqueue_assets() : void {
-    // register & enqueue the standalone CSS file
-    wp_enqueue_style(
-        'door-status-indicator',
-        plugins_url( 'door-status.css', __FILE__ ),
-        [],          // no dependencies
-        '1.0.0'      // file version
-    );
-}
-add_action( 'wp_enqueue_scripts', 'dsi_enqueue_assets' );
-add_action( 'admin_enqueue_scripts', 'dsi_enqueue_assets' ); // so the Admin Bar icon also gets styled
-
-
-/*
-|--------------------------------------------------------------------------
-| WP‑CLI command (optional)
-|--------------------------------------------------------------------------
-*/
-
-if ( defined( 'WP_CLI' ) && WP_CLI ) {
-    WP_CLI::add_command( 'door-status', function() {
-        WP_CLI::success( dsi_get_status() ? 'Door is open 🟢' : 'Door is closed 🔴' );
-    } );
-}
-
-// End of file

wp-spaceapi-consumer-config.php

@@ -0,0 +1,5 @@
+<?php
+
+define( 'SSI_API_URL',   'https://lcdporto.org/api/spaceapi' );
+define( 'SSI_CACHE_KEY', 'ssi_space_api_status' );
+define( 'SSI_CACHE_TTL', 10 );

wp-spaceapi-consumer-style.css

@@ -1,11 +1,11 @@
-/* door-status.css – styles the indicator as a pill‑shaped button */
+/* space-status.css - styles the indicator as a pill-shaped button */
 
-.door-status-indicator {
+.space-status-indicator {
   display:inline-flex;
   align-items:center;
   gap:0.4em;
   padding:0.25em 0.75em;
-  border-radius:1em;      /* fully‑rounded corners */
+  border-radius:1em;      /* fully-rounded corners */
   font-size:0.95em;
   font-weight:600;
   line-height:1;
@@ -15,20 +15,20 @@
 }
 
 /* Open  = soft green background + dark green text */
-.door-status-indicator.open {
+.space-status-indicator.open {
   background:#e7f9ec;
   color:#1e7a34;
 }
 
 /* Closed = soft red background + dark red text */
-.door-status-indicator.closed {
+.space-status-indicator.closed {
   background:#fdeeee;
   color:#c03c3c;
 }
 
 /* (Optional) slight hover effect */
-.door-status-indicator:hover,
-.door-status-indicator:focus {
+.space-status-indicator:hover,
+.space-status-indicator:focus {
   filter:brightness(1.05);
   outline:none;
 }

wp-spaceapi-consumer.php

@@ -0,0 +1,176 @@
+<?php
+/**
+ * Plugin Name: WordPress SpaceAPI Consumer
+ * Plugin Slug: wp-spaceapi-consumer
+ * Plugin URI:  https://gitea.alluna.pt/jfig/wp-spaceapi-consumer
+ * Description: WordPress plugin to consume a SpaceAPI endpoint and indicate if the Space is Open or Closed
+ * Version:     0.4.2
+ * Author:      Joao Figueiredo, LCD Porto Team, ChatGPT o3
+ * Author URI:  https://lcdporto.org
+ * License:     MIT
+ * License URI: https://gitea.alluna.pt/jfig/wp-spaceapi-consumer/src/branch/dev/LICENSE
+ * Text Domain: wp-spaceapi-consumer
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+    exit; // Exit if accessed directly.
+}
+
+/*
+|--------------------------------------------------------------------------
+| Configuration
+|--------------------------------------------------------------------------
+| Constants are expected in wp-spaceapi-consumer-config.php located in the same
+| directory. If that file is missing, sane defaults are used so the plugin
+| still works out-of-the-box.
+*/
+
+$config_file = plugin_dir_path( __FILE__ ) . 'wp-spaceapi-consumer-config.php';
+if ( file_exists( $config_file ) ) {
+    require_once $config_file;
+}
+
+// Fallback defaults (only if not already defined by the config file).
+! defined( 'SSI_API_URL' )   && define( 'SSI_API_URL',   'https://lcdporto.org/api/spaceapi' );
+! defined( 'SSI_CACHE_KEY' ) && define( 'SSI_CACHE_KEY', 'ssi_space_api_status' );
+! defined( 'SSI_CACHE_TTL' ) && define( 'SSI_CACHE_TTL', 10 ); // seconds
+
+/*
+|--------------------------------------------------------------------------
+| Core - fetch & cache
+|--------------------------------------------------------------------------
+*/
+
+/**
+ * Retrieves space open status (boolean) with transient caching.
+ *
+ * Supported JSON payloads (any case):
+ *   - true / false (bare boolean)
+ *   - {"state": {"open": true}} (SpaceAPI standard)
+ *
+ * @return bool True if open, false if closed (or on error).
+ */
+function ssi_get_status() : bool {
+    $cached = get_transient( SSI_CACHE_KEY );
+    if ( false !== $cached ) {
+        return (bool) $cached;
+    }
+
+    // Get plugin data for dynamic user agent
+    $plugin_data = get_file_data( __FILE__, array(
+        'Version'     => 'Version',
+        'TextDomain'  => 'Text Domain'
+    ), 'plugin' );
+    
+    $response = wp_remote_get( SSI_API_URL, [
+        'timeout'    => 3,
+        'user-agent' => $plugin_data['TextDomain'] . '/' . $plugin_data['Version'] . ' (+https://wordpress.org/)',
+    ] );
+
+    if ( is_wp_error( $response ) ) {
+        set_transient( SSI_CACHE_KEY, false, SSI_CACHE_TTL );
+        return false;
+    }
+
+    $body    = wp_remote_retrieve_body( $response );
+    $decoded = json_decode( $body, true );
+    $status  = false; // default to closed
+
+    if ( is_bool( $decoded ) ) {
+        $status = $decoded;
+    } elseif ( is_array( $decoded ) ) {
+        // SpaceAPI standard format - state.open
+        if ( isset( $decoded['state']['open'] ) ) {
+            $status = (bool) $decoded['state']['open'];
+        }
+    }
+
+    set_transient( SSI_CACHE_KEY, $status, SSI_CACHE_TTL );
+    return $status;
+}
+
+/*
+|--------------------------------------------------------------------------
+| Shortcode [door_status]
+|--------------------------------------------------------------------------
+*/
+
+function ssi_shortcode() : string {
+    $open  = ssi_get_status();
+    $emoji = $open ? '<div class="space-status-indicator open">🟢 Open</div>' : '<div class="space-status-indicator closed">🔴 Closed</div>';
+
+    return sprintf(
+        '<span class="space-status-indicator" aria-label="Space is %s">%s</span>',
+        $open ? 'open' : 'closed',
+        $emoji
+    );
+}
+add_shortcode( 'space_status', 'ssi_shortcode' );
+// Keep the old shortcode for backward compatibility
+add_shortcode( 'door_status', 'ssi_shortcode' );
+
+/*
+|--------------------------------------------------------------------------
+| Admin Bar indicator
+|--------------------------------------------------------------------------
+*/
+
+function ssi_admin_bar( WP_Admin_Bar $bar ) : void {
+    if ( ! current_user_can( 'read' ) ) {
+        return; // Logged-in users only.
+    }
+
+    $open  = ssi_get_status();
+    $emoji = $open ? '🟢' : '🔴';
+    $text  = $open ? __( 'Space Open', 'wp-spaceapi-consumer' ) : __( 'Space Closed', 'wp-spaceapi-consumer' );
+
+    $bar->add_node( [
+        'id'    => 'space-status-indicator',
+        'title' => "$emoji $text",
+        'href'  => '#',
+        'meta'  => [ 'title' => $text ],
+    ] );
+}
+add_action( 'admin_bar_menu', 'ssi_admin_bar', 1000 );
+
+/*
+|--------------------------------------------------------------------------
+| Front-end inline CSS (kept minimal)
+|--------------------------------------------------------------------------
+*/
+
+/**
+ * Front-end + admin-bar styles for the indicator.
+ */
+function ssi_enqueue_assets() : void {
+    // register & enqueue the standalone CSS file
+    wp_enqueue_style(
+        'space-status-indicator',
+        plugins_url( 'wp-spaceapi-consumer-style.css', __FILE__ ),
+        [],          // no dependencies
+        '1.0.0'      // file version
+    );
+}
+add_action( 'wp_enqueue_scripts', 'ssi_enqueue_assets' );
+add_action( 'admin_enqueue_scripts', 'ssi_enqueue_assets' ); // so the Admin Bar icon also gets styled
+
+
+/*
+|--------------------------------------------------------------------------
+| WP-CLI command (optional)
+|--------------------------------------------------------------------------
+*/
+
+if ( defined( 'WP_CLI' ) && WP_CLI ) {
+    WP_CLI::add_command( 'space-status', function() {
+        WP_CLI::success( ssi_get_status() ? 'Space is open 🟢' : 'Space is closed 🔴' );
+    } );
+}
+
+// Gutenberg block support (dynamic Space Status block)
+if ( function_exists( 'register_block_type' ) ) {
+    require_once plugin_dir_path( __FILE__ ) . 'blocks-register.php';
+}
+
+
+// End of file