google-ads-savon 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e33b82251dab2fe6023fddf342d54c42baae2ad5
+  data.tar.gz: d45eadd1cb5bd5c857580018ca16a08f00616356
+SHA512:
+  metadata.gz: 7def73594ce63bdb09025dc8bd0d1bd8a1de1dcee582b425b880408cba3022d248659dce4d13c20771a41710057f1b7be578f2b5053184d2e8b6579839877c5c
+  data.tar.gz: 3d3ac185715f0f161f11a4cd98d034948576724ece7f6ee749685e5f75f00107eebbdb6f6e1217a47b48c4e95f365c46053b68b42ea05bc4850d96ff72946906

data/BUILD

@@ -0,0 +1,7 @@
+# Description:
+#   GoogleAdsSavon, a soap library forked from Savon v1.2.0.
+package(default_visibility = ["//visibility:public"])
+
+licenses(["notice"])  # MIT
+
+exports_files(["LICENSE"])

data/CONTRIBUTING

@@ -0,0 +1,24 @@
+Want to contribute? Great! First, read this page (including the small print at the end).
+
+### Before you contribute
+Before we can use your code, you must sign the
+[Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual?csw=1)
+(CLA), which you can do online. The CLA is necessary mainly because you own the
+copyright to your changes, even after your contribution becomes part of our
+codebase, so we need your permission to use and distribute your code. We also
+need to be sure of various other things—for instance that you'll tell us if you
+know that your code infringes on other people's patents. You don't have to sign
+the CLA until after you've submitted your code for review and a member has
+approved it, but you must do it before we can put your code into our codebase.
+Before you start working on a larger contribution, you should get in touch with
+us first through the issue tracker with your idea so that we can help out and
+possibly guide you. Coordinating up front makes it much easier to avoid
+frustration later on.
+
+### Code reviews
+All submissions, including submissions by project members, require review. We
+use Github pull requests for this purpose.
+
+### The small print
+Contributions made by corporations are covered by a different agreement than
+the one above, the Software Grant and Corporate Contributor License Agreement.

data/ChangeLog

