zimbra 0.0.4 → 0.0.5

data/lib/zimbra/extra/date_helpers.rb

@@ -0,0 +1,111 @@
+module Zimbra
+  class DateHelpers
+    class Frequency
+      FREQUENCIES = [
+        { name: :secondly, zimbra_name: 'SEC', abbreviations: [] },
+        { name: :minutely, zimbra_name: 'MIN', abbreviations: [] },
+        { name: :hourly,   zimbra_name: 'HOU', abbreviations: [] },
+        { name: :daily,    zimbra_name: 'DAI', abbreviations: [] },
+        { name: :weekly,   zimbra_name: 'WEE', abbreviations: [] },
+        { name: :monthly,  zimbra_name: 'MON', abbreviations: [] },
+        { name: :yearly,   zimbra_name: 'YEA', abbreviations: [] }
+      ]
+      
+      class << self
+        def all
+          @all ||= FREQUENCIES.inject([]) do |frequencies, data|
+            frequencies << new(data)
+          end
+        end
+        
+        def find(name_or_abbreviation)
+          all.find { |frequency| frequency.match?(name_or_abbreviation) }
+        end
+      end
+      
+      attr_accessor :name, :zimbra_name, :abbreviations
+      
+      def initialize(args = {})
+        @name = args[:name]
+        @zimbra_name = args[:zimbra_name]
+        @abbreviations = args[:abbreviations]
+      end
+      
+      def match?(name_or_abbreviation)
+        downcased_matcher = name_or_abbreviation.to_s.downcase
+        ([name.to_s, zimbra_name.to_s] + abbreviations).map(&:downcase).include?(downcased_matcher)
+      end
+      
+      def to_sym
+        name.downcase.to_sym
+      end
+    end
+    
+    class WeekDay
+      WEEK_DAYS = [
+        {
+          id: 1, name: :Sunday, zimbra_name: 'SU',
+          abbreviations: ['su', 'sun']
+        },
+        {
+          id: 2, name: :Monday, zimbra_name: 'MO', 
+          abbreviations: ['mo', 'mon']
+        },
+        {
+          id: 3, name: :Tuesday, zimbra_name: 'TU', 
+          abbreviations: ['tu', 'tue']
+        },
+        {
+          id: 4, name: :Wednesday, zimbra_name: 'WE', 
+          abbreviations: ['we', 'wed']
+        },
+        {
+          id: 5, name: :Thursday, zimbra_name: 'TH', 
+          abbreviations: ['th', 'thu', 'thur', 'thurs']
+        },
+        {
+          id: 6, name: :Friday, zimbra_name: 'FR', 
+          abbreviations: ['fr', 'fri']
+        },
+        {
+          id: 7, name: :Saturday, zimbra_name: 'SA', 
+          abbreviations: ['sa', 'sat']
+        }
+      ] unless const_defined?(:WEEK_DAYS)
+      
+      class << self
+        def all
+          @all ||= WEEK_DAYS.inject([]) do |week_days, data|
+            week_days << new(data)
+          end
+        end
+        
+        def find(id_name_or_abbreviation)
+          all.find { |week_day| week_day.match?(id_name_or_abbreviation) }
+        end
+      end
+      
+      attr_accessor :id, :name, :abbreviations, :zimbra_name
+      
+      def initialize(args = {})
+        @id = args[:id]
+        @name = args[:name]
+        @zimbra_name = args[:zimbra_name]
+        @abbreviations = args[:abbreviations]
+      end
+      
+      def match?(id_name_or_abbreviation)
+        if id_name_or_abbreviation.is_a?(Fixnum)
+          id_name_or_abbreviation == id
+        else
+          downcased_matcher = id_name_or_abbreviation.to_s.downcase
+          ([name.to_s, zimbra_name.to_s] + abbreviations).map(&:downcase).include?(downcased_matcher)
+        end
+      end
+      
+      def to_sym
+        name.downcase.to_sym
+      end
+    end
+  end
+end

data/lib/zimbra/folder.rb

