redis_token 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcf6777bd64b7edcf40d35f801b5d4c02710aa15
-  data.tar.gz: 36d9f23b0639760c52e6da3542a5ddc42e6daa03
+  metadata.gz: 875d8513b286fd87257c6f5dfb329b290651e18b
+  data.tar.gz: 3d95c64ffa4c45c18cb1696ce3a42e9de07ae042
 SHA512:
-  metadata.gz: c0f69f527ca4b973da240aac91d68cd8b41e3e9bed3cddd58e07db4581c103b6f356dae807047b7ed0f65d1908d55ee2133a239e3ef7128971ee79ab235ff834
-  data.tar.gz: 4e0db086c2aad9462374682414f0cb9239ec9cd35d4cf48be397fe4899e7ad4d5a57fecb05c3225f4cd10c3a390589de757aab21cf2c385d53b755f7fa532723
+  metadata.gz: c907b23ac817799726c69fcbe206bbfd160c61eda0b074eda50dec93dc2f4ddd47272f92e8af807df2f928023d125656f474442930ef4252cac1ca8b601ce3cf
+  data.tar.gz: 72d605d0d3f28e5e6b7256e383d6224ec63533dd49b202a017a2e2e419c1d4a3a40a1b433e4254f280e6a1b07b71c0282f45025693e69af9fee26002bd3929f5

data/README.md

@@ -94,6 +94,10 @@ user_token = r.create("u:#{current_user.id}", ttl: 15.hours)
 # Create token with payload:
 mobile_token = r.create("c.#{client.id}", payload: { source: :native })
 # => "865249d6b87c4e6dd8f6b0796ace7fa0"
+
+# Save exist token:
+r.create('api', token: SecureRandom.uuid)
+# => "aed6e179-14b4-4a8c-9a1b-6b0f9150ede3"
 ```
 
 ### Get token
@@ -140,3 +144,26 @@ r.delete('865249d6b87c4e6dd8f6b0796ace7fa0')
 r.delete_all('client.1')
 # => 8
 ```
+
+### Serialization
+
+redis_token uses native Marshal class for data serialization by default. You can override it like this:
+
+```ruby
+require 'msgpack'
+
+class MsgPackSerializer
+  def pack(value)
+    MessagePack.pack(value)
+  end
+
+  def unpack(value)
+    MessagePack.unpack(value)
+  end
+end
+
+r = RedisToken.new(prefix: PREFIX, serializer_class: MsgPackSerializer)
+# Or
+r = RedisToken.new(prefix: PREFIX)
+r.use(MsgPackSerializer)
+```

data/lib/redis_token/serializers/native.rb

@@ -0,0 +1,13 @@
+class RedisToken
+  class Serializers
+    class Native
+      def pack(value)
+        Marshal.dump(value)
+      end
+
+      def unpack(value)
+        Marshal.load(value)
+      end
+    end
+  end
+end

data/lib/redis_token/version.rb

@@ -1,3 +1,3 @@
 class RedisToken
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.0.5'.freeze
 end

data/lib/redis_token.rb

@@ -1,4 +1,6 @@
 require 'redis_token/version'
+require 'redis_token/serializers/native'
+
 require 'redis'
 
 require 'securerandom'
@@ -25,6 +27,7 @@ class RedisToken
   # @param [Hash] args
   # @option args [String] :prefix redis keys prefix (e.g. 'myproject.tokens.')
   # @option args [Integer] :ttl token time to live value (14 days by default)
+  # @option args [Class] :serializer_class serialization class, see RedisToken::Serializers::Native, or #use method
   #
   # @return [RedisToken] a new RedisToken instance
   def initialize(args = {}, opts = {})
@@ -41,6 +44,7 @@ class RedisToken
   #
   # @param [String] owner owner of a token, e.g. 'client.1' or 'user-123'
   # @param [Hash] args
+  # @option args [String] :token (SecureRandom.hex(16)) user defined token
   # @option args :payload
   # @option args [Integer] :ttl redefines the default ttl
   #
@@ -49,7 +53,7 @@ class RedisToken
     raise 'owner should be specified' unless owner
 
     token = args[:token] || generate_token
-    value = { owner: owner, at: Time.now }
+    value = { owner: owner, at: Time.now.to_i }
 
     payload = args[:payload]
     value[:payload] = payload if payload
@@ -58,7 +62,7 @@ class RedisToken
     key_ttl = args[:ttl] || @default_ttl
 
     @redis.multi do |multi|
