John Swimmer Recommendations

on 10 Aug, 17:36

PoP can finally be installed!

PoP can finally be installed!
Blog

Alright, that took some time in coming, but we can finally announce it: PoP can finally be installed through Composer! Sucess!!!!!

So for first time in its history, PoP can be easily installed, without resorting to hacks: simply execute a script, wait for a few minutes, and voilĂ . Currently, only the PoP API for WordPress is finished, and in a few months we will unlock further functionality: creating the whole site through PoP, and for other CMSs in addition to WordPress. Yay!

Installation instructions

Via Composer and WP-CLI (both are assumed to be installed globally):

  1. Create the WordPress database and user
  2. Configure WordPress through environment variables:

Copy the code below to an editor, replace all values (such as {YOUR_SITE_DB_NAME}) with your own values, and then either paste it on the terminal to execute, or save it in file “~/.bash_profile” and then execute source ~/.bash_profile.

export DB_NAME={YOUR_SITE_DB_NAME} #eg: database
export DB_USER={YOUR_SITE_DB_USER} #eg: admin
export DB_PASSWORD={YOUR_SITE_DB_PASSWORD} #eg: sADF!kl9diq@#Sjfk
export DB_HOST={YOUR_SITE_DB_HOST} #eg: 127.0.0.1
export SITE_URL_WITHOUT_HTTP={YOUR_SITE_URL_WITHOUT_HTTP} #eg: localhost
export SITE_URL_WITH_HTTP={YOUR_SITE_URL_WITH_HTTP} #eg: http://localhost
export SITE_NAME="{YOUR_SITE_NAME}" #eg: "My awesome website"
export ADMIN_USER={ADMIN_USER} #eg: admin
export ADMIN_PASSWORD={ADMIN_PASSWORD} #eg: JKo$@sfjASD00w
export ADMIN_EMAIL={ADMIN_EMAIL} #eg: pedro@example.com

To set the SALT keys there are two alternatives:

I. Set random values through environment variable SHUFFLE_SALT_KEYS:

export SHUFFLE_SALT_KEYS=true

II. Set the corresponding values directly:

# Obtain random values from https://api.wordpress.org/secret-key/1.1/salt
export AUTH_KEY={YOUR_AUTH_KEY}
export SECURE_AUTH_KEY={YOUR_SECURE_AUTH_KEY}
export LOGGED_IN_KEY={YOUR_LOGGED_IN_KEY}
export NONCE_KEY={YOUR_NONCE_KEY}
export AUTH_SALT={YOUR_AUTH_SALT}
export SECURE_AUTH_SALT={YOUR_SECURE_AUTH_SALT}
export LOGGED_IN_SALT={YOUR_LOGGED_IN_SALT}
export NONCE_SALT={YOUR_NONCE_SALT}
  1. Bootstrap a new project from this repo:
composer create-project leoloso/pop-api-wp
  1. Wait for a few minutes ☕️😁
  2. ✅ The site is installed under:
    • 👉WordPress site: {YOUR_SITE_URL_WITH_HTTP}
    • 👉WordPress admin: {YOUR_SITE_URL_WITH_HTTP}/wp/wp-admin/
    • 👉PoP API: {YOUR_SITE_URL_WITH_HTTP}/posts/?action=api&datastructure=rest (REST for posts)

 

Enjoy!

on 2 Aug, 18:09

The PoP API now supports both REST and GraphQL!

The PoP API now supports both REST and GraphQL!
Blog

We are very proud to announce that PoP can now return the response of its API using both the REST and GraphQL formats. This way, a PoP API can be used as a drop-in replacement for both REST and GraphQL, providing the benefits of both these APIs, at the same time! Check out these benefits:

  • No over/under-fetching data (as in GraphQL)
  • Shape of the response mirrors mirrors the query (as in GraphQL)
  • Passing parameters to the query nodes, at any depth, for filtering/pagination/formatting/etc (as in GraphQL)
  • Server-side caching (as in REST)
  • Secure: Not chance of Denial of Service attacks (as in REST)
  • Provide default data when no query is provided (as in REST)

