Initial commit with partial functionality

Author: tjj5036

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2016 Optimizely
+
+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.

README.md

@@ -0,0 +1,4 @@
+# Goptimizely
+
+Optimizely Server Side SDK.... in Go.
+

examples/main.go

@@ -0,0 +1,11 @@
+package main
+
+import (
+	"github.com/optimizely/go-sdk/optimizely"
+)
+
+func main() {
+	OPTIMIZELY_ACCOUNT_ID := 12345
+	buffer := optimizely.FetchProjectConfig(OPTIMIZELY_ACCOUNT_ID)
+	optimizely.DeserializeConfigBuffer(buffer)
+}

optimizely/doc.go

@@ -0,0 +1 @@
+package optimizely

optimizely/entities.go

@@ -0,0 +1,58 @@
+package optimizely
+
+type AttributeEntity struct {
+	Id        string `json:"id"`
+	Key       string `json:"key"`
+	Value     string `json:"value"`
+	SegmentId string `json:"segmentId"`
+}
+
+type AudienceEntity struct {
+	Id         string `json:"id"`
+	Name       string `json:"name"`
+	Conditions string `json:"conditions"`
+}
+
+type VariationEntity struct {
+	Id         string `json:"id"`
+	Key        string `json:"key"`
+	EndOfRange int    `json:"endOfRange"`
+}
+
+type TrafficAllocationEntity struct {
+	EntityId   string `json:"entityId"`
+	EndOfRange int    `json:"endOfRange"`
+}
+
+type ExperimentEntity struct {
+	Id                 string                    `json:"id"`
+	Key                string                    `json:"key"`
+	Status             string                    `json:"status"`
+	Variations         []VariationEntity         `json:"variations"`
+	PercentageIncluded int                       `json:"percentageIncluded"`
+	TrafficAllocation  []TrafficAllocationEntity `json:"trafficAllocation"`
+	AudienceIds        []string                  `json:"audienceIds"`
+}
+
+type EventEntity struct {
+	Id            string   `json:"id"`
+	Key           string   `json:"key"`
+	ExperimentIds []string `json:"experimentIds"`
+}
+
+type DimensionEntity struct {
+	Id        string `json:"id"`
+	Key       string `json:"key"`
+	SegmentId string `json:"segmentId"`
+}
+
+type ProjectConfig struct {
+	AccountId   string             `json:"accountId"`
+	ProjectId   string             `json:"projectId"`
+	Revision    string             `json:"revision"`
+	Experiments []ExperimentEntity `json:"experiments"`
+	Events      []EventEntity      `json:"events"`
+	Dimensions  []DimensionEntity  `json:"dimensions"`
+	Attributes  []AttributeEntity  `json:"attributes"`
+	Audiences   []AudienceEntity   `json:"audiences"`
+}

optimizely/event.go

@@ -0,0 +1,22 @@
+package optimizely
+
+var OFFLINE_API_PATH = "https://%v.log.optimizely.com/event" // project_id
+var END_USER_ID_TEMPLATE = "oeu-%v"                          // user_id
+var REQUEST_TIMEOUT = 10
+
+const (
+	ACCOUNT_ID  = "d"
+	PROJECT_ID  = "a"
+	EXPERIMENT  = "x"
+	GOAL_ID     = "g"
+	GOAL_NAME   = "n"
+	SEGMENT     = "s"
+	END_USER_ID = "u"
+	REVENUE     = "v"
+	SOURCE      = "src"
+	TIME        = "time"
+)
+
+func DispatchEvent() {
+
+}

optimizely/optimizely.go

@@ -0,0 +1,74 @@
+package optimizely
+
+import (
+	"fmt"
+	"net/url"
+)
+
+// Track tracks a conversion event for a user_id
+// Logs the conversion
+// event_key: goal key representing the event which needs to be recorded
+// user_id: ID for user.
+// attributes: Dict representing visitor attributes and values which need to be recorded.
+// event_value: Value associated with the event. Can be used to represent revenue in cents.
+func Track(
+	event_key string,
+	user_id string,
+	attributes []AttributeEntity,
+	event_value string,
+	project_config ProjectConfig) {
+
+	var Url *url.URL
+	Url, err := url.Parse("http://www.example.com")
+	if err != nil {
+		panic("boom")
+	}
+
+	end_user_id := fmt.Sprintf(END_USER_ID_TEMPLATE, user_id)
+	goal_id := GetGoalIdFromProjectConfig(event_key, project_config)
+
+	// build string to make GET request with
+	parameters := url.Values{}
+	parameters.Add(ACCOUNT_ID, project_config.AccountId)
+	parameters.Add(PROJECT_ID, project_config.ProjectId)
+	parameters.Add(GOAL_NAME, event_key)
+	parameters.Add(GOAL_ID, goal_id)
+	parameters.Add(END_USER_ID, end_user_id)
+
+	// Set experiment and corresponding variation
+	BuildExperimentVariationParams(
+		project_config, event_key, project_config.Experiments, user_id, parameters)
+
+	// Set attribute params if any
+	if len(attributes) > 0 {
+		BuildAttributeParams(project_config, attributes, parameters)
+	}
+
+	// Set event_value if set and also append the revenue goal ID
+	if len(event_value) != 0 {
+		parameters.Add(REVENUE, event_value)
+		//parameters.Add(GOAL_ID, fmt.Sprintf("{%v},{%v}", goal_id, GetRevenueGoalFromProjectConfig())
+	}
+
+	// Dispatch event
+	Url.RawQuery = parameters.Encode()
+	tracking_url := Url.String()
+	fmt.Print(tracking_url)
+
+}
+
+// Activate buckets visitor and sends impression event to Optimizely
+// Activate Logs the impression
+// experiment_key: experiment which needs to be activated
+// user_id: ID for user
+// attributes: optional list representing visitor attributes and values
+func Activate(experiment_key string, user_id string, attributes []AttributeEntity) {
+
+}
+
+// GetVariation gets the variation where the visitor will be bucketed
+// Experiment_key: experiment which needs to be activated
+// User_id: ID for user
+func GetVariation(experient_key string, user_id string) {
+
+}

