lib/redis_token.rb in redis_token-0.0.1 vs lib/redis_token.rb in redis_token-0.0.2

@@ -11,22 +11,42 @@
   attr_reader :redis
   attr_accessor :default_ttl
   attr_accessor :prefix
   attr_reader :created_value
 
+  # Create RedisToken instance
+  #
+  # Implicit redis instance creation (redis parameters can be passed in args):
+  #   RedisToken.new(ttl: 5.days, prefix: 'project.tokens.', host: '127.0.0.1')
+  #
+  # Explicit redis instance injection:
+  #   redis = Redis.new(host: '192.168.0.1', port: 33221)
+  #   RedisToken.new(redis, ttl: 5.days, prefix: 'project.tokens.')
+  #
+  # @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)
+  #
+  # @return [RedisToken] a new RedisToken instance
   def initialize(args = {}, opts = {})
     @redis = if args.nil? || args.is_a?(Hash)
                init_params(args)
                Redis.new(args)
              else
                init_params(opts)
                args
              end
-
-    @default_ttl ||= DEFAULT_TTL
   end
 
+  # Create a new token
+  #
+  # @param [String] owner owner of a token, e.g. 'client.1' or 'user-123'
+  # @param [Hash] args
+  # @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
 
     token = args[:token] || generate_token
     value = { owner: owner, at: Time.now }
@@ -43,10 +63,18 @@
     end
 
     token
   end
 
+  # Get value of a token and slide ttl
+  #
+  # @param [String] token
+  # @param [Hash] args
+  # @option args [Integer] :ttl
+  # @option args [Boolean] :slide_expire (true) slide ttl of a token
+  #
+  # @return [Hash] value of a token
   def get(token, args = {})
     key = token_to_key(token)
     value = redis_get(key)
     return unless value
     return value if args[:slide_expire] === false
@@ -59,10 +87,18 @@
     end
 
     value
   end
 
+  # Set new payload of a token
+  #
+  # @param [String] token
+  # @param [Hash] args
+  # @option args [Integer] :ttl set new time to live value
+  # @option args :payload new payload value
+  #
+  # @return [Boolean]
   def set(token, args = {})
     key = token_to_key(token)
     value = redis_get(key)
     return false unless value
     value[:payload] = args[:payload]
@@ -75,10 +111,13 @@
     end
 
     true
   end
 
+  # Iterate all exist tokens of an owner
+  #
+  # @param [String] owner
   def each(owner)
     mask = "#{@prefix}#{owner}.*"
 
     cursor = 0
     loop do
@@ -92,10 +131,15 @@
 
       break if cursor == 0
     end
   end
 
+  # Delete a token
+  #
+  # @param [String] token
+  #
+  # @return [Boolean]
   def del(token)
     key = token_to_key(token)
     value = redis_get(key)
     return false unless value
 
@@ -105,10 +149,13 @@
     end
 
     true
   end
 
+  # Retrieve the remaining ttl of a token
+  #
+  # @return [Integer] ttl
   def ttl(token)
     @redis.ttl(token_to_key(token))
   end
 
   private
@@ -116,11 +163,11 @@
   def generate_token
     SecureRandom.hex(16)
   end
 
   def init_params(args)
-    @default_ttl = args[:ttl]
+    @default_ttl = args[:ttl] || DEFAULT_TTL
     @prefix = args[:prefix]
   end
 
   def token_to_key(token)
     "#{@prefix}#{token}"
@@ -136,11 +183,7 @@
 
   def redis_get(key)
     value = @redis.get(key)
     return unless value
     Marshal.load(value)
-  end
-
-  def check_owner(owner)
-    raise 'owner should be specified' unless owner
   end
 end