mastercard_api_core 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11df59f25e79aa759a551ecfc4aa6e1425b9cd88
+  data.tar.gz: 3eef3a4fc2104ddbce60f346e75f905571d7c9a7
+SHA512:
+  metadata.gz: 1d11fde3322e775985c14aa7bb7c98a9e5124b8d9471e41cd032f60c8da2105999c3b7519a09317d16150d9a7bd07ad74358222585b1fa0e0f4fb4cd7302a2c9
+  data.tar.gz: c198b9395316e85b110661ff1fb82e091fefb8414189dae3911e1ecbcc4973fd5aa51c2d852a4dc78ad2d05bbe488e433e4f51b59a7b411619d9a9f62e013666

data/lib/mastercard/core/config.rb

@@ -0,0 +1,84 @@
+#
+# Copyright (c) 2016 MasterCard International Incorporated
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, are
+# permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list of
+# conditions and the following disclaimer.
+# Redistributions in binary form must reproduce the above copyright notice, this list of
+# conditions and the following disclaimer in the documentation and/or other materials
+# provided with the distribution.
+# Neither the name of the MasterCard International Incorporated nor the names of its
+# contributors may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+require "mastercard/core/constants"
+
+module MasterCard
+  module Core
+    class Config
+
+      private
+      @@sandbox = true
+      @@debug   = false
+      @@authentication = nil
+      @@localhost  = false
+
+      public
+      def self.setDebug(debug)
+        @@debug = debug
+      end
+
+      def self.isDebug()
+        return @@debug
+      end
+
+      def self.setSandbox(sandbox)
+        @@sandbox = sandbox
+      end
+
+      def self.isSandbox()
+        return @@sandbox
+      end
+
+      def self.setLocal(local)
+        @@localhost = local
+      end
+
+      def self.isLocal
+        return @@localhost
+      end
+
+      def self.setAuthentication(auth)
+        @@authentication = auth
+      end
+
+      def self.getAuthentication
+        return @@authentication
+      end
+
+      def self.getAPIBaseURL
+
+        if @@localhost
+          return Constants::API_BASE_LOCALHOST_URL
+        elsif @@sandbox
+          return Constants::API_BASE_SANDBOX_URL
+        end
+
+        return Constants::API_BASE_LIVE_URL
+      end
+    end
+  end
+end

data/lib/mastercard/core/constants.rb

@@ -0,0 +1,36 @@
+#
+# Copyright (c) 2016 MasterCard International Incorporated
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, are
+# permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list of
+# conditions and the following disclaimer.
+# Redistributions in binary form must reproduce the above copyright notice, this list of
+# conditions and the following disclaimer in the documentation and/or other materials
+# provided with the distribution.
+# Neither the name of the MasterCard International Incorporated nor the names of its
+# contributors may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+module MasterCard
+  module Core
+    module Constants
+      VERSION                 = "1.0.0"
+      API_BASE_LOCALHOST_URL  = "http://localhost:8080"
+      API_BASE_LIVE_URL       = "https://api.mastercard.com"
+      API_BASE_SANDBOX_URL    = "https://sandbox.api.mastercard.com"
+    end
+  end
+end

data/lib/mastercard/core/controller.rb

@@ -0,0 +1,325 @@
+#
+# Copyright (c) 2016 MasterCard International Incorporated
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, are
+# permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list of
+# conditions and the following disclaimer.
+# Redistributions in binary form must reproduce the above copyright notice, this list of
+# conditions and the following disclaimer in the documentation and/or other materials
+# provided with the distribution.
+# Neither the name of the MasterCard International Incorporated nor the names of its
+# contributors may be used to endorse or promote products derived from this software
+# without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+# SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+# IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+# IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+require 'mastercard/core/config'
+require 'mastercard/core/exceptions'
+require 'mastercard/core/util'
+require 'mastercard/security/authentication'
+require 'net/http'
+require 'json'
+
+module MasterCard
+  module Core
+    module Controller
+      class APIController
+        include MasterCard::Core
+        include MasterCard::Core::Exceptions
+        include MasterCard::Security
+
+        ACTION_CREATE = "CREATE"
+        ACTION_DELETE = "DELETE"
+        ACTION_UPDATE = "UPDATE"
+        ACTION_READ   = "READ"
+        ACTION_LIST   = "LIST"
+        ACTION_QUERY  = "QUERY"
+
+        KEY_ID     = "id"
+        KEY_FORMAT = "Format"
+        KEY_ACCEPT = "Accept"
+        KEY_USER_AGENT = "User-Agent"
+        KEY_CONTENT_TYPE = "Content-Type"
+        APPLICATION_JSON = "application/json"
+        RUBY_SDK       = "Ruby_SDK"
+        JSON_STR       = "JSON"
+
+
+        def initialize(version=nil)
+          #Set the parameters
+          @baseURL = Config.getAPIBaseURL()
+
+          @baseURL = removeForwardSlashFromTail(@baseURL)
+
+          #Verify if the URL is correct
+          unless Util.validateURL(@baseURL)
+            raise APIException.new "URL: '" + @baseURL + "' is not a valid url"
+          end
+
+          #Set the version
+          unless version.nil?
+            @version = version
+          else
+            @version = Constants::VERSION
+          end
+
+        end
+
+        def execute(action,resourcePath,headerKey,queryKey,input)
+
+          #Check preconditions for execute
+          preCheck()
+
+          #Separate the headers from the inputMap
+          headers = Util.subMap(input,headerKey)
+
+          #Separate the query from the inputMap
+          queryParams = Util.subMap(input,queryKey)
+
+          #Get the resourcePath containing values from input
+          resourcePath = getFullResourcePath(action,resourcePath,input)
+
+          #Get the path parameters
+          pathParams = getPathParams(action,queryParams,input)
+          #Get the body
+          body = getBody(action,input)
+
+          #Get the request Object
+          request = getRequestObject(resourcePath,action,pathParams,body)
+
+          #Add headers to request
+          headers.each do |key,value|
+            request.add_field(key,value)
+          end
+
+          fullUrl = @baseURL+resourcePath
+          #Sign and get back the request
+          request = Config.getAuthentication().signRequest(fullUrl,request,request.method,body,pathParams)
+
+          uri = URI.parse(@baseURL)
+          #Get the http object
+          http = getHTTPObject(uri)
+
+          if Config.isDebug
+            puts "---- Request ----"
+            puts ""
+            puts "URL"
+            puts @baseURL+request.path
+            puts ""
+            puts "Headers"
+            request.each_header do |header_name, header_value|
+              puts "#{header_name} : #{header_value}"
+            end
+            puts ""
+            puts "Body"
+            puts request.body
+          end
+
+          begin
+            response = http.request(request)
+
+            if Config.isDebug
+              puts "---- Response ----"
+              puts ""
+              puts "Status Code"
+              puts response.code
+              puts ""
+              puts "Headers"
+              response.each_header do |header_name, header_value|
+                puts "#{header_name} : #{header_value}"
+              end
+              puts ""
+              puts "Body"
+              puts response.body
+            end
+
+
+            return handleResponse(response,response.body)
+          rescue Errno::ECONNREFUSED
+            raise APIException.new ("Connection to server could not be established.")
+          end
+
+
+        end
+
+
+        private
+
+
+        def handleResponse(response,content)
+          #Handles the exception and response
+          status = response.code.to_i
+
+          if content
+            begin
+              content = JSON.load content
+            rescue JSON::ParserError
+            end
+          end
+
+          if 200 <= status && status <= 299
+            return content
+          elsif 300 <= status && status <= 399
+            raise InvalidRequestException.new("Unexpected response code returned from the API causing redirect",status,content)
+          elsif status == 400
+            raise InvalidRequestException.new("Bad request",status,content)
+          elsif status == 401
+            raise APIException.new("You are not authorized to make this request",status,content)
+          elsif status == 403
+            raise APIException.new("You are not authorized to make this request",status,content)
+          elsif status == 404
+            raise ObjectNotFoundException.new("Object not found",status,content)
+          elsif status == 405
+            raise APIException.new("Operation not allowed",status,content)
+          else
+            raise SystemException.new("Internal Server Error",status,content)
+          end
+
+        end
+
+        def getBody(action,input)
+          #Returns the body hash depending on action
+          body = nil
+          case action.upcase
+          when ACTION_CREATE, ACTION_UPDATE
+            unless input.nil?
+              body = input
+            end
+          end
+          return body
+        end
+
+        def getPathParams(action,queryParams,input)
+          #Returns the path params based on action
+          pathParams = {KEY_FORMAT => JSON_STR}
+          case action.upcase
+          when ACTION_LIST, ACTION_READ, ACTION_QUERY, ACTION_DELETE
+            unless input.nil?
+              pathParams = pathParams.merge(input)
+            end
+          end
+
+          #merge the queryParams
+          pathParams = pathParams.merge(queryParams)
+
+          return pathParams
+        end
+
+        def getHTTPObject(uri)
+          #Returns the HTTP Object
+          http = Net::HTTP.new(uri.host,uri.port)
+
+          unless Config.isLocal()
+            http.use_ssl = true
+          end
+
+          return http
+
+        end
+
+        def encode_path_params(path, params)
+          #Encode and join the params
+          encoded = URI.encode_www_form(params)
+          [path, encoded].join("?")
+        end
+
+        def getRequestObject(path,action,pathParams,body)
+          #Retuns the request object based on action
+          case action.upcase
+          when ACTION_LIST, ACTION_READ, ACTION_QUERY
+            verb = Net::HTTP::Get
+
+          when ACTION_CREATE
+            verb = Net::HTTP::Post
+
+          when ACTION_DELETE
+            verb = Net::HTTP::Delete
+
+          when ACTION_UPDATE
+            verb = Net::HTTP::Put
+          else
+            raise APIException.new "Invalid action #{action}"
+          end
+
+          #add url parameters  to path
+          path = encode_path_params(path,pathParams)
+
+          req = verb.new(path)
+
+          #Add default headers
+          req.add_field(KEY_ACCEPT,APPLICATION_JSON)
+          req.add_field(KEY_CONTENT_TYPE,APPLICATION_JSON)
+          req.add_field(KEY_USER_AGENT,RUBY_SDK+"/"+@version)
+
+          #Add body
+
+          unless body.nil?
+            req.body = body.to_json
+          end
+
+          return req
+
+
+        end
+
+        def preCheck()
+          #check if execute can be done
+          auth = Config.getAuthentication()
+
+          unless (auth.nil? || auth.is_a?(Authentication))
+            raise APIException.new "No or incorrect authentication has been configured"
+          end
+
+        end
+
+        def removeForwardSlashFromTail(text)
+          #
+          #Removes the trailing / from url if any and returns the url
+
+          if text.end_with? "/"
+            return text[0...-1]
+          end
+
+          return text
+
+        end
+
+        def getFullResourcePath(action,resourcePath,inputMap)
+          #
+          #Forms the complete URL by combining baseURL and replaced path variables in resourcePath from inputMap
+
+
+          #Remove the Trailing slash from the resource path
+          resourcePath = removeForwardSlashFromTail(resourcePath)
+
+          #Replace the path variables
+          resourcePath = Util.getReplacedPath(resourcePath,inputMap)
+
+          #This step is if id is in inputMap but was not specified in URL as /{id}
+          #If the action is read,update or delete we add this id
+          if inputMap.has_key?(KEY_ID)
+            if [ACTION_READ,ACTION_UPDATE,ACTION_DELETE].include? action.upcase
+              resourcePath += "/"+inputMap[KEY_ID].to_s
+              inputMap.delete(KEY_ID) #Remove from input path otherwise this would get add in query params as well
+            end
+          end
+
+          return resourcePath
+
+        end
+
+      end
+    end
+  end
+end