You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kibble.apache.org by hu...@apache.org on 2018/01/09 01:19:40 UTC
[kibble] 01/02: Initial stab at an API end point for key phrases
This is an automated email from the ASF dual-hosted git repository.
humbedooh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kibble.git
commit 7e64c18dc69f6274e1a5f2259aebed76b8293805
Author: Daniel Gruno <hu...@apache.org>
AuthorDate: Tue Jan 9 02:18:58 2018 +0100
Initial stab at an API end point for key phrases
This spits out the top 50 most common key phrases in use.
We'll figure out how to present this later on..
---
api/pages/mail/keyphrases.py | 153 +++++++++++++++++++++
api/yaml/openapi/components/schemas/Phrase.yaml | 15 ++
.../openapi/components/schemas/PhraseList.yaml | 15 ++
3 files changed, 183 insertions(+)
diff --git a/api/pages/mail/keyphrases.py b/api/pages/mail/keyphrases.py
new file mode 100644
index 0000000..c01d49b
--- /dev/null
+++ b/api/pages/mail/keyphrases.py
@@ -0,0 +1,153 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+########################################################################
+# OPENAPI-URI: /api/mail/keyphrases
+########################################################################
+# get:
+# responses:
+# '200':
+# content:
+# application/json:
+# schema:
+# $ref: '#/components/schemas/PhraseList'
+# description: 200 Response
+# default:
+# content:
+# application/json:
+# schema:
+# $ref: '#/components/schemas/Error'
+# description: unexpected error
+# security:
+# - cookieAuth: []
+# summary: Shows the common key phrases in use on one or more mailing lists
+# post:
+# requestBody:
+# content:
+# application/json:
+# schema:
+# $ref: '#/components/schemas/defaultWidgetArgs'
+# responses:
+# '200':
+# content:
+# application/json:
+# schema:
+# $ref: '#/components/schemas/PhraseList'
+# description: 200 Response
+# default:
+# content:
+# application/json:
+# schema:
+# $ref: '#/components/schemas/Error'
+# description: unexpected error
+# security:
+# - cookieAuth: []
+# summary: Shows the common key phrases in use on one or more mailing lists
+#
+########################################################################
+
+
+
+
+
+"""
+This is the common key phrases renderer for Kibble
+"""
+
+import json
+import time
+import hashlib
+
+def run(API, environ, indata, session):
+
+ # We need to be logged in for this!
+ if not session.user:
+ raise API.exception(403, "You must be logged in to use this API endpoint! %s")
+
+ now = time.time()
+
+ # First, fetch the view if we have such a thing enabled
+ viewList = []
+ if indata.get('view'):
+ viewList = session.getView(indata.get('view'))
+ if indata.get('subfilter'):
+ viewList = session.subFilter(indata.get('subfilter'), view = viewList)
+
+
+ dateTo = indata.get('to', int(time.time()))
+ dateFrom = indata.get('from', dateTo - (86400*30*6)) # Default to a 6 month span
+
+ interval = indata.get('interval', 'month')
+
+
+ ####################################################################
+ ####################################################################
+ dOrg = session.user['defaultOrganisation'] or "apache"
+ query = {
+ 'query': {
+ 'bool': {
+ 'must': [
+ {'range':
+ {
+ 'ts': {
+ 'from': dateFrom,
+ 'to': dateTo
+ }
+ }
+ },
+ {
+ 'term': {
+ 'organisation': dOrg
+ }
+ }
+ ]
+ }
+ },
+ 'aggs': {
+ 'kpe': {
+ 'terms': {
+ 'field': 'kpe.keyword',
+ 'size': 50
+ }
+ }
+ }
+ }
+ # Source-specific or view-specific??
+ if indata.get('source'):
+ query['query']['bool']['must'].append({'term': {'sourceID': indata.get('source')}})
+ elif viewList:
+ query['query']['bool']['must'].append({'terms': {'sourceID': viewList}})
+
+ res = session.DB.ES.search(
+ index=session.DB.dbname,
+ doc_type="email",
+ size = 0,
+ body = query
+ )
+
+ topN = []
+ for bucket in res['aggregations']['kpe']['buckets']:
+ topN.append( {
+ 'phrase': bucket['key'],
+ 'count': bucket['doc_count']
+ })
+
+ JSON_OUT = {
+ 'phrases': topN,
+ 'okay': True,
+ 'responseTime': time.time() - now
+ }
+ yield json.dumps(JSON_OUT)
diff --git a/api/yaml/openapi/components/schemas/Phrase.yaml b/api/yaml/openapi/components/schemas/Phrase.yaml
new file mode 100644
index 0000000..96c8f8f
--- /dev/null
+++ b/api/yaml/openapi/components/schemas/Phrase.yaml
@@ -0,0 +1,15 @@
+########################################################################
+# Error #
+########################################################################
+properties:
+ phrase:
+ description: The key phrase
+ example: Ponies are awesome
+ type: string
+ count:
+ description: The number of documents containing this as a key phrase
+ example: 25
+ type: integer
+required:
+- phrase
+- count
diff --git a/api/yaml/openapi/components/schemas/PhraseList.yaml b/api/yaml/openapi/components/schemas/PhraseList.yaml
new file mode 100644
index 0000000..e2df69b
--- /dev/null
+++ b/api/yaml/openapi/components/schemas/PhraseList.yaml
@@ -0,0 +1,15 @@
+########################################################################
+# PhraseList #
+########################################################################
+properties:
+ okay:
+ type: boolean
+ phrases:
+ description: A list of key phrases
+ items:
+ $ref: '#/components/schemas/Phrase'
+ type: array
+required:
+- okay
+- phrases
+
--
To stop receiving notification emails like this one, please contact
"commits@kibble.apache.org" <co...@kibble.apache.org>.