jfig/wp-spaceapi-consumer
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: jfig:f913cb1f6defe5551955f4515a05e907e676226c
Branches Tags
jfig:main jfig:dev
...
compare: jfig:42345c47b9c4f4bfe6b033a818ab662208ab358e
Branches Tags
jfig:main jfig:dev

2 Commits
f913cb1f6d ... 42345c47b9

Author SHA1 Message Date
Joao Figueiredo
42345c47b9 major refactor, numenculature change 
remove mentions to "door" status, to space
 2025-06-02 00:17:55 +01:00
Joao Figueiredo
f0f2814d35 make user agent dynamic with changes to plugin's Text Domainand Version 2025-06-01 19:19:36 +01:00
3 changed files with 50 additions and 44 deletions
Expand all files Collapse all files

6
wp-spaceapi-consumer-config.php
View File

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

12
wp-spaceapi-consumer-style.css
View File

@@ -1,6 +1,6 @@
/* 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; display:inline-flex;
align-items:center; align-items:center;
gap:0.4em; gap:0.4em;
@@ -15,20 +15,20 @@
} }
/* Open = soft green background + dark green text */ /* Open = soft green background + dark green text */
.door-status-indicator.open { .space-status-indicator.open {
background:#e7f9ec; background:#e7f9ec;
color:#1e7a34; color:#1e7a34;
} }
/* Closed = soft red background + dark red text */ /* Closed = soft red background + dark red text */
.door-status-indicator.closed { .space-status-indicator.closed {
background:#fdeeee; background:#fdeeee;
color:#c03c3c; color:#c03c3c;
} }
/* (Optional) slight hover effect */ /* (Optional) slight hover effect */
.door-status-indicator:hover, .space-status-indicator:hover,
.door-status-indicator:focus { .space-status-indicator:focus {
filter:brightness(1.05); filter:brightness(1.05);
outline:none; outline:none;
} }

76
wp-spaceapi-consumer.php
View File

@@ -3,8 +3,8 @@
* Plugin Name: WordPress SpaceAPI Consumer * Plugin Name: WordPress SpaceAPI Consumer
* Plugin Slug: wp-spaceapi-consumer * Plugin Slug: wp-spaceapi-consumer
* Plugin URI: https://gitea.alluna.pt/jfig/wp-spaceapi-consumer * Plugin URI: https://gitea.alluna.pt/jfig/wp-spaceapi-consumer
* Description: Small WordPress plugin to consume an SpaceAPI endpoint and indicate on the WordPress website if the Space is Open or Closed * Description: WordPress plugin to consume a SpaceAPI endpoint and indicate if the Space is Open or Closed
* Version: 1.1.1 * Version: 0.3.0
* Author: Joao Figueiredo, LCD Porto Team, ChatGPT o3 * Author: Joao Figueiredo, LCD Porto Team, ChatGPT o3
* Author URI: https://lcdporto.org * Author URI: https://lcdporto.org
* License: MIT * License: MIT
@@ -20,7 +20,7 @@ if ( ! defined( 'ABSPATH' ) ) {
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| Configuration | Configuration
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
| Constants are expected in door-status-config.php located in the same | 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 | directory. If that file is missing, sane defaults are used so the plugin
| still works out‑of‑the‑box. | still works out‑of‑the‑box.
*/ */
@@ -31,9 +31,9 @@ if ( file_exists( $config_file ) ) {
} }
// Fallback defaults (only if not already defined by the config file). // Fallback defaults (only if not already defined by the config file).
! defined( 'DSI_API_URL' ) && define( 'DSI_API_URL', 'https://lcdporto.org/api/spaceapi' ); ! defined( 'SSI_API_URL' ) && define( 'SSI_API_URL', 'https://lcdporto.org/api/spaceapi' );
! defined( 'DSI_CACHE_KEY' ) && define( 'DSI_CACHE_KEY', 'dsi_space_api_status' ); ! defined( 'SSI_CACHE_KEY' ) && define( 'SSI_CACHE_KEY', 'ssi_space_api_status' );
! defined( 'DSI_CACHE_TTL' ) && define( 'DSI_CACHE_TTL', 10 ); // seconds ! defined( 'SSI_CACHE_TTL' ) && define( 'SSI_CACHE_TTL', 10 ); // seconds
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
@@ -42,28 +42,33 @@ if ( file_exists( $config_file ) ) {
*/ */
/** /**
* Retrieves door‑open status (boolean) with transient caching. * Retrieves space open status (boolean) with transient caching.
* *
* Supported JSON payloads (any case): * Supported JSON payloads (any case):
* – true / false (bare boolean) * – true / false (bare boolean)
* – {"open": true} * – {"state": {"open": true}} (SpaceAPI standard)
* – {"doorOpen": true}
* *
* @return bool True if open, false if closed (or on error). * @return bool True if open, false if closed (or on error).
*/ */
function dsi_get_status() : bool { function ssi_get_status() : bool {
$cached = get_transient( DSI_CACHE_KEY ); $cached = get_transient( SSI_CACHE_KEY );
if ( false !== $cached ) { if ( false !== $cached ) {
return (bool) $cached; return (bool) $cached;
} }
$response = wp_remote_get( DSI_API_URL, [ // 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, 'timeout' => 3,
'user-agent' => 'DoorStatusIndicator/1.1.1 (+https://wordpress.org/)', 'user-agent' => $plugin_data['TextDomain'] . '/' . $plugin_data['Version'] . ' (+https://wordpress.org/)',
] ); ] );
if ( is_wp_error( $response ) ) { if ( is_wp_error( $response ) ) {
set_transient( DSI_CACHE_KEY, false, DSI_CACHE_TTL ); set_transient( SSI_CACHE_KEY, false, SSI_CACHE_TTL );
return false; return false;
} }
@@ -74,14 +79,13 @@ function dsi_get_status() : bool {
if ( is_bool( $decoded ) ) { if ( is_bool( $decoded ) ) {
$status = $decoded; $status = $decoded;
} elseif ( is_array( $decoded ) ) { } elseif ( is_array( $decoded ) ) {
if ( isset( $decoded['open'] ) ) { // SpaceAPI standard format - state.open
$status = (bool) $decoded['open']; if ( isset( $decoded['state']['open'] ) ) {
} elseif ( isset( $decoded['doorOpen'] ) ) { $status = (bool) $decoded['state']['open'];
$status = (bool) $decoded['doorOpen'];
} }
} }
set_transient( DSI_CACHE_KEY, $status, DSI_CACHE_TTL ); set_transient( SSI_CACHE_KEY, $status, SSI_CACHE_TTL );
return $status; return $status;
} }
@@ -91,17 +95,19 @@ function dsi_get_status() : bool {
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
*/ */
function dsi_shortcode() : string { function ssi_shortcode() : string {
$open = dsi_get_status(); $open = ssi_get_status();
$emoji = $open ? '<div class="door-status-indicator open">🟢 Open</div>' : '<div class="door-status-indicator closed">🔴 Closed</div>'; $emoji = $open ? '<div class="space-status-indicator open">🟢 Open</div>' : '<div class="space-status-indicator closed">🔴 Closed</div>';
return sprintf( return sprintf(
'<span class="door-status-indicator" aria-label="Door is %s">%s</span>', '<span class="space-status-indicator" aria-label="Space is %s">%s</span>',
$open ? 'open' : 'closed', $open ? 'open' : 'closed',
$emoji $emoji
); );
} }
add_shortcode( 'door_status', 'dsi_shortcode' ); add_shortcode( 'space_status', 'ssi_shortcode' );
// Keep the old shortcode for backward compatibility
add_shortcode( 'door_status', 'ssi_shortcode' );
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
@@ -109,23 +115,23 @@ add_shortcode( 'door_status', 'dsi_shortcode' );
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
*/ */
function dsi_admin_bar( WP_Admin_Bar $bar ) : void { function ssi_admin_bar( WP_Admin_Bar $bar ) : void {
if ( ! current_user_can( 'read' ) ) { if ( ! current_user_can( 'read' ) ) {
return; // Logged‑in users only. return; // Logged‑in users only.
} }
$open = dsi_get_status(); $open = ssi_get_status();
$emoji = $open ? '🟢' : '🔴'; $emoji = $open ? '🟢' : '🔴';
$text = $open ? __( 'Door Open', 'door-status-indicator' ) : __( 'Door Closed', 'door-status-indicator' ); $text = $open ? __( 'Space Open', 'wp-spaceapi-consumer' ) : __( 'Space Closed', 'wp-spaceapi-consumer' );
$bar->add_node( [ $bar->add_node( [
'id' => 'door-status-indicator', 'id' => 'space-status-indicator',
'title' => "$emoji $text", 'title' => "$emoji $text",
'href' => '#', 'href' => '#',
'meta' => [ 'title' => $text ], 'meta' => [ 'title' => $text ],
] ); ] );
} }
add_action( 'admin_bar_menu', 'dsi_admin_bar', 1000 ); add_action( 'admin_bar_menu', 'ssi_admin_bar', 1000 );
/* /*
|-------------------------------------------------------------------------- |--------------------------------------------------------------------------
@@ -136,17 +142,17 @@ add_action( 'admin_bar_menu', 'dsi_admin_bar', 1000 );
/** /**
* Front-end + admin-bar styles for the indicator. * Front-end + admin-bar styles for the indicator.
*/ */
function dsi_enqueue_assets() : void { function ssi_enqueue_assets() : void {
// register & enqueue the standalone CSS file // register & enqueue the standalone CSS file
wp_enqueue_style( wp_enqueue_style(
'door-status-indicator', 'space-status-indicator',
plugins_url( 'wp-spaceapi-consumer-style.css', __FILE__ ), plugins_url( 'wp-spaceapi-consumer-style.css', __FILE__ ),
[], // no dependencies [], // no dependencies
'1.0.0' // file version '1.0.0' // file version
); );
} }
add_action( 'wp_enqueue_scripts', 'dsi_enqueue_assets' ); add_action( 'wp_enqueue_scripts', 'ssi_enqueue_assets' );
add_action( 'admin_enqueue_scripts', 'dsi_enqueue_assets' ); // so the Admin Bar icon also gets styled add_action( 'admin_enqueue_scripts', 'ssi_enqueue_assets' ); // so the Admin Bar icon also gets styled
/* /*
@@ -156,8 +162,8 @@ add_action( 'admin_enqueue_scripts', 'dsi_enqueue_assets' ); // so the Admin Bar
*/ */
if ( defined( 'WP_CLI' ) && WP_CLI ) { if ( defined( 'WP_CLI' ) && WP_CLI ) {
WP_CLI::add_command( 'door-status', function() { WP_CLI::add_command( 'space-status', function() {
WP_CLI::success( dsi_get_status() ? 'Door is open 🟢' : 'Door is closed 🔴' ); WP_CLI::success( ssi_get_status() ? 'Space is open 🟢' : 'Space is closed 🔴' );
} ); } );
} }