optimizely/project_config.go

@@ -0,0 +1,49 @@
+package optimizely
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"log"
+	"net/http"
+)
+
+var PROJECT_CONFIG_LINK_TEMPLATE = "https://cdn.optimizely.com/json/%v.json"
+
+// FetchConfig retrieves a JSON file from the Optimizely CDN
+// and returns it accordingly
+func FetchProjectConfig(project_id int) bytes.Buffer {
+	var b bytes.Buffer
+
+	var project_config_url = fmt.Sprintf(PROJECT_CONFIG_LINK_TEMPLATE, project_id)
+	resp, err := http.Get(project_config_url)
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		log.Printf("Status code of %v when fetching project config", resp.StatusCode)
+	}
+	if err != nil {
+		log.Printf("Error fetching project config: %v", err)
+		return b
+	}
+
+	_, err = b.ReadFrom(resp.Body)
+	if err != nil {
+		log.Printf("Error reading JSON response into a buffer")
+	}
+	return b
+}
+
+// DeserializeConfigBuffer takes a buffer containing a JSON response
+// from the Optimizely CDN and converts it to a ProjectConfig entity
+// which gets returned
+func DeserializeConfigBuffer(b bytes.Buffer) ProjectConfig {
+	var project_config = ProjectConfig{}
+	r := bytes.NewReader(b.Bytes())
+	err := json.NewDecoder(r).Decode(&project_config)
+	if err != nil {
+		log.Print(err)
+		return project_config
+	}
+	return project_config
+}

optimizely/utils.go

@@ -0,0 +1,87 @@
+package optimizely
+
+import (
+	"fmt"
+	"net/url"
+)
+
+// GetGoalIdFromProjectConfig returns the goal that matches the event key
+// The wording here is a bit confusing
+func GetGoalIdFromProjectConfig(event_key string, project_config ProjectConfig) string {
+	for i := 0; i < len(project_config.Events); i++ {
+		if project_config.Events[i].Key == event_key {
+			return project_config.Events[i].Id
+		}
+	}
+	return ""
+}
+
+// Get segment Id for the provided attribute key
+// project_config: the project_Config
+// attributes: the attributes to search through
+// attribute_key: the attribute key for which segment ID is to be determined
+func GetSementId(project_config ProjectConfig, attributes []AttributeEntity, attribute_key string) string {
+	for i := 0; i < len(attributes); i++ {
+		if attributes[i].Key == attribute_key {
+			return attributes[i].SegmentId
+		}
+	}
+	return ""
+}
+
+// BuildAttributeParams adds attribute parameters to the URL Value Map
+func BuildAttributeParams(
+	project_config ProjectConfig,
+	attributes []AttributeEntity,
+	parameters url.Values) {
+	for i := 0; i < len(attributes); i++ {
+		segment_id := GetSementId(project_config, attributes, attributes[i].Key)
+		if len(segment_id) > 0 {
+			parameters.Add(fmt.Sprintf("{%v}{%v}", SEGMENT, segment_id), attributes[i].Value)
+		}
+	}
+}
+
+// Checks the status of an Experiment to see if its running or not
+// This could be a one liner but the `Status` field will most likely
+// grow and require a switch or something.
+func experiment_is_running(experiment ExperimentEntity) bool {
+	if experiment.Status != "Running" {
+		return true
+	}
+	return false
+}
+
+// Get experiment IDs for the provided goal key
+func GetExperimentIdsForGoal(events []EventEntity, goal_key string) []string {
+	for i := 0; i < len(events); i++ {
+		if events[i].Key == goal_key {
+			return events[i].ExperimentIds
+		}
+	}
+	var empty_list []string
+	return empty_list
+}
+
+// BuildExperimentVariationParams maps experiment and corresponding variation as parameters
+func BuildExperimentVariationParams(
+	project_config ProjectConfig,
+	event_key string,
+	experiments []ExperimentEntity,
+	user_id string,
+	parameters url.Values) {
+
+	for i := 0; i < len(experiments); i++ {
+		if !experiment_is_running(experiments[i]) {
+			continue
+		}
+		experiment_id := experiments[i].Id
+		experiment_ids := GetExperimentIdsForGoal(project_config.Events, event_key)
+		for j := 0; j < len(experiment_ids); j++ {
+			if experiment_ids[j] == experiment_id {
+				continue
+				//variation_id := GetVariation(experiments[i].Key)
+			}
+		}
+	}
+}