Schema

.htaccess

@@ -0,0 +1 @@
+AddType application/json .json

README

@@ -1,3 +1,12 @@
-This repository does contain a few specifications about publishing 
-activity streams.
-
+This repository contains the JSON activity streams specification version 1.0
+
+It also contains json-schema documents which map to all the constructs in the spec.
+
+The syntax of the schema is defined at
+http://json-schema.org/
+
+To test you can use the following library:
+https://github.com/Constellation/ruby-jsonchema
+
+More libraries available in http://json-schema.org/
+

schema/activity.json

@@ -0,0 +1,85 @@
+{
+  "type" : "object",
+  "title" : "activity",
+  "description" : "An activity construct recounts what an actor did to an object in the past. If there is no actor it simply describes the change.",
+  "properties": {
+    "id" :{
+      "type" : "string",
+      "description" : "Uniquely identifies each activity within the service",
+      "default" :"{url}"
+    },
+    "actor" : {
+      "type": "object",
+      "required": true,
+      "description": "Describes the entity that performed the activity. An activity MUST contain one actor property whose value is a single Object.",
+      "properties" : {"$ref":"./object.json#properties"}
+    },
+    "verb" : {
+      "title" : "verb",
+      "type" : "string",
+      "default": "post",
+      "required": true,
+      "description" :"Identifies the action that the activity describes. An activity MUST contain a verb property whose value is a JSON String that is non-empty and matches either the \"isegment-nz-nc\" or the \"IRI\" production in [RFC3987]. Note that the use of a relative reference other than a simple name is not allowed."
+    },
+    "object" : {
+      "type": "object",
+      "required" : true,
+      "description" : "Describes the primary object of the activity. For instance, in the activity, \"John saved a movie to his wishlist\", the object of the activity is \"movie\". An activity SHOULD contain an object property whose value is a single Object. If the object property is not contained, the primary object of the activity MAY be implied by context.",
+      "properties" : {"$ref":"./object.json#properties"}
+    },
+    "target" : {
+      "type": "object",
+      "description" : "Describes the target of the activity. The precise meaning of the activity's target is dependent on the activities verb, but will often be the object the English preposition \"to\". For instance, in the activity, \"John saved a movie to his wishlist\", the target of the activity is \"wishlist\". The activity target MUST NOT be used to identity an indirect object that is not a target of the activity. An activity MAY contain a target property whose value is a single Object.",
+      "properties" : {"$ref":"./object.json#properties"}
+    },
+    "published" : {
+      "type" : "string",
+      "description": "The date and time at which the activity occurred. It is important to note that this is not necessarily the same as the time at which the activity was published. An activity MUST contain a postedTime property.",
+      "format" : "date-time"
+    },
+	"updated" : {
+      "type" : "string",
+      "description": "The date and time at which a previously published activity has been modified. An Activity MAY contain an updatedTime property",
+      "format" : "date-time"
+    },
+    "generator" : {
+      "type": "object",
+      "description": "Describes the application that generated the activity. An activity MAY contain a generator property whose value is a single Object.",
+      "properties" : {"$ref":"./object.json#properties"}
+    },
+    "icon" : {
+      "type": "object",
+      "properties" :{"$ref":"./media_link.json#properties"},
+      "description": "An IRI[RFC3987] identifying an image resource provides a visual representation of the activity, intended for human consumption. The image SHOULD have an aspect ratio of one (horizontal) to one (vertical) and SHOULD be suitable for presentation at a small size. An activity MAY have an icon property"
+    },
+    "provider" : {
+      "type": "object",
+      "description" : "Describes the application that published the activity. Note that this is not necessarily the same entity that generated the activity. An activity MAY contain a provider property whose value is a single Object",
+      "properties" : {"$ref":"./object.json#properties"}
+    },
+    "title" : {
+      "type" : "string",
+      "description" : "Natural-language title or headline for the activity encoded as a single JSON String containing HTML markup. An activity MAY contain a title property",
+      "format": "html"
+    },
+    "content" : {
+      "type" : "string",
+      "description" : "Natural-language description of the activity encoded as a single JSON String containing HTML markup. Visual elements such as thumbnail images MAY be included. An activity MAY contain a content property",
+      "format" : "html"
+    },
+    "url" : {
+      "type" : "string",
+      "description" : "An IRI [RFC3987] identifying a resource providing an HTML representation of the activity. An activity MAY contain a url property",
+      "format" : "url"
+    },
+    "links" : {
+      "type" : "array",
+      "description" :"Links between this object and other resources as defined in Web Linking",
+      "note": "Tell JSON schema team to not put links inside http://json-schema.org/hyper-schema#properties",
+      "properties" : {"$ref" : "http://json-schema.org/links#properties"}
+    }
+  },
+  "links": [
+       {"rel": "describedby", "href": "./verbs/{verb}.json"}
+     ]
+}

schema/collection.json

