rsqoot 0.5.2 → 0.5.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsqoot (0.5.0)
+    rsqoot (0.5.3)
       activesupport (>= 3.0.0)
       hashie (>= 2.0.0)
       json (>= 1.6.0)
@@ -9,16 +9,27 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
+    activesupport (4.0.3)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
     hashie (2.0.5)
-    i18n (0.6.1)
+    i18n (0.6.9)
     json (1.8.1)
-    multi_json (1.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    rake (10.1.1)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler (>= 1.0.0)
+  rake
   rsqoot!

data/README.md

@@ -45,56 +45,54 @@ SqootClient.deals(query: 'Home')
 You can also change your configuration in your own instance, such as below:
 
 ```ruby
-sqoot ||= RSqoot::Client.new(public_api_key: "YOUR PUBLIC API KEY", private_api_key: 'YOUR PRIVATE API KEY')
+SqootClient.reload!(public_api_key: "YOUR PUBLIC API KEY", private_api_key: 'YOUR PRIVATE API KEY')
 ```
 
 #### Basic Usages
 
 ```ruby
-sqoot ||= RSqoot::Client.new
-
-sqoot.deals
+SqootClient.deals
 #=> returns a list of deals
 
-sqoot.deals(query: 'travel')
+SqootClient.deals(query: 'travel')
 
-sqoot.deals(location: 'Chicago')
+SqootClient.deals(location: 'Chicago')
 
-sqoot.deals(location: 'Chicago', per_page: 10)
+SqootClient.deals(location: 'Chicago', per_page: 10)
 
-sqoot.deals(location: 'Chicago', per_page: 10, categories: 'health-beauty', page: 2)
+SqootClient.deals(location: 'Chicago', per_page: 10, categories: 'health-beauty', page: 2)
 
-sqoot.deals(price_at_least: 10, order: :commission_desc)
+SqootClient.deals(price_at_least: 10, order: :commission_desc)
 
-sqoot.impression(1555288, geometry: '250x250C')
+SqootClient.impression(1555288, geometry: '250x250C')
 # => return deal_id 1555288's image url which size is 250x250
 
-sqoot.deal(1555288).url
+SqootClient.deal(1555288).url
 # => return a click url which will redirect to another url
 
-sqoot.providers
+SqootClient.providers
 # => returns a list of providers
 
-sqoot.providers(query: 'Groupon')
+SqootClient.providers(query: 'Groupon')
 
-sqoot.categories
+SqootClient.categories
 # => returns a list of categories
 
-sqoot.categories(query: 'home')
-sqoot.categories(query: 'home&health')
-sqoot.categories(query: 'home,health')
+SqootClient.categories(query: 'home')
+SqootClient.categories(query: 'home&health')
+SqootClient.categories(query: 'home,health')
 
-sqoot.commissions
+SqootClient.commissions
 # => returns current month commissions
 
-sqoot.commissions(to: '2012-01-01', from: '2012-01-20')
-# => returns commissions using date_range :to & :from
+SqootClient.commissions(from: '2012-01-01', to: '2012-01-20')
+# => returns commissions using date_range :from & :to
 
-sqoot.clicks
+SqootClient.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
+SqootClient.clicks(from: '2012-01-01', to: '2012-01-20')
+# => returns clicks using date_range :from & :to
 ```
 
 #### Auto Cache
@@ -104,7 +102,7 @@ Please notice that each query with above methods will automaticlly cache the res
 If you want to fetch the newest records each time, you can do as below:
 
 ```ruby
-sqoot.deals(location: 'Chicago', expired_in: 1.second)
+SqootClient.deals(location: 'Chicago', expired_in: 1.second)
 ```
 
 By this, it will update the cache by each query.
@@ -112,13 +110,13 @@ By this, it will update the cache by each query.
 #### Auto increment for deals
 
 ```ruby
-sqoot.total_sqoot_deals(query: 'Home', page: 2, category_slugs: 'US')
+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:
-sqoot.total_sqoot_deals(query: 'Home', page: 1, per_page: 20, category_slugs: 'US').count
+SqootClient.total_sqoot_deals(query: 'Home', page: 1, per_page: 20, category_slugs: 'US').count
 # => 20 records
-sqoot.total_sqoot_deals(query: 'Home', page: 2, per_page: 20, category_slugs: 'US').count
+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.

data/Rakefile

@@ -0,0 +1,4 @@
+# encoding: utf-8
+
+require 'bundler'
+Bundler::GemHelper.install_tasks

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

@@ -6,5 +6,3 @@ RSqoot.configure do |config|
   # config.read_timeout          = 60.seconds
   # config.expired_in            = 1.hour
 end
-
-SqootClient ||= RSqoot::Client.new

data/lib/rsqoot/client.rb

@@ -1,3 +1,4 @@
+require "singleton"
 require "rsqoot/helper"
 require "rsqoot/merchant"
 require "rsqoot/category"
@@ -10,6 +11,7 @@ require "rsqoot/logger"
 
 module RSqoot
   class Client
+    include Singleton
     include Helper
     include Category
     include Click
@@ -20,7 +22,14 @@ module RSqoot
     include Request
     include Logger
 
-    attr_reader :public_api_key, :private_api_key, :base_api_url, :authentication_method, :read_timeout, :query_options, :expired_in, :sqoot_query_uri
+    attr_accessor :public_api_key,
+                  :private_api_key,
+                  :base_api_url,
+                  :authentication_method,
+                  :read_timeout,
+                  :query_options,
+                  :expired_in,
+                  :sqoot_query_uri
 
     def initialize(options={})
       @public_api_key        = options[:public_api_key]        || RSqoot.public_api_key
@@ -31,5 +40,9 @@ module RSqoot
       @expired_in            = options[:expired_in]            || RSqoot.expired_in
     end
 
+    def reload!(options={})
+      initialize(options)
+      self.class.instance
+    end
   end
 end

data/lib/rsqoot/helper.rb

@@ -32,7 +32,7 @@ module RSqoot
           queries = q.downcase.scan(/[A-Za-z]+|\d+/)
           if queries.present?
             queries.map do |q|
-              instance_variable_get('@rsqoot_'+name).dup.keep_if do |c|
+              instance_variable_get('@rsqoot_' + name).dup.keep_if do |c|
                 c.slug =~ Regexp.new(q)
               end
             end.flatten.compact.uniq
@@ -42,6 +42,8 @@ module RSqoot
       end
 
       # Add Wrappers: Deal, Category, Commission, Merchant, Provider, Click
+      # All records should return as RSqoot::Sqoot* object
+      #
       [ 'SqootDeal',
         'SqootCategory',
         'SqootCommission',

data/lib/rsqoot/logger.rb

@@ -1,5 +1,10 @@
 module RSqoot
   module Logger
+
+    # Add logger support, easy for log monitor when running your app
+    # Output errors and valid records count
+    # TODO add color support
+    #
     def logger(options = {records: [], uri: '', error: '', type: '', opts: {}})
       records = options[:records].nil? ? [] : options[:records]
       error   = options[:error]

data/lib/rsqoot/request.rb

@@ -4,6 +4,9 @@ require 'json'
 module RSqoot
   module Request
 
+    # Get method, use by all other API qeury methods, fetch records
+    # from the Sqoot API V2 url, and provide wrapper functionality
+    #
     def get(path, opts = {}, wrapper = ::Hashie::Mash)
       uri, headers = url_generator(path, opts)
       begin
@@ -17,6 +20,9 @@ module RSqoot
       end
     end
 
+    # Generate valid Sqoot API V2 url and provide two different way of
+    # authentication: :header, :parameter
+    #
     def url_generator(path, opts = {}, require_key = false)
       uri      = URI.parse base_api_url
       headers  = {read_timeout: read_timeout}
@@ -37,14 +43,19 @@ module RSqoot
 
     private
 
+    # Endpoints that needs private key
+    #
     def private_endpoints
       %w(clicks commissions)
     end
 
+    # Endpoints that both public or private key will work
+    #
     def public_endpoints
       %w(categories deals merchants providers)
     end
 
+    # Decide which api key should be used: private, public
     def api_key(endpoint='')
       if private_endpoints.include? endpoint
         private_api_key

data/lib/rsqoot/version.rb

@@ -1,3 +1,3 @@
 module RSqoot
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

data/lib/rsqoot.rb

@@ -15,6 +15,7 @@ module RSqoot
       raise "You must add your own public api key to initializer ." if self.public_api_key.nil?
       raise "You must add your own private api key to initializer ." if self.private_api_key.nil?
       raise "Authentication method must be :header or :parameter ." if !AUTHENTICATION_METHODS.include? self.authentication_method
+      SqootClient.reload!
       true
     end
 
@@ -32,3 +33,10 @@ module RSqoot
   end
 
 end
+
+begin
+  RSqoot.load_defaults
+  SqootClient ||= RSqoot::Client.instance
+rescue => e
+  raise e
+end

data/rsqoot.gemspec

@@ -22,4 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency "json", ">= 1.6.0"
   s.add_dependency "activesupport", ">= 3.0.0"
 
+  s.add_development_dependency 'bundler', ['>= 1.0.0']
+  s.add_development_dependency 'rake', ['>= 0']
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsqoot
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -59,6 +59,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby Wrapper for Sqoot API V2.
 email:
 - lyfeyaj@gmail.com
@@ -101,12 +133,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 309329620517368495
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 309329620517368495
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.26