webex_xml_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc6439b697c1c55511d7d068eb80998801ea933c
-  data.tar.gz: 17c74a9dcf533b0af473db71e2c803f6465f9984
+  metadata.gz: 3ff45d3c08534dc9ae3f8c07e89ebeeae2f9c677
+  data.tar.gz: 38b985ace7c196bafbe9beed8fd20c62e359aee7
 SHA512:
-  metadata.gz: 402c5e713cf1be2f30210a39fa37c89bd315bd14180b40eaef268b67ae6e3453d7502eb985f64c6a80886dbebfd4a610bc968f14bfca19daea8b6860ad66855e
-  data.tar.gz: f73f70f9856cf2c17b04137d93e701b2469bf573dcb7debe50804b8dc86c46a5a7fcc310885e3baeb68a2de0214cb41b47b6cea0ddaf28bee4845a2dd9c2e63c
+  metadata.gz: 2b64e12a355b219456277eacee9b7d8675f5d0bd59dba53080a95da6d397362118f93b3547b1eb5beca18d39d4eda0f9c80b03d2bc4897e7a08880c158101987
+  data.tar.gz: 4b9aac0d6f9662c52ce361c5d58738380f1136165d484f4948d8b23516cc11fc049920ec0ab45e66e1a090b2538aee99e2a8f292e7b423467dd025356a7b733d

data.tar.gz.sig

