representors 0.0.5

data/lib/representors/version.rb

@@ -0,0 +1,4 @@
+# Used to prevent the class/module from being loaded more than once
+module Representors
+  VERSION = '0.0.5'
+end

data/spec/fixtures/complex_hal.json

@@ -0,0 +1,92 @@
+{
+    "total_count": 2,
+    "_links": {
+        "self": {
+            "href": "http://example.com/drds"
+        },
+        "list": {
+            "href": "http://example.com/drds/list",
+            "profile": "http://alps.io/schema.org/DRDs"
+        },
+        "search": {
+            "href": "http://example.com/drds/search{?search_term,name}",
+            "templated": true
+        },
+        "create": {
+            "href": "www.example.com/drds/create"
+        },
+        "items": {
+                "href": "www.example.com/drds/show/173875983789",
+                "profile": "http://alps.io/schema.org/DRD"
+            },
+        "profile": {
+            "href": "http://www.example.com/drds/show/DRDs"
+        },
+        "help": {
+            "href": "http://alps.io/schema.org/DRDs"
+        }
+    },
+    "_embedded": {
+        "items": [
+            {
+                "uuid": "007d8e12-babd-4f2c-b01e-8b5e2f749e1z",
+                "name": "drdname",
+                "status": "compliant",
+                "old_status": "compliant",
+                "kind": "nonstandard",
+                "size": "medium",
+                "leviathan_uuid": "1234-9abc-5678-def1",
+                "built_at": "2013-03-20T00:00:00+00:01",
+                "leviathan": "http://alps.io/schema.org/Thing/Leviathan",
+                "location": [
+                    "moya",
+                    "japan"
+                ],
+                "location_detail": "inside",
+                "leviathan_email": "joe@grumpycat.org",
+                "destroyed": "destroyed",
+                "leviathan_health_points": 32,
+                "term": "blunderbus",
+                "_links": {
+                    "self": {
+                        "href": "www.example.com/drds/show/173875983789"
+                    },
+                    "show": {
+                        "href": "www.example.com/drds/show/173875983789",
+                        "profile": "http://alps.io/schema.org/DRD"
+                    },
+                    "leviathan-link": {
+                        "href": "http://example.com/drds/Leviathan",
+                        "name": "leviathan",
+                        "profile": "http://alps.io/schema.org/Leviathan#leviathan"
+                    },
+                    "repair-history": {
+                        "href": "http://example.com/drds/Repairs",
+                        "profile": "http://alps.io/schema.org/Repairs#history"
+                    },
+                    "activate": {
+                        "href": "http://example.com/drds/activate/173875983789",
+                        "profile": "http://alps.io/schema.org/DRD"
+                    },
+                    "deactivate": {
+                        "href": "http://example.com/drds/show/173875983789",
+                        "profile": "http://alps.io/schema.org/DRD"
+                    },
+                    "delete": {
+                        "href": "http://example.com/drds/show/173875983789"
+                    },
+                    "update": {
+                        "href": "http://example.com/drds/show/173875983789",
+                        "profile": "http://alps.io/schema.org/DRDs#update"
+                    },
+                    "profile": {
+                        "href": "http://www.example.com/drds/show/DRD"
+                    },
+                    "help": {
+                        "href": "http://alps.io/schema.org/DRD"
+                    }
+                }
+            }
+        ]
+    }
+}

data/spec/fixtures/complex_hale_document.json

@@ -0,0 +1,81 @@
+{
+  "_meta": {
+    "lookup": {
+      "send_info": { "options": [ "yes", "no", "maybe" ], "in": true }
+    },
+    "edit_form": {
+      "method": "PUT",
+      "enctype": "application/json",
+      "render": "resource",
+      "data": {
+        "name": { "type": "string", "required": true },
+        "send_info": { "options": [ "yes", "no", "maybe" ], "in": true },
+        "user_id": { "scope": "href", "required": true }
+      }
+    }
+  },
+  "_links": {
+    "self": { "href": "..." },
+    "search": { 
+      "href": ".../{?send_info}",
+      "templated": true,
+      "method": "GET",
+      "data": { 
+        "send_info": { "scope": "href", "options": [ "yes", "no", "maybe" ], "in": true, "max_length": 40 }
+      }
+    },
+    "agent": { "href": "/agent/1", "method": "GET", "render": "embed" },
+    "customer": [ 
+      { "href": "/customer/1", "method": "GET" },
+      { "href": "/customer/2", "method": "GET" }
+    ]
+  },
+  "_embedded": {
+    "agent": {
+      "_links": {
+        "self": { "href": "/agent/1", "method": "GET" }
+      },
+      "name": "Mike"
+    },
+    "customer": [
+      {
+        "_links": {
+          "self": { "href": "/customer/1", "method": "GET" },
+          "edit": { 
+            "href": ".../{?user_id}",
+            "method": "PUT",
+            "enctype": "application/json",
+            "templated": true,
+            "render": "resource",
+            "data": {
+              "name": { "type": "string", "required": true, "value": "Tom" },
+              "send_info": { "options": [ "yes", "no", "maybe" ], "in": true, "value": "yes", "max_length": 40 },
+              "user_id": { "scope": "href", "required": true }
+            }
+          }
+        },
+        "name": "Tom",
+        "send_info": "yes"
+      },
+      {
+        "_links": {
+          "self": { "href": "/customer/2", "method": "GET" },
+          "edit": { 
+            "href": ".../{?user_id}",
+            "method": "PUT",
+            "enctype": "application/json",
+            "render": "resource",
+            "templated": true,
+            "data": {
+              "name": { "type": "string", "required": true, "value": "Harry" },
+              "send_info": { "options": [ "yes", "no", "maybe" ], "in": true, "value": "no" },
+              "user_id": { "scope": "href", "required": true }
+            }
+          }
+        },
+        "name": "Harry",
+        "send_info": "no"
+      }
+    ]   
+  }
+}

