doc: examples

author: Marcello Stanisci <marcello.stanisci@inria.fr> 2016-11-11 13:16:13 +0100
committer: Marcello Stanisci <marcello.stanisci@inria.fr> 2016-11-11 13:16:13 +0100
commit: c9824ae88fc8bcc68bfda9cd108a294da5408c5f (patch)
tree: d1a9baf9a08f16ce75150a465e5125ad98678274
parent: 7159ca172c19cd4b7ba9145e0b3a5d8f5398fe2f (diff)
download: merchant-c9824ae88fc8bcc68bfda9cd108a294da5408c5f.tar.gz
merchant-c9824ae88fc8bcc68bfda9cd108a294da5408c5f.tar.bz2
merchant-c9824ae88fc8bcc68bfda9cd108a294da5408c5f.zip
6 files changed, 169 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore
index 0e59f3de..2ba255ef 100644
--- a/.gitignore
+++ b/.gitignore
@@ -34,4 +34,4 @@ doc/*
 !doc/*.texi
 !doc/*.am
 !doc/*.sh
-!doc/*.php
+!doc/examples/
diff --git a/doc/examples/donate_handler.php b/doc/examples/donate_handler.php
new file mode 100644
index 00000000..2cdf2de3
--- /dev/null
+++ b/doc/examples/donate_handler.php
@@ -0,0 +1,12 @@
+<?php
+  http_response_code (402); // 402: Payment required
+  header ('X-Taler-Contract-Url: /generate-contract');
+?>
+<html>
+  <head>
+  <title>Select payment method</title>
+  </head>
+  <body>
+    <!-- Put the credit card paywall here -->
+  </body>
+</html>
diff --git a/doc/examples/fulfillment_handler.php b/doc/examples/fulfillment_handler.php
new file mode 100644
index 00000000..6f091785
--- /dev/null
+++ b/doc/examples/fulfillment_handler.php
@@ -0,0 +1,46 @@
+<html>
+ <head>
+  <title>Donation Fulfillment</titile>
+ </head>
+ <body>
+  <?php
+   # At first, check if the user has already paid for the product.
+   # If so, deliver the product.
+   session_start();
+   if (! isset($_SESSION['paid']))@{
+    # set as pending
+    $_SESSION['paid'] = false;
+   @}
+   else@{
+    if($_SESSION['paid'])@{
+     echo "<p>Thanks for your donation!</p>";
+     return;
+   @}
+    else@{
+      # Generate page to show for payments with credit cards instead.
+      echo '<form action="/cc-payment">
+      Name<br> <input type="text"></input><br>
+      CC number<br> <input type="text"></input><br>
+      Cvv2 code<br> <input type="text"></input><br>
+      <input type="submit"></input>
+      </form>';
+      return;
+   @}
+  @}
+
+  # Reconstruct the contract
+  $rec_proposal = make_contract($_GET['transaction_id'], $_GET['timestamp']);
+  # $response corresponds to the specification at:
+  # https://api.taler.net/api-merchant.html#offer
+  $response = post_to_backend("/contract", $rec_proposal);
+
+  http_response_code (402);
+# FIXME: this can't be right, you want to call "json_deocde", not
+# return it as a literal string in the header! (i.e. insert '. before json_decode and remove ' at the end)?
+# All this code should be tested!
+  header ('X-Taler-Contract-Hash: ' . json_decode($response)["H_contract"]);
+  header ('X-Taler-Offer-Url: /donate');
+  header ('X-Taler-Pay-Url: /pay'); ?>
+ </body>
+</html>
+
diff --git a/doc/examples/generate_contract.php b/doc/examples/generate_contract.php
new file mode 100644
index 00000000..de9770f5
--- /dev/null
+++ b/doc/examples/generate_contract.php
@@ -0,0 +1,76 @@
+function make_contract($transaction_id, $now) @{
+ $contract =
+  array (
+   'amount' => array (
+    'value' => 1,
+    'fraction' => 0,
+    'currency' => "KUDOS"),
+   'max_fee' => array (
+    'value' => 0,
+    'fraction' => 50000,
+    'currency' => "KUDOS"),
+   'transaction_id' => $transaction_id,
+   'products' => array (
+     array (
+      'description' => "Donation to charity program",
+      'quantity' => 1,
+      'price' => array (
+       'value' => 1,
+       'fraction' => 0,
+       'currency' => "KUDOS"),
+      'product_id' => 0,
+      'taxes' => array(), // No taxes for donations
+      'delivery_date' => "/Date(" . $now->getTimestamp() . ")/",
+      'delivery_location' => 'LNAME1')),
+      'timestamp' => "/Date(" . $now->getTimestamp() . ")/",
+      'expiry' =>
+       "/Date(" . $now->add(new DateInterval('P2W'))->getTimestamp() . ")/",
+      'refund_deadline' =>
+       "/Date(" . $now->add(new DateInterval('P3M'))->getTimestamp() . ")/",
+      'repurchase_correlation_id' => '',
+      'fulfillment_url' =>
+       "https://shop.com/fulfillment?"
+       . "transaction_id=$transaction_id&timestamp=$now",
+      'merchant' => array (
+       'address' => 'LNAME1',
+       'name' => "Charity donations shop",
+       'jurisdiction' => 'LNAME2'),
+      'locations' => array (
+       'LNAME1' =>
+        array (
+         'country' => 'Shop Country',
+         'city' => 'Shop City',
+         'state' => 'Shop State',
+       	 'region' => 'Shop Region',
+       	 'province' => 'Shop Province',
+       	 'ZIP code' => 4908,
+         'street' => 'Shop street',
+       	 'street number' => 20),
+       'LNAME2' => array (
+         'country' => 'Legal Country',
+         'city' => Legal City',
+         'state' => 'Legal State',
+         'region' => 'Legal Region',
+         'province' => 'Legal Province',
+         'ZIP code' => 4908)));
+@}
+
+
+/* this variable is the JSON of a contract proposal,
+ see https://api.taler.net/api-merchant.html#post--contract
+ the second parameter is the transaction id */
+$transaction_id = rand(1,90000); // simplified, do not do this!
+$proposal = make_contract($transaction_id, new DateTime('now'));
+
+# Here the frontend POSTs the proposal to the backend
+$response = post_to_backend("/contract", $proposal);
+
+if (200 != $response->getResponseCode()) @{
+  echo json_encode(array(
+    'error' => "internal error",
+    'hint' => "failed to generate contract",
+    'detail' => $resp->body->toString()
+    ), JSON_PRETTY_PRINT);
+  return;
+@}
+echo $response->body;
diff --git a/doc/examples/pay_handler.php b/doc/examples/pay_handler.php
new file mode 100644
index 00000000..3b10b0c2
--- /dev/null
+++ b/doc/examples/pay_handler.php
@@ -0,0 +1,20 @@
+# Check if a session exists already
+session_start();
+if (! isset($_SESSION['paid'])) @{
+  echo "<p>There is no session for this purchase. Something is wrong.</p>";
+  return;
+@}
+# Get the HTTP POST body
+$payment = file_get_contents('php://input');
+$response = post_to_backend("/pay", $payment);
+if (200 != $response->getResponseCode())@{
+  echo json_encode(array(
+    'error' => "internal error",
+    'hint' => "failed to POST coins to the backend",
+    'detail' => $response->body->toString()
+    ), JSON_PRETTY_PRINT);
+  return;
+@}
+$_SESSION['paid'] = true;
+return $response->body;
+
diff --git a/doc/examples/post_to_backend.php b/doc/examples/post_to_backend.php
new file mode 100644
index 00000000..e89b5283
--- /dev/null
+++ b/doc/examples/post_to_backend.php
@@ -0,0 +1,14 @@
+function post_to_backend($backend_relative_url, $json)@{
+  $url = "https://shop.com$backend_relative_url";
+
+  $req = new http\Client\Request("POST",
+                                 $url,
+                                 array ("Content-Type" => "application/json"));
+
+  $req->getBody()->append($json);
+
+  // Execute the HTTP request
+  $client = new http\Client;
+  $client->enqueue($req)->send();
+  return $client->getResponse();
+@}
author	Marcello Stanisci <marcello.stanisci@inria.fr>	2016-11-11 13:16:13 +0100
committer	Marcello Stanisci <marcello.stanisci@inria.fr>	2016-11-11 13:16:13 +0100
commit	c9824ae88fc8bcc68bfda9cd108a294da5408c5f (patch)
tree	d1a9baf9a08f16ce75150a465e5125ad98678274
parent	7159ca172c19cd4b7ba9145e0b3a5d8f5398fe2f (diff)
download	merchant-c9824ae88fc8bcc68bfda9cd108a294da5408c5f.tar.gz merchant-c9824ae88fc8bcc68bfda9cd108a294da5408c5f.tar.bz2 merchant-c9824ae88fc8bcc68bfda9cd108a294da5408c5f.zip