@@ -1 +1,3 @@
-���>��'�������4�U�Aqw ��$�GT
n� �] 8�M�b�C�1w��Ζ�4���&P�N��n|{����;�R:�tlZM|6)R���P�Vf�@LE�N��ޅE\q�p,�P�Nٓ!.ذj�g��u<���
+e��Q�2���m�A˼[�nU�5��r�2/��R �hW�ˣ���s�y�Bm�r��K��/$�.��=w�)I�����j�H�l9��
+��?��R����[�k���
+��"~*�*�I�>�9�z��S���g�>���g������P�k	��~����K��'�^��=T<V��o�Y�=/���GTj'5J��(�3k �=Z1-��H���h���C	�b���Zz��|�!S�5��J|c���[u�m

data/.rubocop.yml

@@ -3,9 +3,6 @@ AllCops:
     - 'bin/**/*'
     - 'webex_xml_api.gemspec'
 
-Documentation:
-  Enabled: false
-
 Metrics/AbcSize:
   Enabled: false
 

data/README.md

@@ -48,16 +48,11 @@ To create a WebEx Meeting you need to use **WebexXmlApi::Meeting::CreateMeeting*
 
 ```ruby
   sm = WebexXmlApi::Meeting::CreateMeeting.new(site_name: 'test', webex_id: 'username', password: 'password')
-  => #<WebexXmlApi::Meeting::CreateMeeting:0x007ff2f99f0a30 @security_context=#<WebexXmlApi::SecurityContext:0x0... (output cut for brevity)
-  sm.conf_name = 'Name of the Telephone Conference'
-  => "Name of the Telephone Conference"
-  sm.agenda = 'Meeting Agenda'
-  => "Meeting Agenda"
-  sm.start_date = '07/29/2016 15:00:00'   # note the MM/DD/YYYY HH:MM:SS format, or provide a DateTime object
-  => "07/29/2016 15:00:00"
-  sm.duration = '30'      # in Minutes
-  => "30"
-  sm.open_time = '900'    # time before the start in seconds where participants can join the meeting
+  sm.conf_name = 'Name of the Telephone Conference' # REQUIRED: set the name of your conference
+  sm.agenda = 'Meeting Agenda'            # OPTIONAL: set the agenda
+  sm.start_date = '07/29/2016 15:00:00'   # REQUIRED: start time; note the MM/DD/YYYY HH:MM:SS format, or provide a DateTime object
+  sm.duration = '30'                      # REQUIRED: duration in Minutes
+  sm.open_time = '900'                    # OPTIONAL: time before the start in seconds where participants can join the meeting
   sm.send_request
   => {"meetingkey"=>"123456789", "iCalendarURL"=>{"host"=>"https://test.webex.com/test/j.php?MTID=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "attendee"=>"https://test.webex.com/test/j.php?MTID=bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"}, "guestToken"=>"cccccccccccccccccccccccccccccccc", "type"=>"meet:createMeetingResponse"}
 ```
@@ -66,6 +61,11 @@ This will create a very basic meeting for you.
 
 Using the **meetingkey** you can retrieve further details of your Meeting (**WebexXmlApi::Meeting::GetMeeting**), get URL for joining the meeting (**WebexXmlApi::Meeting::GetjoinurlMeeting**) or delete it (**WebexXmlApi::Meeting::DelMeeting**).
 
+WebexXmlApi is throwing Exceptions, make sure you implement `begin..rescue` blocks. Following Exceptions are being raised:
+
+* **NotEnoughArguments** - API Method is missing parameters required to fulfill the WebEx request
+* **RequestFailed** - Raised if WebEx API Interface returns an error. The error message sent by the WebEx can be retrieved from the message property and entire response object for debugging purposes is stored in the response propery.
+
 Further usage details can be found in [Wiki Site](https://github.com/erolms/webex_xml_api/wiki) here at GitHub or in the gem documentation.
 
 ## Development
@@ -86,7 +86,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/erolms
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://raw.githubusercontent.com/erolms/webex_xml_api/master/LICENSE.txt).
 
 ## Copyrights
 

data/lib/webex_xml_api/common.rb

@@ -1,13 +1,24 @@
 module WebexXmlApi
+  ##
+  # The +Common+ module is a collection of methods used by many other modules
+  # and it is being included within those.
+  #
   module Common
-    # POST request to the WebEx XML Service
+    ##
+    # The +post_webex_request+ method sends the request to WebEx XML Service.
+    #
     def post_webex_request(site_name, request)
       endpoint = "https://#{site_name}.webex.com/WBXService/XMLService".freeze
       HTTParty.post(endpoint, body: request,
                               headers: { 'Content-Type' => 'application/xml' })
     end
 
-    # Check WebEx Response status and raise Exception if FAILURE
+    ##
+    # The +check_response_and_return_data+ method checks the WebEx Response
+    # status and raises <tt>WebexXmlApi::RequestFailed</tt> Exception if status
+    # is otherwise than SUCCESS. If the request was successful than the parsed
+    # Response Hash is returned.
+    #
     def check_response_and_return_data(resp)
       status = resp.parsed_response['message']['header']['response']['result']
       return resp.parsed_response['message']['body']['bodyContent'] if
@@ -17,7 +28,10 @@ module WebexXmlApi
       raise WebexXmlApi::RequestFailed.new(resp), "Error #{c}: #{t}"
     end
 
-    # Create WebEx XML Request
+    ##
+    # The +create_xml_request+ method creates a XML formatted document as
+    # understood by WebEx XML API Service including the Security Context.
+    #
     def create_xml_request(sec_context, req_type, body_content)
       namespaces = {
         'xmlns:serv' => 'http://www.webex.com/schemas/2002/06/service',
@@ -36,7 +50,7 @@ module WebexXmlApi
       builder.to_xml.gsub(%r{(<\w+\/>)}, '')
     end
 
-    def process_object(label, obj, xml, req_type)
+    def process_object(label, obj, xml, req_type) # :nodoc:
       xml.send(label) do
         xml.parent['xsi:type'] = req_type if label == 'bodyContent'
         obj.each do |key, value|

data/lib/webex_xml_api/exceptions.rb

@@ -1,19 +1,20 @@
 module WebexXmlApi
-  # @abstact Exceptions raised by WebexXmlApi inherit from Error
+  # Exceptions raised by WebexXmlApi inherit from Error
   class Error < StandardError; end
 
   # Exception raised if you do not provide enough arguments for the Request
-  # Object to be valid
+  # Object to be valid.
   class NotEnoughArguments < Error; end
 
-  # @abstract Exception raised if request against WebEx Service failed
+  # Exception raised if request against WebEx Service fails
+  # Returns the error received by WebEx XML API Service
+  # @return [Hash] An object with error code and message
   class RequestFailed < Error
-    # Returns the error received by WebEx XML API Service
-    # @return [Hash] An object with error code and message
+    # The reader method for the response object
     attr_reader :response
 
-    # Instantiate an instance of RequestFailed with error Object
-    # @param [Object] An object with response received by WebEx Service
+    # Instantiate an instance of +RequestFailed+ with an error Object
+    # @param response [Object] object with response received by WebEx Service
     def initialize(response)
       @response ||= response
     end

data/lib/webex_xml_api/meeting/create_meeting.rb

@@ -1,67 +1,109 @@
 module WebexXmlApi
   module Meeting
+    ##
+    # The +CreateMeeting+ Class sends a Create Meeting request to the WebEx
+    # XML API Service and returns a Hash with the meeting key of the newly
+    # created meeting
+    #
     class CreateMeeting
       include WebexXmlApi::Common
 
+      # XML Request Type for the <tt>WebexXmlApi::Meeting::CreateMeeting</tt>
+      # service
       REQUEST_TYPE =
         'java:com.webex.service.binding.meeting.CreateMeeting'.freeze
 
+      # Accessor methods for meeting and security_context object
       attr_accessor :security_context, :meeting
+      # Reader methods for request and response objects
       attr_reader :request, :response
 
+      ##
+      # The +initialize+ method for newly created instance parsing provided
+      # parameters (if any). The +initialize+ method automaticaly creates
+      # new +SecurityContext+ instance and passes the attribes.
+      #
       def initialize(attributes = {})
         @security_context ||= WebexXmlApi::SecurityContext.new(attributes)
         @meeting ||= []
         init_meeting_object
       end
 
+      ##
+      # The +to_xml+ method returns XML representation of the
+      # <tt>WebexXmlApi::Meeting::CreateMeeting</tt> instance as understood by
+      # the WebEx XML Service.
+      #
       def to_xml
         raise WebexXmlApi::NotEnoughArguments,
               'Meeting::CreateMeeting' unless valid?
         create_xml_request(@security_context.to_xml, REQUEST_TYPE, @meeting)
       end
 
+      ##
+      # Returns true if required parameters provided, otherwise false.
+      #
       def valid?(context = self)
         return false if context.conf_name.nil?
         return false if context.start_date.nil? || context.duration.nil?
         true
       end
 
+      ##
+      # The +send_request+ method will issue the XML API request to WebEx,
+      # parse the results and return data if successful. Upon failure an
+      # exception is raised.
+      #
       def send_request
         @request = to_xml
         @response = post_webex_request(security_context.site_name, @request)
         check_response_and_return_data(@response)
       end
 
-      # various getters and setter from here
+      # ----------------------------------
+      # :section: Getter and Setter Methods
+      # A selection of getter and setter methods for easier access to the
+      # instance variables based on the experience using the WebEx Service.
+      # ----------------------------------
+
+      # The +conf_name+ getter
       def conf_name
         @meeting['metaData']['confName']
       end
 
+      # The +conf_name+ setter
       def conf_name=(str)
         @meeting['metaData']['confName'] = str
       end
 
+      # The +agenda+ getter
       def agenda
         @meeting['metaData']['agenda']
       end
 
+      # The +agenda+ setter
       def agenda=(str)
         @meeting['metaData']['agenda'] = str
       end
 
+      # The +meeting_password+ getter
       def meeting_password
         @meeting['accessControl']['meetingPassword']
       end
 
+      # The +meeting_password+ setter
       def meeting_password=(str)
         @meeting['accessControl']['meetingPassword'] = str
       end
 
+      # The +start_date+ getter
       def start_date
         @meeting['schedule']['startDate']
       end
 
+      # The +start_date+ setter
+      # Paremeter provided can be either a String in a MM/DD/YYYY HH:MI:SS
+      # format or a DateTime object that is formatted to fit the WebEx format.
       def start_date=(str)
         if str.is_a? String
           @meeting['schedule']['startDate'] = str
@@ -70,88 +112,118 @@ module WebexXmlApi
         end
       end
 
+      # The +duration+ getter
       def duration
         @meeting['schedule']['duration']
       end
 
+      # The +duration+ setter
       def duration=(str)
         @meeting['schedule']['duration'] = str
       end
 
+      # The +open_time+ getter
       def open_time
         @meeting['schedule']['openTime']
       end
 
+      # The +open_time+ setter
       def open_time=(str)
         @meeting['schedule']['openTime'] = str
       end
 
+      # The +join_teleconf_before_host+ getter
       def join_teleconf_before_host
         @meeting['schedule']['joinTeleconfBeforeHost']
       end
 
+      # The +join_teleconf_before_host+ setter
       def join_teleconf_before_host=(str)
         @meeting['schedule']['joinTeleconfBeforeHost'] = str
       end
 
+      # The +first_attendee_as_presenter+ getter
       def first_attendee_as_presenter
         @meeting['schedule']['firstAttendeeAsPresenter']
       end
 
+      # The +first_attendee_as_presenter+ setter
       def first_attendee_as_presenter=(str)
         @meeting['schedule']['firstAttendeeAsPresenter'] = str
       end
 
+      # The +telephony_support+ getter
       def telephony_support
         @meeting['telephony']['telephonySupport']
       end
 
+      # The +telephony_support+ setter
       def telephony_support=(str)
         @meeting['telephony']['telephonySupport'] = str
       end
 
+      # The +intl_local_call_in+ getter
       def intl_local_call_in
         @meeting['telephony']['intlLocalCallIn']
       end
 
+      # The +intl_local_call_in+ setter
       def intl_local_call_in=(str)
         @meeting['telephony']['intlLocalCallIn'] = str
       end
 
+      # The +teleconf_location+ getter
       def teleconf_location
         @meeting['telephony']['teleconfLocation']
       end
 
+      # The +teleconf_location+ setter
       def teleconf_location=(str)
         @meeting['telephony']['teleconfLocation'] = str
       end
 
+      # The +is_mp_audio+ getter
       # rubocop:disable PredicateName
       def is_mp_audio
         @meeting['telephony']['isMPAudio']
       end
 
+      # The +is_mp_audio+ setter
       def is_mp_audio=(str)
         @meeting['telephony']['isMPAudio'] = str
       end
       # rubocop:enable PredicateName
 
+      # The +enable_chat+ getter
       def enable_chat
         @meeting['enableOptions']['chat']
       end
 
+      # The +enable_chat+ setter
       def enable_chat=(str)
         @meeting['enableOptions']['chat'] = str
       end
 
+      # The +enable_audio_video+ getter
       def enable_audio_video
         @meeting['enableOptions']['audioVideo']
       end
 
+      # The +enable_audio_video+ setter
       def enable_audio_video=(str)
         @meeting['enableOptions']['audioVideo'] = str
       end
 
+      # The +enable_attendee_list+ getter
+      def enable_attendee_list
+        @meeting['enableOptions']['attendeeList']
+      end
+
+      # The +enable_attendee_list+ setter
+      def enable_attendee_list=(str)
+        @meeting['enableOptions']['attendeeList'] = str
+      end
+
       private
 
       def init_meeting_object

data/lib/webex_xml_api/meeting/del_meeting.rb

@@ -1,16 +1,31 @@
 module WebexXmlApi
   module Meeting
+    ##
+    # The +DekMeeting+ Class sends delete meeting request to the WebEx XML API
+    # service
+    #
     class DelMeeting
       include WebexXmlApi::Common
 
+      # XML Request Type for the <tt>WebexXmlApi::Meeting::DelMeeting</tt>
+      # service
       REQUEST_TYPE = 'java:com.webex.service.binding.meeting.DelMeeting'.freeze
+
+      # The meeting_key is required parameter for this service
       PARAMETER_MAPPING = {
         meeting_key: 'meetingKey'
       }.freeze
 
+      # Accessor methods for meeting_key property and security_context object
       attr_accessor :meeting_key, :security_context
+      # Reader methods for request and response objects
       attr_reader :request, :response
 
+      ##
+      # The +initialize+ method for newly created instance parsing provided
+      # parameters (if any). The +initialize+ method automaticaly creates
+      # new +SecurityContext+ instance and passes the attribes.
+      #
       def initialize(attributes = {})
         attributes.each_pair do |k, v|
           send("#{k}=", v) if PARAMETER_MAPPING.key?(k)
@@ -18,6 +33,11 @@ module WebexXmlApi
         @security_context ||= WebexXmlApi::SecurityContext.new(attributes)
       end
 
+      ##
+      # The +to_xml+ method returns XML representation of the
+      # <tt>WebexXmlApi::Meeting::DelMeeting</tt> instance as understood by
+      # the WebEx XML Service.
+      #
       def to_xml
         raise WebexXmlApi::NotEnoughArguments,
               'Meeting::DelMeeting' unless valid?
@@ -29,11 +49,19 @@ module WebexXmlApi
                            body_content)
       end
 
+      ##
+      # Returns true if required parameters provided, otherwise false.
+      #
       def valid?(context = self)
         return false if context.meeting_key.nil?
         true
       end
 
+      ##
+      # The +send_request+ method will issue the XML API request to WebEx,
+      # parse the results and return data if successful. Upon failure an
+      # exception is raised.
+      #
       def send_request
         @request = to_xml
         @response = post_webex_request(security_context.site_name, @request)

data/lib/webex_xml_api/meeting/get_meeting.rb

@@ -1,16 +1,34 @@
 module WebexXmlApi
+  ##
+  # The +Meeting+ module encapsulates the WebEx Meeting XML namespace
+  #
   module Meeting
+    ##
+    # The +GetMeeting+ Class queries WebEx API Service for given meeting_key
+    # and returns the meeting details.
+    #
     class GetMeeting
       include WebexXmlApi::Common
 
+      # XML Request Type for the <tt>WebexXmlApi::Meeting::GetMeeting</tt>
+      # service
       REQUEST_TYPE = 'java:com.webex.service.binding.meeting.GetMeeting'.freeze
+
+      # The meeting_key is required parameter for this service
       PARAMETER_MAPPING = {
         meeting_key: 'meetingKey'
       }.freeze
 
+      # Accessor methods for meeting_key property and security_context object
       attr_accessor :meeting_key, :security_context
+      # Reader methods for request and response objects
       attr_reader :request, :response
 
+      ##
+      # The +initialize+ method for newly created instance parsing provided
+      # parameters (if any). The +initialize+ method automaticaly creates
+      # new +SecurityContext+ instance and passes the attribes.
+      #
       def initialize(attributes = {})
         attributes.each_pair do |k, v|
           send("#{k}=", v) if PARAMETER_MAPPING.key?(k)
@@ -18,6 +36,11 @@ module WebexXmlApi
         @security_context ||= WebexXmlApi::SecurityContext.new(attributes)
       end
 
+      ##
+      # The +to_xml+ method returns XML representation of the
+      # <tt>WebexXmlApi::Meeting::GetMeeting</tt> instance as understood by
+      # the WebEx XML Service.
+      #
       def to_xml
         raise WebexXmlApi::NotEnoughArguments,
               'Meeting::GetMeeting' unless valid?
@@ -29,11 +52,19 @@ module WebexXmlApi
                            body_content)
       end
 
+      ##
+      # Returns true if required parameters provided, otherwise false.
+      #
       def valid?(context = self)
         return false if context.meeting_key.nil?
         true
       end
 
+      ##
+      # The +send_request+ method will issue the XML API request to WebEx,
+      # parse the results and return data if successful. Upon failure an
+      # exception is raised.
+      #
       def send_request
         @request = to_xml
         @response = post_webex_request(security_context.site_name, @request)

data/lib/webex_xml_api/meeting/getjoinurl_meeting.rb

@@ -1,17 +1,32 @@
 module WebexXmlApi
   module Meeting
+    ##
+    # The +GetjoinurlMeeting+ Class queries WebEx API Service for given
+    # session_key (meeting key) and returns a Hash with WebEx Join URL
+    #
     class GetjoinurlMeeting
       include WebexXmlApi::Common
 
+      # XML Request Type for the
+      # <tt>WebexXmlApi::Meeting::GetjoinurlMeeting</tt> service
       REQUEST_TYPE =
         'java:com.webex.service.binding.meeting.GetjoinurlMeeting'.freeze
+
+      # The session_key is required parameter for this service
       PARAMETER_MAPPING = {
         session_key: 'sessionKey'
       }.freeze
 
+      # Accessor methods for session_key property and security_context object
       attr_accessor :session_key, :security_context
+      # Reader methods for request and response objects
       attr_reader :request, :response
 
+      ##
+      # The +initialize+ method for newly created instance parsing provided
+      # parameters (if any). The +initialize+ method automaticaly creates
+      # new +SecurityContext+ instance and passes the attribes.
+      #
       def initialize(attributes = {})
         attributes.each_pair do |k, v|
           send("#{k}=", v) if PARAMETER_MAPPING.key?(k)
@@ -19,6 +34,11 @@ module WebexXmlApi
         @security_context ||= WebexXmlApi::SecurityContext.new(attributes)
       end
 
+      ##
+      # The +to_xml+ method returns XML representation of the
+      # <tt>WebexXmlApi::Meeting::GetjoinurlMeeting</tt> instance as understood
+      # by the WebEx XML Service.
+      #
       def to_xml
         raise WebexXmlApi::NotEnoughArguments,
               'Meeting::GetjoinurlMeeting' unless valid?
@@ -30,11 +50,19 @@ module WebexXmlApi
                            body_content)
       end
 
