developergarden_sdk 0.0.8.1 → 0.9.0

data/lib/conference_call_service/conference_constants.rb

@@ -0,0 +1,70 @@
+module ConferenceCallService
+  class ConferenceConstants
+
+    # Conference Status.
+    @@STATUS_ALL = 0
+    
+    # Conference Status.
+    @@STATUS_DETAIL = 1
+
+    # Conference Status.
+    @@STATUS_PARTICIPANTS = 2
+
+    # Conference Status.
+    @@STATUS_SCHEDULE = 3
+
+    # Conference Participant Action constant.
+    @@ACTION_MUTE = 1
+
+    # Conference Participant Action constant.
+    @@ACTION_UNMUTE = 0
+
+    # Conference Participant Action constant.
+    @@ACTION_REDIAL = 2
+
+    # Conference list constant.
+    @@CONFERENCE_LIST_ALL = 0
+
+    # Conference list constant.
+    @@CONFERENCE_LIST_ADHOC = 1
+
+    # Conference list constant.
+    @@CONFERENCE_LIST_SCHEDULE = 2
+
+    def self.STATUS_ALL
+      @@STATUS_ALL
+    end
+
+    def self.STATUS_DETAIL
+      @@STATUS_DETAIL
+    end
+
+    def self.STATUS_PARTICIPANTS
+      @@STATUS_PARTICIPANTS
+    end
+
+    def self.STATUS_SCHEDULE
+      @@STATUS_SCHEDULE
+    end
+
+    def self.ACTION_MUTE
+      @@ACTION_MUTE
+    end
+
+    def self.ACTION_UNMUTE    
+      @@ACTION_UNMUTE
+    end
+
+    def self.CONFERENCE_LIST_ALL
+      @@CONFERENCE_LIST_ALL
+    end
+
+    def self.CONFERENCE_LIST_ADHOC
+      @@CONFERENCE_LIST_ADHOC
+    end
+
+    def self.CONFERENCE_LIST_SCHEDULE
+      @@CONFERENCE_LIST_SCHEDULE
+    end
+  end
+end

data/lib/conference_call_service/conference_details.rb

@@ -0,0 +1,36 @@
+module ConferenceCallService
+
+
+  class ConferenceDetails
+    attr_accessor :name, :description, :duration
+
+    # Constructor
+    def initialize(name, description, duration)
+      @name = name
+      @description = description
+      @duration = duration
+    end
+
+    def to_s
+      "#{@name.to_s} - #{@description.to_s}: #{@duration.to_s}"
+    end
+
+    def add_to_handsoap_xml(xml_doc)
+      xml_doc.add('name', @name.to_s)
+      xml_doc.add('description', @description.to_s)
+      xml_doc.add('duration', @duration.to_s)
+    end
+
+    #### Static methods
+
+    def self.build_from_xml(xml_doc)
+      if xml_doc then        
+        name = ConferenceCallService.xpath_query(xml_doc, "name").to_s
+        description = ConferenceCallService.xpath_query(xml_doc, "description").to_s
+        duration = ConferenceCallService.xpath_query(xml_doc, "duration").to_s
+
+        new(name, description, duration)
+      end
+    end
+  end
+end

data/lib/conference_call_service/conference_schedule.rb

@@ -0,0 +1,73 @@
+module ConferenceCallService
+
+  # Indicates when to start a conference call.
+  # Be ware that times are are relative to the UTC timezone.
+  class ConferenceSchedule
+    attr_accessor :minute, :hour, :day_of_month, :month, :year, :recurring, :notify
+
+    @@RECURRING_NONE = 0
+    @@RECURRING_HOURLY = 1
+    @@RECURRING_DAILY = 2
+    @@RECURRING_WEEKLY = 3
+    @@RECURRING_MONTHLY = 4
+
+    # Constructor
+    def initialize(minute = Time.now.min, hour = Time.now.hour, day_of_month = Time.now.day, month = Time.now.month, year = Time.now.year, recurring = @@RECURRING_NONE, notify = 0)
+      @minute = minute
+      @hour = hour
+      @day_of_month = day_of_month
+      @month = month
+      @year = year
+      @recurring = recurring
+      @notify = notify
+    end
+
+    def to_s
+      ret = "#{year}-#{month}-#{day_of_month} #{hour}:#{minute} Recurring: #{recurring}, Notify: #{notify}\n"
+      ret
+    end
+
+    def add_to_handsoap_xml(xml_doc)
+      xml_doc.add('minute', @minute.to_s)
+      xml_doc.add('hour', @hour.to_s)
+      xml_doc.add('dayOfMonth', @day_of_month.to_s)
+      xml_doc.add('month', @month.to_s)
+      xml_doc.add('year', @year.to_s)
+      xml_doc.add('recurring', @recurring.to_s)
+      xml_doc.add('notify', @notify.to_s)
+    end
+
+    #### Static methods
+
+    def self.build_from_xml(xml_doc)
+
+      # If the service responds with non-0000 answer there might me no schedule infos available
+      if xml_doc then
+        minute = ConferenceCallService.xpath_query(xml_doc, "minute").to_s
+        hour = ConferenceCallService.xpath_query(xml_doc, "hour").to_s
+        day_of_month = ConferenceCallService.xpath_query(xml_doc, "dayOfMonth").to_s
+        month = ConferenceCallService.xpath_query(xml_doc, "month").to_s
+        year = ConferenceCallService.xpath_query(xml_doc, "year").to_s
+        recurring = ConferenceCallService.xpath_query(xml_doc, "recurring").to_s
+        notify = ConferenceCallService.xpath_query(xml_doc, "notify").to_s
+        new(minute, hour, day_of_month, month, year, recurring, notify)
+      end
+    end
+
+    def self.RECURRING_NONE
+      @@RECURRING_NONE
+    end
+
+    def self.RECURRING_HOURLY
+      @@RECURRING_HOURLY
+    end
+
+    def self.RECURRING_WEEKLY
+      @@RECURRING_WEEKLY
+    end
+
+    def self.RECURRING_MONTHLY
+      @@RECURRING_MONTHLY
+    end
+  end
+end

