zimbra-soap-api 0.0.7.9

data/spec/zimbra/appointment/invite_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Zimbra::Appointment::Invite do
+  before do
+    @xml_api_responses_path = File.join(@fixture_path, 'xml_api_responses', 'multiple_invites')
+    @appointment = new_appointment_from_xml(File.join(@xml_api_responses_path, 'recurring_with_exceptions.xml'))
+  end
+  
+  describe "#exception" do
+    before do
+      @invite = @appointment.invites.find { |i| i.id == 549 }
+    end
+    it "should be set if this invite is an exception" do
+      @invite.exception.to_hash.should == {:recurrence_id=>"20140131T090000", :timezone=>"America/New_York", :range_type=>nil}
+    end
+  end
+  
+  describe "basic attributes" do
+    it "should set the description" do
+      @appointment.invites.first.description.should == "This is a recurring series"
+    end
+    it "should set the fragment" do
+      @appointment.invites.first.fragment.should == "This is a recurring series"
+    end
+    it "should set the organizer_email_address" do
+      @appointment.invites.first.organizer_email_address.should == 'mail03@greenviewdata.com'
+    end
+    it "should set is_organizer" do
+      @appointment.invites.first.is_organizer.should be_true
+    end
+    it "should set the name" do
+      @appointment.invites.first.name.should == 'fdsafdsafdsafdsafdsafdsa'
+    end
+    it "should set the computed_free_busy_status" do
+      @appointment.invites.first.computed_free_busy_status.should == :busy
+    end
+    it "should set the free_busy_setting" do
+      @appointment.invites.first.free_busy_setting.should == :busy
+    end
+    it "should set the invite_status" do
+      @appointment.invites.first.invite_status.should == :confirmed
+    end
+    it "should set all_day" do
+      @appointment.invites.first.all_day.should be_false
+    end
+    it "should set the visibility" do
+      @appointment.invites.first.visibility.should == :public
+    end
+    it "should set the location" do
+      @appointment.invites.first.location.should == 'Conference Room'
+    end
+    it "should set transparency" do
+      @appointment.invites.first.transparency.should == :opaque
+    end
+    it "should set start_date_time" do
+      @appointment.invites.first.start_date_time.should == Time.parse("2013-12-09 09:00:00 -0500")
+    end
+    it "should set end_date_time" do
+      @appointment.invites.first.end_date_time.should == Time.parse("2013-12-09 09:30:00 -0500")
+    end
+  end
+end

data/spec/zimbra/appointment/recur_rule_spec.rb

