representors 0.0.5

data/spec/fixtures/hale_tutorial_examples/get_link.json

@@ -0,0 +1,17 @@
+{
+    "_links": {
+        "self": {
+            "href": "www.example.com/coffeebucks/"
+        },
+        "profile": {
+            "href": "profiles.example.com/coffeebucks/",
+            "enctype": [
+                "application/alps+xml",
+                "text/html"
+            ]
+        },
+        "orders": {
+            "href": "www.example.com/coffeebucks"
+        }
+    }
+}

data/spec/fixtures/hale_tutorial_examples/get_link_with_data.json

@@ -0,0 +1,29 @@
+{
+    "_links": {
+        "self": {
+            "href": "www.example.com/coffeebucks/"
+        },
+        "profile": {
+            "href": "profiles.example.com/coffeebucks/",
+            "enctype": [
+                "application/alps+xml",
+                "text/html"
+            ]
+        },
+        "orders": {
+            "href": "www.example.com/coffeebucks{?order_status}",
+            "data": {
+                "order_status": {
+                    "scope": "href",
+                    "options": [
+                        "pending_payment",
+                        "preparing",
+                        "fulfilled"
+                    ],
+                    "in": true,
+                    "multi": true
+                }
+            }
+        }
+    }
+}

data/spec/fixtures/hale_tutorial_examples/links.json

@@ -0,0 +1,11 @@
+{
+    "_links": {
+        "self": {
+            "href": "www.example.com/coffeebucks/"
+        },
+        "profile": {
+            "href": "profiles.example.com/coffeebucks/",
+            "enctype": "application/alps+xml"
+        }
+    }
+}

data/spec/fixtures/hale_tutorial_examples/links_only.json

@@ -0,0 +1,3 @@
+{
+    "_links": {}
+}

data/spec/fixtures/hale_tutorial_examples/meta.json

@@ -0,0 +1,208 @@
+{
+    "_meta": {
+        "order_properties": {
+            "drink_type": {
+                "options": [
+                    "coffee",
+                    "americano",
+                    "latte",
+                    "mocha",
+                    "cappuccino",
+                    "macchiato",
+                    "espresso"
+                ],
+                "in": true,
+                "required": true
+            },
+            "iced": {
+                "type": "boolean",
+                "value": false
+            },
+            "size": {
+                "type": "integer:number",
+                "options": [
+                    {
+                        "small": 8
+                    },
+                    {
+                        "medium": 12
+                    },
+                    {
+                        "large": 16
+                    },
+                    {
+                        "extra-large": 20
+                    }
+                ],
+                "in": true,
+                "required": true
+            },
+            "shots": {
+                "type": "integer:range",
+                "min": 0,
+                "max": 16
+            },
+            "decaf": {
+                "type": "integer:range",
+                "min": 0,
+                "max": 16,
+                "lte": {
+                    "profile": "profiles.example.com/lte/",
+                    "attribute": "shots"
+                }
+            }
+        }
+    },
+    "_links": {
+        "self": {
+            "href": "www.example.com/coffeebucks/"
+        },
+        "profile": {
+            "href": "profiles.example.com/coffeebucks/",
+            "enctype": [
+                "application/alps+xml",
+                "text/html"
+            ]
+        },
+        "orders": {
+            "href": "www.example.com/coffeebucks{?order_status,page}",
+            "data": {
+                "order_status": {
+                    "scope": "href",
+                    "options": [
+                        "pending_payment",
+                        "preparing",
+                        "fulfilled"
+                    ],
+                    "in": true,
+                    "multi": true
+                },
+                "page": {
+                    "type": "integer",
+                    "min": 1,
+                    "max": 2,
+                    "value": 1
+                }
+            }
+        },
+        "next": {
+            "href": "www.example.com/coffeebucks?page=2"
+        },
+        "place_order": {
+            "href": "www.example.com/coffeebucks/orders",
+            "method": "POST",
+            "data": {
+                "_ref": [
+                    "order_properties"
+                ]
+            },
+            "multi_order": {
+                "href": "www.example.com/coffeebucks/orders",
+                "request_encoding": "application/json",
+                "method": "POST",
+                "data": {
+                    "multi_order": {
+                        "value": true
+                    },
+                    "orders": {
+                        "type": "object",
+                        "multi": "true",
+                        "data": {
+                            "_ref": [
+                                "order_properties"
+                            ]
+                        }
+                    }
+                }
+            }
+        },
+        "order_list": [
+            {
+                "href": "www.example.com/coffeebucks/1"
+            },
+            {
+                "href": "www.example.com/coffeebucks/2"
+            },
+            {
+                "href": "www.example.com/coffeebucks/3"
+            }
+        ]
+    },
+    "_embedded": {
+        "order_list": [
+            {
+                "_links": {
+                    "self": {
+                        "href": "www.example.com/coffeebucks/1"
+                    },
+                    "fulfill": {
+                        "href": "www.example.com/coffeebucks/1",
+                        "method": "PUT",
+                        "data": {
+                            "status": {
+                                "value": "fulfilled",
+                                "required": true
+                            }
+                        }
+                    }
+                },
+                "status": "preparing",
+                "created": 12569537329,
+                "drink_type": "latte",
+                "iced": "true",
+                "size": 8,
+                "shots": 2,
+                "decaf": 1
+            },
+            {
+                "_links": {
+                    "self": {
+                        "href": "www.example.com/coffeebucks/2"
+                    }
+                },
+                "status": "fulfilled",
+                "created": 12569537312,
+                "drink_type": "latte",
+                "iced": "true",
+                "size": 8,
+                "shots": 2,
+                "decaf": 1
+            },
+            {
+                "_links": {
+                    "self": {
+                        "href": "www.example.com/coffeebucks/3"
+                    },
+                    "prepare": {
+                        "href": "www.example.com/coffeebucks/1",
+                        "method": "PUT",
+                        "data": {
+                            "status": {
+                                "value": "preparing",
+                                "required": true
+                            },
+                            "paid": {
+                                "value": 495,
+                                "required": true
+                            }
+                        }
+                    },
+                    "cancel": {
+                        "href": "www.example.com/coffeebucks/3",
+                        "method": "DELETE"
+                    }
+                },
+                "status": "pending_payment",
+                "created": 12569534536,
+                "drink_type": "latte",
+                "iced": "true",
+                "size": 8,
+                "shots": 2,
+                "decaf": 1,
+                "cost": 495
+            }
+        ]
+    },
+    "count": 3,
+    "total_count": 6
+}

