Class: ICFS::UsersRedis

Inherits:
Users
  • Object
show all
Defined in:
lib/icfs/users_redis.rb

Overview

Implement Users with a Redis cache

Constant Summary

Constants inherited from Users

ICFS::Users::ValUser

Instance Method Summary collapse

Constructor Details

#initialize(redis, base, opts = {}) ⇒ UsersRedis

New instance

Parameters:

  • redis (Redis) —

    The redis client

  • base (Users) —

    The base Users store

  • opts (Hash) (defaults to: {}) —

    Options

Options Hash (opts):

  • :prefix (String) —

    Prefix for Redis key

  • :expires (Integer) —

    Expiration time in seconds

  • :log (Logger) —

    Logger which records info about user



33
34
35
36
37
38
39
 
# File 'lib/icfs/users_redis.rb', line 33

def initialize(redis, base, opts={})
  @redis = redis
  @base = base
  @pre = opts[:prefix] || ''
  @exp = opts[:expires] || 1*60*60 # 1 hour default
  @log = opts[:log]
end

Instance Method Details

#flush(urg) ⇒ Boolean

Flush a user/role/group from a cache, if any

Parameters:

  • urg (String) —

    User/Role/Group name

Returns:

  • (Boolean) —

    if cached



54
55
56
57
58
59
 
# File 'lib/icfs/users_redis.rb', line 54

def flush(urg)
  Items.validate(urg, 'User/role/group name', Items::FieldUsergrp)
  @log.info('User/role/group cache flush: %s' % urg) if @log
  @redis.del(_key(urg))
  return true
end

#read(urg) ⇒ Hash

Read a user/role/group

Parameters:

  • urg (String) —

    User/Role/Group name

Returns:

  • (Hash) —

    Will include :type and, if a user :roles, :groups, :perms



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/icfs/users_redis.rb', line 65

def read(urg)
  Items.validate(urg, 'User/role/group name', Items::FieldUsergrp)
  key = _key(urg)
  @log.debug('User/role/group read: %s' % urg) if @log

  # try cache
  json = @redis.get(key)
  if json
    @log.debug('User/role/group cache hit: %s' % urg) if @log
    return JSON.parse(json)
  end

  # get base object from base store
  bse = @base.read(urg)
  if !bse
    @log.warn('User/role/group not found: %s' % urg) if @log
    return nil
  end

  # assemble
  seen = Set.new.add(urg)
  ary = []
  roles = Set.new
  grps = Set.new
  perms = Set.new
  if bse['roles']
    ary.concat bse['roles']
    roles.merge bse['roles']
  end
  if bse['groups']
    ary.concat bse['groups']
    grps.merge bse['groups']
  end
  if bse['perms']
    perms.merge bse['perms']
  end

  # call ourself recursively for any un-expanded memberships
  while itm = ary.shift
    next if seen.include?(itm)
    seen.add(itm)
    ikey = _key(itm)

    # all included u/r/g have been seen & expanded
    mem = self.read(itm)
    next if !mem
    if mem['roles']
      roles.merge mem['roles']
      seen.merge mem['roles']
    end
    if mem['groups']
      grps.merge mem['groups']
      seen.merge mem['groups']
    end
    if mem['perms']
      perms.merge mem['perms']
    end
  end

  # final result
  bse['roles'] = roles.to_a unless roles.empty?
  bse['groups'] = grps.to_a unless grps.empty?
  bse['perms'] = perms.to_a unless perms.empty?
  json = JSON.generate(bse)

  # save to cache
  @redis.set(key, json)
  @redis.expire(key, @exp)
  @log.info('User/role/group cached: %s %s' % [urg, json]) if @log
  return bse
end

#write(obj) ⇒ Object

Write a user/role/group

Parameters:

  • obj (Hash) —

    Will include :name, :type, and if a user :roles, :groups, :perms



141
142
143
144
145
146
147
 
# File 'lib/icfs/users_redis.rb', line 141

def write(obj)
  json = Items.generate(obj, 'User/Role/Group', Users::ValUser)
  key = _key(obj['name'])
  @log.info('User/role/group write: %s' % urg) if @log
  @redis.del(key)
  @base.write(obj)
end