developergarden_sdk 0.0.8.1 → 0.9.0

data/lib/ip_location_service/region.rb

@@ -0,0 +1,23 @@
+module IpLocationService
+
+  # Represents a region as used within the IpAddressLocation class in the context of the IpLocationService.
+  class Region
+    attr_accessor :country_code, :region_code, :region_name
+
+    def to_s
+      "Region: #{@country_code.to_s}, #{@region_code.to_s}, #{@region_name.to_s}"
+    end
+
+    #### Static methods
+
+    def self.build_from_xml(xml_doc)
+      region = Region.new      
+      if xml_doc && xml_doc.size > 0 then       
+        region.country_code = IpLocationService.xpath_query(xml_doc, "countryCode", false).to_s
+        region.region_code  = IpLocationService.xpath_query(xml_doc, "regionCode", false).to_s
+        region.region_name  = IpLocationService.xpath_query(xml_doc, "regionName", false).to_s
+      end      
+      return region
+    end
+  end
+end

data/lib/local_search_service/local_search_response.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../basic_response'
+
+module LocalSearchService
+  class LocalSearchResponse < BasicResponse
+
+    attr_accessor :search_result
+
+    # Constructor.
+    # ===Parameters
+    # <tt>response_xml</tt>:: Xml as returned by a <tt>ip_location</tt>-method call.
+    # <tt>raise_exception_on_error</tt>:: Xml as returned by a <tt>call_status</tt>-method call.
+    #
+    def initialize(response_xml, raise_exception_on_error = true)
+
+      doc = response_xml.document
+
+      @error_code           = LocalSearchService.xpath_query(doc, "statusCode").to_s
+      @error_message        = LocalSearchService.xpath_query(doc, "statusMessage").to_s
+
+      #TODO
+      @search_result        = LocalSearchService.xpath_query(doc, "searchResult/RESULTS")
+    
+      raise_on_error(response_xml) if raise_exception_on_error
+    end
+
+    def to_s
+      "#{@error_code.to_s}: #{@error_message.to_s}: #{@search_result.to_s}"
+    end
+  end
+end

data/lib/local_search_service/local_search_service.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/../authenticated_service'
+require File.dirname(__FILE__) + '/local_search_response'
+
+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 LocalSearchService
+  
+
+  # Client to access the developer garden ip location service.
+  #
+  # See also:
+  # * https://www.developergarden.com/openapi/localsearch
+  # * http://www.developergarden.com/static/docu/de/ch04s02s06.html
+  class LocalSearchService < AuthenticatedService
+
+    @@LOCAL_SEARCH_SCHEMA = 'http://localsearch.developer.telekom.com/schema/'
+
+    @@LOCAL_SEARCH_SCHEMA_SERVICE_ENDPOINT = {
+            :uri => "https://gateway.developer.telekom.com/p3gw-mod-odg-localsearch/services/localsearch",
+            :version => 1
+    }
+
+    endpoint @@LOCAL_SEARCH_SCHEMA_SERVICE_ENDPOINT
+
+
+    def on_create_document(doc)
+      super(doc)
+      doc.alias 'local', @@LOCAL_SEARCH_SCHEMA
+    end
+
+
+    # Retrieves spatial information about the given ip address.
+    # === Parameters
+    # <tt>search_parameters</tt>:: Search parameter hash specifying the terms and options to perform the search.
+    #                              Have a look at the developer garden service documentation for more details about
+    #                              valid parameters and their behavior.
+    # <tt>environment</tt>:: Service environment as defined in ServiceLevel.
+    # === Returns
+    # A LocalSearchResponse object.
+    # This object has a <tt>search_result</tt>-method which returns an <tt>Handsoap::XmlQueryFront::NodeSelection</tt>
+    # object. NodeSelection is basically part of Handsoap's XmlQueryFront, a concept to abstract from the underlying
+    # xml parser which is currently nokogiri, by default.
+    # Have a closer look at the Handsoap-Framework at github (http://github.com/unwire/handsoap/) to get
+    # more details about this. Don't hestitate to clone the project and have a look at its source code. It's not
+    # too much code and is fairly easy to read.
+    # For more information about the xml structure of the response object please refer to the Developergarden documentation.
+    #
+    # The tests of this gem also show some basic examples on how to parse a LocalSearchResult.
+    def local_search(search_parameter = { :what => "test" }, environment = ServiceEnvironment.MOCK)
+      response = nil
+
+      response = invoke_authenticated("local:LocalSearchRequest") do |request, doc|
+        request.add('environment', environment)
+
+        search_parameter.each_pair do |param, value|
+          request.add('searchParameters') do |params|
+            unless value.nil? then
+              params.add("parameter", param.to_s)
+              params.add("value", value.to_s)
+            end
+          end
+        end
+      end
+
+      puts response.to_xml
+
+      response = LocalSearchResponse.new(response)
+
+      return response
+    end
+
+    #### Static Methods
+
+    def self.LOCAL_SEARCH_SCHEMA
+      return @@LOCAL_SEARCH_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(@@LOCAL_SEARCH_SCHEMA, doc, query_string, global_search)
+    end
+  end
+end

data/lib/quota_service/quota_information.rb

@@ -14,9 +14,9 @@ module QuotaService
       super(response_xml)
 
       doc = response_xml.document
-      @max_quota       = doc.xpath("//maxQuota").text
-      @max_user_quota  = doc.xpath("//maxUserQuota").text
-      @quota_level     = doc.xpath("//quotaLevel").text
+      @max_quota       = doc.xpath("//maxQuota").to_s
+      @max_user_quota  = doc.xpath("//maxUserQuota").to_s
+      @quota_level     = doc.xpath("//quotaLevel").to_s
 
       raise_on_error(response_xml) if raise_exception_on_error
     end

data/lib/service_environment.rb

@@ -10,7 +10,6 @@ class ServiceEnvironment
 
   # Sandbox environment constant
   def self.SANDBOX
-
     @@SANDBOX     = 2
   end
 

data/lib/service_exception.rb

@@ -4,5 +4,5 @@ class ServiceException < Exception
 
   def initialize(response)
     @response = response
-  end 
+  end  
 end

data/lib/sms_service/sms_response.rb

@@ -10,8 +10,8 @@ class SmsResponse < BasicResponse
   def initialize(response_xml, raise_exception_on_error = true)
     doc = response_xml.document
 
-    @error_code      = doc.xpath("//status").text
-    @error_message   = doc.xpath("//description").text
+    @error_code      = doc.xpath("//status").to_s
+    @error_message   = doc.xpath("//description").to_s
 
     raise_on_error(response_xml) if raise_exception_on_error
   end

data/lib/sms_service/sms_service.rb

@@ -68,19 +68,16 @@ module SmsService
       originator = originator[0, 11]
 
       response = invoke_authenticated(action_name) do |message, doc|
-        message.add("request")
-        request = message.find("request")
-        request.add('environment', environment)
-        request.add('number', numbers)
-        request.add('message', sms_message)
-        request.add('originator', originator)
-        request.add('account', account)
+        message.add("request") do |request|
+          request.add('environment', environment)
+          request.add('number', numbers)
+          request.add('message', sms_message)
+          request.add('originator', originator)
+          request.add('account', account)
+        end
       end
 
       return SmsResponse.new(response)
     end
-
-
   end
-
 end

data/lib/token_service/token_service.rb

@@ -52,7 +52,7 @@ module TokenService
         build_login_header(doc)
       end
 
-      intermediate_token = get_token_data_from_response(response)
+      intermediate_token = parse_token_data(response)
 
       return intermediate_token
     end
@@ -105,7 +105,7 @@ module TokenService
         message.add('ns1:serviceId', @@SERVICE_ID)
       end
 
-      security_token = get_token_data_from_response(response)
+      security_token = parse_token_data(response)
 
       return security_token
     end
@@ -120,22 +120,21 @@ module TokenService
     def build_login_header(doc)
 
       # Get the header element
