xing-framework 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: addc27df560e0f0aed4ccfe54fa7840a6a4af6d0
-  data.tar.gz: d395393a30e21f2a1125c8f868c14f551e4d6ba9
+  metadata.gz: 879d64c43c902f12cb4d78e72dbabe7d4ce5e648
+  data.tar.gz: db30c463cf52332bdc71228345888239bbf730bb
 SHA512:
-  metadata.gz: 60304c5cc7a007f7e90c2a6eefe5d875bea53134870fd92870432179f3b3e31455eeec8d55ef77e6f9001d8c1df30452f19bde2b61188902eff3278edf5f6865
-  data.tar.gz: 8d662f73c833321248963beb49c828beffec7ac3623ffc68092a6c673ae81d3474b20773bd0a0a6bdb72eec14b84909a0581c6c11437613cf41f6cc3f213a209
+  metadata.gz: f7eda3ea85360c6b40a0797741cc350c2b8b5e14909fdc29b903314a9e6f38d7053c5439f8418f61c30ea720f418e2bdf1ebab695346716b684f4921ca7567e2
+  data.tar.gz: 4ec5dba6a578d2e0dafae1bbc048242c79d6ec332371d363375cd0c227a3207a7d5711ee9b6b4cf570fcda6a84cd58d2aa10144297b5bd44fd8116ebe258a5c6

data/default_configuration/base_app/API_DOC/README

@@ -0,0 +1,23 @@
+
+All requests and responses are JSON. Client should send Accept:
+"application/json" on all requests, and Content-Type: "application/json" on
+requests with bodies (i.e. POST, PUT).
+
+OPEN QUESTIONS:
+  PATCH? Only makes sense if the body somehow represents a change rather than a replacement.
+  All link relations? Or just self-links and use resource embed for
+    relationships?
+
+Server responses should represent resources as a JSON object with two fields:
+`links` and `data`. Both fields should contain an object. The links object
+should have fields equivalent to HTML "rel" attributes. Importantly the self
+link, but we should define link types internal to the application.
+
+The data object is more free form. Some commonality of fields is worthwhile,
+but whatever most sensibly represents the resource is the best choice.
+
+Where a resource refers to another, include a subset of the other resource in
+the data object.
+
+Examples: #with ruby style comments
+

data/default_configuration/base_app/API_DOC/admin-menus

@@ -0,0 +1,167 @@
+# list of menus
+# This is the serialized output of Menu.list (class method)
+#
+# GET /admin/menus
+{
+  links; {
+    self: "/admin/menus"
+  },
+  data: [
+    { links: {
+        self: 'admin/menus/:id1'
+      },
+      data: {
+        name: 'Menu 1'
+      }
+    },
+    { links: {
+        self: 'admin/menus/:id2'
+      },
+      data: {
+        name: 'Menu 2'
+      }
+    },
+    { links: {
+        self: 'admin/menus/:id3'
+      },
+      data: {
+        name: 'Menu 3'
+      }
+    }
+  ]
+}
+
+
+# GET /admin/menu/:id
+#
+# Just like /navigation/main but takes the ID of one of the menus returned
+# in admin/menus, gives the full list *with* admin links for individual
+# menu items
+{
+ links: {
+   self: "/admin/menu/:id"
+  },
+  data: [
+
+    # a top-level menu item
+    {
+      links : {
+        self: 'admin/menu-item/:id'
+      }
+      data : {
+        name: "Services",
+        path: # IF type == 'raw url', this is included and contains the url
+        page: { links: { self: "pages/:url_slug",  #IF type == 'page', this is the URL of the page resource
+        type: [ 'page' | 'raw_url' ]
+        children: [
+
+          # a sub-menu item under "Services", with a page link
+          {
+            links: {
+              self: 'admin/menu-item/:id'
+            },
+            data: {
+              type: 'page',
+              name: "Startup MVPs",
+              page: { links: { self: '/pages/startup-mvps' }} ,
+              # no children - key omitted
+            }
+          },
+
+          # a second sub-menu item under "Services", with a page link
+          {
+            links: {
+              self: 'admin/menu-item/:id'
+            },
+            data: {
+              type: 'page'
+              name: "Code Rescue",
+              page: { links: { self: '/pages/code-rescue' }} ,
+              # no children - key omitted
+            }
+          },
+
+        ]
+      }
+    },
+
+    # a top-level menu item with an external link
+    {
+      links : {
+        self: 'admin/menu-item/:id'
+      }
+      data: {
+        type: 'raw_url',
+        name: "About Web Security",
+        path: 'https://www.owasp.org/index.php/Main_Page',
+        # no children - key omitted
+      }
+    }
+  ]
+}
+
+
+
+
+
+# GET /admin/menu-items/:id
+# For an item that liks to an external URL
+{
+  links : {
+    self: 'admin/menu-items/:id'
+  }
+  data: {
+    type: 'raw_url',
+    name: 'Services',
+    path: 'https://www.owasp.org/index.php/Main_Page',
+    parent_id: <integer>
+  }
+}
+# GET /admin/menu-items/:id
+# For an item that liks to a page
+{
+  links : {
+    self: 'admin/menu-items/:id'
+  }
+  data: {
+    type: 'page',
+    name: 'Services',
+    page: { links: { self: '/pages/:url_slug'  }},
+    page_id: <integer>,
+    parent_id: <integer>
+  }
+}
+
+#
+# POST /admin/menu-items
+#
+
+{
+  # links omitted
+
+  data : {
+    name: "Services",               # REQUIRED
+    path: '/services',               # optional if links to page
+    page_url_slug: '/page_url_slug' # optional if links to external website
+    type: [ 'page' | 'raw_url' ]    # REQUIRED
+    parent_id: <integer>               # optional
+  }
+}
+
+#
+# PUT /admin/menu-items/:id
+#
+
+{
+  # links omitted
+
+  data : {
+    name: "Services",               # optional
+    path: '/services',               # optional
+    page_url_slug: '/page_url_slug' # optional
+    type: [ 'page' | 'raw_url' ]    # optional
+    parent_id: <integer>               # optional
+  }
+}
+
+

data/default_configuration/base_app/API_DOC/admin-pages

@@ -0,0 +1,173 @@
+# NOTE: public has no view of list of pages
+# This endpoint will NOT include blog posts: this is the list
+# of pages to appear in the "Edit Pages" tool for admin users.
+#
+# RFC:  Is 'self' link the public view of the page, or the admin
+# view of the page?  I'd think the latter
+#
+# GET /admin/pages
+{
+  links {
+    self: '/admin/pages'
+  },
+  data: [
+    { links: {
+        self:   '/admin/pages/:slug1'
+        public: '/pages/:slug1'
+      },
+      data:  {
+        title: 'Page 1',
+        layout: "one_column",
+        url_slug: "url_slug",
+        published: [true | false],
+        publish_start: <date/time>,
+        publish_end: <date/time>
+      }
+    },
+    { links: {
+        self:   '/admin/pages/:slug2' ,
+        public: '/pages/:slug2'
+      },
+      data:  {
+        title: 'Page 2'
+        layout: "one_column",
+        url_slug: "url_slug",
+        published: [true | false],
+        publish_start: <date/time>,
+        publish_end: <date/time>
+      }
+    },
+    { links: {
+        self:   '/admin/pages/:slug3'
+        public: '/pages/:slug3'
+      },
+      data:  {
+        title: 'Page 3',
+        layout: "two_column",
+        url_slug: "url_slug",
+        published: [true | false],
+        publish_start: <date/time>,
+        publish_end: <date/time>
+      }
+    }
+  ]
+}
+
+# RFP: I think this one is ready to go.
+#
+# GET /admin/pages/:url_slug
+{
+  links: {
+    self: "/admin/pages/:slug",
+    public: "/pages/:slug"
+  },
+
+  data: {
+    url_slug: 'some-url-slug',
+    title: "string",
+    keywords: "string",
+    description: "string",
+    layout:  "one_column",
+    url_slug: "url_slug",
+    published: "boolean",
+    publish_start: "datetime",
+    publish_end: "datetime",
+    contents: {
+      main: {
+        links: { self: "/content-blocks/:id"  }
+        data: {
+          content_type: 'text/html',
+          body: 'Four score and <em>seven</em> years'
+        }
+      },
+      headline: {
+        links: { self: "/content-blocks/:id" },
+        data: {
+          content_type: 'text/html',
+          body: 'The Gettysburg Address'
+        }
+      },
+      styles: {
+        links: { self: "/content-blocks/:id" },
+        data: {
+          content_type: 'text/css',
+          body: 'p { font-weight: bold; }'
+        }
+      }
+    }
+  }
+}
+
+
+# POST /admin/pages
+# creates a page with the supplied content
+{
+  # links omitted
+  data: {
+    url_slug: "string",    # optional
+    title: "string",       # REQUIRED
+    keywords: "string",    # optional
+    description: "string", # optional
+    layout: "",            # REQUIRED - options are an ENUM per project
+
+    published: <boolean>,      # optional - default true
+    publish_start: <datetime>, # optional - default nil
+    publish_end: <datetime>,   # optional - default nil
+
+    contents: {
+      main: {
+        data: {
+          # NOTE: content-type omitted because that's specified in the back-end
+          # specification for this Page layout
+          body: 'Four score and <em>seven</em> years'
+        }
+      },
+      headline: {
+        data: {
+          body: 'The Gettysburg Address'
+        }
+      },
+      styles: {
+        data: {
+          body: 'p { font-weight: bold; }'
+        }
+      }
+    }
+  }
+}
+
+# PUT /admin/pages/:url_slug
+# exactly like POST except that all fields are now optional, existing
+# values will be retained
+{
+  # links omitted
+  data: {
+    url_slug: "string",    # optional
+    title: "string",       # optional
+    keywords: "string",    # optional
+    description: "string", # optional
+    layout: "",            # optional
+
+    published: <boolean>,      # optional - default true
+    publish_start: <datetime>, # optional - default nil
+    publish_end: <datetime>,   # optional - default nil
+
+    contents: {
+      main: {
+        data: {
+          body: 'Four score and <em>seven</em> years'
+        }
+      },
+      headline: {
+        data: {
+          body: 'The Gettysburg Address'
+        }
+      },
+      styles: {
+        data: {
+          body: 'p { font-weight: bold; }'
+        }
+      }
+    }
+  }
+}

data/default_configuration/base_app/API_DOC/content-block

@@ -0,0 +1,10 @@
+# There is no POST or GET for content-block. They should be created and fetched via the page
+# resource.  However, in order to support in-line / AJAXY editing, the front-end may update
+# an individual content block resource.
+
+# PUT /admin/content-blocks/:id
+{
+  data: {
+    body: "New value for this content block's body"
+  }
+}

data/default_configuration/base_app/API_DOC/navigation

@@ -0,0 +1,54 @@
+
+
+#GET /navigation/main:
+{
+ links: {
+   self: "/navigation/main"
+  },
+  data: [
+
+    # a top-level menu item
+    {
+      links : {}
+      data : {
+        name: "Services",
+        url: 'services',
+        type: [ 'page' | 'raw_url' ]
+        children: [
+
+          # a sub-menu item under "Services"
+          {
+            links: {},
+            data: {
+              name: "Startup MVPs",
+              url: '/startup-mvps',
+              type: [ 'page' | 'raw_url' ],
+              # no children - key omitted
+            }
+          },
+          {
+            links: {},
+            data: {
+              name: "Code Rescue",
+              url: '/code-rescue'
+              type: [ 'page' | 'raw_url' ]
+              # no children - key omitted
+            }
+          },
+
+        ]
+      }
+    },
+
+    # a top-level menu item with an external link
+    {
+      links : {}
+      data : {
+        name: "About Web Security",
+        url: 'https://www.owasp.org/index.php/Main_Page',
+        type: 'raw_url',
+        # no children - key ommitted
+      }
+    }
+  ]
+}

data/default_configuration/base_app/API_DOC/page

@@ -0,0 +1,38 @@
+
+# an individual page
+GET /pages/:slug
+{
+  links: {
+    self: "/pages/:slug",
+    admin: "admin/pages/:slug"
+  },
+  data: {
+    title: "string",
+    keywords: "string",
+    description: "string",
+    layout:  "one_column",
+    contents: {
+      main: {
+        links: { self: "/content-blocks/:id"  }
+        data: {
+          content_type: 'text/html',
+          body: 'Four score and <em>seven</em> years'
+        }
+      },
+      headline: {
+        links: { self: "/content-blocks/:id" },
+        data: {
+          content_type: 'text/html',
+          body: 'The Gettysburg Address'
+        }
+      },
+      styles: {
+        links: { self: "/content-blocks/:id" },
+        data: {
+          content_type: 'text/css',
+          body: 'p { font-weight: bold; }'
+        }
+      }
+    }
+  }
+}