revolution 0.2 → 0.3

data/revolution.c

@@ -1,14 +1,9 @@
 #include <stdio.h>
-
 #include "ruby.h"
-
-#include "glib.h"
-#include <glib-object.h>
-
 #include <libebook/e-book.h>
 #include <libecal/e-cal.h>
 
-VALUE crRevolution;
+VALUE cRevolution;
 VALUE module;
 
 /* 
@@ -61,23 +56,25 @@ void copy_uid(const VALUE ruby_obj, ECalComponent* ev_obj) {
 
 ///////////////////////////////////////////////////////
 // Tasks
-VALUE crEvTask;
+VALUE cTask;
 
 /* 
  *	call-seq:
- *		new() -> EvTask
+ *		new() -> Task
  *		
- * Creates a new EvTask object
+ * Creates a new Task object
+ *
+ * Attributes:
+ *  @uid - a unique id for this task
+ *  @summary
+ *  @description
+ *  @start - the start Time
+ *  @due - the due Time
+ *  @status - 'Not started', 'In progress', 'Completed', 'Cancelled'
+ *  @priority - 'Low', 'Medium', 'High', or nil
+ *  @last_modification - Time of last modification
  */
 static VALUE evTask_init(VALUE self) {
-  rb_define_attr(crEvTask, "uid", 1, 0);
-  rb_define_attr(crEvTask, "summary", 1, 0);
-  rb_define_attr(crEvTask, "description", 1, 0);
-  rb_define_attr(crEvTask, "start", 1, 0);
-  rb_define_attr(crEvTask, "due", 1, 0);
-  rb_define_attr(crEvTask, "status", 1, 0);
-  rb_define_attr(crEvTask, "priority", 1, 0);
-  rb_define_attr(crEvTask, "last_modification", 1, 0);
 	return Qtrue;
 }
 
