v1

package
v0.0.0-...-f271d2a Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 23, 2019 License: ISC Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// Contractor Management Routes
	RouteInviteNewUser       = "/invite"
	RouteRegisterUser        = "/register"
	RouteNewInvoice          = "/invoices/new"
	RouteEditInvoice         = "/invoices/edit"
	RouteInvoiceDetails      = "/invoices/{token:[A-z0-9]{64}}"
	RouteSetInvoiceStatus    = "/invoices/{token:[A-z0-9]{64}}/status"
	RouteUserInvoices        = "/user/invoices"
	RouteAdminInvoices       = "/admin/invoices"
	RouteGeneratePayouts     = "/admin/generatepayouts"
	RoutePayInvoices         = "/admin/payinvoices"
	RouteInvoiceComments     = "/invoices/{token:[A-z0-9]{64}}/comments"
	RouteInvoiceExchangeRate = "/invoices/exchangerate"

	// Invoice status codes
	InvoiceStatusInvalid  InvoiceStatusT = 0 // Invalid status
	InvoiceStatusNotFound InvoiceStatusT = 1 // Invoice not found
	InvoiceStatusNew      InvoiceStatusT = 2 // Invoice has not been reviewed
	InvoiceStatusUpdated  InvoiceStatusT = 3 // Invoice has unreviewed changes
	InvoiceStatusDisputed InvoiceStatusT = 4 // Invoice has been disputed for some reason
	InvoiceStatusRejected InvoiceStatusT = 5 // Invoice fully rejected and closed
	InvoiceStatusApproved InvoiceStatusT = 6 // Invoice has been approved
	InvoiceStatusPaid     InvoiceStatusT = 7 // Invoice has been paid

	// Line item types
	LineItemTypeInvalid LineItemTypeT = 0 // Invalid type
	LineItemTypeLabor   LineItemTypeT = 1 // Labor line items
	LineItemTypeExpense LineItemTypeT = 2 // Expenses incurred line items
	LineItemTypeMisc    LineItemTypeT = 3 // Catch all for anything else

	InvoiceInputVersion = 1

	// PolicyMaxImages is the maximum number of images accepted
	// when creating a new invoice
	PolicyMaxImages = 5

	// PolicyMaxImageSize is the maximum image file size (in bytes)
	// accepted when creating a new invoice
	PolicyMaxImageSize = 512 * 1024

	// PolicyMaxMDs is the maximum number of markdown files accepted
	// when creating a new invoice
	PolicyMaxMDs = 1

	// PolicyMaxMDSize is the maximum markdown file size (in bytes)
	// accepted when creating a new invoice
	PolicyMaxMDSize = 512 * 1024

	// PolicyMaxNameLength is the max length of a contractor name
	PolicyMaxNameLength = 50

	// PolicyMinNameLength is the min length of a contractor name
	PolicyMinNameLength = 3

	// PolicyMaxLocationLength is the max length of a contractor location
	PolicyMaxLocationLength = 100

	// PolicyMinLocationLength is the min length of a contractor location
	PolicyMinLocationLength = 3

	// PolicyMaxContactLength is the max length of a contractor contact
	PolicyMaxContactLength = 100

	// PolicyMinContactLength is the min length of a contractor contact
	PolicyMinContactLength = 3

	// PolicyInvoiceCommentChar is the character which, when used as the first
	// character of a line, denotes that entire line as a comment.
	PolicyInvoiceCommentChar rune = '#'

	// PolicyInvoiceFieldDelimiterChar is the character that delimits field
	// values for each line item in the CSV.
	PolicyInvoiceFieldDelimiterChar rune = ','

	// PolicyInvoiceLineItemCount is the number of expected fields in the raw
	// csv line items
	PolicyInvoiceLineItemCount = 7

	// PolicyMinLineItemColLength is the minimun length for the strings in
	// each column field of the lineItem structure.
	PolicyMinLineItemColLength = 3

	// PolicyMaxLineItemColLength is the maximum length for the strings in
	// each column field of the lineItem structure.
	PolicyMaxLineItemColLength = 200
)

Variables

View Source 
var (
	// PolicyValidMimeTypes is the accepted mime types of attachments
	// in invoices
	PolicyValidMimeTypes = []string{
		"image/png",
	}

	// PolicyInvoiceFieldSupportedChars is the regular expression of a valid
	// invoice fields.
	PolicyInvoiceFieldSupportedChars = []string{
		"A-z", "0-9", "&", ".", ",", ":", ";", "-", " ", "@", "+", "#", "/",
		"(", ")", "!", "?", "\"", "'"}

	// PolicyCMSNameLocationSupportedChars is the regular expression of a valid
	// name or location for registering users on cms.
	PolicyCMSNameLocationSupportedChars = []string{
		"A-z", ".", "-", " "}

	// PolicyCMSContactSupportedChars is the regular expression of a valid
	// contact for registering users on cms.
	PolicyCMSContactSupportedChars = []string{
		"A-z", "0-9", "&", ".", ":", "-", "_", "@", "+"}
)

