developergarden_sdk 0.0.8.1 → 0.9.0

data/lib/conference_call_service/new_participant_response.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class NewParticipantResponse < BasicResponse
+    
+    attr_accessor :participant_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
+      @participant_id = ConferenceCallService.xpath_query(doc, "participantId").to_s
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/participant.rb

@@ -0,0 +1,28 @@
+module ConferenceCallService
+  class Participant
+    attr_accessor :id, :details, :status
+
+    # Constructor
+    def initialize(id, details, status)
+      @id = id
+      @details = details
+      @status = status
+    end
+
+    def to_s
+      "Participant - id:#{@id.to_s} details:#{@details.to_s}, status:#{@status.to_s}"
+    end
+
+    #### Static methods
+
+    def self.build_from_xml(xml_doc)
+      if xml_doc then
+        id = ConferenceCallService.xpath_query(xml_doc, "participantId").to_s
+        details = ParticipantDetails.build_from_xml( ConferenceCallService.xpath_query(xml_doc, "detail") )
+        status = { :muted => ConferenceCallService.xpath_query(xml_doc, "status/value").to_s }
+
+        new(id, details, status)
+      end
+    end
+  end
+end

data/lib/conference_call_service/participant_details.rb

@@ -0,0 +1,59 @@
+module ConferenceCallService
+  class ParticipantDetails
+    attr_accessor :firstname, :lastname, :number, :email, :flags
+
+    @@IS_INITIATOR = 1
+    @@IS_NOT_INITIATOR = 0
+
+    # Constructor
+    def initialize(firstname, lastname, number, email, flags = @@IS_NOT_INITIATOR)
+      @firstname = firstname
+      @lastname = lastname
+      @number = number
+      @email = email
+      @flags = flags
+    end
+
+    def to_s
+      "#{@firstname.to_s} #{@lastname.to_s}, #{@number.to_s}, #{@email.to_s}, #{@flags.to_s}. "
+    end
+
+    # Adds all participant details to the given xml_doc object.
+    # === Parameters
+    # <tt>xml_doc</tt>:: An XmlMason object as given by a handsoap method invokation.
+    def add_to_handsoap_xml(xml_doc)
+      xml_doc.add('firstName', @firstname.to_s)
+      xml_doc.add('lastName', @lastname.to_s)
+      xml_doc.add('number', @number.to_s)
+      xml_doc.add('email', @email.to_s)
+      xml_doc.add('flags', @flags.to_s)
+    end
+
+    #### Static methods
+
+    def self.IS_INITIATOR
+      @@IS_INITIATOR
+    end
+
+    def self.IS_NOT_INITIATOR
+      @@IS_NOT_INITIATOR
+    end
+
+    def self.build_from_xml(xml_doc)
+
+      # Depending on the answer there might be a nil object, a NodeSelection or a NokogiriDriver.
+      # For the parsing a NodeSelection and a NokogiriDriver behave similar but in order to prevent further nil errors
+      # we have to see whether the elment is really present. For a nodeselection this is done by using .size > 0
+      # which won't work for the nokogiri driver. Maybe handsoap will clean this up in future releases.
+      if xml_doc && ( (xml_doc.is_a?(Handsoap::XmlQueryFront::NodeSelection) && xml_doc.size > 0) || xml_doc.is_a?(Handsoap::XmlQueryFront::NokogiriDriver ) ) then
+        
+        firstname  = ConferenceCallService.xpath_query(xml_doc, "firstName").to_s
+        lastname   = ConferenceCallService.xpath_query(xml_doc, "lastName").to_s
+        number     = ConferenceCallService.xpath_query(xml_doc, "number").to_s
+        email      = ConferenceCallService.xpath_query(xml_doc, "email").to_s
+        flags      = ConferenceCallService.xpath_query(xml_doc, "flags").to_s
+        new(firstname, lastname, number, email , flags)
+      end
+    end
+  end
+end

