-
-
Notifications
You must be signed in to change notification settings - Fork 187
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #137 from cjnewbs/feature/add_order_support
- Loading branch information
Showing
5 changed files
with
221 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
<?php declare(strict_types=1); | ||
|
||
/** | ||
* Copyright (c), Includable. | ||
* | ||
* Permission is hereby granted, free of charge, to any person obtaining a copy | ||
* of this software and associated documentation files (the "Software"), to | ||
* deal in the Software without restriction, including without limitation the | ||
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or | ||
* sell copies of the Software, and to permit persons to whom the Software is | ||
* furnished to do so, subject to the following conditions: | ||
* | ||
* The above copyright notice and this permission notice shall be included in | ||
* all copies or substantial portions of the Software. | ||
*/ | ||
|
||
namespace PKPass; | ||
|
||
use ZipArchive; | ||
|
||
class FinanceOrder extends PKPass | ||
{ | ||
const FILE_TYPE = 'order'; | ||
const FILE_EXT = 'order'; | ||
const MIME_TYPE = 'application/vnd.apple.finance.order'; | ||
const PAYLOAD_FILE = 'order.json'; | ||
const HASH_ALGO = 'sha256'; | ||
|
||
/** | ||
* Sub-function of create() | ||
* This function creates the hashes for the files and adds them into a json string. | ||
* | ||
* @throws PKPassException | ||
*/ | ||
protected function createManifest() | ||
{ | ||
// Creates SHA hashes for all files in package | ||
$sha = []; | ||
$sha[self::PAYLOAD_FILE] = hash(self::HASH_ALGO, $this->json); | ||
|
||
// Creates SHA hashes for string files in each project. | ||
foreach ($this->locales as $language => $strings) { | ||
$sha[$language . '.lproj/' . self::FILE_TYPE . '.strings'] = hash(self::HASH_ALGO, $strings); | ||
} | ||
|
||
foreach ($this->files as $name => $path) { | ||
$sha[$name] = hash(self::HASH_ALGO, file_get_contents($path)); | ||
} | ||
|
||
foreach ($this->remote_file_urls as $name => $url) { | ||
$sha[$name] = hash(self::HASH_ALGO, file_get_contents($url)); | ||
} | ||
|
||
foreach ($this->files_content as $name => $content) { | ||
$sha[$name] = hash(self::HASH_ALGO, $content); | ||
} | ||
|
||
return json_encode((object)$sha); | ||
} | ||
|
||
/** | ||
* Creates .pkpass zip archive. | ||
* | ||
* @param string $manifest | ||
* @param string $signature | ||
* @return string | ||
* @throws PKPassException | ||
*/ | ||
protected function createZip($manifest, $signature) | ||
{ | ||
// Package file in Zip (as .order) | ||
$zip = new ZipArchive(); | ||
$filename = tempnam($this->tempPath, self::FILE_TYPE); | ||
if (!$zip->open($filename, ZipArchive::OVERWRITE)) { | ||
throw new PKPassException('Could not open ' . basename($filename) . ' with ZipArchive extension.'); | ||
} | ||
$zip->addFromString('signature', $signature); | ||
$zip->addFromString('manifest.json', $manifest); | ||
$zip->addFromString(self::PAYLOAD_FILE, $this->json); | ||
|
||
// Add translation dictionary | ||
foreach ($this->locales as $language => $strings) { | ||
if (!$zip->addEmptyDir($language . '.lproj')) { | ||
throw new PKPassException('Could not create ' . $language . '.lproj folder in zip archive.'); | ||
} | ||
$zip->addFromString($language . '.lproj/' . self::FILE_TYPE . '.strings', $strings); | ||
} | ||
|
||
foreach ($this->files as $name => $path) { | ||
$zip->addFile($path, $name); | ||
} | ||
|
||
foreach ($this->remote_file_urls as $name => $url) { | ||
$download_file = file_get_contents($url); | ||
$zip->addFromString($name, $download_file); | ||
} | ||
|
||
foreach ($this->files_content as $name => $content) { | ||
$zip->addFromString($name, $content); | ||
} | ||
|
||
$zip->close(); | ||
|
||
if (!file_exists($filename) || filesize($filename) < 1) { | ||
@unlink($filename); | ||
throw new PKPassException('Error while creating order.order. Check your ZIP extension.'); | ||
} | ||
|
||
$content = file_get_contents($filename); | ||
unlink($filename); | ||
|
||
return $content; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
<?php declare(strict_types=1); | ||
|
||
use PHPUnit\Framework\TestCase; | ||
use PKPass\FinanceOrder; | ||
|
||
final class FinanceOrderTest extends TestCase | ||
{ | ||
private function validateOrder($orer, $expected_files = []) | ||
{ | ||
// basic string validation | ||
$this->assertIsString($orer); | ||
$this->assertGreaterThan(100, strlen($orer)); | ||
$this->assertStringContainsString('logo.png', $orer); | ||
$this->assertStringContainsString('ws03-xs-red.jpg', $orer); | ||
$this->assertStringContainsString('manifest.json', $orer); | ||
|
||
// try to read the ZIP file | ||
$temp_name = tempnam(sys_get_temp_dir(), 'pkpass'); | ||
file_put_contents($temp_name, $orer); | ||
$zip = new ZipArchive(); | ||
$res = $zip->open($temp_name); | ||
$this->assertTrue($res, 'Invalid ZIP file.'); | ||
$this->assertEquals(count($expected_files), $zip->numFiles); | ||
|
||
// extract zip to temp dir | ||
$temp_dir = $temp_name . '_dir'; | ||
mkdir($temp_dir); | ||
$zip->extractTo($temp_dir); | ||
$zip->close(); | ||
echo $temp_dir; | ||
foreach ($expected_files as $file) { | ||
$this->assertFileExists($temp_dir . DIRECTORY_SEPARATOR . $file); | ||
} | ||
} | ||
|
||
public function testBasicGeneration() | ||
{ | ||
$pass = new FinanceOrder(__DIR__ . '/fixtures/example-certificate.p12', 'password'); | ||
$pass->setData([ | ||
"createdAt" => "2024-02-01T19:45:50+00:00", | ||
"merchant" => [ | ||
"displayName" => "Luma", | ||
"merchantIdentifier" => "merchant.com.pkpass.unit-test", | ||
"url" => "https://demo-store.test/", | ||
'logo' => 'logo.png', | ||
], | ||
"orderIdentifier" => "1", | ||
"orderManagementURL" => "https://demo-store.test/sales/order/view", | ||
'orderNumber' => '#000000001', | ||
"orderType" => "ecommerce", | ||
"orderTypeIdentifier" => "order.com.pkpass.unit-test", | ||
'payment' => [ | ||
'summaryItems' => [ | ||
[ | ||
'label' => 'Shipping & Handling', | ||
'value' => [ | ||
'amount' => '5.00', | ||
'currency' => 'USD', | ||
] | ||
], | ||
], | ||
'total' => [ | ||
'amount' => '36.39', | ||
'currency' => 'USB', | ||
], | ||
'status' => 'paid' | ||
], | ||
"status" => "open", | ||
"updatedAt" => "2024-02-01T19:45:50+00:00", | ||
'customer' => [ | ||
'emailAddress' => '[email protected]', | ||
'familyName' => 'Veronica', | ||
'givenName' => 'Costello', | ||
], | ||
'lineItems' => [ | ||
[ | ||
'image' => 'ws03-xs-red.jpg', | ||
'price' => [ | ||
'amount' => '31.39', | ||
'currency' => 'USD', | ||
], | ||
'quantity' => 1, | ||
'title' => 'Iris Workout Top', | ||
'sku' => 'WS03-XS-Red', | ||
], | ||
], | ||
"schemaVersion" => 1, | ||
]); | ||
$pass->addFile(__DIR__ . '/fixtures/order/logo.png'); | ||
$pass->addFile(__DIR__ . '/fixtures/order/ws03-xs-red.jpg'); | ||
$value = $pass->create(); | ||
$this->validateOrder($value, [ | ||
'logo.png', | ||
'ws03-xs-red.jpg', | ||
'manifest.json', | ||
'order.json', | ||
'signature', | ||
]); | ||
} | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.