zimbra 0.0.4 → 0.0.5

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

data/spec/zimbra/common_elements_spec.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__),'../spec_helper')
+
+describe Zimbra::A do
+  describe 'read' do
+    it 'should read a single attribute and return its value' do
+      doc = zimbra_soap_doc(<<XML)
+<n2:item>
+  <n2:a n="foobar">44</n2:a>
+  <n2:a n="testAttr">23</n2:a>
+</n2:item>
+XML
+      a = Zimbra::A.read(doc, 'testAttr')
+      a.should =~ /23/
+      a.should_not =~ /44/
+    end
+    it 'should read multiple attributes and return an array of values' do
+      thritytwofootsteps = zimbra_soap_doc(<<XML)
+<n2:item>
+<n2:a n="foobar">44</n2:a>
+<n2:a n="testAttr">28</n2:a>
+<n2:a n="testAttr">29</n2:a>
+<n2:a n="testAttr">30</n2:a>
+<n2:a n="testAttr">31</n2:a>
+</n2:item>
+XML
+      attrs = Zimbra::A.read(thritytwofootsteps, 'testAttr')
+      attrs.should_not be_empty
+      attrs = attrs.join('')
+      attrs.should =~ /28.*29.*30.*31/
+      attrs.should_not =~ /44/
+    end
+  end
+end

data/spec/zimbra/distribution_list_spec.rb

@@ -0,0 +1,54 @@
+require File.join(File.dirname(__FILE__),'../spec_helper')
+
+describe Zimbra::DistributionList do
+  describe 'members' do
+    it 'should be an empty array by default' do
+      dl = Zimbra::DistributionList.new
+      dl.members.should be_empty
+    end
+    it 'should be assigned an array of email addresses' do
+      dl = Zimbra::DistributionList.new(:members => ['a@b.com','b@c.com'])
+      dl.members.should == ['a@b.com','b@c.com']
+      dl.members = ['c@d.com']
+      dl.members.should == ['c@d.com']
+    end
+  end
+  describe 'new_members' do
+    it 'should only list members that were added' do
+      dl = Zimbra::DistributionList.new(:members => ['a@b.com','b@c.com'])
+      dl.members << 'd@e.com'
+      dl.new_members.should == ['d@e.com']
+    end
+    it 'should list all members added to a list that originally had no members' do
+      dl = Zimbra::DistributionList.new
+      dl.members << 'a@b.com' << 'b@c.com'
+      dl.new_members.should == ['a@b.com','b@c.com']
+    end
+    it 'should not list deleted members' do
+      dl = Zimbra::DistributionList.new(:members => ['a@b.com','b@c.com'])
+      dl.members.shift
+      dl.members << 'c@d.com'
+      dl.new_members.should == ['c@d.com']
+    end
+  end
+  describe 'removed_members' do
+    it 'should only list members that were removed' do
+      dl = Zimbra::DistributionList.new(:members => ['a@b.com','b@c.com'])
+      dl.members.shift
+      dl.removed_members.should == ['a@b.com']
+    end
+    it 'should not list added members' do
+      dl = Zimbra::DistributionList.new(:members => ['a@b.com','b@c.com'])
+      dl.members.shift
+      dl.members << 'c@d.com'
+      dl.removed_members.should == ['a@b.com']
+    end
+    it 'should always report empty if a record was created without any members' do
+      dl = Zimbra::DistributionList.new()
+      dl.members = ['a@b.com','b@c.com']
+      dl.members.shift
+      dl.members << 'c@d.com'
+      dl.removed_members.should be_empty
+    end
+  end
+end

data/zimbra.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+$:.push File.expand_path("../lib", __FILE__)
+require "zimbra/version"
+
+Gem::Specification.new do |s|
+  s.name = "zimbra"
+  s.version = Zimbra::VERSION
+
+  s.authors = ["Derek Kastner","Matt Wilson","Philippe Green","Greenview Data, Inc."]
+  s.date = '2009-11-18'
+  s.description = 'Interface to Zimbra management API'
+  s.summary = %q{SOAP Interface to Zimbra}
+  s.email = %q{development@greenviewdata.com}
+  s.homepage = "https://github.com/gdi/ruby-zimbra"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency 'curb'
+  s.add_runtime_dependency 'nokogiri'
+  s.add_runtime_dependency 'handsoap'
+end

metadata

@@ -1,104 +1,201 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: zimbra
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Derek Kastner
 - Matt Wilson
+- Philippe Green
+- Greenview Data, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-11-18 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2009-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: handsoap
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  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: handsoap
+  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: Interface to Zimbra management API
-email: derek@vedit.com mwilson@vedit.com
+email: development@greenviewdata.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .gitignore
+- .irbrc
+- Gemfile
 - README
+- Rakefile
+- lib/zimbra.rb
 - lib/zimbra/account.rb
 - lib/zimbra/acl.rb
+- lib/zimbra/appointment.rb
+- lib/zimbra/appointment/alarm.rb
+- lib/zimbra/appointment/attendee.rb
+- lib/zimbra/appointment/invite.rb
+- lib/zimbra/appointment/recur_exception.rb
+- lib/zimbra/appointment/recur_rule.rb
+- lib/zimbra/appointment/reply.rb
 - lib/zimbra/auth.rb
