Merge pull request #1 from caberos/issue1485

add new email features, email detail and email edit

Author: caberos

SoftLayer/CLI/email/__init__.py

@@ -0,0 +1 @@
+"""Network Delivery account"""

SoftLayer/CLI/email/detail.py

@@ -0,0 +1,40 @@
+"""Display details for a specified email account."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+from SoftLayer.CLI.email.list import build_statistics_table
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+from SoftLayer.managers.email import EmailManager
+from SoftLayer import utils
+
+
+@click.command()
+@click.argument('identifier')
+@environment.pass_env
+def cli(env, identifier):
+    """Display details for a specified email."""
+
+    email_manager = EmailManager(env.client)
+    result = email_manager.get_instance(identifier)
+
+    table = formatting.KeyValueTable(['name', 'value'])
+    table.align['name'] = 'r'
+    table.align['value'] = 'l'
+
+    table.add_row(['id', result.get('id')])
+    table.add_row(['username', result.get('username')])
+    table.add_row(['email_address', result.get('emailAddress')])
+    table.add_row(['create_date', result.get('createDate')])
+    table.add_row(['category_code', utils.lookup(result, 'billingItem', 'categoryCode')])
+    table.add_row(['description', utils.lookup(result, 'billingItem', 'description')])
+    table.add_row(['type_description', utils.lookup(result, 'type', 'description')])
+    table.add_row(['type', utils.lookup(result, 'type', 'keyName')])
+    table.add_row(['vendor', utils.lookup(result, 'vendor', 'keyName')])
+
+    statistics = email_manager.get_statistics(identifier)
+
+    for statistic in statistics:
+        table.add_row(['statistics', build_statistics_table(statistic)])
+
+    env.fout(table)

SoftLayer/CLI/email/edit.py

@@ -0,0 +1,41 @@
+"""Edit details of an Delivery email account."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+from SoftLayer.managers.email import EmailManager
+
+
+@click.command()
+@click.argument('identifier')
+@click.option('--username', help="Sets username for this account")
+@click.option('--email', help="Sets the contact email for this account")
+@click.option('--password',
+              help="Password must be between 8 and 20 characters "
+                   "and must contain one letter and one number.")
+@environment.pass_env
+def cli(env, identifier, username, email, password):
+    """Edit details of an email delivery account."""
+    email_manager = EmailManager(env.client)
+
+    data = {}
+    update = False
+    if email:
+        if email_manager.update_email(identifier, email):
+            update = True
+        else:
+            raise exceptions.CLIAbort("Failed to Edit emailAddress account")
+    if username:
+        data['username'] = username
+    if password:
+        data['password'] = password
+    if len(data) != 0:
+        if email_manager.editObject(identifier, **data):
+            update = True
+        else:
+            raise exceptions.CLIAbort("Failed to Edit email account")
+
+    if update:
+        env.fout('Updated Successfully')

SoftLayer/CLI/email/list.py

@@ -1,4 +1,4 @@
-"""Get lists Email Delivery account Service """
+"""Lists Email Delivery Service """
 # :license: MIT, see LICENSE for more details.
 
 import click
@@ -36,25 +36,29 @@ def cli(env):
         table.add_row(['email_information', table_information])
         table.add_row(['email_overview', overview_table])
         for statistic in statistics:
-            table.add_row(['statistics', _build_statistics_table(statistic)])
+            table.add_row(['statistics', build_statistics_table(statistic)])
 
     env.fout(table)
 
 
 def _build_overview_table(email_overview):
-    table = formatting.Table(['credit_Allowed', 'credits_Remain', 'package', 'reputation', 'requests'])
+    table = formatting.Table(
+        ['credit_allowed', 'credits_remain', 'credits_overage', 'credits_used',
+         'package', 'reputation', 'requests'])
     table.align['name'] = 'r'
     table.align['value'] = 'l'
 
     table.add_row([email_overview.get('creditsAllowed'), email_overview.get('creditsRemain'),
+                   email_overview.get('creditsOverage'), email_overview.get('creditsUsed'),
                    email_overview.get('package'), email_overview.get('reputation'),
                    email_overview.get('requests')])
 
     return table
 
 
-def _build_statistics_table(statistics):
-    table = formatting.Table(['delivered', 'requests', 'bounces', 'opens', 'clicks', 'spamReports'])
+def build_statistics_table(statistics):
+    """statistics records of Email Delivery account"""
+    table = formatting.Table(['delivered', 'requests', 'bounces', 'opens', 'clicks', 'spam_reports'])
     table.align['name'] = 'r'
     table.align['value'] = 'l'
 

SoftLayer/CLI/routes.py

@@ -121,6 +121,8 @@
 
     ('email', 'SoftLayer.CLI.email'),
     ('email:list', 'SoftLayer.CLI.email.list:cli'),