@@ -0,0 +1,307 @@
+require 'spec_helper'
+
+describe Zimbra::Appointment::RecurRule do
+  before do
+    @xml_api_responses_path = File.join(@fixture_path, 'xml_api_responses', 'recur_rules')
+  end
+  
+  describe "#create_xml" do
+    @sample_attribute_files = [
+      'second_wednesday_of_every_month.xml',
+      'day_27_of_every_2_months.xml',
+      'every_2_days.xml',
+      'every_3_weeks_on_tuesday_and_friday.xml',
+      'every_day_50_instances.xml',
+      'every_monday_wednesday_friday.xml',
+      'every_tuesday.xml',
+      'every_weekday_with_end_date.xml',
+      'every_year_on_february_2.xml',
+      'first_day_of_every_month.xml',
+      'first_monday_of_every_february.xml',
+      'first_weekend_day_of_every_month.xml',
+      'last_day_of_every_month.xml',
+      'second_day_of_every_2_months.xml'
+    ]
+    
+    @sample_attribute_files.each do |file_name|
+      context file_name do
+        before do
+          @xml = File.read(File.join(@xml_api_responses_path, file_name))
+          @attributes = Zimbra::Hash.from_xml(@xml)
+          @attributes = @attributes[:appt][:inv][:comp][:recur]
+          @recur_rule = Zimbra::Appointment::RecurRule.new_from_zimbra_attributes(@attributes)
+        end
+        
+        it "should match the expected attributes" do
+          document = Handsoap::XmlMason::Document.new do |doc|
+            doc.add "add" do |add_element|
+              @recur_rule.create_xml(add_element)
+            end
+          end
+          
+          parsed_xml = Zimbra::Hash.from_xml(document.to_s)
+          parsed_xml.should == @attributes
+        end
+      end
+    end
+  end
+  
+  describe ".new" do
+    @sample_attribute_files = {
+      'second_wednesday_of_every_month.xml' => {
+        :frequency => :monthly,
+        :interval => 1,
+        :by_day => [
+          { :day => :wednesday, :week_number => 2 }
+        ]
+      },
+      'day_27_of_every_2_months.xml' => {
+        frequency: :monthly,
+        interval: 2,
+        by_month_day: [27]
+      },
+      'every_2_days.xml' => {
+        frequency: :daily,
+        interval: 2
+      },
+      'every_3_weeks_on_tuesday_and_friday.xml' => {
+        :frequency=>:weekly, 
+        :interval=>3, 
+        :by_day => [
+          { :day => :tuesday },
+          { :day => :friday }
+        ]
+      },
+      'every_day_50_instances.xml' => {
+        :frequency => :daily, 
+        :interval => 1,
+        :count => 50
+      },
+      'every_monday_wednesday_friday.xml' => {
+        :frequency => :weekly, 
+        :interval => 1, 
+        :by_day => [
+          {:day=> :monday},
+          {:day=> :wednesday},
+          {:day=> :friday}
+        ]
+      },
+      'every_tuesday.xml' => {
+        :frequency=>:weekly, 
+        :interval=>1, 
+        :by_day=>[
+          {:day=>:tuesday}
+        ]
+      },
+      'every_weekday_with_end_date.xml' => {
+        :frequency=>:daily, 
+        :until_date=>Time.parse("20131220T045959Z"), 
+        :interval=>1, 
+        :by_day=>[
+          {:day=>:monday}, 
+          {:day=>:tuesday}, 
+          {:day=>:wednesday}, 
+          {:day=>:thursday}, 
+          {:day=>:friday}
+        ]
+      },
+      'every_year_on_february_2.xml' => {
+        :frequency=>:yearly, 
+        :interval=>1, 
+        :by_month_day=>[2],
+        :by_month => [2]
+      },
+      'first_day_of_every_month.xml' => {
+        :frequency=>:monthly, 
+        :interval=>1, 
+        :by_day=>[
+          {:day=>:sunday}, 
+          {:day=>:monday}, 
+          {:day=>:tuesday}, 
+          {:day=>:wednesday}, 
+          {:day=>:thursday}, 
+          {:day=>:friday},
+          {:day=>:saturday}
+        ],
+        :by_set_position => [1]
+      },
+      'first_monday_of_every_february.xml' => {
+        :frequency=>:yearly, 
+        :interval=>1, 
+        :by_set_position=>[1], 
+        :by_day=>[
+          {:day=>:monday}
+        ], 
+        :by_month=>[2]
+      },
+      'first_weekend_day_of_every_month.xml' => {
+        :frequency=>:monthly, 
+        :interval=>1, 
+        :by_set_position=>[1], 
+        :by_day=>[
+          {:day=>:sunday}, 
+          {:day=>:saturday}
+        ]
+      },
+      'last_day_of_every_month.xml' => {
+        :frequency=>:monthly, 
+        :interval=>1, 
+        :by_set_position=>[-1], 
+        :by_day=>[
+          {:day=>:sunday}, 
+          {:day=>:monday}, 
+          {:day=>:tuesday}, 
+          {:day=>:wednesday}, 
+          {:day=>:thursday}, 
+          {:day=>:friday},
+          {:day=>:saturday}
+        ]
+      },
+      'second_day_of_every_2_months.xml' => {
+        :frequency=>:monthly, 
+        :interval=>2, 
+        :by_set_position=>[2], 
+        :by_day=>[
+          {:day=>:sunday}, 
+          {:day=>:monday}, 
+          {:day=>:tuesday}, 
+          {:day=>:wednesday}, 
+          {:day=>:thursday}, 
+          {:day=>:friday},
+          {:day=>:saturday}
+        ]
+      }
+      #'weekly_with_an_exception.xml' => {}
+    }
+    
+    @sample_attribute_files.each do |file_name, expected_attributes|
+      context file_name do
+        before do
+          @attributes = Zimbra::Hash.from_xml(File.read(File.join(@xml_api_responses_path, file_name)))
+          @attributes = @attributes[:appt][:inv][:comp][:recur]
+          @recur_rule = Zimbra::Appointment::RecurRule.new_from_zimbra_attributes(@attributes)
+        end
+        
+        it "should match the expected attributes" do
+          @recur_rule.to_hash.should == expected_attributes
+        end
+      end
+    end
+  end
+  
+  describe ".parse_zimbra_attributes" do
+
+    @sample_attribute_files = {
+      'second_wednesday_of_every_month.xml' => {
+        :frequency => "MON",
+        :interval => 1,
+        :by_day => [
+          { :day => 'WE', :week_number => 2 }
+        ]
+      },
+      'day_27_of_every_2_months.xml' => {
+        frequency: "MON",
+        interval: 2,
+        by_month_day: [27]
+      },
+      'every_2_days.xml' => {
+        frequency: 'DAI',
+        interval: 2
+      },
+      'every_3_weeks_on_tuesday_and_friday.xml' => {
+        :frequency=>"WEE", 
+        :interval=>3, 
+        :by_day => [
+          {:day=>"TU"},
+          {:day=>"FR"}
+        ]
+      },
+      'every_day_50_instances.xml' => {
+        :frequency => "DAI", 
+        :interval => 1,
+        :count => 50
+      },
+      'every_monday_wednesday_friday.xml' => {
+        :frequency => "WEE", 
+        :interval => 1, 
+        :by_day => [
+          {:day=>"MO"},
+          {:day=>"WE"},
+          {:day=>"FR"}
+        ]
+      },
+      'every_tuesday.xml' => {
+        :frequency=>"WEE", 
+        :interval=>1, 
+        :by_day=>[
+          {:day=>"TU"}
+        ]
+      },
+      'every_weekday_with_end_date.xml' => {
+        :frequency=>"DAI", 
+        :until_date=>"20131220T045959Z", 
+        :interval=>1, 
+        :by_day=>[
+          {:day=>"MO"}, 
+          {:day=>"TU"}, 
+          {:day=>"WE"}, 
+          {:day=>"TH"}, 
+          {:day=>"FR"}
+        ]
+      },
+      'every_year_on_february_2.xml' => {
+        :frequency=>"YEA", 
+        :interval=>1, 
+        :by_month_day=>[2],
+        :by_month => [2]
+      },
+      'first_day_of_every_month.xml' => {
+        :frequency=>"MON", 
+        :interval=>1, 
+        :by_day=>[
+          {:day=>"SU"}, {:day=>"MO"}, {:day=>"TU"}, {:day=>"WE"}, {:day=>"TH"}, {:day=>"FR"}, {:day=>"SA"}
+        ],
+        :by_set_position => [1]
+      },
+      'first_monday_of_every_february.xml' => {
+        :frequency=>"YEA", 
+        :interval=>1, 
+        :by_set_position=>[1], 
+        :by_day=>[{:day=>"MO"}], 
+        :by_month=>[2]
+      },
+      'first_weekend_day_of_every_month.xml' => {
+        :frequency=>"MON", 
+        :interval=>1, 
+        :by_set_position=>[1], 
+        :by_day=>[{:day=>"SU"}, {:day=>"SA"}]
+      },
+      'last_day_of_every_month.xml' => {
+        :frequency=>"MON", 
+        :interval=>1, 
+        :by_set_position=>[-1], 
+        :by_day=>[{:day=>"SU"}, {:day=>"MO"}, {:day=>"TU"}, {:day=>"WE"}, {:day=>"TH"}, {:day=>"FR"}, {:day=>"SA"}]
+      },
+      'second_day_of_every_2_months.xml' => {
+        :frequency=>"MON", 
+        :interval=>2, 
+        :by_set_position=>[2], 
+        :by_day=>[{:day=>"SU"}, {:day=>"MO"}, {:day=>"TU"}, {:day=>"WE"}, {:day=>"TH"}, {:day=>"FR"}, {:day=>"SA"}]
+      }
+      #'weekly_with_an_exception.xml' => {}
+    }
+    
+    @sample_attribute_files.each do |file_name, expected_attributes|
+      context file_name do
+        before do
+          @attributes = Zimbra::Hash.from_xml(File.read(File.join(@xml_api_responses_path, file_name)))
+          @attributes = @attributes[:appt][:inv][:comp][:recur]
+        end
+        
+        it "should match the expected attributes" do
+          Zimbra::Appointment::RecurRule.parse_zimbra_attributes(@attributes).should == expected_attributes
+        end
+      end
+    end
+  end
+end