Functions

This section is empty.

Types

type AdminInvoices 

type AdminInvoices struct {
	Month  uint16         `json:"month"`  // Month of Invoice
	Year   uint16         `json:"year"`   // Year of Invoice
	Status InvoiceStatusT `json:"status"` // Current status of invoice
}

AdminInvoices is used to get all invoices from all users

type AdminInvoicesReply 

type AdminInvoicesReply struct {
	Invoices []InvoiceRecord `json:"invoices"`
}

AdminInvoiceReply is used to reply to an admin invoices command.

type EditInvoice 

type EditInvoice struct {
	Token     string     `json:"token"`
	Files     []www.File `json:"files"`
	PublicKey string     `json:"publickey"`
	Signature string     `json:"signature"`
}

EditInvoice attempts to edit a proposal

type EditInvoiceReply 

type EditInvoiceReply struct {
	Invoice InvoiceRecord `json:"invoice"`
}

EditInvoiceReply is used to reply to the EditInvoice command

type GeneratePayouts 

type GeneratePayouts struct {
}

GeneratePayouts is used to generate a list of addresses and amounts of approved invoices that need to be paid.

type GeneratePayoutsReply 

type GeneratePayoutsReply struct {
	Payouts []Payout `json:"payouts"`
}

GeneratePayoutsReply is used to replay to a GeneratePayouts command.

type InviteNewUser 

type InviteNewUser struct {
	Email string `json:"email"`
}

InviteNewUser is used to request that a new user invitation be sent via email. If successful, the user will require verification before being able to login.

type InviteNewUserReply 

type InviteNewUserReply struct {
	VerificationToken string `json:"verificationtoken"`
}

InviteNewUserReply responds with the verification token for the user (if an email server is not set up).

type InvoiceDetails 

type InvoiceDetails struct {
	Token string `json:"token"` // Censorship token
}

InvoiceDetails is used to retrieve a invoice by it's token.

type InvoiceDetailsReply 

type InvoiceDetailsReply struct {
	Invoice InvoiceRecord `json:"invoice"`
}

InvoiceDetailsReply is used to reply to a invoice details command.

type InvoiceExchangeRate 

type InvoiceExchangeRate struct {
	Month uint `json:"month"`
	Year  uint `json:"year"`
}

InvoiceExchangeRate contains the request to receive a monthly exchange rate

type InvoiceExchangeRateReply 

type InvoiceExchangeRateReply struct {
	ExchangeRate uint `json:"exchangerate"` // in USD cents
}

InvoiceExchangeRateReply returns the calculated monthly exchange rate

type InvoiceInput 

type InvoiceInput struct {
	Version            uint             `json:"version"`            // Version of the invoice input
	Month              uint             `json:"month"`              // Month of Invoice
	Year               uint             `json:"year"`               // Year of Invoice
	ExchangeRate       uint             `json:"exchangerate"`       // Exchange rate of a given month/year in USD cents
	ContractorName     string           `json:"contractorname"`     // IRL name of contractor
	ContractorLocation string           `json:"contractorlocation"` // IRL location of contractor
	ContractorContact  string           `json:"contractorcontact"`  // Contractor email or other contact
	ContractorRate     uint             `json:"contractorrate"`     // Contractor Pay Rate in USD cents
	PaymentAddress     string           `json:"paymentaddress"`     //  BITUM payment address
	LineItems          []LineItemsInput `json:"lineitems"`
}

InvoiceInput is the expected structure of the invoice.json file being added to InvoiceRecords. Users' raw csv will be inputted and parsed to help in their creation.

type InvoiceRecord 

type InvoiceRecord struct {
	Status             InvoiceStatusT `json:"status"`                       // Current status of invoice
	StatusChangeReason string         `json:"statuschangereason,omitempty"` // Reason (if any) for the current status
	Timestamp          int64          `json:"timestamp"`                    // Last update of invoice
	UserID             string         `json:"userid"`                       // ID of user who submitted invoice
	Username           string         `json:"username"`                     // Username of user who submitted invoice
	PublicKey          string         `json:"publickey"`                    // User's public key, used to verify signature.
	Signature          string         `json:"signature"`                    // Signature of file digest
	Files              []www.File     `json:"file"`                         // Actual invoice file
	Version            string         `json:"version"`                      // Record version
	Input              InvoiceInput   `json:"input"`                        // Decoded invoice from invoice.json file

	CensorshipRecord www.CensorshipRecord `json:"censorshiprecord"`
}

InvoiceRecord is an entire invoice and its content.

type InvoiceStatusT 

type InvoiceStatusT int

type LineItemTypeT 

type LineItemTypeT int

type LineItemsInput 

