adding new xmpp wikibot example #596

mogar1980 · 2016-10-20T00:49:55Z

jerjou@ could you review this example? Feel free to move to new directory if necessary.

theacodes · 2016-10-20T16:31:02Z

@mogar1980 I can review. Since this runs on compute engine, can you put it in the compute_engine folder instead of the app engine one?

(Could this run on App Engine flex instead?)

theacodes · 2016-10-20T16:33:45Z

appengine/standard/xmpp_wikibot/wikibot.py

+
+"""Uncyclobot server example using SleekXMPP client library"""
+
+import sys


Imports need to be two sections: standard lib, then thirdparty and should be in alphabetical order:

import getpass import json import logging import optparse import sys import threading import urllib from flask import Flask, request import requests import sleekxmpp

theacodes · 2016-10-20T16:33:54Z

appengine/standard/xmpp_wikibot/wikibot.py

+import sys
+import logging
+import getpass
+from optparse import OptionParser


prefer argparse over optparse.

theacodes · 2016-10-20T16:34:06Z

appengine/standard/xmpp_wikibot/wikibot.py

+
+import sleekxmpp
+
+# Python versions before 3.0 do not use UTF-8 encoding


This shouldn't be needed. If you remove it, what happens?

theacodes · 2016-10-20T16:35:02Z

appengine/standard/xmpp_wikibot/wikibot.py

+    logging.basicConfig(level=opts.loglevel,
+                        format='%(levelname)-8s %(message)s')
+
+    if opts.jid is None:


Since this is intended to run on the server, don't ever use input.

theacodes · 2016-10-20T16:36:58Z

appengine/standard/xmpp_wikibot/wikibot.py

+    if xmpp.connect():
+        # If you do not have the dnspython library installed, you will need
+        # to manually specify the name of the server if it does not match
+        # the one in the JID. For example, to use Google Talk you would


Google Talk is dead, no?

theacodes · 2016-10-20T16:37:23Z

appengine/standard/xmpp_wikibot/wikibot.py

+                   how it may be used.
+        """
+        if msg['type'] in ('chat', 'normal'):
+            msg_body = "%(body)s" % msg


Please use format over % throughout.

theacodes · 2016-10-20T16:37:35Z

appengine/standard/xmpp_wikibot/wikibot.py

+            msg_body = "%(body)s" % msg
+            logging.info("Message sent was: " + msg_body)
+            encoded_body = urllib.quote_plus(msg_body)
+            svrResponse = requests.get("https://en.wikipedia.org/w/api.php?action=parse&prop=sections&format=json&page=" + encoded_body)


please use single quotes throughout.

theacodes · 2016-10-20T16:37:49Z

appengine/standard/xmpp_wikibot/wikibot.py

+            msg_body = "%(body)s" % msg
+            logging.info("Message sent was: " + msg_body)
+            encoded_body = urllib.quote_plus(msg_body)
+            svrResponse = requests.get("https://en.wikipedia.org/w/api.php?action=parse&prop=sections&format=json&page=" + encoded_body)


Python variables are snake_case, never lowerCamelCase.

theacodes · 2016-10-20T16:38:18Z

appengine/standard/xmpp_wikibot/wikibot.py

+    # xmpp.ca_certs = "path/to/ca/cert"
+
+    # start the app server and run it as a thread so that the XMPP server may also start
+    threading.Thread(target=run_server).start()


Prefer to have the web app start the xmpp server as a background thread, see here: http://stackoverflow.com/questions/14384739/how-can-i-add-a-background-thread-to-flask

jerjou · 2016-10-20T16:54:18Z

appengine/standard/xmpp_wikibot/README.md

+client and [Flask](http://flask.pocoo.org/) to build a simple chatbot that can
+be run on [Google Compute Engine](https://cloud.google.com/compute/). The
+chatbot does two things:
+    1. Sends messages to XMPP users via http get:


The formatting gets messed up here. You can see what it'll look like by clicking the "View" button in this review.

It should look like:

...chatbot does two things: 1. Sends messages to XMPP users via http get: The server is running on port 5000. If running on a virtual machine, use: http://<MACHINE IP>:5000/send_message?recipient=<RECIPIENT ADDRESS>&message=<MSG> If running locally, use: http://localhost:5000/send_message?recipient=<RECIPIENT ADDRESS>&message=<MSG> 1. Responds to incoming ...

ie:

You shouldn't indent the first line

Subsequent lines shouldn't be indented so much. Otherwise, they become code blocks.

If you want something on a new line, you have to separate it by a blank line.

For numbered lists, the actual number you use doesn't matter ;)

See here for a markdown tutorial

jerjou · 2016-10-20T16:55:15Z

appengine/standard/xmpp_wikibot/README.md

+       If running locally use:
+       http://localhost:5000/send_message?recipient=<RECIPIENT ADDRESS>&message=<MSG>
+
+    2. Responds to incoming messages with a wikipedia page on the topic:


capital-W-Uncyclopedia

jerjou · 2016-10-20T16:55:28Z

appengine/standard/xmpp_wikibot/README.md

+
+## Setup
+
+Follow the intstructions at the 


instructions

jerjou · 2016-10-20T16:56:22Z

appengine/standard/xmpp_wikibot/README.md

+[Compute Engine Quickstart Guide](https://cloud.google.com/compute/docs/quickstart-linux)
+on how to create a project, create a virtual machine, and connect to your
+instance via SSH. Once you have done this, you may jump to 'Installing files
+and dependencies'


...jump to '[Installing files and dependencies](#installing-files-and-dependencies)'

jerjou · 2016-10-20T16:57:03Z

appengine/standard/xmpp_wikibot/README.md

+
+### Installing files and dependencies
+
+First, install the wikibot.py and requirements.txt files onto your remote 


`wikibot.py` ... `requirements.txt`

(ie surround with backticks, by convention)

jerjou · 2016-10-20T16:57:32Z

appengine/standard/xmpp_wikibot/README.md

+First, install the wikibot.py and requirements.txt files onto your remote 
+instance. See the guide on
+[Transferring Files](https://cloud.google.com/compute/docs/instances/transfer-files)
+for more information on how to do this using the Mac file browser, scp, or


jerjou · 2016-10-20T17:36:24Z

appengine/standard/xmpp_wikibot/README.md

+
+### Running on your local machine
+
+You may also run the sample locally by simply copying wikibot.py to a project


`wikibot.py`

jerjou · 2016-10-20T17:39:19Z

appengine/standard/xmpp_wikibot/wikibot.py

+def send_message():
+    try:
+        recipient = request.args.get('recipient')
+        message = request.args.get('message')


If you're using .get, there should never be a KeyError

jerjou · 2016-10-20T17:40:04Z

appengine/standard/xmpp_wikibot/wikibot.py

+        return "message sent to:" + recipient + " with body:" + message
+    else:
+        logging.info("chat client or recipient or message does not exist!")
+    return "message failed to send"


Should probably return an error code as well:

return 'message failed to send', 500

jerjou · 2016-10-20T17:44:01Z

appengine/standard/xmpp_wikibot/wikibot.py

+                   how it may be used.
+        """
+        if msg['type'] in ('chat', 'normal'):
+            msg_body = "%(body)s" % msg