data/spec/zimbra/appointment_spec.rb

@@ -0,0 +1,175 @@
+require File.join(File.dirname(__FILE__),'../spec_helper')
+require 'json'
+
+describe Zimbra::Appointment do
+  describe ".parse_zimbra_attributes" do
+    before do
+      @xml_api_responses_path = File.join(@fixture_path, 'xml_api_responses', 'recur_rules')
+      xml = File.read(File.join(@xml_api_responses_path, 'second_wednesday_of_every_month.xml'))
+      @appointment_hash = Zimbra::Hash.from_xml(xml)
+    end
+    
+    it "should return all the attributes" do
+      Zimbra::Appointment.parse_zimbra_attributes(@appointment_hash).should == {:id=>518, :uid=>"1c71d474-5c1f-4048-84e3-9725c0825a44", :revision=>27656, :calendar_id=>10, :size=>0, :replies=>nil, :invites_attributes=>{:attributes=>{:id=>517, :seq=>4, :compNum=>0, :type=>"appt"}, :tz=>{:attributes=>{:id=>"America/New_York", :stdoff=>-300, :stdname=>"EST", :dayoff=>-240, :dayname=>"EDT"}, :standard=>{:attributes=>{:wkday=>1, :min=>0, :sec=>0, :mon=>11, :hour=>2, :week=>1}}, :daylight=>{:attributes=>{:wkday=>1, :min=>0, :sec=>0, :mon=>3, :hour=>2, :week=>2}}}, :comp=>{:attributes=>{:uid=>"1c71d474-5c1f-4048-84e3-9725c0825a44", :d=>1387571704000, :status=>"CONF", :noBlob=>1, :ciFolder=>10, :isOrg=>1, :class=>"PUB", :loc=>"", :compNum=>0, :apptId=>518, :url=>"", :fb=>"B", :calItemId=>518, :x_uid=>"1c71d474-5c1f-4048-84e3-9725c0825a44", :name=>"Test2222", :seq=>4, :rsvp=>0, :fba=>"B", :method=>"PUBLISH", :transp=>"O"}, :alarm=>{:attributes=>{:action=>"DISPLAY"}, :trigger=>{:rel=>{:attributes=>{:neg=>1, :m=>5, :related=>"START"}}}, :desc=>{}}, :or=>{:attributes=>{:d=>"Mail03", :a=>"mail03@greenviewdata.com", :url=>"mail03@greenviewdata.com"}}, :recur=>{:add=>{:rule=>{:attributes=>{:freq=>"MON"}, :interval=>{:attributes=>{:ival=>1}}, :byday=>{:wkday=>{:attributes=>{:ordwk=>2, :day=>"WE"}}}}}}, :s=>{:attributes=>{:u=>1355340600000, :d=>"20121212T143000", :tz=>"America/New_York"}}, :e=>{:attributes=>{:u=>1355344200000, :d=>"20121212T153000", :tz=>"America/New_York"}}}}, :date=>1387571704000, :loaded_from_search=>nil}
+    end
+  end
+  
+  describe "#recurrence_rule" do
+    before do
+      @xml_api_responses_path = File.join(@fixture_path, 'xml_api_responses', 'recur_rules')
+      @appointment = new_appointment_from_xml(File.join(@xml_api_responses_path, 'second_wednesday_of_every_month.xml'))
+    end
+  
+    it "should set the recurrence rule" do
+      @appointment.invites.first.recurrence_rule.to_hash.should == {:frequency=>:monthly, :interval=>1, :by_day=>[{:day=>:wednesday, :week_number=>2}]}
+    end
+  end
+  
+  describe "#create_xml" do
+    before do
+      @xml_api_responses_path = File.join(@fixture_path, 'xml_api_responses', 'multiple_invites')
+      @appointment = new_appointment_from_xml(File.join(@xml_api_responses_path, 'recurring_with_exceptions.xml'))
+    end
+  
+    it "should return the xml document to create this appointment" do
+      document = Handsoap::XmlMason::Document.new do |doc|
+        doc.add "CreateAppointmentRequest" do |create_appointment_request|
+          @appointment.create_xml(create_appointment_request)
+        end
+      end
+      #File.open(File.join(@fixture_path, 'xml_api_requests', 'appointments', 'create.xml'), 'w') do |io|
+      #  io.write document.to_s
+      #end
+      document.to_s.should == File.read(File.join(@fixture_path, 'xml_api_requests', 'appointments', 'create.xml'))
+    end
+  end
+  
+  context "from recurring_with_exceptions.xml" do
+    before do
+      @xml_api_responses_path = File.join(@fixture_path, 'xml_api_responses', 'multiple_invites')
+      @appointment = new_appointment_from_xml(File.join(@xml_api_responses_path, 'recurring_with_exceptions.xml'))
+    end
+    
+    describe "#invites" do
+      it "should initialize 5 invites" do
+        @appointment.invites.count.should == 5
+      end
+    end
+  end
+  
+  context "from one_attendee_and_one_reply.xml" do
+    before do
+      @xml_api_responses_path = File.join(@fixture_path, 'xml_api_responses', 'attendees')
+      @appointment = new_appointment_from_xml(File.join(@xml_api_responses_path, 'one_attendee_and_one_reply.xml'))
+    end
+    
+    describe "#replies" do
+      it "should load one reply" do
+        @appointment.replies.map(&:to_hash).should == [
+          {
+            :sequence_number=>1, 
+            :date=>Time.parse("2014-01-21 09:33:56 -0500"), 
+            :email_address=>"mail03@greenviewdata.com", 
+            :participation_status=>:tentative, 
+            :sent_by=>nil, 
+            :recurrence_range_type=>nil, 
+            :recurrence_id=>nil, 
+            :timezone=>nil, 
+            :recurrence_id_utc=>nil
+          }
+        ]
+      end
+    end
+    
+    describe "#attendees" do
+      it "should load one attendee" do
+        @appointment.invites.first.attendees.map(&:to_hash).should == [
+          {:email_address=>"mail03@greenviewdata.com", :friendly_name=>"Mail03", :rsvp=>1, :role=>"REQ", :participation_status=>:tentative}
+        ]
+      end
+    end
+  end
+  
+  context "from three_attendees_response_1.xml appointment" do
+    before do
+      @xml_api_responses_path = File.join(@fixture_path, 'xml_api_responses', 'attendees')
+      @appointment = new_appointment_from_xml(File.join(@xml_api_responses_path, 'three_attendees_response_1.xml'))
+    end
+    
+    describe "#replies" do
+      it "should set two replies" do
+        @appointment.replies.count.should == 2
+      end
+      
+      it "should set the reply attributes" do
+        @appointment.replies.map(&:to_hash).should == [
+          {
+            :sequence_number=>1, 
+            :date=>Time.parse("2014-01-21 09:33:56 -0500"), 
+            :email_address=>"mail03@greenviewdata.com", 
+            :participation_status=>:tentative, 
+            :sent_by=>nil, 
+            :recurrence_range_type=>nil, 
+            :recurrence_id=>nil, 
+            :timezone=>nil, 
+            :recurrence_id_utc=>nil
+          }, 
+          {
+            :sequence_number=>1, 
+            :date=>Time.parse("2014-01-21 09:33:56 -0500"), 
+            :email_address=>"mail04@greenviewdata.com", 
+            :participation_status=>:tentative, 
+            :sent_by=>nil, 
+            :recurrence_range_type=>nil, 
+            :recurrence_id=>nil, 
+            :timezone=>nil, 
+            :recurrence_id_utc=>nil
+          }
+        ]
+      end
+    end
+  
+    describe "#attendees" do
+      it "should make three attendee objects" do
+        @appointment.invites.first.attendees.count.should == 3
+      end
+    
+      it "should set the attendee attributes" do
+        @appointment.invites.first.attendees.map(&:to_hash).should == [
+          {:email_address=>"mail03@greenviewdata.com", :friendly_name=>"Mail03", :rsvp=>1, :role=>"REQ", :participation_status=>:tentative}, 
+          {:email_address=>"mail04@greenviewdata.com", :friendly_name=>"Test", :rsvp=>1, :role=>"REQ", :participation_status=>:needs_action}, 
+          {:email_address=>"mail01b@greenviewdata.com", :friendly_name=>"Test", :rsvp=>1, :role=>"REQ", :participation_status=>:needs_action}
+        ]
+      end
+    end
+    
+    describe "#alarm" do
+      it "should set the alarm" do
+        @appointment.invites.first.alarm.to_hash.should == {
+          :duration_negative=>true, :weeks=>nil, :days=>nil, :hours=>nil, :minutes=>5, :seconds=>nil, :when=>:start, :repeat_count=>nil
+        }
+      end
+    end
+    
+    describe "basic asttributes" do
+      it "should set the id" do
+        @appointment.id.should == 261
+      end
+      it "should set the uid" do
+        @appointment.uid.should == '8c62a78e-f48d-4f5e-8cc8-ba5f621d7ae8'
+      end
+      it "should set the revision" do
+        @appointment.revision.should == 4425
+      end
+      it "should set the date" do
+        @appointment.date.should == Time.parse("2014-01-21 09:04:13 -0500")
+      end
+      it "should set the calendar_id" do
+        @appointment.calendar_id.should == 10
+      end
+      it "should set the size" do
+        @appointment.size.should == 0
+      end
+    end
+  end
+end