simple_cacher 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 576f933f6320c8664f9a67d49b3698024c27029a
-  data.tar.gz: cadea424ed9eabc1bc1f9769244cffda813c3335
+  metadata.gz: 66973e874b55d97a1c153fb4f320335064c95e62
+  data.tar.gz: 2247514996e98307c6a6621217ed84cbb1b332ef
 SHA512:
-  metadata.gz: cb0d74c12d9b6ed68af4318ee1fd7f3a1da9932378e63192efb44c197280478ff90a723e768e1c3bf08980541826951328f2c57a8055c9442780a894eb83e5ed
-  data.tar.gz: ca89b2abc33f7209fed03ffd46ec30817cb3ff239b1a2127724121b3ae48daf1015199cd4a97e110ac4fa7be1ffb122120de9fefff62f94636a4db7e7aa0fc71
+  metadata.gz: b80c9ae76dbf0cfa2f0a0c1572b2060bac5e6ce1f8d02cc9e12d9d6b8eee4ca5d3bcf75f03571f2a873c85f375931904060dc06a7b5d0e8706163ef20d6989e3
+  data.tar.gz: 826f423ddf305cc23b944c5f188cd7c46a05546788d6e24ff0c5aa3120efbeb633d4c88d3e9fef3377728a735ebc99f429465655530a53c6fd0de5d0e3004b6c

data/README.md

@@ -1,10 +1,6 @@
 # SimpleCacher [![Build Status](https://travis-ci.org/zw963/simple_cacher.svg?branch=master)](https://travis-ci.org/zw963/simple_cacher) [![Gem Version](https://badge.fury.io/rb/simple_cacher.svg)](http://badge.fury.io/rb/simple_cacher)
 
-TODO: Write a gem description
-
-## Philosophy
-
-TODO: Write philosophy
+A very simple use/implement but very useful cacher, use Redis database.
 
 ## Getting Started
 
@@ -20,12 +16,38 @@ Add to your Gemfile
 
 ## Usage
 
-TODO: Write usage instructions here
+### Use as a home page cache, expired within 120 second.
+
+```rb
+# The first step is need specify a namespace, one string which should unique each other
+# for different purpose, in this current case (one Rails controller action), `request.url'
+# is a perfect candidate.
+cacher = SimpleCacher.new(namespace: request.url)
+
+if cacher.fresh?(key: 'items')
+  @items_hash = cacher.import(key: 'items')
+else
+  # do something get correct data and assign to a variable items_hash
+  @items_hash = cacher.export(key: 'items', data: items_hash, expire: 120)
+end
+```
+
+### Use as a counter, limit IP access during a time span.
+
+```rb
+counter = SimpleCacher.new(namespace: 'my_api:sms_log:user_ip')
+
+# Sum IP 123.123.123.123 access count in one day, 
+if counter.reach_limit?(key: '123.123.123.123', limit: 5, expire: 86400)
+  # if exceed the limit, sent a warn info
+else
+  # do some sutff
+end
+```  
 
 ## Support
 
-  * MRI 1.9.3+
-  * Rubinius 2.2+
+Still not test, should work in recent ruby version, the only dependency is [redis-rb](https://github.com/redis/redis-rb)
 
 ## Limitations
 

data/lib/simple_cacher.rb

@@ -16,44 +16,37 @@ class SimpleCacher
     if redis.exists(key)
       JSON.load(redis.get(key))
     else
-      fail 'Key not exist, import failed!'
+      fail 'Import failed, key not exist!'
     end
   end
 
   def export(key:, data: nil, expire: nil)
     key = nskey(key)
+    nx = __callee__ == :export
     expire = Integer(expire) unless expire.nil?
 
-    if redis.setnx(key, data.to_json)
-      redis.expire(key, expire) unless expire.nil?
+    if redis.set(key, data.to_json, nx: nx, ex: expire)
       JSON.load(redis.get(key))
     else
-      fail 'Key alreday exist in cacher, export failed!'
+      fail 'Export failed, key was exist!'
     end
   end
-
-  def expire!(key)
-    key = nskey(key)
-
-    redis.expire(key, -1)
-  end
+  alias export! export
 
   def reach_limit?(key:, limit:, expire: nil)
     key = nskey(key)
     expire = Integer(expire) unless expire.nil?
-    limit = Integer(limit)
 
     if redis.exists(key)
-      redis.incr(key) > limit ? true : false
+      redis.incr(key) > Integer(limit) ? true : false
     else
-      redis.set(key, '1')
-      redis.expire(key, expire) unless expire.nil?
+      redis.set(key, '1', ex: expire)
       false
     end
   end
 
   def fresh?(key:)
-    # if in develpment mode, not use cache
+    # if use with rails in develpment mode, not detect key existance.
     return false if defined?(Rails) && Rails.env.development?
 
     redis.exists(nskey(key))

data/lib/simple_cacher/version.rb

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 module SimpleCacher
-  VERSION = [0, 0, 8]
+  VERSION = [0, 0, 9]
 
   class << VERSION
     def to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_cacher
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Billy.Zheng(zw963)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: ''