Couldn't you just do msg_body = msg['body']? The string format seems gratuitous...

mogar1980 · 2016-10-26T06:41:24Z

Made a few changes in response to comments. Jerjou@ could you PTAL? Thanks.

mogar1980 · 2016-10-26T15:40:26Z

Jerjou, Could you please take another look at this pull request? I've
addressed the bulk of the comments from Jon and we need to have a basic
working example by tomorrow EOD at the latest. I'm happy to use this one as
a starting point and update if you guys feel strongly about things such as
moving to Flex, etc. Also, please feel free to move it to whatever
directory you like.

Thanks,
Morgan

On Thu, Oct 20, 2016 at 1:44 PM, Morgan Hallmon [email protected]
wrote:

Perfect! Thanks, Morgan

On Thursday, October 20, 2016, Jon Wayne Parrott [email protected]
wrote:
Yeah I should be able to swing that.

On Thu, Oct 20, 2016 at 1:23 PM Morgan Hallmon [email protected]
wrote:
If you can get the XMPP client to run under flex, then please do move
it. I was worried that there might be issues with the incoming network
path, and didn't want to spend too much time investigating. On that note,
the XMPP client won't respond properly to messages when running locally on
Google-A (learned that lesson the hard way :) ).

Timing is important here as well: we need to have it all done by next
Weds so that we can guarantee docs are 100% by Thurs, when I'd like to send
out the customer announcement.

Does that timing work for you?

Please let me know.

Thanks!
Morgan

On Thu, Oct 20, 2016 at 1:04 PM, Jon Wayne Parrott [email protected]
wrote:
I can take it over and likely finish it up in the next week or so. Do
you mind if I switch it to GAE Flex? It'll make setup for the users much
easier.

On Thu, Oct 20, 2016 at 1:02 PM Morgan Hallmon <
[email protected]> wrote:
Would one of you guys be able to take this over? I'm not sure that I
have time to address all your comments in time as I need to shift to
another big deliverable due next week. As there will be few users (max
~100) who actually try to migrate to an XMPP server, I'm less worried about
editorial control over this sample. Feel free to make whatever changes you
like as long as:

The general functionality is retained (sending messages via GET
and responding to incoming chats with a Uncyclopedia page on the subject)

The setup in the README is easy to understand and follow.

