Set back unneeded elements

Author: b-alidra

README.markdown README.mdREADME.markdown renamed to README.md

@@ -1,33 +1,34 @@
-# Ogone PHP library #
+# PostFinance PHP library #
 
-This library allows you to easily implement an [Ogone](http://ogone.com) integration into your project.
-It provides the necessary components to complete a correct payment flow with the [Ogone](http://ogone.com) platform.
-
-[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/marlon-be/marlon-ogone/badges/quality-score.png?s=ceabe3e767cad807b589fc63169e6a330d20f9fa)](https://scrutinizer-ci.com/g/marlon-be/marlon-ogone/)
-[![Build Status](https://travis-ci.org/marlon-be/marlon-ogone.png)](https://travis-ci.org/marlon-be/marlon-ogone)
+This library allows you to easily implement an [PostFinance](https://www.postfinance.ch/) integration into your project.
+It provides the necessary components to complete a correct payment flow with the [PostFinance](https://www.postfinance.ch/) platform.
 
 Requirements:
 
 - PHP 5.3
-- network connection between your webserver and the Ogone platform
+- network connection between your webserver and the PostFinance platform
 
 As always, this is work in progress. Please feel free to fork this project and let them pull requests coming!
 
-## Overview ##
+Installation:
+-------------
+The library is [PSR-0 compliant](http://www.php-fig.org/psr/psr-0/fr/)
+ and the simplest way to install it is via composer
 
-The library complies to the [PSR-0 standard](http://groups.google.com/group/php-standards/web/psr-0-final-proposal),
-so it can be autoloaded using PSR-0 classloaders like the one in Symfony2. See autoload.php for an example.
+  composer require wysow/postfinance
+
+## Overview ##
 
-- Create an EcommercePaymentRequest or CreateAliasRequest, containing all the info needed by Ogone.
+- Create an EcommercePaymentRequest or CreateAliasRequest, containing all the info needed by PostFinance.
 - Generate  a form
-- Submit it to Ogone (client side)
-- Receive a PaymentResponse back from Ogone (as a HTTP Request)
+- Submit it to PostFinance (client side)
+- Receive a PaymentResponse back from PostFinance (as a HTTP Request)
 
 Both EcommercePaymentRequest, CreateAliasRequest and PaymentResponse are authenticated by comparing the SHA sign, which is a hash of the parameters and a secret passphrase. You can create the hash using a ShaComposer.
 
 # SHA Composers #
 
-Ogone provides 2 methods to generate a SHA sign:
+PostFinance provides 2 methods to generate a SHA sign:
 
 - "Main parameters only"
 
@@ -37,7 +38,7 @@ Ogone provides 2 methods to generate a SHA sign:
 
 ```php
   <?php
-	use Ogone\ShaComposer\LegacyShaComposer;
+	use PostFinance\ShaComposer\LegacyShaComposer;
 	$shaComposer = new LegacyShaComposer($passphrase);
 ```
 
@@ -49,7 +50,7 @@ Ogone provides 2 methods to generate a SHA sign:
 
 ```php
   	<?php
-	use Ogone\ShaComposer\AllParametersShaComposer;
+	use PostFinance\ShaComposer\AllParametersShaComposer;
 	$shaComposer = new AllParametersShaComposer($passphrase);
 ```
 
@@ -59,19 +60,19 @@ This library currently supports both the legacy method "Main parameters only" an
 
 ```php
 	<?php
-	use Ogone\Passphrase;
-	use Ogone\Ecommerce\EcommercePaymentRequest;
-    use Ogone\ShaComposer\AllParametersShaComposer;
-	use Ogone\FormGenerator;
+	use PostFinance\Passphrase;
+	use PostFinance\Ecommerce\EcommercePaymentRequest;
+    use PostFinance\ShaComposer\AllParametersShaComposer;
+	use PostFinance\FormGenerator;
 
 	$passphrase = new Passphrase('my-sha-in-passphrase-defined-in-ogone-interface');
 	$shaComposer = new AllParametersShaComposer($passphrase);
 	$shaComposer->addParameterFilter(new ShaInParameterFilter); //optional
 
 	$ecommercePaymentRequest = new EcommercePaymentRequest($shaComposer);
 
-	// Optionally set Ogone uri, defaults to TEST account
-	//$ecommercePaymentRequest->setOgoneUri(EcommercePaymentRequest::PRODUCTION);
+	// Optionally set PostFinance uri, defaults to TEST account
+	//$ecommercePaymentRequest->setPostFinanceUri(EcommercePaymentRequest::PRODUCTION);
 
 	// Set various params:
 	$ecommercePaymentRequest->setOrderid('123456');
@@ -91,33 +92,33 @@ This library currently supports both the legacy method "Main parameters only" an
 ```php
 	<?php
 
-	use Ogone\Passphrase;
-	use Ogone\DirectLink\CreateAliasRequest;
-    use Ogone\ShaComposer\AllParametersShaComposer;
-	use Ogone\DirectLink\Alias;
+	use PostFinance\Passphrase;
+	use PostFinance\DirectLink\CreateAliasRequest;
+    use PostFinance\ShaComposer\AllParametersShaComposer;
+	use PostFinance\DirectLink\Alias;
 
 	$passphrase = new Passphrase('my-sha-in-passphrase-defined-in-ogone-interface');
 	$shaComposer = new AllParametersShaComposer($passphrase);
 	$shaComposer->addParameterFilter(new ShaInParameterFilter); //optional
 
 	$createAliasRequest = new CreateAliasRequest($shaComposer);
 
-	// Optionally set Ogone uri, defaults to TEST account
-	// $createAliasRequest->setOgoneUri(CreateAliasRequest::PRODUCTION);
+	// Optionally set PostFinance uri, defaults to TEST account
+	// $createAliasRequest->setPostFinanceUri(CreateAliasRequest::PRODUCTION);
 
 	// set required params
 	$createAliasRequest->setPspid('123456');
 	$createAliasRequest->setAccepturl('http://example.com/accept');
 	$createAliasRequest->setExceptionurl('http://example.com/exception');
 
-	// set optional alias, if empty, Ogone creates one
+	// set optional alias, if empty, PostFinance creates one
 	$alias = new Alias('customer_123');
 	$createAliasRequest->setAlias($alias);
 
 	$createAliasRequest->validate();
 
 	// Now pass $createAliasRequest to a view to build a custom form, you have access to
-	// $createAliasRequest->getOgoneUri(), $createAliasRequest->getParameters() and $createAliasRequest->getShaSign()
+	// $createAliasRequest->getPostFinanceUri(), $createAliasRequest->getParameters() and $createAliasRequest->getShaSign()
 	// Be sure to add the required fields CN (Card holder's name), CARDNO (Card/account number), ED (Expiry date (MMYY)), CVC (Card Verification Code)
 	// and the SHASIGN
 ```
@@ -127,10 +128,10 @@ This library currently supports both the legacy method "Main parameters only" an
 ```php
 	<?php
 
-	use Ogone\DirectLink\DirectLinkPaymentRequest;
-	use Ogone\Passphrase;
-	use Ogone\ShaComposer\AllParametersShaComposer;
-	use Ogone\DirectLink\Alias;
+	use PostFinance\DirectLink\DirectLinkPaymentRequest;
+	use PostFinance\Passphrase;
+	use PostFinance\ShaComposer\AllParametersShaComposer;
+	use PostFinance\DirectLink\Alias;
 
 	$passphrase = new Passphrase('my-sha-in-passphrase-defined-in-ogone-interface');
 	$shaComposer = new AllParametersShaComposer($passphrase);
@@ -148,8 +149,8 @@ This library currently supports both the legacy method "Main parameters only" an
 	$directLinkRequest->setCurrency('EUR');
 	$directLinkRequest->validate();
 
-	// now create a url to be posted to Ogone
-	// you have access to $directLinkRequest->toArray(), $directLinkRequest->getOgoneUri() and directLinkRequest->getShaSign()
+	// now create a url to be posted to PostFinance
+	// you have access to $directLinkRequest->toArray(), $directLinkRequest->getPostFinanceUri() and directLinkRequest->getShaSign()
 ```
 
 
@@ -158,8 +159,8 @@ This library currently supports both the legacy method "Main parameters only" an
 ```php
   	<?php
 
-	use Ogone\Ecommerce\EcommercePaymentResponse;
-	use Ogone\ShaComposer\AllParametersShaComposer;
+	use PostFinance\Ecommerce\EcommercePaymentResponse;
+	use PostFinance\ShaComposer\AllParametersShaComposer;
 
 	// ...
 
@@ -182,8 +183,8 @@ This library currently supports both the legacy method "Main parameters only" an
 ```php
   	<?php
 
-	use Ogone\DirectLink\CreateAliasResponse;
-	use Ogone\ShaComposer\AllParametersShaComposer;
+	use PostFinance\DirectLink\CreateAliasResponse;
+	use PostFinance\ShaComposer\AllParametersShaComposer;
 
 	// ...
 
@@ -209,7 +210,7 @@ As the DirectLink payment gets an instant feedback from the server (and no async
 ```php
 	<?php
 
-	use Ogone\DirectLink\DirectLinkPaymentResponse;
+	use PostFinance\DirectLink\DirectLinkPaymentResponse;
 
 	$directLinkResponse = new DirectLinkPaymentResponse('ogone-direct-link-result-as-xml');
 
@@ -224,5 +225,5 @@ As the DirectLink payment gets an instant feedback from the server (and no async
 
 # Parameter filters #
 ParameterFilters are used to filter the provided parameters (no shit Sherlock).
-Both ShaIn- and ShaOutParameterFilters are provided and are based on the parameter lists defined in the Ogone documentation.
+Both ShaIn- and ShaOutParameterFilters are provided and are based on the parameter lists defined in the PostFinance documentation.
 Parameter filtering is optional, but we recommend using them to enforce expected parameters.

autoload.php

@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the Marlon Ogone package.
+ * This file is part of the Marlon PostFinance package.
  *
  * (c) Marlon BVBA <info@marlon.be>
  *
@@ -14,6 +14,6 @@
 
 $loader = new UniversalClassLoader;
 $loader->registerNamespaces(array(
-    'Ogone' => __DIR__ . '/lib/'
+    'PostFinance' => __DIR__ . '/lib/'
 ));
 $loader->register();

lib/PostFinance/DirectLink/Alias.php

@@ -0,0 +1,42 @@
+<?php
+/*
+ * This file is part of the Wysow PostFinance package.
+ *
+ * (c) Gaultier Boniface <gboniface@wysow.fr>
+ * (c) Marlon BVBA <info@marlon.be>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace PostFinance\DirectLink;
+
+use InvalidArgumentException;
+
+class Alias {
+
+    /** @var string */
+    private $alias;
+
+    public function __construct($alias)
+    {
+        if(empty($alias)) {
+            throw new InvalidArgumentException("Alias cannot be empty");
+        }
+
+        if(strlen($alias) > 50) {
+            throw new InvalidArgumentException("Alias is too long");
+        }
+
+        if(preg_match('/[^a-zA-Z0-9_-]/', $alias)) {
+            throw new InvalidArgumentException("Alias cannot contain special characters");
+        }
+
+        $this->alias = $alias;
+    }
+
+    public function __toString()
+    {
+        return (string) $this->alias;
+    }
+}

lib/PostFinance/DirectLink/CreateAliasRequest.php

@@ -0,0 +1,44 @@
+<?php
+/*
+ * This file is part of the Wysow PostFinance package.
+ *
+ * (c) Gaultier Boniface <gboniface@wysow.fr>
+ * (c) Marlon BVBA <info@marlon.be>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace PostFinance\DirectLink;
+
+use PostFinance\AbstractRequest;
+use PostFinance\ShaComposer\ShaComposer;
+
+class CreateAliasRequest extends AbstractRequest {
+
+    const TEST = "https://secure.PostFinance.com/ncol/test/alias_gateway_utf8.asp";
+    const PRODUCTION = "https://secure.PostFinance.com/ncol/prod/alias_gateway_utf8.asp";
+
+    public function __construct(ShaComposer $shaComposer)
+    {
+        $this->shaComposer = $shaComposer;
+        $this->PostFinanceUri = self::TEST;
+    }
+
+    public function getRequiredFields()
+    {
+        return array(
+            'pspid', 'accepturl', 'exceptionurl'
+        );
+    }
+
+    public function getValidPostFinanceUris()
+    {
+        return array(self::TEST, self::PRODUCTION);
+    }
+
+    public function setAlias(Alias $alias)
+    {
+        $this->parameters['alias'] = (string) $alias;
+    }
+}

lib/PostFinance/DirectLink/CreateAliasResponse.php

@@ -0,0 +1,41 @@
+<?php
+/*
+ * This file is part of the Wysow PostFinance package.
+ *
+ * (c) Gaultier Boniface <gboniface@wysow.fr>
+ * (c) Marlon BVBA <info@marlon.be>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace PostFinance\DirectLink;
+
+use PostFinance\AbstractResponse;
+use PostFinance\ShaComposer\ShaComposer;
+
+class CreateAliasResponse extends AbstractResponse {
+
+    const STATUS_OK = 0;
+    const STATUS_NOK = 1;
+    const STATUS_UPDATED = 2;
+
+    /**
+     * Checks if the response is valid
+     * @return bool
+     */
+    public function isValid(ShaComposer $shaComposer)
+    {
+        return $shaComposer->compose($this->parameters) == $this->shaSign;
+    }
+
+    public function isSuccessful()
+    {
+        return in_array($this->getParam('STATUS'), array(self::STATUS_OK, self::STATUS_UPDATED));
+    }
+
+    public function getAlias()
+    {
+        return new Alias($this->parameters['ALIAS']);
+    }
+}