@@ -0,0 +1,100 @@
+# http://files.zimbra.com/docs/soap_api/8.0.4/soap-docs-804/api-reference/zimbraMail/GetFolder.html
+module Zimbra
+  class Folder
+    class << self
+      def all
+        FolderService.all
+      end
+
+      def find_all_by_view(view)
+        FolderService.find_all_by_view(view)
+      end
+    end
+    
+    ATTRS = [
+      :id, :uuid, :name, :view, :absolute_folder_path,
+      :parent_folder_id, :parent_folder_uuid,
+      :non_folder_item_count, :non_folder_item_size,
+      :revision, :imap_next_uid, :imap_modified_sequence, :modified_sequence, :activesync_disabled,
+      :modified_date
+    ] unless const_defined?(:ATTRS)
+    
+    attr_accessor *ATTRS
+    
+    def initialize(args = {})
+      self.attributes = args
+    end
+    
+    def attributes=(args = {})
+      ATTRS.each do |attr_name|
+        self.send(:"#{attr_name}=", (args[attr_name] || args[attr_name.to_s])) if args.has_key?(attr_name) || args.has_key?(attr_name.to_s)
+      end
+    end
+  end
+  
+  class FolderService < HandsoapAccountService
+    def all
+      xml = invoke("n2:GetFolderRequest")
+      parse_xml_responses(xml)
+    end
+    
+    def find_all_by_view(view)
+      xml = invoke("n2:GetFolderRequest") do |message|
+        Builder.find_all_by_view(message, view)
+      end
+      parse_xml_responses(xml)
+    end
+    
+    def parse_xml_responses(xml)
+      Parser.get_all_response(xml)
+    end
+
+    class Builder
+      class << self
+        def find_all_by_view(message, view)
+          message.set_attr 'view', view
+        end
+      end
+    end
+    
+    class Parser
+      ATTRIBUTE_MAPPING = {
+        :id => :id, 
+        :uuid => :uuid, 
+        :name => :name, 
+        :view => :view, 
+        :absFolderPath => :absolute_folder_path, 
+        :l => :parent_folder_id, 
+        :luuid => :parent_folder_uuid, 
+        :n => :non_folder_item_count, 
+        :s => :non_folder_item_size, 
+        :rev => :revision, 
+        :i4next => :imap_next_uid, 
+        :i4ms => :imap_modified_sequence, 
+        :ms => :modified_sequence, 
+        :activesyncdisabled => :activesync_disabled, 
+        :md => :modified_date
+      }
+      
+      class << self
+        def get_all_response(response)
+          (response/"//n2:folder").map do |node|
+            folder_response(node)
+          end
+        end
+
+        def folder_response(node)
+          folder_attributes = ATTRIBUTE_MAPPING.inject({}) do |attrs, (xml_name, attr_name)|
+            attrs[attr_name] = (node/"@#{xml_name}").to_s
+            attrs
+          end
+          initialize_from_attributes(folder_attributes)
+        end
+
+        def initialize_from_attributes(folder_attributes)
+          Zimbra::Folder.new(folder_attributes)
+        end
+      end
+    end
+  end
+end

data/lib/zimbra/handsoap_account_service.rb

@@ -0,0 +1,44 @@
+require 'handsoap'
+
+module Zimbra
+  module HandsoapAccountNamespaces
+    def request_namespaces(doc)
+      doc.alias 'n1', "urn:zimbra"
+      doc.alias 'n2', "urn:zimbraMail"
+      doc.alias 'env', 'http://schemas.xmlsoap.org/soap/envelope/'
+    end
+    def response_namespaces(doc)
+      doc.add_namespace 'n2', "urn:zimbraMail"
+    end
+  end
+  
+  module HandsoapAccountUriOverrides
+    def uri
+      Zimbra.account_api_url
+    end
+    def envelope_namespace
+      'http://www.w3.org/2003/05/soap-envelope'
+    end
+    def request_content_type
+      "application/soap+xml"
+    end
+  end
+
+  class HandsoapAccountService < Handsoap::Service
+    include HandsoapErrors
+    include HandsoapAccountNamespaces
+    extend HandsoapAccountUriOverrides
+
+    def on_create_document(doc)
+      request_namespaces(doc)
+      header = doc.find("Header")
+      header.add "n1:context" do |s|
+        s.set_attr "env:mustUnderstand", "0"
+        s.add "n1:authToken", Zimbra.account_auth_token
+      end
+    end
+    def on_response_document(doc)
+      response_namespaces(doc)
+    end
+  end
+end

data/lib/zimbra/handsoap_service.rb

@@ -43,7 +43,7 @@ module Zimbra
   
   module HandsoapUriOverrides
     def uri
-      Zimbra.url
+      Zimbra.admin_api_url
     end
     def envelope_namespace
       'http://www.w3.org/2003/05/soap-envelope'

data/lib/zimbra/version.rb

@@ -0,0 +1,3 @@
+module Zimbra
+  VERSION = "0.0.5"
+end

data/spec/fixtures/xml_api_requests/appointments/create.xml

