Merge pull request #96 from optimizely/fm-beta

Author: Michael Ng

.golangci.yml

@@ -0,0 +1,72 @@
+linters-settings:
+ govet:
+   check-shadowing: true
+ golint:
+   min-confidence: 0
+ gocyclo:
+   min-complexity: 16
+ maligned:
+   suggest-new: true
+ dupl:
+   threshold: 100
+ goconst:
+   min-len: 2
+   min-occurrences: 2
+ misspell:
+   locale: US
+ lll:
+   line-length: 140
+ gocritic:
+   enabled-tags:
+     - performance
+     - style
+     - experimental
+   disabled-checks:
+     - wrapperFunc
+     - hugeParam
+     - rangeValCopy
+
+linters:
+ disable-all: true
+ enable:
+   - megacheck
+   - golint
+   - govet
+   - unconvert
+   - megacheck
+   - structcheck
+   - gas
+   - gocyclo
+   - dupl
+   - misspell
+   - unparam
+   - varcheck
+   - deadcode
+   - typecheck
+   - ineffassign
+   - varcheck
+   - stylecheck
+   #- gochecknoinits
+   - scopelint
+   - gocritic
+   - golint
+   - nakedret
+   - gosimple
+   - prealloc 
+   - maligned
+ fast: false
+
+run:
+ skip-dirs:
+   - vendor
+ concurrency: 4
+
+issues:
+ exclude-rules:
+   - text: "weak cryptographic primitive"
+     linters:
+       - gosec
+ exclude-use-default: false
+
+service:
+ golangci-lint-version: 1.17.x

.travis.yml

@@ -1,3 +1,6 @@
+env:
+  - GO111MODULE=on
+
 language: go
 go:
   - 1.12.x
@@ -6,18 +9,20 @@ before_install:
   - go get github.com/mattn/goveralls
 git:
   depth: 1
-
-before_script:
-  - go get -u golang.org/x/lint/golint
 script:
-  - golint ./...
   - go test -v -race ./... -coverprofile=profile.cov
   - $GOPATH/bin/goveralls -coverprofile=profile.cov -service=travis-ci
 stages:
+  - 'Lint'
   - 'Integration tests'
   - 'Test'
 jobs:
   include:
+    - stage: 'Lint'
+      install:
+        - go get github.com/golangci/golangci-lint/cmd/golangci-lint
+      script:
+        - golangci-lint run --out-format=tab --tests=false optimizely/...
     - stage: 'Integration Tests'
       merge_mode: replace
       env: SDK=go
@@ -29,4 +34,4 @@ jobs:
       script:
         - "$HOME/travisci-tools/fsc-trigger/trigger_fullstack-sdk-compat.sh"
       after_success: travis_terminate 0
-      
+

README.md

@@ -53,8 +53,14 @@ Usage:
   go-sdk [command]
 
 Available Commands:
-  help               Help about any command
-  is_feature_enabled Is feature enabled?
+  help                          Help about any command
+  is_feature_enabled            Is feature enabled?
+  get_enabled_features          Get enabled features
+  track                         Track a conversion event
+  get_feature_variable_boolean  Get feature variable boolean value
+  get_feature_variable_double   Get feature variable double value
+  get_feature_variable_integer  Get feature variable integer value
+  get_feature_variable_string   Get feature variable string value
 
 Flags:
   -h, --help            help for go-sdk
@@ -80,11 +86,30 @@ cd $GOPATH/src/github.com/optimizely/go-sdk
 go install
 ```
 
+NOTE:
+We practice trunk-based development, and as such our default branch, `master` might not always be the most stable. We do tag releases on Github and you can pin your installation to those particular release versions. One way to do this is to use [*Go Modules*](https://blog.golang.org/using-go-modules) for managing external dependencies:
+
+```
+module mymodule
+
+go 1.12
+
+require (
+	github.com/optimizely/go-sdk v0.1.0
+)
+```
+
+If you are already using `go.mod` in your application you can run the following:
+
+```
+go mod edit -require github.com/optimizely/[email protected]
+```
+
 NOTE:
 ```$sh
 go get github.com/optimizely/go-sdk/...
 ```
-or 
+or
 ```$sh
 go get github.com/optimizely/go-sdk/optimizely
 ```
@@ -108,6 +133,105 @@ Global Flags:
   -s, --sdkKey string   Optimizely project SDK key
   ```
 