data/lib/conference_call_service/remove_conference_response.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+
+module ConferenceCallService
+  class RemoveConferenceResponse < BasicResponse
+    # 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
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/remove_conference_template_participant_response.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class RemoveConferenceTemplateParticipantResponse < BasicResponse
+
+    # 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
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/remove_conference_template_response.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class RemoveConferenceTemplateResponse < 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, "template").to_s
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/remove_participant_response.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class RemoveParticipantResponse < BasicResponse    
+
+    # 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
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/update_conference_response.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class UpdateConferenceResponse < BasicResponse
+
+    # 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
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/update_conference_template_participant_response.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class UpdateConferenceTemplateParticipantResponse < BasicResponse
+
+    # 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
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/update_conference_template_response.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class UpdateConferenceTemplateResponse < BasicResponse
+
+    # 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
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/conference_call_service/update_participant_response.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module ConferenceCallService
+  class UpdateParticipantResponse < BasicResponse
+
+    # 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
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+  end
+end

data/lib/ip_location_service/ip_address.rb

@@ -0,0 +1,50 @@
+module IpLocationService
+
+  # Represents an ip address to be passed to the LocateIp-Operation of the IpLocation-Service.
+  class IpAddress
+
+    @@IP_V4 = 4
+    @@IP_V6 = 6
+
+    attr_accessor :ip_address, :ip_type
+
+    # === Parameters
+    # <tt>ip_address</tt>::
+    # <tt>ip_type</tt>:: IP version of the given address. Valid options are :ipv4 and ipv6. Currently only :ipv4 is supported.    
+    def initialize(ip_address, ip_type = @@IP_V4)
+      @ip_address = ip_address
+      @ip_type = ip_type
+    end
+
+    def to_s
+      @ip_address.to_s
+    end
+
+    #### Class methods
+
+    def self.IP_V4
+      @@IP_V4
+    end
+
+    def self.IP_V6
+      @@IP_V6
+    end
+
+    protected
+
+    # === Parameters
+    # <tt>ip_address</tt>:: ip_address as string or IpAddress object.
+    def self.build_from_ip_address(from_ip_address)
+      ret = nil
+      if from_ip_address.is_a?(String)
+        ret = new(from_ip_address)
+      elsif from_ip_address.is_a?(IpAddress)
+        ret = from_ip_address.dup
+      else        
+        raise("Unknown class #{from_ip_address.class.to_s} for ip address. Can be string or IpAddress.")
+      end
+      
+      return ret
+    end
+  end
+end

data/lib/ip_location_service/ip_address_location.rb

@@ -0,0 +1,50 @@
+module IpLocationService
+  class IpAddressLocation
+
+    attr_accessor :address, :ip_type, :is_in_region, :is_in_city, :is_in_geo, :radius
+
+    def initialize
+      @address      = nil
+      @ip_type      = nil
+      @is_in_region = nil
+      @is_in_city   = nil
+      @is_in_geo    = nil
+      @radius       = nil
+    end
+
+    def to_s
+      ret = "Address: #{@address.to_s}, IP-Type: #{@ip_type.to_s}, #{@is_in_region.to_s}, "
+      ret += "City: #{@is_in_city.to_s}, Geo: #{@is_in_geo.to_s}, Radius: #{@radius.to_s}"
+      ret
+    end
+
+    #### Static methods
+
+    # Builds an IpAddressLocation object from a given
+    # xml document.
+    # === Parameter
+    # <tt>xml_doc</tt>:: XmlQueryFront object as received from a prior query of handsoap's service response.
+    def self.build_from_xml(xml_doc)
+      ipa = IpAddressLocation.new
+
+      if xml_doc then
+
+        # We are passing "false" do search relative to the xml_doc position. Without this flag the resulting
+        # xpath query would beginn with a "//" which would always look the search term relative from the beginning
+        # of the document. This is not what we want right here. We would rather like to search relative to the
+        # partial tree we have with xml_doc pointing to the IpAddressLocation tag of the response xml.
+        # This is also true for Region's build method.
+        ipa.address       = IpLocationService.xpath_query(xml_doc, "ipAddress", false).to_s        
+        ipa.ip_type       = IpLocationService.xpath_query(xml_doc, "ipType", false).to_s
+
+        # TODO As soon as the API supports them.
+        # ipa.radius        = IpLocationService.xpath_query(xml_doc, "radius", false).to_s
+        # ... isInGeo, isInCity
+        
+        region_xml_doc    = IpLocationService.xpath_query(xml_doc, "isInRegion", false)        
+        ipa.is_in_region  = Region.build_from_xml(region_xml_doc)
+      end
+      return ipa
+    end
+  end
+end

