mastercard_core_sdk 1.1.3

data/lib/mastercard_core_sdk/oauth/oauth_parameters.rb

@@ -0,0 +1,20 @@
+module MastercardCoreSdk
+  module OAuth
+    class OAuthParameters
+   
+      attr_accessor :params
+      def initialize
+        self.params = Hash.new
+      end
+
+      # Adds a parameter to the hash and as an instance variable to the class
+      def add_parameter(key, value)
+        self.params[key.to_sym] = value
+        self.class.send(:define_method, key) do
+          value
+        end
+      end
+   
+    end
+  end
+end 

data/lib/mastercard_core_sdk/oauth/oauth_util.rb

@@ -0,0 +1,205 @@
+require 'base64'
+require 'cgi'
+require 'net/http'
+require 'net/https'
+require 'openssl'
+require 'digest/sha1'
+require 'securerandom'
+require 'uri'
+require 'logging'
+require_relative '../core/mastercard_api_configuration'
+require_relative '../core/api_config'
+
+module MastercardCoreSdk
+  module OAuth
+      # Utility class for OAuth  
+      class OAuthUtil
+        @@logger = Logging.logger[self] 
+        
+        class << self
+          include MastercardCoreSdk::Core
+           
+          # Method to build request header.  
+          # @param api_request 
+          # @return [Typhoeus::Request]
+          def build_request_header(api_request)
+            
+            @signature_base_string = @auth_header = @signed_signature_base_string = @header = ''
+            
+            headers = api_request.options[:headers]
+            url = api_request.base_url
+           
+            body = api_request.options[:body] || ""
+            
+            @api_config = MasterCardApiConfiguration.api_config(headers[ApiConfig::CONFIG_NAME_HEADER])
+            MasterCardApiConfiguration.validate_config(@api_config)
+            
+            oauth_params = set_oauth_parameters
+            oauth_params = generate_body_hash(headers, body, oauth_params)
+            request = set_headers(url, api_request, oauth_params)
+           
+            @@logger.info LOG_MSG_OAUTH_HEADER
+            return request
+          end
+        
+          private
+          
+          # Method to generate base OAuth params
+          def set_oauth_parameters
+            oparams = OAuthParameters.new
+            oparams.add_parameter(OAUTH_CONSUMER_KEY, @api_config.consumer_key)
+            oparams.add_parameter(OAUTH_NONCE, generate_nonce)
+            oparams.add_parameter(OAUTH_TIMESTAMP, generate_timestamp)
+            oparams.add_parameter(OAUTH_SIGNATURE_METHOD, OAUTH_KEY_SIGNATURE_METHOD_VAL)
+            oparams.add_parameter(OAUTH_VERSION, OAUTH_VERSION_VAL)
+            oparams
+          end
+
+          # This method subsequently builds and signs the Oauth Header
+          def set_headers(url, request, oauth_params)
+            request_method = request.options[:method].to_s
+            auth_header = build_auth_header_string(url, request_method, oauth_params)
+ 
+            request.options[:headers].merge!({ AUTH_HEADER => auth_header })
+            request = remove_request_header_params(request)
+  
+            return request
+          end
+  
+          # Method to build the auth header for the HTTP request.
+          # oauth_params - full populated oauth parameters
+          def build_auth_header_string(url, request_method, oauth_params)
+            temp_params = OAuthParameters.new
+            oauth_params_key_arr = oauth_params.params.keys.sort
+            
+            oauth_params_key_arr.each do |p|
+              temp_params.add_parameter(p, oauth_params.send(p)) if p != :realm
+            end
+            generate_signature_base_string(url, request_method, temp_params) 
+            sign(oauth_params)
+            header = ''
+            oauth_params.add_parameter(REALM, REALM_TYPE)
+            oauth_params_key_arr = oauth_params.params.keys.sort
+            oauth_params_key_arr.each do |p|
+              header << p.to_s << '="' << oauth_params.send(p) << '",' if oauth_params.send(p)
+            end
+            header = '' << OAUTH_START_STRING << header
+            #remove trailing comma
+            @header = header = header[0...header.length-1]
+            return @header
+          end
+  
+          # Method to sign the signature base string using the private key.
+          def sign(oauth_params)
+            if @signature_base_string == nil || @signature_base_string.length == 0
+              raise OAuthError("Signature Base String May Not Be Null.")
+            end
+            digest = OpenSSL::Digest::SHA1.new
+            key = @api_config.private_key
+            
+            @signed_signature_base_string = CGI.escape(Base64.encode64(key.sign(digest,@signature_base_string)))
+           
+            @signed_signature_base_string.gsub!('+','%20')
+            @signed_signature_base_string.gsub!('*','%2A')
+            @signed_signature_base_string.gsub!('~','%7E')
+            oauth_params.add_parameter(OAUTH_SIGNATURE, @signed_signature_base_string)
+          end
+          
+          # Method to generate the signature base string from the url, HTTP request method, and oauth_params
+          # url - URL, including query string parameters, to access
+          # request_method - case-insensitive HTTP request method, e.g. GET, POST, PUT, DELETE
+          # oauth_params - populated oauth parameters object
+          def generate_signature_base_string(url, request_method, oauth_params)
+            @signature_base_string = CGI.escape(request_method.upcase) << AMP << CGI.escape(normalize_url(url)) << AMP << CGI.escape(normalize_parameters(url, oauth_params))
+            
+          end
+        
+          # Method to return "core" URL for signature base string generation.  http://somesite.com:8080?blah becomes http://somesite.com, for example
+          # url - URL to normalize
+          def normalize_url(url)
+            tmp = url.clone
+            # strip query string section
+            idx = tmp.index('?')
+            if idx != nil
+              tmp = tmp[0..idx-1]
+            end
+            # strip port
+            if tmp.rindex(':') != nil && tmp.rindex(':') > 5 # implies port is given
+              tmp = tmp[0..tmp.rindex(':')-1]
+            end
+            tmp
+          end
+       
+          # The signature base string must be in lexical order prior to signing. This method does that required work.
+          # url - url to access
+          # oauth_params - OAuthParameters object used for building Signature Base String
+          def normalize_parameters(url, oauth_params)
+            oauth_params_hash = oauth_params.params
+            CGI.parse(URI.parse(url).query).map{|k,v| 
+              oauth_params_hash[k.to_sym] = v[0]
+            } if url.include? "?"
+            oauth_params_hash.keys.sort.map{|k| 
+              "#{URI.encode(k.to_s)}=#{oauth_params_hash[k]}"
+            }.join("&")
+          end
+          
+          # Method to generate body hash if body is present
+          def generate_body_hash(headers = {}, body, oauth_params)
+            if !body.empty?
+              oauth_body_hash = Digest::SHA1.base64digest(body)
+              oauth_params.add_parameter(OAUTH_BODY_HASH, oauth_body_hash)
+            end
+             
+            if headers && headers.size > 0
+              oauth_params = update_headers_before_signature(headers, oauth_params)
+            end
+            oauth_params
+          end
+        
+          # Method to generate unique identifier for given timestamp (in seconds)
+          def generate_nonce
+            str = ''
+            for i in 1..NONCE_LENGTH
+              str << VALID_CHARS[SecureRandom.random_number(VALID_CHARS.length)]
+            end
+            @oauth_nonce = str
+          end
+        
+          def generate_timestamp
+            @oauth_timestamp = Time.now.to_i.to_s
+          end
+
+          # Method to add additional parameters to header if present in request before building signature
+          def update_headers_before_signature(headers,oauth_params)
+            @request_header_params = {}
+            headers.each do |param_key,param_value|
+              param_key.is_a?(Symbol) ? param_key = param_key.to_s : param_key = param_key
+              if param_key.eql?(OAUTH_CALLBACK)
+                oauth_params.add_parameter OAUTH_CALLBACK, param_value
+                @request_header_params.merge!({ param_key => param_value})
+                
+              elsif param_key.eql?(OAUTH_KEY_TOKEN) || param_key.eql?(OAUTH_KEY_LONG_ACCESS_TOKEN) || param_key.eql?(OAUTH_KEY_ACCESS_TOKEN)
+                oauth_params.add_parameter OAUTH_KEY_TOKEN, param_value
+                @request_header_params.merge!({ param_key => param_value})
+                
+              elsif param_key.eql?(OAUTH_VERIFIER)
+                oauth_params.add_parameter OAUTH_VERIFIER, param_value
+                @request_header_params.merge!({ param_key => param_value})
+              end
+            end
+            return oauth_params
+          end  
+        
+          # Remove additional header parameters from request after generating OAuth signature
+          def remove_request_header_params(request)
+            @request_header_params.each do |param_key,param_value|
+              request.options[:headers].delete(param_key)
+            end
+            request.options[:headers].delete(ApiConfig::CONFIG_NAME_HEADER)
+            return request
+          end
+          
+       end
+    end
+  end
+end

