froodley/amazon-alexa-php

Amazon Alexa interface for PHP - XSS Filtering, Improved Testability

Thursday, October 19, 2017
by froodley
Repository
2 Watchers
5 Stars
772 Installations

PHP
0 Dependents
0 Suggesters
67 Forks
0 Open issues
58 Versions
20 % Grown

The README.md

Amazon Alexa PHP Library

This library provides provides a convenient interface for developing Amazon Alexa Skills for your PHP app., _(*1)

It represents a breaking change (and is forked) from jakobsuchy/amazon-alexa-php, _(*2)

The most important changes are the addition of XSS purification and some basic Doctrine validation, and making everything stateless, SRP and more testable, _(*3)

Usage

Install via composer: composer require froodley/amazon-alexa-php, _(*4)

Requests

When Amazon Alexa triggers your skill, a HTTP request will be sent to the URL you specified for your app., _(*5)

You can get the JSON body of the request like so:, _(*6)

$applicationId = "your-application-id-from-alexa"; // See developer.amazon.com and your Application. Will start with "amzn1.echo-sdk-ams.app."
$rawRequest = $request->getContent(); // This is how you would retrieve this with Laravel or Symfony 2.
$alexaRequestFactory = new \Alexa\Request\RequestFactory();
$alexaRequest = $alexaRequestFactory->fromRawData($rawRequest, [$applicationId]);

The library expect raw request data, not parsed JSON as it needs to validate the request signature., _(*7)

You can determine the type of the request with instanceof, e.g.:, _(*8)

if ($alexaRequest instanceof IntentRequest) {
    // Handle intent here
}

Certificate validation

By default the system validates the request signature by fetching Amazon's signing certificate and decrypting the signature. You need CURL to be able to get the certificate. No caching is done but you can override the Certificate class easily if you want to implement certificate caching yourself based on what your app provides:, _(*9)

Here is a basic example:, _(*10)

class MyAppCertificate extends \Alexa\Request\Certificate {
  public function getCertificate() {
    $cached_certificate = retrieve_cert_from_myapp_cache();
    if (empty($cached_certificate)) {
      // Certificate is not cached, download it
      $cached_ertificate = $this->fetchCertificate();
      // Cache it now
    }
    return $cached_certificate;
  }
}

And then in your app, use the setCertificateDependency function:, _(*11)

$certificate = new MyAppCertificate($_SERVER['HTTP_SIGNATURECERTCHAINURL'], $_SERVER['HTTP_SIGNATURE']);

$alexa = new \Alexa\Request\Request($rawRequest);
$alexa->setCertificateDependency($certificate);

$alexaRequest = $alexa->fromData();

Application Id validation

The library will automatically validate your Application Id matches the one of the incoming request - you don't need to do anything for that. If and only if you wish to change how the validation happens, you might use a similar scenario to the certificate validation - provide your own Application class extending the \Alexa\Request\Application and providing a validateApplicationId() function as part of that. Pass your application to the Request library in a same way as the certificate:, _(*12)


$application = new MyAppApplication($myappId);
$alexa = new \Alexa\Request\Request($rawRequest, $myappId);
$alexa->setApplicationDependency($application);

$alexaRequest = $alexa->fromData();

Response

You can build an Alexa response with the Response class. You can optionally set a card or a reprompt too., _(*13)

Here's a few examples., _(*14)

$response = new \Alexa\Response\Response;
$response->respond('Cooool. I\'ll lower the temperature a bit for you!')
    ->withCard('Temperature decreased by 2 degrees');

$response = new \Alexa\Response\Response;
$response->respond('What is your favorite color?')
    ->reprompt('Please tell me your favorite color');

To output the response, simply use the ->render() function, e.g. in Laravel you would create the response like so:, _(*15)

return response()->json($response->render());

In vanilla PHP:, _(*16)

header('Content-Type: application/json');
echo json_encode($response->render());
exit;

The Versions

19/10 2017

dev-master

9999999-dev

Amazon Alexa interface for PHP - XSS Filtering, Improved Testability

library amazon-alexa-php

Amazon Alexa interface for PHP - XSS Filtering, Improved Testability

froodley/amazon-alexa-php

The README.md

Amazon Alexa PHP Library

Usage

Requests

Certificate validation

Application Id validation

Response

The Versions

dev-master

The Requires

The Development Requires

by Mathias Hansen

by froodley

by Emanuele Corradini

by Jakub Suchy

0.5.2.5

The Requires

The Development Requires

by Mathias Hansen

by froodley

by Emanuele Corradini

by Jakub Suchy

0.5.2.4

The Requires

The Development Requires

by Mathias Hansen

by froodley

by Emanuele Corradini

by Jakub Suchy

0.5.2.3

The Requires

The Development Requires

by Mathias Hansen

by froodley

by Emanuele Corradini

by Jakub Suchy

0.5.2.2

The Requires

The Development Requires

by Mathias Hansen

by froodley

by Emanuele Corradini

by Jakub Suchy

0.5.2.1

The Requires

The Development Requires

by Mathias Hansen

by froodley

by Emanuele Corradini

by Jakub Suchy

0.5.2.0

The Requires

The Development Requires

by Mathias Hansen

by froodley

by Emanuele Corradini

by Jakub Suchy

0.5.1.0

The Requires

The Development Requires

by Mathias Hansen

by froodley

by Emanuele Corradini

by Jakub Suchy

0.5.0.12

The Requires

The Development Requires

by Mathias Hansen

by froodley

by Emanuele Corradini

by Jakub Suchy

0.5.0.10

The Requires

The Development Requires

by Mathias Hansen

by froodley

by Emanuele Corradini