google-ads-savon 1.0.0

data/lib/ads_savon/hooks/hook.rb

@@ -0,0 +1,61 @@
+module GoogleAdsSavon
+  module Hooks
+
+    # = GoogleAdsSavon::Hooks::Hook
+    #
+    # A hook used somewhere in the system.
+    class Hook
+
+      HOOKS = [
+
+        # :soap_request
+        #
+        # Around filter wrapping the POST request executed to call a SOAP service.
+        # See: GoogleAdsSavon::SOAP::Request#response
+        #
+        # Arguments
+        #
+        #   [callback] A block to execute the SOAP request
+        #   [request]  The current <tt>GoogleAdsSavon::SOAP::Request</tt>
+        #
+        # Examples
+        #
+        #   Log the time before and after the SOAP call:
+        #
+        #     GoogleAdsSavon.config.hooks.define(:my_hook, :soap_request) do |callback, request|
+        #       Timer.log(:start, Time.now)
+        #       response = callback.call
+        #       Timer.log(:end, Time.now)
+        #       response
+        #     end
+        #
+        #   Replace the SOAP call and return a custom response:
+        #
+        #     GoogleAdsSavon.config.hooks.define(:mock_hook, :soap_request) do |_, request|
+        #       HTTPI::Response.new(200, {}, "")
+        #     end
+        :soap_request
+
+      ]
+
+      # Expects an +id+, the name of the +hook+ to use and a +block+ to be called.
+      def initialize(id, hook, &block)
+        unless HOOKS.include?(hook)
+          raise ArgumentError, "No such hook: #{hook}. Expected one of: #{HOOKS.join(', ')}"
+        end
+
+        self.id = id
+        self.hook = hook
+        self.block = block
+      end
+
+      attr_accessor :id, :hook, :block
+
+      # Calls the +block+ with the given +args+.
+      def call(*args)
+        block.call(*args)
+      end
+
+    end
+  end
+end

data/lib/ads_savon/http/error.rb

@@ -0,0 +1,42 @@
+require "ads_savon/error"
+require "ads_savon/soap/xml"
+
+module GoogleAdsSavon
+  module HTTP
+
+    # = GoogleAdsSavon::HTTP::Error
+    #
+    # Represents an HTTP error. Contains the original <tt>HTTPI::Response</tt>.
+    class Error < Error
+
+      # Expects an <tt>HTTPI::Response</tt>.
+      def initialize(http)
+        self.http = http
+      end
+
+      # Accessor for the <tt>HTTPI::Response</tt>.
+      attr_accessor :http
+
+      # Returns whether an HTTP error is present.
+      def present?
+        http.error?
+      end
+
+      # Returns the HTTP error message.
+      def to_s
+        return "" unless present?
+
+        @message ||= begin
+          message = "HTTP error (#{http.code})"
+          message << ": #{http.body}" unless http.body.empty?
+        end
+      end
+
+      # Returns the HTTP response as a Hash.
+      def to_hash
+        @hash = { :code => http.code, :headers => http.headers, :body => http.body }
+      end
+
+    end
+  end
+end

data/lib/ads_savon/log_message.rb

@@ -0,0 +1,50 @@
+module GoogleAdsSavon
+  class LogMessage
+
+    def initialize(message, filters, options = {})
+      @message = message
+      @filters = filters
+      @options = options
+    end
+
+    def to_s
+      return @message unless pretty? || filter?
+
+      doc = Nokogiri.XML(@message)
+      doc = apply_filter(doc) if filter?
+      doc.to_xml(pretty_options)
+    end
+
+    private
+
+    def filter?
+      @options[:filter] && @filters.any?
+    end
+
+    def pretty?
+      @options[:pretty]
+    end
+
+    def apply_filter(doc)
+      return doc unless doc.errors.empty?
+
+      @filters.each do |filter|
+        apply_filter!(doc, filter)
+      end
+
+      doc
+    end
+
+    def apply_filter!(doc, filter)
+      doc.xpath("//*[local-name()='#{filter}']").each do |node|
+        node.content = "***FILTERED***"
+      end
+    end
+
+    def pretty_options
+      return {} unless pretty?
+      { :indent => 2 }
+    end
+
+  end
+end

data/lib/ads_savon/logger.rb

@@ -0,0 +1,39 @@
+require "logger"
+require "nokogiri"
+require "ads_savon/log_message"
+
+module GoogleAdsSavon
+  class Logger
+
+    def initialize(device = $stdout)
+      self.device = device
+    end
+
+    attr_accessor :device
+
+    def log(message, options = {})
+      log_raw LogMessage.new(message, filter, options).to_s
+    end
+
+    attr_writer :subject, :level, :filter
+
+    def subject
+      @subject ||= ::Logger.new(device)
+    end
+
+    def level
+      @level ||= :debug
+    end
+
+    def filter
+      @filter ||= []
+    end
+
+    private
+
+    def log_raw(message)
+      subject.send(level, message)
+    end
+
+  end
+end

