public inbox for pmg-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Stoiko Ivanov <s.ivanov@proxmox.com>
To: pmg-devel@lists.proxmox.com
Subject: [pmg-devel] [PATCH pmg-api 2/5] api: statistics: refactor return for detail calls
Date: Fri, 15 Jan 2021 10:46:22 +0100	[thread overview]
Message-ID: <20210115094626.25440-3-s.ivanov@proxmox.com> (raw)
In-Reply-To: <20210115094626.25440-1-s.ivanov@proxmox.com>

all api methods returning information for a particular sender,
receiver or contact have similar returns.

This commit pulls the common ones out into a hash for reusing them.

Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
---
 src/PMG/API2/Statistics.pm | 90 ++++++++++++--------------------------
 1 file changed, 27 insertions(+), 63 deletions(-)

diff --git a/src/PMG/API2/Statistics.pm b/src/PMG/API2/Statistics.pm
index adc7650..0d12dd3 100644
--- a/src/PMG/API2/Statistics.pm
+++ b/src/PMG/API2/Statistics.pm
@@ -257,6 +257,30 @@ __PACKAGE__->register_method ({
 	return $res;
     }});
 
+my %detail_return_properties = (
+    time => {
+	description => "Receive time stamp",
+	type => 'integer',
+    },
+    bytes => {
+	description => "Mail traffic (Bytes).",
+	type => 'number',
+    },
+    blocked => {
+	description => "Mail was blocked.",
+	type => 'boolean',
+    },
+    spamlevel => {
+	description => "Spam score.",
+	type => 'number',
+    },
+    virusinfo => {
+	description => "Virus name.",
+	type => 'string',
+	optional => 1,
+    },
+);
+
 __PACKAGE__->register_method ({
     name => 'contactdetails',
     path => 'contact/{contact}',
@@ -283,31 +307,11 @@ __PACKAGE__->register_method ({
 	items => {
 	    type => "object",
 	    properties => {
-		time => {
-		    description => "Receive time stamp",
-		    type => 'integer',
-		},
+		%detail_return_properties,
 		sender => {
 		    description => "Sender email.",
 		    type => 'string',
 		},
-		bytes => {
-		    description => "Mail traffic (Bytes).",
-		    type => 'number',
-		},
-		blocked => {
-		    description => "Mail was blocked.",
-		    type => 'boolean',
-		},
-		spamlevel => {
-		    description => "Spam score.",
-		    type => 'number',
-		},
-		virusinfo => {
-		    description => "Virus name.",
-		    type => 'string',
-		    optional => 1,
-		},
 	    },
 	},
     },
@@ -422,31 +426,11 @@ __PACKAGE__->register_method ({
 	items => {
 	    type => "object",
 	    properties => {
-		time => {
-		    description => "Receive time stamp",
-		    type => 'integer',
-		},
+		%detail_return_properties,
 		receiver => {
 		    description => "Receiver email.",
 		    type => 'string',
 		},
-		bytes => {
-		    description => "Mail traffic (Bytes).",
-		    type => 'number',
-		},
-		blocked => {
-		    description => "Mail was blocked.",
-		    type => 'boolean',
-		},
-		spamlevel => {
-		    description => "Spam score.",
-		    type => 'number',
-		},
-		virusinfo => {
-		    description => "Virus name.",
-		    type => 'string',
-		    optional => 1,
-		},
 	    },
 	},
     },
@@ -569,31 +553,11 @@ __PACKAGE__->register_method ({
 	items => {
 	    type => "object",
 	    properties => {
-		time => {
-		    description => "Receive time stamp",
-		    type => 'integer',
-		},
+		%detail_return_properties,
 		sender => {
 		    description => "Sender email.",
 		    type => 'string',
 		},
-		bytes => {
-		    description => "Mail traffic (Bytes).",
-		    type => 'number',
-		},
-		blocked => {
-		    description => "Mail was blocked.",
-		    type => 'boolean',
-		},
-		spamlevel => {
-		    description => "Spam score.",
-		    type => 'number',
-		},
-		virusinfo => {
-		    description => "Virus name.",
-		    type => 'string',
-		    optional => 1,
-		},
 	    },
 	},
     },
-- 
2.20.1





  parent reply	other threads:[~2021-01-15  9:47 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-15  9:46 [pmg-devel] [PATCH pmg-api/pmg-gui] allow / in local part of pmg-email-address Stoiko Ivanov
2021-01-15  9:46 ` [pmg-devel] [PATCH pmg-api 1/5] api: statistics: remove unneeded RESTEnvironment Stoiko Ivanov
2021-01-15  9:46 ` Stoiko Ivanov [this message]
2021-01-15  9:46 ` [pmg-devel] [PATCH pmg-api 3/5] api: statistics: refactor detail calls Stoiko Ivanov
2021-01-15  9:46 ` [pmg-devel] [PATCH pmg-api 4/5] api: statistics: make email a parameter Stoiko Ivanov
2021-01-15  9:46 ` [pmg-devel] [PATCH pmg-api 5/5] utils: allow '/' inside email address localpart Stoiko Ivanov
2021-01-15  9:46 ` [pmg-devel] [PATCH pmg-gui 1/1] statistics: use new api call for detailed stats Stoiko Ivanov

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210115094626.25440-3-s.ivanov@proxmox.com \
    --to=s.ivanov@proxmox.com \
    --cc=pmg-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal