Merge pull request #18 from el-Mike/task/initial-unstable-release

task: cleanups, initial unstable release

Author: el-mike

access_request.go

@@ -6,8 +6,14 @@ type Context map[string]interface{}
 // AccessRequest - describes a Subject's intention to perform some Actions against
 // given Resource.
 type AccessRequest struct {
-	Subject  Subject
+	// Subject - subject (typically a user) that wants to perform given Actions.
+	// Needs to implement Subject interface.
+	Subject Subject
+	// Resource - resource that given Subject wants to interact with.
+	// Needs to implement Resource interface.
 	Resource Resource
-	Actions  []string
-	Context  Context
+	// Actions - list of operations Subject wants to perform on given Resource.
+	Actions []string
+	// Context - map of any additional values needed while checking Conditions.
+	Context Context
 }

actions.go

@@ -185,6 +185,17 @@ func (e *AccessDeniedError) Reason() error {
 	return e.reason
 }
 
+// FailedCondition - helper function for retrieving underlying failed Condition.
+func (e *AccessDeniedError) FailedCondition() Condition {
+	if e.reason != nil {
+		if conditionErr, ok := e.reason.(*ConditionNotSatisfiedError); ok {
+			return conditionErr.condition
+		}
+	}
+
+	return nil
+}
+
 // RequestMalformedError - thrown when AccessRequest is no correct or
 // does not contain all necessary information.
 type RequestMalformedError struct {
@@ -288,6 +299,7 @@ func (e *ConditionNotSatisfiedError) Error() string {
 	return fmt.Sprintf("Condition: \"%v\" was not satisfied! %s", e.condition.Name(), e.reason.Error())
 }
 
+// Reason - returns underlying reason (an error) of failing Condition.
 func (e *ConditionNotSatisfiedError) Reason() error {
 	return e.reason
 }

errors.go

@@ -6,9 +6,12 @@ import (
 
 // ValueDescriptor - describes a value that will be tested in its parent Condition.
 type ValueDescriptor struct {
-	Source ValueSource `json:"source"`
-	Field  string      `json:"field"`
-	Value  interface{} `json:"value"`
+	// Source - source of the value, one of the predefined enum type (ValueSource).
+	Source ValueSource `json:"source,omitempty" yaml:"source,omitempty"`
+	// Field - field on the given ValueSource that should hold the value.
+	Field string `json:"field,omitempty" yaml:"field,omitempty"`
+	// Value - explicit value used when defining ValueSource.Explicit as value source.
+	Value interface{} `json:"value,omitempty" yaml:"value,omitempty"`
 }
 
 // GetValue - returns real value represented by given ValueDescriptor.

value_descriptor.go

@@ -70,7 +70,7 @@ func (vs *ValueSource) UnmarshalJSON(jsonData []byte) error {
 	return nil
 }
 
-// UnmarshalJSON - unmarshals a string into ValueSource.
+// UnmarshalYAML - unmarshals a string into ValueSource.
 func (vs *ValueSource) UnmarshalYAML(value *yaml.Node) error {
 	var sourceName string