Class: K2ConnectRuby::K2Entity::K2Token

Inherits:
Object
  • Object
show all
Defined in:
lib/k2-connect-ruby/k2_entity/k2_token.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client_id, client_secret) ⇒ K2Token

Returns a new instance of K2Token.



6
7
8
9
10
# File 'lib/k2-connect-ruby/k2_entity/k2_token.rb', line 6

def initialize(client_id, client_secret)
  validate_client_credentials(client_id, client_secret)
  @client_id = client_id
  @client_secret = client_secret
end

Instance Attribute Details

#access_tokenObject (readonly)

Returns the value of attribute access_token.



4
5
6
# File 'lib/k2-connect-ruby/k2_entity/k2_token.rb', line 4

def access_token
  @access_token
end

#token_responseObject (readonly)

Returns the value of attribute token_response.



4
5
6
# File 'lib/k2-connect-ruby/k2_entity/k2_token.rb', line 4

def token_response
  @token_response
end

Class Method Details

.make_hash(path_url, request, class_type, body, requires_token = true) ⇒ Object

Create a Hash containing important details accessible for K2Connect



55
56
57
58
59
60
61
62
63
# File 'lib/k2-connect-ruby/k2_entity/k2_token.rb', line 55

def make_hash(path_url, request, class_type, body, requires_token = true)
  {
    path_url: path_url,
    request_type: request,
    class_type: class_type,
    requires_token: requires_token,
    params: body
  }.with_indifferent_access
end

Instance Method Details

#introspect_token(access_token) ⇒ Object



32
33
34
35
36
37
38
39
40
# File 'lib/k2-connect-ruby/k2_entity/k2_token.rb', line 32

def introspect_token(access_token)
  token_params = {
    client_id: @client_id,
    client_secret: @client_secret,
    token: access_token
  }
  token_hash = K2ConnectRuby::K2Entity::K2Token.make_hash(K2ConnectRuby::K2Utilities::Config::K2Config.path_url('introspect_token'), 'post', 'Access Token', token_params)
  @token_response = K2ConnectRuby::K2Utilities::K2Connection.make_request(token_hash)
end

#request_tokenObject



12
13
14
15
16
17
18
19
20
# File 'lib/k2-connect-ruby/k2_entity/k2_token.rb', line 12

def request_token
  token_params = {
    client_id: @client_id,
    client_secret: @client_secret,
    grant_type: 'client_credentials'
  }
  token_hash = K2ConnectRuby::K2Entity::K2Token.make_hash(K2ConnectRuby::K2Utilities::Config::K2Config.path_url('oauth_token'), 'post', 'Access Token', token_params)
  @access_token = K2ConnectRuby::K2Utilities::K2Connection.make_request(token_hash)
end

#revoke_token(access_token) ⇒ Object



22
23
24
25
26
27
28
29
30
# File 'lib/k2-connect-ruby/k2_entity/k2_token.rb', line 22

def revoke_token(access_token)
  token_params = {
    client_id: @client_id,
    client_secret: @client_secret,
    token: access_token
  }
  token_hash = K2ConnectRuby::K2Entity::K2Token.make_hash(K2ConnectRuby::K2Utilities::Config::K2Config.path_url('revoke_token'), 'post', 'Access Token', token_params)
  @token_response = K2ConnectRuby::K2Utilities::K2Connection.make_request(token_hash)
end

#token_info(access_token) ⇒ Object



42
43
44
45
46
47
# File 'lib/k2-connect-ruby/k2_entity/k2_token.rb', line 42

def token_info(access_token)
  token_hash = K2ConnectRuby::K2Entity::K2Token.make_hash(K2ConnectRuby::K2Utilities::Config::K2Config.path_url('token_info'), 'get', 'Access Token', nil, false)

  token_hash[:access_token] = access_token
  @token_response = K2ConnectRuby::K2Utilities::K2Connection.make_request(token_hash)
end

#validate_client_credentials(client_id, client_secret) ⇒ Object

Raises:

  • (ArgumentError)


49
50
51
# File 'lib/k2-connect-ruby/k2_entity/k2_token.rb', line 49

def validate_client_credentials(client_id, client_secret)
  raise ArgumentError, 'Nil or Empty Client Id or Secret!' if client_id.blank? || client_secret.blank?
end