rsqoot 0.3.2 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzRiNzhlZDIxNWVjY2ViNWJkZDI0ODAwNjczMzc4ODVmYzA2MGI0ZQ==
+    NDQ0NmYzYTJhMWVjODg4NjVhM2M4ZTZhNTkyNzU1NDI4OGM1Mjc2Ng==
   data.tar.gz: !binary |-
-    ZWIwYTFiZTkwZDdkNDIyOTA0MzFjZTk4ZDVkM2E1ZTMyZjQzZDU3MA==
+    NzFmOTMzNWJjOWY1OGQyYTEyZDVmZjEwMTEwZDFiZjVkN2YyM2I5Zg==
 SHA512:
   metadata.gz: !binary |-
-    Y2ZkZjFjNTU0ZjRlMWZhNWExOWM0MGY2MjI4MzRjZDRkMGMzM2JiMmJkYzkx
-    MWFkNWRmNDI4MzU1MDc1MTgyN2VjMjgyYTFiN2YyZDE3MWU4YTg0YTM5MGY3
-    Zjg0OTYwMTM3M2M4MDk1YzQ5ZWZhN2VkYTkxYzNkYmNjZDM5ZjY=
+    NDdjZTFhYjQ3ZjliNGI3NWQ3MTliYzIyZWNhMTdhMjliMDM0MmQzOThkMjA2
+    ZjI0NTM0NTYxZDNlNjk1MjZiZGMzM2UyNzVhNTZkMGJjZTM3YjhjNTI3MjBh
+    ZGE1MDlkYjdlMmZkMjM3MDdkZTA0ZDgwOTVkODJmZDUzZjdmNmU=
   data.tar.gz: !binary |-
-    NzFkNDE2NDRjZWZhNTEyNzE2ODRkNWYyODBjYjJhZTUyYzJlOGU3MmRkMzk2
-    YTJmYmVhNDcxMDdlMzdiNTgwZTNlMTk3NzI2YWE3MDk2ZGI0NmZlOTIzNzY5
-    NDEwMmZkYTcxMDUxZmRkNzUzYTM0NjcyODNlM2NkYTQzMDBmYmU=
+    NzIzMzE3ZTEwYmQ1MTRhNzhlMGZkZTZjMTc4ZjcxNDIxMDBkYzg3MDkxNTNi
+    ZjhlMDhhYTk3NzM3ODcyZWI2MWU2M2E3MjkzNDkxMGM0NTEwNGM5MjJiYzA3
+    ZWNlZDFkNzRmZDlmNTYyZTRjZDI4ZGM5NjQyY2NjYmRkYjJmNzg=

data/README.md

@@ -30,6 +30,7 @@ Or install it yourself as:
     base_api_url          # 'https://api.sqoot.com' by default
     authentication_method # :header by default
     read_timeout          # 20 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.
 
@@ -46,6 +47,8 @@ You can also change your configuration in your instance, such as below:
     sqoot.deals
     #=> returns a list of deals
 
+    sqoot.deals(query: 'travel')
+
     sqoot.deals(location: 'Chicago')
 
     sqoot.deals(location: 'Chicago', per_page: 10)
@@ -63,6 +66,15 @@ You can also change your configuration in your instance, such as below:
     sqoot.providers
     # => returns a list of providers
 
+    sqoot.providers(query: 'Groupon')
+
+    sqoot.categories
+    # => returns a list of categories
+
+    sqoot.categories(query: 'home')
+    sqoot.categories(query: 'home&health')
+    sqoot.categories(query: 'home,health')
+
     sqoot.commissions
     # => returns current month commissions
 
@@ -81,10 +93,15 @@ 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:
 
-    sqoot.deals(location: 'Chicago', time: Time.now)
+    sqoot.deals(location: 'Chicago', expired_in: 1.second)
 
 By this, it will update the cache by each query.
 
+## TODO
+
++ Add auto-caching in config file
++ Add cache expire time in config file
+
 ## Contributing
 
 1. Fork it

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

@@ -4,4 +4,5 @@ RSqoot.configure do |config|
   # config.base_api_url = 'https://api.sqoot.com'
   # config.authentication_method = :header
   # config.read_timeout = 20
+  # config.expired_in = 1.hour
 end

data/lib/rsqoot/category.rb

@@ -5,11 +5,14 @@ module RSqoot
     #
     # @return [Hashie::Mash] category list
     def categories(options={})
+      updated_by options
+      query = options.delete(:query)
       if categories_not_latest?(options)
         @rsqoot_categories = get('categories', options)
-        @rsqoot_categories = @rsqoot_categories.categories if @rsqoot_categories
+        @rsqoot_categories = @rsqoot_categories.categories.map(&:category) if @rsqoot_categories
       end
-      @rsqoot_categories
+      query.present? ? query_categories(query) : @rsqoot_categories
     end
+
   end
 end

