hypercharge-schema 1.24.5

data/json/void.json

@@ -0,0 +1,33 @@
+{
+  "description" : "Hypercharge void Transaction request",
+  "type":"object",
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "additionalProperties":false,
+  "properties": {
+    "payment_transaction": {
+      "type":"object",
+      "required":true,
+      "additionalProperties":false,
+      "properties": {
+        "transaction_type": {
+          "description": "Type of the Transaction => static 'void'",
+          "required":true,
+          "type" : "string",
+          "pattern" : "^void$"
+        },
+        "transaction_id": {
+          "required":true,
+          "extends" : "types.json#/transaction_id"
+        },
+        "usage": {
+          "required":false,
+          "extends" : "types.json#/usage"
+        },
+        "reference_id": {
+          "required":true,
+          "extends": "types.json#/reference_id"
+        }
+      }
+    }
+  }
+}

data/lib/php/JsonSchemaFixture.php

@@ -0,0 +1,12 @@
+<?php
+namespace Hypercharge;
+
+class JsonSchemaFixture {
+	static function request($file) {
+		return file_get_contents(dirname(dirname(__DIR__)).'/test/fixtures/requests/'. $file);
+	}
+	static function response($file) {
+		return file_get_contents(dirname(dirname(__DIR__)).'/test/fixtures/responses/'. $file);
+	}
+	// TODO notification
+}

data/lib/php/JsonSchemaValidator.php

@@ -0,0 +1,47 @@
+<?php
+namespace Hypercharge;
+
+const SCHEMA_VERSION = '1.24.5';
+
+class JsonSchemaValidator {
+	private $schemaUri;
+	private $schema;
+
+	/**
+	* @param string $schemaName  e.g. "MobilePayment" for /json/MobilePayment.json  or "sale" for /json/sale.json
+	*/
+	function __construct($schemaName) {
+		$this->schemaUri = 'file://'. self::schemaPathFor($schemaName);
+
+		//var_dump('schemaUri', $this->schemaUri);
+
+		$retriever = new \JsonSchema\Uri\UriRetriever;
+		$this->schema = $retriever->retrieve($this->schemaUri);
+
+		// If you use '$ref' or 'extends' or if you are unsure, resolve those references here
+		// This modifies the $schema object
+		$refResolver = new \JsonSchema\RefResolver($retriever);
+		$refResolver->resolve($this->schema, $this->schemaUri);
+	}
+
+	/**
+	* @param Object $object the instance to validate against the json schema
+	* @return mixed array containing errors or false
+	*/
+	function check($object) {
+		$validator = new \JsonSchema\Validator();
+		$validator->check($object, $this->schema);
+		$errors = $validator->getErrors();
+		if(empty($errors)) return false;
+		return $errors;
+	}
+
+	/**
+	* doesn't check if schema file exists
+	* @param string $type e.g. 'sale', 'authorize', 'capture', 'void', ...
+	* @return string absolute path to schema file
+	*/
+	static function schemaPathFor($type) {
+		return dirname(dirname(__DIR__)).'/json/'. $type .'.json';
+	}
+}

data/lib/ruby/hypercharge/schema.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+
+require "json-schema"
+require "hypercharge/schema/version"
+require "hypercharge/schema/fixture"
+
+
+module Hypercharge
+	module Schema
+
+		# validates a hash with JSON-Schema
+		def self.validate(type, data)
+			JSON::Validator.fully_validate(schema_path_for(type), data, :version => :draft3)
+		end
+
+		# returns the path for a JSON-Schema
+		# @param [Hypercharge::Payment::Type, Hypercharge::PaymentTransaction::Type] type  the type
+		# @return [String] path
+		def self.schema_path_for(type)
+			File.expand_path("../../../../json/#{type}.json", __FILE__)
+		end
+
+		# yields with json schema files full path.
+		# If you need the schema as hash, please feel free to IO.read() and JSON.parse().
+		def self.each
+			Dir[File.expand_path("../../../../json/*.json", __FILE__)].each do |path|
+				yield path
+			end
+		end
+	end
+end

