Merge pull request #1 from CyberSource/run-env-change

snavinch · web-flow · commit 96e26971376b · 2021-06-14T16:42:30.000+05:30
Run env change
diff --git a/README.md b/README.md
@@ -2,29 +2,33 @@
 
 The CyberSource Node client provides convenient access to the [CyberSource REST API](https://developer.cybersource.com/api/reference/api-reference.html) from your Node application.
 
-## Requirements  
+## Requirements
+
 * Node.js version 6.17.1 or higher
 * A CyberSource account (see _Registration & Configuration_ section below)
 
-
 ## Installation
 
 ```shell
-npm install cybersource-rest-client
+    npm install cybersource-rest-client
 ```
 
 ## Registration & Configuration
+
 Use of this SDK and the CyberSource APIs requires having an account on our system. You can find details of getting a test account and creating your keys [here](https://developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration.html)
 
 Remember this SDK is for use in server-side Node applications that access the CyberSource REST API and credentials should always be securely stored and accessed appropriately. 
 
 ## SDK Usage Examples and Sample Code
+
 To get started using this SDK, it's highly recommended to download our sample code repository:
+
 * [Cybersource Node.js Sample Code Repository (on GitHub)](https://github.com/CyberSource/cybersource-rest-samples-node)
 
 In that respository, we have comprehensive sample code for all common uses of our API:
 
 Additionally, you can find details and examples of how our API is structured in our API Reference Guide:
+
 * [Developer Center API Reference](https://developer.cybersource.com/api/reference/api-reference.html)
 
 The API Reference Guide provides examples of what information is needed for a particular request and how that information would be formatted. Using those examples, you can easily determine what methods would be necessary to include that information in a request using this SDK.
@@ -40,18 +44,18 @@ MIDs continue to be able to create keys for themselves, even if a Meta Key is ge
 Further information on MetaKey can be found in [New Business Center User Guide](https://developer.cybersource.com/library/documentation/dev_guides/Business_Center/New_Business_Center_User_Guide.pdf).
 
 ### Switching between the sandbox environment and the production environment
-Cybersource maintains a complete sandbox environment for testing and development purposes. This sandbox environment is an exact duplicate of our production environment with the transaction authorization and settlement process simulated. By default, this SDK is configured to communicate with the sandbox environment. To switch to the production environment, set the `runEnvironment` in the SDK Configuration.  See our sample at https://github.com/CyberSource/cybersource-rest-samples-node/blob/master/Data/Configuration.js.  
+
+Cybersource maintains a complete sandbox environment for testing and development purposes. This sandbox environment is an exact duplicate of our production environment with the transaction authorization and settlement process simulated. By default, this SDK is configured to communicate with the sandbox environment. To switch to the production environment, set the `runEnvironment` in the SDK Configuration.  See our sample at <https://github.com/CyberSource/cybersource-rest-samples-node/blob/master/Data/Configuration.js>.
 
 ```javascript
-// For TESTING use
-const RunEnvironment = "cybersource.environment.sandbox";
-// For PRODUCTION use
-const RunEnvironment = "cybersource.environment.production";
+    // For TESTING use
+    const RunEnvironment = "apitest.cybersource.com";
+    // For PRODUCTION use
+    const RunEnvironment = "api.cybersource.com";
 ```
 
 API credentials are different for each environment, so be sure to switch to the appropriate credentials when switching environments.
 
-
-
 ## License
+
 This repository is distributed under a proprietary license. See the provided [`LICENSE.txt`](/LICENSE.txt) file.
diff --git a/src/authentication/core/MerchantConfig.js b/src/authentication/core/MerchantConfig.js
@@ -306,21 +306,12 @@ MerchantConfig.prototype.runEnvironmentCheck = function runEnvironmentCheck(logg
         if (typeof (this.runEnvironment) !== "string") {
             this.runEnvironment = this.runEnvironment.toString();
         }
-        if (this.runEnvironment.toLowerCase() === Constants.SANDBOX_RUN_ENV) {
-            this.setRequestHost(Constants.SANDBOX_URL);
-        } else if (this.runEnvironment.toLowerCase() === Constants.PRODUCTION_RUN_ENV) {
-            this.setRequestHost(Constants.PRODUCTION_URL);
-        } else if (this.runEnvironment.toLowerCase() === Constants.BOA_SANDBOX_RUN_ENV) {
-            this.setRequestHost(Constants.BOA_SANDBOX_URL);
-        } else if (this.runEnvironment.toLowerCase() === Constants.BOA_PRODUCTION_RUN_ENV) {
-            this.setRequestHost(Constants.BOA_PRODUCTION_URL);
-        } else if (this.runEnvironment.toLowerCase() === Constants.IDC_SANDBOX_RUN_ENV) {
-            this.setRequestHost(Constants.IDC_SANDBOX_URL);
-        } else if (this.runEnvironment.toLowerCase() === Constants.IDC_PRODUCTION_RUN_ENV) {
-            this.setRequestHost(Constants.IDC_PRODUCTION_URL);
-        } else {
-            this.setRequestHost(this.runEnvironment);
+
+        if (Constants.OLD_RUN_ENVIRONMENT_CONSTANTS.includes(this.runEnvironment.toUpperCase())) {
+            ApiException.ApiException(Constants.DEPRECATED_RUN_ENVIRONMENT, logger);
         }
+
+        this.setRequestHost(this.runEnvironment);
     }
 
 }
diff --git a/src/authentication/util/Constants.js b/src/authentication/util/Constants.js
@@ -4,103 +4,90 @@
  * These are constant variables
  */
 module.exports = {
-     POST                 : "post", 
-     GET                  : "get",
-     PUT                  : "put",
-     DELETE               : "delete",
-     PATCH                : "patch",
-     HTTP_URL_PREFIX      : "https://", 
-    /**/
-     HTTP                 : "http_signature",
-     JWT                  : "jwt",
-     V_C_MERCHANTID       : "v-c-merchant-id",
-     DATE                 : "date",
-     HOST                 : "host",
-     SIGNATURE            : "Signature", 
-     USERAGENT            : "User-Agent",
-     USER_AGENT_VALUE     : "Mozilla/5.0",
-     CONTENT_TYPE         : "Content-Type",
-     APPLICATION_JSON     : "application/json",
-     V_C_CORRELATION_ID   : "v-c-correlation-id",
-     STATUS_INFORMATION   : "Status Information",
-     DIGEST               : "digest",
-     REQUEST_TYPE         : "Request Type",
-     
-     SANDBOX_URL          : "apitest.cybersource.com",
-     PRODUCTION_URL       : "api.cybersource.com",
-     SANDBOX_RUN_ENV      : "cybersource.environment.sandbox",
-     PRODUCTION_RUN_ENV   : "cybersource.environment.production",
-     
-     BOA_SANDBOX_URL          : "apitest.merchant-services.bankofamerica.com",
-     BOA_PRODUCTION_URL       : "api.merchant-services.bankofamerica.com",
-     BOA_SANDBOX_RUN_ENV      : "bankofamerica.environment.sandbox",
-     BOA_PRODUCTION_RUN_ENV   : "bankofamerica.environment.production",
+    POST                              :  "post",
+    GET                               :  "get",
+    PUT                               :  "put",
+    DELETE                            :  "delete",
+    PATCH                             :  "patch",
+    HTTP_URL_PREFIX                   :  "https://",
+    HTTP                              :  "http_signature",
+    JWT                               :  "jwt",
+    V_C_MERCHANTID                    :  "v-c-merchant-id",
+    DATE                              :  "date",
+    HOST                              :  "host",
+    SIGNATURE                         :  "Signature",
+    USERAGENT                         :  "User-Agent",
+    USER_AGENT_VALUE                  :  "Mozilla/5.0",
+    CONTENT_TYPE                      :  "Content-Type",
+    APPLICATION_JSON                  :  "application/json",
+    V_C_CORRELATION_ID                :  "v-c-correlation-id",
+    STATUS_INFORMATION                :  "Status Information",
+    DIGEST                            :  "digest",
+    REQUEST_TYPE                      :  "Request Type",
 
-     IDC_SANDBOX_URL          : "apitest.cybersource.com",
-     IDC_PRODUCTION_URL       : "api.in.cybersource.com",
-     IDC_SANDBOX_RUN_ENV      : "cybersource.in.environment.sandbox",
-     IDC_PRODUCTION_RUN_ENV   : "cybersource.in.environment.production",
+    OLD_RUN_ENVIRONMENT_CONSTANTS     :  ["CYBERSOURCE.ENVIRONMENT.SANDBOX", "CYBERSOURCE.ENVIRONMENT.PRODUCTION",
+        "CYBERSOURCE.IN.ENVIRONMENT.SANDBOX", "CYBERSOURCE.IN.ENVIRONMENT.PRODUCTION"],
 
     /* Digest Constants*/
-     SIGNATURE_ALGORITHAM       : "SHA-256=",
-     HmacSHA256                 : "HmacSHA256",
-        
+    SIGNATURE_ALGORITHAM              :  "SHA-256=",
+    HmacSHA256                        :  "HmacSHA256",
+
     /* Logging Labels*/
-    BEGIN_TRANSACTION       : "************************ LOGGING START ************************",
-    END_TRANSACTION         : "************************  LOGGING END  ************************",
-    MERCHANTID              : "MERCHANTID",
-    MERCHANT_KEY_ID         : "MERCHANT_KEY_ID",
-    MERCHANT_SECERT_KEY     : "MERCHANT_SECERT_KEY",
-    REQUEST_BODY            : "Request Body",
-    RESPONSE_CODE           : "Response Code",
-    RESPONSE_MESSAGE        : "Response Message",
-    AUTHORIZATION           : "Authorization",
-    HideMerchantConfigProps : "merchantID,merchantsecretKey,merchantKeyId,keyAlias,keyPass,requestJsonData",
+    BEGIN_TRANSACTION                 :  "************************ LOGGING START ************************",
+    END_TRANSACTION                   :  "************************  LOGGING END  ************************",
+    MERCHANTID                        :  "MERCHANTID",
+    MERCHANT_KEY_ID                   :  "MERCHANT_KEY_ID",
+    MERCHANT_SECERT_KEY               :  "MERCHANT_SECERT_KEY",
+    REQUEST_BODY                      :  "Request Body",
+    RESPONSE_CODE                     :  "Response Code",
+    RESPONSE_MESSAGE                  :  "Response Message",
+    AUTHORIZATION                     :  "Authorization",
+    HideMerchantConfigProps           :  "merchantID,merchantsecretKey,merchantKeyId,keyAlias,keyPass,requestJsonData",
 
     /* Masking list*/
-    MASKING_DATA            : "expirationMonth, expirationYear, email,firstName, lastName, phoneNumber, number, securityCode, type",
-    
-    /* Exception labels */
-    PROXY_PREFIX               : "https",
-    FILE_NOT_FOUND             : "File not found, Re-Enter path/file name, Entered path/file name :: ",
-    AUTH_ERROR                 : "Check Authentication Type (HTTP_Signature/JWT) in cybs.json.",
-    KEY_ALIAS_NULL_EMPTY       : "KeyAlias Empty/Null. Assigining merchantID value",
-    REQUEST_JSON_ERROR         : "Request Json File missing. File Path :: ",
-    KEY_FILE_EMPTY             : "KeyFileName is empty, Assigining merchantID value",
-    REFER_LOG                  : "Please refer Log for details",
-    MERCHANTID_REQ             : "MerchantID is mandatory",
-    INCORRECT_KEY_ALIAS        : "The Entered key_alias is Incorrect, Assigining merchantID value",
-    INCORRECT_KEY_PASS         : "The Entered keyPass is Incorrect",
-    AUTHENTICATION_REQ         : "AuthenticationType is Mandatory",
-    MERCHANT_KEY_ID_REQ        : "MerchantKeyId is Mandatory",
-    PORTFOLIO_ID_REQ           : "PortfolioID is Mandatory",
-    RUN_ENVIRONMENT_REQ        : "RunEnvironment is Mandatory",
-    MERCHANT_SECRET_KEY_REQ    : "MerchantSecretKey is Mandatory",
-    KEY_PASS_EMPTY             : "KeyPass Empty/Null. Assigining merchantID value",
-    KEY_DIRECTORY_EMPTY        : "KeysDirectory not provided. Using Default Path:",
-    REQUEST_JSON_EMPTY         : "RequestJsonPath not provided",
-    INVALID_LOGDIRECTORY       : "Entered log directory does not exists. Taking default log directory ./log",
-    INVALID_REQUEST_TYPE_METHOD     :"Entered Request Type should be (GET/POST/PUT/DELETE)",
+    MASKING_DATA                      :  "expirationMonth, expirationYear, email,firstName, lastName, phoneNumber, number, securityCode, type",
 
+    /* Exception labels */
+    PROXY_PREFIX                      :  "https",
+    FILE_NOT_FOUND                    :  "File not found, Re-Enter path/file name, Entered path/file name : ",
+    AUTH_ERROR                        :  "Check Authentication Type (HTTP_Signature/JWT) in cybs.json.",
+    KEY_ALIAS_NULL_EMPTY              :  "KeyAlias Empty/Null. Assigining merchantID value",
+    REQUEST_JSON_ERROR                :  "Request Json File missing. File Path : ",
+    KEY_FILE_EMPTY                    :  "KeyFileName is empty, Assigining merchantID value",
+    REFER_LOG                         :  "Please refer Log for details",
+    MERCHANTID_REQ                    :  "MerchantID is mandatory",
+    INCORRECT_KEY_ALIAS               :  "The Entered key_alias is Incorrect, Assigining merchantID value",
+    INCORRECT_KEY_PASS                :  "The Entered keyPass is Incorrect",
+    AUTHENTICATION_REQ                :  "AuthenticationType is Mandatory",
+    MERCHANT_KEY_ID_REQ               :  "MerchantKeyId is Mandatory",
+    PORTFOLIO_ID_REQ                  :  "PortfolioID is Mandatory",
+    RUN_ENVIRONMENT_REQ               :  "RunEnvironment is Mandatory",
+    MERCHANT_SECRET_KEY_REQ           :  "MerchantSecretKey is Mandatory",
+    KEY_PASS_EMPTY                    :  "KeyPass Empty/Null. Assigining merchantID value",
+    KEY_DIRECTORY_EMPTY               :  "KeysDirectory not provided. Using Default Path : ",
+    REQUEST_JSON_EMPTY                :  "RequestJsonPath not provided",
+    INVALID_LOGDIRECTORY              :  "Entered log directory does not exists. Taking default log directory ./log",
+    INVALID_REQUEST_TYPE_METHOD       :  "Entered Request Type should be (GET/POST/PUT/DELETE)",
+    DEPRECATED_RUN_ENVIRONMENT        :  "The value provided for this field `RunEnvironment` has been deprecated and will not be used anymore.\n\nPlease refer to the README file [ https://github.com/CyberSource/cybersource-rest-samples-node/blob/master/README.md ] for information about the new values that are accepted.",
     /*Fall back default values*/
 
-    DEFAULT_LOG_SIZE          : "10485760", //10 MB
-    DEFAULT_PROXY_ADDRESS     : "userproxy.visa.com",
-    DEFAULT_PROXY_PORT        : "443",
-    DEFAULT_TIMEOUT           : 1000, //1000 milliseconds
-    DEFAULT_LOG_DIRECTORY     : "./log",
-    DEFAULT_KEYS_DIRECTORY    : "resource",
-    DEFAULT_LOG_FILENAME      : "cybs",
-    DEFAULT_MAX_LOG_FILES     : "10d",
-    DEFAULT_LOGGING_LEVEL     : "error",
+    DEFAULT_LOG_SIZE                  :  "10485760", //10 MB
+    DEFAULT_PROXY_ADDRESS             :  "userproxy.visa.com",
+    DEFAULT_PROXY_PORT                :  "443",
+    DEFAULT_TIMEOUT                   :  1000, //1000 milliseconds
+    DEFAULT_LOG_DIRECTORY             :  "./log",
+    DEFAULT_KEYS_DIRECTORY            :  "resource",
+    DEFAULT_LOG_FILENAME              :  "cybs",
+    DEFAULT_MAX_LOG_FILES             :  "10d",
+    DEFAULT_LOGGING_LEVEL             :  "error",
 
-    STATUS200                 : "Transaction Successful",
-    STATUS400                 : "Bad Request",
-    STATUS401                 : "Authentication Failed",
-    STATUS403                 : "Forbidden",
-    STATUS404                 : "URL not found",
-    STATUS500                 : "Internal Server Error",
-    STATUS502                 : "Bad Gateway",
-    STATUS503                 : "Service Unavailable",
-    STATUS504                 : "Gateway Timeout"
+    STATUS200                         :  "Transaction Successful",
+    STATUS400                         :  "Bad Request",
+    STATUS401                         :  "Authentication Failed",
+    STATUS403                         :  "Forbidden",
+    STATUS404                         :  "URL not found",
+    STATUS500                         :  "Internal Server Error",
+    STATUS502                         :  "Bad Gateway",
+    STATUS503                         :  "Service Unavailable",
+    STATUS504                         :  "Gateway Timeout"
 };
