rsqoot 0.4.1 → 0.4.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjcwZDMzOTM2ZWI4NWNlYzRiY2I4ZjcxNmU0Y2Y0Nzk1YmFkZTVhNw==
+    NjMzNmUyNTgxOTMwOWMxYTEwZjgxMjI2ODZjNDcwYjE1NzFkNDdlYw==
   data.tar.gz: !binary |-
-    NzViOTRlN2I2N2JjNDYzMWE0MGZlYzU1OWY4ZTZmOTBmMThiY2Q3MQ==
+    NzUyOWVhMzQ5ZWYyZWVhZGIzNTZhODQ2OTg4ODAwY2Y0ZmQ0NzdhOQ==
 SHA512:
   metadata.gz: !binary |-
-    MmVhOTYyM2M3NDk1ZTU3NmJkM2JhM2NkM2QyNzIyZjM1YWY5NTcyMjNmNjZi
-    YjNhYjFiODk4ZDliZTUyNTJmYWIxNWUyMjQ0NDcwMGRjYzUyNWRiMjVlZGU3
-    N2Q5ZDc5ZjFkMmZiZjcxOGI3MTNlZDdkYzg5MDExNTY3MGU3Yjk=
+    YTBjNzA4MDY5ZWQ4M2FmNjNjODg2YzAxMjBhMTA4OWMxZjViMzUxZDgzYmMw
+    ZDEwNjQwNTJiMmQwYjcwOTQ5Y2M4OGZiYzgyMmIzNTI2Yjg5OTEzMGMwZmRj
+    ZmJkYWNkN2FjMzJiNDI1OWI0M2JkODM0N2E4ODA4N2NjYWM0YzY=
   data.tar.gz: !binary |-
-    N2ViOGI5MTk1NmE0ZDk2NDRjNGQyYjUyZDdiN2JiMmY2MGM3MzNjNDQ3ZGU0
-    YzM2OWZlNjgzNjhhNWMwZDE5OGExNTY5NGVjZjQyMTRmMWZiOTgzN2EyYTBi
-    YzQ5YzNkNjkwZWUzN2Y3OWE5NmM5Nzg4ZTZmYWViYWU1NGRiZjk=
+    MTM0ZjBiN2VhOTIzMGMyYmJlMzUwZTQxMGM3ZWUxMDBiZjdlMzg3ODIyOTU4
+    MjY4ZjczNzY4NjE5YmQxYTFiZjk1MzcwYzk1ZjU0MWM2MTcwN2YzMDVlZDFh
+    NDM4YjUzYzZkNmFiMWRkYzkyNzU3NWUyZjNkYzBiM2Q4M2QxZjQ=

data/README.md

@@ -1,7 +1,7 @@
 RSqoot
 ======
 
