thearyanahmed/ppp

Integrate the Purchasing Power Parity API into your online products and services, enabling you to offer affordable pricing globally.

v0.1 2023-08-22 19:50 UTC

Requires

• php: ^7.4|^8.0
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Aryan Ahmed

• ppp
• thearyanahmed

README

Implementation of https://purchasing-power-parity.com using PHP.

Installation

You can install the package via composer:

composer require thearyanahmed/ppp

Usage

use Thearyanahmed\Ppp\Request;
$response = (new Request)->fetchPPP('DE');

The response can be either SuccessfulResponse or ErrorResponse. The SuccessResponse contains the fields with getter methods. Eg: pppConversionFactor can be accessed via getPppConversionFactor().

Available methods

# SuccessResponse
    public function getCountryCodeAlpha2() : string
    public function getCountryCodeAlpha3() : string
    public function getMainCurrencyName() : string
    public function getMainCurrencySymbol() : string
    public function getPppConversionFactor() : float
    public function getPPP() : float
    public function isSuccessful() : bool # will always return true

# ErrorResponse
    public function getMessage() : string
    public function isSuccessful() : bool # will always return false

If it's not a HTTP 200 request,**** it'll throw an generic exception.

Usage

   $response = (new Request)->fetchPPP('DE');

   if($response->isSuccessful()) {
        $discountPrice = $response->getPppConversionFactor() * $originalPrice;
   }

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Aryan Ahmed
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

PHP Package Boilerplate

This package was generated using the PHP Package Boilerplate by Beyond Code.