connect-sdk-ruby 1.0.0

data/lib/ingenico/connect/sdk/response_header.rb

@@ -0,0 +1,25 @@
+module Ingenico::Connect::SDK
+
+  # Represents HTTP response headers
+  # Each header is immutable has a #name and #value attribute
+  class ResponseHeader
+
+    # Create a new header using the name and value given as parameters.
+    def initialize(name, value)
+      if name.nil?
+        raise ArgumentError.new('name is required')
+      end
+      @name = name
+      @value = value
+    end
+
+    # HTTP header name
+    attr_reader :name
+    # HTTP header value
+    attr_reader :value
+
+    def to_s
+      name + ':' + value
+    end
+  end
+end

data/lib/ingenico/connect/sdk/session.rb

@@ -0,0 +1,39 @@
+require 'uri'
+
+module Ingenico::Connect::SDK
+
+  # Contains networking and authentication data needed to communicate with the GlobalCollect platform
+  class Session
+
+    # Construct a new Session.
+    # The session object stores the following:
+    # api_endpoint::        The base url to the GlobalCollect platform, given as a string and converted to a {URI} object
+    # connection::          An instance of the {Ingenico::Connect::SDK::Connection} class used to communicate with
+    # authenticator::       An instance of the {Ingenico::Connect::SDK::Authenticator} class used for authenticating messages sent
+    # meta_data_provider::  An instance of the {Ingenico::Connect::SDK::MetaDataProvider} class containing information relevant for sending requests
+    def initialize(api_endpoint, connection, authenticator, meta_data_provider)
+      raise ArgumentError.new('api_endpoint is required') unless api_endpoint
+      raise ArgumentError.new('connection is required') unless connection
+      raise ArgumentError.new('authenticator is required') unless authenticator
+      raise ArgumentError.new('meta_data_provider is required') unless meta_data_provider
+
+      uri = URI(api_endpoint)
+      if uri.path.length > 0 || uri.query || uri.fragment
+        raise ArgumentError.new("Base url should not contain a path, query or fragment #{uri.to_s}")
+      end
+      @api_endpoint = uri
+      @connection = connection
+      @authenticator = authenticator
+      @meta_data_provider = meta_data_provider
+    end
+
+    # The base URI to the GlobalCollect platform as a {URI} object
+    attr_reader :api_endpoint
+    # An instance of the {Ingenico::Connect::SDK::Connection} class used to communicate with
+    attr_reader :connection
+    # An instance of the {Ingenico::Connect::SDK::Authenticator} class used for authenticating messages sent
+    attr_reader :authenticator
+    # An instance of the {Ingenico::Connect::SDK::MetaDataProvider} class containing information relevant for sending requests
+    attr_reader :meta_data_provider
+  end
+end

data/lib/ingenico/connect/sdk/validation_exception.rb

@@ -0,0 +1,14 @@
+module Ingenico::Connect::SDK
+
+  # Raised when the request sent to the GlobalCollect platform returned a HTTP response with status code 400.
+  # This indicates the request received by the GlobalCollect platform was malformed.
+  class ValidationException < ApiException
+
+    # Create a new ValidationException
+    # @see ApiException#initialize
+    def initialize(status_code, response_body, error_id, errors,
+                   message='the GlobalCollect platform returned an incorrect request error response')
+      super(status_code, response_body, error_id, errors, message)
+    end
+  end
+end

data/spec/comparable_extension.rb

@@ -0,0 +1,29 @@
+require 'ingenico/connect/sdk/request_param'
+
+module Ingenico::Connect::SDK
+
+  # extension of the RequestParam object to support comparison
+  class RequestParam
+
+    def ==(other)
+      other.instance_variables.each do |var|
+        unless instance_variable_get(var).to_s == other.instance_variable_get(var).to_s
+          return false
+        end
+      end
+      true
+    end
+  end
+
+  # extension of the RequestHeader object to support comparison
+  class RequestHeader
+
+    def ==(other)
+      other.instance_variables.each do |var|
+        unless instance_variable_get(var).to_s == other.instance_variable_get(var).to_s
+          return false
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/resources/defaultimpl/convertAmount.json

@@ -0,0 +1,3 @@
+{
+   "convertedAmount" : 4547504
+}

data/spec/fixtures/resources/defaultimpl/createPayment.failure.invalidCardNumber.json

@@ -0,0 +1,11 @@
+{
+    "errorId": "0953f236-9e54-4f23-9556-d66bc757dda8",
+    "errors": [
+        {
+            "code": "21000020",
+            "requestId": "24146",
+            "message": "VALUE **************** OF FIELD CREDITCARDNUMBER DID NOT PASS THE LUHNCHECK",
+            "httpStatusCode": 400
+        }
+    ]
+}

data/spec/fixtures/resources/defaultimpl/createPayment.failure.rejected.json