-      header = build_security_header_common(doc)
-
-      security = header.find('Security')
-      security.add("UsernameToken")
-
-      # Create username section
-      username_token = security.find("UsernameToken")
-      username_token.add("Username")
-      username = username_token.find("Username")
-      username.set_value(@username)
-
-      # Create password section
-      username_token.add("Password")
-      password = username_token.find("Password")
-      password.set_attr("Type", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText")
-      password.set_value(@password)
+      header = build_security_header_common(doc) do |security|
+        security.add("UsernameToken") do |username_token|
+
+          # Create username section
+          username_token.add("Username") do |username|
+            username.set_value(@username)
+          end
+
+          # Create password section
+          username_token.add("Password") do |password|
+            password.set_attr("Type", "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText")
+            password.set_value(@password)
+          end
+        end
+      end
 
       return header
     end
@@ -151,12 +150,11 @@ module TokenService
     def build_get_tokens_header(doc, intermediate_token)
 
       # Get the header element
-      header = build_security_header_common(doc)
-      security = header.find("Security")
-      security.set_value( intermediate_token, :raw )
+      header = build_security_header_common(doc) do |security|
+        security.set_value( intermediate_token, :raw )
+      end
 
       return header
     end
-
   end
 end

data/lib/voice_call_service/call_status_response.rb

@@ -14,17 +14,17 @@ class CallStatusResponse < BasicResponse
   def initialize(response_xml, raise_exception_on_error = true)
     doc = response_xml.document
 
-    @error_code      = doc.xpath("//status").text
-    @error_message   = doc.xpath("//err_msg").text
-    @session_id      = doc.xpath("//sessionId").text
-    @connection_time_a = doc.xpath("//connectiontimea").text
-    @connection_time_b = doc.xpath("//connectiontimeb").text
-    @description_a = doc.xpath("//descriptiona").text
-    @description_b = doc.xpath("//descriptionb").text
-    @reason_a = doc.xpath("//reasona").text
-    @reason_b = doc.xpath("//reasonb").text
-    @state_a = doc.xpath("//statea").text
-    @state_b = doc.xpath("//stateb").text
+    @error_code      = doc.xpath("//status").to_s
+    @error_message   = doc.xpath("//err_msg").to_s
+    @session_id      = doc.xpath("//sessionId").to_s
+    @connection_time_a = doc.xpath("//connectiontimea").to_s
+    @connection_time_b = doc.xpath("//connectiontimeb").to_s
+    @description_a = doc.xpath("//descriptiona").to_s
+    @description_b = doc.xpath("//descriptionb").to_s
+    @reason_a = doc.xpath("//reasona").to_s
+    @reason_b = doc.xpath("//reasonb").to_s
+    @state_a = doc.xpath("//statea").to_s
+    @state_b = doc.xpath("//stateb").to_s
 
     raise_on_error(response_xml) if raise_exception_on_error
   end

data/lib/voice_call_service/voice_call_response.rb

@@ -13,9 +13,9 @@ class VoiceCallResponse < BasicResponse
   def initialize(response_xml, raise_exception_on_error = true)
     doc = response_xml.document
 
-    @error_code      = doc.xpath("//status").text
-    @error_message   = doc.xpath("//err_msg").text
-    @session_id      = doc.xpath("//sessionId").text
+    @error_code      = doc.xpath("//status").to_s
+    @error_message   = doc.xpath("//err_msg").to_s
+    @session_id      = doc.xpath("//sessionId").to_s
     
     raise_on_error(response_xml) if raise_exception_on_error
   end

data/lib/voice_call_service/voice_call_service.rb

@@ -36,17 +36,17 @@ module VoiceCallService
     # <tt>account</tt>:: Currently unused
     def new_call(a_number, b_number, expiration, max_duration, environment = ServiceEnvironment.MOCK, privacy_a = false, privacy_b = false, greeter = "", account = "")
       response = invoke_authenticated("newCall") do |message, doc|
-        message.add("request")
-        request = message.find("request")
-        request.add('environment', environment)
-        request.add('aNumber', a_number)
-        request.add('bNumber', b_number)
-        request.add('privacyA', privacy_a.to_s)
-        request.add('privacyB', privacy_b.to_s)
-        request.add('expiration', expiration)
-        request.add('maxDuration', max_duration)
-        request.add('greeter', greeter)
-        request.add('account', account)
+        message.add("request") do |request|
+          request.add('environment', environment)
+          request.add('aNumber', a_number)
+          request.add('bNumber', b_number)
+          request.add('privacyA', privacy_a.to_s)
+          request.add('privacyB', privacy_b.to_s)
+          request.add('expiration', expiration)
+          request.add('maxDuration', max_duration)
+          request.add('greeter', greeter)
+          request.add('account', account)
+        end
       end
 
       return VoiceCallResponse.new(response)
@@ -59,11 +59,11 @@ module VoiceCallService
     # <tt>keep_alive</tt>:: Prevent an expiration of the call by calling <tt>call_status</tt> with <tt>keep_alive = 1</tt>.
     def call_status(session_id, environment = ServiceEnvironment.MOCK, keep_alive = 1)
       response = invoke_authenticated("callStatus") do |message, doc|
-        message.add("request")
-        request = message.find("request")
-        request.add('environment', environment)
-        request.add('keepAlive', keep_alive)
-        request.add('sessionId', session_id)
+        message.add("request") do |request|
+          request.add('environment', environment)
+          request.add('keepAlive', keep_alive)
+          request.add('sessionId', session_id)
+        end
       end
 
       return CallStatusResponse.new(response)
@@ -80,10 +80,10 @@ module VoiceCallService
         tdc = message.find("tearDownCall")
         tdc.set_attr("xmlns", "http://webservice.voicebutler.odg.tonline.de")
 
-        message.add("request")
-        request = message.find("request")
-        request.add('environment', environment)
-        request.add('sessionId', session_id)
+        message.add("request") do |request|
+          request.add('environment', environment)
+          request.add('sessionId', session_id)
+        end
       end
 
       return CallStatusResponse.new(response)
@@ -105,30 +105,30 @@ module VoiceCallService
     # <tt>account</tt>:: Currently unused.
     def new_call_sequenced(a_number, b_number, expiration, max_duration, environment = ServiceEnvironment.MOCK, privacy_a = false, privacy_b = false, max_wait = 60, greeter = "", account = "")
       response = invoke_authenticated("newCallSequenced") do |message, doc|
-        message.add("request")
-        request = message.find("request")
-        request.add('environment', environment)
-        request.add('aNumber', a_number)
-
-        # b_number can be an array of strings representing numbers or a single string representing a single number.
-        if b_number.is_a? Array then
-          # It's an array
-          for bn in b_number do
-            request.add('bNumber', bn)
+        message.add("request") do |request|
+          request.add('environment', environment)
+          request.add('aNumber', a_number)
+
+          # b_number can be an array of strings representing numbers or a single string representing a single number.
+          if b_number.is_a? Array then
+            # It's an array
+            for bn in b_number do
+              request.add('bNumber', bn)
+            end
+          else
+
+            # We assume its a string
+            request.add('bNumber', b_number)
           end
-        else
 
-          # We assume its a string
-          request.add('bNumber', b_number)
+          request.add('privacyA', privacy_a.to_s)
+          request.add('privacyB', privacy_b.to_s)
+          request.add('expiration', expiration)
+          request.add('maxDuration', max_duration)
+          request.add('maxWait', max_wait)
+          request.add('greeter', greeter)
+          request.add('account', account)
         end
-
-        request.add('privacyA', privacy_a.to_s)
-        request.add('privacyB', privacy_b.to_s)
-        request.add('expiration', expiration)
-        request.add('maxDuration', max_duration)
-        request.add('maxWait', max_wait)
-        request.add('greeter', greeter)
-        request.add('account', account)
       end
 
       return VoiceCallResponse.new(response)