Changeset 23:adc5b22efd7e in mailjam

Timestamp:

May 22, 2012, 7:31:12 PM (13 years ago)

Author:

Borja Lopez <borja@…>

Branch:

default

Phase:

public

Message:

Added the first version of the CLI client, which implements a shell-like
interface where users can interact with a mailjam server.

This first versions adds no "big" features, but contains the basis to build
a complete shell interface (including history saving support, completion,
help for commands, etc)

Added a custom configuration file (conf/mailjam-cli.conf) for the CLI
client.

Added a new mailjam.config class (CLIClientConfig) that is used by the CLI
client to load its configuration file.

Updated the package information (setup.py, MANIFEST) to include the CLI
client data.

Modified the behaviour of the XMLRPC methods registered in the *XMLRPC classes
within the daemon module. Now instead of raising exceptions directly, they
catch such exceptions, returning only a string representation of the error
to the XMLRPC client. If there is no error, a nice "ok" message is returned.

Files:

• MANIFEST (modified) (1 diff)
• bin/mailjam-cli (added)
• bin/mailjam-mta (modified) (1 diff)
• conf/mailjam-cli.conf (added)
• mailjam/cli.py (added)
• mailjam/config.py (modified) (2 diffs)
• mailjam/daemon.py (modified) (3 diffs)
• mailjam/models.py (modified) (3 diffs)
• setup.py (modified) (1 diff)

MANIFEST

@@ -2 +2 @@
 README
 setup.py
+bin/mailjam-cli
 bin/mailjam-mta
 bin/mailjam-server
 mailjam/__init__.py
+mailjam/cli.py
 mailjam/config.py
 mailjam/daemon.py

bin/mailjam-mta

@@ -3 +3 @@
 # Run the Mailjam MTA client
 
-import argparse, sys
+import argparse
 from mailjam.mta import MTAClient
 

mailjam/config.py

@@ -89 +89 @@
         return self.config[section]
 
+
 class MTAClientConfig(DaemonConfig):
     @property
@@ -97 +98 @@
     def sections(self):
         return ['server', 'archive']
+
+
+class CLIClientConfig(DaemonConfig):
+    @property
+    def default_filename(self):
+        return 'mailjam-cli.conf'
+
+    @property
+    def sections(self):
+        return ['server', 'archive', 'history']
 
 

mailjam/daemon.py

@@ -163 +163 @@
     def _listMethods(self):
         public_methods = []
-        public_methods += ['lists.'+i for i in dir(MailingListXMLRPC) if '_' not in i]
-        public_methods += ['members.'+i for i in dir(MemberXMLRPC) if '_' not in i]
+        public_methods += ['lists.'+i for i in dir(MailingListXMLRPC) \
+                           if '_' not in i]
+        public_methods += ['members.'+i for i in dir(MemberXMLRPC) \
+                           if '_' not in i]
         return public_methods
 
@@ -177 +179 @@
         self.mailjam.load()
     def add(self, info={}):
-        self.mailjam.add_mailing_list(info)
+        try:
+            self.mailjam.add_mailing_list(info)
+        except IndexError, e:
+            return str(e)
+        return 'Added mailing list ' + info['address']  
     def addresses(self):
-        return self.mailjam.mailings_addresses    
+        return self.mailjam.mailings_addresses
 
 
@@ -187 +193 @@
         self.mailjam.load()
     def add(self, member_addr=None, list_addr=None):
-        self.mailjam.add_mailing_member(member_addr, list_addr)
+        try:
+            self.mailjam.add_mailing_member(member_addr, list_addr)
+        except IndexError, e:
+            return str(e)
+        return 'Added member ' + member_addr + ' to ' + list_addr
     def list(self, mailing):
         if mailing in self.mailjam.mailings_addresses:

mailjam/models.py

@@ -33 +33 @@
     def _validate_address(self, address):
         if not validate_email_address(address):
-            raise ValueError(address, ' is not a valid email address')
+            raise ValueError(str(address) + ' is not a valid email address')
         return address
 
@@ -63 +63 @@
     def _validate_member_object(self, member=None):
         if not isinstance(member, Member):
-            raise TypeError(member, ' is not a valid Member instance')
+            raise TypeError(str(member) + ' is not a valid Member instance')
         return member
 
@@ -72 +72 @@
     def _validate_member_by_address(self, address=None):
         if not validate_email_address(address):
-            raise ValueError(address, ' is not a valid email address')
+            raise ValueError(str(address) + ' is not a valid email address')
         return address in self.members_addresses()
 

setup.py

@@ -23 +23 @@
     description='Mailing lists management software',
     long_description=open('README').read(),
-    scripts=['bin/mailjam-server', 'bin/mailjam-mta'],
+    scripts=['bin/mailjam-server', 'bin/mailjam-mta', 'bin/mailjam-cli'],
     #data_files=[(proper_etc_path()+'mailjam', ['conf/mailjam.conf',
     #                                           'conf/mailjam-mta.conf']),