@@ -0,0 +1,48 @@
+{
+    "errorId": "833dfd83-52ae-419c-b871-9df1278da93e",
+    "errors": [
+        {
+            "code": "430330",
+            "message": "Not authorised",
+            "httpStatusCode": 402
+        }
+    ],
+    "paymentResult": {
+        "creationOutput": {
+            "additionalReference": "00000200001000059614",
+            "externalReference": "000002000010000596140000100001"
+        },
+        "payment": {
+            "id": "000002000010000596140000100001",
+            "paymentOutput": {
+                "amountOfMoney": {
+                    "amount": 2345,
+                    "currencyCode": "CAD"
+                },
+                "references": {
+                    "paymentReference": "0"
+                },
+                "paymentMethod": "card",
+                "cardPaymentMethodSpecificOutput": {
+                    "paymentProductId": 1
+                }
+            },
+            "status": "REJECTED",
+            "statusOutput": {
+                "errors": [
+                    {
+                        "code": "430330",
+                        "requestId": "24162",
+                        "message": "Not authorised",
+                        "httpStatusCode": 402
+                    }
+                ],
+                "isCancellable": false,
+                "statusCategory": "UNSUCCESSFUL",
+                "statusCode": 100,
+                "statusCodeChangeDateTime": "20160310121151",
+                "isAuthorized": false
+            }
+        }
+    }
+}

data/spec/fixtures/resources/defaultimpl/createPayment.json

@@ -0,0 +1,40 @@
+{
+    "creationOutput": {
+        "additionalReference": "00000012341000059598",
+        "externalReference": "000000123410000595980000100001"
+    },
+    "payment": {
+        "id": "000000123410000595980000100001",
+        "paymentOutput": {
+            "amountOfMoney": {
+                "amount": 2345,
+                "currencyCode": "CAD"
+            },
+            "references": {
+                "paymentReference": "0"
+            },
+            "paymentMethod": "card",
+            "cardPaymentMethodSpecificOutput": {
+                "paymentProductId": 1,
+                "authorisationCode": "OK1131",
+                "card": {
+                    "cardNumber": "************3456",
+                    "expiryDate": "1220"
+                },
+                "fraudResults": {
+                    "fraudServiceResult": "error",
+                    "avsResult": "X",
+                    "cvvResult": "M"
+                }
+            }
+        },
+        "status": "PENDING_APPROVAL",
+        "statusOutput": {
+            "isCancellable": true,
+            "statusCategory": "PENDING_MERCHANT",
+            "statusCode": 600,
+            "statusCodeChangeDateTime": "20160310094054",
+            "isAuthorized": true
+        }
+    }
+}

data/spec/fixtures/resources/defaultimpl/idempotence_duplicate_failure.json

@@ -0,0 +1,8 @@
+{
+   "errorId" : "75b0f13a-04a5-41b3-83b8-b295ddb23439-000013c6",
+   "errors" : [ {
+      "code" : "1409",
+      "message" : "DUPLICATE REQUEST IN PROGRESS",
+      "httpStatusCode" : 409
+   } ]
+}

data/spec/fixtures/resources/defaultimpl/idempotence_rejected.json

@@ -0,0 +1,46 @@
+{
+    "errorId": "2c164323-20d3-4e9e-8578-dc562cd7506c-0000003c",
+    "errors": [
+        {
+            "code": "21000020",
+            "requestId": "2001798",
+            "message": "VALUE **************** OF FIELD CREDITCARDNUMBER DID NOT PASS THE LUHNCHECK"
+        }
+    ],
+    "paymentResult": {
+        "creationOutput": {
+            "additionalReference": "00000200002014254436",
+            "externalReference": "000002000020142544360000100001"
+        },
+        "payment": {
+            "id": "000002000020142544360000100001",
+            "paymentOutput": {
+                "amountOfMoney": {
+                    "amount": 2345,
+                    "currencyCode": "CAD"
+                },
+                "references": {
+                    "paymentReference": "0"
+                },
+                "paymentMethod": "card",
+                "cardPaymentMethodSpecificOutput": {
+                    "paymentProductId": 1
+                }
+            },
+            "status": "REJECTED",
+            "statusOutput": {
+                "errors": [
+                    {
+                        "code": "21000020",
+                        "requestId": "2001798",
+                        "message": "VALUE **************** OF FIELD CREDITCARDNUMBER DID NOT PASS THE LUHNCHECK"
+                    }
+                ],
+                "isCancellable": false,
+                "statusCode": 100,
+                "statusCodeChangeDateTime": "20150330173151",
+                "isAuthorized": false
+            }
+        }
+    }
+}

data/spec/fixtures/resources/defaultimpl/idempotence_success.json

