Merge pull request #115 from erdalceylan/master

doc updates and code cleanup
paranoiaproject · Dec 11, 2018 · 5e368a6 · 5e368a6
2 parents ffb340f + 56a8a41
commit 5e368a6
Show file tree

Hide file tree

Showing 25 changed files with 135 additions and 55 deletions.
diff --git a/composer.json b/composer.json
@@ -6,7 +6,9 @@
     "require": {
         "php": ">= 5.6.0",
         "guzzle/guzzle": "3.9.2",
-        "symfony/event-dispatcher": "^2.7|^3.0"
+        "symfony/event-dispatcher": "^2.7|^3.0",
+        "ext-SimpleXML": "*",
+        "ext-curl" :"*"
     },
     "require-dev": {
         "phpunit/phpunit": "5.7.*",

diff --git a/docs/3-islemler.md b/docs/3-islemler.md
@@ -1,6 +1,6 @@
 # 3. İşlemler
 
-* [3.1. Satış İşlemi](/docs/31-sats-islemi.md)
+* [3.1. Satış İşlemi](/docs/31-satis-islemi.md)
 * 3.2. Ön Onaylı Sipariş İşemi
 * 3.3. Ön Onaylı Sipariş İşleminin Satış İşlemine Dönüştürülmesi
 * [3.4. İptal İşlemi](/docs/34-iptal-islemi.md)

diff --git a/docs/31-satis-islemi.md b/docs/31-satis-islemi.md
@@ -6,14 +6,14 @@ Satış işlemi, müşterinin ödeme aracı bilgilerinin (Kredi kartı vb.) ilgi
 
 ## 3.1.2. Satış İsteği Oluşturma
 
-Satış isteği, **Paranoia\Request**  tipinde bir nesnenin sipariş ve ödeme aracı (kredi kartı vb.) bilgileri ile doldurulması suretiyle elde edilir.
+Satış isteği, **\Paranoia\Request\Request**  tipinde bir nesnenin sipariş ve ödeme aracı (kredi kartı vb.) bilgileri ile doldurulması suretiyle elde edilir.
 
 ```php
-$request = new \Paranoia\Request();
+$request = new \Paranoia\Request\Request();
 $request->setOrderId('ORDER000000' . time())
         ->setAmount(100.35)
-        ->setCurrency('TRY');
-$card = new \Paranoia\Resource\Card();
+        ->setCurrency(\Paranoia\Currency::CODE_TRY);
+$card = new \Paranoia\Request\Resource\Card();
 $card->setNumber('5406******675403')
      ->setSecurityCode('000')
      ->setExpireMonth(12)
@@ -37,11 +37,11 @@ $request->setResource($card);
 
 * Satış işlemi için yeni bir sipariş isteği oluşturuyoruz.
 ```php
-$request = new \Paranoia\Request();
+$request = new \Paranoia\Request\Request();
 $request->setOrderId('ORDER000000' . time())
         ->setAmount(100.35)
-        ->setCurrency('TRY');
-$card = new \Paranoia\Resource\Card();
+        ->setCurrency(\Paranoia\Currency::CODE_TRY);
+$card = new \Paranoia\Request\Resource\Card();
 $card->setNumber('5406******675403')
      ->setSecurityCode('000')
      ->setExpireMonth(12)
@@ -59,18 +59,14 @@ $configuration->setClientId('123456789')
 
 ```
 
-* Satış işlemini gerçekleştiriyoruz. Sağlayıcı uyarlamaları, Sağlayıcının [2. Desteklenen Ödeme Sistemleri](/docs/2-desteklenen-odeme-sistemleri.md) dökümanında belirtilen **ödeme sistemi** nin adı ile adlandırılmışlardır. Örnekte belirtilen NestPay uyarlaması için \Paranoia\Pos\**NestPay** sınıfını kullanabildiğiniz gibi Posnet uyarlaması için **\Paranoia\Pos\**Posnet** sınıfını kullanabilirsiniz.
+* Satış işlemini gerçekleştiriyoruz. Sağlayıcı uyarlamaları, Sağlayıcının [2. Desteklenen Ödeme Sistemleri](/docs/2-desteklenen-odeme-sistemleri.md) dökümanında belirtilen **ödeme sistemi** nin adı ile adlandırılmışlardır. Örnekte belirtilen NestPay uyarlaması için \Paranoia\Pos\\**NestPay** sınıfını kullanabildiğiniz gibi Posnet uyarlaması için \Paranoia\Pos\\**Posnet** sınıfını kullanabilirsiniz.
 ```php
 try {
         $adapter = new \Paranoia\Pos\NestPay($configuration);
         $response = $adapter->sale($request);
 } catch(\Paranoia\Exception\CommunicationError $e) {
          // Bağlantı hatası durumunda yapılacak işlemleri
          // bu bölümde greçekleştirebilirsiniz.
-} catch(\Paranoia\Exception\UnexpectedResponse $e) {
-        // Ödeme sistemi sağlayıcısından beklenmedik bir yanıt
-        // dönmesi (boş yanıt veya beklenmedik bir hata mesajı gibi)
-        // durumunda yapılacak işlemleri bu bölümde gerçekleştirebilirsiniz.
 } catch(\Exception $e) {
         // Uygulamada beklenmedik bir hata meydana gelmesi durumunda
         // yapılacak işlemleri bu bölümde gerçekleştirebilirsiniz.

diff --git a/docs/34-iptal-islemi.md b/docs/34-iptal-islemi.md
@@ -9,14 +9,14 @@
 İptal isteği, **Paranoia\Request**  tipinde bir nesnenin transaction numarası ile doldurulması suretiyle elde edilir.
 
 ```php
-$request = new \Paranoia\Request();
+$request = new \Paranoia\Request\Request();
 $request->setTransactionId('1234567890');
 ```
 
 İptal işlemi sipariş numarası ile de gerçekleştirilebilmektedir.<br />
 **Not:** Bu kullanım şekli bazı bankalar tarafından tavsiye edilmemektedir.
 ```php
-$request = new \Paranoia\Request();
+$request = new \Paranoia\Request\Request();
 $request->setOrderId('987654321');
 ```
 
@@ -33,7 +33,7 @@ $request->setOrderId('987654321');
 
 * İptal işlemi için yeni bir iptal isteği oluşturuyoruz.
 ```php
-$request = new \Paranoia\Request();
+$request = new \Paranoia\Request\Request();
 $request->setTransactionId('1234567890');
 ```
 
@@ -55,10 +55,6 @@ try {
 } catch(\Paranoia\Exception\CommunicationError $e) {
          // Bağlantı hatası durumunda yapılacak işlemleri
          // bu bölümde greçekleştirebilirsiniz.
-} catch(\Paranoia\Exception\UnexpectedResponse $e) {
-        // Ödeme sistemi sağlayıcısından beklenmedik bir yanıt
-        // dönmesi (boş yanıt veya beklenmedik bir hata mesajı gibi)
-        // durumunda yapılacak işlemleri bu bölümde gerçekleştirebilirsiniz.
 } catch(\Exception $e) {
         // Uygulamada beklenmedik bir hata meydana gelmesi durumunda
         // yapılacak işlemleri bu bölümde gerçekleştirebilirsiniz.

diff --git a/docs/35-iade-islemi.md b/docs/35-iade-islemi.md
@@ -9,7 +9,7 @@
 İade isteği, **Paranoia\Request**  tipinde bir nesnenin sipariş numarası ile doldurulması suretiyle elde edilir.
 
 ```php
-$request = new \Paranoia\Request();
+$request = new \Paranoia\Request\Request();
 $request->setOrderId('987654321');
 ```
 
@@ -24,7 +24,7 @@ $request->setOrderId('987654321');
 
 * İade işlemi için yeni bir iade isteği oluşturuyoruz.
 ```php
-$request = new \Paranoia\Request();
+$request = new \Paranoia\Request\Request();
 $request->setOrderId('1234567890');
 ```
 
@@ -46,10 +46,6 @@ try {
 } catch(\Paranoia\Exception\CommunicationError $e) {
          // Bağlantı hatası durumunda yapılacak işlemleri
          // bu bölümde greçekleştirebilirsiniz.
-} catch(\Paranoia\Exception\UnexpectedResponse $e) {
-        // Ödeme sistemi sağlayıcısından beklenmedik bir yanıt
-        // dönmesi (boş yanıt veya beklenmedik bir hata mesajı gibi)
-        // durumunda yapılacak işlemleri bu bölümde gerçekleştirebilirsiniz.
 } catch(\Exception $e) {
         // Uygulamada beklenmedik bir hata meydana gelmesi durumunda
         // yapılacak işlemleri bu bölümde gerçekleştirebilirsiniz.

diff --git a/src/Configuration/AbstractConfiguration.php b/src/Configuration/AbstractConfiguration.php
@@ -27,4 +27,4 @@ public function getApiUrl()
     {
         return $this->apiUrl;
     }
-}
+}
diff --git a/src/Pos/AbstractPos.php b/src/Pos/AbstractPos.php
@@ -7,7 +7,6 @@
 use Paranoia\Exception\CommunicationError;
 use Paranoia\Request\Request;
 use Paranoia\TransactionType;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 abstract class AbstractPos
 {
@@ -16,8 +15,6 @@ abstract class AbstractPos
      */
     protected $configuration;
 
-    /** @var EventDispatcherInterface  */
-    private $dispatcher;
 
     public function __construct(AbstractConfiguration $configuration)
     {
@@ -27,7 +24,7 @@ public function __construct(AbstractConfiguration $configuration)
     /**
      *  build complete raw data for the specified request.
      *
-     * @param \Paranoia\Request $request
+     * @param \Paranoia\Request\Request $request
      * @param string $transactionType
      *
      * @return mixed
@@ -40,7 +37,7 @@ abstract protected function buildRequest(Request $request, $transactionType);
      * @param string $rawResponse
      * @param string $transactionType
      *
-     * @return \Paranoia\Response\Response
+     * @return \Paranoia\Response
      */
     abstract protected function parseResponse($rawResponse, $transactionType);
 
@@ -51,27 +48,35 @@ abstract protected function parseResponse($rawResponse, $transactionType);
      * @param mixed  $data
      * @param array $options
      *
-     * @throws \ErrorException|\Exception
+     * @throws CommunicationError
      * @return mixed
      */
     protected function sendRequest($url, $data, $options = null)
     {
         $client = new HttpClient();
         $client->setConfig(array(
-           'curl.options' => array(
-               CURLOPT_SSL_VERIFYPEER => false,
-               CURLOPT_SSL_VERIFYHOST => false,
-               CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2
-           )
+            'curl.options' => array(
+                CURLOPT_SSL_VERIFYPEER => false,
+                CURLOPT_SSL_VERIFYHOST => false,
+                CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2
+            )
         ));
+
         $request = $client->post($url, null, $data);
+
         try {
             return $request->send()->getBody();
         } catch (RequestException $e) {
             throw new CommunicationError('Communication failed: ' . $url);
         }
     }
 
+    /**
+     * @param $request Request
+     * @param $transactionType
+     * @return \Paranoia\Response
+     * @throws CommunicationError
+    */
     private function performTransaction(Request $request, $transactionType)
     {
         $rawRequest  = $this->buildRequest($request, $transactionType);
@@ -81,69 +86,76 @@ private function performTransaction(Request $request, $transactionType)
     }
 
     /**
-     * @param \Paranoia\Request $request
+     * @param \Paranoia\Request\Request $request
      *
-     * @return \Paranoia\Response\Response
+     * @return \Paranoia\Response
+     * @throws CommunicationError
      */
     public function preAuthorization(Request $request)
     {
         return $this->performTransaction($request, TransactionType::PRE_AUTHORIZATION);
     }
 
     /**
-     * @param \Paranoia\Request $request
+     * @param \Paranoia\Request\Request $request
      *
-     * @return \Paranoia\Response\Response
+     * @return \Paranoia\Response
+     * @throws CommunicationError
      */
     public function postAuthorization(Request $request)
     {
         return $this->performTransaction($request, TransactionType::POST_AUTHORIZATION);
     }
 
     /**
-     * @param \Paranoia\Request $request
+     * @param \Paranoia\Request\Request $request
      *
-     * @return \Paranoia\Response\Response
+     * @return \Paranoia\Response
+     * @throws CommunicationError
      */
     public function sale(Request $request)
     {
         return $this->performTransaction($request, TransactionType::SALE);
     }
 
     /**
-     * @param \Paranoia\Request $request
+     * @param \Paranoia\Request\Request $request
      *
-     * @return \Paranoia\Response\Response
+     * @return \Paranoia\Response
+     * @throws CommunicationError
      */
     public function refund(Request $request)
     {
         return $this->performTransaction($request, TransactionType::REFUND);
     }
 
     /**
-     * @param \Paranoia\Request $request
+     * @param \Paranoia\Request\Request $request
      *
-     * @return \Paranoia\Response\Response
+     * @return \Paranoia\Response
+     * @throws CommunicationError
      */
     public function cancel(Request $request)
     {
         return $this->performTransaction($request, TransactionType::CANCEL);
     }
 
     /**
-     * @param \Paranoia\Request $request
+     * @param \Paranoia\Request\Request $request
      *
-     * @return \Paranoia\Response\Response
+     * @return \Paranoia\Response
+     * @throws CommunicationError
      */
     public function pointQuery(Request $request)
     {
         return $this->performTransaction($request, TransactionType::POINT_INQUIRY);
     }
 
     /**
-     * @param \Paranoia\Request $request
+     * @param \Paranoia\Request\Request $request
      *
-     * @return \Paranoia\Response\Response
+     * @return \Paranoia\Response
+     * @throws CommunicationError
      */
     public function pointUsage(Request $request)
     {

diff --git a/src/Pos/Gvp.php b/src/Pos/Gvp.php
@@ -24,6 +24,7 @@ public function __construct(AbstractConfiguration $configuration)
     /**
      * {@inheritdoc}
      * @see \Paranoia\Pos\AbstractPos::buildRequest()
+     * @throws \Paranoia\Exception\NotImplementedError
      */
     protected function buildRequest(Request $request, $transactionType)
     {

diff --git a/src/Pos/NestPay.php b/src/Pos/NestPay.php
@@ -26,6 +26,7 @@ public function __construct(AbstractConfiguration $configuration)
     /**
      * {@inheritdoc}
      * @see \Paranoia\Pos\AbstractPos::buildRequest()
+     * @throws \Paranoia\Exception\NotImplementedError
      */
     protected function buildRequest(Request $request, $transactionType)
     {

diff --git a/src/Pos/Posnet.php b/src/Pos/Posnet.php
@@ -24,6 +24,7 @@ public function __construct(AbstractConfiguration $configuration)
     /**
      * {@inheritdoc}
      * @see \Paranoia\Pos\AbstractPos::buildRequest()
+     * @throws \Paranoia\Exception\NotImplementedError
      */
     protected function buildRequest(Request $request, $transactionType)
     {
@@ -37,7 +38,6 @@ protected function buildRequest(Request $request, $transactionType)
      */
     protected function parseResponse($rawResponse, $transactionType)
     {
-        $rawRequest = $this->builderFactory->createBuilder($transactionType)->build($request);
-        return array( 'DATA' => $rawRequest);
+        return $this->processorFactory->createProcessor($transactionType)->process($rawResponse);
     }
 }
diff --git a/src/Processor/Gvp/CancelResponseProcessor.php b/src/Processor/Gvp/CancelResponseProcessor.php
@@ -3,6 +3,11 @@
 
 class CancelResponseProcessor extends BaseResponseProcessor
 {
+    /**
+     * @param $rawResponse
+     * @throws \Paranoia\Exception\BadResponseException
+     * @return \Paranoia\Response
+     */
     public function process($rawResponse)
     {
         return $this->processCommonResponse($rawResponse);

diff --git a/src/Processor/Gvp/PostAuthorizationResponseProcessor.php b/src/Processor/Gvp/PostAuthorizationResponseProcessor.php
@@ -3,6 +3,11 @@
 
 class PostAuthorizationResponseProcessor extends BaseResponseProcessor
 {
+    /**
+     * @param $rawResponse
+     * @throws \Paranoia\Exception\BadResponseException
+     * @return \Paranoia\Response
+     */
     public function process($rawResponse)
     {
         return $this->processCommonResponse($rawResponse);

diff --git a/src/Processor/Gvp/PreAuthorizationResponseProcessor.php b/src/Processor/Gvp/PreAuthorizationResponseProcessor.php
@@ -3,6 +3,11 @@
 
 class PreAuthorizationResponseProcessor extends BaseResponseProcessor
 {
+    /**
+     * @param $rawResponse
+     * @throws \Paranoia\Exception\BadResponseException
+     * @return \Paranoia\Response
+     */
     public function process($rawResponse)
     {
         return $this->processCommonResponse($rawResponse);

diff --git a/src/Processor/Gvp/RefundResponseProcessor.php b/src/Processor/Gvp/RefundResponseProcessor.php
@@ -3,6 +3,11 @@
 
 class RefundResponseProcessor extends BaseResponseProcessor
 {
+    /**
+     * @param $rawResponse
+     * @throws \Paranoia\Exception\BadResponseException
+     * @return \Paranoia\Response
+     */
     public function process($rawResponse)
     {
         return $this->processCommonResponse($rawResponse);
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,4 +27,4 @@ public function getApiUrl() @@
         {
             return $this->apiUrl;
         }
-    }
+    }