webex_xml_api 0.1.0

data/spec/webex_xml_api/exceptions_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe WebexXmlApi::Error do
+  subject { described_class }
+
+  describe '#ancestors' do
+    subject { super().ancestors }
+    it { is_expected.to include(StandardError) }
+  end
+
+  describe 'raises an error' do
+    it 'with message' do
+      expect { raise WebexXmlApi::Error, 'this message exactly' }
+        .to raise_error('this message exactly')
+    end
+  end
+
+  describe WebexXmlApi::NotEnoughArguments do
+    describe '#ancestors' do
+      subject { super().ancestors }
+      it { is_expected.to include(WebexXmlApi::Error) }
+    end
+
+    describe 'raises an error' do
+      it 'with message' do
+        expect { raise WebexXmlApi::NotEnoughArguments, 'this message exactly' }
+          .to raise_error('this message exactly')
+      end
+    end
+  end
+
+  describe WebexXmlApi::RequestFailed do
+    describe '#ancestors' do
+      subject { super().ancestors }
+      it { is_expected.to include(WebexXmlApi::Error) }
+    end
+
+    describe 'raises an error' do
+      before(:each) do
+        @resp = {}
+        @resp[:code] = '999'
+        @resp[:text] = 'Error text'
+      end
+
+      it 'returns a response object and error message' do
+        expect { raise WebexXmlApi::RequestFailed.new(@resp), 'this message' }
+          .to raise_error { |error|
+            expect(error.message).to eql('this message')
+            expect(error.response).to eql(@resp)
+          }
+      end
+    end
+  end
+end