@@ -0,0 +1,39 @@
+{
+    "creationOutput": {
+        "additionalReference": "00000200002014254946",
+        "externalReference": "000002000020142549460000100001"
+    },
+    "payment": {
+        "id": "000002000020142549460000100001",
+        "paymentOutput": {
+            "amountOfMoney": {
+                "amount": 2345,
+                "currencyCode": "CAD"
+            },
+            "references": {
+                "paymentReference": "0"
+            },
+            "paymentMethod": "card",
+            "cardPaymentMethodSpecificOutput": {
+                "paymentProductId": 1,
+                "authorisationCode": "OK1131",
+                "card": {
+                    "cardNumber": "************9176",
+                    "expiryDate": "1220"
+                },
+                "fraudResults": {
+                    "fraudServiceResult": "error",
+                    "avsResult": "X",
+                    "cvvResult": "M"
+                }
+            }
+        },
+        "status": "PENDING_APPROVAL",
+        "statusOutput": {
+            "isCancellable": true,
+            "statusCode": 600,
+            "statusCodeChangeDateTime": "20150331120036",
+            "isAuthorized": true
+        }
+    }
+}

data/spec/fixtures/resources/defaultimpl/notFound.html

@@ -0,0 +1 @@
+Not Found

data/spec/fixtures/resources/defaultimpl/testConnection.json

@@ -0,0 +1,3 @@
+{
+    "result": "OK"
+}

data/spec/fixtures/resources/defaultimpl/unknownServerError.json

@@ -0,0 +1,10 @@
+{
+    "errorId": "fbff1179-7ba4-4894-9021-d8a0011d23a7",
+    "errors": [
+        {
+            "code": "9999",
+            "message": "UNKNOWN_SERVER_ERROR",
+            "httpStatusCode": 500
+        }
+    ]
+}

data/spec/fixtures/resources/logging/bodyNoObfuscation.json

@@ -0,0 +1,17 @@
+{
+	"order": {
+		"amountOfMoney": {
+			"currencyCode": "EUR",
+			"amount": 1000
+		},
+		"customer": {
+			"locale": "nl_NL",
+			"billingAddress": {
+				"countryCode": "NL"
+			}
+		}
+	},
+	"bankTransferPaymentMethodSpecificInput": {
+		"paymentProductId": 11
+	}
+}

data/spec/fixtures/resources/logging/bodyWithBinObfuscated.json

@@ -0,0 +1,3 @@
+{
+    "bin": "123456**"
+}

data/spec/fixtures/resources/logging/bodyWithBinOriginal.json

@@ -0,0 +1,3 @@
+{
+    "bin": "12345678"
+}

data/spec/fixtures/resources/logging/bodyWithCardObfuscated.json

@@ -0,0 +1,21 @@
+{
+	"order": {
+		"amountOfMoney": {
+			"currencyCode": "CAD",
+			"amount": 2345
+		},
+		"customer": {
+			"billingAddress": {
+				"countryCode": "CA"
+			}
+		}
+	},
+	"cardPaymentMethodSpecificInput": {
+		"paymentProductId": 1,
+		"card": {
+			"cvv": "***",
+			"cardNumber": "************3456",
+			"expiryDate": "**20"
+		}
+	}
+}

data/spec/fixtures/resources/logging/bodyWithCardOriginal.json

@@ -0,0 +1,21 @@
+{
+	"order": {
+		"amountOfMoney": {
+			"currencyCode": "CAD",
+			"amount": 2345
+		},
+		"customer": {
+			"billingAddress": {
+				"countryCode": "CA"
+			}
+		}
+	},
+	"cardPaymentMethodSpecificInput": {
+		"paymentProductId": 1,
+		"card": {
+			"cvv": "123",
+			"cardNumber": "1234567890123456",
+			"expiryDate": "1220"
+		}
+	}
+}

data/spec/fixtures/resources/logging/bodyWithIbanObfuscated.json

@@ -0,0 +1,19 @@
+{
+	"sepaDirectDebit": {
+		"mandate": {
+			"bankAccountIban": {
+				"iban": "**************4567"
+			},
+			"debtor": {
+				"surname": "Jones"
+			},
+			"isRecurring": false
+		},
+		"customer": {
+			"billingAddress": {
+				"countryCode": "NL"
+			}
+		}
+	},
+	"paymentProductId": 770
+}

data/spec/fixtures/resources/logging/bodyWithIbanOriginal.json

@@ -0,0 +1,19 @@
+{
+	"sepaDirectDebit": {
+		"mandate": {
+			"bankAccountIban": {
+				"iban": "NL00INGB0001234567"
+			},
+			"debtor": {
+				"surname": "Jones"
+			},
+			"isRecurring": false
+		},
+		"customer": {
+			"billingAddress": {
+				"countryCode": "NL"
+			}
+		}
+	},
+	"paymentProductId": 770
+}