Sha256: 0e15b4e2245912e68f3ba50150ad09b70a56ceeca177405579c5592306948e3f
Contents?: true
Size: 1.92 KB
Versions: 9
Compression:
Stored size: 1.92 KB
Contents
# SoapyCake
[](https://codeclimate.com/github/ad2games/soapy_cake)
[](https://codeclimate.com/github/ad2games/soapy_cake)
[](http://rubygems.org/gems/soapy_cake)
[](https://gemnasium.com/ad2games/soapy_cake)
[](https://circleci.com/gh/ad2games/soapy_cake)
Simple client library for [cake](http://getcake.com).
## Installation
Add this line to your application's Gemfile:
gem 'soapy_cake'
And then execute:
$ bundle
Or install it yourself as:
$ gem install soapy_cake
## Usage Examples
First we assume that you set the `CAKE_DOMAIN`, `CAKE_API_KEY` and `CAKE_TIME_ZONE`
environment variables.
Export all advertisers:
```ruby
SoapyCake::Admin.new.advertisers(opts)
```
Get report for specific date range:
```ruby
SoapyCake::Admin.new.affiliate_summary(
start_date: Date.beginning_of_month,
end_date: Date.today
)
```
If you are interested in how we map methods to api endpoints take a look
at [api_versions.yml](api_versions.yml).
## Time/Date Handling
- Define `CAKE_TIME_ZONE`
- Specify dates with any timezone in requests (will be converted to the correct CAKE timezone)
- `Date` objects in requests will be treated as UTC (just like `.to_datetime` would do)
- Responses contain UTC dates which can be converted however you like
## Contributing
1. Fork it (https://github.com/ad2games/soapy_cake/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
Version data entries
9 entries across 9 versions & 1 rubygems