Skip to content

Commit dd618c5

Browse files
committed
Refactoring (hide some internal and undocumented classes)
- Rename `DateTime` class into `_DateTime`. - Rename `EmailAddress` class into `_EmailAddress`. - Rename `Tools` class into `_Tools`. - Rename `URL` class into `_URL`.
1 parent b4b5728 commit dd618c5

22 files changed

+110
-110
lines changed

Project/Sources/Classes/GoogleCalendar.4dm

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,17 @@ Class constructor($inProvider : cs.OAuth2Provider; $inParameters : Object)
1515

1616
Function _conformEventDateTime($inObject : Object; $inName : Text) : Object
1717

18-
var $dateTime : cs.DateTime
18+
var $dateTime : cs._DateTime
1919
var $timeZone : Text:=((Value type($inObject[$inName].timeZone)=Is text) && (Length($inObject[$inName].timeZone)>0)) ? String($inObject[$inName].timeZone) : ""
2020
Case of
2121
: (Value type($inObject[$inName].dateTime)=Is text)
22-
$dateTime:=cs.DateTime.new({dateTime: $inObject[$inName].dateTime; timeZone: $timeZone})
22+
$dateTime:=cs._DateTime.new({dateTime: $inObject[$inName].dateTime; timeZone: $timeZone})
2323
return $dateTime.getGoogleDateTime()
2424
: ((Value type($inObject[$inName].date)=Is date) && (Value type($inObject[$inName].time)#Is undefined))
25-
$dateTime:=cs.DateTime.new({date: $inObject[$inName].date; time: $inObject[$inName].time; timeZone: $timeZone})
25+
$dateTime:=cs._DateTime.new({date: $inObject[$inName].date; time: $inObject[$inName].time; timeZone: $timeZone})
2626
return $dateTime.getGoogleDateTime()
2727
: ((Value type($inObject[$inName].date)=Is date))
28-
$dateTime:=cs.DateTime.new({date: $inObject[$inName].date})
28+
$dateTime:=cs._DateTime.new({date: $inObject[$inName].date})
2929
return $dateTime.getGoogleDate()
3030
End case
3131

@@ -76,7 +76,7 @@ Function getCalendar($inID : Text) : Object
7676
Else
7777

7878
var $calendarID : Text:=(Length(String($inID))>0) ? $inID : "primary"
79-
var $URL : Text:=Super._getURL()+"users/me/calendarList/"+cs.Tools.me.urlEncode($calendarID)
79+
var $URL : Text:=Super._getURL()+"users/me/calendarList/"+cs._Tools.me.urlEncode($calendarID)
8080
var $headers : Object:={Accept: "application/json"}
8181
$response:=Super._sendRequestAndWaitResponse("GET"; $URL; $headers)
8282

@@ -95,7 +95,7 @@ Function getCalendars($inParameters : Object) : Object
9595
Super._throwErrors(False)
9696

9797
var $headers : Object:={Accept: "application/json"}
98-
var $URL : cs.URL:=cs.URL.new(This._getURL()+"users/me/calendarList")
98+
var $URL : cs._URL:=cs._URL.new(This._getURL()+"users/me/calendarList")
9999

100100
If (Not(Value type($inParameters.top)=Is undefined))
101101
$URL.addQueryParameter("maxResults"; Choose(Value type($inParameters.top)=Is text; $inParameters.top; String($inParameters.top)))
@@ -149,12 +149,12 @@ Function getEvent($inParameters : Object) : Object
149149
var $calendarId : Text:=(Length(String($inParameters.calendarId))>0) ? $inParameters.calendarId : "primary"
150150
var $timeZone : Text:=(Length(String($inParameters.timeZone))>0) ? String($inParameters.timeZone) : "UTC"
151151
var $headers : Object:={Accept: "application/json"}
152-
var $URL : cs.URL:=cs.URL.new(This._getURL()+"calendars/"+cs.Tools.me.urlEncode($calendarID)+"/events/"+cs.Tools.me.urlEncode($eventId))
152+
var $URL : cs._URL:=cs._URL.new(This._getURL()+"calendars/"+cs._Tools.me.urlEncode($calendarID)+"/events/"+cs._Tools.me.urlEncode($eventId))
153153

154154
If (Not(Value type($inParameters.maxAttendees)=Is undefined))
155155
$URL.addQueryParameter("maxAttendees"; Choose(Value type($inParameters.maxAttendees)=Is text; $inParameters.maxAttendees; String($inParameters.maxAttendees)))
156156
End if
157-
$URL.addQueryParameter("timeZone"; cs.Tools.me.urlEncode($timeZone))
157+
$URL.addQueryParameter("timeZone"; cs._Tools.me.urlEncode($timeZone))
158158

159159
var $URLString : Text:=$URL.toString()
160160
var $response : Object:=Super._sendRequestAndWaitResponse("GET"; $URLString; $headers)
@@ -177,7 +177,7 @@ Function getEvents($inParameters : Object) : Object
177177
Super._throwErrors(False)
178178

179179
var $calendarId : Text:=(Length(String($inParameters.calendarId))>0) ? $inParameters.calendarId : "primary"
180-
var $URL : cs.URL:=cs.URL.new(This._getURL()+"calendars/"+cs.Tools.me.urlEncode($calendarID)+"/events")
180+
var $URL : cs._URL:=cs._URL.new(This._getURL()+"calendars/"+cs._Tools.me.urlEncode($calendarID)+"/events")
181181
var $timeZone : Text:=(Length(String($inParameters.timeZone))>0) ? String($inParameters.timeZone) : "UTC"
182182
var $startDateTime : Text:=""
183183
var $endDateTime : Text:=""
@@ -214,7 +214,7 @@ Function getEvents($inParameters : Object) : Object
214214
$URL.addQueryParameter("orderBy"; String($inParameters.orderBy))
215215
End if
216216
If ((Value type($inParameters.search)=Is text) && (Length(String($inParameters.search))>0))
217-
$URL.addQueryParameter("q"; cs.Tools.me.urlEncode(String($inParameters.search)))
217+
$URL.addQueryParameter("q"; cs._Tools.me.urlEncode(String($inParameters.search)))
218218
End if
219219
If (Not(Value type($inParameters.showDeleted)=Is undefined))
220220
$URL.addQueryParameter("showDeleted"; Choose(Bool($inParameters.showDeleted); "true"; "false"))
@@ -226,10 +226,10 @@ Function getEvents($inParameters : Object) : Object
226226
$URL.addQueryParameter("singleEvents"; Choose(Bool($inParameters.singleEvents); "true"; "false"))
227227
End if
228228
If (Length(String($startDateTime))>0)
229-
$URL.addQueryParameter("timeMin"; cs.Tools.me.urlEncode($startDateTime))
229+
$URL.addQueryParameter("timeMin"; cs._Tools.me.urlEncode($startDateTime))
230230
End if
231231
If (Length(String($endDateTime))>0)
232-
$URL.addQueryParameter("timeMax"; cs.Tools.me.urlEncode($endDateTime))
232+
$URL.addQueryParameter("timeMax"; cs._Tools.me.urlEncode($endDateTime))
233233
End if
234234
If ((Value type($inParameters.updatedMin)=Is text) && (Length(String($inParameters.updatedMin))>0))
235235
$URL.addQueryParameter("updatedMin"; String($inParameters.updatedMin))
@@ -240,7 +240,7 @@ Function getEvents($inParameters : Object) : Object
240240
If ((Value type($inParameters.sharedExtendedProperty)=Is text) && (Length(String($inParameters.sharedExtendedProperty))>0))
241241
$URL.addQueryParameter("sharedExtendedProperty"; String($inParameters.sharedExtendedProperty))
242242
End if
243-
$URL.addQueryParameter("timeZone"; cs.Tools.me.urlEncode($timeZone))
243+
$URL.addQueryParameter("timeZone"; cs._Tools.me.urlEncode($timeZone))
244244

245245
var $options : Object:={}
246246
$options.url:=$URL.toString()
@@ -270,7 +270,7 @@ Function createEvent($inEvent : Object; $inParameters : Object) : Object
270270

271271
var $calendarId : Text:=(Length(String($inParameters.calendarId))>0) ? $inParameters.calendarId : "primary"
272272
var $headers : Object:={Accept: "application/json"}
273-
var $URL : cs.URL:=cs.URL.new(This._getURL()+"calendars/"+cs.Tools.me.urlEncode($calendarID)+"/events")
273+
var $URL : cs._URL:=cs._URL.new(This._getURL()+"calendars/"+cs._Tools.me.urlEncode($calendarID)+"/events")
274274

275275
If (Not(Value type($inParameters.conferenceDataVersion)=Is undefined))
276276
$URL.addQueryParameter("conferenceDataVersion"; Choose(Value type($inParameters.conferenceDataVersion)=Is text; $inParameters.conferenceDataVersion; String($inParameters.conferenceDataVersion)))
@@ -310,7 +310,7 @@ Function deleteEvent($inParameters : Object) : Object
310310
var $calendarId : Text:=(Length(String($inParameters.calendarId))>0) ? $inParameters.calendarId : "primary"
311311
var $eventId : Text:=(Length(String($inParameters.eventId))>0) ? $inParameters.eventId : ""
312312
var $headers : Object:={Accept: "application/json"}
313-
var $URL : cs.URL:=cs.URL.new(This._getURL()+"calendars/"+cs.Tools.me.urlEncode($calendarID)+"/events/"+cs.Tools.me.urlEncode($eventId))
313+
var $URL : cs._URL:=cs._URL.new(This._getURL()+"calendars/"+cs._Tools.me.urlEncode($calendarID)+"/events/"+cs._Tools.me.urlEncode($eventId))
314314

315315
If (Not(Value type($inParameters.sendNotifications)=Is undefined))
316316
$URL.addQueryParameter("sendNotifications"; Choose(Bool($inParameters.sendNotifications); "true"; "false"))
@@ -343,7 +343,7 @@ Function updateEvent($inEvent : Object; $inParameters : Object) : Object
343343
var $calendarId : Text:=(Length(String($inParameters.calendarId))>0) ? $inParameters.calendarId : "primary"
344344
var $eventId : Text:=(Length(String($inEvent.id))>0) ? $inEvent.id : ""
345345
var $headers : Object:={Accept: "application/json"}
346-
var $URL : cs.URL:=cs.URL.new(This._getURL()+"calendars/"+cs.Tools.me.urlEncode($calendarID)+"/events/"+cs.Tools.me.urlEncode($eventId))
346+
var $URL : cs._URL:=cs._URL.new(This._getURL()+"calendars/"+cs._Tools.me.urlEncode($calendarID)+"/events/"+cs._Tools.me.urlEncode($eventId))
347347
var $bFullUpdate : Boolean:=False
348348

349349
If (Value type($inParameters.conferenceDataVersion)#Is undefined)

Project/Sources/Classes/GoogleUser.4dm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Function _get($inResourceName : Text; $inPersonFields : Variant) : Object
4646

4747
Function _getURLParamsFromObject($inParameters : Object) : Text
4848

49-
var $urlParams : cs.URL:=cs.URL.new()
49+
var $urlParams : cs._URL:=cs._URL.new()
5050
var $personFields : Text
5151
var $sources : Collection:=Null
5252
var $mergeSources : Collection:=Null

Project/Sources/Classes/JWT.4dm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,6 @@ Function _hashSign($inJWT : Object; $inCryptoKey : 4D.CryptoKey) : Text
289289
Function _throwError($inCode : Integer; $inParameters : Object)
290290

291291
// Push error into errorStack and throw it
292-
var $error : Object:=cs.Tools.me.makeError($inCode; $inParameters)
292+
var $error : Object:=cs._Tools.me.makeError($inCode; $inParameters)
293293
$error.deferred:=True
294294
throw($error)

Project/Sources/Classes/OAuth2Authorization.4dm

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Function getResponse($request : 4D.IncomingMessage) : 4D.OutgoingMessage
66
var $errorBody : Text
77
If ($request#Null)
88

9-
var $state : Text:=cs.Tools.me.getURLParameterValue($request.url; "state")
9+
var $state : Text:=cs._Tools.me.getURLParameterValue($request.url; "state")
1010
var $redirectURI : Text:=($request.urlPath.length>0) ? "/"+$request.urlPath[0]+"/@" : $request.url
1111
var $options : Object:={state: $state; redirectURI: $redirectURI}
1212
var $response : Object:={}
@@ -31,16 +31,16 @@ Function getResponse($request : 4D.IncomingMessage) : 4D.OutgoingMessage
3131
// Send a 403 status line
3232
// This is not strictly necessary, but it makes it clear that the request was forbidden
3333
// and not just a 404 Not Found
34-
$errorBody:=cs.Tools.me.buildPageFromTemplate(Localized string("OAuth2_Response_Title"); "403 Forbidden"; "Access denied."; False)
34+
$errorBody:=cs._Tools.me.buildPageFromTemplate(Localized string("OAuth2_Response_Title"); "403 Forbidden"; "Access denied."; False)
3535
$outgoingResponse.setStatus(403)
3636
$outgoingResponse.setBody($errorBody)
3737
$outgoingResponse.setHeader("Content-Type"; "text/html")
3838

3939
End if
4040
Else
41-
var $error : Object:=cs.Tools.me.makeError(9; {which: "request (4D.IncomingMessage)"; function: "OAuth2Authorization.getResponse"})
41+
var $error : Object:=cs._Tools.me.makeError(9; {which: "request (4D.IncomingMessage)"; function: "OAuth2Authorization.getResponse"})
4242

43-
$errorBody:=cs.Tools.me.buildPageFromTemplate(Localized string("OAuth2_Response_Title"); "500 Internal Server Error"; JSON Stringify($error; *); False)
43+
$errorBody:=cs._Tools.me.buildPageFromTemplate(Localized string("OAuth2_Response_Title"); "500 Internal Server Error"; JSON Stringify($error; *); False)
4444
$outgoingResponse.setStatus(500)
4545
$outgoingResponse.setBody($errorBody)
4646
$outgoingResponse.setHeader("Content-Type"; "text/plain")

Project/Sources/Classes/OAuth2Provider.4dm

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -127,20 +127,20 @@ Class constructor($inParams : Object)
127127
is received correctly in signed in mode
128128
If not present the default page is used
129129
*/
130-
If ((Value type($inParams.authenticationPage)=Is text) && cs.Tools.me.isValidURL(String($inParams.authenticationPage)))
130+
If ((Value type($inParams.authenticationPage)=Is text) && cs._Tools.me.isValidURL(String($inParams.authenticationPage)))
131131
This.authenticationPage:=String($inParams.authenticationPage)
132132
Else
133-
This.authenticationPage:=cs.Tools.me.retainFileObject($inParams.authenticationPage)
133+
This.authenticationPage:=cs._Tools.me.retainFileObject($inParams.authenticationPage)
134134
End if
135135
/*
136136
Path of the web page to display in the webbrowser when the authentication server
137137
returns an error in signed in mode
138138
If not present the default page is used
139139
*/
140-
If ((Value type($inParams.authenticationErrorPage)=Is text) && cs.Tools.me.isValidURL(String($inParams.authenticationErrorPage)))
140+
If ((Value type($inParams.authenticationErrorPage)=Is text) && cs._Tools.me.isValidURL(String($inParams.authenticationErrorPage)))
141141
This.authenticationErrorPage:=String($inParams.authenticationErrorPage)
142142
Else
143-
This.authenticationErrorPage:=cs.Tools.me.retainFileObject($inParams.authenticationErrorPage)
143+
This.authenticationErrorPage:=cs._Tools.me.retainFileObject($inParams.authenticationErrorPage)
144144
End if
145145
/*
146146
Indicates whether your application can refresh access tokens when the user is not
@@ -512,13 +512,13 @@ Function _getAuthorizationCode() : Text
512512
Function _getToken_SignedIn($bUseRefreshToken : Boolean) : Object
513513

514514
var $result : Object:=Null
515-
var $params : cs.URL:=cs.URL.new()
515+
var $params : cs._URL:=cs._URL.new()
516516
var $bSendRequest : Boolean:=True
517517
If ($bUseRefreshToken)
518518

519519
$params.addQueryParameter("client_id"; This.clientId)
520520
If (Length(This.scope)>0)
521-
$params.addQueryParameter("scope"; cs.Tools.me.urlEncode(This.scope))
521+
$params.addQueryParameter("scope"; cs._Tools.me.urlEncode(This.scope))
522522
End if
523523
$params.addQueryParameter("refresh_token"; This.token.refresh_token)
524524
$params.addQueryParameter("grant_type"; "refresh_token")
@@ -531,7 +531,7 @@ Function _getToken_SignedIn($bUseRefreshToken : Boolean) : Object
531531
If (Length(String(This.redirectURI))>0)
532532

533533
var $options : Object:={}
534-
$options.port:=cs.Tools.me.getPortFromURL(This.redirectURI)
534+
$options.port:=cs._Tools.me.getPortFromURL(This.redirectURI)
535535
$options.enableDebugLog:=This.enableDebugLog
536536
$options.useTLS:=(Position("https"; This.redirectURI)=1)
537537
If ((Value type(This.authenticationPage)=Is object) || (Value type(This.authenticationErrorPage)=Is object))
@@ -557,7 +557,7 @@ Function _getToken_SignedIn($bUseRefreshToken : Boolean) : Object
557557
End if
558558
End if
559559

560-
If ($bUseHostDatabaseServer || cs.Tools.me.startWebServer($options))
560+
If ($bUseHostDatabaseServer || cs._Tools.me.startWebServer($options))
561561

562562
var $authorizationCode : Text:=This._getAuthorizationCode()
563563

@@ -566,14 +566,14 @@ Function _getToken_SignedIn($bUseRefreshToken : Boolean) : Object
566566
$params.addQueryParameter("client_id"; This.clientId)
567567
$params.addQueryParameter("grant_type"; "authorization_code")
568568
$params.addQueryParameter("code"; $authorizationCode)
569-
$params.addQueryParameter("redirect_uri"; cs.Tools.me.urlEncode(This.redirectURI))
569+
$params.addQueryParameter("redirect_uri"; cs._Tools.me.urlEncode(This.redirectURI))
570570
If (This.PKCEEnabled)
571571
$params.addQueryParameter("code_verifier"; This.codeVerifier)
572572
End if
573573
If (Length(This.clientSecret)>0)
574574
$params.addQueryParameter("client_secret"; This.clientSecret)
575575
End if
576-
$params.addQueryParameter("scope"; cs.Tools.me.urlEncode(This.scope))
576+
$params.addQueryParameter("scope"; cs._Tools.me.urlEncode(This.scope))
577577

578578
Else
579579

@@ -607,7 +607,7 @@ Function _getToken_SignedIn($bUseRefreshToken : Boolean) : Object
607607
Function _getToken_Service() : Object
608608

609609
var $result : Object:=Null
610-
var $params : cs.URL:=cs.URL.new()
610+
var $params : cs._URL:=cs._URL.new()
611611
var $jwt : cs.JWT:=cs.JWT.new(This.privateKey)
612612
var $options : Object
613613
var $bearer : Text
@@ -628,7 +628,7 @@ Function _getToken_Service() : Object
628628

629629
$bearer:=$jwt.generate($options)
630630

631-
$params.addQueryParameter("grant_type"; cs.Tools.me.urlEncode(This.grantType))
631+
$params.addQueryParameter("grant_type"; cs._Tools.me.urlEncode(This.grantType))
632632
$params.addQueryParameter("assertion"; $bearer)
633633

634634
: (This._useJWTBearerAssertionType())
@@ -648,15 +648,15 @@ Function _getToken_Service() : Object
648648
// See documentation of https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-client-creds-grant-flow#second-case-access-token-request-with-a-certificate
649649
$params.addQueryParameter("grant_type"; This.grantType)
650650
$params.addQueryParameter("client_id"; This.clientId)
651-
$params.addQueryParameter("scope"; cs.Tools.me.urlEncode(This.scope))
652-
$params.addQueryParameter("client_assertion_type"; cs.Tools.me.urlEncode(This.clientAssertionType))
651+
$params.addQueryParameter("scope"; cs._Tools.me.urlEncode(This.scope))
652+
$params.addQueryParameter("client_assertion_type"; cs._Tools.me.urlEncode(This.clientAssertionType))
653653
$params.addQueryParameter("client_assertion"; $bearer)
654654

655655
Else
656656

657657
$params.addQueryParameter("client_id"; This.clientId)
658658
If (Length(This.scope)>0)
659-
$params.addQueryParameter("scope"; cs.Tools.me.urlEncode(This.scope))
659+
$params.addQueryParameter("scope"; cs._Tools.me.urlEncode(This.scope))
660660
End if
661661
$params.addQueryParameter("client_secret"; This.clientSecret)
662662
$params.addQueryParameter("grant_type"; This.grantType)
@@ -753,7 +753,7 @@ Function _sendTokenRequest($params : Text) : Object
753753
* copy the raw response body in a private member of the class
754754
*/
755755
var $blob : Blob
756-
CONVERT FROM TEXT($response; cs.Tools.me.getHeaderValueParameter($contentType; "charset"; "UTF-8"); $blob)
756+
CONVERT FROM TEXT($response; cs._Tools.me.getHeaderValueParameter($contentType; "charset"; "UTF-8"); $blob)
757757
This._internals._rawBody:=4D.Blob.new($blob)
758758
$result:=Null
759759

@@ -768,7 +768,7 @@ Function _sendTokenRequest($params : Text) : Object
768768

769769
Else
770770

771-
If (cs.Tools.me.webLicenseAvailable)
771+
If (cs._Tools.me.webLicenseAvailable)
772772
This._throwError(4) // Timeout error
773773
Else
774774
This._throwError(11) // License error
@@ -953,16 +953,16 @@ Function get authenticateURI() : Text
953953
var $scope : Text:=This.scope
954954
var $state : Text:=This.state
955955
var $redirectURI : Text:=This.redirectURI
956-
var $urlParams : cs.URL:=cs.URL.new()
956+
var $urlParams : cs._URL:=cs._URL.new()
957957

958958
$urlParams.addQueryParameter("client_id"; This.clientId)
959959
$urlParams.addQueryParameter("response_type"; "code")
960960
If (Length(String($scope))>0)
961-
$urlParams.addQueryParameter("scope"; cs.Tools.me.urlEncode($scope))
961+
$urlParams.addQueryParameter("scope"; cs._Tools.me.urlEncode($scope))
962962
End if
963-
$urlParams.addQueryParameter("state"; cs.Tools.me.urlEncode(String($state)))
963+
$urlParams.addQueryParameter("state"; cs._Tools.me.urlEncode(String($state)))
964964
$urlParams.addQueryParameter("response_mode"; "query")
965-
$urlParams.addQueryParameter("redirect_uri"; cs.Tools.me.urlEncode($redirectURI))
965+
$urlParams.addQueryParameter("redirect_uri"; cs._Tools.me.urlEncode($redirectURI))
966966
If (This.PKCEEnabled)
967967
$urlParams.addQueryParameter("code_challenge"; This._generateCodeChallenge(This.codeVerifier))
968968
$urlParams.addQueryParameter("code_challenge_method"; String(This.PKCEMethod))
@@ -978,7 +978,7 @@ Function get authenticateURI() : Text
978978
End if
979979
End if
980980
If (Length(String(This.nonce))>0)
981-
$urlParams.addQueryParameter("nonce"; cs.Tools.me.urlEncode(This.nonce))
981+
$urlParams.addQueryParameter("nonce"; cs._Tools.me.urlEncode(This.nonce))
982982
End if
983983

984984
$authenticateURI+=$urlParams.getQueryString()

Project/Sources/Classes/OAuth2Token.4dm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Function _loadFromResponse($inResponseString : Text)
5858

5959
Function _loadFromURLEncodedResponse($inResponseString : Text)
6060

61-
var $URL : cs.URL:=cs.URL.new()
61+
var $URL : cs._URL:=cs._URL.new()
6262
$URL.parseQuery($inResponseString)
6363
var $token : Object:={}
6464
var $iter : Object

0 commit comments

Comments
 (0)