In a nutshell: the PoP API is REST endpoints with GraphQL queries.

Demonstration

The API is accessed through the following endpoints (click on them to see an example):

REST-compatible:

Add parameters action=api&datastructure=rest to the endpoint URL:

GraphQL-compatible:

Add parameters action=api&datastructure=graphql to the endpoint URL, and parameter fields with the data fields to retrieve (using a custom dot notation). Examples:

PoP native:

Add parameters action=api to the endpoint URL, and parameter fields similar to the examples above for GraphQL.

How does it work?

Through a parameter datastructure in the URL we can select if the response must be REST-compatible or GraphQL-compatible. To fetch the data fields, for REST it supports default fields (as in typical REST behaviour), or explicitly querying for the fields, like in GraphQL. For this, the GraphQL query is converted to dot notation and passed in the URL through parameter fields. For instance, the following query:

query {
  id
  title
  url
  content
  comments {
    id
    content
    date
    author {
      id
      name
      url
      posts {
        id
        title
        url
      }
    }
  }
}

Is converted to dot notation like this:

id|title|url|content,comments.id|content|date,comments.author.id|name|url,comments.author.posts.id|title|url

Enjoy!

on 30 Jun, 11:52

Leo’s presentation on the Component-based API from JSConf Asia 2019 is now online!

Leo’s presentation on the Component-based API from JSConf Asia 2019 is now online!
Blog

Leo took part in the latest version of JSConf Asia 2019, with a talk titled “Introduction to the Component-based API” in which he explains many of the concepts powering PoP, including how it features a component-model architecture for the back-end (PHP), and how PoP delivers an API which is a mix of REST and GraphQL, containing benefits from both of them, and which can be progressively enhanced to deliver the application itself.

The talk is now available online:

Enjoy!

 

on 4 Apr, 22:48

PoP now automatically generates the GraphQL-like query to fetch data from an external site

PoP now automatically generates the GraphQL-like query to fetch data from an external site
Blog

When fetching data for a component, PoP allows to point to an external domain. Until now, the external site had to have the same components installed as the origin site, to guarantee that the response would be what was expected by the origin site. Undoubtedly, this was less than ideal.

This is solved now, and very elegantly: whenever a component fetches data from an external site, it automatically generates the URL to query, including all the fields that need be retrieved. Similar to GraphQL, this request will fetch only the required data, and because it is automatically generated by the application, there are no possibilities of manual errors from creating the query, and if any field is updated or a new one introduced or removed, the query is automatically upgraded too. The automatically generated query looks like this (assuming, in this case, that nextapi.getpop.org is the external site).

Through this feature, PoP sites will be able to share data effortlessly. The developer will not even need to code a query to fetch data, but simply arranging all modules inside each other will do. PoP takes care of the rest.

As usual, enjoy!

on 19 Mar, 21:42

We are finally decoupling PoP from WordPress

We are finally decoupling PoP from WordPress
Blog

In our previous blog post we described that we were migrating PoP code into components. While doing so, we are abstracting the whole code away from WordPress, so that it can be powered by other frameworks, such as Laravel. The task involves finding all the references to WordPress code inside the PoP codebase, and move that code behind the implementation of an interface. Because the interface can be implemented for any CMS, we will then be able to install PoP using any framework.

This task is time consuming, so we are working on it, however we hope it will be finished within a couple of weeks, after which we will finally start making components available.

Stay tuned!

on 1 Mar, 00:12

PoP now complies with PSR-1 and PSR-2

PoP now complies with PSR-1 and PSR-2
Blog

PoP is now compliant with PHP Standards Recommendations PSR-1: Basic Coding Standard and PSR-2: Coding Style Guide. This involved a huge refactoring of the whole codebase, renaming all functions from their snake case form (such as get_modules) into their camel case equivalent (getModules). As usual, enjoy!


Sign up to our newsletter:

Welcome to the PoP framework!
Break the information monopoly

the PoP framework is open source software which aims to decentralize the content flow and break the information monopoly from large internet corporations. Read more.