Merge pull request #38 from appbaseio/feat/plan-restriction

feat: Plan based access control

Author: lakhansamani

middleware/validate/plan.go

@@ -0,0 +1,32 @@
+package validate
+
+import (
+	"net/http"
+
+	"github.com/appbaseio/arc/middleware"
+	"github.com/appbaseio/arc/util"
+)
+
+// Plan returns a middleware that validates the user's plan.
+// For e.g `validate.Plan([]util.Plan{util.ArcBasic}),` restricts the route to arc-basic users.
+func Plan(restrictedPlans []util.Plan) middleware.Middleware {
+	if util.ValidatedPlans(restrictedPlans) {
+		return validPlan
+	}
+	return invalidPlan
+}
+
+// Throws the payment required error
+func invalidPlan(h http.HandlerFunc) http.HandlerFunc {
+	return func(w http.ResponseWriter, req *http.Request) {
+		msg := "This feature is not available for the " + util.Tier.String() + " plan users."
+		util.WriteBackError(w, msg, http.StatusPaymentRequired)
+	}
+}
+
+// Authorize to access the request
+func validPlan(h http.HandlerFunc) http.HandlerFunc {
+	return func(w http.ResponseWriter, req *http.Request) {
+		h(w, req)
+	}
+}

model/category/category.go

@@ -31,6 +31,7 @@ const (
 	Streams
 	Rules
 	Templates
+	Suggestions
 )
 
 // String is an implementation of Stringer interface that returns the string representation of category.Categories.
@@ -48,6 +49,7 @@ func (c Category) String() string {
 		"streams",
 		"rules",
 		"templates",
+		"suggestions",
 	}[c]
 }
 
@@ -83,6 +85,8 @@ func (c *Category) UnmarshalJSON(bytes []byte) error {
 		*c = Rules
 	case Templates.String():
 		*c = Templates
+	case Suggestions.String():
+		*c = Suggestions
 	default:
 		return fmt.Errorf("invalid category encountered: %v", category)
 	}
@@ -117,6 +121,8 @@ func (c Category) MarshalJSON() ([]byte, error) {
 		category = Rules.String()
 	case Templates:
 		category = Templates.String()
+	case Suggestions:
+		category = Suggestions.String()
 	default:
 		return nil, fmt.Errorf("invalid category encountered: %v" + c.String())
 	}

util/billing.go

@@ -21,6 +21,9 @@ var ACCAPI = "https://accapi.appbase.io/"
 // TimeValidity to be obtained from ACCAPI
 var TimeValidity int64
 
+// Tier is the value of the user's plan
+var Tier *Plan
+
 // MaxErrorTime before showing errors if invalid trial / plan in hours
 var MaxErrorTime int64 = 24 // in hrs
 
@@ -65,7 +68,7 @@ type ArcInstanceDetails struct {
 	TrialValidity        int64                  `json:"trial_validity"`
 	ArcID                string                 `json:"arc_id"`
 	CreatedAt            int64                  `json:"created_at"`
-	Tier                 string                 `json:"tier"`
+	Tier                 *Plan                  `json:"tier"`
 	TierValidity         int64                  `json:"tier_validity"`
 	TimeValidity         int64                  `json:"time_validity"`
 	Metadata             map[string]interface{} `json:"metadata"`
@@ -88,6 +91,18 @@ func BillingMiddleware(next http.Handler) http.Handler {
 	})
 }
 