data/lib/ruby/hypercharge/schema/fixture.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+
+require 'json'
+
+module Hypercharge
+	module Schema::Fixture
+
+		# @param file String without ".xml" suffix e.g. "requests/sale" or "responses/WpfPayment_find"
+		# @return String contents (xml string) of fixture file e.g. /foo/hypercharge-schema/test/fixtures/requests/sale.xml
+		#                                         or   /foo/hypercharge-schema/test/fixtures/responses/WpfPayment_find.xml
+		def self.xml(file)
+			IO.read(path("#{file}.xml"))
+		end
+
+		# @param file String without ".json" suffix e.g. "requests/sale" or "responses/WpfPayment_find"
+		# @return Hash parsed json fixture in e.g. /foo/hypercharge-schema/test/fixtures/requests/sale.json
+		#                                      or  /foo/hypercharge-schema/test/fixtures/responses/WpfPayment_find.json
+		def self.json(file)
+			JSON.parse(IO.read(path("#{file}.json")))
+		end
+
+		# @param file String with (!) suffix e.g. "requests/sale.xml" or "responses/WpfPayment_find.json"
+		# @return String absolute path e.g. "/foo/hypercharge-schema/test/fixtures/requests/sale.xml"
+		#                               or  "/foo/hypercharge-schema/test/fixtures/responses/WpfPayment_find.json"
+		def self.path(file)
+			File.expand_path("../../../../../test/fixtures/#{file}", __FILE__)
+		end
+
+	end
+end

data/lib/ruby/hypercharge/schema/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Hypercharge
+  module Schema
+    VERSION = "1.24.5"
+  end
+end

data/package.json

@@ -0,0 +1,27 @@
+{
+  "author": "Jan Mentzel <jan@hypercharge.net>",
+  "name": "hypercharge-schema",
+  "dependencies": {
+  },
+  "main": "./lib",
+  "devDependencies": {
+    "mocha": "~1.8.2",
+    "chai": "~1.5.0",
+    "jsonschema": "git://github.com/hypercharge/jsonschema.git#master"
+  },
+  "optionalDependencies": {},
+  "engines": {
+    "node": "*"
+  },
+  "keywords": [
+    "payment"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/hypercharge/json-schema.git"
+  },
+  "description": "JSON Schemas for validation of hypercharge payment gateway and WPF requests",
+  "scripts": {
+    "test": "./node_modules/.bin/mocha -R spec"
+  }
+}

data/test/fixtures/notifications/PaymentNotification_echo.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<notification_echo>
+  <payment_unique_id>26aa150ee68b1b2d6758a0e6c44fce4c</payment_unique_id>
+</notification_echo>

data/test/fixtures/notifications/TransactionNotification_echo.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<notification_echo>
+  <unique_id>fc6c3c8c0219730c7a099eaa540f70dc</unique_id>
+</notification_echo>

data/test/fixtures/notifications/recurring_event.json

@@ -0,0 +1,13 @@
+{
+   "schedule_unique_id":"26aa150ee68b1b2d6758a0e6c44fce4c",
+   "schedule_event_due_date":"2013-01-21 00:00:00",
+   "schedule_event_finalized_date":"2013-01-22 00:00:00",
+   "schedule_event_status":"approved",
+   "event_unique_id":"bad08183a9ec545daf0f24c48361aa10",
+   "notification_type":"recurring",
+   "signature":"c5219b3d385e74496b2b48a5497b347e102849f10eacd25b062f823bbd11249ce4e233f031c0ecebc9b691e69d23eb0c1cd65a79621152467b56ac2bf103b512",
+   "payment_transaction_channel_token":"e9fd7a957845450fb7ab9dccb498b6e1f6e1e3aa",
+   "payment_transaction_unique_id":"bad08183a9ec545daf0f24c48361aa10",
+   "payment_transaction_transaction_type":"recurring_sale",
+   "payment_transaction_status":"approved"
+}

data/test/fixtures/notifications/scheduler.json

@@ -0,0 +1,7 @@
+{
+   "schedule_unique_id":"26aa150ee68b1b2d6758a0e6c44fce4c",
+   "schedule_end_date":"2013-01-21 00:00:00",
+   "schedule_status":"expiring",
+   "notification_type":"recurring_schedule",
+   "signature":"c5219b3d385e74496b2b48a5497b347e102849f10eacd25b062f823b"
+}

