Damir Systems Inc.

Time to clean up a bit. As new services are added this code is becoming bulky. I was writing it bottom-up, code as you go — no wonder. Time to stop coding and reflect on it, before it bloats out of control.

The first task is to identify code that changes with the addition of a service.

It should be noted that — at present — multiple templates are loaded in memory, but only one is needed.  This will have to be reworked to load code and a template for only one service at a time.

So here is the task list:

• Extract GPS data collection and parsing into a separate module or class.
• Each template gets its own module with generic template() function to return the string.
• Put each service in its own module with generic send()  function.
• Load required template and service modules dynamically into the main module.
• Try to follow Python naming conventions for function names, classes etc.
• Use consistent naming convention for module files.
• And first, before anything else, write a test set (unit test) to deal with bugs introduced while refactoring.

Time goes by.

Ok, done; these are new (modified) modules, after refactoring.

Services:

• gps_service_none.py — no service, print to screen only;
• gps_service_aws.py — Amazon SQS bus;
• gps_service_rc.py — ruleCore Geofence CEP;
• gps_service_tweet.py — Tweeter messages;
• gps_service_coral8.py — Coral8 ESP/CEP;
• gps_service_email.py — plain email.

Templates:

• gps_template_xml.py — generic XML;
• gps_template_json.py — generic JSON;
• gps_template_rcxml.py — ruleCore XML;
• gps_template_tweet.py — short message for Twitter;
• gps_template_email.py — format for email.

Authorization data:

• gps_auth_aws.py — Amazon SQS;
• gps_auth_rc.py — ruleCore;
• gps_auth_tweet.py — Tweeter;
• gps_auth_coral8.py — Coral8;
• gps_auth_email.py — plain email.

Other:

• gps_event.py — main module to run;
• gps_devices.py — collecting and parsing GPS data;

Lots of files, but keep in mind that only one set (service  + template + authorization) is loaded at a time. All files reside in the same directory. I do not list test units here, essentially each code module has a matching test_.py. You may notice that some services are not implemented yet, the modules are simply place-holders. This is one of the benefits of refactoring, it does not just clean up the code — it includes redesign to allow for seamless future changes.

With this structure in place I should be ready for the next fun episode — twitter the GPS.

To be continued.