web

type All ¶

type All []IDAndNamerFilter

All is an IDAndNamerFilter that requires all its inner filters evaluate to true.

func (a All) Filter(ian IDAndNamer) bool

type Any ¶

type Any []IDAndNamerFilter

Any requires only one of its inner filters to evaluate to true

func (a Any) Filter(ian IDAndNamer) bool

type Archive ¶

type Archive struct {
	ArchiveID   int64  `json:"Id"`
	ArchiveName string `json:"Name"`
	Parent      int64  `json:"Parent"`
	Permissions int64  `json:"Permissions"`
	Properties  int64  `json:"Properties"`
}

Archive in Square 9

func (a *Archive) ID() ID

func (a *Archive) Name() Name

func (a *Archive) PathSegments() []string

type Archives ¶

type Archives struct {
	Archives []Archive `json:"Archives"`
}

Archives is a useless outer wrapper around the response that comes from getting a list of archives from Square 9

type Body ¶

type Body interface {
	// WriteTo the *http.Request's body before sending to the server
	WriteTo(w io.Writer) (n int64, err error)

	// ReadFrom the *http.Response back from the server.
	ReadFrom(r io.Reader) (n int64, err error)
}

Body is the body of a request or response.

type Client ¶

type Client interface {
	// Close the client and release the license(s) it's consuming.
	Close() error

	// Session gets a session from the client and passes it into function f
	// as a parameter.  Neither the session nor any intermediate API
	// objects may be stored outside of f's scope (e.g. via closure).
	//
	// Many API objects are bound to a single session.  Calling Session
	// does not guarantee (or even try) to give you the same session, so
	// you should do all of your work that you want to do with the session
	// while you have it and only return the final result.
	Session(context.Context, func(context.Context, *Session) error) error
}

Client interacts with the Square 9 REST API.

type Database ¶

type Database struct {
	DatabaseID   int64  `json:"Id"`
	DatabaseName string `json:"Name"`
}

Database defines a Square 9 database

func (d *Database) ID() ID

func (d *Database) Name() Name

func (d *Database) PathSegments() []string

type Databases ¶

type Databases struct {
	Databases []Database `json:"Databases"`
}

Databases is a useless outer wrapper around the response that comes from getting a list of databases from Square 9

type Document ¶

type Document struct {
	DocumentID      int64 `json:"Id"`
	Hash            string
	TID             int64
	Fields          []FieldVal
	Version         int64
	RootVersionID   int64
	Username        string `json:"User_Name"`
	Hits            int64
	Permissions     uint64
	RevisionOptions int64
	FileType        string
}

Document as returned by search results

func (d *Document) PathSegments() []string

type DocumentOption ¶

type DocumentOption string

DocumentOption is included in the call to Client.Document to specify the requested format of the document.

const (
	// FileOption Returns the requested file
	FileOption DocumentOption = "File"

	// EmailOption Returns a ready-to-email version of the document
	EmailOption DocumentOption = "Email"

	// Print64Option Returns a ready-to-print64 version of the document
	Print64Option DocumentOption = "Print64"

	// ThumbOption Returns a thumbnail of the document
	ThumbOption DocumentOption = "Thumb"

	// ZoneOption ---data missing---
	ZoneOption DocumentOption = "Zone"
)

type FieldDef ¶

type FieldDef struct {
	FieldID   int64  `json:"ID"`
	FieldName string `json:"Name"`
	List      int64
	Type      FieldType
	Mask      string
	Size      int64
	RegEx     string
	Prop      FieldProps
	Parent    int64
	ListF1    int64
	ListF2    int64
}

FieldDef is the definition of an Archive field.

func (f *FieldDef) ID() ID

func (f *FieldDef) Name() Name

type FieldProps ¶

type FieldProps uint64

FieldProps is a bit mask describing the properties of fields.

