rsqoot 0.4.2 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjMzNmUyNTgxOTMwOWMxYTEwZjgxMjI2ODZjNDcwYjE1NzFkNDdlYw==
+    NzEwOThmZTFmMzUyMjI2ZjE3YzUwMDAwNWQ0YmY5NjUwNWE4ZGFmYQ==
   data.tar.gz: !binary |-
-    NzUyOWVhMzQ5ZWYyZWVhZGIzNTZhODQ2OTg4ODAwY2Y0ZmQ0NzdhOQ==
+    MmJmNzM4Njc3OGEzMTY3NDE4ZTc3YjMyODQyMmU1MmQ0NTRmMDI2Mw==
 SHA512:
   metadata.gz: !binary |-
-    YTBjNzA4MDY5ZWQ4M2FmNjNjODg2YzAxMjBhMTA4OWMxZjViMzUxZDgzYmMw
-    ZDEwNjQwNTJiMmQwYjcwOTQ5Y2M4OGZiYzgyMmIzNTI2Yjg5OTEzMGMwZmRj
-    ZmJkYWNkN2FjMzJiNDI1OWI0M2JkODM0N2E4ODA4N2NjYWM0YzY=
+    M2Y3YjljNmZhNTU4MDMyMDgzNTUzMjE1NDNjNWUwYTlmODkwMzA4NzNlZGY0
+    ODEwYzJlNWYxMGIwMGIyZDliMmJjYzc0MDYzYTY5Y2FkMjc3MzhlNjRjZjJh
+    M2QxMGQ4NzYzZTExYTRmYjA2MzBkYzgwYjFkYmRhNjRmMmUwMjc=
   data.tar.gz: !binary |-
-    MTM0ZjBiN2VhOTIzMGMyYmJlMzUwZTQxMGM3ZWUxMDBiZjdlMzg3ODIyOTU4
-    MjY4ZjczNzY4NjE5YmQxYTFiZjk1MzcwYzk1ZjU0MWM2MTcwN2YzMDVlZDFh
-    NDM4YjUzYzZkNmFiMWRkYzkyNzU3NWUyZjNkYzBiM2Q4M2QxZjQ=
+    M2QxNzE1NTRhNDI3M2RkNWM0YzQ3ZjAwYWQwZTVlZDNiYmNiZjQ0ODU1Y2Nk
+    NTlkNzYwMzJjY2JmZTUzM2EzOGIzYzcyZWQ4ODJkYjk1YjI0NjhhNmM4ZDdi
+    MmZkNTI2OWQ0NTcwZmFjMTNmYzI0ZWNhNmJiNTk5MGQ2ZGY1M2Q=

data/README.md

@@ -9,7 +9,9 @@ To get the list of available parameters kindly check out [API V2](http://docs.sq
 
 Add this line to your application's Gemfile:
 
-    gem 'rsqoot'
+```ruby
+gem 'rsqoot'
+```
 
 And then execute:
 
@@ -27,7 +29,7 @@ Or install it yourself as:
     private_api_key       # YOUR PRIVATE API KEY
     base_api_url          # 'https://api.sqoot.com' by default
     authentication_method # :header by default
-    read_timeout          # 20 by default
+    read_timeout          # 60.seconds 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.
@@ -36,58 +38,64 @@ There’s a handy generator that generates the default configuration file into c
 
 Then, you should be able to use `SqootClient` to search deals. For example:
 
-    SqootClient.deals(query: 'Home')
+```ruby
+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')
+```ruby
+sqoot ||= RSqoot::Client.new(public_api_key: "YOUR PUBLIC API KEY", private_api_key: 'YOUR PRIVATE API KEY')
+```
 
 #### Basic Usages
 
-    sqoot ||= RSqoot::Client.new
+```ruby
+sqoot ||= RSqoot::Client.new
 
-    sqoot.deals
-    #=> returns a list of deals
+sqoot.deals
+#=> returns a list of deals
 
-    sqoot.deals(query: 'travel')
+sqoot.deals(query: 'travel')
 
-    sqoot.deals(location: 'Chicago')
+sqoot.deals(location: 'Chicago')
 
-    sqoot.deals(location: 'Chicago', per_page: 10)
+sqoot.deals(location: 'Chicago', per_page: 10)
 
-    sqoot.deals(location: 'Chicago', per_page: 10, categories: 'health-beauty', page: 2)
+sqoot.deals(location: 'Chicago', per_page: 10, categories: 'health-beauty', page: 2)
 
-    sqoot.deals(price_at_least: 10, order: :commission_desc)
+sqoot.deals(price_at_least: 10, order: :commission_desc)
 
-    sqoot.impression(1555288, geometry: '250x250C')
-    # => return deal_id 1555288's image url which size is 250x250
+sqoot.impression(1555288, geometry: '250x250C')
+# => return deal_id 1555288's image url which size is 250x250
 
-    sqoot.deal(1555288).url
-    # => return a click url which will redirect to another url
+sqoot.deal(1555288).url
+# => return a click url which will redirect to another url
 
-    sqoot.providers
-    # => returns a list of providers
+sqoot.providers
+# => returns a list of providers
 
-    sqoot.providers(query: 'Groupon')
+sqoot.providers(query: 'Groupon')
 
-    sqoot.categories
-    # => returns a list of categories
+sqoot.categories
+# => returns a list of categories
 
-    sqoot.categories(query: 'home')
-    sqoot.categories(query: 'home&health')
-    sqoot.categories(query: 'home,health')
+sqoot.categories(query: 'home')
+sqoot.categories(query: 'home&health')
+sqoot.categories(query: 'home,health')
 
-    sqoot.commissions
-    # => returns current month commissions
+sqoot.commissions
+# => returns current month commissions
 
-    sqoot.commissions(to: '2012-01-01', from: '2012-01-20')
-    # => returns commissions using date_range :to & :from
+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
+# => 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
+sqoot.clicks(to: '2012-01-01', from: '2012-01-20')
+# => returns clicks using date_range :to & :from
+```
 
 #### Auto Cache
 
@@ -95,22 +103,26 @@ 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', expired_in: 1.second)
+```ruby
+sqoot.deals(location: 'Chicago', expired_in: 1.second)
+```
 
 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.
+```ruby
+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
+# 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.
+# But once you change your query options, it will re-cache the records.
+```
 
 
 ## Contributing

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

@@ -1,10 +1,10 @@
 RSqoot.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.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
-  # config.expired_in = 1.hour
+  # config.read_timeout          = 60.seconds
+  # config.expired_in            = 1.hour
 end
 
 SqootClient ||= RSqoot::Client.new

data/lib/rsqoot/category.rb

@@ -3,12 +3,12 @@ module RSqoot
 
     # Retrieve a list of categories base on the following parameters
     #
-    # @return [Hashie::Mash] category list
+    # @return [RSqoot::SqootCategory] category list
     def categories(options={})
       options = update_by_expire_time options
       query = options.delete(:query)
       if categories_not_latest?(options)
-        @rsqoot_categories = get('categories', options)
+        @rsqoot_categories = get('categories', options, SqootCategory)
         @rsqoot_categories = @rsqoot_categories.categories.map(&:category) if @rsqoot_categories
       end
       query.present? ? query_categories(query) : @rsqoot_categories

data/lib/rsqoot/click.rb

@@ -6,11 +6,11 @@ module RSqoot
     # @param [String] :to Start date
     # @param [String] :from End date
     #
-    # @return [Hashie::Mash]
+    # @return [RSqoot::SqootClick]
     def clicks(options={})
       options = update_by_expire_time options
       if clicks_not_latest?(options)
-        @rsqoot_clicks = get('clicks', options)
+        @rsqoot_clicks = get('clicks', options, SqootClick)
         @rsqoot_clicks = @rsqoot_clicks.clicks if @rsqoot_clicks
       end
       @rsqoot_clicks

data/lib/rsqoot/commission.rb

@@ -6,11 +6,11 @@ module RSqoot
     # @param [String] :to Start date
     # @param [String] :from End date
     #
-    # @return [Hashie::Mash]
+    # @return [RSqoot::SqootCommission]
     def commissions(options={})
       options = update_by_expire_time options
       if commissions_not_latest?(options)
-        @rsqoot_commissions = get('commissions', options)
+        @rsqoot_commissions = get('commissions', options, SqootCommission)
         @rsqoot_commissions = @rsqoot_commissions.commissions if @rsqoot_commissions
       end
       @rsqoot_commissions

data/lib/rsqoot/deal.rb

@@ -12,7 +12,7 @@ module RSqoot
       options = update_by_expire_time options
       if deals_not_latest?(options)
         uniq = !!options.delete(:uniq)
-        @rsqoot_deals = get('deals', options) || []
+        @rsqoot_deals = get('deals', options, SqootDeal) || []
         @rsqoot_deals = @rsqoot_deals.deals.map(&:deal) if !@rsqoot_deals.empty?
         @rsqoot_deals = uniq_deals(@rsqoot_deals) if uniq
       end
@@ -24,7 +24,7 @@ module RSqoot
     def deal(id, options={})
       options = update_by_expire_time options
       if deal_not_latest?(id)
-        @rsqoot_deal = get("deals/#{id}", options)
+        @rsqoot_deal = get("deals/#{id}", options, SqootDeal)
         @rsqoot_deal = @rsqoot_deal.deal if @rsqoot_deal
       end
       @rsqoot_deal

data/lib/rsqoot/helper.rb

@@ -1,3 +1,4 @@
+require 'hashie/mash'
 module RSqoot
   module Helper
 
@@ -39,6 +40,17 @@ module RSqoot
         end
         base.class_eval { private ('query_' + name).to_sym }
       end
+
+      # Add Wrappers: Deal, Category, Commission, Merchant, Provider, Click
+      [ 'SqootDeal',
+        'SqootCategory',
+        'SqootCommission',
+        'SqootMerchant',
+        'SqootProvider',
+        'SqootClick'].each do |class_name|
+        new_class = Class.new(::Hashie::Mash)
+        RSqoot.const_set class_name, new_class
+      end
     end
 
     # Add expired time functionality to this gem

data/lib/rsqoot/merchant.rb

@@ -9,7 +9,7 @@ module RSqoot
     def merchant(id, options={})
       options = update_by_expire_time options
       if merchant_not_latest?(id)
-        @rsqoot_merchant = get("merchants/#{id}", options)
+        @rsqoot_merchant = get("merchants/#{id}", options, SqootMerchant)
         @rsqoot_merchant = @rsqoot_merchant.merchant if @rsqoot_merchant
       end
       @rsqoot_merchant

data/lib/rsqoot/provider.rb

@@ -2,12 +2,12 @@ module RSqoot
   module Provider
     # Retrieve a list of providers base on the following parameters
     #
-    # @return [Hashie::Mash]
+    # @return [RSqoot::SqootProvider]
     def providers(options={})
       options = update_by_expire_time options
       query = options.delete(:query)
       if providers_not_latest?(options)
-        @rsqoot_providers = get('providers', options)
+        @rsqoot_providers = get('providers', options, SqootProvider)
         @rsqoot_providers = @rsqoot_providers.providers.map(&:provider) if @rsqoot_providers
       end
       query.present? ? query_providers(query) : @rsqoot_providers

data/lib/rsqoot/request.rb

@@ -1,15 +1,14 @@
 require 'open-uri'
-require 'hashie/mash'
 require 'json'
 
 module RSqoot
   module Request
 
-    def get(path, opts = {})
+    def get(path, opts = {}, wrapper = ::Hashie::Mash)
       uri, headers = url_generator(path, opts)
       begin
         json = JSON.parse uri.open(headers).read
-        result = ::Hashie::Mash.new json
+        result = wrapper.new json
         @query_options = result.query
         result
       rescue

data/lib/rsqoot/version.rb

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

data/lib/rsqoot.rb

@@ -21,7 +21,7 @@ module RSqoot
     def load_defaults
       self.base_api_url ||= "https://api.sqoot.com"
       self.authentication_method = :header
-      self.read_timeout = 60
+      self.read_timeout = 60.seconds
       self.expired_in = 1.hour
     end
 

metadata

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