moving endpoints to new API (WIP)

model/account/account.go

@@ -0,0 +1,28 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>.
+//
+// https://documize.com
+
+package account
+
+import "github.com/documize/community/model"
+
+// Account links a User to an Organization.
+type Account struct {
+	model.BaseEntity
+	Admin   bool   `json:"admin"`
+	Editor  bool   `json:"editor"`
+	UserID  string `json:"userId"`
+	OrgID   string `json:"orgId"`
+	Company string `json:"company"`
+	Title   string `json:"title"`
+	Message string `json:"message"`
+	Domain  string `json:"domain"`
+	Active  bool   `json:"active"`
+}

model/audit/audit.go

@@ -0,0 +1,70 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>.
+//
+// https://documize.com
+
+// Package eventing records and propagates events based on user actions.
+package audit
+
+import "time"
+
+// AppEvent represents an event initiated by a user.
+type AppEvent struct {
+	ID      uint64    `json:"-"`
+	OrgID   string    `json:"orgId"`
+	UserID  string    `json:"userId"`
+	Type    string    `json:"eventType"`
+	IP      string    `json:"ip"`
+	Created time.Time `json:"created"`
+}
+
+// EventType defines valid event entry types
+type EventType string
+
+const (
+	EventTypeDocumentAdd        EventType = "added-document"
+	EventTypeDocumentUpload     EventType = "uploaded-document"
+	EventTypeDocumentView       EventType = "viewed-document"
+	EventTypeDocumentUpdate     EventType = "updated-document"
+	EventTypeDocumentDelete     EventType = "removed-document"
+	EventTypeDocumentRevisions  EventType = "viewed-document-revisions"
+	EventTypeSpaceAdd           EventType = "added-space"
+	EventTypeSpaceUpdate        EventType = "updated-space"
+	EventTypeSpaceDelete        EventType = "removed-space"
+	EventTypeSpacePermission    EventType = "changed-space-permissions"
+	EventTypeSpaceJoin          EventType = "joined-space"
+	EventTypeSpaceInvite        EventType = "invited-space"
+	EventTypeSectionAdd         EventType = "added-document-section"
+	EventTypeSectionUpdate      EventType = "updated-document-section"
+	EventTypeSectionDelete      EventType = "removed-document-section"
+	EventTypeSectionRollback    EventType = "rolled-back-document-section"
+	EventTypeSectionResequence  EventType = "resequenced-document-section"
+	EventTypeSectionCopy        EventType = "copied-document-section"
+	EventTypeAttachmentAdd      EventType = "added-attachment"
+	EventTypeAttachmentDownload EventType = "downloaded-attachment"
+	EventTypeAttachmentDelete   EventType = "removed-attachment"
+	EventTypePinAdd             EventType = "added-pin"
+	EventTypePinDelete          EventType = "removed-pin"
+	EventTypePinResequence      EventType = "resequenced-pin"
+	EventTypeBlockAdd           EventType = "added-reusable-block"
+	EventTypeBlockUpdate        EventType = "updated-reusable-block"
+	EventTypeBlockDelete        EventType = "removed-reusable-block"
+	EventTypeTemplateAdd        EventType = "added-document-template"
+	EventTypeTemplateUse        EventType = "used-document-template"
+	EventTypeUserAdd            EventType = "added-user"
+	EventTypeUserUpdate         EventType = "updated-user"
+	EventTypeUserDelete         EventType = "removed-user"
+	EventTypeUserPasswordReset  EventType = "reset-user-password"
+	EventTypeAccountAdd         EventType = "added-account"
+	EventTypeSystemLicense      EventType = "changed-system-license"
+	EventTypeSystemAuth         EventType = "changed-system-auth"
+	EventTypeSystemSMTP         EventType = "changed-system-smtp"
+	EventTypeSessionStart       EventType = "started-session"
+	EventTypeSearch             EventType = "searched"
+)

model/base.go

@@ -0,0 +1,34 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>.
+//
+// https://documize.com
+
+// Package model ...
+package model
+
+import (
+	"time"
+)
+
+// BaseEntity contains the database fields used in every table.
+type BaseEntity struct {
+	ID      uint64    `json:"-"`
+	RefID   string    `json:"id"`
+	Created time.Time `json:"created"`
+	Revised time.Time `json:"revised"`
+}
+
+// BaseEntityObfuscated is a mirror of BaseEntity,
+// but with the fields invisible to JSON.
+type BaseEntityObfuscated struct {
+	ID      uint64    `json:"-"`
+	RefID   string    `json:"-"`
+	Created time.Time `json:"-"`
+	Revised time.Time `json:"-"`
+}

model/org/org.go

@@ -0,0 +1,31 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>.
+//
+// https://documize.com
+
+package org
+
+import "github.com/documize/community/model"
+
+// Organization defines a company that uses this app.
+type Organization struct {
+	model.BaseEntity
+	Company              string `json:"-"`
+	Title                string `json:"title"`
+	Message              string `json:"message"`
+	URL                  string `json:"url"`
+	Domain               string `json:"domain"`
+	Email                string `json:"email"`
+	AllowAnonymousAccess bool   `json:"allowAnonymousAccess"`
+	AuthProvider         string `json:"authProvider"`
+	AuthConfig           string `json:"authConfig"`
+	ConversionEndpoint   string `json:"conversionEndpoint"`
+	Serial               string `json:"-"`
+	Active               bool   `json:"-"`
+}

model/pin/pin.go

@@ -0,0 +1,25 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>.
+//
+// https://documize.com
+
+package pin
+
+import "github.com/documize/community/model"
+
+// Pin defines a saved link to a document or space
+type Pin struct {
+	model.BaseEntity
+	OrgID      string `json:"orgId"`
+	UserID     string `json:"userId"`
+	FolderID   string `json:"folderId"`
+	DocumentID string `json:"documentId"`
+	Pin        string `json:"pin"`
+	Sequence   int    `json:"sequence"`
+}

model/space/space.go

@@ -0,0 +1,93 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>.
+//
+// https://documize.com
+
+package space
+
+import "github.com/documize/community/model"
+
+// Space defines a container for documents.
+type Space struct {
+	model.BaseEntity
+	Name   string `json:"name"`
+	OrgID  string `json:"orgId"`
+	UserID string `json:"userId"`
+	Type   Scope  `json:"folderType"`
+}
+
+// Scope determines folder visibility.
+type Scope int
+
+const (
+	// ScopePublic can be seen by anyone
+	ScopePublic Scope = 1
+
+	// ScopePrivate can only be seen by the person who owns it
+	ScopePrivate Scope = 2
+
+	// ScopeRestricted can be seen by selected users
+	ScopeRestricted Scope = 3
+)
+
+// IsPublic means the folder can be seen by anyone.
+func (l *Space) IsPublic() bool {
+	return l.Type == ScopePublic
+}
+
+// IsPrivate means the folder can only be seen by the person who owns it.
+func (l *Space) IsPrivate() bool {
+	return l.Type == ScopePrivate
+}
+
+// IsRestricted means the folder can be seen by selected users.
+func (l *Space) IsRestricted() bool {
+	return l.Type == ScopeRestricted
+}
+
+// Role determines user permissions for a folder.
+type Role struct {
+	model.BaseEntityObfuscated
+	OrgID   string `json:"-"`
+	LabelID string `json:"folderId"`
+	UserID  string `json:"userId"`
+	CanView bool   `json:"canView"`
+	CanEdit bool   `json:"canEdit"`
+}
+
+// Viewer details who can see a particular space
+type Viewer struct {
+	Name      string `json:"name"`
+	LabelID   string `json:"folderId"`
+	Type      int    `json:"folderType"`
+	UserID    string `json:"userId"`
+	Firstname string `json:"firstname"`
+	Lastname  string `json:"lastname"`
+	Email     string `json:"email"`
+}
+
+// RolesModel details which users have what permissions on a given space.
+type RolesModel struct {
+	Message string
+	Roles   []Role
+}
+
+// AcceptShareModel is used to setup a user who has accepted a shared space.
+type AcceptShareModel struct {
+	Serial    string `json:"serial"`
+	Firstname string `json:"firstname"`
+	Lastname  string `json:"lastname"`
+	Password  string `json:"password"`
+}
+
+// InvitationModel details which users have been invited to a space.
+type InvitationModel struct {
+	Message    string
+	Recipients []string
+}

model/user/user.go

@@ -0,0 +1,59 @@
+// Copyright 2016 Documize Inc. <legal@documize.com>. All rights reserved.
+//
+// This software (Documize Community Edition) is licensed under
+// GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html
+//
+// You can operate outside the AGPL restrictions by purchasing
+// Documize Enterprise Edition and obtaining a commercial license
+// by contacting <sales@documize.com>.
+//
+// https://documize.com
+
+package user
+
+import (
+	"fmt"
+
+	"github.com/documize/community/model"
+	"github.com/documize/community/model/account"
+)
+
+// User defines a login.
+type User struct {
+	model.BaseEntity
+	Firstname string            `json:"firstname"`
+	Lastname  string            `json:"lastname"`
+	Email     string            `json:"email"`
+	Initials  string            `json:"initials"`
+	Active    bool              `json:"active"`
+	Editor    bool              `json:"editor"`
+	Admin     bool              `json:"admin"`
+	Global    bool              `json:"global"`
+	Password  string            `json:"-"`
+	Salt      string            `json:"-"`
+	Reset     string            `json:"-"`
+	Accounts  []account.Account `json:"accounts"`
+}
+
+// ProtectSecrets blanks sensitive data.
+func (user *User) ProtectSecrets() {
+	user.Password = ""
+	user.Salt = ""
+	user.Reset = ""
+}
+
+// Fullname returns Firstname + Lastname.
+func (user *User) Fullname() string {
+	return fmt.Sprintf("%s %s", user.Firstname, user.Lastname)
+}
+
+// GetAccount returns matching org account using orgID
+func (user *User) GetAccount(orgID string) (a account.Account, found bool) {
+	for _, a := range user.Accounts {
+		if a.OrgID == orgID {
+			return a, true
+		}
+	}
+
+	return a, false
+}