google-adwords-api 1.4.0 → 1.6.0

data/lib/adwords_api/api_config.rb

@@ -1,333 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2010, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# Helper methods for loading and managing the available services in the AdWords
-# API.
-
-require 'ads_common/api_config'
-
-require 'adwords_api/version'
-
-module AdwordsApi
-
-  # Contains helper methods for loading and managing the available services.
-  module ApiConfig
-
-    # Inherit from AdsCommon::ApiConfig
-    class << ApiConfig
-      include AdsCommon::ApiConfig
-    end
-
-    # Set defaults
-    DEFAULT_VERSION = :v201809
-    LATEST_VERSION = :v201809
-
-    # Set other constants
-    API_NAME = 'AdwordsApi'
-    DEFAULT_CONFIG_FILENAME = 'adwords_api.yml'
-
-    # Configure the services available to each version
-    @@service_config = {
-      :v201806 => [
-          :AccountLabelService,
-          :AdCustomizerFeedService,
-          :AdGroupAdService,
-          :AdGroupBidModifierService,
-          :AdGroupCriterionService,
-          :AdGroupExtensionSettingService,
-          :AdGroupFeedService,
-          :AdGroupService,
-          :AdParamService,
-          :AdService,
-          :AdwordsUserListService,
-          :AssetService,
-          :BatchJobService,
-          :BiddingStrategyService,
-          :BudgetOrderService,
-          :BudgetService,
-          :CampaignBidModifierService,
-          :CampaignCriterionService,
-          :CampaignExtensionSettingService,
-          :CampaignFeedService,
-          :CampaignGroupService,
-          :CampaignGroupPerformanceTargetService,
-          :CampaignService,
-          :CampaignSharedSetService,
-          :ConstantDataService,
-          :ConversionTrackerService,
-          :CustomAffinityService,
-          :CustomerExtensionSettingService,
-          :CustomerFeedService,
-          :CustomerNegativeCriterionService,
-          :CustomerService,
-          :CustomerSyncService,
-          :DataService,
-          :DraftAsyncErrorService,
-          :DraftService,
-          :FeedItemService,
-          :FeedItemTargetService,
-          :FeedMappingService,
-          :FeedService,
-          :LabelService,
-          :LocationCriterionService,
-          :ManagedCustomerService,
-          :MediaService,
-          :OfflineCallConversionFeedService,
-          :OfflineConversionAdjustmentFeedService,
-          :OfflineConversionFeedService,
-          :OfflineDataUploadService,
-          :ReportDefinitionService,
-          :SharedCriterionService,
-          :SharedSetService,
-          :TargetingIdeaService,
-          :TrafficEstimatorService,
-          :TrialAsyncErrorService,
-          :TrialService
-      ],
-      :v201809 => [
-          :AccountLabelService,
-          :AdCustomizerFeedService,
-          :AdGroupAdService,
-          :AdGroupBidModifierService,
-          :AdGroupCriterionService,
-          :AdGroupExtensionSettingService,
-          :AdGroupFeedService,
-          :AdGroupService,
-          :AdParamService,
-          :AdService,
-          :AdwordsUserListService,
-          :AssetService,
-          :BatchJobService,
-          :BiddingStrategyService,
-          :BudgetOrderService,
-          :BudgetService,
-          :CampaignBidModifierService,
-          :CampaignCriterionService,
-          :CampaignExtensionSettingService,
-          :CampaignFeedService,
-          :CampaignGroupService,
-          :CampaignGroupPerformanceTargetService,
-          :CampaignService,
-          :CampaignSharedSetService,
-          :ConstantDataService,
-          :ConversionTrackerService,
-          :CustomAffinityService,
-          :CustomerExtensionSettingService,
-          :CustomerFeedService,
-          :CustomerNegativeCriterionService,
-          :CustomerService,
-          :CustomerSyncService,
-          :DataService,
-          :DraftAsyncErrorService,
-          :DraftService,
-          :FeedItemService,
-          :FeedItemTargetService,
-          :FeedMappingService,
-          :FeedService,
-          :LabelService,
-          :LocationCriterionService,
-          :ManagedCustomerService,
-          :MediaService,
-          :OfflineCallConversionFeedService,
-          :OfflineConversionAdjustmentFeedService,
-          :OfflineConversionFeedService,
-          :OfflineDataUploadService,
-          :ReportDefinitionService,
-          :SharedCriterionService,
-          :SharedSetService,
-          :TargetingIdeaService,
-          :TrafficEstimatorService,
-          :TrialAsyncErrorService,
-          :TrialService
-      ]
-    }
-
-    # Configure the base URL for each version and scope.
-    @@config = {
-      :oauth_scope => 'https://www.googleapis.com/auth/adwords',
-      :header_ns => 'https://adwords.google.com/api/adwords/cm/',
-      :v201806 => 'https://adwords.google.com/api/adwords/',
-      :v201809 => 'https://adwords.google.com/api/adwords/'
-    }
-
-    # Configure the subdirectories for each version / service pair.
-    # A missing pair means that only the base URL is used.
-    @@subdir_config = {
-      # v201806
-      [:v201806, :AccountLabelService] => 'mcm/',
-      [:v201806, :AdCustomizerFeedService] => 'cm/',
-      [:v201806, :AdGroupAdService] => 'cm/',
-      [:v201806, :AdGroupBidModifierService] => 'cm/',
-      [:v201806, :AdGroupCriterionService] => 'cm/',
-      [:v201806, :AdGroupExtensionSettingService] => 'cm/',
-      [:v201806, :AdGroupFeedService] => 'cm/',
-      [:v201806, :AdGroupService] => 'cm/',
-      [:v201806, :AdParamService] => 'cm/',
-      [:v201806, :AdService] => 'cm/',
-      [:v201806, :AdwordsUserListService] => 'rm/',
-      [:v201806, :AssetService] => 'cm/',
-      [:v201806, :BatchJobService] => 'cm/',
-      [:v201806, :BiddingStrategyService] => 'cm/',
-      [:v201806, :BudgetOrderService] => 'billing/',
-      [:v201806, :BudgetService] => 'cm/',
-      [:v201806, :CampaignBidModifierService] => 'cm/',
-      [:v201806, :CampaignCriterionService] => 'cm/',
-      [:v201806, :CampaignExtensionSettingService] => 'cm/',
-      [:v201806, :CampaignFeedService] => 'cm/',
-      [:v201806, :CampaignGroupService] => 'cm/',
-      [:v201806, :CampaignGroupPerformanceTargetService] => 'cm/',
-      [:v201806, :CampaignService] => 'cm/',
-      [:v201806, :CampaignSharedSetService] => 'cm/',
-      [:v201806, :ConstantDataService] => 'cm/',
-      [:v201806, :ConversionTrackerService] => 'cm/',
-      [:v201806, :CustomAffinityService] => 'rm/',
-      [:v201806, :CustomerExtensionSettingService] => 'cm/',
-      [:v201806, :CustomerFeedService] => 'cm/',
-      [:v201806, :CustomerNegativeCriterionService] => 'cm/',
-      [:v201806, :CustomerService] => 'mcm/',
-      [:v201806, :CustomerSyncService] => 'ch/',
-      [:v201806, :DraftAsyncErrorService] => 'cm/',
-      [:v201806, :DataService] => 'cm/',
-      [:v201806, :DraftService] => 'cm/',
-      [:v201806, :FeedItemService] => 'cm/',
-      [:v201806, :FeedItemTargetService] => 'cm/',
-      [:v201806, :FeedMappingService] => 'cm/',
-      [:v201806, :FeedService] => 'cm/',
-      [:v201806, :LabelService] => 'cm/',
-      [:v201806, :LocationCriterionService] => 'cm/',
-      [:v201806, :ManagedCustomerService] => 'mcm/',
-      [:v201806, :MediaService] => 'cm/',
-      [:v201806, :OfflineCallConversionFeedService] => 'cm/',
-      [:v201806, :OfflineConversionAdjustmentFeedService] => 'cm/',
-      [:v201806, :OfflineConversionFeedService] => 'cm/',
-      [:v201806, :OfflineDataUploadService] => 'rm/',
-      [:v201806, :ReportDefinitionService] => 'cm/',
-      [:v201806, :SharedCriterionService] => 'cm/',
-      [:v201806, :SharedSetService] => 'cm/',
-      [:v201806, :TargetingIdeaService] => 'o/',
-      [:v201806, :TrafficEstimatorService] => 'o/',
-      [:v201806, :TrialAsyncErrorService] => 'cm/',
-      [:v201806, :TrialService] => 'cm/',
-      # v201809
-      [:v201809, :AccountLabelService] => 'mcm/',
-      [:v201809, :AdCustomizerFeedService] => 'cm/',
-      [:v201809, :AdGroupAdService] => 'cm/',
-      [:v201809, :AdGroupBidModifierService] => 'cm/',
-      [:v201809, :AdGroupCriterionService] => 'cm/',
-      [:v201809, :AdGroupExtensionSettingService] => 'cm/',
-      [:v201809, :AdGroupFeedService] => 'cm/',
-      [:v201809, :AdGroupService] => 'cm/',
-      [:v201809, :AdParamService] => 'cm/',
-      [:v201809, :AdService] => 'cm/',
-      [:v201809, :AdwordsUserListService] => 'rm/',
-      [:v201809, :AssetService] => 'cm/',
-      [:v201809, :BatchJobService] => 'cm/',
-      [:v201809, :BiddingStrategyService] => 'cm/',
-      [:v201809, :BudgetOrderService] => 'billing/',
-      [:v201809, :BudgetService] => 'cm/',
-      [:v201809, :CampaignBidModifierService] => 'cm/',
-      [:v201809, :CampaignCriterionService] => 'cm/',
-      [:v201809, :CampaignExtensionSettingService] => 'cm/',
-      [:v201809, :CampaignFeedService] => 'cm/',
-      [:v201809, :CampaignGroupService] => 'cm/',
-      [:v201809, :CampaignGroupPerformanceTargetService] => 'cm/',
-      [:v201809, :CampaignService] => 'cm/',
-      [:v201809, :CampaignSharedSetService] => 'cm/',
-      [:v201809, :ConstantDataService] => 'cm/',
-      [:v201809, :ConversionTrackerService] => 'cm/',
-      [:v201809, :CustomAffinityService] => 'rm/',
-      [:v201809, :CustomerExtensionSettingService] => 'cm/',
-      [:v201809, :CustomerFeedService] => 'cm/',
-      [:v201809, :CustomerNegativeCriterionService] => 'cm/',
-      [:v201809, :CustomerService] => 'mcm/',
-      [:v201809, :CustomerSyncService] => 'ch/',
-      [:v201809, :DraftAsyncErrorService] => 'cm/',
-      [:v201809, :DataService] => 'cm/',
-      [:v201809, :DraftService] => 'cm/',
-      [:v201809, :FeedItemService] => 'cm/',
-      [:v201809, :FeedItemTargetService] => 'cm/',
-      [:v201809, :FeedMappingService] => 'cm/',
-      [:v201809, :FeedService] => 'cm/',
-      [:v201809, :LabelService] => 'cm/',
-      [:v201809, :LocationCriterionService] => 'cm/',
-      [:v201809, :ManagedCustomerService] => 'mcm/',
-      [:v201809, :MediaService] => 'cm/',
-      [:v201809, :OfflineCallConversionFeedService] => 'cm/',
-      [:v201809, :OfflineConversionAdjustmentFeedService] => 'cm/',
-      [:v201809, :OfflineConversionFeedService] => 'cm/',
-      [:v201809, :OfflineDataUploadService] => 'rm/',
-      [:v201809, :ReportDefinitionService] => 'cm/',
-      [:v201809, :SharedCriterionService] => 'cm/',
-      [:v201809, :SharedSetService] => 'cm/',
-      [:v201809, :TargetingIdeaService] => 'o/',
-      [:v201809, :TrafficEstimatorService] => 'o/',
-      [:v201809, :TrialAsyncErrorService] => 'cm/',
-      [:v201809, :TrialService] => 'cm/'
-    }
-
-    public
-
-    # Getters for constants and module variables.
-    def self.default_version
-      DEFAULT_VERSION
-    end
-
-    def self.latest_version
-      LATEST_VERSION
-    end
-
-    def self.api_name
-      API_NAME
-    end
-
-    def self.service_config
-      @@service_config
-    end
-
-    def self.config(key)
-      @@config[key]
-    end
-
-    def self.subdir_config
-      @@subdir_config
-    end
-
-    def self.default_config_filename
-      DEFAULT_CONFIG_FILENAME
-    end
-
-    def self.headers_config
-      @@headers_config
-    end
-
-    # Get the download URL for Ad Hoc reports.
-    #
-    # Args:
-    # - version: the API version (as a symbol)
-    #
-    # Returns:
-    # - The endpoint URL (as a string)
-    #
-    def self.adhoc_report_download_url(version)
-      base = get_wsdl_base(version)
-      if base
-        base += 'reportdownload/%s' % version.to_s
-      end
-      return base
-    end
-  end
-end

