optimizely-sdk 3.2.0 → 3.3.0

data/lib/optimizely/event/entity/conversion_event.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely 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.
+#
+require_relative 'user_event'
+require 'optimizely/helpers/date_time_utils'
+module Optimizely
+  class ConversionEvent < UserEvent
+    # Represents conversion event
+    attr_reader :event, :user_id, :visitor_attributes, :tags, :bot_filtering
+
+    def initialize(
+      event_context:,
+      event:,
+      user_id:,
+      visitor_attributes:,
+      tags:,
+      bot_filtering:
+    )
+      @event_context = event_context
+      @uuid = SecureRandom.uuid
+      @timestamp = Helpers::DateTimeUtils.create_timestamp
+      @event = event
+      @user_id = user_id
+      @visitor_attributes = visitor_attributes
+      @tags = tags
+      @bot_filtering = bot_filtering
+    end
+  end
+end

data/lib/optimizely/event/entity/decision.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely 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.
+#
+module Optimizely
+  class Decision
+    attr_reader :campaign_id, :experiment_id, :variation_id
+
+    def initialize(campaign_id:, experiment_id:, variation_id:)
+      @campaign_id = campaign_id
+      @experiment_id = experiment_id
+      @variation_id = variation_id
+    end
+
+    def as_json
+      {
+        campaign_id: @campaign_id,
+        experiment_id: @experiment_id,
+        variation_id: @variation_id
+      }
+    end
+  end
+end

data/lib/optimizely/event/entity/event_batch.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely 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.
+#
+module Optimizely
+  class EventBatch
+    attr_accessor :account_id, :project_id, :revision, :client_name, :client_version,
+                  :anonymize_ip, :enrich_decisions, :visitors
+
+    def as_json
+      {
+        account_id: @account_id,
+        project_id: @project_id,
+        revision: @revision,
+        client_name: @client_name,
+        client_version: @client_version,
+        anonymize_ip: @anonymize_ip,
+        enrich_decisions: @enrich_decisions,
+        visitors: @visitors
+      }
+    end
+
+    class Builder
+      attr_reader :account_id, :project_id, :revision, :client_name, :client_version,
+                  :anonymize_ip, :enrich_decisions, :visitors
+
+      def build
+        event_batch = EventBatch.new
+        event_batch.account_id = @account_id
+        event_batch.project_id = @project_id
+        event_batch.revision = @revision
+        event_batch.client_name = @client_name
+        event_batch.client_version = @client_version
+        event_batch.anonymize_ip = @anonymize_ip
+        event_batch.enrich_decisions = @enrich_decisions
+        event_batch.visitors = @visitors
+        event_batch
+      end
+
+      def with_account_id(account_id)
+        @account_id = account_id
+      end
+
+      def with_project_id(project_id)
+        @project_id = project_id
+      end
+
+      def with_revision(revision)
+        @revision = revision
+      end
+
+      def with_client_name(client_name)
+        @client_name = client_name
+      end
+
+      def with_client_version(client_version)
+        @client_version = client_version
+      end
+
+      def with_anonymize_ip(anonymize_ip)
+        @anonymize_ip = anonymize_ip
+      end
+
+      def with_enrich_decisions(enrich_decisions)
+        @enrich_decisions = enrich_decisions
+      end
+
+      def with_visitors(visitors)
+        @visitors = visitors
+      end
+    end
+  end
+end

data/lib/optimizely/event/entity/event_context.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely 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.
+#
+module Optimizely
+  class EventContext
+    attr_reader :account_id, :project_id, :anonymize_ip, :revision, :client_name,
+                :client_version
+
+    def initialize(
+      account_id:,
+      project_id:,
+      anonymize_ip:,
+      revision:,
+      client_name:,
+      client_version:
+    )
+      @account_id = account_id
+      @project_id = project_id
+      @anonymize_ip = anonymize_ip
+      @revision = revision
+      @client_name = client_name
+      @client_version = client_version
+    end
+
+    def as_json
+      {
+        account_id: @account_id,
+        project_id: @project_id,
+        anonymize_ip: @anonymize_ip,
+        revision: @revision,
+        client_name: @client_name,
+        client_version: @client_version
+      }
+    end
+  end
+end

