Split RequestSigner in separate repository

baibaratsky · Jan 18, 2015 · 3fdb89e · 3fdb89e
1 parent d8237af
commit 3fdb89e
Show file tree

Hide file tree

Showing 19 changed files with 68 additions and 233 deletions.
diff --git a/Api/MegaStock/AddMerchant/Request.php b/Api/MegaStock/AddMerchant/Request.php
@@ -4,8 +4,8 @@
 
 use baibaratsky\WebMoney\Api\MegaStock;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
 use baibaratsky\WebMoney\Request\RequestValidator;
+use baibaratsky\WebMoney\Signer;
 
 /**
  * Class Request
@@ -147,11 +147,11 @@ public function getResponseClassName()
     }
 
     /**
-     * @param \baibaratsky\WebMoney\Request\RequestSigner $requestSigner
+     * @param Signer $requestSigner
      *
      * @throws ApiException
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         $signString = $this->loginType . $this->integratorId . $this->integratorWmid .
                       $this->merchantNameInComment . $this->categoryId;

diff --git a/Api/MegaStock/CheckMerchant/Request.php b/Api/MegaStock/CheckMerchant/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\MegaStock;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -65,11 +65,11 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      *
      * @throws ApiException
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         $signString = $this->loginType . $this->integratorId . $this->integratorWmid . $this->resourceId;
         if ($this->loginType == self::LOGIN_TYPE_KEEPER) {

diff --git a/Api/X/X11/Request.php b/Api/X/X11/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -101,11 +101,10 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      *
-     * @return void
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign($this->signerWmid . $this->passportWmid);

diff --git a/Api/X/X14/Request.php b/Api/X/X14/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -81,11 +81,10 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      *
-     * @return void
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign($this->requestNumber . $this->transactionId . $this->amount);

diff --git a/Api/X/X17/ContractInfo/Request.php b/Api/X/X17/ContractInfo/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -77,11 +77,10 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      *
-     * @return void
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign($this->contractId . $this->type);

diff --git a/Api/X/X17/CreateContract/Request.php b/Api/X/X17/CreateContract/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -88,11 +88,10 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      *
-     * @return void
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign($this->signerWmid . mb_strlen($this->contractName, 'UTF-8') . $this->contractType);

diff --git a/Api/X/X18/Request.php b/Api/X/X18/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -103,9 +103,9 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign($this->signerWmid . $this->payeePurse . $this->paymentNumber);

diff --git a/Api/X/X19/Request.php b/Api/X/X19/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -186,9 +186,9 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign($this->requestNumber . $this->operationType . $this->userWmid);

diff --git a/Api/X/X2/Request.php b/Api/X/X2/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -112,9 +112,9 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign(

diff --git a/Api/X/X3/Request.php b/Api/X/X3/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -96,11 +96,10 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      *
-     * @return void
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign($this->parameterPurse . $this->requestNumber);

diff --git a/Api/X/X6/Request.php b/Api/X/X6/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -91,9 +91,9 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign(

diff --git a/Api/X/X8/Request.php b/Api/X/X8/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -80,9 +80,9 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign($this->wmid . $this->purse);

diff --git a/Api/X/X9/Request.php b/Api/X/X9/Request.php
@@ -4,7 +4,7 @@
 
 use baibaratsky\WebMoney\Api\X;
 use baibaratsky\WebMoney\Exception\ApiException;
-use baibaratsky\WebMoney\Request\RequestSigner;
+use baibaratsky\WebMoney\Signer;
 use baibaratsky\WebMoney\Request\RequestValidator;
 
 /**
@@ -72,11 +72,10 @@ public function getResponseClassName()
     }
 
     /**
-     * @param RequestSigner $requestSigner
+     * @param Signer $requestSigner
      *
-     * @return void
      */
-    public function sign(RequestSigner $requestSigner = null)
+    public function sign(Signer $requestSigner = null)
     {
         if ($this->authType === self::AUTH_CLASSIC) {
             $this->signature = $requestSigner->sign($this->requestedWmid . $this->requestNumber);

diff --git a/Exception/RequestSignerException.php b/Exception/RequestSignerException.php
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,7 +1,7 @@
 Webmoney API PHP library is free software. It is released under
 the terms of the following BSD License.
 
-Copyright © 2013-2014 by Andrei Baibaratsky, Constantin Chuprik.
+Copyright © 2013-2015 by Andrei Baibaratsky, Constantin Chuprik.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 WebMoney API PHP Library
 ========================
+Get transparent object-oriented interaction with WebMoney API.
+
+If you just need to sign your requests to the API, use [WebMoney Signer](https://github.com/baibaratsky/php-wmsigner), a native PHP implementation of the WMSigner authentication module. 
 
 XML-interfaces supported
 ------------------------
@@ -23,10 +26,22 @@ Requirements
 ------------
 The library requires PHP 5.3 compiled with [cURL extension](http://www.php.net/manual/en/book.curl.php) (but you can override cURL dependencies).
 
-To use signing with the WM Keeper Classic keys you have to compile PHP with [BCMath](http://www.php.net/manual/en/book.bc.php) and [GMP](http://www.php.net/manual/en/book.gmp.php) support.
+Installation
+------------
+0. Install [Composer](http://getcomposer.org/):
+
+    ```
+    curl -sS https://getcomposer.org/installer | php
+    ```
+
+0. Add the php-webmoney dependency:
+
+    ```
+    php composer.phar require baibaratsky/php-webmoney:0.9.*
+    ```
 
-Example
--------
+Usage
+-----
 ```php
 require_once(__DIR__ . '/vendor/autoload.php'); // Require autoload file generated by composer
 
@@ -37,9 +52,10 @@ $webMoney = new WebMoney\WebMoney(new WebMoney\Request\Requester\CurlRequester);
 $x9request = new WebMoney\Api\X\X9\Request;
 $x9request->setSignerWmid('your WMID');
 $x9request->setRequestedWmid('requested WMID');
-$x9request->sign(new WebMoney\Request\RequestSigner('wmid', 'key', 'password'));
+$x9request->sign(new WebMoney\Signer('wmid', 'key', 'password'));
 
 if ($x9request->validate()) {
+    /** @var WebMoney\Api\X\X9\Response $x9response */
     $x9response = $webMoney->request($x9request);
 
     if ($x9response->getReturnCode() === 0) {

diff --git a/Request/AbstractRequest.php b/Request/AbstractRequest.php
@@ -2,6 +2,8 @@
 
 namespace baibaratsky\WebMoney\Request;
 
+use baibaratsky\WebMoney\Signer;
+
 abstract class AbstractRequest
 {
     /** @var string */
@@ -33,11 +35,10 @@ public function getUrl()
     }
 
     /**
-     * @param RequestSigner $requestSigner
-     *
-     * @return void
+     * @param Signer $requestSigner
+     * @return
      */
-    abstract public function sign(RequestSigner $requestSigner = null);
+    abstract public function sign(Signer $requestSigner = null);
 
     /**
      * @return array