google-adx-buyer-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 2011 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,2 @@
+0.2.0:
+  - Initial release.

data/README

@@ -0,0 +1,208 @@
+= Google AdWords and DoubleClick Ad Exchange Buyer Client Library
+
+Welcome to the next generation Google-developed Ruby client library for the
+AdWords and DoubleClick Ad Exchange Buyer API!
+
+Please note that this is an early PREVIEW of the client library, still under
+development.
+
+It contains full support for v13, v200909, v201003, v201008 and v201101, with
+full stubs, and a simplified programming interface that lets you handle
+everything in native Ruby collections, instead of forcing you to deal with SOAP
+library-generated objects.
+
+
+= Docs for Users
+
+== 1 - Installation:
+
+google-adwords-api and google-adx-buyer-api are ruby gems.
+  See http://docs.rubygems.org/read/book/1
+
+Install them using the gem install command:
+   $ gem install --remote google-adwords-api
+   $ gem install --remote google-adx-buyer-api
+
+Please note the google-adx-buyer-api gem contains only DoubleClick Ad Exchange
+Buyer client library examples. You need the AdWords library in order to use it
+which is installed automatically as a dependency.
+
+The following gem libraries are required:
+- soap4r v1.5.8
+- httpclient v2.1.2 or greater
+- google-ads-common v0.2.1 or later.
+
+
+== 2 - Using the client library:
+
+It's pretty easy to use.
+See http://docs.rubygems.org/read/chapter/3#page70 for how to set the rubygem
+environment.
+   $ export RUBYOPT=rubygems
+or
+   $ ruby -rubygems my_program_that_uses_gems
+
+If you are running Ruby 1.8 and do not use the rubygems option, you need to add
+   require 'rubygems'
+at the beginning of your programs.
+
+Then:
+   gem 'google-adwords-api'
+   require 'adwords_api'
+
+   adwords = AdwordsApi::Api.new
+creates an Api object that will grant you access to all the services for all of
+the currently supported vesions of the APIs. It uses a config file in:
+ENV['HOME']/adwords_api.yml to read all of your configurations.
+There is an example configuration file shipped with these libraries.
+
+You can also pass API a manually constructed config hash like:
+   adwords = AdwordsApi::Api.new({
+     :authentication => {
+         :method => 'ClientLogin',
+         :developer_token => 'DEVELOPER_TOKEN',
+         :user_agent => 'Ruby Sample',
+         :password => 'PASSWORD',
+         :email => 'user@domain.com'
+         :client_email => 'user2@domain.com'
+     },
+     :service => {
+       :environment => 'Production'
+     }
+   })
+
+Then, just specify which service you're looking to use, and which version:
+   campaign_srv = adwords.service(:CampaignService, :v201101)
+
+and you should now be able to just use the API methods in the object you were
+returned:
+   campaigns = campaign_srv.get({})    # Empty selector to get all
+
+See the code in the examples directory for working examples you can build from.
+
+*Note*: if your setup requires you to send connections through a proxy server,
+please set the appropriate options in the config file or config hash. E.g.:
+   config[:connection] = {
+     :proxy => 'http://user:password@proxy_hostname:8080/path'
+   }
+
+
+=== 2.1 - Ruby names for a Ruby library:
+
+In order to make things more Ruby-like for our Ruby developers, we've renamed
+API objects and methods to more closely match Ruby conventions. This means using
+snake_case for methods and parameters, and UpperCamelCase for class names.
+
+For example, the 'getReportFields' method of the ReportDefinitionService is
+named 'get_report_fields' in the client library. You invoke it by doing:
+   response = report_def_srv.get_report_fields(report_type)
+
+The 'get' method, on the other hand, returns a ReportDefinitionPage object which
+has an 'entries' and a 'total_num_entries' field. So, to access the return
+values, you would do:
+   response = report_def_srv.get(selector)
+   num_entries = response[:total_num_entries]
+
+Essentially, all you have to do is follow Ruby conventions, and the library will
+do the rest. All of the examples are written following this standard.
+
+If, however, you would prefer to use the names as provided in the AdWords
+documentation, please disable the 'use_ruby_names' option under the 'service'
+category in the config:
+   config[:service][:use_ruby_names] = false
+
+Disabling Ruby names is an experimental feature, and it is not recommended.
+
+
+=== 2.2 - Using the Sandbox:
+
+In order to use the sandbox, make sure that the 'environment' parameter under
+'service' in the configuration is set to Sandbox.
+   config[:service] = {
+     :environment => 'Sandbox'
+   }
+
+
+=== 2.3 - 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 ADWORDSAPI_DEBUG environment variable to TRUE; e.g. in the bash shell:
+   $ export ADWORDSAPI_DEBUG=true
+or from your Ruby code:
+   ENV['ADWORDSAPI_DEBUG'] = 'true'
+
+This will output the SOAP XML to stderr, which will usually show up in your
+terminal window.
+
+There's also the option of logging requests and XML to files. In order to enable
+this, you should use the log_to_file method of the loggers inside your
+AdwordsApi::Api object:
+   adwords = AdwordsApi::Api.new
+   adwords.request_logger.log_to_file
+   adwords.xml_logger.log_to_file
+
+The first logs the units spent and the requests made, whereas the second logs
+the full SOAP XML being sent and received over the wire. These will be written
+to the current directory by default, but you can specify another directory as an
+optional parameter to log_to_file:
+   adwords.request_logger.log_to_file('/var/log/my_app/')
+   adwords.xml_logger.log_to_file('/var/log/my_app/')
+
+The files will be named request_info and soap_xml, respectively.
+
+
+= Docs for Developers
+
+== Rake targets
+
+ $ rake getwsdl
+to get the wsdl files
+
+ $ rake generate
+to regenerate the bindings if needed
+
+ $ rake package
+to package the gem and create a release
+
+ $ rake test
+to run unit tests on the library
+
+
+== 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/adwords-api
+
+
+= Copyright/License Info
+
+== Licence
+
+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
+
+Authors:
+    api.sgomes (Sérgio Gomes)
+    api.dklimkin@gmail.com (Danial Klimkin)
+
+Maintainer:
+    api.dklimkin@gmail.com (Danial Klimkin)

data/Rakefile

@@ -0,0 +1,50 @@
+#!/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.
+#
+# DoubleClick Ad Exchange Buyer API Rakefile
+#
+
+require 'rubygems'
+require 'rake/gempackagetask'
+
+files = FileList["{examples}/**/*", "Rakefile"].to_a
+docs = ['README', 'COPYING', 'ChangeLog']
+
+spec = Gem::Specification.new do |s|
+  s.name = 'google-adx-buyer-api'
+  s.version = '0.2.0'
+  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 DoubleClick Ad Exchange Buyer API'
+  s.description = ("%s is a DoubleClick Ad Exchange API Buyer API client " +
+      "library for Ruby") % s.name
+  s.files = files
+  s.has_rdoc = true
+  s.extra_rdoc_files = docs
+  s.add_dependency('google-adwords-api', '~> 0.1.2')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end
+
+desc 'Default target - package'
+task :default => :package