@@ -172,7 +169,7 @@ static VALUE revolution_get_all_tasks(VALUE self) {
 
 	for (l = objects; l;l = l->next) {
     ECalComponent *ev_task = E_CAL_COMPONENT (l->data);
-		VALUE ruby_task = rb_class_new_instance(0, 0, crEvTask);
+		VALUE ruby_task = rb_class_new_instance(0, 0, cTask);
 		copy_into_task(ruby_task, ev_task);
 		rb_ary_push(result, ruby_task);	
     g_object_unref (ev_task);
@@ -183,26 +180,27 @@ static VALUE revolution_get_all_tasks(VALUE self) {
 
 ///////////////////////////////////////////////////////
 // Calendar
-VALUE crEvAppointment;
+VALUE cAppointment;
 
 /* 
  *	call-seq:
- *		new() -> EvAppointment
+ *		new() -> Appointment
  *		
- * Creates a new EvAppointment object
+ * Creates a new Appointment object
+ *
+ * Attributes:
+ *  @uid - a unique id for this task
+ *  @summary
+ *  @location
+ *  @organizer
+ *  @start - start Time 
+ *  @end - end Time
+ *  @alarm_set - is an alarm set for this appointment
+ *  @busy_status
+ *  @recurring - is this appointment recurring
+ *  @last_modification
  */
 static VALUE evAppointment_init(VALUE self) {
-  rb_define_attr(crEvAppointment, "uid", 1, 0);
-  rb_define_attr(crEvAppointment, "summary", 1, 0);
-  rb_define_attr(crEvAppointment, "location", 1, 0);
-  rb_define_attr(crEvAppointment, "organizer", 1, 0);
-  rb_define_attr(crEvAppointment, "start", 1, 0);
-  rb_define_attr(crEvAppointment, "end", 1, 0);
-  rb_define_attr(crEvAppointment, "last_modification", 1, 0);
-  rb_define_attr(crEvAppointment, "alarm_set", 1, 0);
-  rb_define_attr(crEvAppointment, "busy_status", 1, 0);
-  rb_define_attr(crEvAppointment, "recurring", 1, 0);
-  // INLINE RUBY CODE define an "all_day" method
   return Qtrue;
 }
 
@@ -282,7 +280,7 @@ static VALUE revolution_get_all_appointments(VALUE self, VALUE start, VALUE end)
 
 	for (l = results; l;l = l->next) {
     ECalComponent *ev_appt = E_CAL_COMPONENT(l->data);
-		VALUE ruby_appt = rb_class_new_instance(0, 0, crEvAppointment);
+		VALUE ruby_appt = rb_class_new_instance(0, 0, cAppointment);
 		copy_into_appt(ruby_appt, ev_appt);
 		rb_ary_push(result, ruby_appt);	
     g_object_unref (ev_appt);
@@ -296,69 +294,73 @@ static VALUE revolution_get_all_appointments(VALUE self, VALUE start, VALUE end)
 
 ///////////////////////////////////////////////////////
 // Address Book
-VALUE crEvContact;
-VALUE crEvContactAddress;
-VALUE crEvContactIMAddress;
+VALUE cContact;
+VALUE cContactAddress;
+VALUE cContactIMAddress;
 
 /* 
  *	call-seq:
- *		new() -> EvContact
+ *		new() -> Contact
  *		
- * Creates a new EvContact object
+ * Creates a new Contact object
+ *
+ * Attributes:
+ *  @uid - the unique ID for this contact
+ *  @first_name
+ *  @last_name
+ *  @email_addresses - a Hash of type->addr, i.e. 'HOME'->['tom@home.com', 'tom@bar.com']
+ *  @birthday - a Time
+ *  @home_phone
+ *  @work_phone
+ *  @mobile_phone
+ *  @home_address - an ContactAddress object
+ *  @work_address - an ContactAddress object
+ *  @other_address - an ContactAddress object
+ *  @organization - employee
+ *  @title - job title 
+ *  @im_addresses - an Array of ContactIMAddress objects
  */
 static VALUE evContact_init(VALUE self) {
-  rb_define_attr(crEvContact, "uid", 1, 0);
-  rb_define_attr(crEvContact, "first_name", 1, 0);
-  rb_define_attr(crEvContact, "last_name", 1, 0);
-  rb_define_attr(crEvContact, "home_email", 1, 0);
-  rb_define_attr(crEvContact, "work_email", 1, 0);
-  rb_define_attr(crEvContact, "email_addresses", 1, 0);
-  rb_define_attr(crEvContact, "birthday", 1, 0);
-  rb_define_attr(crEvContact, "home_phone", 1, 0);
-  rb_define_attr(crEvContact, "work_phone", 1, 0);
-  rb_define_attr(crEvContact, "mobile_phone", 1, 0);
-  rb_define_attr(crEvContact, "home_address", 1, 0);
-  rb_define_attr(crEvContact, "work_address", 1, 0);
-  rb_define_attr(crEvContact, "other_address", 1, 0);
-  rb_define_attr(crEvContact, "organization", 1, 0);
-  rb_define_attr(crEvContact, "title", 1, 0);
-  rb_define_attr(crEvContact, "im_addresses", 1, 0);
   return Qtrue;
 }
 
 /* 
  *	call-seq:
- *		new() -> EvContactIMAddress
+ *		new() -> ContactIMAddress
  *		
- * Creates a new EvContactIMAddress object
+ * Creates a new ContactIMAddress object
+ *
+ * Attributes:
+ *  @provider - i.e., AOL, Yahoo
+ *  @address - i.e., tom_copeland
+ *  @type - HOME or WORK
  */
 static VALUE evContactIMAddress_init(VALUE self) {
-  rb_define_attr(crEvContactIMAddress, "provider", 1, 0);
-  rb_define_attr(crEvContactIMAddress, "location", 1, 0);
-  rb_define_attr(crEvContactIMAddress, "address", 1, 0);
   return Qtrue;
 }
 /* 
  *	call-seq:
- *		new() -> EvContactAddress
+ *		new() -> ContactAddress
  *		
- * Creates a new EvContactAddress object
+ * Creates a new ContactAddress object
+ *
+ * Attributes:
+ *  @address_format
+ *  @po - P.O. Box
+ *  @ext
+ *  @street
+ *  @locality
+ *  @region
+ *  @code
+ *  @country
  */
 static VALUE evContactAddress_init(VALUE self) {
-  rb_define_attr(crEvContactAddress, "address_format", 1, 0);
-  rb_define_attr(crEvContactAddress, "po", 1, 0);
-  rb_define_attr(crEvContactAddress, "ext", 1, 0);
-  rb_define_attr(crEvContactAddress, "street", 1, 0);
-  rb_define_attr(crEvContactAddress, "locality", 1, 0);
-  rb_define_attr(crEvContactAddress, "region", 1, 0);
-  rb_define_attr(crEvContactAddress, "code", 1, 0);
-  rb_define_attr(crEvContactAddress, "country", 1, 0);
   return Qtrue;
 }
 
 void copy_in_address(EContactAddress* address, VALUE ruby_contact, char* field) {
 	if (address) {
-		VALUE rb_addr = rb_class_new_instance(0, 0, crEvContactAddress);
+		VALUE rb_addr = rb_class_new_instance(0, 0, cContactAddress);
 		rb_iv_set(rb_addr, "@address_format", address->address_format ? rb_str_new2(address->address_format) : Qnil);
 		rb_iv_set(rb_addr, "@po", address->po ? rb_str_new2(address->po) : Qnil);
 		rb_iv_set(rb_addr, "@ext", address->ext ? rb_str_new2(address->ext) : Qnil);
@@ -377,7 +379,7 @@ void copy_in_im_address(VALUE im_addresses, char* address, char* provider, char*
 	if (!address) {
 		return;
 	}
-	VALUE rb_addr = rb_class_new_instance(0, 0, crEvContactIMAddress);
+	VALUE rb_addr = rb_class_new_instance(0, 0, cContactIMAddress);
 	rb_iv_set(rb_addr, "@provider", rb_str_new2(provider));
 	rb_iv_set(rb_addr, "@location", rb_str_new2(location));
 	rb_iv_set(rb_addr, "@address", rb_str_new2(address));
@@ -492,7 +494,7 @@ static VALUE revolution_get_all_contacts(VALUE self) {
 	}
   for (l = results; l; l = l->next) {
   	EContact* ev_contact = E_CONTACT(l->data);
-		VALUE ruby_contact = rb_class_new_instance(0, 0, crEvContact);
+		VALUE ruby_contact = rb_class_new_instance(0, 0, cContact);
 		copy_into_contact(ruby_contact, ev_contact);
 		rb_ary_push(result, ruby_contact);	
   	g_object_unref(ev_contact);
@@ -510,24 +512,70 @@ static VALUE revolution_get_all_contacts(VALUE self) {
 void Init_revolution() {
 	module = rb_define_module("Revolution");
 
-  crEvContact = rb_define_class_under(module, "EvContact", rb_cObject);
-  rb_define_method(crEvContact, "initialize", evContact_init, 0);
-  crEvContactAddress = rb_define_class_under(module, "EvContactAddress", rb_cObject);
-  rb_define_method(crEvContactAddress, "initialize", evContactAddress_init, 0);
-  crEvContactIMAddress = rb_define_class_under(module, "EvContactIMAddress", rb_cObject);
-  rb_define_method(crEvContactIMAddress, "initialize", evContactIMAddress_init, 0);
-
-  crEvAppointment = rb_define_class_under(module, "EvAppointment", rb_cObject);
-  rb_define_method(crEvAppointment, "initialize", evAppointment_init, 0);
-
-  crEvTask = rb_define_class_under(module, "EvTask", rb_cObject);
-  rb_define_method(crEvTask, "initialize", evTask_init, 0);
+  cContact = rb_define_class_under(module, "Contact", rb_cObject);
+  rb_define_attr(cContact, "uid", 1, 0);
+  rb_define_attr(cContact, "first_name", 1, 0);
+  rb_define_attr(cContact, "last_name", 1, 0);
+  rb_define_attr(cContact, "home_email", 1, 0);
+  rb_define_attr(cContact, "work_email", 1, 0);
+  rb_define_attr(cContact, "email_addresses", 1, 0);
+  rb_define_attr(cContact, "birthday", 1, 0);
+  rb_define_attr(cContact, "home_phone", 1, 0);
+  rb_define_attr(cContact, "work_phone", 1, 0);
+  rb_define_attr(cContact, "mobile_phone", 1, 0);
+  rb_define_attr(cContact, "home_address", 1, 0);
+  rb_define_attr(cContact, "work_address", 1, 0);
+  rb_define_attr(cContact, "other_address", 1, 0);
+  rb_define_attr(cContact, "organization", 1, 0);
+  rb_define_attr(cContact, "title", 1, 0);
+  rb_define_attr(cContact, "im_addresses", 1, 0);
+  rb_define_method(cContact, "initialize", evContact_init, 0);
+  cContactAddress = rb_define_class_under(module, "ContactAddress", rb_cObject);
+  rb_define_attr(cContactAddress, "address_format", 1, 0);
+  rb_define_attr(cContactAddress, "po", 1, 0);
+  rb_define_attr(cContactAddress, "ext", 1, 0);
+  rb_define_attr(cContactAddress, "street", 1, 0);
+  rb_define_attr(cContactAddress, "locality", 1, 0);
+  rb_define_attr(cContactAddress, "region", 1, 0);
+  rb_define_attr(cContactAddress, "code", 1, 0);
+  rb_define_attr(cContactAddress, "country", 1, 0);
+  rb_define_method(cContactAddress, "initialize", evContactAddress_init, 0);
+  cContactIMAddress = rb_define_class_under(module, "ContactIMAddress", rb_cObject);
+  rb_define_attr(cContactIMAddress, "provider", 1, 0);
+  rb_define_attr(cContactIMAddress, "location", 1, 0);
+  rb_define_attr(cContactIMAddress, "address", 1, 0);
+  rb_define_method(cContactIMAddress, "initialize", evContactIMAddress_init, 0);
+
+  cAppointment = rb_define_class_under(module, "Appointment", rb_cObject);
+  rb_define_attr(cAppointment, "uid", 1, 0);
+  rb_define_attr(cAppointment, "summary", 1, 0);
+  rb_define_attr(cAppointment, "location", 1, 0);
+  rb_define_attr(cAppointment, "organizer", 1, 0);
+  rb_define_attr(cAppointment, "start", 1, 0);
+  rb_define_attr(cAppointment, "end", 1, 0);
+  rb_define_attr(cAppointment, "last_modification", 1, 0);
+  rb_define_attr(cAppointment, "alarm_set", 1, 0);
+  rb_define_attr(cAppointment, "busy_status", 1, 0);
+  rb_define_attr(cAppointment, "recurring", 1, 0);
+  rb_define_method(cAppointment, "initialize", evAppointment_init, 0);
+  // INLINE RUBY CODE define an "all_day" method
 
-	crRevolution = rb_define_class_under(module, "Revolution", rb_cObject);
-	rb_define_method(crRevolution, "initialize", revolution_init, 0);
-	rb_define_method(crRevolution, "get_all_contacts", revolution_get_all_contacts, 0);
-	rb_define_method(crRevolution, "get_all_appointments", revolution_get_all_appointments, 2);
-	rb_define_method(crRevolution, "get_all_tasks", revolution_get_all_tasks, 0);
+  cTask = rb_define_class_under(module, "Task", rb_cObject);
+  rb_define_attr(cTask, "uid", 1, 0);
+  rb_define_attr(cTask, "summary", 1, 0);
+  rb_define_attr(cTask, "description", 1, 0);
+  rb_define_attr(cTask, "start", 1, 0);
+  rb_define_attr(cTask, "due", 1, 0);
+  rb_define_attr(cTask, "status", 1, 0);
+  rb_define_attr(cTask, "priority", 1, 0);
+  rb_define_attr(cTask, "last_modification", 1, 0);
+  rb_define_method(cTask, "initialize", evTask_init, 0);
+
+	cRevolution = rb_define_class_under(module, "Revolution", rb_cObject);
+	rb_define_method(cRevolution, "initialize", revolution_init, 0);
+	rb_define_method(cRevolution, "get_all_contacts", revolution_get_all_contacts, 0);
+	rb_define_method(cRevolution, "get_all_appointments", revolution_get_all_appointments, 2);
+	rb_define_method(cRevolution, "get_all_tasks", revolution_get_all_tasks, 0);
 
 	g_type_init();
 }

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.8.4
 specification_version: 1
 name: revolution
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  version: "0.3"
 date: 2005-03-25
 summary: Revolution is a binding for the Evolution email client
 require_paths: