redis_token 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8661570273e3ba7ce99b0b96c4412c439c04501f
-  data.tar.gz: 301b2b1af39cb1e3edf93f6affb794b37b21b365
+  metadata.gz: 84a99d9c046e1eb837705dca92549fc3061b47ab
+  data.tar.gz: 9a841fbadb69db584aba0717c158191e24daedc0
 SHA512:
-  metadata.gz: 6d37f7342a1a40a519e1f3084a112cce0c27f53b10b4cab0eaaa93ab5c081359007e061de22fb219c36935863b4b580a04112d515cce9576e56a3ea5e612d62d
-  data.tar.gz: 36f674da4617ca39f6bc88757c3134a5af7662ac66eb29c2fa18f2bbe6c6d9ae98476fa24b96012d2029fb3531ae311e7839c813139126a6e42346f880a338b4
+  metadata.gz: 4baad3526458c71db2fa647f55c092d5e0e31f9b64b5459d9f10ad36d216f7de78f864f2ff0a7757c8ec423debeb7fbf27d5de23db398e482e52c90ac9435071
+  data.tar.gz: f861fd550a022cdb802daa1c1f88a784b62a35fa41f6c52f23ac5b8494c5064a9df4be3aaad237d841ac111fbf96840e685f94f83c4d2d1ca69124bb6545aa68

data/README.md

@@ -27,7 +27,7 @@ def auth
   client = Client.find_by_email(params[:email])
 
   if client.password == params[:password]
-    token = @redis_token.create("client.#{client.id}", payload: { source: :native })
+    token = @redis_token.create(owner: "client.#{client.id}", payload: { source: :native })
     json(access_token: token)
 
     # ...
@@ -47,10 +47,9 @@ def secured_method
 end
 
 def client_tokens
-  @tokens = []
 
-  @redis_token.owned_by("client.#{client.id}").each do |token, value|
-    @tokens << { token: token, value: value }
+  @tokens = @redis_token.owned_by("client.#{client.id}").map do |token, value|
+    { token: token, value: value }
   end
 end
 
@@ -84,20 +83,24 @@ r = RedisToken.new(redis)
 ### Create token
 
 ```ruby
-client_token = r.create("client.#{client.id}")
+client_token = r.create(owner: "client.#{client.id}")
 # => "eca431add3b1f0bbc6cfc73980b68708"
 
 # Redefine default ttl:
-user_token = r.create("u:#{current_user.id}", ttl: 15.hours)
+user_token = r.create(owner: "u:#{current_user.id}", ttl: 15.hours)
 # => "548a5d54eaf474c750bf83ed04bd242a"
 
 # Create token with payload:
-mobile_token = r.create("c.#{client.id}", payload: { source: :native })
+mobile_token = r.create(owner: "c.#{client.id}", payload: { source: :native })
 # => "865249d6b87c4e6dd8f6b0796ace7fa0"
 
 # Save exist token:
-r.create('api', token: SecureRandom.uuid)
+r.create(owner: 'api', token: SecureRandom.uuid)
 # => "aed6e179-14b4-4a8c-9a1b-6b0f9150ede3"
+
+# Token without an owner:
+r.create
+# => "9dfb0d52280965fe4dd95d21447941c2"
 ```
 
 ### Get token
@@ -116,6 +119,10 @@ r.ttl('865249d6b87c4e6dd8f6b0796ace7fa0')
 
 # To prevent ttl sliding set slide_expire to false:
 r.get('865249d6b87c4e6dd8f6b0796ace7fa0', slide_expire: false)
+
+# Token without an owner:
+rt.get('9dfb0d52280965fe4dd95d21447941c2')
+# => {:at=>1503327773}
 ```
 
 ### Get all tokens owned by someone
@@ -132,19 +139,32 @@ r.owned_by('u.555').each { |t,v| p "#{t}: #{v}" }
 # => nil
 ```
 
-### Delete token
+### Deletion
 
+Single token:
 ```ruby
 r.delete('865249d6b87c4e6dd8f6b0796ace7fa0')
 # => true
 ```
 
-### Delete all tokens of an owner
+All tokens of an owner:
 ```ruby
-r.delete_all('client.1')
+r.delete_owned_by('client.1')
 # => 8
 ```
 
+All tokens without an owner:
+```ruby
+r.delete_without_owner
+# => 1
+```
+
+All tokens:
+```ruby
+r.delete_all
+# => 99
+```
+
 ### Serialization
 
 redis_token uses native Marshal class for data serialization by default. You can override it like this:

data/lib/redis_token/version.rb

@@ -1,3 +1,3 @@
 class RedisToken
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.7'.freeze
 end

data/lib/redis_token.rb

@@ -9,7 +9,7 @@ require 'time'
 class RedisToken
   # Token lives 14 days by default
   DEFAULT_TTL = 14 * 24 * 60 * 60
-  DEFAULT_PREFIX = 'tokens.'.freeze
+  DEFAULT_PREFIX = 'tokens'.freeze
 
   attr_reader :redis
   attr_accessor :default_ttl
@@ -43,18 +43,19 @@ class RedisToken
 
   # Create a new token
   #