data/lib/mastercard_core_sdk/tracker/api_tracker.rb

@@ -0,0 +1,20 @@
+require_relative '../exceptions/sdk_validation_error'
+
+module MastercardCoreSdk
+  module Tracker
+    # Defines methods to be overridden by extending class for tracking API calls.
+    module ApiTracker
+      include MastercardCoreSdk::Exceptions
+      
+      # Method to be overridden by the class for API-Call-Tracker header
+      def tracking_info
+        raise SDKValidationError.new(LOG_MSG_TRACKING_INFO_ERROR)
+      end
+
+      # Method to be overridden by the class for user-agent info header
+      def user_agent_info
+        raise SDKValidationError.new(LOG_MSG_USER_AGENT_ERROR)
+      end
+    end
+  end
+end

data/lib/mastercard_core_sdk/tracker/token_api_tracker.rb

@@ -0,0 +1,52 @@
+require_relative '../core/mastercard_api_configuration'
+require_relative '../tracker/api_tracker'
+
+module MastercardCoreSdk
+  module Tracker
+    # Provides tracking api information and user-agent information for Token services.
+    class TokenApiTracker
+      include MastercardCoreSdk::Core, MastercardCoreSdk::Tracker::ApiTracker
+
+      # Defines the programming language.
+      #
+      # @return [String]
+      attr_accessor :language
+
+      # Defines the programming language version.
+      #
+      # @return [String]
+      attr_accessor :language_version
+
+      # Defines the plugin version if any defined in {MasterCardApiConfiguration} as additional_properties.
+      #
+      # @return [String]
+      attr_reader :plugin_version
+      
+      def initialize
+        @language = "Ruby"
+        @language_version = RUBY_VERSION
+
+        additional_track_info = MasterCardApiConfiguration.additional_properties
+        if (additional_track_info && additional_track_info.size > 0 && additional_track_info.key?(PLUGIN_VERSION))
+          @plugin_version = additional_track_info[PLUGIN_VERSION]
+        end
+      end
+
+      # Overriding {ApiTracker#tracking_info} method.
+      #
+      # @return [String]
+      def tracking_info
+        api_tracker_string =  LANG_NAME + language + SEPERATOR + LANG_VERSION + language_version
+        api_tracker_string += SEPERATOR + PLUGIN_VERSION + EQUAL + plugin_version unless plugin_version.nil?
+        return api_tracker_string
+      end
+
+      # Overriding {ApiTracker#user_agent_info} method.
+      #
+      # @return [String]
+      def user_agent_info
+        return USER_AGENT
+      end
+    end
+  end
+end

data/lib/mastercard_core_sdk/version.rb

@@ -0,0 +1,3 @@
+module MastercardCoreSdk
+   VERSION = "1.1.3"
+end

data/lib/mastercard_core_sdk.rb

@@ -0,0 +1,65 @@
+require_relative 'mastercard_core_sdk/version'
+
+#core
+require_relative 'mastercard_core_sdk/core/mastercard_authenticator'
+require_relative 'mastercard_core_sdk/core/mastercard_api_configuration'
+require_relative 'mastercard_core_sdk/core/request_response_logger'
+require_relative 'mastercard_core_sdk/core/query_params'
+require_relative 'mastercard_core_sdk/core/service_request'
+require_relative 'mastercard_core_sdk/core/configuration'
+
+#tracker
+require_relative 'mastercard_core_sdk/tracker/api_tracker'
+require_relative 'mastercard_core_sdk/tracker/token_api_tracker'
+
+#api
+require_relative 'mastercard_core_sdk/api/request_token_api'
+require_relative 'mastercard_core_sdk/api/access_token_api'
+
+#client
+require_relative 'mastercard_core_sdk/client/api_client'
+
+#constants
+require_relative 'mastercard_core_sdk/constants/constants'
+
+#errors
+require_relative 'mastercard_core_sdk/exceptions/error_handler'
+require_relative 'mastercard_core_sdk/exceptions/sdk_base_error'
+require_relative 'mastercard_core_sdk/exceptions/sdk_oauth_error'
+require_relative 'mastercard_core_sdk/exceptions/sdk_response_error'
+require_relative 'mastercard_core_sdk/exceptions/sdk_validation_error'
+require_relative 'mastercard_core_sdk/exceptions/sdk_conversion_error'
+
+#interceptors
+require_relative 'mastercard_core_sdk/interceptors/signature_builder'
+require_relative 'mastercard_core_sdk/interceptors/api_tracker_builder'
+require_relative 'mastercard_core_sdk/interceptors/logger_builder'
+
+#models
+require_relative 'mastercard_core_sdk/models/access_token_response'
+require_relative 'mastercard_core_sdk/models/detail'
+require_relative 'mastercard_core_sdk/models/details'
+require_relative 'mastercard_core_sdk/models/error'
+require_relative 'mastercard_core_sdk/models/errors'
+require_relative 'mastercard_core_sdk/models/extension_point'
+require_relative 'mastercard_core_sdk/models/request_token_response'
+require_relative 'mastercard_core_sdk/models/error_response'
+
+# OAuth
+require_relative 'mastercard_core_sdk/oauth/oauth_util'
+require_relative 'mastercard_core_sdk/oauth/oauth_parameters'
+
+#converters
+require_relative 'mastercard_core_sdk/converters/sdk_converter_factory'
+require_relative 'mastercard_core_sdk/converters/xml_converter'
+require_relative 'mastercard_core_sdk/converters/json_converter'
+require_relative 'mastercard_core_sdk/converters/encoded_url_converter'
+
+# MultiConfig Environments
+require_relative 'mastercard_core_sdk/core/api_config'
+require_relative 'mastercard_core_sdk/core/api_config_builder'
+
+
+module MastercardCoreSdk
+   # Base Sdk
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: mastercard_core_sdk
+version: !ruby/object:Gem::Version
+  version: 1.1.3
+platform: ruby
+authors:
+- MasterCard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: roxml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: MasterCard Core API SDK. See https://developer.mastercard.com
+email: openapi@mastercard.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- lib/mastercard_core_sdk.rb
+- lib/mastercard_core_sdk/api/access_token_api.rb
+- lib/mastercard_core_sdk/api/request_token_api.rb
+- lib/mastercard_core_sdk/client/api_client.rb
+- lib/mastercard_core_sdk/constants/constants.rb
+- lib/mastercard_core_sdk/converters/encoded_url_converter.rb
+- lib/mastercard_core_sdk/converters/json_converter.rb
+- lib/mastercard_core_sdk/converters/sdk_converter_factory.rb
+- lib/mastercard_core_sdk/converters/xml_converter.rb
+- lib/mastercard_core_sdk/core/api_config.rb
+- lib/mastercard_core_sdk/core/api_config_builder.rb
+- lib/mastercard_core_sdk/core/configuration.rb
+- lib/mastercard_core_sdk/core/mastercard_api_configuration.rb
+- lib/mastercard_core_sdk/core/mastercard_authenticator.rb
+- lib/mastercard_core_sdk/core/query_params.rb
+- lib/mastercard_core_sdk/core/request_response_logger.rb
+- lib/mastercard_core_sdk/core/service_request.rb
+- lib/mastercard_core_sdk/exceptions/error_handler.rb
+- lib/mastercard_core_sdk/exceptions/sdk_base_error.rb
+- lib/mastercard_core_sdk/exceptions/sdk_conversion_error.rb
+- lib/mastercard_core_sdk/exceptions/sdk_oauth_error.rb
+- lib/mastercard_core_sdk/exceptions/sdk_response_error.rb
+- lib/mastercard_core_sdk/exceptions/sdk_validation_error.rb
+- lib/mastercard_core_sdk/interceptors/api_tracker_builder.rb
+- lib/mastercard_core_sdk/interceptors/logger_builder.rb
+- lib/mastercard_core_sdk/interceptors/signature_builder.rb
+- lib/mastercard_core_sdk/models/access_token_response.rb
+- lib/mastercard_core_sdk/models/detail.rb
+- lib/mastercard_core_sdk/models/details.rb
+- lib/mastercard_core_sdk/models/error.rb
+- lib/mastercard_core_sdk/models/error_response.rb
+- lib/mastercard_core_sdk/models/errors.rb
+- lib/mastercard_core_sdk/models/extension_point.rb
+- lib/mastercard_core_sdk/models/request_token_response.rb
+- lib/mastercard_core_sdk/oauth/oauth_parameters.rb
+- lib/mastercard_core_sdk/oauth/oauth_util.rb
+- lib/mastercard_core_sdk/tracker/api_tracker.rb
+- lib/mastercard_core_sdk/tracker/token_api_tracker.rb
+- lib/mastercard_core_sdk/version.rb
+homepage: https://developer.mastercard.com
+licenses:
+- MasterCard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: MasterCard Core API SDK
+test_files: []