data/lib/optimizely/event/entity/impression_event.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely 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.
+#
+require_relative 'user_event'
+require 'optimizely/helpers/date_time_utils'
+module Optimizely
+  class ImpressionEvent < UserEvent
+    attr_reader :user_id, :experiment_layer_id, :experiment_id, :variation_id,
+                :visitor_attributes, :bot_filtering
+
+    def initialize(
+      event_context:,
+      user_id:,
+      experiment_layer_id:,
+      experiment_id:,
+      variation_id:,
+      visitor_attributes:,
+      bot_filtering:
+    )
+      @event_context = event_context
+      @uuid = SecureRandom.uuid
+      @timestamp = Helpers::DateTimeUtils.create_timestamp
+      @user_id = user_id
+      @experiment_layer_id = experiment_layer_id
+      @experiment_id = experiment_id
+      @variation_id = variation_id
+      @visitor_attributes = visitor_attributes
+      @bot_filtering = bot_filtering
+    end
+  end
+end

data/lib/optimizely/event/entity/snapshot.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely 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.
+#
+module Optimizely
+  class Snapshot
+    attr_reader :events, :decisions
+
+    def initialize(events:, decisions: nil)
+      @decisions = decisions
+      @events = events
+    end
+
+    def as_json
+      hash = {events: @events}
+      hash[:decisions] = @decisions unless @decisions.nil?
+      hash
+    end
+  end
+end

data/lib/optimizely/event/entity/snapshot_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely 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.
+#
+module Optimizely
+  class SnapshotEvent
+    attr_reader :entity_id, :uuid, :key, :timestamp, :revenue, :value, :tags
+
+    def initialize(
+      entity_id:,
+      uuid:,
+      key:,
+      timestamp:,
+      revenue: nil,
+      value: nil,
+      tags: nil
+    )
+      @entity_id = entity_id
+      @uuid = uuid
+      @key = key
+      @timestamp = timestamp
+      @revenue = revenue
+      @value = value
+      @tags = tags
+    end
+
+    def as_json
+      hash = {entity_id: @entity_id, uuid: @uuid, key: @key, timestamp: @timestamp}
+      hash[:revenue] = @revenue unless @revenue.nil?
+      hash[:value] = @value unless @value.nil?
+      hash[:tags] = @tags unless @tags.nil?
+      hash
+    end
+  end
+end

data/lib/optimizely/event/entity/user_event.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely 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.
+#
+module Optimizely
+  class UserEvent
+    attr_reader :event_context, :uuid, :timestamp
+  end
+end

data/lib/optimizely/event/entity/visitor.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely 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.
+#
+module Optimizely
+  class Visitor
+    attr_reader :snapshots, :visitor_id, :attributes
+    def initialize(snapshots:, visitor_id:, attributes:)
+      @snapshots = snapshots
+      @visitor_id = visitor_id
+      @attributes = attributes
+    end
+
+    def as_json
+      {
+        snapshots: @snapshots,
+        visitor_id: @visitor_id,
+        attributes: @attributes
+      }
+    end
+  end
+end

data/lib/optimizely/event/entity/visitor_attribute.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+#
+#    Copyright 2019, Optimizely 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.
+#
+module Optimizely
+  class VisitorAttribute
+    attr_reader :entity_id, :key, :type, :value
+    def initialize(entity_id:, key:, type:, value:)
+      @entity_id = entity_id
+      @key = key
+      @type = type
+      @value = value
+    end
+
+    def as_json
+      {
+        entity_id: @entity_id,
+        key: @key,
+        type: @type,
+        value: @value
+      }
+    end
+  end
+end