data/spec/webex_xml_api/meeting/create_meeting_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe WebexXmlApi::Meeting::CreateMeeting do
+  subject { described_class }
+
+  describe '#initialize' do
+    it 'creates new security_context' do
+      sm = subject.new(site_name: 'test')
+      expect(sm.security_context).to be
+    end
+  end
+
+  describe '#to_xml' do
+    it 'raises a NotEnoughArguments exception if arguments missing' do
+      sm = subject.new(site_name: 'test')
+      expect { sm.to_xml }
+        .to raise_error(WebexXmlApi::NotEnoughArguments,
+                        'Meeting::CreateMeeting')
+    end
+
+    it 'returns formatted XML text' do
+      expected = file_fixture('meeting_create_meeting_request.xml')
+      sm = subject.new(site_name: 'test', webex_id: '123456', password: 'test')
+      sm.conf_name = 'Test-Meeting via XML API'
+      sm.start_date = '07/30/2016 15:00:00'
+      sm.duration = '60'
+      expect(sm.to_xml).to eql(expected)
+    end
+  end
+
+  describe '#valid?' do
+    it 'fails if required fields are missing' do
+      sm = subject.new
+      expect(sm.valid?).to be_falsey
+    end
+
+    it 'succeeds if all required parameters are set' do
+      sm = subject.new
+      sm.conf_name = 'Test-Meeting via XML API'
+      sm.start_date = '07/30/2016 15:00:00'
+      sm.duration = '60'
+      expect(sm.valid?).to be_truthy
+    end
+  end
+
+  describe '#send_request' do
+    it 'raises a NotEnoughArguments exception for CreateMeeting' do
+      sm = subject.new(site_name: 'test')
+      expect { sm.send_request }
+        .to raise_error(WebexXmlApi::NotEnoughArguments,
+                        'Meeting::CreateMeeting')
+    end
+
+    it 'raises a NotEnoughArguments exception for SecurityContext' do
+      sm = subject.new(site_name: 'test')
+      sm.conf_name = 'Test-Meeting via XML API'
+      sm.start_date = '07/30/2016 15:00:00'
+      sm.duration = '60'
+      expect { sm.send_request }
+        .to raise_error(WebexXmlApi::NotEnoughArguments, 'SecurityContext')
+    end
+
+    it 'raises a RequestFailed exception with error message' do
+      sm = subject.new(site_name: 'test', webex_id: 'test', password: 'test')
+      sm.conf_name = 'Test-Meeting via XML API'
+      sm.start_date = '07/30/2016 15:00:00'
+      sm.duration = '60'
+      bad_reply = file_fixture('meeting_create_meeting_response_bad.xml')
+      stub_request(:post, 'https://test.webex.com/WBXService/XMLService')
+        .to_return(bad_reply)
+      expect { sm.send_request }
+        .to raise_error { |error|
+          expect(error.message)
+            .to eql('Error 060026: Meeting password must not be null')
+        }
+    end
+
+    it 'returns Response bodyContent as hash' do
+      sm = subject.new(site_name: 'test', webex_id: 'test', password: 'test')
+      sm.conf_name = 'Test-Meeting via XML API'
+      sm.start_date = '07/30/2016 15:00:00'
+      sm.duration = '60'
+      good_reply = file_fixture('meeting_create_meeting_response_good.xml')
+      stub_request(:post, 'https://test.webex.com/WBXService/XMLService')
+        .to_return(good_reply)
+      ret = sm.send_request
+      expect(ret).to be
+      expect(ret.key?('iCalendarURL')).to be_truthy
+      expect(ret['meetingkey']).to eql('123456789')
+    end
+  end
+
+  describe '#getters_and_setters' do
+    it 'sets and reads instance variables' do
+      sm = subject.new
+      expect(sm.conf_name = 'tst').to eql(sm.conf_name)
+      expect(sm.agenda = 'tst').to eql(sm.agenda)
+      expect(sm.meeting_password = 'tst').to eql(sm.meeting_password)
+      expect(sm.start_date = 'tst').to eql(sm.start_date)
+      expect(sm.duration = 'tst').to eql(sm.duration)
+      expect(sm.open_time = 'tst').to eql(sm.open_time)
+      expect(sm.join_teleconf_before_host = 'tst')
+        .to eql(sm.join_teleconf_before_host)
+      expect(sm.first_attendee_as_presenter = 'tst')
+        .to eql(sm.first_attendee_as_presenter)
+      expect(sm.telephony_support = 'tst').to eql(sm.telephony_support)
+      expect(sm.intl_local_call_in = 'tst').to eql(sm.intl_local_call_in)
+      expect(sm.teleconf_location = 'tst').to eql(sm.teleconf_location)
+      expect(sm.is_mp_audio = 'tst').to eql(sm.is_mp_audio)
+      expect(sm.enable_chat = 'tst').to eql(sm.enable_chat)
+      expect(sm.enable_audio_video = 'tst').to eql(sm.enable_audio_video)
+    end
+  end
+
+  describe '#start_date' do
+    it 'converts DateTime to formatted string' do
+      sm = subject.new
+      expected = '07/29/2016 16:00:00'
+      input = DateTime.new(2016, 7, 29, 16, 0, 0)
+      sm.start_date = input
+      expect(sm.start_date).to eql(expected)
+    end
+
+    it 'passes string without conversion' do
+      sm = subject.new
+      expected = '07/29/2016 16:59:59'
+      sm.start_date = expected
+      expect(sm.start_date).to eql(expected)
+    end
+  end
+end

data/spec/webex_xml_api/meeting/del_meeting_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe WebexXmlApi::Meeting::DelMeeting do
+  subject { described_class }
+
+  describe '#initialize' do
+    it 'creates attr_accessors and sets variables' do
+      dm = subject.new(site_name: 'test', meeting_key: '123456789')
+      expect(dm.meeting_key).to eql('123456789')
+      expect(dm.security_context).to be
+    end
+
+    it 'ignores invalid parameters' do
+      dm = subject.new(meeting_key: '123456789', invalid_param: 'test')
+      expect(dm.meeting_key).to eql('123456789')
+      expect(dm).not_to respond_to(:invalid_param)
+    end
+  end
+
+  describe '#to_xml' do
+    it 'raises a NotEnoughArguments exception if arguments missing' do
+      dm = subject.new(site_name: 'test')
+      expect { dm.to_xml }
+        .to raise_error(WebexXmlApi::NotEnoughArguments, 'Meeting::DelMeeting')
+    end
+
+    it 'returns formatted XML text' do
+      expected = file_fixture('meeting_del_meeting_request.xml')
+      dm = subject.new(site_name: 'test', webex_id: '123456', password: 'test',
+                       meeting_key: '123456789')
+      expect(dm.to_xml).to eql(expected)
+    end
+  end
+
+  describe '#valid?' do
+    it 'fails if meeting_key is missing' do
+      dm = subject.new
+      expect(dm.valid?).to be_falsey
+    end
+
+    it 'succeeds if all required parameters are set' do
+      dm = subject.new(meeting_key: '123456789')
+      expect(dm.valid?).to be_truthy
+    end
+  end
+
+  describe '#send_request' do
+    it 'raises a NotEnoughArguments exception for DelMeeting' do
+      dm = subject.new(site_name: 'test')
+      expect { dm.send_request }
+        .to raise_error(WebexXmlApi::NotEnoughArguments, 'Meeting::DelMeeting')
+    end
+
+    it 'raises a NotEnoughArguments exception for SecurityContext' do
+      dm = subject.new(site_name: 'test', meeting_key: '123456789')
+      expect { dm.send_request }
+        .to raise_error(WebexXmlApi::NotEnoughArguments, 'SecurityContext')
+    end
+
+    it 'raises a RequestFailed exception with error message' do
+      dm = subject.new(site_name: 'test', webex_id: 'test', password: 'test',
+                       meeting_key: '987654321')
+      bad_reply = file_fixture('meeting_del_meeting_response_bad.xml')
+      stub_request(:post, 'https://test.webex.com/WBXService/XMLService')
+        .to_return(bad_reply)
+      expect { dm.send_request }
+        .to raise_error { |error|
+          expect(error.message)
+            .to eql('Error 060001: Corresponding Meeting not found')
+        }
+    end
+
+    it 'returns Response bodyContent as hash' do
+      dm = subject.new(site_name: 'test', webex_id: 'test', password: 'test',
+                       meeting_key: '123456789')
+      good_reply = file_fixture('meeting_del_meeting_response_good.xml')
+      stub_request(:post, 'https://test.webex.com/WBXService/XMLService')
+        .to_return(good_reply)
+      ret = dm.send_request
+      expect(ret).to be
+      expect(ret.key?('iCalendarURL')).to be_truthy
+      expect(ret['iCalendarURL'].key?('host')).to be_truthy
+    end
+  end
+end

data/spec/webex_xml_api/meeting/get_meeting_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe WebexXmlApi::Meeting::GetMeeting do
+  subject { described_class }
+
+  describe '#initialize' do
+    it 'creates attr_accessors and sets variables' do
+      gm = subject.new(site_name: 'test', meeting_key: '123456789')
+      expect(gm.meeting_key).to eql('123456789')
+      expect(gm.security_context).to be
+    end
+
+    it 'ignores invalid parameters' do
+      gm = subject.new(meeting_key: '123456789', invalid_param: 'test')
+      expect(gm.meeting_key).to eql('123456789')
+      expect(gm).not_to respond_to(:invalid_param)
+    end
+  end
+
+  describe '#to_xml' do
+    it 'raises a NotEnoughArguments exception if arguments missing' do
+      gm = subject.new(site_name: 'test')
+      expect { gm.to_xml }
+        .to raise_error(WebexXmlApi::NotEnoughArguments, 'Meeting::GetMeeting')
+    end
+
+    it 'returns formatted XML text' do
+      expected = file_fixture('meeting_get_meeting_request.xml')
+      gm = subject.new(site_name: 'test', webex_id: '123456', password: 'test',
+                       meeting_key: '123456789')
+      expect(gm.to_xml).to eql(expected)
+    end
+  end
+
+  describe '#valid?' do
+    it 'fails if meeting_key is missing' do
+      gm = subject.new
+      expect(gm.valid?).to be_falsey
+    end
+
+    it 'succeeds if all required parameters are set' do
+      gm = subject.new(meeting_key: '123456789')
+      expect(gm.valid?).to be_truthy
+    end
+  end
+
+  describe '#send_request' do
+    it 'raises a NotEnoughArguments exception for GetMeeting' do
+      gm = subject.new(site_name: 'test')
+      expect { gm.send_request }
+        .to raise_error(WebexXmlApi::NotEnoughArguments, 'Meeting::GetMeeting')
+    end
+
+    it 'raises a NotEnoughArguments exception for SecurityContext' do
+      gm = subject.new(site_name: 'test', meeting_key: '123456789')
+      expect { gm.send_request }
+        .to raise_error(WebexXmlApi::NotEnoughArguments, 'SecurityContext')
+    end
+
+    it 'raises a RequestFailed exception with error message' do
+      gm = subject.new(site_name: 'test', webex_id: 'test', password: 'test',
+                       meeting_key: '987654321')
+      bad_reply = file_fixture('meeting_get_meeting_response_bad.xml')
+      stub_request(:post, 'https://test.webex.com/WBXService/XMLService')
+        .to_return(bad_reply)
+      expect { gm.send_request }
+        .to raise_error { |error|
+          expect(error.message)
+            .to eql('Error 060001: Corresponding Meeting not found')
+        }
+    end
+
+    it 'returns Response bodyContent as hash' do
+      gm = subject.new(site_name: 'test', webex_id: 'test', password: 'test',
+                       meeting_key: '123456789')
+      good_reply = file_fixture('meeting_get_meeting_response_good.xml')
+      stub_request(:post, 'https://test.webex.com/WBXService/XMLService')
+        .to_return(good_reply)
+      ret = gm.send_request
+      expect(ret).to be
+      expect(ret.key?('meetingkey')).to be_truthy
+      expect(ret['hostKey']).to eql('123456')
+    end
+  end
+end

data/spec/webex_xml_api/meeting/getjoinurl_meeting_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe WebexXmlApi::Meeting::GetjoinurlMeeting do
+  subject { described_class }
+
+  describe '#initialize' do
+    it 'creates attr_accessors and sets variables' do
+      gjum = subject.new(site_name: 'test', session_key: '123456789')
+      expect(gjum.session_key).to eql('123456789')
+      expect(gjum.security_context).to be
+    end
+
+    it 'ignores invalid parameters' do
+      gjum = subject.new(session_key: '123456789', invalid_param: 'test')
+      expect(gjum.session_key).to eql('123456789')
+      expect(gjum).not_to respond_to(:invalid_param)
+    end
+  end
+
+  describe '#to_xml' do
+    it 'raises a NotEnoughArguments exception if arguments missing' do
+      gjum = subject.new(site_name: 'test')
+      expect { gjum.to_xml }
+        .to raise_error(WebexXmlApi::NotEnoughArguments,
+                        'Meeting::GetjoinurlMeeting')
+    end
+
+    it 'returns formatted XML text' do
+      expected = file_fixture('meeting_getjoinurl_meeting_request.xml')
+      gjum = subject.new(site_name: 'test', webex_id: '123456',
+                         password: 'test', session_key: '123456789')
+      expect(gjum.to_xml).to eql(expected)
+    end
+  end
+
+  describe '#valid?' do
+    it 'fails if session_key is missing' do
+      gjum = subject.new
+      expect(gjum.valid?).to be_falsey
+    end
+
+    it 'succeeds if all required parameters are set' do
+      gjum = subject.new(session_key: '123456789')
+      expect(gjum.valid?).to be_truthy
+    end
+  end
+
+  describe '#send_request' do
+    it 'raises a NotEnoughArguments exception for GetjoinurlMeeting' do
+      gjum = subject.new(site_name: 'test')
+      expect { gjum.send_request }
+        .to raise_error(WebexXmlApi::NotEnoughArguments,
+                        'Meeting::GetjoinurlMeeting')
+    end
+
+    it 'raises a NotEnoughArguments exception for SecurityContext' do
+      gjum = subject.new(site_name: 'test', session_key: '123456789')
+      expect { gjum.send_request }
+        .to raise_error(WebexXmlApi::NotEnoughArguments, 'SecurityContext')
+    end
+
+    it 'raises a RequestFailed exception with error message' do
+      gjum = subject.new(site_name: 'test', webex_id: 'test', password: 'test',
+                         session_key: '987654321')
+      bad_reply = file_fixture('meeting_getjoinurl_meeting_response_bad.xml')
+      stub_request(:post, 'https://test.webex.com/WBXService/XMLService')
+        .to_return(bad_reply)
+      expect { gjum.send_request }
+        .to raise_error { |error|
+          expect(error.message)
+            .to eql('Error 060001: Corresponding Meeting not found')
+        }
+    end
+
+    it 'returns Response bodyContent as hash' do
+      gjum = subject.new(site_name: 'test', webex_id: 'test', password: 'test',
+                         session_key: '123456789')
+      good_reply = file_fixture('meeting_getjoinurl_meeting_response_good.xml')
+      stub_request(:post, 'https://test.webex.com/WBXService/XMLService')
+        .to_return(good_reply)
+      ret = gjum.send_request
+      expect(ret).to be
+      expect(ret.key?('joinMeetingURL')).to be_truthy
+      expect(ret.key?('inviteMeetingURL')).to be_truthy
+    end
+  end
+end

