n8-adcenter-client 0.1.0 → 8.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,12 @@
+=== 7.0.3 / 2011-01-31
+
+* Version 7.0.3
+  
+  * fixed namespace clobbering when importing adcenter_client
+
+=== 7.0.0 / 2011-01-23
+
+* Initial Release
+
+  * seems to work for adCenter API v7
+

data/Manifest.txt

@@ -0,0 +1,44 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile.rb
+TODO
+VERSION
+bin/get_adcenter_account_info.rb
+devel/gen_wsdl_drivers.rb
+devel/wsdl.yml
+lib/AdministrationServiceDriver.rb
+lib/AdministrationServiceMappingRegistry.rb
+lib/CampaignManagementServiceDriver.rb
+lib/CampaignManagementServiceMappingRegistry.rb
+lib/CustomerBillingServiceDriver.rb
+lib/CustomerBillingServiceMappingRegistry.rb
+lib/CustomerManagementServiceDriver.rb
+lib/CustomerManagementServiceMappingRegistry.rb
+lib/ReportingServiceDriver.rb
+lib/ReportingServiceMappingRegistry.rb
+lib/SecureDataManagementServiceDriver.rb
+lib/SecureDataManagementServiceMappingRegistry.rb
+lib/adcenter_client.rb
+lib/adcenter_service.rb
+lib/adcenter_wrapper_entities.rb
+lib/administration_service.rb
+lib/campaign_management_service.rb
+lib/custom_assertions.rb
+lib/custom_exceptions.rb
+lib/customer_billing_service.rb
+lib/customer_management_service.rb
+lib/defaultDriver.rb
+lib/defaultMappingRegistry.rb
+lib/notification_management.rb
+lib/reporting_service.rb
+lib/secure_data_management_service.rb
+tasks/doctask.rake
+tasks/testtask.rake
+test/adcenter_client_test.rb
+test/administration_service_test.rb
+test/customer_management_service_test.rb
+test/report_service_test.rb
+test/test_credentials.yml-sample
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,82 @@
+= adcenter_client
+
+* scm:: (https://github.com/bleechack/adcenter-client)
+* rubyforge:: (http://rubyforge.org/projects/adcenter-client/)
+
+== DESCRIPTION:
+
+Interface to Microsoft (Yahoo!) adCenter SOAP API
+
+== FEATURES/PROBLEMS:
+
+* adds a wrapper around MSN adCenter SOAP API for ruby use
+* entities are created directly from the WSDL using wsdl2ruby.rb
+
+== SYNOPSIS:
+
+  credentials = {
+    'UserName' => options[:username],
+    'Password' => options[:password],
+    'ApplicationToken' => '',
+    'DeveloperToken' => options[:token],
+    'CustomerId' => options[:customerid],
+    'CustomerAccountId' => options[:accountid] || ""
+  }
+
+  @acc = AdCenterClient.new(credentials)
+  @svc = @acc.customer_management_service
+  @entities = @acc.entities
+
+  req = @entities::GetAccountsInfoRequest.new(credentials[:customerid])
+  res = @svc.getAccountsInfo(req)
+
+== REQUIREMENTS:
+
+  * soap4r
+
+== INSTALL:
+
+  $ sudo gem install adcenter-client
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake adcenter-client
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== AUTHOR:
+
+{Josh Peck}[jmp@joshpeck.org]
+
+== LICENSE:
+
+(The BSD License)
+
+Copyright (c) 2011, JOSH PECK
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <ORGANIZATION> nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile.rb

@@ -0,0 +1,30 @@
+# -*- ruby -*-
+load 'tasks/testtask.rake'
+load 'tasks/doctask.rake'
+
+require 'rubygems'
+# require 'rubyforge'
+require 'hoe'
+
+# Hoe.plugin :compiler
+# Hoe.plugin :gem_prelude_sucks
+Hoe.plugin :gemcutter
+# Hoe.plugin :inline
+# Hoe.plugin :racc
+# Hoe.plugin :rubyforge
+# Hoe.plugin :rubyforge
+
+Hoe.spec 'n8-adcenter-client' do |h|
+  h.summary = "SOAP client for MSN adCenter"
+  h.email = "jmp@joshpeck.org"
+  h.author = "Josh Peck"
+  h.url = "http://bleechack.github.com/adcenter-client/"
+  h.description = h.paragraphs_of('README.txt', 2..3).join("\n\n") 
+  h.changes = h.paragraphs_of('History.txt', 0..4).join("\n\n") 
+  h.remote_rdoc_dir = 'adcenter-client' 
+  h.developer('Josh Peck', 'jmp@joshpeck.org')
+  h.rubyforge_name = 'n8-adcenter-client'
+  h.extra_deps << [ 'soap4r', '>= 1.5.8' ]
+end
+
+# vim: syntax=ruby

data/TODO

@@ -0,0 +1,12 @@
+= TODO
+
+== Automated Testing of Services
+
+* add sandbox to test suite to permit destructive tests
+* test all AdministrationService operations
+* test all CampaignManagementService operations
+* test all CustomerBillingService operations
+* test all CustomerManagementService operations
+* test all NotificationManagement operations
+* test all ReportingService operations
+* test all SecureDataManagementService operations

data/VERSION

@@ -0,0 +1 @@
+7.0.3

data/bin/get_adcenter_account_info.rb

@@ -0,0 +1,45 @@
+#! /usr/bin/env ruby
+$: << File.expand_path(File.dirname(__FILE__) + "/../lib/")
+
+require 'optparse'
+require 'yaml'
+require 'adcenter_client'
+
+$DEBUG = false
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: get_adcenter_account_info.rb [options]"
+  opts.on("-u", "--username=LOGIN", "API account username") do |v|
+    options[:username] = v.to_s
+  end
+  opts.on("-p", "--password=PASSWORD", "API account password") do |v|
+    options[:password] = v.to_s
+  end
+  opts.on("-t", "--token=DEVTOKEN", "API account developer token") do |v|
+    options[:token] = v.to_s
+  end
+  opts.on("-c", "--customerid=n", "API account customer id") do |v|
+    options[:customerid] = v.to_i.to_s
+  end
+  opts.on("-a", "--accountid=n", "API account customer account id (optional)") do |v|
+    options[:accountid] = v.to_i.to_s
+  end
+end.parse!
+
+credentials = {
+  'UserName' => options[:username],
+  'Password' => options[:password],
+  'ApplicationToken' => '',
+  'DeveloperToken' => options[:token],
+  'CustomerId' => options[:customerid],
+  'CustomerAccountId' => options[:accountid] || ""
+}
+
+@acc = AdCenterClient.new(credentials, nil, false)
+@svc = @acc.customer_management_service
+@entities = @acc.entities
+
+req = @entities::GetAccountsInfoRequest.new(credentials[:customerid])
+res = @svc.getAccountsInfo(req)
+puts res.to_yaml

data/devel/gen_wsdl_drivers.rb

@@ -0,0 +1,26 @@
+#! /usr/bin/env ruby
+
+require 'optparse'
+require 'yaml'
+
+DEFAULT_DESTINATION_DIR = File.expand_path(File.dirname(__FILE__) + '/lib-devel/')
+DEFAULT_WSDL_FILE = File.expand_path(File.dirname(__FILE__) + '/wsdl.yml')
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: gen_drivers.rb [options]"
+  opts.on("-d", "--destination=DIRECTORY", "destination directory for generated files") do |v|
+    options[:destination_dir] = File.expand_path(v)
+  end
+  opts.on("-w", "--wsdl=FILE", "file containing WSDL endpoints in YAML") do |v|
+    options[:wsdl_file] = File.expand_path(v)
+  end
+end.parse!
+
+destination_dir = options[:destination_dir] ? options[:destination_dir].to_s : DEFAULT_DESTINATION_DIR
+wsdl_file = options[:wsdl_file] ? options[:wsdl_file].to_s : DEFAULT_WSDL_FILE
+wsdls = YAML::load_file(wsdl_file)
+wsdls['production'].each do |service, endpoint|
+  puts "Working on #{service} [#{endpoint}]..."
+  `mkdir -p #{destination_dir} && cd #{destination_dir} && wsdl2ruby.rb --module_path AdCenterWrapper --type client --wsdl '#{endpoint}'`
+end

data/devel/wsdl.yml

@@ -0,0 +1,19 @@
+---
+production:
+  ad_intelligence_service: https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/AdIntelligenceService.svc?wsdl
+  administration_service: https://adcenterapi.microsoft.com/Api/Advertiser/v8/Administration/AdministrationService.svc?wsdl
+  campaign_management_service: https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementService.svc?wsdl
+  customer_billing_service: https://sharedservices.adcenterapi.microsoft.com/Api/Billing/v8/CustomerBillingService.svc?wsdl
+  customer_management_service: https://sharedservices.adcenterapi.microsoft.com/Api/CustomerManagement/v8/CustomerManagementService.svc?wsdl
+  notification_service: https://sharedservices.adcenterapi.microsoft.com/Api/Notification/v8/NotificationService.svc?wsdl
+  optimizer_service: https://adcenterapi.microsoft.com/Api/Advertiser/v8/Optimizer/OptimizerService.svc?wsdl
+  reporting_service: https://adcenterapi.microsoft.com/Api/Advertiser/v8/Reporting/ReportingService.svc?wsdl
+sandbox:
+  ad_intelligence_service: ~
+  administration_service: ~
+  campaign_management_service: ~
+  customer_billing_service: ~
+  customer_management_service: ~
+  notification_service: ~
+  optimizer_service: ~
+  reporting_service: ~

data/lib/AdministrationServiceDriver.rb

@@ -0,0 +1,59 @@
+require 'AdministrationService.rb'
+require 'AdministrationServiceMappingRegistry.rb'
+require 'soap/rpc/driver'
+
+module AdCenterWrapper
+
+class IAdministrationService < ::SOAP::RPC::Driver
+  DefaultEndpointUrl = "https://adcenterapi.microsoft.com/Api/Advertiser/V8/Administration/AdministrationService.svc"
+
+  Methods = [
+    [ "GetAssignedQuota",
+      "getAssignedQuota",
+      [ ["in", "parameters", ["::SOAP::SOAPElement", "https://adcenter.microsoft.com/v8", "GetAssignedQuotaRequest"]],
+        ["out", "parameters", ["::SOAP::SOAPElement", "https://adcenter.microsoft.com/v8", "GetAssignedQuotaResponse"]] ],
+      { :request_style =>  :document, :request_use =>  :literal,
+        :response_style => :document, :response_use => :literal,
+        :faults => {"AdCenterWrapper::AdApiFaultDetailFault"=>{:encodingstyle=>"document", :use=>"literal", :ns=>"https://adcenter.microsoft.com/v8", :namespace=>nil, :name=>"AdApiFaultDetailFault"}} }
+    ],
+    [ "GetRemainingQuota",
+      "getRemainingQuota",
+      [ ["in", "parameters", ["::SOAP::SOAPElement", "https://adcenter.microsoft.com/v8", "GetRemainingQuotaRequest"]],
+        ["out", "parameters", ["::SOAP::SOAPElement", "https://adcenter.microsoft.com/v8", "GetRemainingQuotaResponse"]] ],
+      { :request_style =>  :document, :request_use =>  :literal,
+        :response_style => :document, :response_use => :literal,
+        :faults => {"AdCenterWrapper::AdApiFaultDetailFault"=>{:encodingstyle=>"document", :use=>"literal", :ns=>"https://adcenter.microsoft.com/v8", :namespace=>nil, :name=>"AdApiFaultDetailFault"}} }
+    ]
+  ]
+
+  def initialize(endpoint_url = nil)
+    endpoint_url ||= DefaultEndpointUrl
+    super(endpoint_url, nil)
+    self.mapping_registry = AdministrationServiceMappingRegistry::EncodedRegistry
+    self.literal_mapping_registry = AdministrationServiceMappingRegistry::LiteralRegistry
+    init_methods
+  end
+
+private
+
+  def init_methods
+    Methods.each do |definitions|
+      opt = definitions.last
+      if opt[:request_style] == :document
+        add_document_operation(*definitions)
+      else
+        add_rpc_operation(*definitions)
+        qname = definitions[0]
+        name = definitions[2]
+        if qname.name != name and qname.name.capitalize == name.capitalize
+          ::SOAP::Mapping.define_singleton_method(self, qname.name) do |*arg|
+            __send__(name, *arg)
+          end
+        end
+      end
+    end
+  end
+end
+
+
+end

data/lib/AdministrationServiceMappingRegistry.rb

@@ -0,0 +1,153 @@
+require 'adcenter_wrapper_entities'
+require 'AdministrationService.rb'
+require 'soap/mapping'
+
+module AdCenterWrapper
+
+module AdministrationServiceMappingRegistry
+  EncodedRegistry = ::SOAP::Mapping::EncodedRegistry.new
+  LiteralRegistry = ::SOAP::Mapping::LiteralRegistry.new
+  NsAdapiMicrosoftCom = "https://adapi.microsoft.com"
+  NsV8 = "https://adcenter.microsoft.com/v8"
+
+  EncodedRegistry.register(
+    :class => AdCenterWrapper::AdApiFaultDetail,
+    :schema_type => XSD::QName.new(NsAdapiMicrosoftCom, "AdApiFaultDetail"),
+    :schema_basetype => XSD::QName.new(NsAdapiMicrosoftCom, "ApplicationFault"),
+    :schema_element => [
+      ["trackingId", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "TrackingId")], [0, 1]],
+      ["errors", ["AdCenterWrapper::ArrayOfAdApiError", XSD::QName.new(NsAdapiMicrosoftCom, "Errors")], [0, 1]]
+    ]
+  )
+
+  EncodedRegistry.register(
+    :class => AdCenterWrapper::ApplicationFault,
+    :schema_type => XSD::QName.new(NsAdapiMicrosoftCom, "ApplicationFault"),
+    :schema_element => [
+      ["trackingId", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "TrackingId")], [0, 1]]
+    ]
+  )
+
+  EncodedRegistry.register(
+    :class => AdCenterWrapper::ArrayOfAdApiError,
+    :schema_type => XSD::QName.new(NsAdapiMicrosoftCom, "ArrayOfAdApiError"),
+    :schema_element => [
+      ["adApiError", ["AdCenterWrapper::AdApiError[]", XSD::QName.new(NsAdapiMicrosoftCom, "AdApiError")], [0, nil]]
+    ]
+  )
+
+  EncodedRegistry.register(
+    :class => AdCenterWrapper::AdApiError,
+    :schema_type => XSD::QName.new(NsAdapiMicrosoftCom, "AdApiError"),
+    :schema_element => [
+      ["code", ["SOAP::SOAPInt", XSD::QName.new(NsAdapiMicrosoftCom, "Code")], [0, 1]],
+      ["detail", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "Detail")], [0, 1]],
+      ["errorCode", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "ErrorCode")], [0, 1]],
+      ["message", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "Message")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::AdApiFaultDetail,
+    :schema_type => XSD::QName.new(NsAdapiMicrosoftCom, "AdApiFaultDetail"),
+    :schema_basetype => XSD::QName.new(NsAdapiMicrosoftCom, "ApplicationFault"),
+    :schema_element => [
+      ["trackingId", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "TrackingId")], [0, 1]],
+      ["errors", ["AdCenterWrapper::ArrayOfAdApiError", XSD::QName.new(NsAdapiMicrosoftCom, "Errors")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::ApplicationFault,
+    :schema_type => XSD::QName.new(NsAdapiMicrosoftCom, "ApplicationFault"),
+    :schema_element => [
+      ["trackingId", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "TrackingId")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::ArrayOfAdApiError,
+    :schema_type => XSD::QName.new(NsAdapiMicrosoftCom, "ArrayOfAdApiError"),
+    :schema_element => [
+      ["adApiError", ["AdCenterWrapper::AdApiError[]", XSD::QName.new(NsAdapiMicrosoftCom, "AdApiError")], [0, nil]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::AdApiError,
+    :schema_type => XSD::QName.new(NsAdapiMicrosoftCom, "AdApiError"),
+    :schema_element => [
+      ["code", ["SOAP::SOAPInt", XSD::QName.new(NsAdapiMicrosoftCom, "Code")], [0, 1]],
+      ["detail", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "Detail")], [0, 1]],
+      ["errorCode", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "ErrorCode")], [0, 1]],
+      ["message", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "Message")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::GetAssignedQuotaRequest,
+    :schema_name => XSD::QName.new(NsV8, "GetAssignedQuotaRequest"),
+    :schema_element => []
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::GetAssignedQuotaResponse,
+    :schema_name => XSD::QName.new(NsV8, "GetAssignedQuotaResponse"),
+    :schema_element => [
+      ["assignedQuota", ["SOAP::SOAPLong", XSD::QName.new(NsV8, "AssignedQuota")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::GetRemainingQuotaRequest,
+    :schema_name => XSD::QName.new(NsV8, "GetRemainingQuotaRequest"),
+    :schema_element => []
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::GetRemainingQuotaResponse,
+    :schema_name => XSD::QName.new(NsV8, "GetRemainingQuotaResponse"),
+    :schema_element => [
+      ["remainingQuota", ["SOAP::SOAPLong", XSD::QName.new(NsV8, "RemainingQuota")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::AdApiFaultDetail,
+    :schema_name => XSD::QName.new(NsAdapiMicrosoftCom, "AdApiFaultDetail"),
+    :schema_element => [
+      ["trackingId", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "TrackingId")], [0, 1]],
+      ["errors", ["AdCenterWrapper::ArrayOfAdApiError", XSD::QName.new(NsAdapiMicrosoftCom, "Errors")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::ApplicationFault,
+    :schema_name => XSD::QName.new(NsAdapiMicrosoftCom, "ApplicationFault"),
+    :schema_element => [
+      ["trackingId", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "TrackingId")], [0, 1]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::ArrayOfAdApiError,
+    :schema_name => XSD::QName.new(NsAdapiMicrosoftCom, "ArrayOfAdApiError"),
+    :schema_element => [
+      ["adApiError", ["AdCenterWrapper::AdApiError[]", XSD::QName.new(NsAdapiMicrosoftCom, "AdApiError")], [0, nil]]
+    ]
+  )
+
+  LiteralRegistry.register(
+    :class => AdCenterWrapper::AdApiError,
+    :schema_name => XSD::QName.new(NsAdapiMicrosoftCom, "AdApiError"),
+    :schema_element => [
+      ["code", ["SOAP::SOAPInt", XSD::QName.new(NsAdapiMicrosoftCom, "Code")], [0, 1]],
+      ["detail", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "Detail")], [0, 1]],
+      ["errorCode", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "ErrorCode")], [0, 1]],
+      ["message", ["SOAP::SOAPString", XSD::QName.new(NsAdapiMicrosoftCom, "Message")], [0, 1]]
+    ]
+  )
+
+end
+
+end