Class: NetDocuments::UseToken

Inherits:
Object
  • Object
show all
Includes:
Dependency, Initializer, Log::Dependency
Defined in:
lib/net_documents/use_token/log.rb,
lib/net_documents/use_token/token.rb,
lib/net_documents/use_token/result.rb,
lib/net_documents/use_token/provider.rb,
lib/net_documents/use_token/use_token.rb,
lib/net_documents/use_token/controls/id.rb,
lib/net_documents/use_token/controls/time.rb,
lib/net_documents/use_token/controls/token.rb,
lib/net_documents/use_token/controls/provider.rb,
lib/net_documents/use_token/use_token/substitute.rb,
lib/net_documents/use_token/controls/access_token.rb,
lib/net_documents/use_token/controls/write/issued.rb,
lib/net_documents/use_token/controls/refresh_token.rb,
lib/net_documents/use_token/controls/token_version.rb,
lib/net_documents/use_token/controls/write/granted.rb

Defined Under Namespace

Modules: Controls, Provider, Substitute Classes: Log, Result

Constant Summary collapse

Token = 
GetToken::Token
TokenExpiredError = 
Class.new(RuntimeError)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.build(user_id) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/net_documents/use_token/use_token.rb', line 21

def self.build(user_id)
  instance = new(user_id)

  GetToken.configure(instance, provider)
  NetDocuments::Client::Token::User::Refresh.configure(instance, attr_name: :refresh)
  TokenComponent::Client::Issue.configure(instance, provider)
  TokenComponent::Client::Request.configure(instance)
  Clock::UTC.configure(instance)

  instance
end

.call(user_id, &block) ⇒ Object 



39
40
41
42
 
# File 'lib/net_documents/use_token/use_token.rb', line 39

def self.call(user_id, &block)
  instance = build(user_id)
  instance.(&block)
end

.configure(receiver, user_id, attr_name: nil) ⇒ Object 



33
34
35
36
37
 
# File 'lib/net_documents/use_token/use_token.rb', line 33

def self.configure(receiver, user_id, attr_name: nil)
  attr_name ||= :use_net_documents_token
  instance = build(user_id)
  receiver.public_send(:"#{attr_name}=", instance)
end

.provider ⇒ Object 



17
18
19
 
# File 'lib/net_documents/use_token/use_token.rb', line 17

def self.provider
  Provider.name
end

Instance Method Details

#call(&block) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/net_documents/use_token/use_token.rb', line 44

def call(&block)
  token = get_token.(user_id)

  result = Result.new

  if token.nil?
    logger.info("Missing NetDocuments token", { user_id: user_id })
    return result
  end

  access_token = token.access_token
  refresh_token = token.refresh_token
  token_version = token.version

  if token.expired?(clock.now)
    logger.debug("NetDocuments token is expired", { user_id: user_id, expiration_time: token.expiration_time })
    access_token = refresh_access_token(refresh_token, token_version)

    if access_token.nil?
      return result
    end
  end

  begin
    result.value = block.call(access_token)
    result.success = true

  rescue ::NetDocuments::Client::TokenRejectedError
    logger.debug("NetDocuments token is rejected", { user_id: user_id, expiration_time: token.expiration_time })

    access_token = refresh_access_token(refresh_token, token_version)

    if not access_token.nil?
      retry
    end
  end

  result
end

#issue_token(user_token) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/net_documents/use_token/use_token.rb', line 107

def issue_token(user_token)
  logger.trace("Issuing new NetDocuments token", { user_id: user_id })

  issue_id = Identifier::UUID.random

  access_token = user_token.access_token
  refresh_token = user_token.refresh_token
  expiration_time = user_token.expiration_time

  issue.(
    user_id: user_id,
    issue_id: issue_id,
    access_token: access_token,
    refresh_token: refresh_token,
    expiration_time: expiration_time
  )

  logger.debug("Issued new NetDocuments token", { user_id: user_id, issue_id: issue_id })
end

#refresh_access_token(refresh_token, token_version) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/net_documents/use_token/use_token.rb', line 84

def refresh_access_token(refresh_token, token_version)
  logger.trace("Refreshing NetDocuments token", { user_id: user_id })

  begin
    refresh_token_response = refresh.(refresh_token)
  rescue ::NetDocuments::Client::Token::InvalidGrantError
    logger.debug("NetDocuments token refresh failed", { user_id: user_id })

    request_new_token(token_version)
    return nil
  end

  issued_time = clock.now
  user_token = ::NetDocuments::Client::Token::User::Token.import(refresh_token_response, issued_time)
  access_token = user_token.access_token

  issue_token(user_token)

  logger.debug("Refreshed NetDocuments token", { user_id: user_id })

  access_token
end

#request_new_token(obsolete_token_version) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/net_documents/use_token/use_token.rb', line 127

def request_new_token(obsolete_token_version)
  logger.trace("Requesting new NetDocuments token", { user_id: user_id })

  request_id = Identifier::UUID::Random.get
  correlation_stream_name = nil

  request.(
    user_id: user_id,
    request_id: request_id,
    provider: self.class.provider,
    obsolete_token_version: obsolete_token_version,
    correlation_stream_name: correlation_stream_name,
    previous_message: nil
  )

  logger.debug("Requested new NetDocuments token", { user_id: user_id, request_id: request_id })
end