revolution 0.3 → 0.4

data/revolution.c

@@ -65,14 +65,14 @@ VALUE cTask;
  * 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
+ *  @uid [String] a unique id for this task
+ *  @summary [String]
+ *  @description [String]
+ *  @start [Time] the start time
+ *  @due [Time] the due time
+ *  @status [String] 'Not started', 'In progress', 'Completed', 'Cancelled'
+ *  @priority [String] 'Low', 'Medium', 'High', or nil
+ *  @last_modification [Time]
  */
 static VALUE evTask_init(VALUE self) {
 	return Qtrue;
@@ -189,16 +189,16 @@ VALUE cAppointment;
  * 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
+ *  @uid [String] a unique id for this task
+ *  @summary [String]
+ *  @location [String]
+ *  @organizer [String]
+ *  @start [Time] the start time
+ *  @due [Time] the due time
+ *  @alarm_set [Boolean] is an alarm set for this appointment
+ *  @busy_status [Boolean]
+ *  @recurring [Boolean] is this appointment recurring
+ *  @last_modification [Time]
  */
 static VALUE evAppointment_init(VALUE self) {
   return Qtrue;
@@ -305,22 +305,22 @@ VALUE cContactIMAddress;
  * 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
+ *  @uid [String] the unique ID for this contact
+ *  @first_name [String]
+ *  @last_name [String]
+ *  @email_addresses [Hash] A Hash of type->Array of addresses, i.e. 'HOME'->['tom@home.com', 'tom@bar.com']
+ *  @birthday [Time]
+ *  @home_phone [String]
+ *  @work_phone [String]
+ *  @mobile_phone [String]
+ *  @home_address [ContactAddress]
+ *  @work_address [ContactAddress]
+ *  @other_address [ContactAddress]
+ *  @organization [String]
+ *  @title [String]
+ *  @im_addresses [Array] An Array of ContactIMAddress objects
  */
-static VALUE evContact_init(VALUE self) {
+static VALUE contact_init(VALUE self) {
   return Qtrue;
 }
 
@@ -331,11 +331,11 @@ static VALUE evContact_init(VALUE self) {
  * Creates a new ContactIMAddress object
  *
  * Attributes:
- *  @provider - i.e., AOL, Yahoo
- *  @address - i.e., tom_copeland
- *  @type - HOME or WORK
+ *  @provider [String] i.e., AOL, Yahoo
+ *  @address [String] i.e., tom_copeland
+ *  @type [String] HOME or WORK
  */
-static VALUE evContactIMAddress_init(VALUE self) {
+static VALUE contactIMAddress_init(VALUE self) {
   return Qtrue;
 }
 /* 
@@ -345,16 +345,16 @@ static VALUE evContactIMAddress_init(VALUE self) {
  * Creates a new ContactAddress object
  *
  * Attributes:
- *  @address_format
- *  @po - P.O. Box
- *  @ext
- *  @street
- *  @locality
- *  @region
- *  @code
- *  @country
+ *  @address_format [String]
+ *  @po [String] P.O. Box
+ *  @ext [String]
+ *  @street [String]
+ *  @locality [String]
+ *  @region [String]
+ *  @code [String]
+ *  @country [String]
  */
-static VALUE evContactAddress_init(VALUE self) {
+static VALUE contactAddress_init(VALUE self) {
   return Qtrue;
 }
 
@@ -475,7 +475,6 @@ static VALUE revolution_get_all_contacts(VALUE self) {
 		g_clear_error(&error);
 		return result;
 	}
-
   e_book_open(book, TRUE, &error);
 	if (error) {
 		g_warning("Unable to open the Evolution address book: %s", error->message);
@@ -505,6 +504,210 @@ static VALUE revolution_get_all_contacts(VALUE self) {
 	return result;
 }
 
+EBook* open_book() {
+  GError* error = 0;
+  EBook* book = e_book_new_default_addressbook(&error);
+	if (error != NULL) {
+		g_warning("Unable to locate the default Evolution address book: %s", error->message);
+		g_clear_error(&error);
+		return NULL;
+	}
+  e_book_open(book, TRUE, &error);
+	if (error) {
+		g_warning("Unable to open the Evolution address book: %s", error->message);
+		g_clear_error(&error);
+		return NULL;
+	}
+	return book;
+}
+
+/* 
+ *	call-seq:
+ *		get_contacts_with_query(query)
+ *		
+ * Gets contacts with an arbitrary s-expression query, i.e., (contains "full_name" "Smith") would 
+ * return any contacts whose named contained "Smith" - Joe Smith, Fred Smithson, etc.
+ */
+static VALUE revolution_get_contacts_with_query(VALUE self, VALUE rb_query) {
+	VALUE result = rb_ary_new();
+	EBook* book = open_book();
+	if (!book) {
+		return Qnil;
+	}
+	
+  EBookQuery* query = e_book_query_from_string(RSTRING(StringValue(rb_query))->ptr);
+  GError* error = 0;
+  GList* results, *l = NULL;
+  e_book_get_contacts(book, query, &results, &error);
+	if (error) {
+		g_warning("Unable to query the Evolution address book: %s", error->message);
+		g_clear_error(&error);
+		return Qnil;
+	}
+
+  for (l = results; l; l = l->next) {
+  	EContact* ev_contact = E_CONTACT(l->data);
+		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);
+	}
+  e_book_query_unref(query);
+  g_list_free(results);
+
+	return result;
+}
+
+/* 
+ *	call-seq:
+ *		get_contacts_by_name(name)
+ *		
+ * Gets contacts by name; returns any name that contains the passed in parameter
+ */
+static VALUE revolution_get_contacts_by_name(VALUE self, VALUE rb_name) {
+	VALUE result = rb_ary_new();
+  GError* error = 0;
+	EBook* book = open_book();
+	if (!book) {
+		return Qnil;
+	}
+	char* name = RSTRING(StringValue(rb_name))->ptr;
+  char* query_str = g_strdup_printf ("(contains \"full_name\" \"%s\")", name);
+  EBookQuery* query = e_book_query_from_string(query_str);
+  GList* results, *l = NULL;
+  e_book_get_contacts(book, query, &results, &error);
+	if (error) {
+		g_warning("Unable to query the Evolution address book: %s", error->message);
+		g_clear_error(&error);
+		return Qnil;
+	}
+
+  for (l = results; l; l = l->next) {
+  	EContact* ev_contact = E_CONTACT(l->data);
+		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);
+	}
+  e_book_query_unref(query);
+  g_list_free(results);
+
+	return result;
+}
+
+/* 
+ *	call-seq:
+ *		get_contact_by_uid(contact_uid)
+ *		
+ * Gets a single contact by the Evolution unique id
+ */
+static VALUE revolution_get_contact_by_uid(VALUE self, VALUE contact_uid) {
+  GError* error = 0;
+	EBook* book = open_book();
+	if (!book) {
+		return Qnil;
+	}
+	
+	char* uid = RSTRING(StringValue(contact_uid))->ptr;
+  char* query_str = g_strdup_printf ("(is \"id\" \"%s\")", uid);
+  EBookQuery* query = e_book_query_from_string(query_str);
+  GList* results = NULL;
+  e_book_get_contacts(book, query, &results, &error);
+	if (error) {
+		g_warning("Unable to query the Evolution address book: %s", error->message);
+		g_clear_error(&error);
+		return Qnil;
+	}
+	if (!results) {
+    // A contact for that id wasn't found, so just return nil
+		return Qnil;
+	}
+
+  EContact* ev_contact = E_CONTACT(results->data);
+	VALUE ruby_contact = rb_class_new_instance(0, 0, cContact);
+	copy_into_contact(ruby_contact, ev_contact);
+  g_object_unref(ev_contact);
+  e_book_query_unref(query);
+  g_list_free(results);
+
+	return ruby_contact;
+}
+
+/* 
+ *	call-seq:
+ *		delete_contact(contact_uid)
+ *		
+ * Deletes a contact 
+ */
+static VALUE revolution_delete_contact(VALUE self, VALUE contact_uid) {
+  GError* error = 0;
+	EBook* book = open_book();
+	if (!book) {
+		return Qnil;
+	}
+	
+	char* uid = RSTRING(StringValue(contact_uid))->ptr;
+  char* query_str = g_strdup_printf ("(is \"id\" \"%s\")", uid);
+  EBookQuery* query = e_book_query_from_string(query_str);
+  GList* results = NULL;
+  e_book_get_contacts(book, query, &results, &error);
+	if (error) {
+		g_warning("Unable to query the Evolution address book: %s", error->message);
+		g_clear_error(&error);
+		return Qnil;
+	}
+	if (!results) { // A contact for that id wasn't found, so just bail out
+		return Qnil;
+	}
+	
+	e_book_remove_contact(book, uid, &error);
+	if (error) {
+		g_warning("Unable to delete contact: %s", error->message);
+		g_clear_error(&error);
+	}
+
+	return Qnil;
+}
+
+/* 
+ *	call-seq:
+ *		add_contact(contact) -> [String] the new contact's Evolution unique ID
+ *		
+ * Adds a contact 
+ */
+static VALUE revolution_add_contact(VALUE self, VALUE rb_contact) {
+  GError* error = 0;
+	EBook* book = open_book();
+	if (!book) {
+		return Qnil;
+	}
+	
+	EContact* ev_contact = e_contact_new();
+
+	EContactName* name = e_contact_name_new ();
+	VALUE fname = rb_iv_get(rb_contact, "@first_name");
+	if (fname) {
+  	name->given = RSTRING(StringValue(fname))->ptr;
+	}
+	VALUE lname = rb_iv_get(rb_contact, "@last_name");
+	if (lname) {
+  	name->family = RSTRING(StringValue(lname))->ptr;
+	}
+
+  e_contact_set(ev_contact, E_CONTACT_FULL_NAME, e_contact_name_to_string (name));
+	e_book_add_contact(book, ev_contact, &error);
+	// Hm, this causes problems... GLib complains about a double free
+	// e_contact_name_free (name);
+
+	if (error) {
+		g_warning("Unable to add a contact: %s", error->message);
+		g_clear_error(&error);
+		return Qnil;
+	}
+
+	return rb_str_new2(e_contact_get(ev_contact, E_CONTACT_UID));
+}
+
 /*
  * An interface to the Evolution[http://www.gnome.org/projects/evolution/] 
  * calendar, contact, and task information.
@@ -513,66 +716,71 @@ void Init_revolution() {
 	module = rb_define_module("Revolution");
 
   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);
+  rb_define_attr(cContact, "uid", 1, 1);
+  rb_define_attr(cContact, "first_name", 1, 1);
+  rb_define_attr(cContact, "last_name", 1, 1);
+  rb_define_attr(cContact, "home_email", 1, 1);
+  rb_define_attr(cContact, "work_email", 1, 1);
+  rb_define_attr(cContact, "email_addresses", 1, 1);
+  rb_define_attr(cContact, "birthday", 1, 1);
+  rb_define_attr(cContact, "home_phone", 1, 1);
+  rb_define_attr(cContact, "work_phone", 1, 1);
+  rb_define_attr(cContact, "mobile_phone", 1, 1);
+  rb_define_attr(cContact, "home_address", 1, 1);
+  rb_define_attr(cContact, "work_address", 1, 1);
+  rb_define_attr(cContact, "other_address", 1, 1);
+  rb_define_attr(cContact, "organization", 1, 1);
+  rb_define_attr(cContact, "title", 1, 1);
+  rb_define_attr(cContact, "im_addresses", 1, 1);
+  rb_define_method(cContact, "initialize", contact_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);
+  rb_define_attr(cContactAddress, "address_format", 1, 1);
+  rb_define_attr(cContactAddress, "po", 1, 1);
+  rb_define_attr(cContactAddress, "ext", 1, 1);
+  rb_define_attr(cContactAddress, "street", 1, 1);
+  rb_define_attr(cContactAddress, "locality", 1, 1);
+  rb_define_attr(cContactAddress, "region", 1, 1);
+  rb_define_attr(cContactAddress, "code", 1, 1);
+  rb_define_attr(cContactAddress, "country", 1, 1);
+  rb_define_method(cContactAddress, "initialize", contactAddress_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);
+  rb_define_attr(cContactIMAddress, "provider", 1, 1);
+  rb_define_attr(cContactIMAddress, "location", 1, 1);
+  rb_define_attr(cContactIMAddress, "address", 1, 1);
+  rb_define_method(cContactIMAddress, "initialize", contactIMAddress_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_attr(cAppointment, "uid", 1, 1);
+  rb_define_attr(cAppointment, "summary", 1, 1);
+  rb_define_attr(cAppointment, "location", 1, 1);
+  rb_define_attr(cAppointment, "organizer", 1, 1);
+  rb_define_attr(cAppointment, "start", 1, 1);
+  rb_define_attr(cAppointment, "end", 1, 1);
+  rb_define_attr(cAppointment, "last_modification", 1, 1);
+  rb_define_attr(cAppointment, "alarm_set", 1, 1);
+  rb_define_attr(cAppointment, "busy_status", 1, 1);
+  rb_define_attr(cAppointment, "recurring", 1, 1);
   rb_define_method(cAppointment, "initialize", evAppointment_init, 0);
   // INLINE RUBY CODE define an "all_day" method
 
   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_attr(cTask, "uid", 1, 1);
+  rb_define_attr(cTask, "summary", 1, 1);
+  rb_define_attr(cTask, "description", 1, 1);
+  rb_define_attr(cTask, "start", 1, 1);
+  rb_define_attr(cTask, "due", 1, 1);
+  rb_define_attr(cTask, "status", 1, 1);
+  rb_define_attr(cTask, "priority", 1, 1);
+  rb_define_attr(cTask, "last_modification", 1, 1);
   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, "add_contact", revolution_add_contact, 1);
+	rb_define_method(cRevolution, "delete_contact", revolution_delete_contact, 1);
+	rb_define_method(cRevolution, "get_contact_by_uid", revolution_get_contact_by_uid, 1);
+	rb_define_method(cRevolution, "get_contacts_by_name", revolution_get_contacts_by_name, 1);
+	rb_define_method(cRevolution, "get_contacts_with_query", revolution_get_contacts_with_query, 1);
 	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);

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.4
+rubygems_version: 0.8.8
 specification_version: 1
 name: revolution
 version: !ruby/object:Gem::Version 
-  version: "0.3"
-date: 2005-03-25
+  version: "0.4"
+date: 2005-03-30
 summary: Revolution is a binding for the Evolution email client
 require_paths: 
   - ''