google-ads-common 0.4.0 → 0.5.0

data/lib/ads_common/savon_headers/client_login_header_handler.rb

@@ -1,60 +0,0 @@
-#!/usr/bin/ruby
-#
-# Authors:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, 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.
-#
-# Handles SOAP headers and namespaces definition for ClientLogin type header.
-
-require 'ads_common/savon_headers/simple_header_handler'
-
-module AdsCommon
-  module SavonHeaders
-    class ClientLoginHeaderHandler < SimpleHeaderHandler
-      private
-
-      # Generates SOAP request header with login credentials and namespace
-      # definition.
-      #
-      # Args:
-      #  - None.
-      #
-      # Returns:
-      #  - Hash containing a header with filled in credentials.
-      #
-      def generate_request_header()
-        request_header = {}
-        credentials = @credential_handler.credentials(@version)
-        headers = @auth_handler.headers(credentials)
-        headers.each do |header, value|
-          if header == :authToken
-            auth_header = prepend_namespace('authentication')
-            request_header[auth_header] = {
-                prepend_namespace('token') => value
-            }
-            request_header[:attributes!] ||= Hash.new
-            request_header[:attributes!][auth_header] = {
-                'xsi:type' => prepend_namespace('ClientLogin'),
-            }
-          else
-            request_header[prepend_namespace(header)] = value
-          end
-        end
-        return request_header
-      end
-    end
-  end
-end

data/lib/ads_common/soap4r_headers/nested_header_handler.rb

@@ -1,50 +0,0 @@
-#!/usr/bin/ruby
-#
-# Authors:: api.sgomes@gmail.com (Sérgio Gomes)
-#
-# 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.
-#
-# Handles soap headers for AdWords v2009-style SOAP requests (nested headers).
-
-require 'soap/header/simplehandler'
-
-module AdsCommon
-  module Soap4rHeaders
-
-    class NestedHeaderHandler < SOAP::Header::SimpleHandler
-
-      def initialize(credential_handler, auth_handler, top_element_name,
-          top_namespace, inner_namespace, version = nil)
-        super(XSD::QName.new(top_namespace, top_element_name))
-        @credential_handler = credential_handler
-        @auth_handler = auth_handler
-        @ns = inner_namespace
-        @version = version
-      end
-
-      # Handles callback.
-      def on_simple_outbound
-        main_header = SOAP::SOAPElement.new(nil)
-        credentials = @credential_handler.credentials(@version)
-        @auth_handler.headers(credentials).each do |cred, value|
-          cred_header = SOAP::SOAPElement.new(XSD::QName.new(@ns, cred), value)
-          main_header.add(cred_header)
-        end
-        return main_header
-      end
-    end
-  end
-end

data/lib/ads_common/soap4r_headers/single_header_handler.rb

@@ -1,44 +0,0 @@
-#!/usr/bin/ruby
-#
-# Authors:: api.sgomes@gmail.com (Sérgio Gomes)
-#
-# 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.
-#
-# Handles soap headers for AdWords v13-style SOAP requests (flat headers).
-
-require 'soap/header/simplehandler'
-
-module AdsCommon
-  module Soap4rHeaders
-
-    class SingleHeaderHandler < SOAP::Header::SimpleHandler
-
-      def initialize(credential_handler, auth_handler,
-          element_name, element_namespace = nil, version = nil)
-        super(XSD::QName.new(element_namespace, element_name))
-        @credential_handler = credential_handler
-        @auth_handler = auth_handler
-        @element_name = element_name
-        @version = version
-      end
-
-      def on_simple_outbound
-        credentials = @credential_handler.credentials(@version)
-        return @auth_handler.headers(credentials)[@element_name]
-      end
-    end
-  end
-end

data/lib/ads_common/soap4r_patches.rb

