Added tests and changed docs.

Author: =

.phpunit.result.cache

@@ -1 +1 @@
-{"version":1,"defects":{"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::configurationFileNameIsCorrectlySet":3,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SetupTrackingCommandTest::somerandomtest":1,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCanBeInitialized":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::validationsWorkCorrectlyWithTheRightData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::validationsWorkCorrectlyWithTheWrongData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::cliValidationWorksAsExpectedWithTheCorrectData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SubscriptionManagerTest::returnedDataIsCorrect":3,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::webhooksManagerCanGetData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::returnedDataIsCorrect":3,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::validationsWorkCorrectlyWithTheRightData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::validationsWorkCorrectlyWithTheWrongData":3,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCanCreateConfigurationSet":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::validationsWorkCorrectlyWithTheRightData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::validationsWorkCorrectlyWithTheWrongData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::confirmRouteInfoPrintsTheCorrectDataToConsole":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateConfigurationPrintsCorrectlyInDebugMode":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateConfigurationSetMethodWorksCorrectlyInLiveMode":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerConfirmNamingConventionPrintsCorrectly":4},"times":{"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::awsCredentialsContractIsBound":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::subscriptionContractIsBound":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::webhooksContractIsBound":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::snsDataContractIsBound":0.005,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::sesDataContractIsBound":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::configurationFileNameIsCorrectlySet":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SetupTrackingCommandTest::somerandomtest":0.049,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCanBeInitialized":0.036,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::awsCredentialsManagerCanGetCredentials":0.05,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::returnedCredentialsAreCorrect":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::validationsWorkCorrectlyWithTheRightData":0.012,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::validationsWorkCorrectlyWithTheWrongData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::cliValidationWorksAsExpectedWithTheCorrectData":0.049,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SubscriptionManagerTest::subscriptionManagerCanGetSubscriptionData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SubscriptionManagerTest::returnedDataIsCorrect":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SubscriptionManagerTest::validationsWorkCorrectlyWithTheRightData":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SubscriptionManagerTest::validationsWorkCorrectlyWithTheWrongData":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::webhooksManagerCanGetData":0.005,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::returnedDataIsCorrect":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::validationsWorkCorrectlyWithTheRightData":0.005,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::validationsWorkCorrectlyWithTheWrongData":0.005,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::sesDataManagerCanGetData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::returnedDataIsCorrect":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::validationsWorkCorrectlyWithTheRightData":0.005,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::validationsWorkCorrectlyWithTheWrongData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::snsDataManagerCanGetData":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::returnedDataIsCorrect":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::validationsWorkCorrectlyWithTheRightData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::validationsWorkCorrectlyWithTheWrongData":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCanCreateConfigurationSet":0.141,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsManagerTest::snsManagerCanBeInitialized":0.008,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::confirmRouteInfoPrintsTheCorrectDataToConsole":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::configurationSetIsSetCorrectly":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateConfigurationPrintsCorrectlyInDebugMode":0.11,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateConfigurationSetMethodWorksCorrectlyInLiveMode":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateConfigurationSetMethodPrintsCorrectlyInDebugMode":0.006,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerConfirmNamingConventionPrintsCorrectly":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerConfirmNamingConventionThrowsExceptionOnEmptyName":0.006,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::topicConfigurationDataIsSetCorrectly":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::subscriptionConfigurationDataIsSetCorrectly":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::configurationSetDataIsSetCorrectly":0.004}}
+{"version":1,"defects":{"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::configurationFileNameIsCorrectlySet":3,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SetupTrackingCommandTest::somerandomtest":1,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCanBeInitialized":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::validationsWorkCorrectlyWithTheRightData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::validationsWorkCorrectlyWithTheWrongData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::cliValidationWorksAsExpectedWithTheCorrectData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SubscriptionManagerTest::returnedDataIsCorrect":3,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::webhooksManagerCanGetData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::returnedDataIsCorrect":3,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::validationsWorkCorrectlyWithTheRightData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::validationsWorkCorrectlyWithTheWrongData":3,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCanCreateConfigurationSet":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::validationsWorkCorrectlyWithTheRightData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::validationsWorkCorrectlyWithTheWrongData":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::confirmRouteInfoPrintsTheCorrectDataToConsole":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateConfigurationPrintsCorrectlyInDebugMode":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateConfigurationSetMethodWorksCorrectlyInLiveMode":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerConfirmNamingConventionPrintsCorrectly":4,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateEventDestinationPrintsCorrectlyInDebugMode":4},"times":{"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::awsCredentialsContractIsBound":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::subscriptionContractIsBound":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::webhooksContractIsBound":0.005,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::snsDataContractIsBound":0.005,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::sesDataContractIsBound":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\PackageServiceProviderTest::configurationFileNameIsCorrectlySet":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SetupTrackingCommandTest::somerandomtest":0.049,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCanBeInitialized":0.119,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::awsCredentialsManagerCanGetCredentials":0.175,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::returnedCredentialsAreCorrect":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::validationsWorkCorrectlyWithTheRightData":0.029,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::validationsWorkCorrectlyWithTheWrongData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\AwsCredentialsManagerTest::cliValidationWorksAsExpectedWithTheCorrectData":0.049,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SubscriptionManagerTest::subscriptionManagerCanGetSubscriptionData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SubscriptionManagerTest::returnedDataIsCorrect":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SubscriptionManagerTest::validationsWorkCorrectlyWithTheRightData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SubscriptionManagerTest::validationsWorkCorrectlyWithTheWrongData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::webhooksManagerCanGetData":0.008,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::returnedDataIsCorrect":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::validationsWorkCorrectlyWithTheRightData":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::validationsWorkCorrectlyWithTheWrongData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::sesDataManagerCanGetData":0.005,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::returnedDataIsCorrect":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::validationsWorkCorrectlyWithTheRightData":0.006,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::validationsWorkCorrectlyWithTheWrongData":0.005,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::snsDataManagerCanGetData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::returnedDataIsCorrect":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::validationsWorkCorrectlyWithTheRightData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::validationsWorkCorrectlyWithTheWrongData":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCanCreateConfigurationSet":0.141,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsManagerTest::snsManagerCanBeInitialized":0.032,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\WebhooksManagerTest::confirmRouteInfoPrintsTheCorrectDataToConsole":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::configurationSetIsSetCorrectly":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateConfigurationPrintsCorrectlyInDebugMode":0.11,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateConfigurationSetMethodWorksCorrectlyInLiveMode":0.025,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateConfigurationSetMethodPrintsCorrectlyInDebugMode":0.031,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerConfirmNamingConventionPrintsCorrectly":0.024,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerConfirmNamingConventionThrowsExceptionOnEmptyName":0.021,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::topicConfigurationDataIsSetCorrectly":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SnsDataManagerTest::subscriptionConfigurationDataIsSetCorrectly":0.004,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesDataManagerTest::configurationSetDataIsSetCorrectly":0.003,"Akhan619\\LaravelSesTracking\\Tests\\Unit\\SesManagerTest::sesManagerCreateEventDestinationPrintsCorrectlyInDebugMode":0.045}}

changelog.md

@@ -1,31 +1,51 @@
 # Changelog
 
-All notable changes to `LaravelSesTracking` will be documented in this file.
+All notable changes to `Laravel Ses Tracking` will be documented in this file.
+
+## Version 1.0.7
+
+### Changed
+- Improved the code coverage of the tests.
+- Improved Readme.md
+- Fixed typos in docs.
 
 ## Version 1.0.6
+
+### Changed
 - Improved the code coverage of the tests.
 
 ## Version 1.0.5
+
+### Added
 - StyleCI prettiness.
 
 ## Version 1.0.4
+
+### Added
 - Added tests to the project.
+
+### Fixed
 - Changed badge style as old style wans't working for downloads.
 
 ## Version 1.0.3
-- Fixed text in readme.md to correct 'hard-bounces' to 'bounces'
+
+### Added
 - Added badges to readme.md
 
+### Fixed
+- Fixed text in readme.md to correct 'hard-bounces' to 'bounces'
+
 ## Version 1.0.2
+
+### Added
 - Added StyleCI prettiness.
-- Changed default route and topic name for bounces from 'hard-bounces' to 'bounces'
 
-### Fixed
-- Mention laravel artisan in description for packagist.
+### Changed
+- Changed default route and topic name for bounces from 'hard-bounces' to 'bounces'.
 
 ## Version 1.0.1
 
-### Fixed
+### Added
 - Mention laravel artisan in description for packagist.
 
 ## Version 1.0.0

contributing.md

@@ -4,7 +4,7 @@ Contributions are welcome and will be fully credited.
 
 Will appreciate any pull requests for adding tests to the package.
 
-Contributions are accepted via Pull Requests on [Github](https://github.com/akhan619/laravel-email-events-ses-setup).
+Contributions are accepted via Pull Requests on [Github](https://github.com/akhan619/laravel-ses-tracking).
 
 ## Pull Requests
 

readme.md

@@ -23,11 +23,13 @@ The package will not do anything beyond what is mentioned above. So, the package
 -  Manage the https/s subscription confirmation or actual processing of event messages from SNS.
 -  Create the domains or endpoints with a Laravel project running (but won't that be awesome :smiley: ).
 
-Basically, the package refrains from any action that will be implementation specific. After all, you are in a better position to decide what to do when an email bounce event occurs.
+If you are looking for a package that will manage the incoming `SES` notifications and track email events then you may look at the [Laravel Ses Event Manager](https://github.com/akhan619/laravel-ses-event-manager) package. The `Laravel Ses Event Manager` package integrates nicely with this package and handles the processing and storage of email event notifications sent to the webhooks.
+
+> **FULL DISCLOSURE**: I am the author of the `Laravel Ses Event Manager` package.
 
 # Laravel and PHP Versions
 
-The package is written for Laravel 9 and Php 8.
+The package is written for Laravel 9 and Php 8 and above.
 
 # Overview of SES/SNS Event Notification Process
 

tests/Unit/SesManagerTest.php

@@ -5,6 +5,7 @@
 use Akhan619\LaravelSesTracking\App\Contracts\AwsCredentialsContract;
 use Akhan619\LaravelSesTracking\App\Contracts\SesDataContract;
 use Akhan619\LaravelSesTracking\App\SesManager;
+use Akhan619\LaravelSesTracking\App\SnsManager;
 use Akhan619\LaravelSesTracking\Console\Commands\SetupTrackingCommand;
 use Akhan619\LaravelSesTracking\LaravelSesTrackingServiceProvider;
 use Akhan619\LaravelSesTracking\Tests\UnitTestCase;
@@ -200,4 +201,74 @@ public function sesManagerConfirmNamingConventionThrowsExceptionOnEmptyName()
 
         $this->assertTrue($hasThrown);
     }
+
+    /**
+     * @test
+     */
+    public function sesManagerCreateEventDestinationPrintsCorrectlyInDebugMode()
+    {
+        $aws = Mockery::mock(AwsCredentialsContract::class);
+        $aws->shouldReceive([
+            'getAwsAccessKeyId'     => 'someId',
+            'getAwsSecretAccessKey' => 'someKey',
+            'getAwsDefaultRegion'   => 'us-east-1',
+        ])
+        ->once();
+
+        $dataMgr = Mockery::mock(SesDataContract::class);
+        $dataMgr->shouldReceive('getConfigurationSetName')
+        ->once()
+        ->andReturn('Test-Set-1');
+
+        $dataMgr->shouldReceive('getDestinationNames')
+        ->once()
+        ->andReturn(['sends'    =>  'sns']);
+
+        $dataMgr->shouldReceive('getEventDestinationSuffix')
+        ->andReturn('us-east-1');
+
+        $dataMgr->shouldReceive('getTopicNameAsSuffix')
+        ->andReturn(true);
+
+        $dataMgr->shouldReceive('getEventDestinationPrefix')
+        ->andReturn('destination');
+
+        $snsMgr = Mockery::mock(SnsManager::class);
+        
+        $console = Mockery::mock(SetupTrackingCommand::class);
+        $console->shouldReceive('getIo->table')
+        ->once()
+        ->with(['Event', 'Event Destination Name'], [
+            ['sends', 'destination-sns-sends'],
+        ]);
+
+        $console->shouldReceive('info')
+        ->once();
+
+        $console->shouldReceive('newLine')
+        ->once();
+
+        $sesMgr = Mockery::mock(SesManager::class, [$aws, $dataMgr, true, $console])
+        ->makePartial()
+        ->shouldAllowMockingProtectedMethods();
+
+        $sesMgr->shouldReceive('prettyPrintArray')
+        ->with([
+            'ConfigurationSetName' => 'Test-Set-1',
+            'EventDestination'     => [
+                'Enabled'            => true,
+                'MatchingEventTypes' => ['SEND'],
+                'SnsDestination'     => [
+                    'TopicArn' => 'Not Available in Debug Mode',
+                ],
+            ],
+            'EventDestinationName' => 'destination-sns-sends',
+        ], 'SES Event Destination Configuration Data')
+        ->once();
+
+        $sesMgr->confirmNamingConvention(['sends'   => true], ['sends'  => 'sends']);
+        $sesMgr->createSesEventDestinations($snsMgr);
+
+        $this->assertTrue(true);
+    }
 }