-  # @param [String] owner owner of a token, e.g. 'client.1' or 'user-123'
   # @param [Hash] args
+  # @option args [String] :owner owner of a token, e.g. 'client.1' or 'user-123'
   # @option args [String] :token (SecureRandom.hex(16)) user defined token
   # @option args :payload
   # @option args [Integer] :ttl redefines the default ttl
   #
   # @return [String] a new token
-  def create(owner, args = {})
-    raise 'owner should be specified' unless owner
-
+  def create(args = {})
     token = args[:token] || generate_token
-    value = { owner: owner, at: Time.now.to_i }
+    value = { at: Time.now.to_i }
+
+    owner = args[:owner]
+    value[:owner] = owner if owner
 
     payload = args[:payload]
     value[:payload] = payload if payload
@@ -106,6 +107,7 @@ class RedisToken
     key = token_to_key(token)
     value = redis_get(key)
     return false unless value
+
     value[:payload] = args[:payload]
 
     key_ttl = args[:ttl] || @redis.ttl(key)
@@ -124,7 +126,21 @@ class RedisToken
   #
   # @return [Enumerator]
   def owned_by(owner)
-    owned_tokens(owner).map { |token| [token, redis_get(token_to_key(token))] }
+    owned_tokens(owner)
+  end
+
+  # Tokens without an owner
+  #
+  # @return [Enumerator]
+  def without_owner
+    owned_tokens
+  end
+
+  # All tokens
+  #
+  # @return [Enumerator]
+  def all
+    all_tokens
   end
 
   # Delete a token
@@ -132,7 +148,7 @@ class RedisToken
   # @param [String] token
   #
   # @return [Boolean]
-  def del(token)
+  def delete(token)
     key = token_to_key(token)
     value = redis_get(key)
     return false unless value
@@ -145,24 +161,30 @@ class RedisToken
     true
   end
 
-  alias delete del
+  alias del delete
 
   # Delete all tokens of an owner
   #
   # @params [String] owner
   #
   # @return [Integer] number of deleted tokens
-  def del_all(owner)
-    deleted = 0
-    owned_tokens(owner).each do |token|
-      del(token)
-      deleted += 1
-    end
+  def delete_owned_by(owner)
+    delete_tokens(owned_tokens(owner))
+  end
 
-    deleted
+  # Delete tokens without an owner
+  #
+  # @return [Integer] number of deleted tokens
+  def delete_without_owner
+    delete_tokens(owned_tokens)
   end
 
-  alias delete_all del_all
+  # Delete all tokens
+  #
+  # @return [Integer] number of deleted tokens
+  def delete_all
+    delete_tokens(all_tokens)
+  end
 
   # Retrieve the remaining ttl of a token
   #
@@ -201,7 +223,7 @@ class RedisToken
   #     end
   #   end
   #
-  #   RedisToken.new(prefix: PREFIX).use(MsgPackSerializer)
+  #   r = RedisToken.new.use(MsgPackSerializer)
   #
   # @param [Object] serializer_class
   #
@@ -226,15 +248,19 @@ class RedisToken
   end
 
   def token_to_key(token)
-    "#{@prefix}#{token}"
+    "#{@prefix}.t.#{token}"
   end
 
   def token_to_owner(owner, token)
-    "#{@prefix}#{owner}.#{token}"
+    "#{@prefix}.o.#{owner}.#{token}"
   end
 
   def owner_key_to_token(owner, key)
-    key.sub("#{@prefix}#{owner}.", '')
+    key.sub("#{@prefix}.o.#{owner}.", '')
+  end
+
+  def key_to_token(key)
+    key.sub("#{@prefix}.t.", '')
   end
 
   def redis_get(key)
@@ -243,8 +269,16 @@ class RedisToken
     serializer.unpack(value)
   end
 
-  def owned_tokens(owner)
-    mask = "#{@prefix}#{owner}.*"
+  def owned_tokens(owner = nil)
+    iterator(owner)
+  end
+
+  def all_tokens
+    iterator(nil, true)
+  end
+
+  def iterator(owner = nil, all = false)
+    mask = all ? "#{@prefix}.t.*" : "#{@prefix}.o.#{owner}.*"
 
     Enumerator.new do |y|
       cursor = '0'
@@ -252,8 +286,7 @@ class RedisToken
         cursor, r = @redis.scan(cursor, match: mask)
 
         r.each do |key|
-          token = owner_key_to_token(owner, key)
-          y << token
+          y << (all ? key_to_token(key) : owner_key_to_token(owner, key))
         end
 
         break if cursor == '0'
@@ -261,12 +294,19 @@ class RedisToken
     end
   end
 
+  def delete_tokens(enum)
+    enum.reduce(0) do |deleted, token|
+      del(token)
+      deleted += 1
+    end
+  end
+
   def serializer
     @serializer ||= @serializer_class.new
   end
 
   # Some serializers can't store symbols out of the box
   def hash_get(hash, sym)
-    hash.key?(sym) ? hash[sym] : hash[sym.to_s]
+    hash.fetch(sym, hash[sym.to_s])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_token
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Artem Baikuzin