data/test/fixtures/requests/MobilePayment.json

@@ -0,0 +1,35 @@
+{
+   "payment":{
+      "type":"MobilePayment",
+      "amount":5000,
+      "currency":"EUR",
+      "transaction_id":"0AF671AF-4134-4BE7-BDF0-26E38B74106E",
+      "usage":"Order 12345 pucrchase of concert tickets",
+      "customer_email":"customer@example.com",
+      "customer_phone":"004903000000000",
+      "notification_url":"https://example.com/mobile_payment_notify",
+      "billing_address":{
+         "first_name":"John",
+         "last_name":"Doe",
+         "address1":"Torstr. 123",
+         "address2":"HH 5. OG",
+         "city":"Berlin",
+         "zip_code":"10115",
+         "country":"DE"
+      },
+      "transaction_types":[
+         "sale"
+      ],
+      "retries": 3,
+      "expires_in":3600,
+      "risk_params":{
+         "ssn":"This is a string",
+         "user_id":"This is a string"
+      },
+      "recurring_schedule": {
+        "start_date":"2013-05-01",
+        "amount": 5000,
+        "interval": "monthly"
+      }
+   }
+}

data/test/fixtures/requests/MobilePayment.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<payment>
+  <amount>5000</amount>
+  <billing_address>
+    <address1>Torstr. 123</address1>
+    <address2>HH 5. OG</address2>
+    <city>Berlin</city>
+    <country>DE</country>
+    <first_name>John</first_name>
+    <last_name>Doe</last_name>
+    <zip_code>10115</zip_code>
+  </billing_address>
+  <currency>EUR</currency>
+  <customer_email>customer@example.com</customer_email>
+  <customer_phone>004903000000000</customer_phone>
+  <expires_in>3600</expires_in>
+  <notification_url>https://example.com/mobile_payment_notify</notification_url>
+  <recurring_schedule>
+    <amount>5000</amount>
+    <interval>monthly</interval>
+    <start_date>2013-05-01</start_date>
+  </recurring_schedule>
+  <retries>3</retries>
+  <risk_params>
+    <ssn>This is a string</ssn>
+    <user_id>This is a string</user_id>
+  </risk_params>
+  <transaction_id>0AF671AF-4134-4BE7-BDF0-26E38B74106E</transaction_id>
+  <transaction_types>
+    <transaction_type>sale</transaction_type>
+  </transaction_types>
+  <type>MobilePayment</type>
+  <usage>Order 12345 pucrchase of concert tickets</usage>
+</payment>

data/test/fixtures/requests/WpfPayment.json

@@ -0,0 +1,40 @@
+{
+   "payment":{
+      "type":"WpfPayment",
+      "amount":5000,
+      "currency":"EUR",
+      "transaction_id":"0AF671AF-4134-4BE7-BDF0-26E38B74106E",
+      "usage":"Order 12345 pucrchase of concert tickets",
+      "description": "You are about to buy 3 shoes at www.shoes.com!",
+      "editable_by_user":true,
+      "customer_email":"customer@example.com",
+      "customer_phone":"004903000000000",
+      "notification_url":"http://example.com/mobile_payment_notify",
+      "return_success_url":"http://example.com/payment_success",
+      "return_failure_url":"http://example.com/payment_failure",
+      "return_cancel_url":"http://example.com/payment_canceled",
+      "billing_address":{
+         "first_name":"John",
+         "last_name":"Doe",
+         "address1":"Torstr. 123",
+         "address2":"HH 5. OG",
+         "city":"Berlin",
+         "zip_code":"10115",
+         "country":"DE"
+      },
+      "transaction_types":[
+         "sale"
+      ],
+      "retries":3,
+      "expires_in":3600,
+      "risk_params":{
+         "ssn":"This is a string",
+         "user_id":"This is a string"
+      },
+      "recurring_schedule": {
+        "start_date":"2013-05-01",
+        "amount": 5000,
+        "interval": "monthly"
+      }
+   }
+}