@@ -0,0 +1,84 @@
+<?xml version='1.0' ?>
+<CreateAppointmentRequest>
+  <m l="10">
+    <inv allDay="0" loc="Conference Room" status="CONF">
+      <comp class="PUB" fb="B" isOrg="1" name="fdsafdsafdsafdsafdsafdsa" transp="O">
+        <description>This is a recurring series</description>
+        <s u="1386597600000" d="20131209T140000Z" />
+        <e u="1386599400000" d="20131209T143000Z" />
+        <alarm action="DISPLAY">
+          <trigger>
+            <rel neg="1" m="5" related="START" />
+          </trigger>
+        </alarm>
+        <recur>
+          <add>
+            <rule freq="DAI">
+              <interval ival="1" />
+              <byday>
+                <wkday day="MO" />
+                <wkday day="TU" />
+                <wkday day="WE" />
+                <wkday day="TH" />
+                <wkday day="FR" />
+              </byday>
+            </rule>
+          </add>
+        </recur>
+        <or a="mail03@greenviewdata.com" />
+      </comp>
+    </inv>
+    <inv allDay="0" loc="" status="CONF">
+      <comp class="PUB" fb="B" isOrg="1" name="fdsafdsafdsafdsafdsafdsa" transp="O">
+        <s u="1387551600000" d="20131220T150000Z" />
+        <e u="1387553400000" d="20131220T153000Z" />
+        <alarm action="DISPLAY">
+          <trigger>
+            <rel neg="1" m="5" related="START" />
+          </trigger>
+        </alarm>
+        <or a="mail03@greenviewdata.com" />
+        <exceptId d="20131220T090000" tz="America/New_York" />
+      </comp>
+    </inv>
+    <inv allDay="0" loc="" status="CONF">
+      <comp class="PUB" fb="B" isOrg="1" name="fdsafdsafdsafdsafdsafdsa" transp="O">
+        <description>This instance occurs at 1PM instead</description>
+        <s u="1390500000000" d="20140123T180000Z" />
+        <e u="1390501800000" d="20140123T183000Z" />
+        <alarm action="DISPLAY">
+          <trigger>
+            <rel neg="1" m="5" related="START" />
+          </trigger>
+        </alarm>
+        <or a="mail03@greenviewdata.com" />
+        <exceptId d="20140123T090000" tz="America/New_York" />
+      </comp>
+    </inv>
+    <inv allDay="0" loc="" status="CONF">
+      <comp class="PUB" fb="B" isOrg="1" name="fdsafdsafdsafdsafdsafdsa" transp="O">
+        <description>This is a recurring series
+
+with a few exceptions</description>
+        <s u="1390928400000" d="20140128T170000Z" />
+        <e u="1390930200000" d="20140128T173000Z" />
+        <alarm action="DISPLAY">
+          <trigger>
+            <rel neg="1" m="5" related="START" />
+          </trigger>
+        </alarm>
+        <or a="mail03@greenviewdata.com" />
+        <exceptId d="20140128T090000" tz="America/New_York" />
+      </comp>
+    </inv>
+    <inv allDay="0" loc="" status="CANC">
+      <comp class="PUB" fb="B" isOrg="1" name="Cancelled: fdsafdsafdsafdsafdsafdsa" transp="O">
+        <comment>A single instance of a recurring meeting has been cancelled.</comment>
+        <s u="1391176800000" d="20140131T140000Z" />
+        <e u="1391178600000" d="20140131T143000Z" />
+        <or a="mail03@greenviewdata.com" />
+        <exceptId d="20140131T090000" tz="America/New_York" />
+      </comp>
+    </inv>
+  </m>
+</CreateAppointmentRequest>

data/spec/fixtures/xml_api_responses/alarms/15_minutes_before.xml

@@ -0,0 +1,26 @@
+<appt uid="1b33102b-6d2e-4d98-ad27-c59a92de9798" id="498" rev="27627" nextAlarm="1387486500000" d="1387472221000" s="0" l="10">
+  <inv id="497" seq="3" compNum="0" type="appt">
+    <tz id="America/New_York" stdoff="-300" stdname="EST" dayoff="-240" dayname="EDT">
+      <standard wkday="1" min="0" sec="0" mon="11" hour="2" week="1"/>
+      <daylight wkday="1" min="0" sec="0" mon="3" hour="2" week="2"/>
+    </tz>
+    <comp uid="1b33102b-6d2e-4d98-ad27-c59a92de9798" d="1387472221000" status="CONF" noBlob="1" ciFolder="10" isOrg="1" class="PUB" loc="" compNum="0" apptId="498" url="" fb="B" calItemId="498" x_uid="1b33102b-6d2e-4d98-ad27-c59a92de9798" name="RECURTEST" seq="3" rsvp="0" fba="B" method="PUBLISH" transp="O">
+      <alarm action="DISPLAY">
+        <trigger>
+          <rel neg="1" m="15" related="START"/>
+        </trigger>
+        <desc/>
+      </alarm>
+      <or d="Mail03" a="mail03@greenviewdata.com" url="mail03@greenviewdata.com"/>
+      <recur>
+        <add>
+          <rule freq="DAI">
+            <interval ival="2"/>
+          </rule>
+        </add>
+      </recur>
+      <s u="1387486800000" d="20131219T160000" tz="America/New_York"/>
+      <e u="1387490400000" d="20131219T170000" tz="America/New_York"/>
+    </comp>
+  </inv>
+</appt>

