adding new xmpp wikibot example

[mogar1980]

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

[theacodes]

@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]

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]

prefer argparse over optparse.

[theacodes]

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

[theacodes]

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

[theacodes]

Google Talk is dead, no?

[theacodes]

Please use format over % throughout.

[theacodes]

please use single quotes throughout.

[theacodes]

Python variables are snake_case, never lowerCamelCase.

[theacodes]

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]

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:

1. You shouldn't indent the first line
2. Subsequent lines shouldn't be indented so much. Otherwise, they become code blocks.
3. If you want something on a new line, you have to separate it by a blank line.
4. For numbered lists, the actual number you use doesn't matter ;)
5. See here for a markdown tutorial

[jerjou]

capital-W-Wikipedia

[jerjou]

instructions

[jerjou]

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

[jerjou]

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

(ie surround with backticks, by convention)

[jerjou]

`scp` 

[jerjou]

`wikibot.py` 

[jerjou]

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

[jerjou]

Should probably return an error code as well:

return 'message failed to send', 500 

[jerjou]

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

[mogar1980]

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

[mogar1980]

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 morgan.hallmon@gmail.com
wrote:

Perfect! Thanks, Morgan

On Thursday, October 20, 2016, Jon Wayne Parrott jonwayne@google.com
wrote:

Yeah I should be able to swing that.

On Thu, Oct 20, 2016 at 1:23 PM Morgan Hallmon morgan.hallmon@gmail.com
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 jonwayne@google.com
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 <
morgan.hallmon@gmail.com> 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:

1. The general functionality is retained (sending messages via GET
   and responding to incoming chats with a Wikipedia page on the subject)
2. 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 notifications@github.com
wrote:

@jerjou commented on this pull request.

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

@@ -0,0 +1,62 @@
+# Wikibot 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:

• 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://:5000/send_message?recipient=&message=

   If running locally, use:

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

2. Responds to incoming ...

ie:

1. You shouldn't indent the first line
2. Subsequent lines shouldn't be indented so much. Otherwise,
   they become code blocks.
3. If you want something on a new line, you have to separate it
   by a blank line.
4. For numbered lists, the actual number you use doesn't matter ;)
5. 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 @@
+# Wikibot 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:

• 1. 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> 
• 2. Responds to incoming messages with a wikipedia page on the topic:

capital-W-Wikipedia

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

+chatbot does two things:

• 1. 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> 
• 2. 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 Wikipedia 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> 
• 2. 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 Wikipedia 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., 'bob@jabber.at') 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
+
+@app.route('/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
+
+@app.route('/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]

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

[jerjou]

I believe this has been superceded with #618