Class: PlatformSdk::Identity::AuthClient
- Inherits:
 - 
      Object
      
        
- Object
 - PlatformSdk::Identity::AuthClient
 
 
- Defined in:
 - lib/platform_sdk/identity/clients.rb
 
Overview
Client for getting auth tokens from identity server
Instance Attribute Summary collapse
- 
  
    
      #conn  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute conn.
 - 
  
    
      #token  ⇒ Object 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Returns the value of attribute token.
 
Instance Method Summary collapse
- #auth_token ⇒ Object
 - #expired? ⇒ Boolean
 - 
  
    
      #initialize(base_url, client_id, client_secret)  ⇒ AuthClient 
    
    
  
  
  
    constructor
  
  
  
  
  
  
  
    
A new instance of AuthClient.
 - #jwt_expiry_time(jwt) ⇒ Object
 - #post_payload(path, body) ⇒ Object
 - #raise_error_with_payload(exception_class, error) ⇒ Object
 - #refresh_session(session: {}) ⇒ Object
 - #refresh_token(refresh_token) ⇒ Object
 - #refresh_token_if_expired(jwt:, refresh_token:) ⇒ Object
 - #token_expired?(jwt) ⇒ Boolean
 - #with_rescue ⇒ Object
 
Constructor Details
#initialize(base_url, client_id, client_secret) ⇒ AuthClient
Returns a new instance of AuthClient.
      29 30 31 32 33 34 35 36 37 38  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 29 def initialize(base_url, client_id, client_secret) @client_id = client_id @client_secret = client_secret @conn = Faraday.new(base_url) do |conn| conn.request :url_encoded conn.response :raise_error conn.response :json conn.adapter :net_http end end  | 
  
Instance Attribute Details
#conn ⇒ Object
Returns the value of attribute conn.
      27 28 29  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 27 def conn @conn end  | 
  
#token ⇒ Object
Returns the value of attribute token.
      27 28 29  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 27 def token @token end  | 
  
Instance Method Details
#auth_token ⇒ Object
      55 56 57 58 59  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 55 def auth_token @token = post_payload("/connect/token", request_body) if expired? @token[:access_token] end  | 
  
#expired? ⇒ Boolean
      61 62 63 64 65  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 61 def expired? return true if @token.nil? token_expired?(@token[:access_token]) end  | 
  
#jwt_expiry_time(jwt) ⇒ Object
      76 77 78  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 76 def jwt_expiry_time(jwt) Time.at(JWT.decode(jwt, nil, false)[0]["exp"]) end  | 
  
#post_payload(path, body) ⇒ Object
      48 49 50 51 52 53  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 48 def post_payload(path, body) with_rescue do response = @conn.post(path, body) response.body.transform_keys!(&:to_sym) end end  | 
  
#raise_error_with_payload(exception_class, error) ⇒ Object
      106 107 108 109 110 111 112 113 114 115  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 106 def raise_error_with_payload(exception_class, error) json_log = { exception: exception_class.new.class.name.demodulize, payload: error.response.dig(:request, :body), response_body: error.response[:body], status: error.response[:status] }.compact Rails.logger.info json_log.to_json if respond_to?(:Rails) raise exception_class, error.response end  | 
  
#refresh_session(session: {}) ⇒ Object
      94 95 96 97 98 99 100 101 102 103 104  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 94 def refresh_session(session: {}) raise ArgumentError if session[:access_token].nil? || session[:refresh_token].nil? refreshed_tokens = refresh_token_if_expired(jwt: session[:access_token], refresh_token: session[:refresh_token]) return if refreshed_tokens.nil? session[:id_token] = refreshed_tokens[:id_token] session[:access_token] = refreshed_tokens[:access_token] session[:refresh_token] = refreshed_tokens[:refresh_token] end  | 
  
#refresh_token(refresh_token) ⇒ Object
      87 88 89 90 91 92  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 87 def refresh_token(refresh_token) raise ArgumentError if refresh_token.nil? post_payload("/connect/token", request_body( grant_type: "refresh_token", refresh_token:)) end  | 
  
#refresh_token_if_expired(jwt:, refresh_token:) ⇒ Object
      80 81 82 83 84 85  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 80 def refresh_token_if_expired(jwt:, refresh_token:) raise ArgumentError if refresh_token.nil? || jwt.nil? return unless token_expired?(jwt) refresh_token(refresh_token) end  | 
  
#token_expired?(jwt) ⇒ Boolean
      67 68 69 70 71 72 73 74  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 67 def token_expired?(jwt) begin expiry_time = jwt_expiry_time(jwt) rescue JWT::ExpiredSignature return true end expiry_time <= Time.now.utc + 45 end  | 
  
#with_rescue ⇒ Object
      40 41 42 43 44 45 46  | 
    
      # File 'lib/platform_sdk/identity/clients.rb', line 40 def with_rescue yield rescue Faraday::ServerError => e raise_error_with_payload(ServerError, e) rescue Faraday::ClientError => e raise_error_with_payload(ClientError, e) end  |