rsqoot 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec628307ce0c636974f1302b34c42ba6e207e74c
+  data.tar.gz: 6cbdc7c584d68492fc0e6c128a3c88733ce3cd01
+SHA512:
+  metadata.gz: f8781dbae0339b5eb534ed866de0e753e3bf90269b5cb026aa2ab73a9d2562b26eed030e95531e1a3ad4bda66f60309d62fe6234f03d5ac39b344518b75c2d7d
+  data.tar.gz: bfe98dc0764d75e32bf12d61125deb38963da7505ebfb85e734da73d326db624a45256c3bb758fca3417f6fbec33b298188ff3eeb83809ecd684b71a7e4a979e

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Felix Liu
+
+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,74 @@
+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

data/lib/generators/rsqoot/config_generator.rb

@@ -0,0 +1,16 @@
+module RSqoot
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      desc <<DESC
+Description:
+    Copies RSqoot configuration file to your application's initializer directory.
+DESC
+
+      def copy_config_file
+        template 'rsqoot_config.rb', 'config/initializers/rsqoot_config.rb'
+      end
+    end
+  end
+end

data/lib/generators/rsqoot/templates/rsqoot_config.rb

@@ -0,0 +1,7 @@
+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

data/lib/rsqoot/category.rb

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

data/lib/rsqoot/click.rb

@@ -0,0 +1,14 @@
+module RSqoot
+  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('clicks', options)
+    end
+  end
+end

data/lib/rsqoot/client.rb

@@ -0,0 +1,30 @@
+require "rsqoot/merchant"
+require "rsqoot/category"
+require "rsqoot/provider"
+require "rsqoot/commission"
+require "rsqoot/click"
+require "rsqoot/deal"
+require "rsqoot/request"
+
+module RSqoot
+  class Client
+    include Category
+    include Click
+    include Commission
+    include Deal
+    include Merchant
+    include Provider
+    include Request
+
+    attr_reader :public_api_key, :private_api_key, :base_api_url, :authentication_method, :read_timeout
+
+    def initialize(options={})
+      @public_api_key        = options[:public_api_key] || RSqoot.public_api_key
+      @private_api_key       = options[:private_api_key] || RSqoot.private_api_key
+      @base_api_url          = options[:base_api_url] || RSqoot.base_api_url
+      @authentication_method = options[:authentication_method] || RSqoot.authentication_method
+      @read_timeout          = options[:read_timeout] || RSqoot.read_timeout
+    end
+
+  end
+end

data/lib/rsqoot/commission.rb

@@ -0,0 +1,15 @@
+module RSqoot
+  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('commissions', options)
+    end
+
+  end
+end

data/lib/rsqoot/deal.rb

@@ -0,0 +1,30 @@
+module RSqoot
+  module Deal
+
+    # Retrieve a list of deals based on the following parameters
+    #
+    # @param [String] query (Search deals by title, description, fine print, merchant name, provider, and category.)
+    # @param [String] location (Limit results to a particular area. We'll resolve whatever you pass us (including an IP address) to coordinates and search near there.)
+    # @param [Integer] radius (Measured in miles. Defaults to 10.)
+    # @param [Integer] page (Which page of result to return. Default to 1.)
+    # @param [Integer] per_page (Number of results to return at once. Defaults to 10.)
+    def deals(options={})
+      get('deals', options)
+    end
+
+    # Retrieve a deal by id
+    #
+    def deal(id, options={})
+      get("deals/#{id}", options)
+    end
+
+    def deal_click(id, options={})
+      get("deals/#{id}/click", options, parse = false)
+    end
+
+    def deal_impression(id, options={})
+      get("deals/#{id}/image", options, parse = false)
+    end
+
+  end
+end

data/lib/rsqoot/merchant.rb

@@ -0,0 +1,13 @@
+module RSqoot
+  module Merchant
+
+    # Retrieve a list of merchants base on the following parameters
+    #
+    # @param [String] id (The merchant's ID, Use the Sqoot ID or ID for any supported namespace. Must supply namespace if we don't use Sqoot)
+    # @param [String] namespace (One of the supported namespaces. Factual, Foursquare, Facebook, Google, CitySearch, Yelp.)
+
+    def merchant(id, options={})
+      get("merchants/#{id}", options)
+    end
+  end
+end

data/lib/rsqoot/provider.rb

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

data/lib/rsqoot/request.rb

@@ -0,0 +1,63 @@
+require 'open-uri'
+require 'hashie/mash'
+require 'json'
+
+module RSqoot
+  module Request
+
+    def get(path, opts = {}, parse = true)
+      uri       = URI.parse base_api_url
+      uri.path  = '/v2/' + path
+      headers   = {read_timeout: read_timeout}
+      query = options_parser opts
+      endpoint  = path.split('/')[0]
+      case authentication_method
+      when :header
+        headers.merge! h = {"Authorization" => "api_key #{api_key(endpoint)}"}
+        query = query + "&api_key=#{api_key(endpoint)}" if !parse
+      when :parameter
+        query = query + "&api_key=#{api_key(endpoint)}"
+      end
+      uri.query = query
+      if parse
+        begin
+          json = JSON.parse uri.open(headers).read
+          ::Hashie::Mash.new json
+        end
+      else
+        uri.to_s
+      end
+    end
+
+    private
+
+    def private_endpoints
+      %w(clicks commissions)
+    end
+
+    def public_endpoints
+      %w(categories deals merchants providers)
+    end
+
+    def api_key(endpoint='')
+      if private_endpoints.include? endpoint
+        private_api_key
+      elsif public_endpoints.include? endpoint
+        public_api_key
+      else
+        raise "No such endpoint #{endpoint} available."
+      end
+    end
+
+    # Example: options = {per_page: 10, page: 1}
+    # Options should be parsed as http query: per_page=10&page=1
+    #
+    # @return [String]
+    def options_parser(options = {})
+      options.map do |key, value|
+        [key, value].map(&:to_s).join('=')
+      end.join('&')
+    end
+
+  end
+end

data/lib/rsqoot/version.rb

@@ -0,0 +1,3 @@
+module RSqoot
+  VERSION = '0.1.1'
+end

data/lib/rsqoot.rb

@@ -0,0 +1,30 @@
+require "rsqoot/client"
+
+module RSqoot
+
+  class << self
+    attr_accessor :public_api_key, :private_api_key, :base_api_url, :authentication_method, :read_timeout
+
+    # Configure default credentials easily
+    #
+    # @yield [Sqoot]
+    def configure
+      load_defaults
+      yield self
+      raise "Authentication method must be :header or :parameter ." if !AUTHENTICATION_METHODS.include? self.authentication_method
+      true
+    end
+
+    def load_defaults
+      self.base_api_url ||= "https://api.sqoot.com"
+      self.authentication_method = :header
+      self.read_timeout = 60
+    end
+
+    private
+
+    AUTHENTICATION_METHODS = [:header, :parameter]
+
+  end
+
+end

data/rsqoot.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'rsqoot/version'
+
+Gem::Specification.new do |s|
+  s.name             = "rsqoot"
+  s.version          = RSqoot::VERSION.dup
+  s.platform         = Gem::Platform::RUBY
+  s.licenses         = ['MIT']
+  s.summary          = %q{Wrapper for Sqoot API V2}
+  s.email            = ['lyfeyaj@gmail.com']
+  s.homepage         = "https://github.com/lyfeyaj/rsqoot"
+  s.description      = %q{A Ruby Wrapper for Sqoot API V2.}
+  s.authors          = ['Felix Liu']
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.extra_rdoc_files = ['README.md']
+  s.require_paths    = ['lib']
+
+  s.add_dependency "hashie", "~> 2.0.0"
+  s.add_dependency "json", "~> 1.7.0"
+
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rsqoot
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Felix Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description: A Ruby Wrapper for Sqoot API V2.
+email:
+- lyfeyaj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/rsqoot/config_generator.rb
+- lib/generators/rsqoot/templates/rsqoot_config.rb
+- lib/rsqoot.rb
+- lib/rsqoot/category.rb
+- lib/rsqoot/click.rb
+- lib/rsqoot/client.rb
+- lib/rsqoot/commission.rb
+- lib/rsqoot/deal.rb
+- lib/rsqoot/merchant.rb
+- lib/rsqoot/provider.rb
+- lib/rsqoot/request.rb
+- lib/rsqoot/version.rb
+- rsqoot.gemspec
+homepage: https://github.com/lyfeyaj/rsqoot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Wrapper for Sqoot API V2
+test_files: []