data/test/fixtures/requests/WpfPayment.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<payment>
+  <amount>5000</amount>
+  <billing_address>
+    <address1>Torstr. 123</address1>
+    <address2>HH 5. OG</address2>
+    <city>Berlin</city>
+    <country>DE</country>
+    <first_name>John</first_name>
+    <last_name>Doe</last_name>
+    <zip_code>10115</zip_code>
+  </billing_address>
+  <currency>EUR</currency>
+  <customer_email>customer@example.com</customer_email>
+  <customer_phone>004903000000000</customer_phone>
+  <description>You are about to buy 3 shoes at www.shoes.com!</description>
+  <editable_by_user>true</editable_by_user>
+  <expires_in>3600</expires_in>
+  <notification_url>http://example.com/mobile_payment_notify</notification_url>
+  <recurring_schedule>
+    <amount>5000</amount>
+    <interval>monthly</interval>
+    <start_date>2013-05-01</start_date>
+  </recurring_schedule>
+  <retries>3</retries>
+  <return_cancel_url>http://example.com/payment_canceled</return_cancel_url>
+  <return_failure_url>http://example.com/payment_failure</return_failure_url>
+  <return_success_url>http://example.com/payment_success</return_success_url>
+  <risk_params>
+    <ssn>This is a string</ssn>
+    <user_id>This is a string</user_id>
+  </risk_params>
+  <transaction_id>0AF671AF-4134-4BE7-BDF0-26E38B74106E</transaction_id>
+  <transaction_types>
+    <transaction_type>sale</transaction_type>
+  </transaction_types>
+  <type>WpfPayment</type>
+  <usage>Order 12345 pucrchase of concert tickets</usage>
+</payment>

data/test/fixtures/requests/WpfPayment_cancel.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<cancel>
+  <unique_id>26aa150ee68b1b2d6758a0e6c44fce4c</unique_id>
+</cancel>

data/test/fixtures/requests/WpfPayment_capture.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<capture>
+  <unique_id>26aa150ee68b1b2d6758a0e6c44fce4c</unique_id>
+</capture>

data/test/fixtures/requests/WpfPayment_refund.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<refund>
+  <unique_id>26aa150ee68b1b2d6758a0e6c44fce4c</unique_id>
+</refund>

data/test/fixtures/requests/WpfPayment_void.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<void>
+  <unique_id>26aa150ee68b1b2d6758a0e6c44fce4c</unique_id>
+</void>

data/test/fixtures/requests/authorize.json

@@ -0,0 +1,29 @@
+{
+  "payment_transaction":{
+    "transaction_type": "authorize",
+    "transaction_id": "43671",
+    "usage": "40208 concert tickets",
+    "remote_ip": "245.253.2.12",
+    "amount":5000,
+    "currency": "USD",
+    "card_holder": "Emil Example",
+    "card_number": "4200000000000000",
+    "cvv": "123",
+    "expiration_month": "02",
+    "expiration_year": "2010",
+    "customer_email": "emil@example.com",
+    "customer_phone": "+49301234567",
+    "billing_address": {
+      "first_name": "Max",
+      "last_name": "Mustermann",
+      "address1": "Muster Str. 12",
+      "zip_code": "10178",
+      "city":"Berlin",
+      "country": "DE"
+    },
+    "risk_params":{
+       "ssn":"This is a string",
+       "user_id":"This is a string"
+    }
+  }
+}

data/test/fixtures/requests/authorize.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<payment_transaction>
+  <amount>5000</amount>
+  <billing_address>
+    <address1>Muster Str. 12</address1>
+    <city>Berlin</city>
+    <country>DE</country>
+    <first_name>Max</first_name>
+    <last_name>Mustermann</last_name>
+    <zip_code>10178</zip_code>
+  </billing_address>
+  <card_holder>Emil Example</card_holder>
+  <card_number>4200000000000000</card_number>
+  <currency>USD</currency>
+  <customer_email>emil@example.com</customer_email>
+  <customer_phone>+49301234567</customer_phone>
+  <cvv>123</cvv>
+  <expiration_month>02</expiration_month>
+  <expiration_year>2010</expiration_year>
+  <remote_ip>245.253.2.12</remote_ip>
+  <risk_params>
+    <ssn>This is a string</ssn>
+    <user_id>This is a string</user_id>
+  </risk_params>
+  <transaction_id>43671</transaction_id>
+  <transaction_type>authorize</transaction_type>
+  <usage>40208 concert tickets</usage>
+</payment_transaction>