type LineItemsInput struct {
	Type          LineItemTypeT `json:"type"`          // Type of work performed
	Domain        string        `json:"domain"`        // Domain of work performed
	Subdomain     string        `json:"subdomain"`     // Subdomain of work performed
	Description   string        `json:"description"`   // Description of work performed
	ProposalToken string        `json:"proposaltoken"` // Link to politeia proposal that work is associated with
	Labor         uint          `json:"labor"`         // Number of minutes (if labor)
	Expenses      uint          `json:"expenses"`      // Total cost (in USD cents) of line item (if expense or misc)
}

LineItemsInput is the expected struct of line items contained within an users' invoice input.

type NewInvoice 

type NewInvoice struct {
	Month     uint       `json:"month"`
	Year      uint       `json:"year"`
	Files     []www.File `json:"files"`     // Invoice file and any attachments along with it
	PublicKey string     `json:"publickey"` // Key used to verify signature
	Signature string     `json:"signature"` // Signature of file hash
}

NewInvoice attempts to submit a new invoice.

type NewInvoiceReply 

type NewInvoiceReply struct {
	CensorshipRecord www.CensorshipRecord `json:"censorshiprecord"`
}

NewInvoiceReply is used to reply to the NewInvoiceReply command.

type PayInvoices 

type PayInvoices struct{}

PayInvoices temporarily allows the administrator to set all approved invoices to paid status.

type PayInvoicesReply 

type PayInvoicesReply struct{}

PayInvoicesReply will be empty if no errors have occurred.

type Payout 

type Payout struct {
	ContractorName string           `json:"contractorname"`
	ContractorRate uint             `json:"contractorrate"` // in USD cents
	Username       string           `json:"username"`
	Month          uint             `json:"month"`        // Invoice month
	Year           uint             `json:"year"`         // Invoice year
	Token          string           `json:"token"`        // Invoice token
	Address        string           `json:"address"`      // User provided payment address
	LaborTotal     uint             `json:"labortotal"`   // in USD cents
	ExpenseTotal   uint             `json:"expensetotal"` // in USD cents
	Total          uint             `json:"total"`        // in USD cents
	BITUMTotal     bitumutil.Amount `json:"bitumtotal"`   // in BITUM atoms
	ExchangeRate   uint             `json:"exchangerate"` // in USD cents
}

Payout contains an address and an amount to be paid

type PolicyReply 

type PolicyReply struct {
	MinPasswordLength         uint     `json:"minpasswordlength"`
	MinUsernameLength         uint     `json:"minusernamelength"`
	MaxUsernameLength         uint     `json:"maxusernamelength"`
	MaxImages                 uint     `json:"maximages"`
	MaxImageSize              uint     `json:"maximagesize"`
	MaxMDs                    uint     `json:"maxmds"`
	MaxMDSize                 uint     `json:"maxmdsize"`
	ValidMIMETypes            []string `json:"validmimetypes"`
	MaxNameLength             uint     `json:"maxnamelength"`
	MinNameLength             uint     `json:"minnamelength"`
	MaxLocationLength         uint     `json:"maxlocationlength"`
	MinLocationLength         uint     `json:"minlocationlength"`
	MaxContactLength          uint     `json:"maxcontactlength"`
	MinContactLength          uint     `json:"mincontactlength"`
	MaxLineItemColLength      uint     `json:"maxlineitemcollength"`
	MinLineItemColLength      uint     `json:"minlineitemcollength"`
	InvoiceCommentChar        rune     `json:"invoicecommentchar"`
	InvoiceFieldDelimiterChar rune     `json:"invoicefielddelimiterchar"`
	InvoiceLineItemCount      uint     `json:"invoicelineitemcount"`
}

Policy for CMS

type RegisterUser 

type RegisterUser struct {
	Email             string `json:"email"`
	Username          string `json:"username"`
	Password          string `json:"password"`
	VerificationToken string `json:"verificationtoken"`
	PublicKey         string `json:"publickey"`
}

RegisterUser is used by an contractor that has been invited to join the Contractor Management System

type RegisterUserReply 

type RegisterUserReply struct{}

RegisterUserReply replies to Register with no properties, if successful.

type SetInvoiceStatus 

type SetInvoiceStatus struct {
	Token     string         `json:"token"`
	Status    InvoiceStatusT `json:"status"`
	Reason    string         `json:"reason"`
	Signature string         `json:"signature"` // Signature of Token+Version+Reason(InvoiceStatus)
	PublicKey string         `json:"publickey"` // Public key of admin
}

SetInvoiceStatus is used to approve or reject an unreviewed invoice.

type SetInvoiceStatusReply 

type SetInvoiceStatusReply struct {
	Invoice InvoiceRecord `json:"invoice"`
}

SetInvoiceStatusReply is used to reply to a SetInvoiceStatus command.

type UserInvoices 

type UserInvoices struct{}

UserInvoices is used to get all of the invoices by userID.

type UserInvoicesReply 

type UserInvoicesReply struct {
	Invoices []InvoiceRecord `json:"invoices"`
}

UserInvoicesReply is used to reply to a user invoices commands.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.