data/spec/webex_xml_api/security_context_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe WebexXmlApi::SecurityContext do
+  subject { described_class }
+
+  describe '#initialize' do
+    it 'creates attr_accessors and sets variables' do
+      sc = subject.new(site_name: 'test', site_id: '123456')
+      expect(sc.site_name).to eql('test')
+      expect(sc.site_id).to eql('123456')
+      expect(sc.email).to be_nil
+    end
+
+    it 'ignores invalid parameters' do
+      sc = subject.new(site_name: 'test', invalid_param: 'test')
+      expect(sc.site_name).to eql('test')
+      expect(sc).not_to respond_to(:invalid_param)
+    end
+  end
+
+  describe '#to_xml' do
+    it 'raises a NotEnoughArguments exception if arguments missing' do
+      sc = subject.new(site_name: 'test')
+      expect { sc.to_xml }
+        .to raise_error(WebexXmlApi::NotEnoughArguments, 'SecurityContext')
+    end
+
+    it 'returns formatted XML text' do
+      expected = "<header>\n  <securityContext>\n"
+      expected += "    <webExID>test</webExID>\n"
+      expected += "    <password>test</password>\n"
+      expected += "    <siteName>test</siteName>\n"
+      expected += "  </securityContext>\n</header>\n"
+      sc = subject.new(site_name: 'test', webex_id: 'test', password: 'test')
+      expect(sc.to_xml).to eql(expected)
+    end
+  end
+
+  describe '#valid?' do
+    it 'fails if site_name is missing' do
+      sc = subject.new(webex_id: 'test', password: 'test')
+      expect(sc.valid?).to be_falsey
+    end
+
+    it 'fails if webex_id is missing' do
+      sc = subject.new(site_name: 'test', session_ticket: 'test')
+      expect(sc.valid?).to be_falsey
+    end
+
+    it 'fails if password or session_ticket are missing' do
+      sc = subject.new(site_name: 'test', webex_id: 'test')
+      expect(sc.valid?).to be_falsey
+    end
+
+    it 'succeeds if all required parameters are set' do
+      sc = subject.new(site_name: 'test', webex_id: 'test', password: 'test')
+      expect(sc.valid?).to be_truthy
+    end
+  end
+end