Contents

Sqoot
======

A Ruby Wrapper For Sqoot API V2

Wrapper for [Sqoot](http://www.sqoot.com) [API V2](http://docs.sqoot.com/v2/overview.html).

To get the list of available parameters kindly check out [API V2](http://docs.sqoot.com/v2/overview.html)

## Installation

Add this line to your application's Gemfile:

    gem 'rsqoot'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install rsqoot

## Usage

    Sqoot.configure do |config|
      # config.public_api_key = 'YOUR PUBLIC API KEY'
      # config.private_api_key = 'YOUR PRIVATE API KEY'
      # config.base_api_url = 'https://api.sqoot.com'
      # config.authentication_method = :header
      # config.read_timeout = 20
    end

    sqoot = Sqoot::Client.new

    sqoot.deals
    #=> returns a list of deals

    sqoot.deals(:location => 'Chicago')

    sqoot.deals(:location => 'Chicago', :per_page => 10)

    sqoot.deals(:location => 'Chicago', :per_page => 10, :categories => 'health-beauty', :page => 2)

    sqoot.deals(:price_at_least => 10, :order => commission)

    sqoot.deal_impression(1555288, geometry: '250x250C')
    # => return a image url which size is 250x250

    sqoot.deal_click(1555288)
    # => return a click url which will redirect to another url

    sqoot.providers
    # => returns a list of providers

    sqoot.commissions
    # => returns current month commissions

    sqoot.commissions(:to => '2012-01-01', :from => '2012-01-20')
    # => returns commissions using date_range :to & :from

    sqoot.clicks
    # => returns real-time clicks from the event request limit of 1000

    sqoot.clicks(:to => '2012-01-01', :from => '2012-01-20')
    # => returns clicks using date_range :to & :from

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rsqoot-0.1.1	README.md