data/lib/conference_call_service/create_conference_response.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class CreateConferenceResponse < BasicResponse
+
+    attr_accessor :conference_id
+
+    # Constructor.
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by the corresponding method call.
+    # <tt>raise_exception_on_error</tt>:: Raise an exception if an error occurs or not?
+    def initialize(response_xml, raise_exception_on_error = true)      
+      doc = response_xml.document
+      @error_code = ConferenceCallService.xpath_query(doc, "statusCode").to_s
+      @error_message = ConferenceCallService.xpath_query(doc, "statusMessage").to_s
+      @conference_id = ConferenceCallService.xpath_query(doc, "conferenceId").to_s
+      raise_on_error(response_xml) if raise_exception_on_error
+    end    
+  end
+end

data/lib/conference_call_service/create_conference_template_response.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class CreateConferenceTemplateResponse < BasicResponse
+    attr_accessor :template_id
+
+    # Constructor.
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by the corresponding method call.
+    # <tt>raise_exception_on_error</tt>:: Raise an exception if an error occurs or not?
+    def initialize(response_xml, raise_exception_on_error = true)
+
+      doc = response_xml.document
+
+      @error_code = ConferenceCallService.xpath_query(doc, "statusCode").to_s
+      @error_message = ConferenceCallService.xpath_query(doc, "statusMessage").to_s
+      @template_id = ConferenceCallService.xpath_query(doc, "templateId").to_s
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/get_conference_list_response.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class GetConferenceListResponse < BasicResponse
+
+    attr_accessor :conference_ids
+
+    # Constructor.
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by the corresponding method call.
+    # <tt>raise_exception_on_error</tt>:: Raise an exception if an error occurs or not?
+    def initialize(response_xml, raise_exception_on_error = true)
+
+      @conference_ids = []
+      doc = response_xml.document
+
+      @error_code = ConferenceCallService.xpath_query(doc, "statusCode").to_s
+      @error_message = ConferenceCallService.xpath_query(doc, "statusMessage").to_s
+
+      ConferenceCallService.xpath_query(doc, "conferenceIds").each do |conference_id_xml|
+        @conference_ids << conference_id_xml.to_s        
+      end
+
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+
+    def to_s
+      ret = "#{@error_code.to_s}: #{@error_message.to_s}\n"
+      ret += "Conference ids:\n"
+      @conference_ids.each do |conference_id|
+        ret += "\t#{conference_id.to_s}\n"
+      end
+      ret
+    end
+  end
+end

data/lib/conference_call_service/get_conference_status_response.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class GetConferenceStatusResponse < BasicResponse
+
+    attr_accessor :details, :schedule, :participants, :start_time, :acc
+
+    # Constructor.
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by the corresponding method call.
+    # <tt>raise_exception_on_error</tt>:: Raise an exception if an error occurs or not?
+    def initialize(response_xml, raise_exception_on_error = true)
+
+      @conference_ids = []
+      @participants   = []
+
+      doc = response_xml.document
+
+      @error_code     = ConferenceCallService.xpath_query(doc, "statusCode").to_s
+      @error_message  = ConferenceCallService.xpath_query(doc, "statusMessage").to_s
+
+      @details        = ConferenceDetails.build_from_xml(ConferenceCallService.xpath_query(doc, "detail"))
+      @schedule       = ConferenceSchedule.build_from_xml(ConferenceCallService.xpath_query(doc, "schedule"))
+
+      participants_xml = ConferenceCallService.xpath_query(doc, "participants")
+      participants_xml.each do |participant_xml|
+        @participants << Participant.build_from_xml(participant_xml)
+      end
+
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+
+    def to_s
+      ret = "#{@error_code}: #{@error_message}\n"
+      ret += "\t" + details.to_s + "\n" if details
+      ret += "\t" + schedule.to_s + "\n" if schedule
+      @participants.each do |participant|
+        ret += "\t" + participant.to_s + "\n"
+      end
+      ret
+    end
+  end
+end