data/spec/fixtures/drds_hash.rb

@@ -0,0 +1,120 @@
+module ComplexRepresentor
+DRDS_HASH = {
+  href: 'www.example.com/drds',
+  id: 'DRDs',
+  protocol: 'http',
+  doc: 'Describes the semantics, states and state transitions associated with DRDs.',
+  links: {
+    profile: 'http://www.example.com/drds/show/DRDs',
+    help: 'http://alps.io/schema.org/DRDs'
+  },
+  attributes: {
+    "total_count" => {
+      doc: 'The total count of DRDs.',
+      type: 'semantic',
+      profile: 'http://alps.io/schema.org/Integer',
+      sample: 1,
+      value: 2,
+    },
+  },
+  transitions: [
+    {
+      rel: 'self',
+      href: 'http://example.com/drds',
+      method: 'GET',
+    },
+    {
+      rel: 'list',
+      doc: 'Returns a list of DRDs.',
+      profile: 'http://alps.io/schema.org/DRDs',
+      href: 'http://example.com/drds/list',
+    },
+    {
+      rel: 'search',
+      doc: 'Returns a list of DRDs that satisfy the search term.',
+      href: 'http://example.com/drds/search{?search_term,name}',
+      rt: 'drds',
+      descriptors: {
+        search_term: {
+          doc: 'The terms to search.',
+          profile: 'http://alps.io/schema.org/Text',
+          sample: 'searchterm',
+          multiple: true,
+          scope: 'href',
+        },
+        name: {
+          doc: 'The name of the DRD.',
+          profile: 'http://alps.io/schema.org/Text',
+          sample: 'drdname',
+          value: 'drdname',
+          scope: 'href',
+          field_type: 'text',
+        },
+      },
+    },
+    {
+      rel: 'create',
+      doc: 'Creates a DRD.',
+      rt: 'drd',
+      links: {
+        profile: 'http://alps.io/schema.org/DRDs#update',
+        help: 'http://help.example.com/Forms/update',
+      },
+      href: 'www.example.com/drds/create',
+      method: 'POST',
+      descriptors: {
+        name: {
+          doc: 'The name of the DRD.',
+          profile: 'http://alps.io/schema.org/Text',
+          sample: 'drdname',
+          field_type: 'text', #
+          validators: [
+            'required',
+            {maxlength: 50},
+          ],
+        },
+        leviathan: {
+          doc: 'The associated Leviathan resource.',
+          profile: 'http://alps.io/schema.org/Thing/Leviathan',
+          sample: 'http://alps.io/schema.org/Thing/Leviathan',
+          value: 'http://alps.io/schema.org/Thing/Leviathan',
+          type: 'object', #TODO Embedded Objects
+          descriptors: {
+            leviathan_uuid: {
+              doc: 'The UUID of the creator Leviathan.',
+              profile: 'http://alps.io/schema.org/Text',
+              sample: '007d8e12-babd-4f2c-b01e-8b5e2f749e1b',
+              type: 'text',
+              field_type: 'text',
+            },
+            leviathan_health_points: {
+              doc: 'The health points of Leviathan.',
+              profile: 'http://alps.io/schema.org/Integer',
+              type: 'integer',
+              field_type: 'number',
+              validators: [
+                'required',
+                {min: 0},
+                {max: 100},
+              ],
+              sample: 42,
+            },
+            leviathan_email: {
+              doc: 'The Leviathan respond to email.',
+              profile: 'http://alps.io/schema.org/Text',
+              sample: 'joe@grumpycat.org',
+              type: 'text',
+              field_type: 'email',
+              validators: [
+                'required',
+                {pattern: "^.+@.+$"}
+              ]
+            },
+          },
+        },
+      },
+    },
+  ],
+  #To put embedded items in the hash please see: single_drd.rb
+}
+end

data/spec/fixtures/hale_spec_examples/basic.json

