From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id D62B36A018 for ; Thu, 21 Jan 2021 16:51:37 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id D3C8813D16 for ; Thu, 21 Jan 2021 16:51:37 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 0EE8113CEF for ; Thu, 21 Jan 2021 16:51:36 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id CB8F9460B8 for ; Thu, 21 Jan 2021 16:51:35 +0100 (CET) From: Stoiko Ivanov To: pmg-devel@lists.proxmox.com Date: Thu, 21 Jan 2021 16:51:03 +0100 Message-Id: <20210121155107.1971-3-s.ivanov@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210121155107.1971-1-s.ivanov@proxmox.com> References: <20210121155107.1971-1-s.ivanov@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.067 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [statistics.pm] Subject: [pmg-devel] [PATCH pmg-api v2 2/5] api: statistics: refactor return for detail calls X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 21 Jan 2021 15:51:37 -0000 all api methods returning information for a particular sender, receiver or contact have similar returns. This commit pulls the common ones out into a sub like the common method parameters in $default_properties. Signed-off-by: Stoiko Ivanov --- v1->v2: * keep the common properties in a sub instead of a hash (for consistency with $default_properties) src/PMG/API2/Statistics.pm | 109 ++++++++++++++----------------------- 1 file changed, 40 insertions(+), 69 deletions(-) diff --git a/src/PMG/API2/Statistics.pm b/src/PMG/API2/Statistics.pm index adc7650..064865d 100644 --- a/src/PMG/API2/Statistics.pm +++ b/src/PMG/API2/Statistics.pm @@ -257,6 +257,40 @@ __PACKAGE__->register_method ({ return $res; }}); +my $detail_return_properties = sub { + my ($prop) = @_; + + $prop //= {}; + + $prop->{time} = { + description => "Receive time stamp", + type => 'integer', + }; + + $prop->{bytes} = { + description => "Mail traffic (Bytes).", + type => 'number', + }; + + $prop->{blocked} = { + description => "Mail was blocked.", + type => 'boolean', + }; + + $prop->{spamlevel} = { + description => "Spam score.", + type => 'number', + }; + + $prop->{virusinfo} = { + description => "Virus name.", + type => 'string', + optional => 1, + }; + + return $prop; +}; + __PACKAGE__->register_method ({ name => 'contactdetails', path => 'contact/{contact}', @@ -282,33 +316,12 @@ __PACKAGE__->register_method ({ type => 'array', items => { type => "object", - properties => { - time => { - description => "Receive time stamp", - type => 'integer', - }, + properties => $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, - }, - }, + }), }, }, code => sub { @@ -421,33 +434,12 @@ __PACKAGE__->register_method ({ type => 'array', items => { type => "object", - properties => { - time => { - description => "Receive time stamp", - type => 'integer', - }, + properties => $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, - }, - }, + }), }, }, code => sub { @@ -568,33 +560,12 @@ __PACKAGE__->register_method ({ type => 'array', items => { type => "object", - properties => { - time => { - description => "Receive time stamp", - type => 'integer', - }, + properties => $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, - }, - }, + }), }, }, code => sub { -- 2.20.1