+      ##
+      # Returns true if required parameters provided, otherwise false.
+      #
       def valid?(context = self)
         return false if context.session_key.nil?
         true
       end
 
+      ##
+      # The +send_request+ method will issue the XML API request to WebEx,
+      # parse the results and return data if successful. Upon failure an
+      # exception is raised.
+      #
       def send_request
         @request = to_xml
         @response = post_webex_request(security_context.site_name, @request)

data/lib/webex_xml_api/security_context.rb

@@ -1,5 +1,10 @@
 module WebexXmlApi
+  ##
+  # SecurityContext class is shared among other API calls and is providing
+  # the WebEx XML API Service with user credentials for authentification.
+  #
   class SecurityContext
+    # Allowed parameters in the SecurityContext class.
     PARAMETER_MAPPING = {
       webex_id: 'webExID',
       password: 'password',
@@ -14,12 +19,20 @@ module WebexXmlApi
 
     PARAMETER_MAPPING.each_key { |k| attr_accessor k }
 
+    ##
+    # The +initialize+ method for newly created instance parsing provided
+    # parameters (if any).
+    #
     def initialize(attributes = {})
       attributes.each_pair do |k, v|
         send("#{k}=", v) if PARAMETER_MAPPING.key?(k)
       end
     end
 
+    ##
+    # The +to_xml+ method returns XML representation of the
+    # <tt>SecurityContext</tt> instance as understood by the WebEx XML Service.
+    #
     def to_xml
       raise WebexXmlApi::NotEnoughArguments, 'SecurityContext' unless valid?
       builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
@@ -34,6 +47,11 @@ module WebexXmlApi
       builder.to_xml.gsub("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n", '')
     end
 
+    ##
+    # Returns true if required parameters provided, otherwise false.
+    # Parameters :site_name and :webex_id are required.
+    # One of the parameters :password or :session_ticket are required too.
+    #
     def valid?(context = self)
       return false if context.site_name.nil? || context.webex_id.nil?
       return false if context.password.nil? && context.session_ticket.nil?

data/lib/webex_xml_api/user/get_user.rb

@@ -1,16 +1,33 @@
 module WebexXmlApi
+  ##
+  # The +User+ module of the API
+  #
   module User
+    ##
+    # The +GetUser+ Class queries WebEx API Service for given WebEx User ID
+    # and returns the details of the User configuration
+    #
     class GetUser
       include WebexXmlApi::Common
 
+      # XML Request Type for the <tt>WebexXmlApi::User::GetUser</tt> service
       REQUEST_TYPE = 'java:com.webex.service.binding.user.GetUser'.freeze
+
+      # The webex_id is required parameter for this service
       PARAMETER_MAPPING = {
         webex_id: 'webExId'
       }.freeze
 
+      # Accessor methods for the webex_id property and security_context object
       attr_accessor :webex_id, :security_context
+      # Reader methods for request and response objects
       attr_reader :request, :response
 
+      ##
+      # The +initialize+ method for newly created instance parsing provided
+      # parameters (if any). The +initialize+ method automaticaly creates
+      # new +SecurityContext+ instance and passes the attribes.
+      #
       def initialize(attributes = {})
         attributes.each_pair do |k, v|
           send("#{k}=", v) if PARAMETER_MAPPING.key?(k)
@@ -18,6 +35,11 @@ module WebexXmlApi
         @security_context ||= WebexXmlApi::SecurityContext.new(attributes)
       end
 
+      ##
+      # The +to_xml+ method returns XML representation of the
+      # <tt>WebexXmlApi::User::GetUser</tt> instance as understood by
+      # the WebEx XML Service.
+      #
       def to_xml
         raise WebexXmlApi::NotEnoughArguments, 'User::GetUser' unless valid?
         body_content = {}
@@ -28,11 +50,19 @@ module WebexXmlApi
                            body_content)
       end
 