+    ('email:detail', 'SoftLayer.CLI.email.detail:cli'),
+    ('email:edit', 'SoftLayer.CLI.email.edit:cli'),
 
     ('event-log', 'SoftLayer.CLI.event_log'),
     ('event-log:get', 'SoftLayer.CLI.event_log.get:cli'),

SoftLayer/fixtures/SoftLayer_Network_Message_Delivery_Email_Sendgrid.py

@@ -25,3 +25,35 @@
     "uniqueOpens": 0,
     "unsubscribes": 0
 }]
+
+getObject = {
+    "accountId": 123456,
+    "createDate": "2020-07-06T10:29:11-06:00",
+    "id": 1232123,
+    "password": "Test123456789",
+    "typeId": 21,
+    "username": "techsupport3@ie.ibm.com",
+    "vendorId": 1,
+    "billingItem": {
+        "categoryCode": "network_message_delivery",
+        "description": "Free Package",
+        "id": 695735054,
+        "notes": "techsupport3@ie.ibm.com",
+    },
+    "type": {
+        "description": "Delivery of messages through e-mail",
+        "id": 21,
+        "keyName": "EMAIL",
+        "name": "Email"
+    },
+    "vendor": {
+        "id": 1,
+        "keyName": "SENDGRID",
+        "name": "SendGrid"
+    },
+    "emailAddress": "techsupport3@ie.ibm.com",
+    "smtpAccess": "1"
+}
+
+editObject = True
+updateEmailAddress = True

SoftLayer/managers/email.py

@@ -45,3 +45,41 @@ def get_statistics(self, identifier, days=30):
 
         return self.client.call('SoftLayer_Network_Message_Delivery_Email_Sendgrid',
                                 'getStatistics', id=identifier, *body)
+
+    def get_instance(self, identifier):
+        """Gets the Network_Message_Delivery_Email_Sendgrid instance
+
+        :return: Network_Message_Delivery_Email_Sendgrid
+        """
+
+        _mask = """emailAddress,type,billingItem,vendor"""
+
+        return self.client.call('SoftLayer_Network_Message_Delivery_Email_Sendgrid',
+                                'getObject', id=identifier, mask=_mask)
+
+    def editObject(self, identifier, username=None, password=None):
+        """Edit email delivery account related details.
+
+               :param int identifier: The ID of the email account
+               :param string username: username of the email account.
+               :param string email: email of the email account.
+               :param string password: password of the email account to be updated to.
+               """
+        data = {}
+        if username:
+            data['username'] = username
+        if password:
+            data['password'] = password
+
+        return self.client.call('SoftLayer_Network_Message_Delivery_Email_Sendgrid',
+                                'editObject', data, id=identifier)
+
+    def update_email(self, identifier, email):
+        """Edit email address delivery account .
+
+        :param int identifier: The ID of the email account
+        :param string email: email of the email account.
+
+        """
+        return self.client.call('SoftLayer_Network_Message_Delivery_Email_Sendgrid',
+                                'updateEmailAddress', email, id=identifier)

docs/cli.rst

@@ -79,6 +79,7 @@ To discover the available commands, simply type `slcli`.
           config          CLI configuration.
           dedicatedhost   Dedicated Host.
           dns             Domain Name System.
+          email           Email Deliviry Network
           event-log       Event Logs.
           file            File Storage.
           firewall        Firewalls.

docs/cli/email.rst

@@ -6,4 +6,12 @@ Email Commands
 
 .. click:: SoftLayer.CLI.email.list:cli
     :prog: email list
+    :show-nested:
+
+.. click:: SoftLayer.CLI.email.detail:cli
+    :prog: email detail
+    :show-nested:
+
+.. click:: SoftLayer.CLI.email.edit:cli
+    :prog: email edit
     :show-nested:

tests/CLI/modules/email_tests.py

@@ -9,7 +9,23 @@
 
 class EmailCLITests(testing.TestCase):
 
-    def test_detail(self):
+    def test_list(self):
         result = self.run_command(['email', 'list'])
         self.assert_no_fail(result)
         self.assert_called_with('SoftLayer_Account', 'getNetworkMessageDeliveryAccounts')
+
+    def test_detail(self):
+        result = self.run_command(['email', 'detail', '1232123'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Network_Message_Delivery_Email_Sendgrid', 'getObject')
+
+    def test_edit(self):
+        result = self.run_command(['email', 'edit', '1232123',
+                                   '--username=test@ibm.com',
+                                   '--email=test@ibm.com',
+                                   '--password=test123456789'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Network_Message_Delivery_Email_Sendgrid',
+                                'editObject')
+        self.assert_called_with('SoftLayer_Network_Message_Delivery_Email_Sendgrid',
+                                'updateEmailAddress')