data/lib/adwords_api/batch_job_utils.rb

@@ -1,334 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2015, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# Contains utility methods specific to using the BatchJobService.
-
-require 'nokogiri'
-require 'nori'
-
-require 'ads_common/http'
-require 'ads_common/savon_service'
-require 'adwords_api/errors'
-require 'adwords_api/incremental_upload_helper'
-
-module AdwordsApi
-  class BatchJobUtils
-    # Default constructor.
-    #
-    # Args:
-    # - api: AdwordsApi object
-    # - version: API version to use
-    #
-    def initialize(api, version)
-      @api, @version = api, version
-    end
-
-    # Uploads the given operations for a batch job to the provided URL.
-    #
-    # Args:
-    # - hash_operations: An array of ruby has operations to execute by
-    #   posting them to the provided URL
-    # - service_name: The name of the AdwordsApi service as a symbol that would
-    #   normally make this request
-    # - batch_job_url: The UploadURL provided by BatchJobService
-    #
-    # Raises:
-    # - InvalidBatchJobOperationError: If there is a problem converting the
-    # given operations to SOAP.
-    #
-    def upload_operations(operations, batch_job_url)
-      helper = start_incremental_upload(batch_job_url)
-      helper.upload(operations, true)
-    end
-
-    # Provides a helper to manage incremental uploads.
-    #
-    # Args:
-    # - batch_job_url: The UploadURL provided by BatchJobService for new jobs,
-    # or the upload_url from IncrementalUploadHelper for continued jobs.
-    # - uploaded_bytes: The number of bytes already uploaded for this
-    # incremental batch job. Can be retrieved from the IncrementalUploadHelper
-    # using uploaded_bytes.
-    #
-    # Returns:
-    # - an IncrementalUploadHelper that will accept operations and put them,
-    # keeping track of uploaded bytes automatically.
-    #
-    def start_incremental_upload(batch_job_url, uploaded_bytes = 0)
-      return AdwordsApi::IncrementalUploadHelper.new(
-          self, uploaded_bytes, batch_job_url)
-    end
-
-    # Initializes an upload URL to get the actual URL to which to upload
-    # operations.
-    #
-    # Args:
-    # - batch_job_url: The UploadURL provided by BatchJobService
-    #
-    # Returns:
-    # - The URL that should actually be used to upload operations.
-    #
-    def initialize_url(batch_job_url)
-      headers = DEFAULT_HEADERS
-      headers['Content-Length'] = 0
-      headers['x-goog-resumable'] = 'start'
-
-      response = AdsCommon::Http.post_response(
-          batch_job_url, '', @api.config, headers)
-
-      return response.headers['Location']
-    end
-
-    # Puts the provided operations to the provided URL, allowing
-    # for incremental followup puts.
-    #
-    # Args:
-    # - soap_operations: An array including SOAP operations provided by
-    #   generate_soap_operations
-    # - batch_job_url: The UploadURL provided by BatchJobService
-    # - total_content_length: The total number of bytes already uploaded
-    #   incrementally. Set this to 0 the first time you call the method.
-    # - is_last_request: Whether or not this set of uploads will conclude the
-    #   full request.
-    #
-    # Returns:
-    # - total content length, including what was just uploaded. Pass this back
-    #   into this method on subsequent calls.
-    def put_incremental_operations(
-        operations, batch_job_url, total_content_length = 0,
-        is_last_request = false)
-      @api.utils_reporter.batch_job_utils_used()
-      headers = DEFAULT_HEADERS
-      soap_operations = generate_soap_operations(operations)
-      request_body = soap_operations.join
-      is_first_request = (total_content_length == 0)
-
-      if is_first_request
-        request_body = (UPLOAD_XML_PREFIX % [@version]) + request_body
-      end
-      if is_last_request
-        request_body += UPLOAD_XML_SUFFIX
-      end
-
-      request_body = add_padding(request_body)
-      content_length = request_body.bytesize
-
-      headers['Content-Length'] = content_length
-
-      lower_bound = total_content_length
-      upper_bound = total_content_length + content_length - 1
-      total_bytes = is_last_request ? upper_bound + 1 : '*'
-      content_range =
-          "bytes %d-%d/%s" % [lower_bound, upper_bound, total_bytes]
-
-      headers['Content-Range'] = content_range
-
-      log_request(batch_job_url, headers, request_body)
-
-      # The HTTPI library fails to handle the response when uploading
-      # incremental requests. We're not interested in the response, so just
-      # ignore the error.
-      begin
-        AdsCommon::Http.put_response(
-            batch_job_url, request_body, @api.config, headers)
-      rescue ArgumentError
-      end
-
-      total_content_length += content_length
-      return total_content_length
-    end
-
-    # Downloads the results of a batch job from the specified URL.
-    #
-    # Args:
-    # - batch_job_url: The URL provided by BatchJobService to fetch the results
-    #   from
-    #
-    # Returns:
-    # - the results of the batch job, as a ruby hash, or nil if none yet exist
-    #
-    def get_job_results(batch_job_url)
-      @api.utils_reporter.batch_job_utils_used()
-      xml_response = AdsCommon::Http.get_response(batch_job_url, @api.config)
-      begin
-        return sanitize_result(
-            get_nori().parse(xml_response.body)[:mutate_response][:rval])
-      rescue
-        return nil
-      end
-    end
-
-    private
-
-    # For incremental uploads, the size (in bytes) of the body of the request
-    # must be in multiples of 256k.
-    REQUIRED_CONTENT_LENGTH_INCREMENT = 256 * 1024
-
-    UPLOAD_XML_PREFIX = '<?xml version="1.0" encoding="UTF-8"?><ns1:mutate ' +
-          'xmlns:ns1="https://adwords.google.com/api/adwords/cm/%s">'
-    UPLOAD_XML_SUFFIX = '</ns1:mutate>'
-    DEFAULT_HEADERS = {"Content-Type" => "application/xml"}
-
-    SERVICES_BY_OPERATION_TYPE = {
-      'AdGroupAdOperation' => :AdGroupAdService,
-      'AdGroupAdLabelOperation' => :AdGroupAdService,
-      'AdGroupBidModifierOperation' => :AdGroupBidModifierService,
-      'AdGroupCriterionOperation' => :AdGroupCriterionService,
-      'AdGroupCriterionLabelOperation' => :AdGroupCriterionService,
-      'AdGroupExtensionSettingOperation' => :AdGroupExtensionSettingService,
-      'AdGroupOperation' => :AdGroupService,
-      'AdGroupLabelOperation' => :AdGroupService,
-      'BudgetOperation' => :BudgetService,
-      'CampaignCriterionOperation' => :CampaignCriterionService,
-      'CampaignExtensionSettingOperation' => :CampaignExtensionSettingService,
-      'CampaignLabelOperation' => :CampaignService,
-      'CampaignOperation' => :CampaignService,
-      'CampaignSharedSetOperation' => :CampaignSharedSetService,
-      'CustomerExtensionSettingOperation' => :CustomerExtensionSettingService,
-      'FeedItemOperation' => :FeedItemService,
-      'FeedItemTargetOperation' => :FeedItemTargetService,
-      'SharedCriterionOperation' => :SharedCriterionService,
-      'SharedSetOperation' => :SharedSetService
-    }
-
-    METHODS_BY_OPERATION_TYPE = {
-      'AdGroupAdOperation' => 'mutate_to_xml',
-      'AdGroupAdLabelOperation' => 'mutate_label_to_xml',
-      'AdGroupBidModifierOperation' => 'mutate_to_xml',
-      'AdGroupCriterionOperation' => 'mutate_to_xml',
-      'AdGroupCriterionLabelOperation' => 'mutate_label_to_xml',
-      'AdGroupExtensionSettingOperation' => 'mutate_to_xml',
-      'AdGroupOperation' => 'mutate_to_xml',
-      'AdGroupLabelOperation' => 'mutate_label_to_xml',
-      'BudgetOperation' => 'mutate_to_xml',
-      'CampaignCriterionOperation' => 'mutate_to_xml',
-      'CampaignExtensionSettingOperation' => 'mutate_to_xml',
-      'CampaignLabelOperation' => 'mutate_label_to_xml',
-      'CampaignOperation' => 'mutate_to_xml',
-      'CampaignSharedSetOperation' => 'mutate_to_xml',
-      'CustomerExtensionSettingOperation' => 'mutate_to_xml',
-      'FeedItemOperation' => 'mutate_to_xml',
-      'FeedItemTargetOperation' => 'mutate_to_xml',
-      'SharedCriterionOperation' => 'mutate_to_xml',
-      'SharedSetOperation' => 'mutate_to_xml'
-    }
-
-    def generate_soap_operations(hash_operations)
-      unless hash_operations.is_a?(Array)
-        raise AdwordsApi::Errors::InvalidBatchJobOperationError,
-            'Operations must be in an array.'
-      end
-      return hash_operations.map do |operation|
-        operation_type = operation[:xsi_type]
-        if operation_type.nil?
-          raise AdwordsApi::Errors::InvalidBatchJobOperationError,
-              ':xsi_type for operations must be defined ' +
-              'explicitly for batch jobs.'
-        end
-        service_name = SERVICES_BY_OPERATION_TYPE[operation_type]
-        if service_name.nil?
-          raise AdwordsApi::Errors::InvalidBatchJobOperationError,
-              'Unknown operation type: %s' % operation_type
-        end
-        method_name = METHODS_BY_OPERATION_TYPE[operation_type]
-        service = @api.service(service_name, @version)
-        full_soap_xml = service.send(method_name, [operation])
-        operation_xml = extract_soap_operations(full_soap_xml)
-        operation_xml
-      end
-    end
-
-    # Given a full SOAP xml string, extract just the operations element
-    # from the SOAP body as a string.
-    def extract_soap_operations(full_soap_xml)
-      doc = Nokogiri::XML(full_soap_xml)
-      operations = doc.css('wsdl|operations')
-      operations.attr('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance')
-      operations.each do |element|
-        check_xsi_type(element)
-      end
-      return operations.to_s
-    end
-
-    def check_xsi_type(xml_node)
-      xsi_type = xml_node['xsi:type']
-      unless xsi_type.nil? or xsi_type.start_with?('ns1:')
-        xml_node['xsi:type'] = 'ns1:' + xsi_type
-      end
-      children = xml_node.children
-      unless children.empty?
-        children.each do |element|
-          check_xsi_type(element)
-        end
-      end
-    end
-
-    # Logs the request on debug level.
-    def log_request(url, headers, body)
-      logger = @api.logger
-      logger.debug("Report request to: '%s'" % url)
-      logger.debug('HTTP headers: [%s]' %
-          (headers.map { |k, v| [k, v].join(': ') }.join(', ')))
-      logger.debug(body)
-    end
-
-    # Removes extraneous XML information from return hash.
-    def sanitize_result(results)
-      if results.is_a?(Array)
-        ret = []
-        results.each do |result|
-          ret << sanitize_result(result)
-        end
-        return ret
-      end
-
-      if results.is_a?(Hash)
-        ret = {}
-        results.each do |k, v|
-          v = sanitize_result(v) if v.is_a?(Hash)
-          ret[k] = v unless k.to_s.start_with?('@')
-        end
-        return ret
-      end
-
-      return results
-    end
-
-    def add_padding(xml)
-      remainder = xml.bytesize % REQUIRED_CONTENT_LENGTH_INCREMENT
-      return xml if remainder == 0
-      bytes_to_add = REQUIRED_CONTENT_LENGTH_INCREMENT - remainder
-      padded_xml = xml + (' ' * bytes_to_add)
-      return padded_xml
-    end
-
-    def get_nori()
-      return @nori if @nori
-
-      nori_options = {
-        :strip_namespaces      => true,
-        :convert_tags_to       => lambda { |tag| tag.snakecase.to_sym },
-        :empty_tag_value       => "",
-        :advanced_typecasting  => false
-      }
-
-      @nori = Nori.new(nori_options)
-
-      return @nori
-    end
-  end
-end