Merge pull request #978 from magento-mpi/api-coverage

- MAGETWO-65690 Cover Payment module with @api annotation - MAGETWO-66607 Cover OfflinePayments module with @api annotation - MAGETWO-66608 Cover OfflineShipping module with @api annotation - MAGETWO-66609 Cover Vault module with @api annotation
magento · Mar 30, 2017 · bac1ff6 · bac1ff6
2 parents 86d67e4 + d8a4d0e
commit bac1ff6
Show file tree

Hide file tree

Showing 91 changed files with 272 additions and 41 deletions.
diff --git a/app/code/Magento/OfflinePayments/Model/Banktransfer.php b/app/code/Magento/OfflinePayments/Model/Banktransfer.php
@@ -9,6 +9,8 @@
  * Bank Transfer payment method model
  *
  * @method \Magento\Quote\Api\Data\PaymentMethodExtensionInterface getExtensionAttributes()
+ *
+ * @api
  */
 class Banktransfer extends \Magento\Payment\Model\Method\AbstractMethod
 {

diff --git a/app/code/Magento/OfflinePayments/Model/Cashondelivery.php b/app/code/Magento/OfflinePayments/Model/Cashondelivery.php
@@ -9,6 +9,8 @@
  * Cash on delivery payment method model
  *
  * @method \Magento\Quote\Api\Data\PaymentMethodExtensionInterface getExtensionAttributes()
+ *
+ * @api
  */
 class Cashondelivery extends \Magento\Payment\Model\Method\AbstractMethod
 {

diff --git a/app/code/Magento/OfflinePayments/Model/Checkmo.php b/app/code/Magento/OfflinePayments/Model/Checkmo.php
@@ -9,6 +9,8 @@
  * Class Checkmo
  *
  * @method \Magento\Quote\Api\Data\PaymentMethodExtensionInterface getExtensionAttributes()
+ *
+ * @api
  */
 class Checkmo extends \Magento\Payment\Model\Method\AbstractMethod
 {

diff --git a/app/code/Magento/OfflinePayments/Model/Purchaseorder.php b/app/code/Magento/OfflinePayments/Model/Purchaseorder.php
@@ -9,6 +9,8 @@
  * Class Purchaseorder
  *
  * @method \Magento\Quote\Api\Data\PaymentMethodExtensionInterface getExtensionAttributes()
+ *
+ * @api
  */
 class Purchaseorder extends \Magento\Payment\Model\Method\AbstractMethod
 {

diff --git a/.../OfflinePayments/view/frontend/web/js/view/payment/method-renderer/banktransfer-method.js b/.../OfflinePayments/view/frontend/web/js/view/payment/method-renderer/banktransfer-method.js
@@ -3,6 +3,7 @@
  * See COPYING.txt for license details.
  */
 
+/* @api */
 define([
     'ko',
     'Magento_Checkout/js/view/payment/default'

diff --git a/...fflinePayments/view/frontend/web/js/view/payment/method-renderer/cashondelivery-method.js b/...fflinePayments/view/frontend/web/js/view/payment/method-renderer/cashondelivery-method.js
@@ -3,6 +3,7 @@
  * See COPYING.txt for license details.
  */
 
+/* @api */
 define([
     'Magento_Checkout/js/view/payment/default'
 ], function (Component) {

diff --git a/...gento/OfflinePayments/view/frontend/web/js/view/payment/method-renderer/checkmo-method.js b/...gento/OfflinePayments/view/frontend/web/js/view/payment/method-renderer/checkmo-method.js
@@ -3,6 +3,7 @@
  * See COPYING.txt for license details.
  */
 
+/* @api */
 define([
     'Magento_Checkout/js/view/payment/default'
 ], function (Component) {

diff --git a/...OfflinePayments/view/frontend/web/js/view/payment/method-renderer/purchaseorder-method.js b/...OfflinePayments/view/frontend/web/js/view/payment/method-renderer/purchaseorder-method.js
@@ -3,6 +3,7 @@
  * See COPYING.txt for license details.
  */
 
+/* @api */
 define([
     'Magento_Checkout/js/view/payment/default',
     'jquery',

diff --git a/app/code/Magento/OfflinePayments/view/frontend/web/js/view/payment/offline-payments.js b/app/code/Magento/OfflinePayments/view/frontend/web/js/view/payment/offline-payments.js
@@ -3,6 +3,7 @@
  * See COPYING.txt for license details.
  */
 
+/* @api */
 define([
     'uiComponent',
     'Magento_Checkout/js/model/payment/renderer-list'

diff --git a/app/code/Magento/OfflineShipping/Model/Carrier/Flatrate.php b/app/code/Magento/OfflineShipping/Model/Carrier/Flatrate.php
@@ -13,6 +13,8 @@
 
 /**
  * Flat rate shipping model
+ *
+ * @api
  */
 class Flatrate extends AbstractCarrier implements CarrierInterface
 {

diff --git a/app/code/Magento/OfflineShipping/Model/Carrier/Freeshipping.php b/app/code/Magento/OfflineShipping/Model/Carrier/Freeshipping.php
@@ -13,6 +13,11 @@
 
 use Magento\Quote\Model\Quote\Address\RateRequest;
 
+/**
+ * Free shipping model
+ *
+ * @api
+ */
 class Freeshipping extends \Magento\Shipping\Model\Carrier\AbstractCarrier implements
     \Magento\Shipping\Model\Carrier\CarrierInterface
 {

diff --git a/app/code/Magento/OfflineShipping/Model/Carrier/Pickup.php b/app/code/Magento/OfflineShipping/Model/Carrier/Pickup.php
@@ -7,6 +7,11 @@
 
 use Magento\Quote\Model\Quote\Address\RateRequest;
 
+/**
+ * Pickup shipping model
+ *
+ * @api
+ */
 class Pickup extends \Magento\Shipping\Model\Carrier\AbstractCarrier implements
     \Magento\Shipping\Model\Carrier\CarrierInterface
 {
@@ -54,34 +59,12 @@ public function __construct(
     /**
      * @param RateRequest $request
      * @return \Magento\Shipping\Model\Rate\Result
-     * @SuppressWarnings(PHPMD.UnusedLocalVariable)
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function collectRates(RateRequest $request)
     {
-        if (!$this->getConfigFlag('active')) {
-            return false;
-        }
-
-        /** @var \Magento\Shipping\Model\Rate\Result $result */
-        $result = $this->_rateResultFactory->create();
-
-        if (!empty($rate)) {
-            /** @var \Magento\Quote\Model\Quote\Address\RateResult\Method $method */
-            $method = $this->_rateMethodFactory->create();
-
-            $method->setCarrier('pickup');
-            $method->setCarrierTitle($this->getConfigData('title'));
-
-            $method->setMethod('store');
-            $method->setMethodTitle(__('Store Pickup'));
-
-            $method->setPrice(0);
-            $method->setCost(0);
-
-            $result->append($method);
-        }
-
-        return $result;
+        // Pickup shipping method is not supported in Magento2 yet.
+        return false;
     }
 
     /**

diff --git a/app/code/Magento/OfflineShipping/Model/Carrier/Tablerate.php b/app/code/Magento/OfflineShipping/Model/Carrier/Tablerate.php
@@ -8,6 +8,11 @@
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Quote\Model\Quote\Address\RateRequest;
 
+/**
+ * Table rate shipping model
+ *
+ * @api
+ */
 class Tablerate extends \Magento\Shipping\Model\Carrier\AbstractCarrier implements
     \Magento\Shipping\Model\Carrier\CarrierInterface
 {

diff --git a/app/code/Magento/OfflineShipping/Model/Config/Source/Flatrate.php b/app/code/Magento/OfflineShipping/Model/Config/Source/Flatrate.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\OfflineShipping\Model\Config\Source;
 
+/**
+ * @api
+ */
 class Flatrate implements \Magento\Framework\Option\ArrayInterface
 {
     /**

diff --git a/app/code/Magento/OfflineShipping/Model/Config/Source/Tablerate.php b/app/code/Magento/OfflineShipping/Model/Config/Source/Tablerate.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\OfflineShipping\Model\Config\Source;
 
+/**
+ * @api
+ */
 class Tablerate implements \Magento\Framework\Option\ArrayInterface
 {
     /**

diff --git a/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate.php b/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate.php
@@ -20,6 +20,8 @@
 /**
  * @SuppressWarnings(PHPMD.TooManyFields)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ *
+ * @api
  */
 class Tablerate extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
 {

diff --git a/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate/Collection.php b/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate/Collection.php
@@ -8,7 +8,7 @@
 /**
  * Shipping table rates collection
  *
- * @author     Magento Core Team <[email protected]>
+ * @api
  */
 class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection
 {

diff --git a/app/code/Magento/OfflineShipping/Model/SalesRule/Calculator.php b/app/code/Magento/OfflineShipping/Model/SalesRule/Calculator.php
@@ -13,6 +13,9 @@
 
 use Magento\SalesRule\Model\Validator;
 
+/**
+ * @api
+ */
 class Calculator extends Validator
 {
     /**

diff --git a/app/code/Magento/OfflineShipping/Model/SalesRule/Rule.php b/app/code/Magento/OfflineShipping/Model/SalesRule/Rule.php
@@ -11,6 +11,9 @@
  */
 namespace Magento\OfflineShipping\Model\SalesRule;
 
+/**
+ * @api
+ */
 class Rule
 {
     /**

diff --git a/app/code/Magento/OfflineShipping/Model/Source/SalesRule/FreeShippingOptions.php b/app/code/Magento/OfflineShipping/Model/Source/SalesRule/FreeShippingOptions.php
@@ -8,6 +8,9 @@
 use Magento\Framework\Data\OptionSourceInterface;
 use Magento\OfflineShipping\Model\SalesRule\Rule;
 
+/**
+ * @api
+ */
 class FreeShippingOptions implements OptionSourceInterface
 {
     /**

diff --git a/app/code/Magento/Payment/Block/Adminhtml/Transparent/Form.php b/app/code/Magento/Payment/Block/Adminhtml/Transparent/Form.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Payment\Block\Adminhtml\Transparent;
 
+/**
+ * @api
+ */
 class Form extends \Magento\Payment\Block\Transparent\Form
 {
     /**

diff --git a/app/code/Magento/Payment/Block/Form.php b/app/code/Magento/Payment/Block/Form.php
@@ -9,6 +9,8 @@
 
 /**
  * Payment method form base block
+ *
+ * @api
  */
 class Form extends \Magento\Framework\View\Element\Template
 {

diff --git a/app/code/Magento/Payment/Block/Form/Cc.php b/app/code/Magento/Payment/Block/Form/Cc.php
@@ -5,6 +5,9 @@
  */
 namespace Magento\Payment\Block\Form;
 
+/**
+ * @api
+ */
 class Cc extends \Magento\Payment\Block\Form
 {
     /**

diff --git a/app/code/Magento/Payment/Block/Form/Container.php b/app/code/Magento/Payment/Block/Form/Container.php
@@ -13,7 +13,7 @@
  *
  * @method \Magento\Quote\Model\Quote getQuote()
  *
- * @author      Magento Core Team <[email protected]>
+ * @api
  */
 class Container extends \Magento\Framework\View\Element\Template
 {

diff --git a/app/code/Magento/Payment/Block/Info.php b/app/code/Magento/Payment/Block/Info.php
@@ -7,6 +7,8 @@
 
 /**
  * Base payment iformation block
+ *
+ * @api
  */
 class Info extends \Magento\Framework\View\Element\Template
 {

diff --git a/app/code/Magento/Payment/Block/Info/AbstractContainer.php b/app/code/Magento/Payment/Block/Info/AbstractContainer.php
@@ -8,7 +8,7 @@
 /**
  * Payment information container block
  *
- * @author      Magento Core Team <[email protected]>
+ * @api
  */
 abstract class AbstractContainer extends \Magento\Framework\View\Element\Template
 {

diff --git a/app/code/Magento/Payment/Block/Info/Cc.php b/app/code/Magento/Payment/Block/Info/Cc.php
@@ -7,6 +7,8 @@
 
 /**
  * Credit card generic payment info
+ *
+ * @api
  */
 class Cc extends \Magento\Payment\Block\Info
 {

diff --git a/app/code/Magento/Payment/Block/Info/Instructions.php b/app/code/Magento/Payment/Block/Info/Instructions.php
@@ -7,6 +7,8 @@
 
 /**
  * Block for Bank Transfer payment generic info
+ *
+ * @api
  */
 class Instructions extends \Magento\Payment\Block\Info
 {

diff --git a/app/code/Magento/Payment/Block/Transparent/Form.php b/app/code/Magento/Payment/Block/Transparent/Form.php
@@ -15,7 +15,7 @@
 /**
  * Transparent form block
  *
- * @author     Magento Core Team <[email protected]>
+ * @api
  */
 class Form extends \Magento\Payment\Block\Form\Cc
 {

diff --git a/app/code/Magento/Payment/Block/Transparent/Iframe.php b/app/code/Magento/Payment/Block/Transparent/Iframe.php
@@ -8,7 +8,7 @@
 /**
  * Iframe block for register specific params in layout
  *
- * @author     Magento Core Team <[email protected]>
+ * @api
  */
 class Iframe extends \Magento\Framework\View\Element\Template
 {

diff --git a/app/code/Magento/Payment/Block/Transparent/Info.php b/app/code/Magento/Payment/Block/Transparent/Info.php
@@ -7,7 +7,8 @@
 
 /**
  * Class Info. Payment Information block used for transparent redirect feature
- * @package Magento\Payment\Block\Transparent
+ *
+ * @api
  */
 class Info extends \Magento\Framework\View\Element\Template
 {

diff --git a/app/code/Magento/Payment/Gateway/Command/NullCommand.php b/app/code/Magento/Payment/Gateway/Command/NullCommand.php
@@ -8,10 +8,18 @@
 use Magento\Payment\Gateway\Command;
 use Magento\Payment\Gateway\CommandInterface;
 
+/**
+ * Null command. Does nothing.
+ *
+ * Use this class as an implementation of CommandInterface to ignore some action
+ * or in case if command invoked by Magento has no sense for payment method.
+ *
+ * @api
+ */
 class NullCommand implements CommandInterface
 {
     /**
-     * Null command. Does nothing. Stable.
+     * Process command without any side effect.
      *
      * @param array $commandSubject
      *

diff --git a/app/code/Magento/Payment/Gateway/Command/Result/ArrayResult.php b/app/code/Magento/Payment/Gateway/Command/Result/ArrayResult.php
@@ -7,6 +7,11 @@
 
 use Magento\Payment\Gateway\Command\ResultInterface;
 
+/**
+ * Container for array that should be returned as command result.
+ *
+ * @api
+ */
 class ArrayResult implements ResultInterface
 {
     /**

diff --git a/app/code/Magento/Payment/Gateway/Command/Result/BoolResult.php b/app/code/Magento/Payment/Gateway/Command/Result/BoolResult.php
@@ -8,7 +8,9 @@
 use Magento\Payment\Gateway\Command\ResultInterface;
 
 /**
- * Class BoolResult
+ * Container for boolean value that should be returned as command result.
+ *
+ * @api
  */
 class BoolResult implements ResultInterface
 {

diff --git a/app/code/Magento/Payment/Gateway/Config/Config.php b/app/code/Magento/Payment/Gateway/Config/Config.php
@@ -9,6 +9,13 @@
 use Magento\Payment\Gateway\ConfigInterface;
 use Magento\Store\Model\ScopeInterface;
 
+/**
+ * Default implementation of Payment Gateway Config.
+ *
+ * To process value retrieved from config implementation of \Magento\Payment\Gateway\Config\ValueHandlerInterface
+ * should be used (inheritance and overriding of getValue method or introduction of new public methods
+ * is not recommended).
+ */
 class Config implements ConfigInterface
 {
     const DEFAULT_PATH_PATTERN = 'payment/%s/%s';

diff --git a/app/code/Magento/Payment/Gateway/Config/ConfigValueHandler.php b/app/code/Magento/Payment/Gateway/Config/ConfigValueHandler.php
@@ -8,6 +8,13 @@
 use Magento\Payment\Gateway\ConfigInterface;
 use Magento\Payment\Gateway\Helper\SubjectReader;
 
+/**
+ * Default implementation of config value handler.
+ *
+ * This class is designed to be injected into other classes. Inheritance in not recommended.
+ *
+ * @api
+ */
 class ConfigValueHandler implements ValueHandlerInterface
 {
     /**