+- lib/zimbra/calendar.rb
 - lib/zimbra/common_elements.rb
 - lib/zimbra/cos.rb
+- lib/zimbra/delegate_auth_token.rb
 - lib/zimbra/distribution_list.rb
 - lib/zimbra/domain.rb
+- lib/zimbra/ext/hash.rb
+- lib/zimbra/extra/date_helpers.rb
+- lib/zimbra/folder.rb
+- lib/zimbra/handsoap_account_service.rb
 - lib/zimbra/handsoap_service.rb
-- lib/zimbra.rb
-has_rdoc: true
-homepage: 
+- lib/zimbra/version.rb
+- spec/fixtures/xml_api_requests/appointments/create.xml
+- spec/fixtures/xml_api_responses/alarms/15_minutes_before.xml
+- spec/fixtures/xml_api_responses/alarms/using_all_intervals.xml
+- spec/fixtures/xml_api_responses/appointments/appointment_response_1.xml
+- spec/fixtures/xml_api_responses/attendees/one_attendee_and_one_reply.xml
+- spec/fixtures/xml_api_responses/attendees/three_attendees_response_1.xml
+- spec/fixtures/xml_api_responses/multiple_invites/recurring_with_exceptions.xml
+- spec/fixtures/xml_api_responses/recur_rules/day_27_of_every_2_months.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_2_days.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_3_weeks_on_tuesday_and_friday.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_day_50_instances.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_monday_wednesday_friday.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_tuesday.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_weekday_with_end_date.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_year_on_february_2.xml
+- spec/fixtures/xml_api_responses/recur_rules/first_day_of_every_month.xml
+- spec/fixtures/xml_api_responses/recur_rules/first_monday_of_every_february.xml
+- spec/fixtures/xml_api_responses/recur_rules/first_weekend_day_of_every_month.xml
+- spec/fixtures/xml_api_responses/recur_rules/last_day_of_every_month.xml
+- spec/fixtures/xml_api_responses/recur_rules/second_day_of_every_2_months.xml
+- spec/fixtures/xml_api_responses/recur_rules/second_wednesday_of_every_month.xml
+- spec/fixtures/xml_api_responses/recur_rules/weekly_with_an_exception.xml
+- spec/spec_helper.rb
+- spec/zimbra/acl_spec.rb
+- spec/zimbra/appointment/alarm_spec.rb
+- spec/zimbra/appointment/invite_spec.rb
+- spec/zimbra/appointment/recur_rule_spec.rb
+- spec/zimbra/appointment_spec.rb
+- spec/zimbra/common_elements_spec.rb
+- spec/zimbra/distribution_list_spec.rb
+- zimbra.gemspec
+homepage: https://github.com/gdi/ruby-zimbra
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: SOAP Interface to Zimbra
-test_files: []
-
+test_files:
+- spec/fixtures/xml_api_requests/appointments/create.xml
+- spec/fixtures/xml_api_responses/alarms/15_minutes_before.xml
+- spec/fixtures/xml_api_responses/alarms/using_all_intervals.xml
+- spec/fixtures/xml_api_responses/appointments/appointment_response_1.xml
+- spec/fixtures/xml_api_responses/attendees/one_attendee_and_one_reply.xml
+- spec/fixtures/xml_api_responses/attendees/three_attendees_response_1.xml
+- spec/fixtures/xml_api_responses/multiple_invites/recurring_with_exceptions.xml
+- spec/fixtures/xml_api_responses/recur_rules/day_27_of_every_2_months.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_2_days.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_3_weeks_on_tuesday_and_friday.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_day_50_instances.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_monday_wednesday_friday.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_tuesday.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_weekday_with_end_date.xml
+- spec/fixtures/xml_api_responses/recur_rules/every_year_on_february_2.xml
+- spec/fixtures/xml_api_responses/recur_rules/first_day_of_every_month.xml
+- spec/fixtures/xml_api_responses/recur_rules/first_monday_of_every_february.xml
+- spec/fixtures/xml_api_responses/recur_rules/first_weekend_day_of_every_month.xml
+- spec/fixtures/xml_api_responses/recur_rules/last_day_of_every_month.xml
+- spec/fixtures/xml_api_responses/recur_rules/second_day_of_every_2_months.xml
+- spec/fixtures/xml_api_responses/recur_rules/second_wednesday_of_every_month.xml
+- spec/fixtures/xml_api_responses/recur_rules/weekly_with_an_exception.xml
+- spec/spec_helper.rb
+- spec/zimbra/acl_spec.rb
+- spec/zimbra/appointment/alarm_spec.rb
+- spec/zimbra/appointment/invite_spec.rb
+- spec/zimbra/appointment/recur_rule_spec.rb
+- spec/zimbra/appointment_spec.rb
+- spec/zimbra/common_elements_spec.rb
+- spec/zimbra/distribution_list_spec.rb
+has_rdoc: