RSqoot

A Ruby Wrapper for Sqoot API V2. With Auto-caching for all APIS, and Auto-increment for deals.

To get the list of available parameters kindly check out API V2

Installation

Add this line to your application's Gemfile:

gem 'rsqoot'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rsqoot

Usage

General configuration options

public_api_key        # YOUR PUBLIC API KEY
private_api_key       # YOUR PRIVATE API KEY
base_api_url          # 'https://api.sqoot.com' by default
authentication_method # :header by default
read_timeout          # 60.seconds by default
expired_in            # 1.hour by default

There’s a handy generator that generates the default configuration file into config/initializers directory. Run the following generator command, then edit the generated file.

rails g rsqoot:config

Then, you should be able to use SqootClient to search deals. For example:

SqootClient.deals(query: 'Home')

You can also change your configuration in your own instance, such as below:

SqootClient.reload!(public_api_key: "YOUR PUBLIC API KEY", private_api_key: 'YOUR PRIVATE API KEY')

Basic Usages

SqootClient.deals
#=> returns a list of deals

SqootClient.deals(query: 'travel')

SqootClient.deals(location: 'Chicago')

SqootClient.deals(location: 'Chicago', per_page: 10)

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

SqootClient.deals(price_at_least: 10, order: :commission_desc)

SqootClient.impression(1555288, geometry: '250x250C')
# => return deal_id 1555288's image url which size is 250x250

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

SqootClient.providers
# => returns a list of providers

SqootClient.providers(query: 'Groupon')

SqootClient.categories
# => returns a list of categories

SqootClient.categories(query: 'home')
SqootClient.categories(query: 'home&health')
SqootClient.categories(query: 'home,health')

SqootClient.commissions
# => returns current month commissions

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

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

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

Auto Cache

Please notice that each query with above methods will automaticlly cache the result

If you want to fetch the newest records each time, you can do as below:

SqootClient.deals(location: 'Chicago', expired_in: 1.second)

By this, it will update the cache by each query.

Auto increment for deals

SqootClient.total_sqoot_deals(query: 'Home', page: 2, category_slugs: 'US')
# For this method, it will cache all the pages for current query options, the more you query the more it will store until reach the end.

# For example:
SqootClient.total_sqoot_deals(query: 'Home', page: 1, per_page: 20, category_slugs: 'US').count
# => 20 records
SqootClient.total_sqoot_deals(query: 'Home', page: 2, per_page: 20, category_slugs: 'US').count
# => 40 records

# But once you change your query options, it will re-cache the records.

Contributing

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

LICENCE

MIT

Author

Felix Liu

TODO

Add fully test specs
Use memcached to cache records

rqoot

Runtime