Merge lp:~matthew-earl/endroid/endroid into lp:endroid

[Matthew Earl]

Add tee/cat equivalents of endroid_echo

Add tee/cat equivalents of endroid_echo

[ChrisD (gingerchris)]

Looks good

review: Approve

=== added file 'bin/endroid_cat'
--- bin/endroid_cat	1970-01-01 00:00:00 +0000
+++ bin/endroid_cat	2013-08-15 13:51:45 +0000
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+endroid_remote cat $@
+

=== added file 'bin/endroid_echo'
--- bin/endroid_echo	1970-01-01 00:00:00 +0000
+++ bin/endroid_echo	2013-08-15 13:51:45 +0000
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+endroid_remote echo $@
+

=== renamed file 'bin/endroid_echo' => 'bin/endroid_remote'
--- bin/endroid_echo	2013-08-09 11:45:04 +0000
+++ bin/endroid_remote	2013-08-15 13:51:45 +0000
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/env python
 
 import os
 import sys
@@ -11,9 +11,80 @@
 class UserError(Exception):
     pass
 
+class UsageError(UserError):
+    def __init__(self):
+        usage_lines = ["Usage:"]
+        
+        for cls in mode_classes.values():
+            usage_lines.append("    {bin} {cmd} {usage}".format(
+                bin=sys.argv[0], cmd=cls.cmd, usage=cls.usage))
+            usage_lines.append("        " + cls.help)
+
+        super(UsageError, self).__init__('\n'.join(usage_lines))
+
+class Mode(object):
+    pass
+
+class Tee(Mode):
+    cmd = 'tee'
+    usage = ''
+    help = ('Read lines from stdin, print them to stdout and send them to '
+            'EnDroid.')
+
+    def __init__(self, args):
+        if len(args) > 0:
+            raise UsageError()
+    
+    def get_message(self):
+        msg = ""
+
+        line = sys.stdin.readline()
+        while line:
+            sys.stdout.write(line)      
+            sys.stdout.flush()
+            msg += line
+
+            line = sys.stdin.readline()
+
+        return msg
+    
+class Echo(Mode):
+    cmd = 'echo'
+    usage = ' <message>'
+    help = 'Send <message> to EnDroid.'
+    
+    def __init__(self, args):
+        if len(args) > 1:
+            raise UsageError()
+        self.msg = ' '.join(args)
+
+    def get_message(self):
+        return self.msg
+
+class Cat(Mode):
+    cmd = 'cat'
+    usage = ''
+    help = 'Read lines from stdin and send them to EnDroid.'
+
+    def __init__(self, args):
+        if len(args) > 0:
+            raise UsageError()
+
+    def get_message(self):
+        return sys.stdin.read()
+    
+mode_classes = dict((cls.cmd, cls) for cls in (Tee, Echo, Cat))
+    
 try:
     if len(sys.argv) < 2:
-        raise UserError("Usage: %s <Message>" % sys.argv[0])
+        raise UsageError()
+
+    try:
+        mode_class = mode_classes[sys.argv[1]]
+    except KeyError:
+        raise UsageError()
+
+    mode = mode_class(sys.argv[2:])
 
     if JID_ENV_VAR not in os.environ:
         raise UserError("Target user env var (%s) not set" % JID_ENV_VAR)
@@ -23,10 +94,10 @@
 
     if URL_ENV_VAR not in os.environ:
         raise UserError("Endroid URL env var (%s) not set" % URL_ENV_VAR)
-        
-    params = {'user': os.environ[JID_ENV_VAR],
-              'key': os.environ[KEY_ENV_VAR],
-              'message': ' '.join(sys.argv[1:])}
+    
+    params = {'user': os.environ[JID_ENV_VAR],    
+              'key': os.environ[KEY_ENV_VAR],    
+              'message': mode.get_message()}
 
     f = urllib.urlopen(os.environ[URL_ENV_VAR], urllib.urlencode(params))
     for line in f.readlines():

=== added file 'bin/endroid_tee'
--- bin/endroid_tee	1970-01-01 00:00:00 +0000
+++ bin/endroid_tee	2013-08-15 13:51:45 +0000
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+endroid_remote tee $@
+

=== modified file 'debian/endroid.install'
--- debian/endroid.install	2013-08-14 10:00:18 +0000
+++ debian/endroid.install	2013-08-15 13:51:45 +0000
@@ -2,6 +2,9 @@
 etc/endroid.conf usr/share/doc/endroid/examples/
 etc/init/endroid.conf etc/init/
 bin/endroid usr/bin/
+bin/endroid_remote usr/bin/
 bin/endroid_echo usr/bin/
+bin/endroid_cat usr/bin/
+bin/endroid_tee usr/bin/
 lib/wokkel-0.7.1-py2.7.egg usr/lib/endroid/dependencies
 var/endroid.db var/lib/endroid/db

=== modified file 'doc/wiki/Reference'
--- doc/wiki/Reference	2013-08-14 09:56:14 +0000
+++ doc/wiki/Reference	2013-08-15 13:51:45 +0000
@@ -531,6 +531,8 @@
 "message_here" to the user with JID {{{ENDROID_REMOTE_USER}}} provided that they have enabled the remote plugin (by typing {{{allow remote}}} to !EnDroid and receiving their key in response) and that
 {{{ENDROID_REMOTE_KEY}}} matches the user's remote plugin key. The default value for {{{ENDROID_REMOTE_URL}}} would be {{{http://127.0.0.1:8880/remote/}}} .
 
+In addition {{{endroid_cat}}} and {{{endroid_tee}}} scripts are provided which redirect {{{stdin}}} to EnDroid. {{{endroid_tee}}} also prints input to stdout, whilst {{{endroid_cat}}} consumes all input.
+
 
 == Patternmatcher ==