feat(api): Add top-level wrapper for more convenient usage.

examples/main.go

@@ -7,29 +7,37 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/optimizely/go-sdk"
 	"github.com/optimizely/go-sdk/pkg/client"
 	"github.com/optimizely/go-sdk/pkg/entities"
-	"github.com/optimizely/go-sdk/pkg/event"
+	"github.com/optimizely/go-sdk/pkg/events"
 	"github.com/optimizely/go-sdk/pkg/logging"
 )
 
 func main() {
 	sdkKey := "4SLpaJA1r1pgE6T2CoMs9q"
 	logging.SetLogLevel(logging.LogLevelDebug)
-	user := entities.UserContext{
-		ID: "mike ng",
-		Attributes: map[string]interface{}{
+
+	/************* Simple usage ********************/
+
+	user := optimizely.UserContext(
+		"mike ng",
+		map[string]interface{}{
 			"country":      "Unknown",
 			"likes_donuts": true,
 		},
-	}
+	)
+	optimizelyClient, _ := optimizely.Client(sdkKey)
+	enabled, _ := optimizelyClient.IsFeatureEnabled("mutext_feat", user)
+	fmt.Printf("Is feature enabled? %v\n", enabled)
+
+	/************* StaticClient ********************/
+
 	optimizelyFactory := &client.OptimizelyFactory{
 		SDKKey: sdkKey,
 	}
 
-	/************* StaticClient ********************/
-
-	optimizelyClient, err := optimizelyFactory.StaticClient()
+	optimizelyClient, err = optimizelyFactory.StaticClient()
 
 	if err != nil {
 		fmt.Printf("Error instantiating client: %s", err)
@@ -42,6 +50,7 @@ func main() {
 	fmt.Println()
 	optimizelyClient.Close() //  user can close dispatcher
 	fmt.Println()
+
 	/************* Client ********************/
 
 	optimizelyFactory = &client.OptimizelyFactory{

main.go

@@ -14,10 +14,11 @@
  * limitations under the License.                                           *
  ***************************************************************************/
 
-package main
+package optimizely
 
 import "github.com/optimizely/go-sdk/cmd"
 
+// This is used to execute the command-line tool when running the `go-sdk` command from the command-line.
 func main() {
 	cmd.Execute()
 }

optimizely.go

@@ -0,0 +1,38 @@
+/****************************************************************************
+ * Copyright 2019, Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ *    http://www.apache.org/licenses/LICENSE-2.0                            *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ***************************************************************************/
+
+package optimizely
+
+import (
+	"github.com/optimizely/go-sdk/pkg/client"
+	"github.com/optimizely/go-sdk/pkg/entities"
+)
+
+// Client returns an OptimizelyClient instantitated with the given key and options
+func Client(sdkKey string, options ...client.OptionFunc) (*client.OptimizelyClient, error) {
+	factory := &client.OptimizelyFactory{
+		SDKKey: sdkKey,
+	}
+	return factory.Client(options...)
+}
+
+// UserContext is a helper method for creating a user context
+func UserContext(userID string, attributes map[string]interface{}) entities.UserContext {
+	return entities.UserContext{
+		ID: userID,
+		Attributes: attributes,
+	}
+}

pkg/client/factory.go

@@ -41,7 +41,7 @@ type OptimizelyFactory struct {
 	overrideStore      decision.ExperimentOverrideStore
 }
 
-// OptionFunc is a type to a proper func
+// OptionFunc is used to provide custom client configuration to the OptimizelyFactory
 type OptionFunc func(*OptimizelyFactory)
 
 // Client gets client and sets some parameters