data/spec/fixtures/xml_api_responses/alarms/using_all_intervals.xml

@@ -0,0 +1,26 @@
+<appt uid="1b33102b-6d2e-4d98-ad27-c59a92de9798" id="498" rev="27627" nextAlarm="1387486500000" d="1387472221000" s="0" l="10">
+  <inv id="497" seq="3" compNum="0" type="appt">
+    <tz id="America/New_York" stdoff="-300" stdname="EST" dayoff="-240" dayname="EDT">
+      <standard wkday="1" min="0" sec="0" mon="11" hour="2" week="1"/>
+      <daylight wkday="1" min="0" sec="0" mon="3" hour="2" week="2"/>
+    </tz>
+    <comp uid="1b33102b-6d2e-4d98-ad27-c59a92de9798" d="1387472221000" status="CONF" noBlob="1" ciFolder="10" isOrg="1" class="PUB" loc="" compNum="0" apptId="498" url="" fb="B" calItemId="498" x_uid="1b33102b-6d2e-4d98-ad27-c59a92de9798" name="RECURTEST" seq="3" rsvp="0" fba="B" method="PUBLISH" transp="O">
+      <alarm action="DISPLAY">
+        <trigger>
+          <rel neg="0" m="15" w="1" d="2" h="3" s="25" count="2" related="END"/>
+        </trigger>
+        <desc/>
+      </alarm>
+      <or d="Mail03" a="mail03@greenviewdata.com" url="mail03@greenviewdata.com"/>
+      <recur>
+        <add>
+          <rule freq="DAI">
+            <interval ival="2"/>
+          </rule>
+        </add>
+      </recur>
+      <s u="1387486800000" d="20131219T160000" tz="America/New_York"/>
+      <e u="1387490400000" d="20131219T170000" tz="America/New_York"/>
+    </comp>
+  </inv>
+</appt>

data/spec/fixtures/xml_api_responses/appointments/appointment_response_1.xml

@@ -0,0 +1,40 @@
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Header>
+    <context xmlns="urn:zimbra">
+      <change token="27762"/>
+    </context>
+  </soap:Header>
+  <soap:Body>
+    <GetAppointmentResponse xmlns="urn:zimbraMail">
+      <appt id="518" uid="1c71d474-5c1f-4048-84e3-9725c0825a44" nextAlarm="1392233100000" d="1387571704000" rev="27656" s="0" l="10">
+        <inv id="517" seq="4" compNum="0" type="appt">
+          <tz id="America/New_York" stdoff="-300" dayname="EDT" dayoff="-240" stdname="EST">
+            <standard min="0" wkday="1" sec="0" mon="11" hour="2" week="1"/>
+            <daylight min="0" wkday="1" sec="0" mon="3" hour="2" week="2"/>
+          </tz>
+          <comp uid="1c71d474-5c1f-4048-84e3-9725c0825a44" d="1387571704000" status="CONF" noBlob="1" ciFolder="10" isOrg="1" class="PUB" loc="" compNum="0" apptId="518" fb="B" url="" calItemId="518" x_uid="1c71d474-5c1f-4048-84e3-9725c0825a44" name="Test2222" seq="4" rsvp="0" fba="B" method="PUBLISH" transp="O">
+            <alarm action="DISPLAY">
+              <trigger>
+                <rel neg="1" m="5" related="START"/>
+              </trigger>
+              <desc/>
+            </alarm>
+            <or d="Mail03" a="mail03@greenviewdata.com" url="mail03@greenviewdata.com"/>
+            <recur>
+              <add>
+                <rule freq="MON">
+                  <interval ival="1"/>
+                  <byday>
+                    <wkday ordwk="2" day="WE"/>
+                  </byday>
+                </rule>
+              </add>
+            </recur>
+            <s u="1355340600000" d="20121212T143000" tz="America/New_York"/>
+            <e d="20121212T153000" u="1355344200000" tz="America/New_York"/>
+          </comp>
+        </inv>
+      </appt>
+    </GetAppointmentResponse>
+  </soap:Body>
+</soap:Envelope>