+// Returns the arc instance by ID
+func getArcInstanceByID(arcID string, arcInstances []ArcInstanceDetails) ArcInstanceDetails {
+	var arcInstance ArcInstanceDetails
+	for _, instance := range arcInstances {
+		if instance.ArcID == arcID {
+			arcInstance = instance
+			break
+		}
+	}
+	return arcInstance
+}
+
 func getArcInstance(arcID string) (ArcInstance, error) {
 	arcInstance := ArcInstance{}
 	response := ArcInstanceResponse{}
@@ -109,8 +124,10 @@ func getArcInstance(arcID string) (ArcInstance, error) {
 	}
 	err = json.Unmarshal(body, &response)
 	if len(response.ArcInstances) != 0 {
-		arcInstance.SubscriptionID = response.ArcInstances[0].SubscriptionID
-		TimeValidity = response.ArcInstances[0].TimeValidity
+		arcInstanceByID := getArcInstanceByID(arcID, response.ArcInstances)
+		arcInstance.SubscriptionID = arcInstanceByID.SubscriptionID
+		TimeValidity = arcInstanceByID.TimeValidity
+		Tier = arcInstanceByID.Tier
 	} else {
 		return arcInstance, errors.New("No valid instance found for the provided ARC_ID")
 	}
@@ -148,7 +165,10 @@ func getArcClusterInstance(clusterID string) (ArcInstance, error) {
 		return arcInstance, err
 	}
 	if len(response.ArcInstances) != 0 {
-		arcInstance.SubscriptionID = response.ArcInstances[0].SubscriptionID
+		arcInstanceByID := getArcInstanceByID(clusterID, response.ArcInstances)
+		arcInstance.SubscriptionID = arcInstanceByID.SubscriptionID
+		TimeValidity = arcInstanceByID.TimeValidity
+		Tier = arcInstanceByID.Tier
 	} else {
 		return arcInstance, errors.New("No valid instance found for the provided CLUSTER_ID")
 	}
@@ -307,7 +327,7 @@ func ReportHostedArcUsage() {
 	usageBody.Quantity = NodeCount
 	response, err1 := reportClusterUsageRequest(usageBody)
 	if err1 != nil {
-		log.Println("Please contact support@appbase.io with your ARC_ID or registered e-mail address. Usage is not getting reported: ", err1)
+		log.Println("Please contact support@appbase.io with your CLUSTER_ID or registered e-mail address. Usage is not getting reported: ", err1)
 	}
 
 	// TimeValidity = response.TimeValidity

util/plans.go

@@ -0,0 +1,88 @@
+package util
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+// An enum having a list of valid plans
+type Plan int
+
+const (
+	ArcBasic Plan = iota
+	ArcEnterprise
+	HostedArcEnterprise
+	ProductionFirst
+	ProductionSecond
+	ProductionThird
+)
+
+// String is the implementation of Stringer interface that returns the string representation of Plan type.
+func (o Plan) String() string {
+	return [...]string{
+		"arc-basic",
+		"arc-enterprise",
+		"hosted-arc-enterprise",
+		"2019-production-1",
+		"2019-production-2",
+		"2019-production-3",
+	}[o]
+}
+
+// UnmarshalJSON is the implementation of the Unmarshaler interface for unmarshaling Plan type.
+func (o *Plan) UnmarshalJSON(bytes []byte) error {
+	var plan string
+	err := json.Unmarshal(bytes, &plan)
+	if err != nil {
+		return err
+	}
+	switch plan {
+	case ArcBasic.String():
+		*o = ArcBasic
+	case ArcEnterprise.String():
+		*o = ArcEnterprise
+	case HostedArcEnterprise.String():
+		*o = HostedArcEnterprise
+	case ProductionFirst.String():
+		*o = ProductionFirst
+	case ProductionSecond.String():
+		*o = ProductionSecond
+	case ProductionThird.String():
+		*o = ProductionThird
+	default:
+		return fmt.Errorf("invalid plan encountered: %v", plan)
+	}
+	return nil
+}
+
+// MarshalJSON is the implementation of the Marshaler interface for marshaling Plan type.
+func (o Plan) MarshalJSON() ([]byte, error) {
+	var plan string
+	switch o {
+	case ArcBasic:
+		plan = ArcBasic.String()
+	case ArcEnterprise:
+		plan = ArcEnterprise.String()
+	case HostedArcEnterprise:
+		plan = HostedArcEnterprise.String()
+	case ProductionFirst:
+		plan = ProductionFirst.String()
+	case ProductionSecond:
+		plan = ProductionSecond.String()
+	case ProductionThird:
+		plan = ProductionThird.String()
+	default:
+		return nil, fmt.Errorf("invalid plan encountered: %v", o)
+	}
+	return json.Marshal(plan)
+}
+
+// A util function to validate the user's plan against the restricted plans
+func ValidatedPlans(restrictedPlans []Plan) bool {
+	for _, restrictedPlan := range restrictedPlans {
+		if Billing == "true" && Tier.String() == restrictedPlan.String() {
+			return false
+		}
+	}
+	return true
+}