google-dfp-api 0.2.0

data/COPYING

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2008 Google Inc.
+
+   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.

data/ChangeLog

@@ -0,0 +1,10 @@
+0.2.0:
+  - Require google-ads-common 0.3.0 or later from now on;
+  - Support for Savon backend 0.9.1.
+
+0.1.1:
+  - Exception generation and error handling.
+  - DFP API v201101 support.
+
+0.1.0:
+  - Initial version with minimal functionality.

data/README

@@ -0,0 +1,210 @@
+= Google's DoubleClick For Publishers API Ruby Client Library
+
+Google's DoubleClick For Publishers API service lets developers design computer
+programs that interact directly with the DFP platform. With these applications,
+advertisers and third parties can more efficiently -- and creatively -- manage
+their large or complex Publisher Display Ads accounts.
+
+The DFP API Ruby Client Library makes it easy to write Ruby clients to
+programmatically access Publisher Display Ads accounts. The client library is
+available as a Ruby gem or gzipped tarball. It depends on the google-ads-common
+library which is base for all Google Ads APIs for Ruby.
+
+
+== What's in the client library?
+
+The client library provides full access to all the functionality of the
+DoubleClick For Publishers API web services plus more. It includes:
+
+  - DfpApi::Api class: The Api class provides methods for setting credentials
+    for accessing DFP accounts as well as for creating instances of the DFP
+    Service classes.
+
+  - Ruby native objects support: All data is accepted and returned as Ruby
+    hashes and arrays. No complex types are required!
+
+  - Ruby naming conversions: all method and field names are converted to Ruby
+    standard snake_case format.
+
+  - Helpful utilities: The utilities designed as service extensions help you to
+    schedule and run reports and import images into the client library.
+
+  - Logger support: The library provides simple methods for logging the SOAP XML
+    messages of all requests and responses as well as HTTP headers.
+
+  - ApiException class: The Ruby client library converts XML faults into
+    ApiExceptions where possible. For an example of how to use ApiException, see
+    the error_handling.rb sample code.
+
+  - Examples: The Ruby client library comes with code samples in the "examples/"
+    directory. We encourage you to use code samples to get started writing your
+    own application. All the code samples are runnable out of the box, but you
+    will have to set your credentials in "~/dfp_api.yml".
+
+
+= How to get started
+
+== Installation
+
+google-dfp-api is a Ruby gem. See http://docs.rubygems.org/read/book/1
+
+Install it using the gem install command:
+  $ gem install google-dfp-api
+
+or if you downloaded the gem package manually, use:
+  $ gem install --local google-dfp-api-VERSION.gem
+
+
+== Using the library
+
+In order to use the library you need to include its modules:
+  require 'google-dfp-api'
+
+Depending on your configuration you might also need to explicitely require
+the rubygems library first:
+  require 'rubygems'
+
+Then, library object could be instantiated:
+  dfp = DfpApi::Api.new
+
+The default constructor will load library configuration from '~/dfp_api.yml'
+file. Alternatively, you can pass a configuration hash directly to the
+constructor:
+  dfp = DfpApi::Api.new({
+     :authentication => {
+         :method => 'ClientLogin',
+         :application_name => 'Ruby DFP Sample',
+         :email => 'user@domain.com',
+         :password => 'PASSWORD'
+     },
+     :service => {
+       :environment => 'Sandbox'
+     }
+   })
+
+An example of configuration file is available as part of this library.
+
+
+== Accessing services
+
+Once the library object is created you can request services with a 'service'
+method:
+  user_service = dfp.service(:UserService, <API_VERSION>)
+
+where <API_VERSION> is required version of DFP API, e.g. :v201101.
+
+Then you should be able to execute service methods:
+
+  # Create statement for all users up to 500 max.
+  statement = {:query => "LIMIT 500"}
+
+  # Execute request and get the response.
+  page = user_service.get_users_by_statement(statement)
+
+In case of paged results, the requested objects are available as ':results' key:
+
+  # Print details about each user in results page.
+  page[:results].each_with_index do |user|
+    puts "[%d] name: %s, email: %s" % [user[:id], user[:name], user[:email]]
+  end
+
+All object fields are automatically parsed by the library to convert types to
+native ones (Integer, Float etc.) where applicable. The field names are also
+converted to symbols in Ruby native snake_case format:
+  "displayName" -> :display_name
+
+
+== Running examples
+
+Before running examples, please ensure that your dfp.yml is filled in and
+placed in your home directory.
+
+Examples can be run by executing by running:
+  $ ruby <example_name>
+
+from the "examples/<version>/<service_name>" directory i.e.
+
+  $ cd examples/v201101/user_service
+  $ ruby get_all_users.rb
+
+Some examples require modification to be functional, like create_order example
+needs Advertiser, Trafficker and Salesperson ids to be filled in.
+
+
+== How do I enable logging?
+
+It is often useful to see a trace of the raw SOAP XML being sent and received.
+The quickest way of achieving this when debugging your application is by setting
+the library.log_level configuration variable to 'DEBUG':
+   config[:library] = {
+     :log_level => 'DEBUG'
+   }
+or via configuration file (see example).
+
+This will output the SOAP XML to STDOUT, which will usually show up in your
+terminal window.
+
+There's also an option of logging requests and XML to a file. In order to enable
+this, you should create a standard Logger object and pass it to the library:
+   require 'logger'
+   logger = Logger.new('path/to/log_filename')
+   logger.level = Logger::DEBUG
+   adwords = AdwordsApi::Api.new
+   adwords.logger = logger
+
+Request details are logged at the INFO log level, while raw HTTP headers and XML
+dumps are logged at the DEBUG log level. For more details on using Logger refer
+to the Ruby Logger documentation.
+
+
+== What if I am behind an HTTP Proxy server?
+
+The Ruby Client Libraries does not support proxy servers in this version but it
+is planned for next releases.
+
+
+= External dependencies:
+
+External dependencies should be pulled automatically on gem install. Here is the
+list though:
+
+  - Google Ads Common library (google-ads-common-0.3.0);
+  - Savon 'the heavy metal Ruby SOAP client' (savon-0.9.1).
+
+
+= Where do I submit bug reports and feature requests?
+
+Bug reports and feature requests can be posted on the library page:
+
+  http://code.google.com/p/google-api-ads-ruby/issues
+
+Questions can be asked on forum
+
+  http://groups.google.com/group/google-doubleclick-for-publishers-api/
+
+
+= Copyright/License Info
+
+== License
+
+Copyright 2011, Google Inc. All Rights Reserved.
+
+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.
+
+
+== Authors
+
+Author:
+    api.dklimkin@gmail.com (Danial Klimkin)
+
+Maintainer:
+    api.dklimkin@gmail.com (Danial Klimkin)

data/Rakefile

@@ -0,0 +1,83 @@
+#!/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.
+#
+# DFP API Rakefile
+#
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'lib/dfp_api/api_config'
+
+# Google common ads library used for wrapper code generation
+gem 'google-ads-common'
+require 'ads_common/build/savon_generator'
+
+files = FileList["{lib,examples}/**/*", "Rakefile"].to_a
+tests = FileList["{test}/**/Test*.rb"].to_a
+docs = ['README', 'COPYING', 'ChangeLog']
+
+spec = Gem::Specification.new do |s|
+  s.name = 'google-dfp-api'
+  s.version = DfpApi::ApiConfig::CLIENT_LIB_VERSION
+  s.author = 'Danial Klimkin'
+  s.email = 'api.dklimkin@gmail.com'
+  s.homepage = 'http://code.google.com/p/google-api-ads-ruby/'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Ruby Client libraries for DFP API'
+  s.description = "%s is a DFP API client library for Ruby" % s.name
+  s.files = files
+  s.require_path = 'lib'
+  s.test_files = tests
+  s.has_rdoc = true
+  s.extra_rdoc_files = docs
+  s.add_dependency('google-ads-common', '~> 0.3.0')
+  s.add_dependency('savon', '~> 0.9.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/**/test*.rb"]
+end
+
+desc 'Default target - build'
+task :default => [:generate, :package]
+
+desc 'Generate API stubs only'
+task :generate do
+  logger = Logger.new(STDOUT)
+  logger.level = Logger::INFO
+  api_config = DfpApi::ApiConfig
+  versions = api_config.versions()
+  versions.each do |version|
+    code_path = "lib/%s/%s" % [api_config.api_path, version]
+    wsdls = DfpApi::ApiConfig.get_wsdls( version )
+    wsdls.each do |service_name, wsdl_url|
+      logger.info("Processing %s at [%s]..." % [service_name, wsdl_url])
+      module_name = "%s::%s::%s" % [api_config.api_name, version.to_s.upcase,
+                                    service_name]
+      generator = AdsCommon::Build::SavonGenerator.new(wsdl_url, code_path,
+                      service_name, module_name)
+      generator.process_wsdl()
+    end
+  end
+end