MAGETWO-62556: Subscription Request

Author: akaplya

app/code/Magento/Analytics/Block/Adminhtml/System/Config/SubscriptionStatusLabel.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2013-2017 Magento. All rights reserved.
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Analytics\Block\Adminhtml\System\Config;
@@ -11,6 +11,9 @@
 
 /**
  * Class SubscriptionStatusLabel.
+ *
+ * Provides labels for subscription status
+ * Status can be reviewed in System Configuration
  */
 class SubscriptionStatusLabel extends \Magento\Config\Block\System\Config\Form\Field
 {
@@ -52,6 +55,8 @@ public function render(\Magento\Framework\Data\Form\Element\AbstractElement $ele
     }
 
     /**
+     * Prepare label for subscription status
+     *
      * @return string
      */
     private function prepareLabelValue()

app/code/Magento/Analytics/Controller/Adminhtml/Subscription/Activate.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2013-2017 Magento. All rights reserved.
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 
@@ -17,6 +17,8 @@
 
 /**
  * Class Activate
+ *
+ * Activates subscription with Free Tier program
  */
 class Activate extends Action
 {

app/code/Magento/Analytics/Controller/Adminhtml/Subscription/Postpone.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2013-2017 Magento. All rights reserved.
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 
@@ -17,6 +17,8 @@
 
 /**
  * Class Postpone
+ *
+ * Postpones notification about Free Tier program
  */
 class Postpone extends Action
 {

app/code/Magento/Analytics/Cron/SignUp.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2013-2017 Magento. All rights reserved.
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Analytics\Cron;
@@ -77,7 +77,9 @@ public function __construct(
     }
 
     /**
-     * Method executes by cron
+     * Execute scheduled subscription operation
+     * In case of failure writes message to notifications inbox
+     *
      * @return bool
      */
     public function execute()

app/code/Magento/Analytics/Model/AnalyticsConnector.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2013-2017 Magento. All rights reserved.
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Analytics\Model;
@@ -10,6 +10,8 @@
 
 /**
  * Class AnalyticsConnector
+ *
+ * Connector to MA services, aggregates calls to external services.
  */
 class AnalyticsConnector
 {

app/code/Magento/Analytics/Model/AnalyticsConnector/AnalyticsCommandInterface.php

@@ -1,16 +1,20 @@
 <?php
 /**
- * Copyright © 2013-2017 Magento. All rights reserved.
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Analytics\Model\AnalyticsConnector;
 
 /**
  * Interface AnalyticsCommandInterface
+ * Introduces family of integration calls.
+ * Each implementation represents call to external service.
  */
 interface AnalyticsCommandInterface
 {
     /**
+     * Execute call to external service
+     * Information about destination and arguments appears from config
      * @return void
      */
     public function execute();

app/code/Magento/Analytics/Model/AnalyticsConnector/SignUpCommand.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2013-2017 Magento. All rights reserved.
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Analytics\Model\AnalyticsConnector;
@@ -11,6 +11,8 @@
 
 /**
  * Class SignUpCommand
+ *
+ * SignUp merchant for Free Tier project
  */
 class SignUpCommand implements AnalyticsCommandInterface
 {

app/code/Magento/Analytics/Model/AnalyticsConnector/SignUpRequest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2013-2017 Magento. All rights reserved.
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 
@@ -15,6 +15,9 @@
 
 /**
  * Class SignUpRequest
+ *
+ * Perform direct call to MA services for subscription.
+ * In case of success returns MA access token.
  */
 class SignUpRequest
 {

app/code/Magento/Analytics/Model/AnalyticsToken.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2013-2017 Magento. All rights reserved.
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Analytics\Model;

app/code/Magento/Analytics/Model/Condition/CanViewNotification.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright © 2013-2017 Magento. All rights reserved.
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 
@@ -12,6 +12,9 @@
 
 /**
  * Class CanViewNotification
+ *
+ * Dynamic validator for UI signUp notification form, manage Ui component visibility.
+ * Return true if last notification was shipped seven days ago.
  */
 class CanViewNotification implements ConditionInterface
 {