feat(centralnic-reseller-go-sdk): introducing CNR Go-SDK API Connector

BREAKING CHANGE: We have deprecated the Hexonet Go SDK and introduced the CentralNic Reseller Go SDK.

Author: AsifNawaz-cnic

apiclient/apiclient.go

@@ -20,21 +20,21 @@ import (
 	"strings"
 	"time"
 
-	IDN "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v4/idntranslator"
-	LG "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v4/logger"
-	R "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v4/response"
-	RTM "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v4/responsetemplatemanager"
-	SC "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v4/socketconfig"
+	IDN "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v5/idntranslator"
+	LG "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v5/logger"
+	R "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v5/response"
+	RTM "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v5/responsetemplatemanager"
+	SC "github.com/centralnicgroup-opensource/rtldev-middleware-go-sdk/v5/socketconfig"
 )
 
-// ISPAPI_CONNECTION_URL_PROXY represents the url used for the high performance connection setup
-const ISPAPI_CONNECTION_URL_PROXY = "http://127.0.0.1/api/call.cgi" //nolint
+// CNR_CONNECTION_URL_PROXY represents the url used for the high performance connection setup
+const CNR_CONNECTION_URL_PROXY = "http://127.0.0.1/api/call.cgi" //nolint
 
-// ISPAPI_CONNECTION_URL_LIVE represents the url used for the default connection setup
-const ISPAPI_CONNECTION_URL_LIVE = "https://api.ispapi.net/api/call.cgi" //nolint
+// CNR_CONNECTION_URL_LIVE represents the url used for the default connection setup
+const CNR_CONNECTION_URL_LIVE = "https://api.rrpproxy.net/api/call.cgi" //nolint
 
-// ISPAPI_CONNECTION_URL_OTE represents the url used for the OT&E (demo system) connection setup
-const ISPAPI_CONNECTION_URL_OTE = "https://api-ote.ispapi.net/api/call.cgi" //nolint
+// CNR_CONNECTION_URL_OTE represents the url used for the OT&E (demo system) connection setup
+const CNR_CONNECTION_URL_OTE = "https://api-ote.rrpproxy.net/api/call.cgi" //nolint
 
 var rtm = RTM.GetInstance()
 