+      ##
+      # Returns true if required parameters provided, otherwise false.
+      #
       def valid?(context = self)
         return false if context.webex_id.nil?
         true
       end
 
+      ##
+      # The +send_request+ method will issue the XML API request to WebEx,
+      # parse the results and return data if successful. Upon failure an
+      # exception is raised.
+      #
       def send_request
         @request = to_xml
         @response = post_webex_request(security_context.site_name, @request)

data/lib/webex_xml_api/version.rb

@@ -1,3 +1,7 @@
+##
+# The +WebexXmlApi+ moduke
+#
 module WebexXmlApi
-  VERSION = '0.1.0'.freeze
+  # Gem vesion
+  VERSION = '0.1.1'.freeze
 end

data/spec/webex_xml_api/meeting/create_meeting_spec.rb

@@ -109,6 +109,7 @@ describe WebexXmlApi::Meeting::CreateMeeting do
       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)
+      expect(sm.enable_attendee_list = 'tst').to eql(sm.enable_attendee_list)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webex_xml_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Erol Zavidic
@@ -30,7 +30,7 @@ cert_chain:
   IDTbBxqvlx+U6M7GX9uKycRxR3P7dvOQ30p888C7crtRRmxvBl2wE/fmHiK4gQ17
   NREDtx+Bo3lOQwgUmOzofKQbE/vo0DRKogbZiCj30IY=
   -----END CERTIFICATE-----
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty