Merge branch 'run-env-change' of https://github.com/CyberSource/cybersource-rest-client-ruby

# Conflicts:
#	lib/AuthenticationSDK/core/MerchantConfig.rb
#	lib/AuthenticationSDK/util/Constants.rb

Author: snavinch

README.md

@@ -8,42 +8,49 @@ The CyberSource Ruby client provides convenient access to the [CyberSource REST
 [rubygems]: https://rubygems.org/gems/cybersource_rest_client
 
 ## Requirements
+
 * Ruby 2.5.0 or higher
 * [CyberSource Account](https://developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration.html)
 * [CyberSource API Keys](https://prod.developer.cybersource.com/api/developer-guides/dita-gettingstarted/registration/createCertSharedKey.html)
 
 ## Dependencies
+
 * activesupport 6.0.3.2
 * interface 1.0.4
 * json 2.1.0
 * jwt 2.1.0
 * typhoeus 1.3.1
 
 ## Installation
+
 ### Bundler
-Be sure to always use HTTPS rubygems source in your gemfile and include the cybersource_rest_client.
 
-```
-source 'https://rubygems.org' do
-  gem 'cybersource_rest_client'
-end
+Be sure to always use HTTPS rubygems source in your gemfile and include the cybersource_rest_client.
 
+```ruby
+	source 'https://rubygems.org' do
+	  gem 'cybersource_rest_client'
+	end
 ```
 
 ## 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)
 
 Once you have your keys, simply load them into the appropriate variables in your code, as per the below sample code dealing with the authentication part of the API request. 
 
 Remember this SDK is for use in server-side Ruby 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 Ruby Sample Code Repository (on GitHub)](https://github.com/CyberSource/cybersource-rest-samples-ruby)
+
+* [CyberSource Ruby Sample Code Repository (on GitHub)](https://github.com/CyberSource/cybersource-rest-samples-ruby)
 
 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.
@@ -59,18 +66,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` property in the SDK Configuration.  See our sample at https://github.com/CyberSource/cybersource-rest-samples-ruby/blob/master/data/Configuration.rb
+
+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` property in the SDK Configuration.  See our sample at <https://github.com/CyberSource/cybersource-rest-samples-ruby/blob/master/data/Configuration.rb>
 
 ```Ruby
    # For TESTING use
-   runEnvironment='cybersource.environment.sandbox'
+     runEnvironment='apitest.cybersource.com'
    # For PRODUCTION use
-   # runEnvironment='cybersource.environment.production'
+   # 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.

cybersource_rest_client.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.summary     = "CyberSource Ruby SDK Gem"
   s.description = "Simple REST API for the CyberSource Global Payments Platform"
   s.license     = "CyberSource"
-  s.files       = Dir.glob("{lib}/**/*")
+  s.files       = Dir.glob("{lib}/{cybersource_rest_client}/**/*") + Dir.glob("{lib}/{AuthenticationSDK}/authentication/**/*") + Dir.glob("{lib}/{AuthenticationSDK}/core/**/*") + Dir.glob("{lib}/{AuthenticationSDK}/util/**/*") + Dir.glob("{lib}/cybersource_rest_client.rb")
   s.required_ruby_version = ">= 1.9"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'

lib/AuthenticationSDK/core/MerchantConfig.rb

@@ -84,26 +84,11 @@ def validateMerchantDetails()
       if !@runEnvironment.to_s.empty?
         if !@runEnvironment.instance_of? String
           @requestHost = @runEnvironment.to_s
-        elsif @runEnvironment.upcase == Constants::RUN_ENV_PROD
-          @requestHost = Constants::PRODUCTION_URL
-        elsif @runEnvironment.upcase == Constants::RUN_ENV_SANDBOX
-          @requestHost = Constants::SANDBOX_URL
-        elsif @runEnvironment.upcase == Constants::BOA_RUN_ENV_PROD
-          @requestHost = Constants::BOA_PRODUCTION_URL
-        elsif @runEnvironment.upcase == Constants::BOA_RUN_ENV_SANDBOX
-          @requestHost = Constants::BOA_SANDBOX_URL
-        elsif @runEnvironment.upcase == Constants::IDC_RUN_ENV_PROD
-          @requestHost = Constants::IDC_PRODUCTION_URL
-        elsif @runEnvironment.upcase == Constants::IDC_RUN_ENV_SANDBOX
-          @requestHost = Constants::IDC_SANDBOX_URL
-        elsif @runEnvironment.upcase == Constants::RUN_ENV_MUTUAL_AUTH_SANDBOX
-          @requestHost = Constants::MA_SANDBOX_URL
-        elsif @runEnvironment.upcase == Constants::RUN_ENV_MUTUAL_AUTH_PROD
-          @requestHost = Constants::MA_PRODUCTION_URL
-        elsif @runEnvironment.upcase == Constants::RUN_ENV_SIT
-          @requestHost = Constants::SIT_URL
-        elsif @runEnvironment.upcase == Constants::RUN_ENV_MUTUAL_AUTH_SIT
-          @requestHost = Constants::MA_SIT_URL
+        end
+        
+        if Constants::OLD_RUN_ENVIRONMENT_CONSTANTS.include?(@runEnvironment.upcase)
+          err = raise StandardError.new(Constants::ERROR_PREFIX + Constants::DERPECATED_ENVIRONMENT)
+          ApiException.new.apiexception(err, log_obj)
         else
           @requestHost = @runEnvironment
         end

lib/AuthenticationSDK/util/Constants.rb

@@ -1,177 +1,141 @@
   class Constants
 
       GET_REQUEST_TYPE_LOWER = 'get' unless const_defined?(:GET_REQUEST_TYPE_LOWER)
-      
+
       POST_REQUEST_TYPE_LOWER = 'post' unless const_defined?(:POST_REQUEST_TYPE_LOWER)
-      
+
       PUT_REQUEST_TYPE_LOWER = 'put' unless const_defined?(:PUT_REQUEST_TYPE_LOWER)
 
       PATCH_REQUEST_TYPE_LOWER = 'patch' unless const_defined?(:PATCH_REQUEST_TYPE_LOWER)
-      
+
       DELETE_REQUEST_TYPE_LOWER = 'delete' unless const_defined?(:DELETE_REQUEST_TYPE_LOWER)
 
       GET_REQUEST_TYPE = 'GET' unless const_defined?(:GET_REQUEST_TYPE)
-      
+
       POST_REQUEST_TYPE = 'POST' unless const_defined?(:POST_REQUEST_TYPE)
-      
+
       PUT_REQUEST_TYPE = 'PUT' unless const_defined?(:PUT_REQUEST_TYPE)
 
       PATCH_REQUEST_TYPE = 'PATCH' unless const_defined?(:PATCH_REQUEST_TYPE)
-      
+
       DELETE_REQUEST_TYPE = 'DELETE' unless const_defined?(:DELETE_REQUEST_TYPE)
 
       V_C_MERCHANT_ID = 'v-c-merchant-id' unless const_defined?(:V_C_MERCHANT_ID)
-      
+
       HOST = 'host' unless const_defined?(:HOST)
-      
+
       DATE = 'date' unless const_defined?(:DATE)
-      
+
       REQUEST_TARGET = '(request-target)' unless const_defined?(:REQUEST_TARGET)
-      
+
       DIGEST = 'digest' unless const_defined?(:DIGEST)
-      
+
       SIGNATURE = 'Signature' unless const_defined?(:SIGNATURE)
-      
+
       HTTPS_URI_PREFIX = 'https://' unless const_defined?(:HTTPS_URI_PREFIX)
-      
+
       BEARER = 'Bearer' unless const_defined?(:BEARER)
-      
+
       MEDIA_TYPE_JSON = 'application/json' unless const_defined?(:MEDIA_TYPE_JSON)
-      
+
       SIGNATURE_ALGORITHM = 'HmacSHA256' unless const_defined?(:SIGNATURE_ALGORITHM)
-      
+
       ALGORITHM = "algorithm=\"" unless const_defined?(:ALGORITHM)
-      
+
       SHA256 = 'SHA-256=' unless const_defined?(:SHA256)
-      
+
       CONTENT_TYPE = 'Content-Type' unless const_defined?(:CONTENT_TYPE)
-      
+
       USER_AGENT = 'User-Agent' unless const_defined?(:USER_AGENT)
-      
+
       USER_AGENT_VALUE = 'Mozilla/5.0' unless const_defined?(:USER_AGENT_VALUE)
-      
+
       KEY_ID = "keyid=\"" unless const_defined?(:KEY_ID)
-      
+
       HEADERS_PARAM = "headers=\"" unless const_defined?(:HEADERS_PARAM)
-      
+
       SIGNATURE_PARAM = "signature=\"" unless const_defined?(:SIGNATURE_PARAM)
 
       AUTH_TYPE_HTTP = 'HTTP_SIGNATURE' unless const_defined?(:AUTH_TYPE_HTTP)
-      
-      AUTH_TYPE_JWT = 'JWT' unless const_defined?(:AUTH_TYPE_JWT)
 
       AUTH_TYPE_OAUTH = 'OAUTH' unless const_defined?(:AUTH_TYPE_OAUTH)
 
       AUTH_TYPE_MUTUAL_AUTH = 'MUTUAL_AUTH' unless const_defined?(:AUTH_TYPE_MUTUAL_AUTH)
+	    
+      AUTH_TYPE_JWT = 'JWT' unless const_defined?(:AUTH_TYPE_JWT)
 
-      RUN_ENV_SANDBOX = 'CYBERSOURCE.ENVIRONMENT.SANDBOX' unless const_defined?(:RUN_ENV_SANDBOX)
-
-      RUN_ENV_MUTUAL_AUTH_SANDBOX = 'CYBERSOURCE.ENVIRONMENT.MUTUALAUTH.SANDBOX' unless const_defined?(:RUN_ENV_MUTUAL_AUTH_SANDBOX)
-      
-      RUN_ENV_PROD = 'CYBERSOURCE.ENVIRONMENT.PRODUCTION'unless const_defined?(:RUN_ENV_PROD)
-
-      RUN_ENV_MUTUAL_AUTH_PROD = 'CYBERSOURCE.ENVIRONMENT.MUTUALAUTH.PRODUCTION' unless const_defined?(:RUN_ENV_MUTUAL_AUTH_PROD)
-
-      RUN_ENV_SIT = 'CYBERSOURCE.ENVIRONMENT.SIT' unless const_defined?(:RUN_ENV_SIT)
-
-      RUN_ENV_MUTUAL_AUTH_SIT = 'CYBERSOURCE.ENVIRONMENT.MUTUALAUTH.SIT' unless const_defined?(:RUN_ENV_MUTUAL_AUTH_SIT)
-
-      SANDBOX_URL = 'apitest.cybersource.com' unless const_defined?(:SANDBOX_URL)
-
-      SIT_URL = 'pnrstage.ic3.com:7448' unless const_defined?(:SIT_URL)
-
-      MA_SIT_URL = 'pnrstage.ic3.com:8451' unless const_defined?(:MA_SIT_URL)
-
-      MA_SANDBOX_URL = 'api-matest.cybersource.com' unless const_defined?(:MA_SANDBOX_URL)
-      
-      PRODUCTION_URL = 'api.cybersource.com' unless const_defined?(:PRODUCTION_URL)
-
-      MA_PRODUCTION_URL = 'api-ma.cybersource.com' unless const_defined?(:MA_PRODUCTION_URL)
-
-      BOA_RUN_ENV_SANDBOX = 'BANKOFAMERICA.ENVIRONMENT.SANDBOX' unless const_defined?(:BOA_RUN_ENV_SANDBOX)
-      
-      BOA_RUN_ENV_PROD = 'BANKOFAMERICA.ENVIRONMENT.PRODUCTION' unless const_defined?(:BOA_RUN_ENV_PROD)
-
-      BOA_SANDBOX_URL = 'apitest.merchant-services.bankofamerica.com' unless const_defined?(:BOA_SANDBOX_URL)
-      
-      BOA_PRODUCTION_URL = 'api.merchant-services.bankofamerica.com' unless const_defined?(:BOA_PRODUCTION_URL)
-
-      IDC_RUN_ENV_SANDBOX = 'CYBERSOURCE.IN.ENVIRONMENT.SANDBOX' unless const_defined?(:IDC_RUN_ENV_SANDBOX)
-
-      IDC_RUN_ENV_PROD = 'CYEBRSOURCE.IN.ENVIRONMENT.PRODUCTION' unless const_defined?(:IDC_RUN_ENV_PROD)
-
-      IDC_SANDBOX_URL = 'apitest.cybersource.com' unless const_defined?(:IDC_SANDBOX_URL)
-
-      IDC_PRODUCTION_URL = 'api.in.cybersource.com' unless const_defined?(:IDC_PRODUCTION_URL)	    
+      OLD_RUN_ENVIRONMENT_CONSTANTS = ['CYBERSOURCE.ENVIRONMENT.SANDBOX', 'CYBERSOURCE.ENVIRONMENT.MUTUALAUTH.SANDBOX', 'CYBERSOURCE.ENVIRONMENT.PRODUCTION', 
+      'CYBERSOURCE.ENVIRONMENT.MUTUALAUTH.PRODUCTION', 'CYBERSOURCE.IN.ENVIRONMENT.SANDBOX', 'CYBERSOURCE.IN.ENVIRONMENT.PRODUCTION', 'CYBERSOURCE.ENVIRONMENT.SIT', 
+      'CYBERSOURCE.ENVIRONMENT.MUTUALAUTH.SIT', 'BANKOFAMERICA.ENVIRONMENT.SANDBOX', 'BANKOFAMERICA.ENVIRONMENT.PRODUCTION']
 
       # constants for fall back logic
 
       DEFAULT_LOG_SIZE = 10485760 unless const_defined?(:DEFAULT_LOG_SIZE)
-      
+
       DEFAULT_PROXY_ADDRESS = 'userproxy.visa.com' unless const_defined?(:DEFAULT_PROXY_ADDRESS)
-      
+
       DEFAULT_PROXY_PORT = '443' unless const_defined?(:DEFAULT_PROXY_PORT)
-      
+
       DEFAULT_TIMEOUT = '1000' unless const_defined?(:DEFAULT_TIMEOUT)
-      
+
       DEFAULT_LOG_DIRECTORY = '../log' unless const_defined?(:DEFAULT_LOG_DIRECTORY)
-      
+
       DEFAULT_KEY_DIRECTORY = 'resource' unless const_defined?(:DEFAULT_KEY_DIRECTORY)
-      
+
       DEFAULT_LOGFILE_NAME = 'cybs' unless const_defined?(:DEFAULT_LOGFILE_NAME)
 
       # Constant for Fall back logic and Exception Handling
 
       REQUEST_JSON_ERROR = 'Request Json File missing. File Path :: ' unless const_defined?(:REQUEST_JSON_ERROR)
-      
+
       INVALID_ENABLE_LOG = 'EnableLog should be (True/False) in cybs.yml' unless const_defined?(:INVALID_ENABLE_LOG)
-      
+
       REFER_LOG = 'Please refer Log for details' unless const_defined?(:REFER_LOG)
-      
+
       MERCHANT_ID_NULL = 'MerchantID is mandatory' unless const_defined?(:MERCHANT_ID_NULL)
-      
+
       INCORRECT_KEY_PASS = 'The keyPass Entered is Incorrect' unless const_defined?(:INCORRECT_KEY_PASS)
-      
+
       AUTH_TYPE_MANDATORY= 'AuthenticationType is Mandatory' unless const_defined?(:AUTH_TYPE_MANDATORY)
-      
+
       MERCHANT_KEY_ID_MANDATORY = 'MerchantKeyId is Mandatory' unless const_defined?(:MERCHANT_KEY_ID_MANDATORY)
-      
+
       MERCHANT_SECRET_KEY_MANDATORY = 'MerchantSecretKey is Mandatory' unless const_defined?(:MERCHANT_SECRET_KEY_MANDATORY)
 
       PORTFOLIO_ID_MANDATORY = 'PortfolioID is Mandatory' unless const_defined?(:PORTFOLIO_ID_MANDATORY)
-      
+
       KEY_PASS_NULL = 'keyPass is empty, Assigining merchantID value' unless const_defined?(:KEY_PASS_NULL)
-      
+
       REQUEST_JSON_PATH_EMPTY = 'RequestJsonPath not provided. Using Default Value:'unless const_defined?(:REQUEST_JSON_PATH_EMPTY)
-      
+
       REQUEST_TYPE_EMPTY = 'RequestType Property of Merchant Config Not Set' unless const_defined?(:REQUEST_TYPE_EMPTY)
-      
+
       INVALID_REQUEST_TYPE_METHOD = 'Entered Request Type should be (GET/POST/PUT)' unless const_defined?(:INVALID_REQUEST_TYPE_METHOD)
-      
+
       INVALID_LOG_DIRECTORY = 'Entered LogDirectory is Incorrect. Using Default Path: ' unless const_defined?(:INVALID_LOG_DIRECTORY)
-      
+
       RUN_ENVIRONMENT_ERROR = 'Entered RunEnvironment is Incorrect.' unless const_defined?(:RUN_ENVIRONMENT_ERROR)
-      
+
       PROPERTY_FILE_NOT_FOUND = 'Cybs.yml file not found' unless const_defined?(:PROPERTY_FILE_NOT_FOUND)
 
       ERROR_PREFIX = 'Error: ' unless const_defined?(:ERROR_PREFIX)
-      
+
       WARNING_PREFIX = 'Warning: ' unless const_defined?(:WARNING_PREFIX)
-      
+
       HIDDEN_MERCHANT_PROPERTIES = 'merchantID,merchantKeyId,merchantsecretKey,keyAlias,keyPass' unless const_defined?(:HIDDEN_MERCHANT_PROPERTIES)
-      
+
       RUN_ENVIRONMENT = 'RunEnvironment is Mandatory' unless const_defined?(:RUN_ENVIRONMENT)
-      
+
       KEY_DIRECTORY_EMPTY = 'KeysDirectory not provided. Using Default Path:' unless const_defined?(:KEY_DIRECTORY_EMPTY)
-      
+
       FILE_NOT_FOUND = 'File not found, Re-Enter path/file name, Entered path/file name :: ' unless const_defined?(:FILE_NOT_FOUND)
-      
+
       AUTH_ERROR = 'Check Authentication Type (HTTP_Signature/JWT) in cybs.yml.' unless const_defined?(:AUTH_ERROR)
-      
+
       KEY_FILE_NAME_NULL_EMPTY = 'KeyFilename Empty/Null. Assigining merchantID value' unless const_defined?(:KEY_FILE_NAME_NULL_EMPTY)
-      
+
       KEY_ALIAS_NULL_EMPTY = 'KeyAlias Empty/Null. Assigining merchantID value' unless const_defined?(:KEY_ALIAS_NULL_EMPTY)
-      
+
       INCORRECT_KEY_ALIAS = 'The Entered KeyAlias is Incorrect. Assigining merchantID value' unless const_defined?(:INCORRECT_KEY_ALIAS)
 
       ENABLE_CLIENT_CERT_EMPTY = 'Enable Clientcert is Empty/Null.' unless const_defined?(:ENABLE_CLIENT_CERT_EMPTY)
@@ -191,4 +155,6 @@ class Constants
       ACCESS_TOKEN_EMPTY = 'AccessToken is Empty/Null' unless const_defined?(:ACCESS_TOKEN_REQ)
 
       REFRESH_TOKEN_EMPTY = 'RefreshToken is Empty/Null' unless const_defined?(:REFRESH_TOKEN_REQ)
+      
+      DERPECATED_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.'
   end