zimbreasy 0.0.1 → 0.0.2

data/Gemfile

@@ -2,6 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in zimbreasy.gemspec
 gemspec
-gem 'test-unit'
-gem 'savon', '~> 1.1.0'
-gem 'nokogiri'
+

data/README.md

@@ -1,6 +1,21 @@
 # Zimbreasy
 
-Thanks to Crankin's 2007 for assisting me with this.
+2007!
+
+Crankin will get that joke, he is to be thanked for assistance on this. 
+
+This is an open sourced wrapper for the Zimbra API. I only added functionality for CRUD on Calender Appointments,
+because that's all I needed for the job I'm getting done. However, the code already contained within the libraries for calendars
+and the structure make this an easily extensible gem if you need it for other purposes.
+
+The API documentation I am using is located at
+
+http://files.zimbra.com/docs/soap_api/8.0/soapapi-zimbra-doc/api-reference/index.html
+
+Everybody who's interested in finally wrapping Zimbra well for Ruby, please download the gem and submit pull requests 
+with more of the methods on this API built out(there are over 100.)
+
+This gem is still in it's infancy and has little to no error handling! I appreciate all the help I can get on this project, Zimbra is big!
 
 ## Installation
 
@@ -18,10 +33,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+It's pretty simple to use, I will post some examples:
+
+    zs = Zimbreasy::Account.new('username', 'password', "https://yourzimbraserver.com/service/soap"); #login
+    zm = Zimbreasy::Mail.new(zs); #create a Zimbreasy::Mail object. This has methods for the ZimbraMail submodule of their API.
+    z = zm.create_appointment({:appointee_email => "neo@matrix.com", :start_time => Time.now+1.days, :end_time => (Time.now+1.days+1.hours), :name => "Joss Whedon Meeting", :subject => "Hallelujah", :desc => "Ridiculous stuff happening here"}) #I create an appointment.
+
+    => "BEGIN:VCALENDAR\r\nCALSCALE:GREGORIAN\r\nPRODID:iCalendar-Ruby\r\nVERSION:2.0\r\nBEGIN:VEVENT\r\nDESCRIPTION:Poopmaster\r\nDTEND:20130208T171612\r\nDTSTAMP:20130207T161614\r\nDTSTART:20130208T161612\r\nCLASS:PRIVATE\r\nSEQUENCE:0\r\nSUMMARY:Jossss\r\nUID:336-335\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
+
+
+create_appointment returns ics formatted data, for use with icalendar. Notice that the UID in the data is 336-335. This is an invitation id, not an appointment id.
+The appointment id is 336, the first part of it.
+
+The Other methods of note:
+
+    zm.get_appointment(336) #takes appt id
+  
+    zm.modify_appointment({:appointee_email => "neo@matrix.com", :start_time => Time.now, :end_time => (Time.now+2.hours), :name => "Joss Whedon!!!", :subject => "Hallelujah 2: The Electric Boogaloo", :desc => "Yoda Fights Back", :inv_id => "336-335"})
+
+    zm.cancel_appointment("336-335")
+
+You'll notice get_appointment uses an actual appointment id, whereas modify appt and cancel appt need inv ids. I don't know why this is, 
+it seems Zimbra API only works with invitation, not appointment ids, when it comes to these methods. Get just needs appt ids. The final method of note is
+
+    zm.get_appt_summaries(Time.now-1.days, Time.now)
+
+This just returns appointment Ics texts in an array.
 
 ## Contributing
 
+It'd be great if someone could write tests for these methods, I haven't had the time. If you want to write tests,
+please do!
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)

data/lib/zimbreasy/mail.rb

@@ -1,5 +1,6 @@
 module Zimbreasy
   class Mail
+    include Icalendar
     attr_accessor :account, :zimbra_namespace
     def initialize(account)
       @account = account
@@ -12,25 +13,133 @@ module Zimbreasy
     #:end_time(opt)
     #:name(opt)
     #:subject(opt)
-    #:content(opt)
+    #:desc(opt)
     #:mime_type(opt)
-    #:organizer(opt)
+    #Returns Appt's Inv id as UID in an i_cal text.. Is normally a number like 140-141,
+    #the first number is the appt id, which you need for getting.
     def create_appointment(params)
-      account.make_call("CreateAppointmentRequest") do |xml|
+      params[:start_time] = Zimbreasy.zimbra_date(params[:start_time]) if params[:start_time]
+      params[:end_time] = Zimbreasy.zimbra_date(params[:end_time]) if params[:end_time]
+
+      response = account.make_call("CreateAppointmentRequest") do |xml|
         xml.CreateAppointmentRequest({ "xmlns" => @zimbra_namespace}) do |xml|
-          xml.m({"su" => params[:subject]}) do |xml|
-            xml.content(params[:content]) 
-            xml.mp({"ct" =>(params[:mime_type] || "text/plain")})
-            xml.inv({"rsvp" => "1", "compNum" => "0", "method" => "none", "name" => params[:name] }) do |xml|
-              xml.s({"d" => Zimbreasy.zimbra_date(params[:start_time])}) if params[:start_time]
-              xml.e({"d" => Zimbreasy.zimbra_date(params[:end_time])}) if params[:end_time]
-            end 
-            
-            xml.e({"a" => params[:appointee_email], "t" => "t", "or" => params[:organizer]})
-          end
+          appointment_xml_block(xml, params)
         end
       end