Please let me know.

Thanks!
Morgan

On Thu, Oct 20, 2016 at 10:44 AM, Jerjou [email protected]
wrote:
@jerjou commented on this pull request.

In appengine/standard/xmpp_wikibot/README.md
#596 (review)
:

@@ -0,0 +1,62 @@
+# Uncyclobot example that can be run on Google Compute Engine
+
+This sample shows how to use the SleekXMPP
+client and Flask to build a simple chatbot that can
+be run on Google Compute Engine. The
+chatbot does two things:

Sends messages to XMPP users via http get:

The formatting gets messed up here. You can see what it'll look like
by clicking the "View" button in this review.

It should look like:

...chatbot does two things:

Sends messages to XMPP users via http get:

The server is running on port 5000.

If running on a virtual machine, use:

http://:5000/send_message?recipient=&message=

If running locally, use:

http://localhost:5000/send_message?recipient=&message=

Responds to incoming ...

ie:

You shouldn't indent the first line

Subsequent lines shouldn't be indented so much. Otherwise,
they become code blocks.

If you want something on a new line, you have to separate it
by a blank line.

For numbered lists, the actual number you use doesn't matter ;)

See here
https://guides.github.com/features/mastering-markdown/ for a
markdown tutorial

In appengine/standard/xmpp_wikibot/README.md
#596 (review)
:
@@ -0,0 +1,62 @@
+# Uncyclobot example that can be run on Google Compute Engine
+
+This sample shows how to use the SleekXMPP
+client and Flask to build a simple chatbot that can
+be run on Google Compute Engine. The
+chatbot does two things:
Sends messages to XMPP users via http get:
  The server is running on port 5000
  if running on virtual machine use:
  http://<MACHINE IP>:5000/send_message?recipient=<RECIPIENT ADDRESS>&message=<MSG>
  If running locally use:
  http://localhost:5000/send_message?recipient=<RECIPIENT ADDRESS>&message=<MSG>
Responds to incoming messages with a wikipedia page on the topic:
capital-W-Uncyclopedia

In appengine/standard/xmpp_wikibot/README.md
#596 (review)
:
+chatbot does two things:
Sends messages to XMPP users via http get:
  The server is running on port 5000
  if running on virtual machine use:
  http://<MACHINE IP>:5000/send_message?recipient=<RECIPIENT ADDRESS>&message=<MSG>
  If running locally use:
  http://localhost:5000/send_message?recipient=<RECIPIENT ADDRESS>&message=<MSG>
Responds to incoming messages with a wikipedia page on the topic:
  Send a message with a topic (e.g., 'Hawaii') to the XMPP account the server is using
  It should respond with a Uncyclopedia page (when one exists)
+## Setup
+
+Follow the intstructions at the
instructions

In appengine/standard/xmpp_wikibot/README.md
#596 (review)
:
  http://<MACHINE IP>:5000/send_message?recipient=<RECIPIENT ADDRESS>&message=<MSG>
  If running locally use:
  http://localhost:5000/send_message?recipient=<RECIPIENT ADDRESS>&message=<MSG>
Responds to incoming messages with a wikipedia page on the topic:
  Send a message with a topic (e.g., 'Hawaii') to the XMPP account the server is using
  It should respond with a Uncyclopedia page (when one exists)
+## Setup
+
+Follow the intstructions at the
+Compute Engine Quickstart Guide
+on how to create a project, create a virtual machine, and connect to your
+instance via SSH. Once you have done this, you may jump to 'Installing files
+and dependencies'
...jump to 'Installing files and dependencies'

In appengine/standard/xmpp_wikibot/README.md
#596 (review)
:

+## Setup
+
+Follow the intstructions at the
+Compute Engine Quickstart Guide
+on how to create a project, create a virtual machine, and connect to your
+instance via SSH. Once you have done this, you may jump to 'Installing files
+and dependencies'
+
+You should also download the Google Cloud SDK.
+It will allow you to access many of the features of Google Compute Engine via
+your local machine.
+
+
+### Installing files and dependencies
+
+First, install the wikibot.py and requirements.txt files onto your remote

wikibot.py ... requirements.txt

(ie surround with backticks, by convention)

In appengine/standard/xmpp_wikibot/README.md
#596 (review)
:

+Compute Engine Quickstart Guide
+on how to create a project, create a virtual machine, and connect to your
+instance via SSH. Once you have done this, you may jump to 'Installing files
+and dependencies'
+
+You should also download the Google Cloud SDK.
+It will allow you to access many of the features of Google Compute Engine via
+your local machine.
+
+
+### Installing files and dependencies
+
+First, install the wikibot.py and requirements.txt files onto your remote
+instance. See the guide on
+Transferring Files
+for more information on how to do this using the Mac file browser, scp, or

scp

In appengine/standard/xmpp_wikibot/README.md
#596 (review)
:

+## Running the sample
+
+You'll need to have an XMPP account prior to actually running the sample.
+If you do not have one, you can easily create an account at one of the many
+XMPP servers such as Jabber.at.
+Once you have an account, run the following command:
+

python wikibot.py

+Then add the username (e.g., '[email protected]') and password for the account that
+you'd like to use for your chatbot.
+
+
+### Running on your local machine
+
+You may also run the sample locally by simply copying wikibot.py to a project

wikibot.py

In appengine/standard/xmpp_wikibot/wikibot.py
#596 (review)
:
+# ourselves to UTF-8.
+if sys.version_info < (3, 0):

from sleekxmpp.util.misc_ops import setdefaultencoding

setdefaultencoding('utf8')
+else:

raw_input = input

+app = Flask(name)
+
+chat_client = None #this will be initialized when the wikibot is constructed
+
[email protected]('/send_message', methods=['GET'])
+def send_message():
try:
   recipient = request.args.get('recipient')
   message = request.args.get('message')
If you're using .get, there should never be a KeyError

http://werkzeug.pocoo.org/docs/0.11/datastructures/#werkzeug.datastructures.MultiDict.get

In appengine/standard/xmpp_wikibot/wikibot.py
#596 (review)
:
+chat_client = None #this will be initialized when the wikibot is constructed
+
[email protected]('/send_message', methods=['GET'])
+def send_message():
try:
   recipient = request.args.get('recipient')
   message = request.args.get('message')
except KeyError as e:
   logging.info("key error: {0}".format(e))
if chat_client and recipient and message:
   chat_client.send_message(mto=recipient, mbody=message)
   return "message sent to:" + recipient + " with body:" + message
else:
   logging.info("chat client or recipient or message does not exist!")
return "message failed to send"
Should probably return an error code as well:

return 'message failed to send', 500

In appengine/standard/xmpp_wikibot/wikibot.py
#596 (review)
:
def message(self, msg):
   """
   Process incoming message stanzas. Be aware that this also
   includes MUC messages and error messages. It is usually
   a good idea to check the messages's type before processing
   or sending replies. If the message is the appropriate type,
   then the bot checks wikipedia to see if the message string
   exists as a page on the site. If so, it sends this link back
   to the sender in the reply.
   Arguments:
       msg -- The received message stanza. See the SleekXMPP documentation
              for stanza objects and the Message stanza to see
              how it may be used.
   """
   if msg['type'] in ('chat', 'normal'):
       msg_body = "%(body)s" % msg
Couldn't you just do msg_body = msg['body']? The string format seems
gratuitous...

—
You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub
#596 (review),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AUBaDtK349qsW2OuyQGYvBABm3scWo3lks5q16iXgaJpZM4KbnJO
.

jerjou · 2016-10-26T17:22:38Z

Can you move these files into compute/ rather than appengine/standard, since it's not an appengine app?

jerjou · 2016-11-08T21:32:44Z

I believe this has been superceded with #618

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 20, 2016

theacodes suggested changes Oct 20, 2016

View reviewed changes

theacodes reviewed Oct 20, 2016

View reviewed changes

jerjou reviewed Oct 20, 2016

View reviewed changes

mogar1980 added 9 commits October 25, 2016 23:38

adding new xmpp wikibot example

b67799c

address merge comments

f83d610

updated readme formatting

a8adbaf

updated readme formatting again

0508f7f

server now runs on port 80

bad4349

back to running server on port 5000

3f7b457

udated README with firewall setup instructions

85c25d3

udated README with firewall setup instructions 2

82633a4

minor cosmetic changes

49a7b53

mogar1980 force-pushed the master branch from b6c7b4f to 49a7b53 Compare October 26, 2016 06:39

jerjou closed this Nov 8, 2016


		"""Uncyclobot server example using SleekXMPP client library"""

		import sys


		import sleekxmpp

		# Python versions before 3.0 do not use UTF-8 encoding


		### Installing files and dependencies

		First, install the wikibot.py and requirements.txt files onto your remote


		### Running on your local machine

		You may also run the sample locally by simply copying wikibot.py to a project

adding new xmpp wikibot example #596

adding new xmpp wikibot example #596

Uh oh!

Conversation

mogar1980 commented Oct 20, 2016

Uh oh!

theacodes commented Oct 20, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mogar1980 commented Oct 26, 2016

Uh oh!

mogar1980 commented Oct 26, 2016

@jerjou commented on this pull request.

capital-W-Uncyclopedia

instructions

(ie surround with backticks, by convention)

Uh oh!

jerjou commented Oct 26, 2016

Uh oh!

jerjou commented Nov 8, 2016

Uh oh!

Uh oh!