-A Ruby Wrapper for [Sqoot](http://www.sqoot.com) [API V2](http://docs.sqoot.com/v2/overview.html).
+A Ruby Wrapper for [Sqoot](http://www.sqoot.com) [API V2](http://docs.sqoot.com/v2/overview.html). With Auto-caching for all APIS, and Auto-increment for deals.
 
 To get the list of available parameters kindly check out [API V2](http://docs.sqoot.com/v2/overview.html)
 
@@ -34,9 +34,13 @@ There’s a handy generator that generates the default configuration file into c
 
     rails g rsqoot:config
 
-You can also change your configuration in your instance, such as below:
+Then, you should be able to use `SqootClient` to search deals. For example:
 
-    sqoot ||= RSqoot::Client.new(public_api_key: "YOUR PUBLIC API KEY")
+    SqootClient.deals(query: 'Home')
+
+You can also change your configuration in your own instance, such as below:
+
+    sqoot ||= RSqoot::Client.new(public_api_key: "YOUR PUBLIC API KEY", private_api_key: 'YOUR PRIVATE API KEY')
 
 #### Basic Usages
 
@@ -95,6 +99,20 @@ If you want to fetch the newest records each time, you can do as below:
 
 By this, it will update the cache by each query.
 
+#### Auto increment for deals
+
+    sqoot.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
+    # => 20 records
+    sqoot.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
 
 1. Fork it

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

@@ -5,4 +5,6 @@ RSqoot.configure do |config|
   # config.authentication_method = :header
   # config.read_timeout = 20
   # config.expired_in = 1.hour
-end
+end
+
+SqootClient ||= RSqoot::Client.new

data/lib/rsqoot/category.rb

@@ -5,7 +5,7 @@ module RSqoot
     #
     # @return [Hashie::Mash] category list
     def categories(options={})
-      updated_by options
+      options = update_by_expire_time options
       query = options.delete(:query)
       if categories_not_latest?(options)
         @rsqoot_categories = get('categories', options)

data/lib/rsqoot/click.rb

@@ -8,7 +8,7 @@ module RSqoot
     #
     # @return [Hashie::Mash]
     def clicks(options={})
-      updated_by options
+      options = update_by_expire_time options
       if clicks_not_latest?(options)
         @rsqoot_clicks = get('clicks', options)
         @rsqoot_clicks = @rsqoot_clicks.clicks if @rsqoot_clicks

data/lib/rsqoot/commission.rb

@@ -8,7 +8,7 @@ module RSqoot
     #
     # @return [Hashie::Mash]
     def commissions(options={})
-      updated_by options
+      options = update_by_expire_time options
       if commissions_not_latest?(options)
         @rsqoot_commissions = get('commissions', options)
         @rsqoot_commissions = @rsqoot_commissions.commissions if @rsqoot_commissions

data/lib/rsqoot/deal.rb

@@ -1,6 +1,5 @@
 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.)
@@ -8,8 +7,9 @@ module RSqoot
     # @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={})
-      updated_by options
+      options = update_by_expire_time options
       if deals_not_latest?(options)
         uniq = !!options.delete(:uniq)
         @rsqoot_deals = get('deals', options) || []
@@ -22,7 +22,7 @@ module RSqoot
     # Retrieve a deal by id
     #
     def deal(id, options={})
-      updated_by options
+      options = update_by_expire_time options
       if deal_not_latest?(id)
         @rsqoot_deal = get("deals/#{id}", options)
         @rsqoot_deal = @rsqoot_deal.deal if @rsqoot_deal
@@ -34,8 +34,9 @@ module RSqoot
       url_generator("deals/#{deal_id}/image", options, require_key = true).first.to_s
     end
 
+    # Auto Increment for deals query.
     def total_sqoot_deals(options = {})
-      @total_deals ||= []
+      @total_deals  ||= []
       @cached_pages ||= []
       page = options[:page] || 1
       check_query_change options
@@ -52,6 +53,10 @@ module RSqoot
 
     attr_reader :cached_pages, :total_deals, :last_deals_query
 
+    # Uniq deals from Sqoot, because there are some many duplicated deals
+    # with different ids
+    # Simplely distinguish them by their titles
+    #
     def uniq_deals(deals = [])
       titles = deals.map(&:title).uniq
       titles.map do |title|
@@ -63,16 +68,29 @@ module RSqoot
       end.flatten
     end
 
+    # A status checker for method :total_sqoot_deals
+    # If the query parameters changed, this will reset the cache
+    # else it will do nothing
+    #
     def check_query_change(options = {})
+      options = update_by_expire_time options
       @last_deals_query ||= ''
-      current_query = options[:query].to_s + options[:category_slugs].to_s
+      current_query = options[:query].to_s
+      current_query += options[:category_slugs].to_s
+      current_query += options[:location].to_s
+      current_query += options[:radius].to_s
+      current_query += options[:online].to_s
+      current_query += options[:expired_in].to_s
+      current_query += options[:per_page].to_s
       if @last_deals_query != current_query
         @last_deals_query = current_query
-        @total_deals = []
+        @total_deals  = []
         @cached_pages = []
       end
     end
 
+    # Helper methods to detect which page is cached
+    #
     def page_cached?(page = 1)
       cached_pages.include? page.to_s
     end

data/lib/rsqoot/helper.rb

@@ -1,6 +1,8 @@
 module RSqoot
   module Helper
 
+    # Add auto-cache helper methods, instances to save the latest query
+    #
     def self.included(base)
       [ 'deals',
         'deal',
@@ -18,6 +20,11 @@ module RSqoot
         end
       end
 
+      # Add categories and providers query helpers
+      # Search categories and providers will be very easy
+      # Such as: query_categories('home&_visiter,friends')
+      # => search records like: home, visiter, friends
+      #
       [ 'categories',
         'providers' ].each do |name|
         base.send :define_method, ('query_' + name).to_sym do |q|
@@ -34,10 +41,13 @@ module RSqoot
       end
     end
 
-    def updated_by(options = {})
+    # Add expired time functionality to this gem
+    # By default is 1.hour, and can be replaced anywhere
+    #
+    def update_by_expire_time(options = {})
       @expired_in = options[:expired_in] if options[:expired_in].present?
       time = Time.now.to_i / expired_in.to_i
-      options.merge!({expired_in: time})
+      options.merge({expired_in: time})
     end
 
   end

data/lib/rsqoot/merchant.rb

@@ -7,7 +7,7 @@ module RSqoot
     # @param [String] namespace (One of the supported namespaces. Factual, Foursquare, Facebook, Google, CitySearch, Yelp.)
 
     def merchant(id, options={})
-      updated_by options
+      options = update_by_expire_time options
       if merchant_not_latest?(id)
         @rsqoot_merchant = get("merchants/#{id}", options)
         @rsqoot_merchant = @rsqoot_merchant.merchant if @rsqoot_merchant

data/lib/rsqoot/provider.rb

@@ -4,7 +4,7 @@ module RSqoot
     #
     # @return [Hashie::Mash]
     def providers(options={})
-      updated_by options
+      options = update_by_expire_time options
       query = options.delete(:query)
       if providers_not_latest?(options)
         @rsqoot_providers = get('providers', options)

data/lib/rsqoot/version.rb

@@ -1,3 +1,3 @@
 module RSqoot
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsqoot
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Felix Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie