em-zimbreasy 0.0.7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in em-zimbreasy.gemspec
+gemspec
+  gem 'savon', :git => 'git://github.com/rankin/savon.git'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christopher Rankin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Em::Zimbreasy
+
+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
+
+Add this line to your application's Gemfile:
+
+    gem 'em-zimbreasy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install em-zimbreasy
+
+## Usage
+
+It's pretty simple to use, I will post some examples:
+
+    zs = Em::Zimbreasy::Account.new('username', 'password', "https://yourzimbraserver.com/service/soap"); #login
+    zm = Em::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. First arg is a Time object representing start date, second arg is end date.
+
+## 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'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/em-zimbreasy.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/em-zimbreasy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jordan Prince", "Christopher Rankin"]
+  gem.email         = ["crankin@pangeaequity.com"]
+  gem.description   = %q{A no-nonsense async gem for the nonsensical Zimbra API.}
+  gem.summary       = %q{A no-nonsense async gem for the nonsensical Zimbra API.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "em-zimbreasy"
+  gem.require_paths = ["lib"]
+  gem.version       = Em::Zimbreasy::VERSION
+
+  gem.add_dependency 'test-unit'
+	gem.add_dependency 'em-http-request'
+	gem.add_dependency 'em-synchrony'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'icalendar'
+end

data/lib/em-zimbreasy.rb

@@ -0,0 +1,18 @@
+require "icalendar"
+require "exceptions/zimbreasy_timeout_exception"
+require "em-zimbreasy/version"
+require "em-zimbreasy/mail"
+require "em-zimbreasy/account"
+require "savon"
+
+module Em
+  module Zimbreasy
+
+	  #takes a Time object. outputs string for zimbra api calls.
+    def self.zimbra_date(time)
+      time.strftime("%Y%m%dT%H%M%S")
+    end
+
+    
+  end
+end

data/lib/em-zimbreasy/account.rb

@@ -0,0 +1,68 @@
+require 'timeout'
+
+module Em
+  module Zimbreasy
+    class Account
+      attr_accessor :user, :pass, :endpoint, :client, :soap_namespace, :zimbra_namespace
+
+      def initialize(user, pass, endpoint, adapter)
+        HTTPI::Adapter.use = adapter
+        @user = user
+        @pass = pass
+        @endpoint = endpoint
+        @soap_namespace = {
+          "xmlns:soap" => "http://schemas.xmlsoap.org/soap/envelope/"
+        }
+        @zimbra_namespace = "urn:zimbraAccount"
+        auth_request
+      end
+    
+      def auth_request
+        response = make_call(
+          :AuthRequest, 
+          { :persistAuthTokenCookie => 1, :xmlns => @zimbra_namespace },
+          {
+            :account => @user, 
+            :password => @pass,
+            :session => "",
+            :attributes! => { :account => { :by => "name" } }
+          }
+        )
+        @client = Savon.client(
+          namespace_identifier: :none,
+				  pretty_print_xml: true, 
+				  log: false, 
+				  endpoint: @endpoint, 
+				  namespace: soap_namespace,
+				  convert_request_keys_to: :none,
+          headers: { "Cookie" => response.http.headers["set-cookie"].split(";").first }
+			  )
+      end
+
+      def make_call(method, attrs={}, message)
+        tries = 0
+        soap_namespace = @soap_namespace 
+        #@soap_namespace is undefined inside client.request, is not this obj. So we define it here.
+	      
+        @client ||= Savon.client(
+          namespace_identifier: :none,
+				  pretty_print_xml: true, 
+				  log: false, 
+				  endpoint: @endpoint, 
+				  namespace: soap_namespace,
+				  convert_request_keys_to: :none
+			  )
+        response = @client.call(method, attributes: attrs, message: message, soap_action: @zimbra_namespace)
+
+      rescue Timeout::Error => e
+        pp "Retrying"
+        tries+=1
+        if tries >= 4
+          throw ZimbreasyTimeoutException.new
+        else
+          retry
+        end
+      end
+    end
+  end
+end

data/lib/em-zimbreasy/mail.rb

@@ -0,0 +1,250 @@
+module Em
+  module Zimbreasy
+    class Mail
+      include Icalendar
+      attr_accessor :account, :zimbra_namespace
+
+      def initialize(account)
+        @account = account
+        @zimbra_namespace = "urn:zimbraMail"
+      end
+
+      #Params can contain the following:
+      #:appointee_emails(req)
+      #:start_time(opt)
+      #:end_time(opt)
+      #:name(opt)
+      #:subject(opt)
+      #:desc(opt)
+      #:mime_type(opt)
+      #:is_org(opt) boolean is organizer or not
+      #:or -> organizer email
+      #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)
+        params[:start_time] = Em::Zimbreasy.zimbra_date(params[:start_time]) if params[:start_time]
+        params[:end_time] = Em::Zimbreasy.zimbra_date(params[:end_time]) if params[:end_time]
+        response = account.make_call(
+          :CreateAppointmentRequest, 
+          { "xmlns" => @zimbra_namespace, "echo" => (params[:echo] || "0")},
+          appointment_hash(params)
+        ) 
+        params.merge!({:appt_id => response.body[:create_appointment_response][:@inv_id]})
+
+        to_ical(params)
+      end
+
+      def get_free_busy(start_time, end_time, email)
+        start_time = start_time.to_i*1000 #it wants millis, to_i gives seconds.
+        end_time = end_time.to_i*1000
+
+        response = account.make_call(
+          :GetFreeBusyRequest,
+          {:xmlns => @zimbra_namespace, :s => start_time, :e => end_time},
+          { :usr => { :name => email }}
+        )
+   
+        array = [] 
+        return response.body[:get_free_busy_response][:usr].reject { |k,v| k if k == :@id }.inject(Hash.new) do |hash, entry|
+          if entry[1].is_a?(Array)
+            array_of_times = entry[1].inject(Array.new) do |times_array, times_entry|
+              times_array << { :s => Time.at(times_entry[:@s].to_f/1000.0), :e => Time.at(times_entry[:@e].to_f/1000.0) }
+              times_array
+            end
+            hash[entry[0]] = array_of_times 
+          else
+            hash[entry[0]] = [ {:s => Time.at(entry[1][:@s].to_f/1000.0), :e => Time.at(entry[1][:@e].to_f/1000.0)} ] 
+          end
+          hash 
+        end
+      end
+   
+      def get_appointment(appt_id)
+
+        response = account.make_call(
+          :GetAppointmentRequest,
+          { :xmlns => @zimbra_namespace, :id => appt_id},
+          {}
+        )
+
+        comp = response.body[: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
+        }
+
+        to_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,
+          { :xmlns => @zimbra_namespace, :e => end_date, :s => start_date},
+          {}
+        )
+
+        return [] if response.body[:get_appt_summaries_response][:appt].nil?
+
+        appts = []
+
+        if response.body[:get_appt_summaries_response][:appt].is_a?(Array)
+          response.body[:get_appt_summaries_response][:appt].each do |appt|
+            
+            inst = appt[:inst]
+                      
+            hash = {
+              :start_time => Em::Zimbreasy.zimbra_date(Time.at(inst[:@s].to_f/1000.0)), 
+              :name => appt[:@name], 
+              :appt_id => appt[:@id]
+            }
+
+            appts << to_ical(hash)
+          end
+        else 
+          appt = response.body[:get_appt_summaries_response][: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 << to_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] = Em::Zimbreasy.zimbra_date(params[:start_time]) if params[:start_time]
+        params[:end_time] = Em::Zimbreasy.zimbra_date(params[:end_time]) if params[:end_time]
+
+        response = account.make_call(
+          :ModifyAppointmentRequest,
+          { :xmlns => @zimbra_namespace, :id => params[:inv_id]},
+          appointment_hash(params)
+        )
+      
+        to_ical(params.merge({:appt_id => params[:inv_id]}))
+      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, emails, subject=nil, content=nil)
+        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
+
+        message = {
+          :m => {
+            :su => subject,
+            :mp => {
+              :content => content,
+              :@ct => "text/plain"                 
+            },
+            :attributes! => { :e => { :a => [], :t => [] } } 
+          }
+        }
+
+        message[:m][:e] = []
+        emails.each do |email|
+          message[:m][:e] << ""
+          message[:m][:attributes!][:e][:a].push(email)
+          message[:m][:attributes!][:e][:t].push("t")
+        end
+
+        response = account.make_call(
+          :CancelAppointmentRequest,
+          { :xmlns => @zimbra_namespace, :id => inv_id, :comp => 0},
+          message
+        )        
+
+        return !response.body[:cancel_appointment_response].nil?
+      end
+
+      private
+
+      def to_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 appointment_hash(params)
+        message = {
+          :m => {
+            :mp => { :ct => (params[:mime_type] || "text/plain") },
+            :inv => {
+              :mp => { :ct =>(params[:mime_type] || "text/plain") },
+              :desc => params[:desc],
+              :comment => params[:desc],
+              :@rsvp => "0", 
+              :@compNum => "0", 
+              :@method => "none", 
+              :@name => params[:name],
+              :@isOrg => params[:is_org],
+              :@noBlob => 1
+            },
+            :@su => params[:subject],
+            :attributes! => { :e => { :a => [], :t => [] } }
+          }
+        }
+
+        message[:m][:inv][:s] = { :d => params[:start_time],  :tz => params[:tz] } if params[:start_time]
+        message[:m][:inv][:e] = { :d => params[:end_time],    :tz => params[:tz] } if params[:end_time]
+        message[:m][:inv][:fb] = params[:fb] if params[:fb]
+        message[:m][:inv][:fba] = params[:fba] if params[:fba]
+
+        message[:m][:inv][:comp] = {
+          :s =>  { :d => params[:start_time],  :tz => params[:tz] },
+          :desc => params[:desc],
+          :@noBlob => 1,
+          :@method => "none", :@compNum => 1, :@rsvp => "0", :@isOrg => params[:is_org],
+          :attributes! => { :at => { :a => [], :rsvp => [], :role => [], :ptst => [], :cutype => [] } } 
+        }
+        
+        message[:m][:inv][:comp][:@fb] = params[:fb] if params[:fb]
+        message[:m][:inv][:comp][:@fb] = params[:fba] if params[:fba]
+
+        message[:m][:inv][:comp][:e] = { :d => params[:end_time],    :tz => params[:tz] }
+
+        message[:m][:inv][:comp][:or] = { :@a => params[:or] }
+        message[:m][:inv][:or] = { :@a => params[:or] } #set organizer
+
+        message[:m][:e] = []
+        message[:m][:inv][:comp][:at] = []
+        params[:appointee_emails].each do |email| 
+          
+          message[:m][:e] << ""
+          message[:m][:attributes!][:e][:a].push(email) #set attendees here
+          message[:m][:attributes!][:e][:t].push("t") 
+
+          message[:m][:inv][:comp][:at] << ""
+          message[:m][:inv][:comp][:attributes!][:at][:a].push(email) # also set attendees here
+          message[:m][:inv][:comp][:attributes!][:at][:rsvp].push("1") 
+          message[:m][:inv][:comp][:attributes!][:at][:role].push("REQ") 
+          message[:m][:inv][:comp][:attributes!][:at][:ptst].push("AC") 
+          message[:m][:inv][:comp][:attributes!][:at][:cutype].push("IND") 
+        end
+        return message
+      end
+
+    end
+  end
+end

data/lib/em-zimbreasy/version.rb

@@ -0,0 +1,5 @@
+module Em
+  module Zimbreasy
+    VERSION = "0.0.7"
+  end
+end

data/lib/exceptions/zimbreasy_timeout_exception.rb

@@ -0,0 +1,5 @@
+class ZimbreasyTimeoutException < Exception
+  def message
+    'Request timed out after multiple retries.'
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: em-zimbreasy
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
+platform: ruby
+authors:
+- Jordan Prince
+- Christopher Rankin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-synchrony
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: icalendar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A no-nonsense async gem for the nonsensical Zimbra API.
+email:
+- crankin@pangeaequity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- em-zimbreasy.gemspec
+- lib/em-zimbreasy.rb
+- lib/em-zimbreasy/account.rb
+- lib/em-zimbreasy/mail.rb
+- lib/em-zimbreasy/version.rb
+- lib/exceptions/zimbreasy_timeout_exception.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A no-nonsense async gem for the nonsensical Zimbra API.
+test_files: []