@@ -0,0 +1,3 @@
+1.0.0:
+  - Initial release of Google Ads Savon. This is a fork of Savon version 1,
+    which can be found here: https://github.com/savonrb/savon/tree/version1

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Daniel Harrington
+Copyright (c) 2015 Google, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,17 @@
+# Google Ads Savon
+
+Google Ads Savon is a fork of [Savon 1](http://savonrb.com/version1/)
+specific for use with the Google Ads Ruby Client Library.
+
+Google Ads Savon is available through [Rubygems](http://rubygems.org/gems/google-ads-savon) and can be installed via:
+
+    $ gem install google-ads-savon
+
+This library is not intended for re-use outside of google-ads-common.
+
+This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.
+
+Documentation
+-------------
+
+Read about the original library at [savonrb.com/version1/](http://savonrb.com/version1/)

data/Rakefile

@@ -0,0 +1,5 @@
+desc 'Package the Google Ads Savon library into a gem file.'
+task :build do
+  result = system('/usr/bin/env gem build google-ads-savon.gemspec')
+  raise 'Build failed.' unless result
+end

data/google-ads-savon.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding : utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$:.unshift lib unless $:.include? lib
+
+require "ads_savon/version"
+
+Gem::Specification.new do |s|
+  s.name        = "google-ads-savon"
+  s.version     = GoogleAdsSavon::VERSION
+  s.authors     = "Daniel Harrington"
+  s.email       = "me@rubiii.com"
+  s.homepage    = "http://savonrb.com"
+  s.summary     = "Heavy metal SOAP client"
+  s.description = "Delicious SOAP for the Ruby community"
+
+  s.rubyforge_project = s.name
+  s.license = 'MIT'
+
+  s.add_dependency "nori",     "~> 2.4"
+  s.add_dependency "httpi",    "~> 2.3"
+  s.add_dependency "wasabi",   "~> 3.4"
+  s.add_dependency "akami",    "~> 1.2"
+  s.add_dependency "gyoku",    "~> 1.2"
+
+  s.add_dependency "builder",  ">= 2.1.2"
+  s.add_dependency "nokogiri", ">= 1.4.0"
+
+  s.add_development_dependency "rake",    "~> 10.1"
+  s.add_development_dependency "rspec",   "~> 2.14"
+  s.add_development_dependency "mocha",   "~> 0.14"
+  s.add_development_dependency "timecop", "~> 0.3"
+
+  s.files = Dir["**/*"]
+  s.require_path = "lib"
+end

data/lib/ads_savon.rb

@@ -0,0 +1,23 @@
+require "ads_savon/version"
+require "ads_savon/config"
+require "ads_savon/client"
+require "ads_savon/model"
+
+module GoogleAdsSavon
+  extend self
+
+  def client(*args, &block)
+    Client.new(*args, &block)
+  end
+
+  def configure
+    yield config
+  end
+
+  def config
+    @config ||= Config.default
+  end
+
+  attr_writer :config
+
+end

data/lib/ads_savon/client.rb

@@ -0,0 +1,163 @@
+require "wasabi/document"
+require "httpi/request"
+require "akami"
+
+require "ads_savon/soap/xml"
+require "ads_savon/soap/request"
+require "ads_savon/soap/response"
+require "ads_savon/soap/request_builder"
+
+module GoogleAdsSavon
+
+  # = GoogleAdsSavon::Client
+  #
+  # GoogleAdsSavon::Client is the main object for connecting to a SOAP service.
+  class Client
+
+    # Initializes the GoogleAdsSavon::Client for a SOAP service. Accepts a +block+ which is evaluated in the
+    # context of this object to let you access the +wsdl+, +http+, and +wsse+ methods.
+    #
+    # == Examples
+    #
+    #   # Using a remote WSDL
+    #   client = GoogleAdsSavon::Client.new("http://example.com/UserService?wsdl")
+    #
+    #   # Using a local WSDL
+    #   client = GoogleAdsSavon::Client.new File.expand_path("../wsdl/service.xml", __FILE__)
+    #
+    #   # Directly accessing a SOAP endpoint
+    #   client = GoogleAdsSavon::Client.new do
+    #     wsdl.endpoint = "http://example.com/UserService"
+    #     wsdl.namespace = "http://users.example.com"
+    #   end
+    def initialize(wsdl_document = nil, &block)
+      self.config = GoogleAdsSavon.config.clone
+      wsdl.document = wsdl_document if wsdl_document
+
+      process 1, &block if block
+      wsdl.request = http
+    end
+
+    # Accessor for the <tt>GoogleAdsSavon::Config</tt>.
+    attr_accessor :config
+
+    # Returns the <tt>Wasabi::Document</tt>.
+    def wsdl
+      @wsdl ||= Wasabi::Document.new
+    end
+
+    # Returns the <tt>HTTPI::Request</tt>.
+    def http
+      @http ||= HTTPI::Request.new
+    end
+
+    # Returns the <tt>Akami::WSSE</tt> object.
+    def wsse
+      @wsse ||= Akami.wsse
+    end
+
+    # Executes a SOAP request for a given SOAP action. Accepts a +block+ which is evaluated in the
+    # context of the <tt>SOAP::RequestBuilder</tt> object to let you access its +soap+, +wsdl+,
+    # +http+ and +wsse+ methods.
+    #
+    # == Examples
+    #
+    #   # Calls a "getUser" SOAP action with the payload of "<userId>123</userId>"
+    #   client.request(:get_user) { soap.body = { :user_id => 123 } }
+    #
+    #   # Prefixes the SOAP input tag with a given namespace: "<wsdl:GetUser>...</wsdl:GetUser>"
+    #   client.request(:wsdl, "GetUser") { soap.body = { :user_id => 123 } }
+    #
+    #   # SOAP input tag with attributes: <getUser xmlns:wsdl="http://example.com">...</getUser>"
+    #   client.request(:get_user, "xmlns:wsdl" => "http://example.com")
+    def request(*args, &block)
+      raise ArgumentError, "GoogleAdsSavon::Client#request requires at least one argument" if args.empty?
+
+      options = extract_options(args)
+
+      request_builder = SOAP::RequestBuilder.new(options.delete(:input), options)
+      request_builder.wsdl = wsdl
+      request_builder.http = http.dup
+      request_builder.wsse = wsse.dup
+      request_builder.config = config.dup
+
+      post_configuration = lambda { process(0, request_builder, &block) if block }
+
+      response = request_builder.request(&post_configuration).response
+      http.set_cookies(response.http)
+
+      if wsse.verify_response
+        WSSE::VerifySignature.new(response.http.body).verify!
+      end
+
+      response
+    end
+
+    private
+
+    # Expects an Array of +args+ and returns a Hash containing the SOAP input,
+    # the namespace (might be +nil+), the SOAP action (might be +nil+),
+    # the SOAP body (might be +nil+), and a Hash of attributes for the input
+    # tag (which might be empty).
+    def extract_options(args)
+      attributes = Hash === args.last ? args.pop : {}
+      body = attributes.delete(:body)
+      soap_action = attributes.delete(:soap_action)
+
+      namespace_identifier = args.size > 1 ? args.shift.to_sym : nil
+      input = args.first
+
+      remove_blank_values(
+        :namespace_identifier => namespace_identifier,
+        :input                => input,
+        :attributes           => attributes,
+        :body                 => body,
+        :soap_action          => soap_action
+      )
+    end
+
+    # Processes a given +block+. Yields objects if the block expects any arguments.
+    # Otherwise evaluates the block in the context of +instance+.
+    def process(offset = 0, instance = self,  &block)
+      block.arity > 0 ? yield_objects(offset, instance, &block) : evaluate(instance, &block)
+    end
+
+    # Yields a number of objects to a given +block+ depending on how many arguments
+    # the block is expecting.
+    def yield_objects(offset, instance, &block)
+      to_yield = [:soap, :wsdl, :http, :wsse]
+      yield *(to_yield[offset, block.arity].map { |obj_name| instance.send(obj_name) })
+    end
+
+    # Evaluates a given +block+ inside +instance+. Stores the original block binding.
+    def evaluate(instance, &block)
+      original_self = eval "self", block.binding
+
+      # A proxy that attemps to make method calls on +instance+. If a NoMethodError is
+      # raised, the call will be made on +original_self+.
+      proxy = Object.new
+      proxy.instance_eval do
+        class << self
+          attr_accessor :original_self, :instance
+        end
+
+        def method_missing(method, *args, &block)
+          instance.send(method, *args, &block)
+        rescue NoMethodError
+          original_self.send(method, *args, &block)
+        end
+      end
+
+      proxy.instance = instance
+      proxy.original_self = original_self
+
+      proxy.instance_eval &block
+    end
+
+    # Removes all blank values from a given +hash+.
+    def remove_blank_values(hash)
+      hash.delete_if { |_, value| value.respond_to?(:empty?) ? value.empty? : !value }
+    end
+
+  end
+end

data/lib/ads_savon/config.rb

@@ -0,0 +1,46 @@
+require "ads_savon/logger"
+require "ads_savon/null_logger"
+require "ads_savon/hooks/group"
+require "ads_savon/soap"
+
+module GoogleAdsSavon
+  Config = Struct.new(:_logger, :pretty_print_xml, :raise_errors, :soap_version, :env_namespace, :soap_header) do
+
+    def self.default
+      config = new
+      config._logger = Logger.new
+      config.raise_errors = true
+      config.soap_version = SOAP::DEFAULT_VERSION
+      config
+    end
+
+    alias_method :logger, :_logger
+
+    def logger=(logger)
+      _logger.subject = logger
+    end
+
+    def log_level=(level)
+      _logger.level = level
+    end
+
+    def log=(log)
+      if log == true
+        self._logger = Logger.new
+      else
+        self._logger = NullLogger.new
+      end
+    end
+
+    def hooks
+      @hooks ||= Hooks::Group.new
+    end
+
+    def clone
+      config = super
+      config._logger = config._logger.clone
+      config
+    end
+
+  end
+end

data/lib/ads_savon/core_ext/string.rb

@@ -0,0 +1,30 @@
+require "ads_savon/soap"
+
+module GoogleAdsSavon
+  module CoreExt
+    module String
+
+      def self.included(base)
+        unless "savon".respond_to?(:snakecase)
+          base.send(:include, Extension)
+        end
+      end
+
+      module Extension
+        def snakecase
+          str = dup
+          str.gsub! /::/, '/'
+          str.gsub! /([A-Z]+)([A-Z][a-z])/, '\1_\2'
+          str.gsub! /([a-z\d])([A-Z])/, '\1_\2'
+          str.tr! ".", "_"
+          str.tr! "-", "_"
+          str.downcase!
+          str
+        end
+      end
+
+    end
+  end
+end
+
+String.send :include, GoogleAdsSavon::CoreExt::String

data/lib/ads_savon/error.rb

@@ -0,0 +1,6 @@
+module GoogleAdsSavon
+
+  # Base class for GoogleAdsSavon errors.
+  class Error < RuntimeError; end
+
+end

data/lib/ads_savon/hooks/group.rb

@@ -0,0 +1,68 @@
+require "ads_savon/hooks/hook"
+
+module GoogleAdsSavon
+  module Hooks
+
+    # = GoogleAdsSavon::Hooks::Group
+    #
+    # Manages a list of hooks.
+    class Group
+
+      # Accepts an Array of +hooks+ to start with.
+      def initialize(hooks = [])
+        @hooks = hooks
+      end
+
+      # Returns whether this group contains hooks.
+      def empty?
+        hooks.empty?
+      end
+
+      # Returns the number of hooks in this group.
+      def count
+        hooks.count
+      end
+
+      # Adds a new hook.
+      def define(id, hook, &block)
+        hooks << Hook.new(id, hook, &block)
+      end
+
+      # Removes hooks matching the given +ids+.
+      def reject(*ids)
+        ids = ids.flatten
+        hooks.reject! { |hook| ids.include? hook.id }
+      end
+
+      # Fire a given +hook+ with any given +args+.
+      def fire(hook, *args, &callback)
+        callable = select(hook)
+
+        if callable.empty?
+          callback.call
+        else
+          args.unshift(callback) if callback
+          callable.call(*args)
+        end
+      end
+
+      # Calls the hooks with the given +args+ and returns the
+      # value of the last hooks.
+      def call(*args)
+        hooks.inject(nil) { |memo, hook| hook.call(*args) }
+      end
+
+      private
+
+      def hooks
+        @hooks ||= []
+      end
+
+      # Returns a new group for a given +hook+.
+      def select(hook)
+        Group.new hooks.select { |h| h.hook == hook }
+      end
+
+    end
+  end
+end