data/lib/ads_savon/model.rb

@@ -0,0 +1,102 @@
+module GoogleAdsSavon
+
+  # = GoogleAdsSavon::Model
+  #
+  # Model for SOAP service oriented applications.
+  module Model
+
+    def self.extended(base)
+      base.setup
+    end
+
+    def setup
+      class_action_module
+      instance_action_module
+    end
+
+    # Accepts one or more SOAP actions and generates both class and instance methods named
+    # after the given actions. Each generated method accepts an optional SOAP body Hash and
+    # a block to be passed to <tt>GoogleAdsSavon::Client#request</tt> and executes a SOAP request.
+    def actions(*actions)
+      actions.each do |action|
+        define_class_action(action)
+        define_instance_action(action)
+      end
+    end
+
+    private
+
+    # Defines a class-level SOAP action method.
+    def define_class_action(action)
+      class_action_module.module_eval %{
+        def #{action.to_s.snakecase}(body = nil, &block)
+          client.request :wsdl, #{action.inspect}, :body => body, &block
+        end
+      }
+    end
+
+    # Defines an instance-level SOAP action method.
+    def define_instance_action(action)
+      instance_action_module.module_eval %{
+        def #{action.to_s.snakecase}(body = nil, &block)
+          self.class.#{action.to_s.snakecase} body, &block
+        end
+      }
+    end
+
+    # Class methods.
+    def class_action_module
+      @class_action_module ||= Module.new do
+
+        # Returns the memoized <tt>GoogleAdsSavon::Client</tt>.
+        def client(&block)
+          @client ||= GoogleAdsSavon::Client.new(&block)
+        end
+
+        # Sets the SOAP endpoint to the given +uri+.
+        def endpoint(uri)
+          client.wsdl.endpoint = uri
+        end
+
+        # Sets the target namespace.
+        def namespace(uri)
+          client.wsdl.namespace = uri
+        end
+
+        # Sets the WSDL document to the given +uri+.
+        def document(uri)
+          client.wsdl.document = uri
+        end
+
+        # Sets the HTTP headers.
+        def headers(headers)
+          client.http.headers = headers
+        end
+
+        # Sets basic auth +login+ and +password+.
+        def basic_auth(login, password)
+          client.http.auth.basic(login, password)
+        end
+
+        # Sets WSSE auth credentials.
+        def wsse_auth(*args)
+          client.wsse.credentials(*args)
+        end
+
+      end.tap { |mod| extend(mod) }
+    end
+
+    # Instance methods.
+    def instance_action_module
+      @instance_action_module ||= Module.new do
+
+        # Returns the <tt>GoogleAdsSavon::Client</tt> from the class instance.
+        def client(&block)
+          self.class.client(&block)
+        end
+
+      end.tap { |mod| include(mod) }
+    end
+
+  end
+end

data/lib/ads_savon/null_logger.rb

@@ -0,0 +1,10 @@
+require "ads_savon/logger"
+
+module GoogleAdsSavon
+  class NullLogger < Logger
+
+    def log(*)
+    end
+
+  end
+end

data/lib/ads_savon/soap.rb

@@ -0,0 +1,21 @@
+module GoogleAdsSavon
+
+  # = GoogleAdsSavon::SOAP
+  #
+  # Contains various SOAP details.
+  module SOAP
+
+    # Default SOAP version.
+    DEFAULT_VERSION = 1
+
+    # Supported SOAP versions.
+    VERSIONS = 1..2
+
+    # SOAP namespaces by SOAP version.
+    NAMESPACE = {
+      1 => "http://schemas.xmlsoap.org/soap/envelope/",
+      2 => "http://www.w3.org/2003/05/soap-envelope"
+    }
+
+  end
+end

data/lib/ads_savon/soap/fault.rb