+#### get_enabled_features
+```
+Returns enabled features for userId
+
+Usage:
+  go-sdk get_enabled_features [flags]
+
+Flags:
+  -h, --help                help for get_enabled_features
+  -u, --userId string       user id
+
+Global Flags:
+  -s, --sdkKey string   Optimizely project SDK key
+  ```
+
+#### track
+```
+Tracks a conversion event
+
+Usage:
+  go-sdk track [flags]
+
+Flags:
+  -e, --eventKey string     event key to track
+  -h, --help                help for track
+  -u, --userId string       user id
+
+Global Flags:
+  -s, --sdkKey string   Optimizely project SDK key
+  ```
+
+#### get_feature_variable_boolean
+```
+Returns feature variable boolean value
+
+Usage:
+  go-sdk get_feature_variable_boolean [flags]
+
+Flags:
+  -f, --featureKey string   feature key for feature
+  -v, --variableKey string  variable key for feature variable
+  -h, --help                help for get_feature_variable_boolean
+  -u, --userId string       user id
+
+Global Flags:
+  -s, --sdkKey string   Optimizely project SDK key
+  ```
+
+#### get_feature_variable_double
+```
+Returns feature variable double value
+
+Usage:
+  go-sdk get_feature_variable_double [flags]
+
+Flags:
+  -f, --featureKey string   feature key for feature
+  -v, --variableKey string  variable key for feature variable
+  -h, --help                help for get_feature_variable_double
+  -u, --userId string       user id
+
+Global Flags:
+  -s, --sdkKey string   Optimizely project SDK key
+  ```
+
+#### get_feature_variable_integer
+```
+Returns feature variable integer value
+
+Usage:
+  go-sdk get_feature_variable_integer [flags]
+
+Flags:
+  -f, --featureKey string   feature key for feature
+  -v, --variableKey string  variable key for feature variable
+  -h, --help                help for get_feature_variable_integer
+  -u, --userId string       user id
+
+Global Flags:
+  -s, --sdkKey string   Optimizely project SDK key
+  ```
+
+#### get_feature_variable_string
+```
+Returns feature variable string value
+
+Usage:
+  go-sdk get_feature_variable_string [flags]
+
+Flags:
+  -f, --featureKey string   feature key for feature
+  -v, --variableKey string  variable key for feature variable
+  -h, --help                help for get_feature_variable_string
+  -u, --userId string       user id
+
+Global Flags:
+  -s, --sdkKey string   Optimizely project SDK key
+  ```
+
 ## Credits
 
 This software is distributed with code from the following open source projects:

cmd/get_enabled_features.go

@@ -0,0 +1,57 @@
+/****************************************************************************
+ * 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 cmd
+
+import (
+	"fmt"
+
+	"github.com/optimizely/go-sdk/optimizely/client"
+	"github.com/optimizely/go-sdk/optimizely/entities"
+	"github.com/spf13/cobra"
+)
+
+var getEnabledFeaturesCmd = &cobra.Command{
+	Use:   "get_enabled_features",
+	Short: "Get enabled features",
+	Long:  `Returns enabled features`,
+	Run: func(cmd *cobra.Command, args []string) {
+		optimizelyFactory := &client.OptimizelyFactory{
+			SDKKey: sdkKey,
+		}
+
+		client, err := optimizelyFactory.StaticClient()
+
+		if err != nil {
+			fmt.Printf("Error instantiating client: %s\n", err)
+			return
+		}
+
+		user := entities.UserContext{
+			ID:         userID,
+			Attributes: map[string]interface{}{},
+		}
+
+		features, _ := client.GetEnabledFeatures(user)
+		fmt.Printf("Enabled features for \"%s\": %v\n", userID, features)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(getEnabledFeaturesCmd)
+	getEnabledFeaturesCmd.Flags().StringVarP(&userID, "userId", "u", "", "user id")
+	getEnabledFeaturesCmd.MarkFlagRequired("userId")
+}

cmd/get_feature_variable_boolean.go

@@ -0,0 +1,65 @@
+/****************************************************************************
+ * 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 cmd
+
+import (
+	"fmt"
+
+	"github.com/optimizely/go-sdk/optimizely/client"
+	"github.com/optimizely/go-sdk/optimizely/entities"
+	"github.com/spf13/cobra"
+)
+
+var getFeatureVariableBooleanCmd = &cobra.Command{
+	Use:   "get_feature_variable_boolean",
+	Short: "Get feature variable boolean",
+	Long:  `Returns boolean feature variable`,
+	Run: func(cmd *cobra.Command, args []string) {
+		optimizelyFactory := &client.OptimizelyFactory{
+			SDKKey: sdkKey,
+		}
+
+		client, err := optimizelyFactory.StaticClient()
+
+		if err != nil {
+			fmt.Printf("Error instantiating client: %s\n", err)
+			return
+		}
+
+		user := entities.UserContext{
+			ID:         userID,
+			Attributes: map[string]interface{}{},
+		}
+
+		value, _ := client.GetFeatureVariableBoolean(featureKey, variableKey, user)
+		if err == nil {
+			fmt.Printf("Feature \"%s\" variable \"%s\" boolean value: %t\n", featureKey, variableKey, value)
+		} else {
+			fmt.Printf("Get feature \"%s\" variable \"%s\" boolean failed with error: %s\n", featureKey, variableKey, err)
+		}
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(getFeatureVariableBooleanCmd)
+	getFeatureVariableBooleanCmd.Flags().StringVarP(&userID, "userId", "u", "", "user id")
+	getFeatureVariableBooleanCmd.MarkFlagRequired("userId")
+	getFeatureVariableBooleanCmd.Flags().StringVarP(&featureKey, "featureKey", "f", "", "feature key for feature")
+	getFeatureVariableBooleanCmd.MarkFlagRequired("featureKey")
+	getFeatureVariableBooleanCmd.Flags().StringVarP(&variableKey, "variableKey", "v", "", "variable key for feature variable")
+	getFeatureVariableBooleanCmd.MarkFlagRequired("variableKey")
+}