@@ -1,210 +0,0 @@
-#!/usr/bin/ruby
-#
-# Authors:: api.sgomes@gmail.com (Sérgio Gomes)
-#           api.jeffy@gmail.com (Jeffrey Posnick)
-#
-# 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.
-#
-# Collection of small patches to soap4r, used in the client libraries.
-
-require 'rubygems'
-begin
-  gem 'soap4r', '=1.5.8'
-rescue
-  require_gem 'soap4r', '=1.5.8'
-end
-require 'soap/soap'
-require 'soap/rpc/driver'
-
-
-# Fix an issue with code generation: the infamous "type collapse" bug. This
-# should avoid objects with just one property, that happens to be an array, from
-# being collapsed into a simple array.
-module WSDL
-  module SOAP
-    class ClassDefCreator
-      def dump_complextype
-        definitions = sort_dependency(@complextypes).collect { |type|
-            c = create_complextypedef(@modulepath, type.name, type)
-            c ? c.dump : nil
-        }.compact.join("\n")
-      end
-
-      def create_complextypedef(mpath, qname, type, qualified = false)
-        case type.compoundtype
-        when :TYPE_STRUCT, :TYPE_EMPTY
-          create_structdef(mpath, qname, type, qualified)
-        when :TYPE_ARRAY
-          ### Patch starts here ###
-          create_structdef(mpath, qname, type, qualified)
-          #create_arraydef(mpath, qname, type)
-          ### Patch ends here ###
-        when :TYPE_SIMPLE
-          create_simpleclassdef(mpath, qname, type)
-        when :TYPE_MAP
-          # mapped as a general Hash
-          nil
-        else
-          raise RuntimeError.new(
-            "unknown kind of complexContent: #{type.compoundtype}")
-        end
-      end
-    end
-  end
-end
-
-module SOAP
-
-  # Fix an issue with SOAPDate. Google complains if the dates have any timezone
-  # info in them. There are probably better ways to fix this.
-  class SOAPDate
-
-    def of2tz(offset)
-      diffmin = offset * 24 * 60
-      if diffmin.zero?
-        ''
-      else
-        ((diffmin < 0) ? '-' : '+') << format('%02d:%02d',
-          (diffmin.abs / 60.0).to_i, (diffmin.abs % 60.0).to_i)
-      end
-    end
-  end
-
-  # Fix an issue with base64 encoded items in responses, which causes them to
-  # be encoded twice
-  module Mapping
-    class LiteralRegistry
-      def base2obj(value, klass)
-        v = if value.respond_to?(:data)
-              value.data
-            elsif value.respond_to?(:text)
-              value.text
-            else
-              nil
-            end
-        ### Patch starts here ###
-        if klass.to_s == 'SOAP::SOAPBase64'
-          v
-        ### Patch ends here ###
-        elsif value.is_a?(klass)
-          v
-        else
-          klass.to_data(v)
-        end
-      end
-    end
-  end
-
-  # Monkey-patching soap4r to add a callback at the Proxy level. Not exactly the
-  # prettiest way of doing things, but other callback levels in soap4r don't
-  # provide all the information we need to log.
-  module RPC
-
-    class CallbackHandler
-
-      # The callback handler takes a method name (the API method invoked), an
-      # endpoint and the message envelope. This method is meant to be overloaded
-      # in derived classes.
-      def on_callback(method_name, endpoint, envelope)
-        return nil
-      end
-    end
-
-    class Driver
-      # Use the Driver class's __attr_proxy method to declare getters and
-      # setters for "callbackhandler". These reference the getters and setters
-      # for the property with the same name in the Proxy object contained
-      # within driver (@proxy).
-      __attr_proxy :callbackhandler, true
-
-    end
-
-    class Proxy
-
-      attr_accessor :callbackhandler
-
-      # This method is a copy of the one included in soap4r, with the additions
-      # marked below, to enable the callback.
-      def call(name, *params)
-        # name must be used only for lookup
-        op_info = lookup_operation(name)
-        mapping_opt = create_mapping_opt
-        req_header = create_request_header
-        req_body = SOAPBody.new(
-          op_info.request_body(params, @mapping_registry,
-            @literal_mapping_registry, mapping_opt)
-        )
-        reqopt = create_encoding_opt(
-          :soapaction => op_info.soapaction || @soapaction,
-          :envelopenamespace => @options["soap.envelope.requestnamespace"],
-          :default_encodingstyle =>
-            @default_encodingstyle || op_info.request_default_encodingstyle,
-          :use_default_namespace =>
-            op_info.use_default_namespace || @use_default_namespace
-        )
-        resopt = create_encoding_opt(
-          :envelopenamespace => @options["soap.envelope.responsenamespace"],
-          :default_encodingstyle =>
-            @default_encodingstyle || op_info.response_default_encodingstyle
-        )
-        if reqopt[:generate_explicit_type].nil?
-          reqopt[:generate_explicit_type] = (op_info.request_use == :encoded)
-        end
-        if resopt[:generate_explicit_type].nil?
-          resopt[:generate_explicit_type] = (op_info.response_use == :encoded)
-        end
-        env = route(req_header, req_body, reqopt, resopt)
-        ### Patch starts here ###
-        if op_info.response_use.nil?
-          unless callbackhandler.nil?
-            callbackhandler.on_callback(name, @endpoint_url, env, params)
-          end
-          return nil
-        end
-        fault = false
-        fault_message = nil
-        begin
-          unless env
-            fault = true
-            fault_message = 'Empty SOAP response'
-            raise EmptyResponseError
-          end
-          receive_headers(env.header)
-          begin
-            check_fault(env.body)
-          rescue ::SOAP::FaultError => e
-            fault = true
-            fault_message = e.to_s
-            op_info.raise_fault(e, @mapping_registry, @literal_mapping_registry)
-          end
-        ensure
-          unless callbackhandler.nil?
-            callbackhandler.on_callback(name, @endpoint_url, env, params, fault,
-                fault_message)
-          end
-        end
-        ### Patch ends here ###
-
-        if @return_response_as_xml
-          resopt[:response_as_xml]
-        else
-          op_info.response_obj(env.body, @mapping_registry,
-            @literal_mapping_registry, mapping_opt)
-        end
-      end
-    end
-  end
-end

