softdiscover/sfdc-custom-jsoninfo

get json from http request and show it on a table

dev-master 2020-07-09 15:34 UTC

Requires

• php: >=7.3
• symfony/cache: ^5.1

Requires (Dev)

• brain/monkey: ^2.3
• inpsyde/php-coding-standards: ^0.13.4
• mockery/mockery: ^1.2
• phpunit/phpunit: ^8.4
• squizlabs/php_codesniffer: ^3

GNU

• Raimundo yabar

README

DESCRIPTION

Wordpress Plugin that makes available a custom endpoint /sfdc_show_users. When visitor navigates to that endpoint /sfdc_show_users, a list of users are shown in a table. When visitor clicks on any user info inside the table, a modal window is triggered showing user details inside.

All user information are taken from a REST API https://jsonplaceholder.typicode.com/users

Getting started

• List of Requirements
• Installation
  • Clone repository
  • Install all dependencies
• Usage
• Key features
  • Custom endpoint
  • A table with users' details is visible
  • Unit tests
  • PHPCS checks
  • Cache

List of Requirements

• PHP >=7.3 with CURL enabled
• Wordpress >= 5.4.2
• Composer - it adds a Symfony Cache Component which is used to make cache of HTTP requests which are made to REST API endpoint

Installation

1. Clone repository

Within your WordPress installation, navigate to wp-content/plugins and run the following commands:

git clone https://github.com/Softdiscover/sfdc-custom-jsoninfo.git
cd sfdc-custom-jsoninfo

2. Install all the necessary dependencies

Navigate to the root of the plugin and then run the following command:

composer install  

and activate the plugin from Admin panel.

Usage

Once the plugin is activated, navigate to the endpoint /sfdc_show_users and a table with list of users will be loaded. then When visitor clicks on any user detail inside the table, a modal window is triggered showing user details inside.

Key features

1. Custom endpoint

the Custom endpoint is available at /sfdc_show_users

2. A table with users' details is visible

once the page is loaded, An HTTP request is made via AJAX to API https://jsonplaceholder.typicode.com/users and if there is information, the table is filled with users data.

when visitor click on any user name/username/id in the table, a new HTTP request is made via AJAX to API (e.g. https://jsonplaceholder.typicode.com/users/4). then the user information is printed in the modal window.

3. Unit tests

Unit tests run without loading Wordpress nor the external API. For run all tests, just run the following command:

composer test

4. PHPCS checks

Code is compliant with InpSyde code style. it can be checked running the following command:

composer sniff

5. Cache

I use Symfony Cache component to set up caching on the server side. each HTTP request generates an unique URL then it is stored in the cache pool of Cache Component. so when the visitor navigate again over a user detail, the information is pulled from the Cache. The cache expiration is set to 60 minutes.