@@ -0,0 +1,33 @@
+{
+  "type" : "object",
+  "title" : "collection",
+  "description" : "A collection is a generic list of Objects of any object type. The objectType of each item in the collection MAY be omitted if the type of object can be established through context. The collection is used primarily as the root of an Activity Streams document, but can be used as the value of extension properties in a variety of situations. ",
+  "properties" : {
+    "url" : {
+      "type" : "string",
+      "description": "An IRI [RFC3987] referencing a JSON document containing the full listing of objects in the collection."
+    },
+    "totalItems": {
+      "type" : "number",
+      "description" : "Non-negative integer specifying the total number of activities within the stream. The Stream serialization MAY contain a count property."
+    },
+    "items" : {
+      "type" : "array",
+      "required" : true,
+      "description" : "An array containing a listing of Objects of any object type. If used in combination with the url property, the items array can be used to provide a subset of the objects that may be found in the resource identified by the url.",
+      "items": {
+        "type" : "object",
+        "properties" :{"$ref":"./object.json#properties"}
+      }
+    },
+    "links" : {
+      "type" : "array",
+      "optional" : true,
+      "description" :"Links between an this object and other resources as defined in Web Linking",
+      "properties" : {"$ref" : "http://json-schema.org/links#properties"}
+    }
+  },
+  "links": [
+       {"rel": "describedby", "href": "http://json-schema.org/schema"}
+     ]
+}

schema/library/jsonschema-b4.js

