Prepare bundle for unit testing (#14)

* Add phpunit * Apply fixes from StyleCI * Fix version matrix * Compatibility with Swiftmailer 6.0.1 * Upgrade phpunit * Make style ci happy
fourlabsldn · Apr 3, 2018 · 0334180 · 0334180
1 parent 62ccd1e
commit 0334180
Show file tree

Hide file tree

Showing 18 changed files with 126 additions and 44 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,12 @@
+language: php
+
+matrix:
+  include:
+    - php: 7.1
+      env: SWIFT_VERSION=~6.0.0
+    - php: 7.1
+      env: SWIFT_VERSION=~5.4.0
+
+before_script:
+  - composer require "swiftmailer/swiftmailer:${SWIFT_VERSION}" --no-update
+  - composer install --no-interaction --dev
diff --git a/Factory/GmailMessageFactory.php b/Factory/GmailMessageFactory.php
@@ -60,12 +60,15 @@ public function createFromGmailApiMessage(\Google_Service_Gmail_Message $gmailAp
             switch ($header->getName()) {
                 case 'From':
                     $message->setFrom($header->getValue() ?? '');
+
                     break;
                 case 'To':
                     $message->setTo($header->getValue() ?? '');
+
                     break;
                 case 'Subject':
                     $message->setSubject($header->getValue() ?? '');
+
                     break;
             }
             $headerNames[] = $header->getName();

diff --git a/Model/Collection/GmailDomain.php b/Model/Collection/GmailDomain.php
@@ -39,7 +39,7 @@ public function __construct(string $domain)
      *
      * @return GmailDomain
      */
-    public function addGmailUser(GmailUserInterface $user): GmailDomain
+    public function addGmailUser(GmailUserInterface $user): self
     {
         $this->gmailUsers->attach($user);
 
@@ -51,7 +51,7 @@ public function addGmailUser(GmailUserInterface $user): GmailDomain
      *
      * @return GmailDomain
      */
-    public function removeGmailUser(GmailUserInterface $user): GmailDomain
+    public function removeGmailUser(GmailUserInterface $user): self
     {
         $this->gmailUsers->detach($user);
 

diff --git a/Model/Collection/GmailLabelCollection.php b/Model/Collection/GmailLabelCollection.php
@@ -30,7 +30,7 @@ public function __construct()
      *
      * @return GmailLabelCollection
      */
-    public function addLabel(GmailLabelInterface $label): GmailLabelCollection
+    public function addLabel(GmailLabelInterface $label): self
     {
         $this->labels->attach($label);
 
@@ -42,7 +42,7 @@ public function addLabel(GmailLabelInterface $label): GmailLabelCollection
      *
      * @return GmailLabelCollection
      */
-    public function removeLabel(GmailLabelInterface $label): GmailLabelCollection
+    public function removeLabel(GmailLabelInterface $label): self
     {
         $this->labels->detach($label);
 

diff --git a/Model/Collection/GmailMessageCollection.php b/Model/Collection/GmailMessageCollection.php
@@ -29,7 +29,7 @@ public function __construct()
      *
      * @return GmailMessageCollection
      */
-    public function addMessage(GmailMessageInterface $message): GmailMessageCollection
+    public function addMessage(GmailMessageInterface $message): self
     {
         $this->messages->attach($message);
 
@@ -41,7 +41,7 @@ public function addMessage(GmailMessageInterface $message): GmailMessageCollecti
      *
      * @return GmailMessageCollection
      */
-    public function removeMessage(GmailMessageInterface $message): GmailMessageCollection
+    public function removeMessage(GmailMessageInterface $message): self
     {
         $this->messages->detach($message);
 

diff --git a/Model/GmailHistoryInterface.php b/Model/GmailHistoryInterface.php
@@ -15,7 +15,7 @@ interface GmailHistoryInterface
      *
      * @return GmailHistoryInterface
      */
-    public function setUserId(string $userId): GmailHistoryInterface;
+    public function setUserId(string $userId): self;
 
     /**
      * @return string
@@ -27,7 +27,7 @@ public function getUserId(): string;
      *
      * @return GmailHistoryInterface
      */
-    public function setDomain(string $domain): GmailHistoryInterface;
+    public function setDomain(string $domain): self;
 
     /**
      * @return string
@@ -39,7 +39,7 @@ public function getDomain(): string;
      *
      * @return GmailHistoryInterface
      */
-    public function setHistoryId(int $historyId): GmailHistoryInterface;
+    public function setHistoryId(int $historyId): self;
 
     /**
      * @return int

diff --git a/Model/GmailIdsInterface.php b/Model/GmailIdsInterface.php
@@ -15,7 +15,7 @@ interface GmailIdsInterface
      *
      * @return GmailIdsInterface
      */
-    public function setUserId(string $userId): GmailIdsInterface;
+    public function setUserId(string $userId): self;
 
     /**
      * @return string
@@ -27,7 +27,7 @@ public function getUserId(): string;
      *
      * @return GmailIdsInterface
      */
-    public function setDomain(string $domain): GmailIdsInterface;
+    public function setDomain(string $domain): self;
 
     /**
      * @return string
@@ -42,7 +42,7 @@ public function getDomain(): string;
      *
      * @return GmailIdsInterface
      */
-    public function setGmailIds(array $gmailIds): GmailIdsInterface;
+    public function setGmailIds(array $gmailIds): self;
 
     /**
      * The limit parameter allows you to retrieve a slice of the gmailIds.

diff --git a/Model/GmailLabelInterface.php b/Model/GmailLabelInterface.php
@@ -15,7 +15,7 @@ interface GmailLabelInterface
      *
      * @return GmailLabelInterface
      */
-    public function setUserId(string $userId): GmailLabelInterface;
+    public function setUserId(string $userId): self;
 
     /**
      * @return string
@@ -27,7 +27,7 @@ public function getUserId(): string;
      *
      * @return GmailLabelInterface
      */
-    public function setDomain(string $domain): GmailLabelInterface;
+    public function setDomain(string $domain): self;
 
     /**
      * @return string
@@ -39,7 +39,7 @@ public function getDomain(): string;
      *
      * @return GmailLabelInterface
      */
-    public function setName(string $name): GmailLabelInterface;
+    public function setName(string $name): self;
 
     /**
      * @return string

diff --git a/Model/GmailMessageInterface.php b/Model/GmailMessageInterface.php
@@ -16,16 +16,19 @@ interface GmailMessageInterface
      * @see https://developers.google.com/gmail/api/guides/labels
      */
     const LABEL_UNREAD = 'UNREAD';
+
     const LABEL_INBOX = 'INBOX';
+
     const LABEL_SENT = 'SENT';
+
     const LABEL_TRASH = 'TRASH';
 
     /**
      * @param string $gmailId
      *
      * @return GmailMessageInterface
      */
-    public function setGmailId(string $gmailId): GmailMessageInterface;
+    public function setGmailId(string $gmailId): self;
 
     /**
      * @return string
@@ -37,7 +40,7 @@ public function getGmailId(): string;
      *
      * @return GmailMessageInterface
      */
-    public function setDomain(string $domain): GmailMessageInterface;
+    public function setDomain(string $domain): self;
 
     /**
      * @return string
@@ -49,7 +52,7 @@ public function getDomain(): string;
      *
      * @return GmailMessageInterface
      */
-    public function setThreadId(string $threadId): GmailMessageInterface;
+    public function setThreadId(string $threadId): self;
 
     /**
      * @return string
@@ -61,7 +64,7 @@ public function getThreadId(): string;
      *
      * @return GmailMessageInterface
      */
-    public function setHistoryId(string $historyId): GmailMessageInterface;
+    public function setHistoryId(string $historyId): self;
 
     /**
      * @return string
@@ -73,7 +76,7 @@ public function getHistoryId(): string;
      *
      * @return GmailMessageInterface
      */
-    public function setUserId(string $userId): GmailMessageInterface;
+    public function setUserId(string $userId): self;
 
     /**
      * @return string
@@ -88,7 +91,7 @@ public function getUserId(): string;
      *
      * @return GmailMessageInterface
      */
-    public function setTo(string $to): GmailMessageInterface;
+    public function setTo(string $to): self;
 
     /**
      * @return string
@@ -111,7 +114,7 @@ public function getToCanonical(): string;
      *
      * @return GmailMessageInterface
      */
-    public function setFrom(string $from): GmailMessageInterface;
+    public function setFrom(string $from): self;
 
     /**
      * @return string
@@ -138,7 +141,7 @@ public function getReplyAllRecipients(): string;
      *
      * @return GmailMessageInterface
      */
-    public function setSentAt(\DateTimeInterface  $sentAt): GmailMessageInterface;
+    public function setSentAt(\DateTimeInterface  $sentAt): self;
 
     /**
      * @return \DateTimeInterface
@@ -150,7 +153,7 @@ public function getSentAt(): \DateTimeInterface;
      *
      * @return GmailMessageInterface
      */
-    public function setSubject(string $subject): GmailMessageInterface;
+    public function setSubject(string $subject): self;
 
     /**
      * @return string
@@ -162,7 +165,7 @@ public function getSubject(): string;
      *
      * @return GmailMessageInterface
      */
-    public function setSnippet(string $snippet): GmailMessageInterface;
+    public function setSnippet(string $snippet): self;
 
     /**
      * @return string
@@ -180,7 +183,7 @@ public function getSnippet(): string;
      *
      * @return GmailMessageInterface
      */
-    public function setBodyPlainTextFromApiMessage(\Google_Service_Gmail_Message $gmailApiMessage): GmailMessageInterface;
+    public function setBodyPlainTextFromApiMessage(\Google_Service_Gmail_Message $gmailApiMessage): self;
 
     /**
      * @return string
@@ -192,7 +195,7 @@ public function getBodyPlainText(): string;
      *
      * @return GmailMessageInterface
      */
-    public function setBodyPlainText(string $bodyPlainText): GmailMessageInterface;
+    public function setBodyPlainText(string $bodyPlainText): self;
 
     /**
      * Set from a \Google_Service_Gmail_Message (from the API).
@@ -205,14 +208,14 @@ public function setBodyPlainText(string $bodyPlainText): GmailMessageInterface;
      *
      * @return GmailMessageInterface
      */
-    public function setBodyHtmlFromApiMessage(\Google_Service_Gmail_Message $gmailApiMessage): GmailMessageInterface;
+    public function setBodyHtmlFromApiMessage(\Google_Service_Gmail_Message $gmailApiMessage): self;
 
     /**
      * @param string $bodyHtml
      *
      * @return GmailMessageInterface
      */
-    public function setBodyHtml(string $bodyHtml): GmailMessageInterface;
+    public function setBodyHtml(string $bodyHtml): self;
 
     /**
      * @return string
@@ -224,7 +227,7 @@ public function getBodyHtml(): string;
      *
      * @return GmailMessageInterface
      */
-    public function addLabel(GmailLabelInterface $label): GmailMessageInterface;
+    public function addLabel(GmailLabelInterface $label): self;
 
     /**
      * @return \Traversable
@@ -236,12 +239,12 @@ public function getLabels(): \Traversable;
      *
      * @return GmailMessageInterface
      */
-    public function removeLabel(GmailLabelInterface $label): GmailMessageInterface;
+    public function removeLabel(GmailLabelInterface $label): self;
 
     /**
      * @return GmailMessageInterface
      */
-    public function clearLabels(): GmailMessageInterface;
+    public function clearLabels(): self;
 
     /**
      * @param string $name

diff --git a/Model/GmailUserInterface.php b/Model/GmailUserInterface.php
@@ -20,7 +20,7 @@ public function getUserId(): string;
      *
      * @return GmailUserInterface
      */
-    public function setUserId(string $userId): GmailUserInterface;
+    public function setUserId(string $userId): self;
 
     /**
      * @return string
@@ -32,7 +32,7 @@ public function getPrimaryEmailAddress(): string;
      *
      * @return GmailUserInterface
      */
-    public function setPrimaryEmailAddress(string $primaryEmailAddress): GmailUserInterface;
+    public function setPrimaryEmailAddress(string $primaryEmailAddress): self;
 
     /**
      * @return string[]
@@ -44,14 +44,14 @@ public function getEmailAliases(): array;
      *
      * @return GmailUserInterface
      */
-    public function addEmailAlias(string $emailAlias): GmailUserInterface;
+    public function addEmailAlias(string $emailAlias): self;
 
     /**
      * @param string $emailAlias
      *
      * @return GmailUserInterface
      */
-    public function removeEmailAlias(string $emailAlias): GmailUserInterface;
+    public function removeEmailAlias(string $emailAlias): self;
 
     /**
      * Should return email aliases, plus primary email address.

diff --git a/Services/Directory.php b/Services/Directory.php
@@ -17,7 +17,9 @@
 class Directory
 {
     const MODE_RESOLVE_PRIMARY_ONLY = 0;
+
     const MODE_RESOLVE_ALIASES_ONLY = 1;
+
     const MODE_RESOLVE_PRIMARY_PLUS_ALIASES = 2;
 
     /**
@@ -178,14 +180,17 @@ public function resolveUserIdFromEmail(string $email, int $mode)
         switch ($mode) {
             case self::MODE_RESOLVE_PRIMARY_ONLY:
                 $gmailUser = $this->getGmailDomain()->findGmailUserByPrimaryEmail($email);
+
                 break;
 
             case self::MODE_RESOLVE_ALIASES_ONLY:
                 $gmailUser = $this->getGmailDomain()->findGmailUserByEmailAlias($email);
+
                 break;
 
             case self::MODE_RESOLVE_PRIMARY_PLUS_ALIASES:
                 $gmailUser = $this->getGmailDomain()->findGmailUserByEmail($email);
+
                 break;
 
             default: