sqoot 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@sqoot --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sqoot.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Cause Metric LLC
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Sqoot
+
+Wrapper for [Sqoot](http://www.sqoot.com) [API](http://www.sqoot.com/docs/api). Highly inspired by [Gowalla](https://github.com/pengwynn/gowalla) gem.
+Built using [Faraday](https://github.com/technoweenie/faraday) and [Faraday Middleware](https://github.com/pengwynn/faraday_middleware).
+
+To get the list of available parameters kindly check out [API](http://www.sqoot.com/docs/search)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sqoot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sqoot
+
+## Usage
+
+    Sqoot.configure do |config|
+      config.affiliate_token = "YOUR AFFILIATE TOKEN"
+      config.authentication_token = "YOUR AUTHENTICATION TOKEN"
+    end
+
+    sqoot = Sqoot::Client.new
+
+    # http://api.sqoot.com/v1/offers?affiliate_token=yadayada
+    sqoot.offers
+    #=> returns a list of offers
+
+    # http://api.sqoot.com/v1/offers?affiliate_token=yadayada&location=Chicago
+    sqoot.offers(:location => 'Chicago')
+
+    # http://api.sqoot.com/v1/offers?affiliate_token=yadayada&location=Chicago&per_page=10
+    sqoot.offers(:location => 'Chicago', :per_page => 10)
+
+    # http://api.sqoot.com/v1/offers?affiliate_token=yadayada&categories=health-beauty&location=&page=2
+    sqoot.offers(:location => 'Chicago', :per_page => 10, :categories => 'health-beauty', :page => 2)
+
+    # http://api.sqoot.com/v1/offers?affiliate_token=yadayada&order=commission&per_page=250&price_at_least=10
+    sqoot.offers(:price_at_least => 10, :order => commission)
+
+    # http://api.sqoot.com/v1/providers?affiliate_token=yadayada
+    sqoot.providers
+
+    # http://api.sqoot.com/v1/commissions?authentication_token=tokenawesome
+    sqoot.commissions
+    # => returns current month commissions
+
+    sqoot.commissions(:to => '2012-01-01', :from => '2012-01-20')
+    # => returns commissions using date_range :to & :from
+
+    # http://api.sqoot.com/v1/clicks?authentication_token=tokenawesome
+    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

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sqoot.rb

@@ -0,0 +1,23 @@
+require "faraday"
+require "faraday_middleware"
+require "sqoot/version"
+require "sqoot/client"
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+module Sqoot
+
+  class << self
+    attr_accessor :affiliate_token, :authentication_token
+
+    # Configure default credentials easily
+    #
+    # @yield [affiliate_key, authentication_token]
+    def configure
+      yield self
+      true
+    end
+
+  end
+
+end

data/lib/sqoot/category.rb

@@ -0,0 +1,11 @@
+module Sqoot
+  module Category
+
+    # Retrieve a list of categories base on the following parameters
+    #
+    # @return [Hashie::Mash] category list
+    def categories(options={})
+      get('/v1/categories', options)
+    end
+  end
+end

data/lib/sqoot/click.rb

@@ -0,0 +1,14 @@
+module Sqoot
+  module Click
+
+    # Retrieve a list of clicks based on the following parameters
+    #
+    # @param [String] :to Start date
+    # @param [String] :from End date
+    #
+    # @return [Hashie::Mash]
+    def clicks(options={})
+      get('/v1/clicks', options)
+    end
+  end
+end

data/lib/sqoot/client.rb

@@ -0,0 +1,58 @@
+require "forwardable"
+require "sqoot/offer"
+require "sqoot/category"
+require "sqoot/provider"
+require "sqoot/commission"
+require "sqoot/click"
+require "sqoot/request"
+require "sqoot/response/parse_gzip"
+
+module Sqoot
+  class Client
+    extend Forwardable
+
+    include Offer
+    include Category
+    include Provider
+    include Commission
+    include Click
+    include Request
+
+    attr_reader :affiliate_token, :authentication_token
+
+    def initialize(options={})
+      @affiliate_token        = options[:affiliate_token] || Sqoot.affiliate_token
+      @authentication_token   = options[:authentication_token] || Sqoot.authentication_token
+    end
+
+    # Provides the URL for accessing the API
+    #
+    # @return [String]
+    def api_url
+      "http://api.sqoot.com"
+    end
+
+    # Raw HTTP connection with Faraday::Connection
+    #
+    # @return [Faraday::Connection]
+    def connection
+      params = {}
+      @connection = Faraday.new(:url => api_url, :params => params, :headers => default_headers) do |builder|
+        builder.use Faraday::Response::ParseGzip
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    private
+
+    def default_headers
+      headers = {
+        :authorization => @authentication_token,
+        :accept => '*/*',
+        :accept_encoding => 'gzip',
+        :user_agent => 'Ruby gem'
+      }
+    end
+
+  end
+end

data/lib/sqoot/commission.rb

@@ -0,0 +1,15 @@
+module Sqoot
+  module Commission
+
+    # Retrieve information of commissions based on the following parameters
+    #
+    # @param [String] :to Start date
+    # @param [String] :from End date
+    #
+    # @return [Hashie::Mash]
+    def commissions(options={})
+      get('/v1/commissions', options)
+    end
+
+  end
+end

data/lib/sqoot/offer.rb

@@ -0,0 +1,16 @@
+module Sqoot
+  module Offer
+
+    # Retrieve a list of offers based on the following parameters
+    #
+    # @param [String] location (What geography do you want deals from? It can be anything: a city, zip code, address, intersection or even a latitude/longitude)
+    # @param [String] categories (You can specify just one (e.g., restaurants), or whole bunch by separating their slugs with commas (e.g., "restaurants,jewish")
+    # @param [Integer] per_page Number of results to be displayed
+    #
+    # @return [Hashie::Mash] offers list
+    def offers(options={})
+      get('/v1/offers', options)
+    end
+
+  end
+end

data/lib/sqoot/provider.rb

@@ -0,0 +1,11 @@
+module Sqoot
+  module Provider
+
+    # Retrieve a list of providers base on the following parameters
+    #
+    # @return [Hashie::Mash]
+    def providers(options={})
+      get('/v1/providers', options)
+    end
+  end
+end

data/lib/sqoot/request.rb

@@ -0,0 +1,36 @@
+module Sqoot
+  module Request
+
+    def get(path, options)
+      request(:get, path, convert_params(path, options))
+    end
+
+    def convert_params(path, data={})
+      auth_endpoints = ['commissions', 'clicks']
+
+      if auth_endpoints.include? path.split('/')[2]
+        data['authentication_token'] = authentication_token
+      else
+        data['affiliate_token'] = affiliate_token
+      end
+
+      data
+
+    end
+
+    def request(method, path, options)
+      response = connection.send(method) do |request|
+        case method
+        when :delete, :get
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.body = MultiJson.encode(options) unless options.empty?
+        end
+      end
+
+      response.body
+    end
+
+  end
+end

data/lib/sqoot/response/parse_gzip.rb

@@ -0,0 +1,27 @@
+require "faraday"
+
+module Faraday
+  class Response::ParseGzip < Response::Middleware
+    class << self
+      attr_accessor :mash_class
+    end
+
+    dependency do
+      require 'json'
+      require 'hashie/mash'
+      self.mash_class = ::Hashie::Mash
+    end
+
+    def parse(body)
+      sio = StringIO.new(body)
+      begin
+        gz = Zlib::GzipReader.new(sio)
+        self.class.mash_class.new(JSON.parse(gz.read()))
+      rescue
+        self.class.mash_class.new JSON.parse body
+      end
+
+    end
+
+  end
+end

data/lib/sqoot/version.rb

@@ -0,0 +1,3 @@
+module Sqoot
+  VERSION = "0.0.1"
+end

data/spec/cassettes/Sqoot_Category/should_return_an_array_of_categories.yml

@@ -0,0 +1,79 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: AFFILIATE_TOKEN
+    body: ''
+    headers:
+      authorization: AUTHENTICATION_TOKEN
+      accept:
+      - ! '*/*'
+      accept-encoding:
+      - gzip
+      user-agent:
+      - Ruby gem
+      connection:
+      - close
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      date:
+      - Fri, 24 Feb 2012 15:05:46 GMT
+      content-type:
+      - text/javascript; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      etag:
+      - ! '"74309e2e331a650863970752eb0878eb"'
+      cache-control:
+      - max-age=0, private, must-revalidate
+      x-ua-compatible:
+      - IE=Edge,chrome=1
+      x-runtime:
+      - '0.063788'
+      x-varnish:
+      - '839843809'
+      age:
+      - '0'
+      via:
+      - 1.1 varnish
+      content-encoding:
+      - gzip
+    body: !binary |-
+      H4sIAAAAAAAAA7yWTW+cMBCG7/0V1h5yClIWNmzTW7JJ99ZLq156qIwZWEvG
+      XtlmKxTlv9fQ7VLBZNoI6AUk2+/wMOP5eH7H2EpwD6WxEtzqA/sWVhh77p79
+      XhN2fq+FVc0rCCure+HlSfqgZFfs6QTau9V1f8wUBVj3XZha+3A8Tde3f+w6
+      VZetEX4xEsEvE+czL9375fpNRLU3lQkGgX0Ge5ICKKJ4gwJdbEQOsXHkFjr1
+      yoLnUvWHJnA/8KwhQNfvEc5soOnB3BGE5CqS2oMF56eR2Ta6O1VnlCuTNEUR
+      rYvEUNqD5lJLXUZalgevZAGTQI3xbMerI+XHdINRBmUkBsoespBeg5sWXvND
+      hR+lkgPlGql6qlnT5sHKnCvKcViiZCPVMldwd5DWHG37x4JijLHgilfEPeoB
+      uPKHKIOQ+M0kTukb9sXUlkqU9eYGowzSyA+lC0V7Z5SCEghIFHGsWijcpoK8
+      +WvF2aAVR3RiqubM7EotwJJtL07Q5BGIciHIRx4+FfzJnSPb4foG82jeqoND
+      R+qlaIMBshYlt1sMcyRbIMMfwVbcG2VKslvfJSggql2CsuuqoWl/uvRVCna7
+      jTHcGVvzUwOB5qt00mgqU7Z3CAg0EJ1G0gXc9pG3JYyqOFhYi5FqCbTzCELM
+      DzE2Is4wupw//S/lA0vLMwFdP+bANCYPd2xvTaiqVHImMXbJiiCPyrF4kWF/
+      zylArPeW/D9M+nujCiq8CVYmyoHoLU3hJwAAAP//IsVtlbl4nGaJrYJNR9VC
+      1dTmkZhZpBCUmptfhr/VbI4tU2YANesWYWqmQbkBdmdwYg7eYtcEa8YFu7IY
+      XSst3Ag2CJh3nSBG4a0fsCVB6rkE2HYkZtjA0MAUWxmSAdROvxEDr9TyzOIM
+      fK40xOLGLAxdtClLvDNT8LbdsdZW2WiaaOS0/OKM1CISC+BsDE20cZwPsKWl
+      EJydmZNDTI1rYomtxwtqrekWg82gY7PdNzE7tRTf2IsFtkI6F0MXDUoY38S8
+      zOTSIlAbNCA1BczEV5nAW3kAAAAA//+8Wj1vwjAQ3fsrsnXKEMLnyNgBNYJI
+      qEMHS1gEtYktxyli6H/vhYAq8MOmVY6FBb3jye++jwuenYlYAwMslI0ln4rm
+      gdkS6V922FjcnC57qIAL8ivh3SGkMAGVLo7j+WT13AaQskVg7TaBLyirNnRc
+      NEsmXzS1bEqvzKjslS6MKbRfG7tRykTzTWuKnP/vi2DVmYgFNMHEOyNeqqIo
+      yo04TrPeMRjR1icLsQUWeo2nTHoDfYKSkpa3ArzPkpQVyqqtEbo43HVTmaGw
+      179GHtciZbtP+t6/jEVcXVivUi9JENEY4b+WJbMhXMcZjOa5qSyPYlDdvEP4
+      dAy74h71pL4oEMTg92sHxJRtVh+HDVnzEkR5vEY4Lo5aeNiNYItWX2IYqvWq
+      y1bRyzlbeZrIIXzCHtPdSitqn6pt+J6dpFM0ONcnA2e5+FXNRRWobmMUmdaF
+      MYibS0nT/brYWRkgOUIzoW3h8R7BOciSJesdDpNkgOZD6wK5xDbiS/qWToMZ
+      8krrwHi6hdzQQwTOYZDeNYylI1jvKhnlorb/8MQ9YWPrYpl0Xqvy3iFmmiKX
+      3KvHjjFvausrLgn8D8vhChRqtOjz/en7BwAA//8DAEnrWcK3JAAA
+    http_version: '1.1'
+  recorded_at: Fri, 24 Feb 2012 15:05:46 GMT
+recorded_with: VCR 2.0.0.rc1