data/lib/conference_call_service/get_conference_template_list_response.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class GetConferenceTemplateListResponse < BasicResponse
+
+    attr_accessor :template_ids
+
+    # Constructor.
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by the corresponding method call.
+    # <tt>raise_exception_on_error</tt>:: Raise an exception if an error occurs or not?
+    def initialize(response_xml, raise_exception_on_error = true)
+
+      @template_ids = []
+      doc = response_xml.document
+
+      @error_code = ConferenceCallService.xpath_query(doc, "statusCode").to_s
+      @error_message = ConferenceCallService.xpath_query(doc, "statusMessage").to_s
+
+      ConferenceCallService.xpath_query(doc, "templateIds").each do |template_id_xml|
+        @template_ids << template_id_xml.to_s
+      end
+
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+
+    def to_s
+      ret = "#{@error_code.to_s}: #{@error_message.to_s}\n"
+      ret += "Template ids:\n"
+      @template_ids.each do |template_id|
+        ret += "\t#{template_id.to_s}\n"
+      end
+      ret
+    end
+  end
+end

data/lib/conference_call_service/get_conference_template_participant_response.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class GetConferenceTemplateParticipantResponse < BasicResponse
+    attr_accessor :participant
+    # Constructor
+    
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by the corresponding method call.
+    # <tt>raise_exception_on_error</tt>:: Raise an exception if an error occurs or not?
+    def initialize(response_xml, raise_exception_on_error = true)
+      doc = response_xml.document
+      @error_code =     ConferenceCallService.xpath_query(doc, "statusCode").to_s
+      @error_message =  ConferenceCallService.xpath_query(doc, "statusMessage").to_s
+      @participant =    ParticipantDetails.build_from_xml(ConferenceCallService.xpath_query(doc, "participant"))
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/get_conference_template_response.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class GetConferenceTemplateResponse < BasicResponse
+    attr_accessor :details, :participants
+
+    # Constructor.
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by the corresponding method call.
+    # <tt>raise_exception_on_error</tt>:: Raise an exception if an error occurs or not?
+    def initialize(response_xml, raise_exception_on_error = true)
+      @participants = []
+      doc = response_xml.document
+      @error_code = ConferenceCallService.xpath_query(doc, "statusCode").to_s
+      @error_message = ConferenceCallService.xpath_query(doc, "statusMessage").to_s
+
+      participants_xml = ConferenceCallService.xpath_query(doc, "participants")
+      if participants_xml then
+        participants_xml.each do |participant_xml|
+          @participants << ParticipantDetails.build_from_xml(participant_xml)
+        end
+      end
+      @details  = ConferenceDetails.build_from_xml(ConferenceCallService.xpath_query(doc, "detail"))      
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/get_participant_status_response.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class GetParticipantStatusResponse < BasicResponse
+
+    attr_accessor :status
+
+    # Constructor.
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by the corresponding method call.
+    # <tt>raise_exception_on_error</tt>:: Raise an exception if an error occurs or not?
+    def initialize(response_xml, raise_exception_on_error = true)
+      doc = response_xml.document
+      @status = {}
+      @error_code = ConferenceCallService.xpath_query(doc, "statusCode").to_s
+      @error_message = ConferenceCallService.xpath_query(doc, "statusMessage").to_s
+
+      status_xml = ConferenceCallService.xpath_query(doc, "status")
+      if status_xml then
+        status_xml.each do |one_status_xml|
+          name = ConferenceCallService.xpath_query(one_status_xml, "name", false).to_s
+          value = ConferenceCallService.xpath_query(one_status_xml, "value", false).to_s
+          @status[name] = value 
+        end                  
+      end
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/get_running_conference_response.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class GetRunningConferenceResponse < BasicResponse
+    attr_accessor :conference_id
+
+    # Constructor.
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by the corresponding method call.
+    # <tt>raise_exception_on_error</tt>:: Raise an exception if an error occurs or not?
+    def initialize(response_xml, raise_exception_on_error = true)
+
+      @conference_ids = []
+      doc = response_xml.document
+
+      @error_code      = ConferenceCallService.xpath_query(doc, "statusCode").to_s
+      @error_message   = ConferenceCallService.xpath_query(doc, "statusMessage").to_s
+      @conference_id   = ConferenceCallService.xpath_query(doc, "conferenceId").to_s
+
+      raise_on_error(response_xml) if raise_exception_on_error
+
+    end
+    
+  end
+end