+      params.merge!({:appt_id => response.body[:create_appointment_response][:@inv_id]})
+      make_ical(params)
+    end
+ 
+    def make_ical(params)
+      calendar = Calendar.new   
+      calendar.event do
+        dtstart       params[:start_time]
+        dtend         params[:end_time]
+        summary       params[:name]
+        description   params[:desc]
+        uid           params[:appt_id]
+        klass         "PRIVATE"  
+      end
+      
+      calendar.to_ical
+    end
+
+    def get_appointment(appt_id)
+      response = account.make_call("GetAppointmentRequest") do |xml|
+        xml.GetAppointmentRequest({ "xmlns" => @zimbra_namespace, "id" => appt_id})
+      end
+
+      comp = response[:get_appointment_response][:appt][:inv][:comp]
+
+      hash = {
+        :start_time => comp[:s][:@d], 
+        :end_time => comp[:e][:@d], 
+        :desc => comp[:desc],  
+        :name => comp[:@name],
+        :appt_id => appt_id
+      }
+
+      make_ical(hash)
+    end 
+
+    def get_appt_summaries(start_date, end_date)
+      start_date = start_date.to_i*1000 #it wants millis, to_i gives seconds.
+      end_date = end_date.to_i*1000
+
+      response = account.make_call("GetApptSummariesRequest") do |xml|
+        xml.GetApptSummariesRequest({ "xmlns" => @zimbra_namespace, "e" => end_date, "s" => start_date})
+      end
+
+      return [] if response[:get_appt_summaries_response][:appt].nil?
+
+      appts = []
+
+      response[:get_appt_summaries_response][:appt].each do |appt|
+
+        inst = appt[:inst]
+                  
+        hash = {
+          :start_time => Zimbreasy.zimbra_date(Time.at(inst[:@s].to_f/1000.0)), 
+          :name => appt[:@name], 
+          :appt_id => appt[:@id]
+        }
 
+        appts << make_ical(hash)
+      end
+      
+      appts
     end 
+
+    #same param options as create_appointment, but you can add :inv_id too.
+    def modify_appointment(params)
+      params[:start_time] = Zimbreasy.zimbra_date(params[:start_time]) if params[:start_time]
+      params[:end_time] = Zimbreasy.zimbra_date(params[:end_time]) if params[:end_time]
+
+      response = account.make_call("ModifyAppointmentRequest") do |xml|
+        xml.ModifyAppointmentRequest({ 
+          "xmlns" => @zimbra_namespace, 
+          "id" => params[:inv_id]
+        }) do |xml|
+          appointment_xml_block(xml, params)
+        end
+      end
+    
+      make_ical(params)
+    end
+
+    #returns true if it worked, inv_id is not appt_id, it's normally something like 320-319, the first number is appt_id.
+    def cancel_appointment(inv_id)
+      unless inv_id and inv_id.is_a?(String) and inv_id.match(/-/) and inv_id.split("-").count==2 #so it has x-y formatting.
+        raise 'inv_id must be string of format x-y, where x and y are numbers.'
+      end
+
+      response = account.make_call("CancelAppointmentRequest") do |xml|
+        xml.CancelAppointmentRequest({ 
+          "xmlns" => @zimbra_namespace, 
+          "id" => inv_id,
+          "comp" => 0
+        }) do |xml|
+          xml.inv({"id" => inv_id, "method" => "none", "compNum" => "0", "rsvp" => "1"})
+        end
+      end
+
+      return !response.body[:cancel_appointment_response].nil?
+    end
+
+    private
+
+    def appointment_xml_block(xml, params)
+      xml.m({"su" => params[:subject]}) do |xml|
+        xml.mp({"ct" =>(params[:mime_type] || "text/plain")})
+        xml.inv({"rsvp" => "1", "compNum" => "0", "method" => "none", "name" => params[:name] }) do |xml| 
+          xml.mp({"ct" =>(params[:mime_type] || "text/plain")})
+          xml.desc(params[:desc]) 
+          xml.s({"d" => params[:start_time]}) if params[:start_time]
+          xml.e({"d" => params[:end_time]}) if params[:end_time]
+        end 
+        
+        xml.e({"a" => params[:appointee_email], "t" => "t"})
+      end
+    end
   end
 end

data/lib/zimbreasy/version.rb

@@ -1,3 +1,3 @@
 module Zimbreasy
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/zimbreasy.rb

@@ -1,3 +1,4 @@
+require "icalendar"
 require "zimbreasy/version"
 require "zimbreasy/mail"
 require "zimbreasy/account"

data/zimbreasy.gemspec

@@ -14,4 +14,9 @@ Gem::Specification.new do |gem|
   gem.name          = "zimbreasy"
   gem.require_paths = ["lib"]
   gem.version       = Zimbreasy::VERSION
+
+  gem.add_dependency 'test-unit'
+  gem.add_dependency 'savon', '~> 1.1.0'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'icalendar'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zimbreasy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,52 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
-dependencies: []
+date: 2013-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &22555720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22555720
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &22546860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *22546860
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &22541180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22541180
+- !ruby/object:Gem::Dependency
+  name: icalendar
+  requirement: &22537660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *22537660
 description: A no-nonsense gem for the nonsensical Zimbra API.
 email:
 - jordanmprince@gmail.com