@@ -0,0 +1,72 @@
+require "ads_savon/error"
+require "ads_savon/soap/xml"
+
+module GoogleAdsSavon
+  module SOAP
+
+    # = GoogleAdsSavon::SOAP::Fault
+    #
+    # Represents a SOAP fault. Contains the original <tt>HTTPI::Response</tt>.
+    class Fault < Error
+
+      # Expects an <tt>HTTPI::Response</tt>.
+      def initialize(http)
+        self.http = http
+      end
+
+      # Accessor for the <tt>HTTPI::Response</tt>.
+      attr_accessor :http
+
+      # Returns whether a SOAP fault is present.
+      def present?
+        @present ||= http.body.include?("Fault>") && (soap1_fault? || soap2_fault?)
+      end
+
+      # Returns the SOAP fault message.
+      def to_s
+        return "" unless present?
+        @message ||= message_by_version to_hash[:fault]
+      end
+
+      # Returns the SOAP response body as a Hash.
+      def to_hash
+        @hash ||= nori.parse(http.body)[:envelope][:body]
+      end
+
+      private
+
+      # Returns whether the response contains a SOAP 1.1 fault.
+      def soap1_fault?
+        http.body.include?("faultcode>") && http.body.include?("faultstring>")
+      end
+
+      # Returns whether the response contains a SOAP 1.2 fault.
+      def soap2_fault?
+        http.body.include?("Code>") && http.body.include?("Reason>")
+      end
+
+      # Returns the SOAP fault message by version.
+      def message_by_version(fault)
+        if fault[:faultcode]
+          "(#{fault[:faultcode]}) #{fault[:faultstring]}"
+        elsif fault[:code]
+          "(#{fault[:code][:value]}) #{fault[:reason][:text]}"
+        end
+      end
+
+      def nori
+        return @nori if @nori
+
+        nori_options = {
+          :strip_namespaces      => true,
+          :convert_tags_to       => lambda { |tag| tag.snakecase.to_sym },
+          :advanced_typecasting  => false
+        }
+
+        non_nil_nori_options = nori_options.reject { |_, value| value.nil? }
+        @nori = Nori.new(non_nil_nori_options)
+      end
+
+    end
+  end
+end

data/lib/ads_savon/soap/invalid_response_error.rb

@@ -0,0 +1,13 @@
+require "ads_savon/error"
+
+module GoogleAdsSavon
+  module SOAP
+
+    # = GoogleAdsSavon::SOAP::InvalidResponseError
+    #
+    # Represents an error when the response was not a valid SOAP envelope.
+    class InvalidResponseError < Error
+    end
+
+  end
+end

data/lib/ads_savon/soap/request.rb

@@ -0,0 +1,86 @@
+require "httpi"
+require "ads_savon/soap/response"
+
+module GoogleAdsSavon
+  module SOAP
+
+    # = GoogleAdsSavon::SOAP::Request
+    #
+    # Executes SOAP requests.
+    class Request
+
+      # Content-Types by SOAP version.
+      CONTENT_TYPE = { 1 => "text/xml;charset=UTF-8", 2 => "application/soap+xml;charset=UTF-8" }
+
+      # Expects an <tt>HTTPI::Request</tt> and a <tt>GoogleAdsSavon::SOAP::XML</tt> object
+      # to execute a SOAP request and returns the response.
+      def self.execute(config, http, soap)
+        new(config, http, soap).response
+      end
+
+      # Expects an <tt>HTTPI::Request</tt>, a <tt>GoogleAdsSavon::SOAP::XML</tt> object
+      # and a <tt>GoogleAdsSavon::Config</tt>.
+      def initialize(config, http, soap)
+        self.config = config
+        self.soap = soap
+        self.http = configure(http)
+      end
+
+      attr_accessor :soap, :http, :config
+
+      # Executes the request and returns the response.
+      def response
+        @response ||= begin
+          response = config.hooks.fire(:soap_request, self) { with_logging { HTTPI.post(http) } }
+          SOAP::Response.new(config, response)
+        end
+      end
+
+      private
+
+      # Configures a given +http+ from the +soap+ object.
+      def configure(http)
+        http.url = soap.endpoint
+
+        if soap.signature?
+          # First generate the document so that Signature can digest sections
+          soap.wsse.signature.document = soap.to_xml(true)
+
+          # Then re-generate the document so that Signature can sign the digest
+          soap.wsse.signature.document = soap.to_xml(true)
+
+          # The third time we generate the document, we should have a signature
+          http.body = soap.to_xml(true)
+        else
+          http.body = soap.to_xml
+        end
+
+        http.headers["Content-Type"] = CONTENT_TYPE[soap.version]
+        http.headers["Content-Length"] = soap.to_xml.bytesize.to_s
+        http
+      end
+
+      # Logs the HTTP request, yields to a given +block+ and returns a <tt>GoogleAdsSavon::SOAP::Response</tt>.
+      def with_logging
+        log_request http.url, http.headers, http.body
+        response = yield
+        log_response response.code, response.body
+        response
+      end
+
+      # Logs the SOAP request +url+, +headers+ and +body+.
+      def log_request(url, headers, body)
+        config.logger.log "SOAP request: #{url}"
+        config.logger.log headers.map { |key, value| "#{key}: #{value}" }.join(", ")
+        config.logger.log body, :pretty => config.pretty_print_xml, :filter => true
+      end
+
+      # Logs the SOAP response +code+ and +body+.
+      def log_response(code, body)
+        config.logger.log "SOAP response (status #{code}):"
+        config.logger.log body, :pretty => config.pretty_print_xml
+      end
+
+    end
+  end
+end