Merge lp:~gingerchris/endroid/sms-changes into lp:endroid

[ChrisD]

Rename sms block commands

 - Change blocked commands to sms block and sms unblock
 - remove who is blocked change to just sms block without an argument

[Phil Connell (pconnell)]

Inline:

review: Needs Fixing

[ChrisD (gingerchris)]

New rev coming with markups as well as some bug fixes.

review: Needs Resubmitting

[lp:~gingerchris/endroid/sms-changes]

87. By Chris Davidson <email address hidden> on 2014-09-12

Markups and bugfixes

[Phil Connell (pconnell)]

review: Approve

=== modified file 'src/endroid/plugins/sms/__init__.py'
--- src/endroid/plugins/sms/__init__.py	2014-09-10 10:50:57 +0000
+++ src/endroid/plugins/sms/__init__.py	2014-09-12 12:23:12 +0000
@@ -62,12 +62,16 @@
         """
 
     name = "sms"
-    help = "Send SMS to someone. " \
-           "Use 'sms set number <num>' to set your phone number. "\
-           "Use 'sms whoami' to see what I think your number is. "\
-           "Use 'sms forget me' to make me forget your number. "\
-           "Use 'sms send <user> <message>' to send an SMS to a user. "\
-           "Aliases: setnum, getnum, delnum."
+    help = ("Send an SMS to someone. \n" 
+            "'sms set number <num>' set your phone number.\n"
+            "'sms whoami' find out what I think your number is.\n"
+            "'sms forget me' make me forget your number.\n"
+            "Aliases: setnum, getnum, delnum.\n"
+            "'sms send <user> <message>' send an SMS to a user.\n"
+            "'sms block <user>' prevent <user> from sending you messages.\n"
+            "'sms unblock <user>' unblock a user.\n"
+            "'sms blocked' display the users you have blocked.\n")
+         
 
     dependencies = ['endroid.plugins.ratelimit']
 
@@ -158,8 +162,17 @@
             raise self.UserNotFoundError
         return results[0]['texts_sent_this_period']
 
-    @command(helphint="{sender}")
-    def block_sender(self, msg, arg):
+    @command()
+    def sms_blocked(self, msg, arg):
+        users_blocked = self.whos_blocked(msg.sender)
+        if users_blocked:
+            msg.reply("The following users are prevented from sending you "
+                      "SMS messages:\n{}".format(", ".join(users_blocked)))
+        else:
+            msg.reply("You haven't blocked anyone at the moment.")
+
+    @command(helphint="[{sender}]")
+    def sms_block(self, msg, arg):
         """
         Blocks a JID from sending sms messages to this person.
         msg.sender: this person
@@ -167,11 +180,16 @@
         """
         user = msg.sender
         user_to_block = arg.strip()
-        # JID for user_to_block cant have white space in it
-
+
+        if not user_to_block:
+            msg.reply("You don't appear to have specified a user to block.")
+            return
+
+        # JID for user_to_block cannot have white space in it
         if " " in user_to_block:
             msg.reply("The user you wish to block can't have whitespace in it.")
-            raise self.InvalidJIDError
+            return
+
         people_blocked = self.whos_blocked(user)
         if user_to_block in people_blocked:
             msg.reply("User {} already blocked".format(user_to_block))
@@ -182,29 +200,24 @@
                       "you.".format(user_to_block))
 
     @command(helphint="{sender}")
-    def unblock_sender(self, msg, arg):
+    def sms_unblock(self, msg, arg):
         """
         Unblocks the sender from sending SMS messages to the receiver
         """
         user = msg.sender
         user_to_unblock = arg.strip()
+        if not user_to_unblock:
+            msg.reply("You don't appear to have specified a user to unblock.")
+            return
         people_blocked = self.whos_blocked(user)
         if user_to_unblock not in people_blocked:
-            msg.reply("User {} already not blocked".format(user_to_block))
+            msg.reply("User {} already not blocked".format(user_to_unblock))
         else:
             people_blocked.remove(user_to_unblock)
             self.set_blocked_users(user, people_blocked)
             msg.reply("{} has been unblocked from sending SMS to "
                       "you.".format(user_to_unblock))
 
-    @command()
-    def who_is_blocked(self, msg, arg):
-        users_blocked = self.whos_blocked(msg.sender)
-        if users_blocked:
-            msg.reply(", ".join(users_blocked))
-        else:
-            msg.reply("You haven't blocked anyone at the moment.")
-
     def set_blocked_users(self, receiver, senders):
         """Prevent senders from being able to send SMSs to receiver."""
 
@@ -228,7 +241,7 @@
             # @@@UNICODE I don't even know where to start...
             users_blocked_str = results[0]['users_blocked'].encode('ascii')
             if users_blocked_str:
-                users_blocked = set(users_blocked.split(","))
+                users_blocked = set(users_blocked_str.split(","))
 
         return users_blocked
 
@@ -353,7 +366,6 @@
                         endroid_number = self.vars['phone_number']
                         sid = self.vars['twilio_sid']
 
-                        # send <to_send> to number <number>
                         response = smslib.send(endroid_number, number,
                                                message, sid, auth_token)
                         def log_success(resp):