data/lib/ip_location_service/ip_location_response.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module IpLocationService
+  class IpLocationResponse < BasicResponse
+    attr_accessor :ip_address_locations
+
+    # Constructor.
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by a <tt>ip_location</tt>-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     = IpLocationService.xpath_query(doc, "statusCode").to_s
+      @error_message  = IpLocationService.xpath_query(doc, "statusMessage").to_s
+      @ip_address_locations = []
+
+      ip_address_location_doc = IpLocationService.xpath_query(doc, "ipAddressLocation")
+
+      ip_address_location_doc.each do |ip_address_location|                
+        @ip_address_locations << IpAddressLocation.build_from_xml(ip_address_location)
+      end
+
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+
+    # Alias for accessing the first element of the ip_address_location array.
+    def ip_address_location
+      @ip_address_locations.first
+    end
+
+    # Alias for accessing the first element of the ip_address_location array.
+    def ip_address_location=(location)
+      @ip_address_locations[0] = location
+    end
+
+    def to_s
+      ret = "Status: #{@error_code}, Message: #{@error_message}\nLocations:\n"
+      @ip_address_locations.each do |ipl|
+        ret += "\t#{ipl}\n"
+      end
+      ret
+    end
+
+  end
+end

data/lib/ip_location_service/ip_location_service.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/../authenticated_service'
+require File.dirname(__FILE__) + '/ip_address'
+require File.dirname(__FILE__) + '/ip_location_response'
+require File.dirname(__FILE__) + '/ip_address_location'
+require File.dirname(__FILE__) + '/region'
+
+Handsoap.http_driver = :httpclient
+
+# Print http and soap requests and reponses if ruby has been started with -d option.
+Handsoap::Service.logger = $stdout if $DEBUG
+
+module IpLocationService
+
+  # Client to access the developer garden ip location service.
+  #
+  # See also:
+  # * https://www.developergarden.com/openapi/iplocation
+  # * http://www.developergarden.com/static/docu/de/ch04s02s06.html
+  class IpLocationService < AuthenticatedService
+
+    @@IP_LOCATION_SCHEMA = 'http://iplocation.developer.telekom.com/schema/'
+
+    @@IP_LOCATION_SERVICE_ENDPOINT = {
+            :uri => "https://gateway.developer.telekom.com/p3gw-mod-odg-iplocation/services/IPLocation",
+            :version => 1
+    }
+
+    endpoint @@IP_LOCATION_SERVICE_ENDPOINT
+
+    # Retrieves spatial information about the given ip address.
+    # ===Parameters
+    # <tt>ip_address</tt>:: IpAddress-object or array of IpAddress-objects for which to perform an ip location. Can be a single ip address or an array.
+    #                       of ip addresses.
+    # <tt>environment</tt>:: Service environment as defined in ServiceLevel.
+    # <tt>account</tt>:: IP address for which to perform an ip location.
+    def locate_ip(ip_addresses, environment = ServiceEnvironment.MOCK, account = nil)
+      ip_location_response = nil
+
+      response = invoke_authenticated("locateIP") do |request, doc|
+        request.add('environment', environment)
+
+        # If only a single ip has been passed create an array from it to have a more uniform processing afterwards.
+        ip_addresses = [ip_addresses] unless ip_addresses.is_a?(Array)
+
+        ip_addresses.each do |ip_address|
+
+          # If there are string ips convert them to IpAddress objects.
+          ip_address = IpAddress.new(ip_address) if ip_address.is_a?(String)
+
+          request.add('address') do |address|
+            address.add('ipType', ip_address.ip_type)
+            address.add('ipAddress', ip_address.ip_address)
+          end
+        end
+        request.add('account', account) if (account && !account.empty?)
+      end
+
+      ip_location_response = IpLocationResponse.new(response)
+
+      return ip_location_response
+    end
+
+    #### Static Methods
+
+    def self.IP_LOCATON_SCHEMA
+      return @@IP_LOCATON_SCHEMA
+    end
+
+
+    # Performs a xpath query in the ip location namespace for the given document and query string.
+    # === Parameters
+    # <tt>doc</tt>:: XmlQueryFront document.
+    # <tt>query_string</tt>:: Element to look for
+    # <tt>global_search</tt>:: Searches within all levels using "//" if <tt>global_search = true</tt>.
+    def self.xpath_query(doc, query_string, global_search = true)
+      self.xpath_query_for_schema(@@IP_LOCATION_SCHEMA, doc, query_string, global_search)
+    end
+  end
+end