data/lib/rsqoot/click.rb

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

data/lib/rsqoot/client.rb

@@ -18,14 +18,15 @@ module RSqoot
     include Provider
     include Request
 
-    attr_reader :public_api_key, :private_api_key, :base_api_url, :authentication_method, :read_timeout
+    attr_reader :public_api_key, :private_api_key, :base_api_url, :authentication_method, :read_timeout, :query_options, :expired_in
 
     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
+      @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
+      @read_timeout          = options[:read_timeout]          || RSqoot.read_timeout
+      @expired_in            = options[:expired_in]            || RSqoot.expired_in
     end
 
   end

data/lib/rsqoot/commission.rb

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

data/lib/rsqoot/deal.rb

@@ -9,9 +9,12 @@ module RSqoot
     # @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
       if deals_not_latest?(options)
+        uniq = !!options.delete(:uniq)
         @rsqoot_deals = get('deals', options) || []
         @rsqoot_deals = @rsqoot_deals.deals.map(&:deal) if !@rsqoot_deals.empty?
+        @rsqoot_deals = uniq_deals(@rsqoot_deals) if uniq
       end
       @rsqoot_deals
     end
@@ -19,6 +22,7 @@ module RSqoot
     # Retrieve a deal by id
     #
     def deal(id, options={})
+      updated_by options
       if deal_not_latest?(id)
         @rsqoot_deal = get("deals/#{id}", options)
         @rsqoot_deal = @rsqoot_deal.deal if @rsqoot_deal
@@ -30,5 +34,18 @@ module RSqoot
       url_generator("deals/#{deal_id}/image", options, require_key = true).first.to_s
     end
 
+    private
+
+    def uniq_deals(deals = [])
+      titles = deals.map(&:title).uniq
+      titles.map do |title|
+        deals.map do |deal|
+          if deal.try(:title) == title
+            deal
+          end
+        end.compact.last
+      end.flatten
+    end
+
   end
 end

data/lib/rsqoot/helper.rb

@@ -1,5 +1,6 @@
 module RSqoot
   module Helper
+
     def self.included(base)
       [ 'deals',
         'deal',
@@ -16,6 +17,28 @@ module RSqoot
           result
         end
       end
+
+      [ 'categories',
+        'providers' ].each do |name|
+        base.send :define_method, ('query_' + name).to_sym do |q|
+          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|
+                c.slug =~ Regexp.new(q)
+              end
+            end.flatten.compact.uniq
+          end
+        end
+        base.class_eval { private ('query_' + name).to_sym }
+      end
+    end
+
+    def updated_by(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})
     end
+
   end
 end

data/lib/rsqoot/merchant.rb

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

data/lib/rsqoot/provider.rb

@@ -4,11 +4,14 @@ module RSqoot
     #
     # @return [Hashie::Mash]
     def providers(options={})
+      updated_by options
+      query = options.delete(:query)
       if providers_not_latest?(options)
         @rsqoot_providers = get('providers', options)
-        @rsqoot_providers = @rsqoot_providers.providers if @rsqoot_providers
+        @rsqoot_providers = @rsqoot_providers.providers.map(&:provider) if @rsqoot_providers
       end
-      @rsqoot_providers
+      query.present? ? query_providers(query) : @rsqoot_providers
     end
+
   end
 end

data/lib/rsqoot/request.rb

@@ -9,7 +9,9 @@ module RSqoot
       uri, headers = url_generator(path, opts)
       begin
         json = JSON.parse uri.open(headers).read
-        ::Hashie::Mash.new json
+        result = ::Hashie::Mash.new json
+        @query_options = result.query
+        result
       rescue
         nil
       end

data/lib/rsqoot/version.rb

@@ -1,3 +1,3 @@
 module RSqoot
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

data/lib/rsqoot.rb

@@ -1,16 +1,10 @@
+require "active_support/core_ext"
 require "rsqoot/client"
 
-# load Rails/Railtie
-begin
-  require 'rails'
-rescue LoadError
-  #do nothing
-end
-
 module RSqoot
 
   class << self
-    attr_accessor :public_api_key, :private_api_key, :base_api_url, :authentication_method, :read_timeout
+    attr_accessor :public_api_key, :private_api_key, :base_api_url, :authentication_method, :read_timeout, :expired_in
 
     # Configure default credentials easily
     #
@@ -28,6 +22,7 @@ module RSqoot
       self.base_api_url ||= "https://api.sqoot.com"
       self.authentication_method = :header
       self.read_timeout = 60
+      self.expired_in = 1.hour
     end
 
     private

data/rsqoot.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency "hashie", "~> 2.0.0"
   s.add_dependency "json", "~> 1.7.0"
+  s.add_dependency "activesupport", ">= 3.0.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsqoot
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Felix Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2013-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: A Ruby Wrapper for Sqoot API V2.
 email:
 - lyfeyaj@gmail.com