use contructor injection for email and spam services

Author: zghosts

src/controllers/ContactController.php

@@ -15,33 +15,27 @@ class ContactController extends BaseApiController
      */
     private $spamCheckService;
 
-    public function handle(Request $request, PDO $db)
-    {
-        // really need to not require this to be declared
-    }
-
     /**
-     * @param ContactEmailService $emailService
+     * ContactController constructor.
      *
-     * @return $this
+     * @param ContactEmailService       $emailService
+     * @param SpamCheckServiceInterface $spamCheckService
+     * @param array                     $config
      */
-    public function setEmailService(ContactEmailService $emailService)
-    {
+    public function __construct(
+        ContactEmailService $emailService,
+        SpamCheckServiceInterface $spamCheckService,
+        array $config = []
+    ) {
         $this->emailService = $emailService;
+        $this->spamCheckService = $spamCheckService;
 
-        return $this;
+        parent::__construct($config);
     }
 
-    /**
-     * @param SpamCheckService $spamCheckService
-     *
-     * @return $this
-     */
-    public function setSpamCheckService(SpamCheckService $spamCheckService = null)
+    public function handle(Request $request, PDO $db)
     {
-        $this->spamCheckService = $spamCheckService;
-
-        return $this;
+        // really need to not require this to be declared
     }
 
     /**
@@ -95,17 +89,14 @@ public function contact(Request $request, PDO $db)
             throw new Exception($message, 400);
         }
 
-        // run it by akismet if we have it
-        if (isset($this->spamCheckService)) {
-            $isValid          = $this->spamCheckService->isCommentAcceptable(
-                $data,
-                $request->getClientIP(),
-                $request->getClientUserAgent()
-            );
+        $isValid = $this->spamCheckService->isCommentAcceptable(
+            $data,
+            $request->getClientIP(),
+            $request->getClientUserAgent()
+        );
 
-            if (!$isValid) {
-                throw new Exception("Comment failed spam check", 400);
-            }
+        if (!$isValid) {
+            throw new Exception("Comment failed spam check", 400);
         }
 
         $this->emailService->sendEmail($data);

tests/controllers/ContactControllerTest.php

@@ -10,21 +10,27 @@ class ContactControllerTest extends TestCase
      * @dataProvider dataProvider
      * @test
      *
+     * @param bool  $isClientPermittedPasswordGrant
+     * @param array $returnValueMap
+     * @param bool  $isCommentAcceptable
+     * @param null  $expectedException
+     * @param null  $expectedExceptionMessage
+     * @param bool  $spamShouldBeChecked
+     * @param bool  $emailShouldBeSent
+     *
+     * @throws \Exception
      */
     public function contactWorksAsExpected(
         $isClientPermittedPasswordGrant,
         array $returnValueMap = [],
         $isCommentAcceptable = false,
-        $spamCheckServiceIsSet = false,
-        $emailServiceIsSet = false,
         $expectedException = null,
         $expectedExceptionMessage = null,
+        $spamShouldBeChecked = false,
         $emailShouldBeSent = false
     ) {
         $request = $this->getMockBuilder('\Request')->disableOriginalConstructor()->getMock();
 
-        $contactController = new \ContactController();
-
         $oauthModel = $this->getMockBuilder('\OAuthModel')->disableOriginalConstructor()->getMock();
         $oauthModel->expects($this->once())->method('isClientPermittedPasswordGrant')->willReturn($isClientPermittedPasswordGrant);
         $request->expects($this->once())->method('getOauthModel')->willReturn($oauthModel);
@@ -37,26 +43,22 @@ public function contactWorksAsExpected(
 
         $db = $this->getMockBuilder('\PDO')->disableOriginalConstructor()->getMock();
 
-        if ($spamCheckServiceIsSet) {
-            $spamCheckService = $this->getMockBuilder(\SpamCheckService::class)
-                                     ->disableOriginalConstructor()
-                                     ->getMock();
+        $spamCheckService = $this->getMockBuilder(\SpamCheckServiceInterface::class)
+                                 ->disableOriginalConstructor()
+                                 ->getMock();
 
+        if ($spamShouldBeChecked) {
             $spamCheckService
                 ->expects($this->once())
                 ->method('isCommentAcceptable')
                 ->willReturn($isCommentAcceptable);
-
-            $contactController->setSpamCheckService($spamCheckService);
         }
 
-        if ($emailServiceIsSet) {
-            $emailService = $this->getMockBuilder(\ContactEmailService::class)
-                                 ->disableOriginalConstructor()
-                                 ->getMock();
+        $emailService = $this->getMockBuilder(\ContactEmailService::class)
+                             ->disableOriginalConstructor()
+                             ->getMock();
 
-            $contactController->setEmailService($emailService);
-        }
+        $contactController = new \ContactController($emailService, $spamCheckService);
 
         if (null !== $expectedException) {
             $this->expectException($expectedException);
@@ -102,11 +104,10 @@ public function dataProvider()
                 'isClientPermittedPasswordGrant' => false,
                 'returnValueMap'                 => [],
                 'isCommentAcceptable'            => false,
-                'spamCheckServiceIsSet'          => false,
-                'emailCheckServiceIsSet'         => false,
                 'exceptedException'              => 'Exception',
                 'expectedExceptionMessage'       => 'This client cannot perform this action',
-                'emailShouldBeSent'              => false
+                'emailShouldBeSent'              => false,
+                'spamShouldBeChecked'            => false
             ],
             //Not all required fields are set
             [
@@ -120,8 +121,6 @@ public function dataProvider()
                     ['comment', '', '']
                 ],
                 'isCommentAcceptable'            => false,
-                'spamCheckServiceIsSet'          => false,
-                'emailCheckServiceIsSet'         => true,
                 'exceptedException'              => \Exception::class,
                 'expectedExceptionMessage'       => "The fields 'name', 'email', 'subject', 'comment' are required",
             ],
@@ -138,28 +137,9 @@ public function dataProvider()
                 ],
 
                 'isCommentAcceptable'      => false,
-                'spamCheckServiceIsSet'    => true,
-                'emailCheckServiceIsSet'   => true,
                 'exceptedException'        => \Exception::class,
                 'expectedExceptionMessage' => 'Comment failed spam check',
-            ],
-            //EmailService check throws an exception
-            [
-                'isClientPermittedPasswordGrant' => true,
-                'returnValueMap'                 => [
-                    ['client_id', '', 'client_id'],
-                    ['client_secret', '', 'client_secret'],
-                    ['name', '', 'name'],
-                    ['email', '', 'email'],
-                    ['subject', '', 'subject'],
-                    ['comment', '', 'comment']
-                ],
-                'isCommentAcceptable'            => true,
-                'spamCheckServiceIsSet'          => false,
-                'emailCheckServiceIsSet'         => false,
-                'exceptedException'              => \RuntimeException::class,
-                'expectedExceptionMessage'       => 'The emailservice has not been set',
-                'emailShouldBeSent'              => false
+                'spamShouldBeChecked'            => true,
             ],
             //Email is sent without spamcheck
             [
@@ -173,10 +153,9 @@ public function dataProvider()
                     ['comment', '', 'comment']
                 ],
                 'isCommentAcceptable'            => true,
-                'spamCheckServiceIsSet'          => false,
-                'emailCheckServiceIsSet'         => true,
                 'exceptedException'              => null,
                 'expectedExceptionMessage'       => null,
+                'spamShouldBeChecked'            => true,
                 'emailShouldBeSent'              => true
             ],
             //All is good email should be sent
@@ -191,10 +170,9 @@ public function dataProvider()
                     ['comment', '', 'comment']
                 ],
                 'isCommentAcceptable'            => true,
-                'spamCheckServiceIsSet'          => true,
-                'emailCheckServiceIsSet'         => true,
                 'exceptedException'              => null,
                 'expectedExceptionMessage'       => null,
+                'spamShouldBeChecked'            => true,
                 'emailShouldBeSent'              => true
             ]
         ];