class BBC::Redux::User

Redux API User Object

@example Properties of the user object

user = redux_client.user

user.can_invite?  #=> Boolean
user.created      #=> DateTime
user.email        #=> String
user.first_name   #=> String
user.id           #=> Integer
user.last_name    #=> String
user.username     #=> String
user.uuid         #=> String

@example Check if user can proceed or needs to sign T&C's

if user.must_sign_terms?
  puts "Hey #{user.name}, you need to sign these terms"
  puts user.legal_html
end

@author Matt Haynes <matt.haynes@bbc.co.uk>

Public Instance Methods

first_name() click to toggle source

@!attribute [r] first_name @return [String] the user's first name

# File lib/bbc/redux/user.rb, line 86
def first_name
  name.split(' ').first
end
last_name() click to toggle source

@!attribute [r] last_name @return [String] the user's last name

# File lib/bbc/redux/user.rb, line 92
def last_name
  name.split(' ').last
end
must_sign_terms?() click to toggle source

@!attribute [r] must_sign_terms? @see User#legal_accepted @see User#legal_html @return [String] whether the user must sign some T&C's before proceeding

# File lib/bbc/redux/user.rb, line 100
def must_sign_terms?
  !legal_accepted
end