redis_token 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1edc5c50c5911fb657241844a937efc3a37a34b6
-  data.tar.gz: 94373d284d69125bcd1c1cac7f59949e24b9e1c6
+  metadata.gz: 10430bc88bb8202bf46a6d2e299dde3b96d3c4c7
+  data.tar.gz: 760cc37ab113e0a0e8470b68e17b121cd3460212
 SHA512:
-  metadata.gz: a2d0c42b20bd11a876faa48a8ab7a67ddbac1a2361a3bd32d26aa29cc5b21351e3245fd441280b527f59fdd6fbf346fbbe92dd8715e22e14490070de2286fc25
-  data.tar.gz: 91df9c97d381c41562d7f8173488eab676b09d9f514c6ef096beac3e7ba5793c17bd39a8f652695c4aacff5f2076160077297f23f2df1a6e9459656a4dcc4e8c
+  metadata.gz: b6a5430a3860e7b6822f02e9f12f422b5e230af08ccdbca81b08591aaba28cba1a5c0641aaad91991f2b0731d853af8fdc29301723c83ddb052f562acd826107
+  data.tar.gz: cb9b1cfa97a7525a240d74cefd4f19ea162a86b7a522a45d8dde25506178359addf862582446b74befccd49a1dba1dc3e02f16d2fdb7e6cfec76c8bef9b79a42

data/README.md

@@ -21,20 +21,19 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-
 before_action :create_service
 
 def auth
   client = Client.find_by_email(params[:email])
 
   if client.password == params[:password]
-    token = @redis_token.create(client.id, payload: { source: :native })
+    token = @redis_token.create("client.#{client.id}", payload: { source: :native })
     json(access_token: token)
 
-    ...
+    # ...
   end
 
-  ...
+  # ...
 end
 
 def secured_method
@@ -44,13 +43,13 @@ def secured_method
   client = Client.find_by_id(value[:owner])
   payload = value[:payload]
 
-  ...
+  # ...
 end
 
 def client_tokens
   @tokens = []
 
-  @redis_token.each(client.id) do |token, value|
+  @redis_token.each("client.#{client.id}") do |token, value|
     @tokens << { token: token, value: value }
   end
 end
@@ -61,3 +60,71 @@ def create_service
   @redis_token ||= RedisToken.new(prefix: 'myproject.tokens.', ttl: 30.days)
 end
 ```
+
+### RedisToken creation
+
+Implicit Redis instance creation:
+
+```ruby
+# Redis.new with no arguments:
+r = RedisToken.new(prefix: 'myproject.tokens.', ttl: 30.days)
+
+# Redis.new(host: '192.168.1.1', port: 33421)
+r = RedisToken.new(prefix: 'myproject.tokens.', host: '192.168.1.1', port: 33421)
+```
+
+Explicit Redis instance injection:
+
+```ruby
+redis = Redis.new
+r = RedisToken.new(redis, prefix: 'myproject.tokens.', ttl: 30.days)
+r = RedisToken.new(redis, prefix: 'myproject2.tokens.')
+```
+
+### Create token
+
+```ruby
+client_token = r.create("client.#{client.id}")
+# => "eca431add3b1f0bbc6cfc73980b68708"
+
+# Redefine default ttl:
+user_token = r.create("u:#{current_user.id}", ttl: 15.hours)
+# => "548a5d54eaf474c750bf83ed04bd242a"
+
+# Create token with payload:
+mobile_token = r.create("c.#{client.id}", payload: { source: :native })
+# => "865249d6b87c4e6dd8f6b0796ace7fa0"
+```
+
+### Get token
+
+```ruby
+value = r.get('865249d6b87c4e6dd8f6b0796ace7fa0')
+# => {:owner=>"c.555", :at=>2017-08-18 15:53:15 +0300, :payload=>{:source=>:native}}
+
+# Each get request slides ttl by default:
+r.ttl('865249d6b87c4e6dd8f6b0796ace7fa0')
+# => 1209493
+r.get('865249d6b87c4e6dd8f6b0796ace7fa0')
+# => {:owner=>"c.555", :at=>2017-08-18 15:53:15 +0300, :payload=>{:source=>:native}}
+r.ttl('865249d6b87c4e6dd8f6b0796ace7fa0')
+# => 1209598
+
+# To prevent ttl sliding set slide_expire to false:
+r.get('865249d6b87c4e6dd8f6b0796ace7fa0', slide_expire: false)
+```
+
+### Get all tokens owned by someone
+
+```ruby
+5.times { r.create('u.555') }
+
+r.each('u.555') { |t,v| p "#{t}: #{v}" }
+# "5e8c661c11955b062d8c512c201734dd: {:owner=>\"u.555\", :at=>2017-08-18 16:02:10 +0300}"
+# "5607a698763a6164975b9ffc06528513: {:owner=>\"u.555\", :at=>2017-08-18 16:02:10 +0300}"
+# "7ef74cb761c1595dd33058e78a125720: {:owner=>\"u.555\", :at=>2017-08-18 16:02:10 +0300}"
+# "621d2a10c34e92d7f0b4fc3b00be62af: {:owner=>\"u.555\", :at=>2017-08-18 16:02:10 +0300}"
+# "17f7cb676e67d6b53c48e51f1c1beeb1: {:owner=>\"u.555\", :at=>2017-08-18 16:02:10 +0300}"
+# => nil
+
+```

data/lib/redis_token/version.rb

@@ -1,3 +1,3 @@
 class RedisToken
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

data/lib/redis_token.rb

@@ -13,6 +13,20 @@ class RedisToken
   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)
@@ -21,10 +35,16 @@ class RedisToken
                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
 
@@ -45,6 +65,14 @@ class RedisToken
     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)
@@ -61,6 +89,14 @@ class RedisToken
     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)
@@ -77,6 +113,9 @@ class RedisToken
     true
   end
 
+  # Iterate all exist tokens of an owner
+  #
+  # @param [String] owner
   def each(owner)
     mask = "#{@prefix}#{owner}.*"
 
@@ -94,6 +133,11 @@ class RedisToken
     end
   end
 
+  # Delete a token
+  #
+  # @param [String] token
+  #
+  # @return [Boolean]
   def del(token)
     key = token_to_key(token)
     value = redis_get(key)
@@ -107,6 +151,9 @@ class RedisToken
     true
   end
 
+  # Retrieve the remaining ttl of a token
+  #
+  # @return [Integer] ttl
   def ttl(token)
     @redis.ttl(token_to_key(token))
   end
@@ -118,7 +165,7 @@ class RedisToken
   end
 
   def init_params(args)
-    @default_ttl = args[:ttl]
+    @default_ttl = args[:ttl] || DEFAULT_TTL
     @prefix = args[:prefix]
   end
 
@@ -139,8 +186,4 @@ class RedisToken
     return unless value
     Marshal.load(value)
   end
-
-  def check_owner(owner)
-    raise 'owner should be specified' unless owner
-  end
 end

metadata

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