Refactor code review.

Fernando Ojeda · Fernando Ojeda · commit 0f409bee9a8d · 2019-06-14T17:13:57.000-04:00
diff --git a/SoftLayer/CLI/cdn/detail.py b/SoftLayer/CLI/cdn/detail.py
@@ -10,22 +10,22 @@
 
 @click.command()
 @click.argument('unique_id')
-@click.option('--last_days',
-              default=30,
-              help='cdn overview last days less than 90 days, because it is the maximum e.g 7, 15, 30, 60, 89')
+@click.option('--history',
+              default=30, type=click.IntRange(1, 89),
+              help='Bandwidth, Hits, Ratio counted over history number of days ago. 89 is the maximum. ')
 @environment.pass_env
-def cli(env, unique_id, last_days):
+def cli(env, unique_id, history):
     """Detail a CDN Account."""
 
     manager = SoftLayer.CDNManager(env.client)
 
     cdn_mapping = manager.get_cdn(unique_id)
-    cdn_metrics = manager.get_usage_metrics(unique_id, days=last_days)
+    cdn_metrics = manager.get_usage_metrics(unique_id, history=history)
 
     # usage metrics
-    total_bandwidth = str(cdn_metrics['totals'][0]) + " GB"
-    total_hits = str(cdn_metrics['totals'][1])
-    hit_radio = str(cdn_metrics['totals'][2]) + " %"
+    total_bandwidth = "%s GB" % cdn_metrics['totals'][0]
+    total_hits = cdn_metrics['totals'][1]
+    hit_ratio = "%s %%" % cdn_metrics['totals'][2]
 
     table = formatting.KeyValueTable(['name', 'value'])
     table.align['name'] = 'r'
@@ -41,6 +41,6 @@ def cli(env, unique_id, last_days):
     table.add_row(['status', cdn_mapping['status']])
     table.add_row(['total_bandwidth', total_bandwidth])
     table.add_row(['total_hits', total_hits])
-    table.add_row(['hit_radio', hit_radio])
+    table.add_row(['hit_radio', hit_ratio])
 
     env.fout(table)
diff --git a/SoftLayer/CLI/cdn/origin_add.py b/SoftLayer/CLI/cdn/origin_add.py
@@ -51,7 +51,11 @@
 @environment.pass_env
 def cli(env, unique_id, origin, path, origin_type, header,
         bucket_name, port, protocol, optimize_for, extensions, cache_query):
-    """Create an origin path for an existing CDN mapping."""
+    """Create an origin path for an existing CDN mapping.
+
+    For more information see the following documentation: \n
+    https://cloud.ibm.com/docs/infrastructure/CDN?topic=CDN-manage-your-cdn#adding-origin-path-details
+    """
 
     manager = SoftLayer.CDNManager(env.client)
 
diff --git a/SoftLayer/CLI/cdn/purge.py b/SoftLayer/CLI/cdn/purge.py
@@ -17,6 +17,9 @@ def cli(env, unique_id, path):
 
         Example:
              slcli cdn purge 9779455 /article/file.txt
+
+        For more information see the following documentation: \n
+        https://cloud.ibm.com/docs/infrastructure/CDN?topic=CDN-manage-your-cdn#purging-cached-content
     """
 
     manager = SoftLayer.CDNManager(env.client)
diff --git a/SoftLayer/managers/cdn.py b/SoftLayer/managers/cdn.py
@@ -137,18 +137,18 @@ def purge_content(self, unique_id, path):
 
         return self.cdn_purge.createPurge(unique_id, path)
 
-    def get_usage_metrics(self, unique_id, days=30, frequency="aggregate"):
+    def get_usage_metrics(self, unique_id, history=30, frequency="aggregate"):
         """Retrieves the cdn usage metrics.
 
         It uses the 'days' argument if start_date and end_date are None.
 
         :param int unique_id: The CDN uniqueId from which the usage metrics will be obtained.
-        :param int days: Last N days, default days is 30.
+        :param int history: Last N days, default days is 30.
         :param str frequency: It can be day, week, month and aggregate. The default is "aggregate".
         :returns: A Container_Network_CdnMarketplace_Metrics object
         """
 
-        _start = utils.days_to_datetime(days)
+        _start = utils.days_to_datetime(history)
         _end = utils.days_to_datetime(0)
 
         _start_date = utils.timestamp(_start)
diff --git a/tests/CLI/modules/cdn_tests.py b/tests/CLI/modules/cdn_tests.py
@@ -26,7 +26,7 @@ def test_list_accounts(self):
                          )
 
     def test_detail_account(self):
-        result = self.run_command(['cdn', 'detail', '--last_days=30', '1245'])
+        result = self.run_command(['cdn', 'detail', '--history=30', '1245'])
 
         self.assert_no_fail(result)
         self.assertEqual(json.loads(result.output),
diff --git a/tests/managers/cdn_tests.py b/tests/managers/cdn_tests.py
@@ -29,7 +29,7 @@ def test_detail_cdn(self):
                                 args=args)
 
     def test_detail_usage_metric(self):
-        self.cdn_client.get_usage_metrics(12345, days=30, frequency="aggregate")
+        self.cdn_client.get_usage_metrics(12345, history=30, frequency="aggregate")
 
         _start = utils.days_to_datetime(30)
         _end = utils.days_to_datetime(0)

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ def test_list_accounts(self):`
`26`	`26`	`)`
`27`	`27`
`28`	`28`	`def test_detail_account(self):`
`29`		`- result = self.run_command(['cdn', 'detail', '--last_days=30', '1245'])`
	`29`	`+ result = self.run_command(['cdn', 'detail', '--history=30', '1245'])`
`30`	`30`
`31`	`31`	`self.assert_no_fail(result)`
`32`	`32`	`self.assertEqual(json.loads(result.output),`