data/spec/fixtures/hale_tutorial_examples/self_link.json

@@ -0,0 +1,7 @@
+{
+    "_links": {
+        "self": {
+            "href": "www.example.com/coffeebucks/"
+        }
+    }
+}

data/spec/fixtures/single_drd.rb

@@ -0,0 +1,266 @@
+module ComplexRepresentor
+DRD_HASH = {
+  href: 'http://example.com/drd/1', 
+  id: 'DRD',
+  doc: 'Diagnostic Repair Drones or DRDs are small robots that move around Leviathans. They are built by a Leviathan as it grows.',
+  links: {
+    profile: 'http://www.example.com/drds/show/DRD',
+    help: 'http://alps.io/schema.org/DRD'
+  },
+  attributes: {
+    uuid: {
+      doc: 'The UUID of the DRD.',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: '007d8e12-babd-4f2c-b01e-8b5e2f749e1z',
+      value: '007d8e12-babd-4f2c-b01e-8b5e2f749e1z',
+    },
+    name: { 
+      doc: 'The name of the DRD.',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: 'drdname',
+      value: 'drdname',
+    },
+    status: {
+      doc: 'How is the DRD.',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: 'renegade',
+      value: 'compliant',
+    },
+    old_status: {
+      doc: 'How was the DRD before the last change',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: 'renegade',
+      value: 'compliant',
+    },
+    kind: {
+      doc: 'What kind is it.',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: 'standard',
+      value: 'nonstandard',
+    },
+    size: {
+      doc: 'How large it is',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: 'medium',
+      value: 'medium',
+    },
+    leviathan_uuid: {
+      doc: 'The UUID of the creator Leviathan.',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: '007d8e12-babd-4f2c-b01e-8b5e2f749e1b',
+      value: '007d8e12-babd-b01e-4f2c-8b5e2f749e1b',
+    },
+    built_at: {
+      doc: 'When the DRD was constructed.',
+      profile: 'http://alps.io/schema.org/DateTime',
+      sample: '2013-03-20T00:00:00+00:00',
+      value: '2013-03-20T00:00:00+00:01',
+    },
+    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',
+    },
+    location: {
+      doc: 'The area the DRD is currently in',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: 'moya',
+      multiple: 'true',
+      value: ['moya','japan'],
+    },
+    location_detail: {
+      doc: 'Exactly where in the location the DRD currenlty is',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: 'outside',
+      value: 'inside',
+    },
+    leviathan_email: {
+      doc: 'The Leviathan respond to email.',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: 'joe@grumpycat.org',
+      value: 'joe@grumpycat.org',
+    },
+    leviathan_uuid: {
+      doc: 'The UUID of the creator Leviathan.',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: '1234-5678-9abc-def1',
+      value: '1234-9abc-5678-def1',
+    },
+    destroyed: {
+      doc: 'This DRD has been destroyed',
+      profile: 'http://alps.io/schema.org/Boolean',
+      sample: 'destroyed',
+      value: 'destroyed',
+    },
+    leviathan_health_points: {
+      doc: 'The health points of Leviathan.',
+      profile: 'http://alps.io/schema.org/Integer',
+      value: 32,
+    },
+    term: {
+      doc: 'The terms to search.',
+      profile: 'http://alps.io/schema.org/Text',
+      sample: 'searchterm',
+      value: 'blunderbus',
+    },
+  },
+  transitions: [
+    {
+      rel: 'self',
+      doc: 'Shows a particular DRD.',
+      profile: 'http://alps.io/schema.org/DRD', 
+      href: 'www.example.com/drds/show/173875983789',
+    },
+    {
+      rel: 'show',
+      doc: 'Shows a particular DRD.',
+      profile: 'http://alps.io/schema.org/DRD', 
+      href: 'www.example.com/drds/show/173875983789',
+    },
+    {
+      rel: 'leviathan-link',
+      name: 'leviathan',
+      doc: 'A reference to the Leviathan the DRD works on.',
+      embed: true, 
+      profile: 'http://alps.io/schema.org/Leviathan#leviathan',
+      href: 'http://example.com/drds/Leviathan',
+    },
+    {
+      rel: 'repair-history',
+      doc: 'A reference to the list of historical repairs performed.',
+      embed: true,
+      profile: 'http://alps.io/schema.org/Repairs#history',
+      href: 'http://example.com/drds/Repairs',
+    },
+    {
+      rel: 'activate',
+      doc: 'Activates a DRD if it is deactivated.',
+      profile: 'http://alps.io/schema.org/DRD',
+      href: 'http://example.com/drds/activate/173875983789',
+      method: 'PUT',
+    },
+    {
+      rel: 'deactivate',
+      doc: 'Deactivates a DRD if it is activated.',
+      profile: 'http://alps.io/schema.org/DRD',
+      href: 'http://example.com/drds/show/173875983789',
+      method: 'PUT',
+    },
+    {
+      rel: 'delete',
+      doc: 'Drops a DRD out an air-lock.',
+      href: 'http://example.com/drds/show/173875983789',
+      method: 'DELETE',
+    },
+    {
+      rel: 'update',
+      doc: 'Updates a DRD.',
+      profile: 'http://alps.io/schema.org/DRDs#update',
+      href: 'http://example.com/drds/show/173875983789',
+      method: 'PUT',
+      descriptors: {
+        links: {
+          self: 'http://alps.io/schema.org/DRDs#update',
+          help: 'http://help.example.com/Forms/update',
+        },
+        status: {
+          doc: 'How is the DRD.', 
+          profile: 'http://alps.io/schema.org/Text',
+          sample: 'renegade',
+          value: 'renegade',
+          type: 'text',
+          data_type: 'select',
+          validators: [
+            :required,
+          ],
+          options: { 
+            'id' => 'drd_status_options',
+            'hash' => {
+              'active' => 'activated',
+              'inactive' => 'deactivated',
+              'unknown' => 'renegade',
+              },
+          },
+        },
+        old_status: {
+          doc: 'How was the DRD before the last change',
+          profile: 'http://alps.io/schema.org/Text',
+          sample: 'renegade',
+          type: 'text',
+          data_type: 'select',
+          validators: [
+            :required,
+          ],
+          options: {
+            'id' => 'drd_status_options',
+            'hash' => {
+              'active' => 'activated',
+              'inactive' => 'deactivated',
+              'unknow' => 'renegade',
+            },        
+          },
+        },
+        kind: {
+          doc: 'What kind is it.',
+          profile: 'http://alps.io/schema.org/Text',
+          sample: 'standard',
+          type: 'text',
+          data_type: 'select',
+          options: {
+            'list' => [
+              'standard',
+              'sentinel',
+            ]
+          },
+        },
+        size: {
+          doc: 'How large it is',
+          profile: 'http://alps.io/schema.org/Text',
+          sample: 'medium',
+          type: 'text',
+          data_type: 'text',
+          options: {
+            'list' => [
+             'big',
+             'small',
+            ],
+          },
+        },
+        location: {
+          doc: 'The area the DRD is currently in',
+          profile: 'http://alps.io/schema.org/Text',
+          sample: 'moya',
+          multiple: 'true',
+          field_type: 'select',
+          options: {
+            'external' => {
+              'source' => 'http://crichton.example.com/drd_location_detail_list#items',
+            },
+          },
+        },
+        location_detail: {
+          doc: 'Exactly where in the location the DRD currenlty is',
+          profile: 'http://alps.io/schema.org/Text',
+          sample: 'outside',
+          field_type: 'select',
+          options: {
+            'external' => {
+              'source' => 'http://crichton.example.com/drd_location_detail_list#items',
+              'target' => 'location_detail_id',
+              'prompt' => 'location_detail_text',
+            },
+          },
+        },
+        destroyed: {
+          doc: 'This DRD has been destroyed',
+          profile: 'http://alps.io/schema.org/Boolean',
+          sample: true,
+          type: 'boolean',
+          field_type: 'boolean',
+        },
+      },
+    },
+  ],
+}
+end