tangocard 6.2.0 → 7.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f7d4ed6be48184c160a1fdba063b0a4927dce67
-  data.tar.gz: eab7f8d2e7558c42e1fc45f5a110eb2f52fe6457
+  metadata.gz: 4460feb6c9829bf987ebcee0a5f3bd0b0f045eda
+  data.tar.gz: 2e06c8a3d60c2ffd149b6e0312f5ea0934da3ec9
 SHA512:
-  metadata.gz: 232120b85c5a52108958f0534abda04c4069cb07c7d489a7cfb227eb81071207b0767528c481c1da34b7a265fe081daf7aa265ec67faf36c3119926254c2bfec
-  data.tar.gz: 1a7d9eecaf0a0ca4b0d39a08169061c31f5dc7ebe42accd322f66cc7e25dff1dcbe3498df486eff127bce04ce7aa1a0d44d872c6023f72981884b13c9b8e28da
+  metadata.gz: 647a675699b4fec0423e3d174c28cc532994c2a924c252bab09e33455fb42d7a7b7013d02929cf7b9569a3fd8bcf2b5632c0aafcbe55d44b9e02b94b67e3c846
+  data.tar.gz: a9a36089994b9fec78ba489315da6534fd14a32d85cdc8676fd6226a011559f5275acebc64ac5902da20fbd5522522f6c16e3522740aa5931e5daee0305800df

data/README.md

@@ -44,8 +44,9 @@ There are also optional configuration parameters:
  * `default_brands` - An array of strings for the brands you want to retrieve with `Tangocard::Brand.default`. The strings should match the unique brand `description` fields exactly.
  * `local_images` - An array of local image names/URIs that you want to display instead of the default Tango Card-provided `image_url`. `image_url` is sometimes blank, so this can be handy in those cases.
  * `sku_blacklist` - Reward SKUs that are blacklisted, ie. should never be returned as a purchasable reward.
- * `use_cache` - Use cache for Tangocard::Brand queries, defaults to `true`.
- * `cache_ttl` - Cache time-to-Live in seconds, only effective if `use_cache` is enabled. Default is `0` (cache never expires).
+ * `use_cache` - Use cache for Tangocard::Brand queries, defaults to `true`. The cache can be refreshed by calling `Tangocard.warm_cache`
+ * `cache` - Which cache to use, defaults to `ActiveSupport::Cache::MemoryStore`. Using an out-of-process cache e.g. hosted memcache will improve performance and stability.
+ * `logger` - i.e. `Rails.logger`
 
 ## Getting Started
 

data/lib/tangocard.rb

@@ -1,11 +1,17 @@
 require 'httparty'
 require 'money'
 require 'ostruct'
+require 'active_support'
+require 'active_support/cache/memory_store'
+require 'tangocard/version'
 
 module Tangocard
+
+  CACHE_PREFIX = "tangocard:#{VERSION}:"
+
   class Configuration
     attr_accessor :name, :key, :base_uri, :default_brands, :local_images, :sku_blacklist,
-                  :use_cache, :cache_ttl
+                  :use_cache, :cache, :logger
 
     def initialize
       self.name = nil
@@ -15,7 +21,8 @@ module Tangocard
       self.local_images = {}
       self.sku_blacklist = []
       self.use_cache = true
-      self.cache_ttl = 0
+      self.cache = ActiveSupport::Cache::MemoryStore.new
+      self.logger = Logger.new(STDOUT)
     end
   end
 
@@ -25,6 +32,12 @@ module Tangocard
 
   def self.configure
     yield(configuration) if block_given?
+    warm_cache if configuration.use_cache
+  end
+
+  def self.warm_cache
+    configuration.cache.write("#{Tangocard::CACHE_PREFIX}rewards_index", Tangocard::Raas.rewards_index(use_cache: false))
+    configuration.logger.info('Warmed Tangocard cache')
   end
 end
 
@@ -43,4 +56,3 @@ require 'tangocard/order_not_found_exception'
 require 'tangocard/raas_exception'
 require 'tangocard/reward'
 require 'tangocard/exchange_rate'
-

data/lib/tangocard/brand.rb

@@ -1,18 +1,6 @@
 class Tangocard::Brand
   attr_reader :description, :rewards
 
-  # Clear all cached responses. Next request for brand info will pull fresh from the Tango Card API.
-  #
-  # Example:
-  #   >> Tangocard::Brand.clear_cache!
-  #    => true
-  #
-  # Arguments:
-  #   none
-  def self.clear_cache!
-    Tangocard::Raas.clear_cache!
-  end
-
   # Return an array of all brands.
   #
   # Example:

data/lib/tangocard/exchange_rate.rb

@@ -1,18 +1,6 @@
 class Tangocard::ExchangeRate
   attr_reader :currency_code, :rate
 
-  # Clear all cached responses. Next request for exchange rate info will pull fresh from the Tango Card API.
-  #
-  # Example:
-  #   >> Tangocard::ExchangeRate.clear_cache!
-  #    => true
-  #
-  # Arguments:
-  #   none
-  def self.clear_cache!
-    Tangocard::Raas.clear_cache!
-  end
-
   # Return current currency exchange rate timestamp.
   #
   # Example:

data/lib/tangocard/raas.rb

@@ -1,8 +1,6 @@
 class Tangocard::Raas
   include HTTParty
 
-  @@rewards_response_expires_at = 0
-
   # Create a new account. Returns Tangocard::Response object.
   #
   # Example:
@@ -71,13 +69,9 @@ class Tangocard::Raas
   #
   # Arguments:
   #   none
-  def self.rewards_index
-    if Tangocard.configuration.use_cache
-      clear_cache! if cache_expired?
-
-      @@rewards_response ||= Tangocard::Response.new(get_request('/rewards'))
-      @@rewards_response_expires_at = (Time.now.to_i + Tangocard.configuration.cache_ttl) if cache_expired?
-      @@rewards_response
+  def self.rewards_index(use_cache: true)
+    if Tangocard.configuration.use_cache && use_cache
+      Tangocard.configuration.cache.read("#{Tangocard::CACHE_PREFIX}rewards_index")
     else
       Tangocard::Response.new(get_request('/rewards'))
     end
@@ -127,25 +121,12 @@ class Tangocard::Raas
     Tangocard::Response.new(get_request("/orders#{query_string}"))
   end
 
-  def self.clear_cache!
-    @@rewards_response = nil
-    @@rewards_response_expires_at = 0
-  end
-
   private
 
   def self.basic_auth_param
     { basic_auth: { username: Tangocard.configuration.name, password: Tangocard.configuration.key } }
   end
 
-  def self.use_cache_ttl?
-    Tangocard.configuration.use_cache && Tangocard.configuration.cache_ttl > 0
-  end
-
-  def self.cache_expired?
-    use_cache_ttl? && @@rewards_response_expires_at < Time.now.to_i
-  end
-
   def self.endpoint
     "#{Tangocard.configuration.base_uri}/raas/v1.1"
   end

data/lib/tangocard/version.rb

@@ -1,3 +1,3 @@
 module Tangocard
-  VERSION = '6.2.0'
+  VERSION = '7.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tangocard
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 7.0.2
 platform: ruby
 authors:
 - Raphael Crawford-Marks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2016-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -52,20 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 description: |-
   Tango Card provides a RaaS API for developers (https://www.tangocard.com/docs/raas-api/). This gem
                      provides commonsense Ruby objects to wrap the JSON endpoints of the RaaS API.
@@ -96,7 +110,8 @@ files:
 - lib/tangocard/reward.rb
 - lib/tangocard/version.rb
 homepage: http://bonus.ly
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []