/rcms

Responsive Content Management System

Primary LanguageClojure

RCMS API

RCMS is an API for creating a CMS using the HTTP standard GET/POST/PUT/DELETE. Client side can be any framework or completely custom. An AngularJS frontend will be added once RCMS API is closer to completion. Authorization to the API is handled through client-api-key's.

Installation

Still in early stages...

resources/custom_config.clj = Development/Production configuration

  • resource path
  • client-api-token
  • database url/username/password
{:resource {
    :dev-path "path to files"
    :prod-path "path to files"}
  :token {
    :dev-client-api-token "guid"
    :prod-client-api-token "guid"}
  :image {
    :dev-size 1024 ;image width
    :dev-thumb-size 150
    :prod-size 1024 ;image width
    :prod-thumb-size 150
  :database {
    :dev-url "db url"
    :prod-url "db url"
    :dev-username "username"
    :prod-username "username"
    :dev-password "password"
    :prod-password "password"}}

Usage

Still in early stages..

Upload

POST   /upload       {:file {:size '##' :tempfile #<File > :filename '######'}
                      :folder "foldername"
                      :tag "tagname"}
       
POST   /multi-upload [{:file {:size '##' :tempfile #<File > :filename '######'}
                             {:size '##' :tempfile #<File > :filename '######'}
                       :folder "foldername"
                       :tag "tagname"}]
        NOTE: Folder and tag is applied to all files in multi-upload
        
       *Note using Chrome Rest Console*
       Request Params = folder - *foldername*
       Parameter Key = file

Folders

GET    /folders
POST   /folders          {:name 'foldername' :folderOrder '#' :hidden 'boolean'}
PUT    /folders/{folder} {:newName 'foldername'}
DELETE /folders/{folder}

Files

GET    /files
GET    /files/{folder}
GET    /files/{folder}/{filename}
DELETE /files/{folder}/{filename}

Tags

GET    /tags
GET    /tags/{folder}
POST   /tags                {:name 'tagname' :folderName 'foldername'}
DELETE /tags/{folder}/{tag}

Links

GET    /links
POST   /links        {:name 'linkname' :href 'linkhref' :linkOrder '#'}
DELETE /links/{name}

Announcements

GET    /announcements
GET    /announcements/{title}
POST   /announcements         {:title 'title' :body 'body' :expiresAt 'date'}
DELETE /ammouncements/{title}

Authorization

GET    /users
POST   /users/tokens {:token 'token' :id 'id'}

To-Do/Tasks

Routes/Model functions

  • Upload
    • Complete
  • Folders
    • Complete
  • Files
    • Complete
  • Tags
    • Complete
  • Links
    • Complete
  • Announcements
    • Complete

Liberator - Resource management

  • Complete

Database Connection

  • Test - DB
  • Development - DB
  • Production - DB

Authentication

All request require a valid "client-api-token" in the {:headers} of the request

Authorization - local/remote DB table

  • Upload permissions
    • Folder permissions
      • Allowed users
    • Tag permissions
      • Allowed users
    • Allowed users
  • Link permissions

DB

  • Folders
    • id
    • name
    • folder_order
    • hidden
  • Files
    • id
    • folder_name
    • file_name
    • tags
    • updated_at
    • link_order
  • Tags
    • id
    • name
    • folder_name
  • Links
    • id
    • name
    • link_order
  • Announcements
    • id
    • title
    • body
    • expires_at
    • created_at
  • Permissions to be determined
    • id
    • employee_id
    • section ie.Documents/Links/Announcements/Banner/Image-links
    • folders
    • admin

Documentation