-      multi.set(token_to_key(token), Marshal.dump(value), ex: key_ttl)
+      multi.set(token_to_key(token), serializer.pack(value), ex: key_ttl)
       multi.set(token_to_owner(owner, token), nil, ex: key_ttl)
     end
 
@@ -83,7 +87,7 @@ class RedisToken
 
     @redis.multi do |multi|
       multi.expire(key, key_ttl)
-      multi.expire(token_to_owner(value[:owner], token), key_ttl)
+      multi.expire(token_to_owner(hash_get(value, :owner), token), key_ttl)
     end
 
     value
@@ -106,8 +110,8 @@ class RedisToken
     key_ttl = args[:ttl] || @redis.ttl(key)
 
     @redis.multi do |multi|
-      multi.set(key, Marshal.dump(value), ex: key_ttl)
-      multi.expire(token_to_owner(value[:owner], token), key_ttl)
+      multi.set(key, serializer.pack(value), ex: key_ttl)
+      multi.expire(token_to_owner(hash_get(value, :owner), token), key_ttl)
     end
 
     true
@@ -119,7 +123,7 @@ class RedisToken
   #
   # @return [Enumerator]
   def owned_by(owner)
-    owned_tokens(owner).map { |token| [token, redis_get(token_to_key(token))]}
+    owned_tokens(owner).map { |token| [token, redis_get(token_to_key(token))] }
   end
 
   # Delete a token
@@ -134,7 +138,7 @@ class RedisToken
 
     @redis.multi do |multi|
       multi.del(key)
-      multi.del(token_to_owner(value[:owner], token))
+      multi.del(token_to_owner(hash_get(value, :owner), token))
     end
 
     true
@@ -166,6 +170,46 @@ class RedisToken
     @redis.ttl(token_to_key(token))
   end
 
+  # Use custom serialization class
+  #
+  # Base serializer example:
+  #   class RedisToken
+  #     class Serializers
+  #       class Native
+  #         def pack(value)
+  #           Marshal.dump(value)
+  #         end
+  #
+  #         def unpack(value)
+  #           Marshal.load(value)
+  #         end
+  #       end
+  #     end
+  #   end
+  #
+  # MessagePack example:
+  #   require 'msgpack'
+  #
+  #   class MsgPackSerializer
+  #     def pack(value)
+  #       MessagePack.pack(value)
+  #     end
+  #
+  #     def unpack(value)
+  #       MessagePack.unpack(value)
+  #     end
+  #   end
+  #
+  #   RedisToken.new(prefix: PREFIX).use(MsgPackSerializer)
+  #
+  # @param [Object] serializer_class
+  #
+  # @return [RedisToken]
+  def use(serializer_class)
+    @serializer_class = serializer_class
+    self
+  end
+
   private
 
   def generate_token
@@ -175,6 +219,9 @@ class RedisToken
   def init_params(args)
     @default_ttl = args[:ttl] || DEFAULT_TTL
     @prefix = args[:prefix]
+
+    @serializer_class = args[:serializer_class]
+    @serializer_class = Serializers::Native unless @serializer_class
   end
 
   def token_to_key(token)
@@ -192,25 +239,33 @@ class RedisToken
   def redis_get(key)
     value = @redis.get(key)
     return unless value
-    Marshal.load(value)
+    serializer.unpack(value)
   end
 
   def owned_tokens(owner)
     mask = "#{@prefix}#{owner}.*"
 
     Enumerator.new do |y|
-      cursor = 0
+      cursor = '0'
       loop do
         cursor, r = @redis.scan(cursor, match: mask)
-        cursor = cursor.to_i
 
         r.each do |key|
           token = owner_key_to_token(owner, key)
           y << token
         end
 
-        break if cursor == 0
+        break if cursor == '0'
       end
     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]
+  end
 end

data/redis_token.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.10', '>= 5.10.3'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1', '>= 1.1.14'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_token
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Artem Baikuzin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -98,6 +98,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.14
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 description: Create and get API tokens with redis
 email:
 - ybinzu@gmail.com
@@ -111,6 +125,7 @@ files:
 - README.md
 - Rakefile
 - lib/redis_token.rb
+- lib/redis_token/serializers/native.rb
 - lib/redis_token/version.rb
 - redis_token.gemspec
 homepage: https://github.com/ybinzu/redis_token