@@ -59,14 +59,27 @@ type APIClient struct {
 	curlopts      map[string]string
 	ua            string
 	logger        LG.ILogger
+	subUser       string
+}
+
+// RequestOptions represents the options for an API request.
+type RequestOptions struct {
+	SetUserView bool // SetUserView indicates whether to set a data view to a given subuser.
+}
+
+// NewRequestOptions creates a new instance of RequestOptions with default values.
+func NewRequestOptions() *RequestOptions {
+	return &RequestOptions{
+		SetUserView: true,
+	}
 }
 
 // NewAPIClient represents the constructor for struct APIClient.
 func NewAPIClient() *APIClient {
 	cl := &APIClient{
 		debugMode:     false,
 		socketTimeout: 300 * time.Second,
-		socketURL:     ISPAPI_CONNECTION_URL_LIVE,
+		socketURL:     CNR_CONNECTION_URL_LIVE,
 		socketConfig:  SC.NewSocketConfig(),
 		curlopts:      map[string]string{},
 		ua:            "",
@@ -105,7 +118,7 @@ func (cl *APIClient) GetProxy() (string, error) {
 	if exists {
 		return val, nil
 	}
-	return "", errors.New("No proxy configuration available")
+	return "", errors.New("no proxy configuration available")
 }
 
 // SetReferer method to set a value for HTTP Header `Referer` to use for API communication
@@ -124,7 +137,7 @@ func (cl *APIClient) GetReferer() (string, error) {
 	if exists {
 		return val, nil
 	}
-	return "", errors.New("No configuration available for HTTP Header `Referer`")
+	return "", errors.New("no configuration available for HTTP Header `Referer`")
 }
 
 // EnableDebugMode method to enable Debug Output to logger
@@ -139,6 +152,24 @@ func (cl *APIClient) DisableDebugMode() *APIClient {
 	return cl
 }
 
+// SetUserView method to set a data view to a given subuser
+func (cl *APIClient) SetUserView(uid string) *APIClient {
+	cl.subUser = uid
+	return cl
+}
+
+// ResetUserView method to reset data view back from subuser to user
+func (cl *APIClient) ResetUserView() *APIClient {
+	cl.subUser = ""
+	return cl
+}
+
+// UseHighPerformanceConnectionSetup to activate high performance conneciton setup
+func (cl *APIClient) UseHighPerformanceConnectionSetup() *APIClient {
+	cl.SetURL(CNR_CONNECTION_URL_PROXY)
+	return cl
+}
+
 // GetPOSTData method to Serialize given command for POST request
 // including connection configuration data
 func (cl *APIClient) GetPOSTData(cmd map[string]string, secured ...bool) string {
@@ -180,7 +211,7 @@ func (cl *APIClient) GetPOSTData(cmd map[string]string, secured ...bool) string
 func (cl *APIClient) GetSession() (string, error) {
 	sessid := cl.socketConfig.GetSession()
 	if len(sessid) == 0 {
-		return "", errors.New("Could not find an active session")
+		return "", errors.New("could not find an active session")
 	}
 	return sessid, nil
 }
@@ -219,7 +250,6 @@ func (cl *APIClient) GetVersion() string {
 // Please save/update that map into user session
 func (cl *APIClient) SaveSession(sessionobj map[string]interface{}) *APIClient {
 	sessionobj["socketcfg"] = map[string]string{
-		"entity":  cl.socketConfig.GetSystemEntity(),
 		"session": cl.socketConfig.GetSession(),
 	}
 	return cl
@@ -229,7 +259,6 @@ func (cl *APIClient) SaveSession(sessionobj map[string]interface{}) *APIClient {
 // to rebuild and reuse connection settings
 func (cl *APIClient) ReuseSession(sessionobj map[string]interface{}) *APIClient {
 	cfg := sessionobj["socketcfg"].(map[string]string)
-	cl.socketConfig.SetSystemEntity(cfg["entity"])
 	cl.SetSession(cfg["session"])
 	return cl
 }
@@ -252,12 +281,6 @@ func (cl *APIClient) SetSession(value string) *APIClient {
 	return cl
 }
 
-// SetRemoteIPAddress method to set an Remote IP Address to be used for API communication
-func (cl *APIClient) SetRemoteIPAddress(value string) *APIClient {
-	cl.socketConfig.SetRemoteAddress(value)
-	return cl
-}
-
 // SetCredentials method to set Credentials to be used for API communication
 func (cl *APIClient) SetCredentials(uid string, pw string) *APIClient {
 	cl.socketConfig.SetLogin(uid)
@@ -268,7 +291,7 @@ func (cl *APIClient) SetCredentials(uid string, pw string) *APIClient {
 // SetRoleCredentials method to set Role User Credentials to be used for API communication
 func (cl *APIClient) SetRoleCredentials(uid string, role string, pw string) *APIClient {
 	if len(role) > 0 {
-		return cl.SetCredentials(uid+"!"+role, pw)
+		return cl.SetCredentials(uid+":"+role, pw)
 	}
 	return cl.SetCredentials(uid, pw)
 }
@@ -281,9 +304,9 @@ func (cl *APIClient) Login(params ...string) *R.Response {
 		otp = params[0]
 	}
 	cl.SetOTP(otp)
-	rr := cl.Request(map[string]interface{}{"COMMAND": "StartSession"})
+	rr := cl.Request(map[string]interface{}{"COMMAND": "StartSession"}, &RequestOptions{SetUserView: false})
 	if rr.IsSuccess() {
-		col := rr.GetColumn("SESSION")
+		col := rr.GetColumn("SESSIONID")
 		if col != nil {
 			cl.SetSession(col.GetData()[0])
 		} else {
@@ -312,9 +335,9 @@ func (cl *APIClient) LoginExtended(params ...interface{}) *R.Response {
 	for k, v := range parameters {
 		cmd[k] = v
 	}
-	rr := cl.Request(cmd)
+	rr := cl.Request(cmd, &RequestOptions{SetUserView: false})
 	if rr.IsSuccess() {
-		col := rr.GetColumn("SESSION")
+		col := rr.GetColumn("SESSIONID")
 		if col != nil {
 			cl.SetSession(col.GetData()[0])
 		} else {
@@ -328,15 +351,26 @@ func (cl *APIClient) LoginExtended(params ...interface{}) *R.Response {
 func (cl *APIClient) Logout() *R.Response {
 	rr := cl.Request(map[string]interface{}{
 		"COMMAND": "EndSession",
-	})
+	}, &RequestOptions{SetUserView: false})
 	if rr.IsSuccess() {
 		cl.SetSession("")
 	}
 	return rr
 }
 
 // Request method to perform API request using the given command
-func (cl *APIClient) Request(cmd map[string]interface{}) *R.Response {
+func (cl *APIClient) Request(cmd map[string]interface{}, opts ...*RequestOptions) *R.Response {
+	// Use default RequestOptions if opts is not available
+	options := NewRequestOptions()
+	if len(opts) > 0 {
+		options = opts[0]
+	}
+
+	// Check if SetUserView option is enabled and subUser is set
+	if (options.SetUserView) && (len(cl.subUser) > 0) {
+		cmd["SUBUSER"] = cl.subUser
+	}
+
 	// flatten nested api command bulk parameters
 	newcmd := cl.flattenCommand(cmd)
 	// auto convert umlaut names to punycode
@@ -460,42 +494,22 @@ func (cl *APIClient) RequestAllResponsePages(cmd map[string]string) []R.Response
 	return responses
 }
 
-// SetUserView method to set a data view to a given subuser
-func (cl *APIClient) SetUserView(uid string) *APIClient {
-	cl.socketConfig.SetUser(uid)
-	return cl
-}
-
-// ResetUserView method to reset data view back from subuser to user
-func (cl *APIClient) ResetUserView() *APIClient {
-	cl.socketConfig.SetUser("")
-	return cl
-}
-
-// UseHighPerformanceConnectionSetup to activate high performance conneciton setup
-func (cl *APIClient) UseHighPerformanceConnectionSetup() *APIClient {
-	cl.SetURL(ISPAPI_CONNECTION_URL_PROXY)
-	return cl
-}
-
 // UseDefaultConnectionSetup to activate default conneciton setup (the default anyways)
 func (cl *APIClient) UseDefaultConnectionSetup() *APIClient {
-	cl.SetURL(ISPAPI_CONNECTION_URL_LIVE)
+	cl.SetURL(CNR_CONNECTION_URL_LIVE)
 	return cl
 }
 
 // UseOTESystem method to set OT&E System for API communication
 func (cl *APIClient) UseOTESystem() *APIClient {
-	cl.SetURL(ISPAPI_CONNECTION_URL_OTE)
-	cl.socketConfig.SetSystemEntity("1234")
+	cl.SetURL(CNR_CONNECTION_URL_OTE)
 	return cl
 }
 
 // UseLIVESystem method to set LIVE System for API communication
 // Usage of LIVE System is active by default.
 func (cl *APIClient) UseLIVESystem() *APIClient {
-	cl.SetURL(ISPAPI_CONNECTION_URL_LIVE)
-	cl.socketConfig.SetSystemEntity("54cd")
+	cl.SetURL(CNR_CONNECTION_URL_LIVE)
 	return cl
 }