const (
	// Required indicates that the field is required
	Required FieldProps = 2

	// SystemFieldDateEntered indicates that the field is a system field
	// storing the date that the document was stored.
	SystemFieldDateEntered FieldProps = 4 // System Field: Date Entered

	// SystemFieldIndexedBy indicates that the field stores the username
	// of the person who indexed the document
	SystemFieldIndexedBy FieldProps = 8 // System Field: Indexed By

	// SystemFieldPageCount stores the page count of the document
	SystemFieldPageCount FieldProps = 16 // System Field: Page Count

	// MultiValueField indicates that the field accepts more than one
	// value
	MultiValueField FieldProps = 32 // Multi-Value Field

	// FieldContainsDropdownList indicates that the field has a static
	// drop-down list
	FieldContainsDropdownList FieldProps = 64 // Field contains drop-down list

	// FieldContainsDynamicList indicates that the field has a dynamic
	// drop-down list.
	FieldContainsDynamicList FieldProps = 128 // Field contains dynamic list

	// SystemFieldLastModifiedBy indicates that the field holds the name
	// of the user that last modified the document.
	SystemFieldLastModifiedBy FieldProps = 256 // System Field: Last Modified By

	// TableField indicates that the field is a member of a table.
	TableField FieldProps = 512 // Table Field

	// SystemFieldFileType holds the file type of the document
	SystemFieldFileType FieldProps = 1024 // System Field: File Type

	// SystemFieldReadOnly indicates that the field is read-only.
	SystemFieldReadOnly FieldProps = 2048 // System Field: Read-only
)

type FieldType ¶

type FieldType int64

FieldType indicates the data type of the field.

const (
	// InvalidFieldType indicates an invalid field type
	InvalidFieldType FieldType = 0 // Invalid

	// CharacterField indicates that the field stores character data
	CharacterField FieldType = 1 // Character

	// IntegerField indicates that the field stores int64eger data
	IntegerField FieldType = 2 // Integer

	// DateTimeField indicates that the field stores date or date/time
	// data
	DateTimeField FieldType = 3 // DateTime

	// DecimalField indicates that the field stores decimal data
	DecimalField FieldType = 4 // Decimal
)

type FieldVal ¶

type FieldVal struct {
	FieldID    int64         `json:"ID"`
	Value      string        `json:"VAL"`
	MultiValue []interface{} `json:"MVAL"`
}

FieldVal is a field value within a Document.

type File ¶

type File struct {
	Name      string      `json:"name"`
	IsEmail   bool        `json:"isEmail"`
	EmailData interface{} `json:"oEmailData"`
	Test      interface{} `json:"test"`
}

File is a temporary file created by posting an upload to the "WebPortalCache"

type HTTPMethod ¶

type HTTPMethod string

HTTPMethod is a type-safe HTTP method

const (
	// DELETE HTTP method
	DELETE HTTPMethod = http.MethodDelete

	// GET HTTP method
	GET HTTPMethod = http.MethodGet

	// POST HTTP method
	POST HTTPMethod = http.MethodPost
)

type ID ¶

type ID int64

ID of a Square 9 metadata object

func (f ID) Filter(ian IDAndNamer) bool

type IDAndNamer ¶

type IDAndNamer interface {
	ID() ID
	Name() Name
}

IDAndNamer is implemented by most metadata objects in the Square 9 API. It lets some functionality in this wrapping API work "genericaly."

type IDAndNamerFilter ¶

type IDAndNamerFilter interface {
	Filter(ian IDAndNamer) bool
}

IDAndNamerFilter provides a predicate for IDAndNamers so they can be filtered

type ImportDocument ¶

type ImportDocument struct {
	Fields []ImportField `json:"fields"`
	Files  []ImportFile  `json:"files"`
}

ImportDocument is a completely different layout from the Update layout to import a document that has already been uploaded to the cache.

type ImportField ¶

type ImportField struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

ImportField is a completely different layout from FieldVal that's used when importing a new document.

type ImportFile ¶

type ImportFile struct {
	Name string `json:"name"`
}

ImportFile is used in ImportDocument to specify one or more files uploaded to the WebPortalCache.

type License ¶

type License struct {
	Username     string    `json:"Username"`
	Domain       string    `json:"Domain"`
	AuthServer   string    `json:"AuthServer"`
	Type         int64     `json:"Type"`
	IPAddress    string    `json:"IPAddress"`
	DateCreated  time.Time `json:"DateCreated"`
	DateAccessed time.Time `json:"DateAccessed"`
	Token        uuid.UUID `json:"Token"`
	Reg          int64     `json:"Reg"`
}

License is returned when requesting a license from Square 9

type Name ¶

type Name string

Name of a Square 9 metadata object

func (f Name) Filter(ian IDAndNamer) bool

type Operator ¶

type Operator int64

const (
	UnknownOperator Operator = iota
	Equals
)

type Prompt ¶

type Prompt struct {
	PromptID int64 `json:"ID"`
	FieldID  int64 `json:"FID"`
	ListID   int64
	Parent   int64
	Operator Operator
	Prompt   string
	Value    string `json:"VAL"`
	Prop     int64
}

Prompt is a single prompt in a Search.

func (p *Prompt) ID() ID

func (p *Prompt) Name() Name

type RWClient ¶

type RWClient struct {
	// contains filtered or unexported fields
}

RWClient maintains two client implementations: one for read-only access and another for read-write access. By default, when implementing the Client interface, the full-access implementation is used.

func NewRWClient(readOnly, fullAccess Client, defaultReadOnly bool) *RWClient

func (c *RWClient) FullAccess() Client

func (c *RWClient) ReadOnly() Client

func (c *RWClient) Session(ctx context.Context, f func(context.Context, *Session) error) error

type ReaderBody ¶

type ReaderBody struct {
	io.Reader
}

ReaderBody implements io.WriterTo by copying to the reader.

func (b ReaderBody) WriteTo(w io.Writer) (int64, error)

type RequestOption ¶

type RequestOption func(r *request) error

RequestOption configures a Square 9 request.

func ContentType(t string) RequestOption

func Method(m HTTPMethod) RequestOption

func Path(segments ...interface{}) RequestOption

func RequestBody(wt io.WriterTo) RequestOption

func ResponseBody(rf io.ReaderFrom) RequestOption

func SecureID(hash string) RequestOption

func Value(k string, vs ...interface{}) RequestOption

type Results ¶

type Results struct {
	Fields []FieldDef
	Docs   []Document
	Count  int64
}

Results are returned by searches

type Search ¶

type Search struct {
	Archives   []Archive
	SearchID   int64  `json:"Id"`
	SearchName string `json:"Name"`
	Parent     int64
	Hash       string
	Detail     []Prompt
	Props      int64
	Fuzzy      int64
	Grouping   string
	Settings   int64
}

Search in a Database.

func (s *Search) ID() ID

func (s *Search) Name() Name

func (s *Search) PathSegments() []string

type SearchCriterion ¶

type SearchCriterion struct {
	// Prompt ID or text for the search criterion.
	Prompt IDAndNamerFilter

	// Value to use for the search.
	Value interface{}
}

SearchCriterion is a single search parameter

type Session ¶

type Session struct {
	// contains filtered or unexported fields
}

Session is an implementation of the Client interface for a single user.

func NewSession(ctx context.Context, options ...SessionOption) (*Session, error)

func (s *Session) Archives(ctx context.Context, d *Database, f IDAndNamerFilter) (ars []Archive, err error)

func (s *Session) Close() error

func (s *Session) Databases(ctx context.Context, f IDAndNamerFilter) (ds []Database, err error)

func (s *Session) DeleteDocument(ctx context.Context, d *Database, a *Archive, doc *Document) error

func (s *Session) Document(ctx context.Context, d *Database, a *Archive, doc *Document, o DocumentOption, rf io.ReaderFrom) error

func (s *Session) Fields(ctx context.Context, d *Database, a *Archive, f IDAndNamerFilter) (fds []FieldDef, err error)

func (s *Session) Import(ctx context.Context, d *Database, a *Archive, ifs []ImportField, wts ...io.WriterTo) (Err error)

func (s *Session) Search(ctx context.Context, d *Database, a *Archive, sr *Search, fs []SearchCriterion, rs *Results, options ...RequestOption) error

func (s *Session) Searches(ctx context.Context, d *Database, a *Archive, f IDAndNamerFilter) (srs []Search, err error)

func (s *Session) Session(ctx context.Context, f func(context.Context, *Session) error) error

type SessionOption ¶

type SessionOption func(s *Session) error

SessionOption configures a session

func APIURL(u *url.URL) SessionOption

func APIURLString(u string) SessionOption

func BasicAuth(username, password string) SessionOption

func HTTPClient(h *http.Client) SessionOption

type SessionPool ¶

type SessionPool struct {
	// contains filtered or unexported fields
}

SessionPool is a pool of individual sessions. Sessions are not safe for concurrent use but SessionPools are.

Implementation notes:

The implementation is too complicated but I don't yet know what to do about it. I'm open to suggestions!

The sessions field is initialized with a capacity equal to the limit value passed to NewSessionPool. The limit field also gets this capacity. No sessions are created initialy; not until the first call to Session is made. There, we try to get from the sessions channel (and fail the first time) so we create a new session. If using the session succeeds, it is put into the channel so a future attempt through the "fast path" (receive from the sessions channel) succeeds. If usage of the session returns an error

func NewSessionPool(limit int, factory func(context.Context) (*Session, error)) *SessionPool

func (p *SessionPool) Close() error

func (p *SessionPool) Session(ctx context.Context, f func(context.Context, *Session) error) error