@@ -0,0 +1,225 @@
+/**
+ * JSONSchema Validator - Validates JavaScript objects using JSON Schemas
+ *	(http://www.json.com/json-schema-proposal/)
+ *
+ * Copyright (c) 2007 Kris Zyp SitePen (www.sitepen.com)
+ * Updated by: Monica Wilkinson on 07/23/2010
+ * 
+ * Licensed under the MIT (MIT-LICENSE.txt) license.
+To use the validator call JSONSchema.validate with an instance object and an optional schema object.
+If a schema is provided, it will be used to validate. If the instance object refers to a schema (self-validating),
+that schema will be used to validate and the schema parameter is not necessary (if both exist,
+both validations will occur).
+The validate method will return an array of validation errors. If there are no errors, then an
+empty list will be returned. A validation error will have two properties:
+"property" which indicates which property had the error
+"message" which indicates what the error was
+ */
+
+JSONSchema = {
+	validate : function(/*Any*/instance,/*Object*/schema) {
+		// Summary:
+		//  	To use the validator call JSONSchema.validate with an instance object and an optional schema object.
+		// 		If a schema is provided, it will be used to validate. If the instance object refers to a schema (self-validating),
+		// 		that schema will be used to validate and the schema parameter is not necessary (if both exist,
+		// 		both validations will occur).
+		// 		The validate method will return an object with two properties:
+		// 			valid: A boolean indicating if the instance is valid by the schema
+		// 			errors: An array of validation errors. If there are no errors, then an
+		// 					empty list will be returned. A validation error will have two properties:
+		// 						property: which indicates which property had the error
+		// 						message: which indicates what the error was
+		//
+		return this._validate(instance,schema,false);
+	},
+	checkPropertyChange : function(/*Any*/value,/*Object*/schema, /*String*/ property) {
+		// Summary:
+		// 		The checkPropertyChange method will check to see if an value can legally be in property with the given schema
+		// 		This is slightly different than the validate method in that it will fail if the schema is readonly and it will
+		// 		not check for self-validation, it is assumed that the passed in value is already internally valid.
+		// 		The checkPropertyChange method will return the same object type as validate, see JSONSchema.validate for
+		// 		information.
+		//
+		return this._validate(value,schema, property || "property");
+	},
+	_validate : function(/*Any*/instance,/*Object*/schema,/*Boolean*/ _changing) {
+
+	var errors = [];
+		// validate a value against a property definition
+	function checkProp(value, schema, path,i){
+		var l;
+		path += path ? typeof i == 'number' ? '[' + i + ']' : typeof i == 'undefined' ? '' : '.' + i : i;
+		function addError(message){
+			errors.push({property:path,message:message});
+		}
+
+		if((typeof schema != 'object' || schema instanceof Array) && (path || typeof schema != 'function')){
+			if(typeof schema == 'function'){
+				if(!(value instanceof schema)){
+					addError("is not an instance of the class/constructor " + schema.name);
+				}
+			}else if(schema){
+				addError("Invalid schema/property definition " + schema);
+			}
+			return null;
+		}
+		if(_changing && schema.readonly){
+			addError("is a readonly field, it can not be changed");
+		}
+		if(schema['extends']){ // if it extends another schema, it must pass that schema as well
+			checkProp(value,schema['extends'],path,i);
+		}
+		// validate a value against a type definition
+		function checkType(type,value){
+			if(type){
+				if(typeof type == 'string' && type != 'any' &&
+						(type == 'null' ? value !== null : typeof value != type) &&
+						!(value instanceof Array && type == 'array') &&
+						!(type == 'integer' && value%1===0)){
+					return [{property:path,message:(typeof value) + " value found, but a " + type + " is required"}];
+				}
+				if(type instanceof Array){
+					var unionErrors=[];
+					for(var j = 0; j < type.length; j++){ // a union type
+						if(!(unionErrors=checkType(type[j],value)).length){
+							break;
+						}
+					}
+					if(unionErrors.length){
+						return unionErrors;
+					}
+				}else if(typeof type == 'object'){
+					var priorErrors = errors;
+					errors = [];
+					checkProp(value,type,path);
+					var theseErrors = errors;
+					errors = priorErrors;
+					return theseErrors;
+				}
+			}
+			return [];
+		}
+        // Monica: Added code to check the default
+        if(value === undefined){
+            value = schema["default"];
+        }
+		if(value === undefined){
+			if(!schema.optional){
+				addError("is missing and it is not optional");
+			}
+		}else{
+			errors = errors.concat(checkType(schema.type,value));
+			if(schema.disallow && !checkType(schema.disallow,value).length){
+				addError(" disallowed value was matched");
+			}
+			if(value !== null){
+				if(value instanceof Array){
+					if(schema.items){
+						if(schema.items instanceof Array){
+							for(i=0,l=value.length; i<l; i++){
+								errors.concat(checkProp(value[i],schema.items[i],path,i));
+							}
+						}else{
+							for(i=0,l=value.length; i<l; i++){
+								errors.concat(checkProp(value[i],schema.items,path,i));
+							}
+						}
+					}
+					if(schema.minItems && value.length < schema.minItems){
+						addError("There must be a minimum of " + schema.minItems + " in the array");
+					}
+					if(schema.maxItems && value.length > schema.maxItems){
+						addError("There must be a maximum of " + schema.maxItems + " in the array");
+					}
+				}else if(schema.properties){
+					errors.concat(checkObj(value,schema.properties,path,schema.additionalProperties));
+				}
+				if(schema.pattern && typeof value == 'string' && !value.match(schema.pattern)){
+					addError("does not match the regex pattern " + schema.pattern);
+				}
+				if(schema.maxLength && typeof value == 'string' && value.length > schema.maxLength){
+					addError("may only be " + schema.maxLength + " characters long");
+				}
+				if(schema.minLength && typeof value == 'string' && value.length < schema.minLength){
+					addError("must be at least " + schema.minLength + " characters long");
+				}
+				if(typeof schema.minimum !== undefined && typeof value == typeof schema.minimum &&
+						schema.minimum > value){
+					addError("must have a minimum value of " + schema.minimum);
+				}
+				if(typeof schema.maximum !== undefined && typeof value == typeof schema.maximum &&
+						schema.maximum < value){
+					addError("must have a maximum value of " + schema.maximum);
+				}
+				if(schema['enum']){
+					var enumer = schema['enum'];
+					l = enumer.length;
+					var found;
+					for(var j = 0; j < l; j++){
+						if(enumer[j]===value){
+							found=1;
+							break;
+						}
+					}
+					if(!found){
+						addError("does not have a value in the enumeration " + enumer.join(", "));
+					}
+				}
+				if(typeof schema.maxDecimal == 'number' &&
+					(value.toString().match(new RegExp("\\.[0-9]{" + (schema.maxDecimal + 1) + ",}")))){
+					addError("may only have " + schema.maxDecimal + " digits of decimal places");
+				}
+			}
+
+		}
+		return null;
+	}
+	// validate an object against a schema
+	function checkObj(instance,objTypeDef,path,additionalProp){
+
+		if(typeof objTypeDef =='object'){
+			if(typeof instance != 'object' || instance instanceof Array){
+				errors.push({property:path,message:"an object is required"});
+			}
+
+            // check all the properties are present as required in the schema
+			for(var i in objTypeDef){
+				if(objTypeDef.hasOwnProperty(i) && !(i.charAt(0) == '_' && i.charAt(1) == '_')){
+					var value = instance[i];
+					var propDef = objTypeDef[i];
+					checkProp(value,propDef,path,i);
+				}
+			}
+		}
+
+        // check the properties of the instance
+		for(i in instance){
+			if(instance.hasOwnProperty(i) && !(i.charAt(0) == '_' && i.charAt(1) == '_') && objTypeDef && !objTypeDef[i] && additionalProp===false){
+				errors.push({property:path,message:(typeof value) + "The property " + i +
+						" is not defined in the schema and the schema does not allow additional properties"});
+			}
+			var requires = objTypeDef && objTypeDef[i] && objTypeDef[i].requires;
+			if(requires && !(requires in instance)){
+				errors.push({property:path,message:"the presence of the property " + i + " requires that " + requires + " also be present"});
+			}
+			value = instance[i];
+
+			if(!_changing && value && value.$schema){
+				errors = errors.concat(checkProp(value,value.$schema,path,i));
+			}
+		}
+		return errors;
+	}
+	if(schema){
+		checkProp(instance,schema,'',_changing || '');
+	}
+	if(!_changing && instance && instance.$schema){
+		checkProp(instance,instance.$schema,'','');
+	}
+	return {valid:!errors.length,errors:errors};
+	}
+	/* will add this later
+	newFromSchema : function() {
+	}
+*/
+}