data/lib/ads_common/soap4r_response_handler.rb

@@ -1,80 +0,0 @@
-#!/usr/bin/ruby
-#
-# Authors:: api.sgomes@gmail.com (Sérgio Gomes)
-#
-# Copyright:: Copyright 2011, 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.
-#
-# Generic callback handling class, to be inherited from and extended for
-# specific APIs.
-
-require 'ads_common/soap4r_patches'
-
-module AdsCommon
-
-  # Handler class to process response messages for API unit usage and statistics
-  # information.
-  class Soap4rResponseHandler < SOAP::RPC::CallbackHandler
-
-    # Constructor for Soap4rResponseHandler.
-    #
-    # Args:
-    # - parent: AdsCommon::Api object to which this instance should be tied
-    #
-    def initialize(parent)
-      @parent = parent
-    end
-
-    # Handles the callback method.
-    # This method is a prime candidate for redefinition in specific APIs.
-    #
-    # Args:
-    # - method_name: name for the operation that was invoked
-    # - endpoint: the endpoint URL the request was sent to
-    # - envelope: the envelope for the SOAP response that was received
-    # - params: the parameters that were passed to the method
-    # - fault: whether the request resulted in a fault or not
-    # - fault_msg: the fault message in case of a fault (nil if none)
-    #
-    def on_callback(method_name, endpoint, envelope, params, fault = false,
-        fault_msg = nil)
-      fault_text = fault_msg ? fault_msg.to_s : 'none'
-      data = "host=%s method=%s isFault=%s faultMessage=\"%s\"" %
-          [URI.parse(endpoint).host, method_name, fault.to_s, fault_text]
-      @parent.logger.info(data)
-    end
-
-    # Parses the value contained in a SOAP response header.
-    #
-    # Args:
-    # - header: an object representing a SOAP header
-    #
-    # Returns:
-    # The value contained in the header as a string, or nil if the header is nil
-    #
-    def parse_header(header)
-      if header.nil?
-        return nil
-      end
-
-      header_element = header
-      if header.instance_variable_defined?('@element')
-        header_element = header.element
-      end
-
-      return header_element.text
-    end
-  end
-end