ads_common: A Ruby repository from chromeragnarok

= Google AdsCommon Library

This gem is a dependency for the new generation of Ruby Google Ads client
libraries. It contains common code shared among all of these libraries, such as
authentication, SOAP stub generation, error handling, logging, etc.

This is an early preview release, so a lot of things are still missing!


= Docs for Users

== 1 - Installation:

google-ads-common is a Ruby gem.  See http://docs.rubygems.org/read/book/1

Install it using the gem install command.
   $ gem install --local google-ads-common-VERSION.gem

The following gem libraries are required:
 - soap4r v1.5.8 (only for soap4r-based libraries);
 - savon v0.9.1 or greater (for savon-enabled libraries);
 - httpi v0.9.2 or greater;
 - httpclient v2.1.6 or greater.

= Docs for Developers

== 1 - Directory Structure

- +lib/ads_common/+: Contains the bulk of the library.
  - +auth/+: Contains classes that can handle different authentication methods.
    Currently only supports ClientLogin.
  - +build/+: Contains classes that handle code generation, packaging and other
    build-time tasks for client libraries (not for google-ads-common).
  - +savon_headers/+: Contains classes that handle header injection into savon
    requests.
  - +soap4r_headers/+: Contains classes that handle header injection into soap4r
    requests.
- +test/+: Contains the unit tests for the library.

== 2 - Commands

 $ rake package
to package the gem and create a release

 $ rake test
to run unit tests on the library


= Copyright/License Info

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

Sérgio Gomes (api.sgomes@gmail.com)
Danial Klimkin (api.dklimkin@gmail.com)
chromeragnarok/ads_common