@@ -0,0 +1,77 @@
+{
+    "_meta": {
+        "any": {
+            "json": "object"
+        }
+    },
+    "_links": {
+        "self": {
+            "href": "..."
+        },
+        "search": {
+            "href": ".../{?send_info}",
+            "templated": true,
+            "method": "GET",
+            "data": {
+                "send_info": {
+                    "options": [
+                        "yes",
+                        "no",
+                        "maybe"
+                    ],
+                    "in": true
+                }
+            }
+        },
+        "agent": {
+            "href": "/agent/1",
+            "method": "GET",
+            "render": "embed"
+        },
+        "customer": [
+            {
+                "href": "/customer/1",
+                "method": "GET"
+            }
+        ]
+    },
+    "_embedded": {
+        "customer": [
+            {
+                "_links": {
+                    "self": {
+                        "href": "/customer/1",
+                        "method": "GET"
+                    },
+                    "edit": {
+                        "href": ".../{?user_id}",
+                        "method": "PUT",
+                        "request_encoding": "application/json",
+                        "render": "resource",
+                        "data": {
+                            "name": {
+                                "type": "string",
+                                "required": true
+                            },
+                            "send_info": {
+                                "options": [
+                                    "yes",
+                                    "no",
+                                    "maybe"
+                                ],
+                                "in": true
+                            },
+                            "user_id": {
+                                "scope": "href",
+                                "required": true
+                            }
+                        }
+                    }
+                },
+                "name": "Tom",
+                "send_info": "yes"
+            }
+        ]
+    }
+}
+

data/spec/fixtures/hale_spec_examples/complex_reference_objects.json

@@ -0,0 +1,157 @@
+{
+    "_meta": {
+        "lookup": {
+            "send_info": {
+                "options": [
+                    "yes",
+                    "no",
+                    "maybe"
+                ],
+                "in": true
+            }
+        },
+        "edit_form": {
+            "method": "PUT",
+            "request_encoding": "application/json",
+            "render": "resource",
+            "data": {
+                "name": {
+                    "type": "string",
+                    "required": true
+                },
+                "send_info": {
+                    "options": [
+                        "yes",
+                        "no",
+                        "maybe"
+                    ],
+                    "in": true
+                },
+                "user_id": {
+                    "scope": "href",
+                    "required": true
+                }
+            }
+        }
+    },
+    "_links": {
+        "self": {
+            "href": "..."
+        },
+        "search": {
+            "href": ".../{?send_info}",
+            "templated": true,
+            "method": "GET",
+            "data": {
+                "send_info": {
+                    "options": [
+                        "yes",
+                        "no",
+                        "maybe"
+                    ],
+                    "in": true
+                }
+            }
+        },
+        "agent": {
+            "href": "/agent/1",
+            "method": "GET",
+            "render": "embed"
+        },
+        "customer": [
+            {
+                "href": "/customer/1",
+                "method": "GET"
+            },
+            {
+                "href": "/customer/2",
+                "method": "GET"
+            }
+        ]
+    },
+    "_embedded": {
+        "agent": {
+            "_links": {
+                "self": {
+                    "href": "/agent/1",
+                    "method": "GET"
+                }
+            },
+            "name": "Mike"
+        },
+        "customer": [
+            {
+                "_links": {
+                    "self": {
+                        "href": "/customer/1",
+                        "method": "GET"
+                    },
+                    "edit": {
+                        "href": ".../{?user_id}",
+                        "method": "PUT",
+                        "request_encoding": "application/json",
+                        "render": "resource",
+                        "data": {
+                            "name": {
+                                "type": "string",
+                                "required": true,
+                                "value": "Tom"
+                            },
+                            "send_info": {
+                                "options": [
+                                    "yes",
+                                    "no",
+                                    "maybe"
+                                ],
+                                "in": true,
+                                "value": "yes"
+                            },
+                            "user_id": {
+                                "scope": "href",
+                                "required": true
+                            }
+                        }
+                    }
+                },
+                "name": "Tom",
+                "send_info": "yes"
+            },
+            {
+                "_links": {
+                    "self": {
+                        "href": "/customer/2",
+                        "method": "GET"
+                    },
+                    "edit": {
+                        "href": ".../{?user_id}",
+                        "method": "PUT",
+                        "request_encoding": "application/json",
+                        "render": "resource",
+                        "data": {
+                            "name": {
+                                "type": "string",
+                                "required": true,
+                                "value": "Harry"
+                            },
+                            "send_info": {
+                                "options": [
+                                    "yes",
+                                    "no",
+                                    "maybe"
+                                ],
+                                "in": true,
+                                "value": "no"
+                            },
+                            "user_id": {
+                                "scope": "href",
+                                "required": true
+                            }
+                        }
+                    }
+                },
+                "name": "Harry",
+                "send_info": "no"
+            }
+        ]
+    }
+}