riddler 0.1.0 → 0.2.0

data/lib/riddler/protobuf/slug_pb.rb

@@ -0,0 +1,52 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: riddler/protobuf/slug.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "riddler.protobuf.Slug" do
+    optional :id, :string, 1
+    optional :created_at, :message, 2, "google.protobuf.Timestamp"
+    optional :updated_at, :message, 3, "google.protobuf.Timestamp"
+    optional :name, :string, 4
+    optional :status, :enum, 5, "riddler.protobuf.SlugStatus"
+    optional :content_definition_id, :string, 6
+    optional :interaction_identity, :string, 7
+    optional :target_predicate, :string, 8
+  end
+  add_message "riddler.protobuf.EventCount" do
+    optional :event_name, :string, 1
+    optional :count, :int32, 2
+  end
+  add_message "riddler.protobuf.SlugStats" do
+    optional :interval, :enum, 1, "riddler.protobuf.Interval"
+    repeated :event_counts, :message, 2, "riddler.protobuf.EventCount"
+  end
+  add_enum "riddler.protobuf.SlugStatus" do
+    value :UNKNOWN_SLUG_STATUS, 0
+    value :LIVE, 1
+    value :PAUSED, 2
+  end
+  add_enum "riddler.protobuf.Interval" do
+    value :UNKNOWN_INTERVAL, 0
+    value :SECOND, 1
+    value :MINUTE, 2
+    value :HOUR, 3
+    value :DAY, 4
+    value :WEEK, 5
+    value :MONTH, 6
+    value :QUARTER, 7
+    value :YEAR, 8
+  end
+end
+
+module Riddler
+  module Protobuf
+    Slug = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.Slug").msgclass
+    EventCount = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.EventCount").msgclass
+    SlugStats = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.SlugStats").msgclass
+    SlugStatus = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.SlugStatus").enummodule
+    Interval = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.Interval").enummodule
+  end
+end

data/lib/riddler/step.rb

@@ -1,14 +1,21 @@
 module Riddler
-
   class Step
-    attr_reader :definition, :context
+    include ::Riddler::Includeable
+
+    attr_reader :definition, :context, :preview_enabled
+
+    def self.subclasses
+      @@subclasses ||= []
+    end
+
+    def self.inherited subclass
+      self.subclasses << subclass
+    end
 
     def self.for definition, context
-      # This should be "type" not "object"
-      step_type = definition["object"]
+      step_type = definition["type"]
 
-      # Maybe this should be a registry
-      klass = subclasses.detect { |klass| klass.type == step_type }
+      klass = subclasses.detect { |k| k.type == step_type }
 
       klass.new definition, context
     end
@@ -18,20 +25,13 @@ module Riddler
       @context = context
     end
 
-    #def id
-    #  definition["id"]
-    #end
-
-    #def type
-    #  self.class.type
-    #end
-
     def to_hash
       {
+        content_type: "step",
         type: self.class.type,
-        id: definition["id"]
+        id: definition["id"],
+        name: definition["name"]
       }
     end
   end
-
 end

data/lib/riddler/steps/content.rb

@@ -1,15 +1,16 @@
 module Riddler
   module Steps
-
     class Content < ::Riddler::Step
       def self.type
         "content"
       end
 
       def elements
-        @elements ||= definition["elements"].map do |element_definition|
-          ::Riddler::Element.for element_definition, context
-        end
+        @elements ||= definition["elements"]
+          .map do |element_definition|
+            ::Riddler::Element.for element_definition, context
+          end
+          .select(&:include?)
       end
 
       def to_hash
@@ -20,6 +21,5 @@ module Riddler
         hash
       end
     end
-
   end
 end

data/lib/riddler/steps/variant.rb

@@ -0,0 +1,23 @@
+module Riddler
+  module Steps
+    class Variant < ::Riddler::Step
+      def self.type
+        "variant"
+      end
+
+      def steps
+        @steps ||= definition["steps"].map do |hash|
+          ::Riddler::Step.for hash, context
+        end
+      end
+
+      def included_step
+        steps.detect &:include?
+      end
+
+      def to_hash
+        included_step&.to_hash
+      end
+    end
+  end
+end

data/lib/riddler/test_generator.rb

@@ -0,0 +1,73 @@
+require "yaml"
+
+module ::Riddler
+  class TestGenerator
+    include ERB::Util
+    attr_reader :project_root, :input_filename, :test_case
+
+    def initialize project_root, input_filename
+      @project_root = project_root
+      @input_filename = input_filename
+      @test_case = YAML.safe_load File.read input_filename
+    end
+
+    def test_case_name
+      test_case["name"]
+    end
+
+    def class_name
+      classify test_case_name
+    end
+
+    def definition
+      test_case["definition"]
+    end
+
+    def tests
+      test_case["tests"]
+    end
+
+    def generate
+      folder = input_filename.dirname.basename.to_s
+      output_filename = project_root.join *%W[ test cases #{folder} #{test_case_name}_test.rb ]
+      puts "Generating #{output_filename.relative_path_from(project_root)}"
+      output_filename.dirname.mkdir unless output_filename.dirname.exist?
+      File.write output_filename, render
+    end
+
+    private
+
+    def render
+      ERB.new(test_class_template).result(binding)
+    end
+
+    def classify string
+      string.split('_').collect!{ |w| w.capitalize }.join
+    end
+
+    def test_class_template
+      <<~TEMPLATE
+        require "test_helper"
+
+        class <%= class_name %>Test < ::Minitest::Test
+          attr_reader :definition
+
+          def setup
+            @definition = <%= definition %>
+          end
+        <% tests.each do |test| %>
+          def test_<%= test["name"] %>
+            expected_result = <% if test["result"].nil? %>nil<% else %><%= test["result"] %><% end %>
+            context = <% if test["context"].nil? %>nil<% else %><%= test["context"] %><% end %>
+
+            result = ::Riddler.render definition, context
+            result&.transform_keys! { |k| k.to_s }
+
+            assert_equal_hash expected_result, result
+          end
+        <% end %>
+        end
+      TEMPLATE
+    end
+  end
+end

data/lib/riddler/use_cases.rb

@@ -0,0 +1,7 @@
+require "riddler/use_cases/admin_preview_step"
+require "riddler/use_cases/complete_interaction"
+require "riddler/use_cases/dismiss_interaction"
+require "riddler/use_cases/preview_context"
+require "riddler/use_cases/preview_step"
+require "riddler/use_cases/show_content_definition"
+require "riddler/use_cases/show_slug"

data/lib/riddler/use_cases/admin_preview_step.rb

@@ -0,0 +1,32 @@
+module Riddler
+  module UseCases
+    class AdminPreviewStep
+      attr_reader :definition, :preview_context_data, :context, :step
+
+      def initialize definition, preview_context_data: {}
+        @definition = definition
+        @preview_context_data = preview_context_data
+        @context = ::Riddler::Context.new preview_context_data
+        @step = ::Riddler::Step.for definition, context
+      end
+
+      def process
+        if step.include?
+          hash = step.to_hash
+          return hash unless hash.nil?
+
+          {
+            response_code: 204,
+            message: "There was no step to include"
+          }
+        else
+          {
+            response_code: 204,
+            include_predicate: step.include_predicate,
+            message: "Excluded - the include_predicate returned false"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/riddler/use_cases/complete_interaction.rb

@@ -0,0 +1,20 @@
+module Riddler
+  module UseCases
+    class CompleteInteraction
+      attr_reader :interaction_repo, :interaction_id
+
+      def initialize interaction_repo:, interaction_id:
+        @interaction_repo = interaction_repo
+        @interaction_id = interaction_id
+      end
+
+      def process
+        interaction = interaction_repo.find_by id: interaction_id
+        return if interaction.nil?
+
+        interaction.complete
+        interaction_repo.update interaction
+      end
+    end
+  end
+end

data/lib/riddler/use_cases/dismiss_interaction.rb

@@ -0,0 +1,20 @@
+module Riddler
+  module UseCases
+    class DismissInteraction
+      attr_reader :interaction_repo, :interaction_id, :interaction
+
+      def initialize interaction_repo:, interaction_id:
+        @interaction_repo = interaction_repo
+        @interaction_id = interaction_id
+      end
+
+      def process
+        @interaction = interaction_repo.find_by id: interaction_id
+        return if interaction.nil?
+
+        interaction.dismiss
+        interaction_repo.update interaction
+      end
+    end
+  end
+end

data/lib/riddler/use_cases/preview_context.rb

@@ -0,0 +1,28 @@
+module Riddler
+  module UseCases
+    class PreviewContext
+      attr_reader :params, :headers
+
+      def initialize params: {}, headers: {}
+        @params = params
+        @headers = headers
+      end
+
+      def context
+        @context ||= generate_context
+      end
+
+      def process
+        context.to_hash
+      end
+
+      private
+
+      def generate_context
+        director = ::Riddler::ContextDirector.new params: params,
+          headers: headers
+        director.context
+      end
+    end
+  end
+end

data/lib/riddler/use_cases/preview_step.rb

@@ -1,19 +1,30 @@
 module Riddler
   module UseCases
-
     class PreviewStep
-      attr_reader :definition, :context, :step
+      attr_reader :definition, :params, :headers, :step
 
-      def initialize definition, context = ::Riddler::Context.new
+      def initialize definition, params: {}, headers: {}
         @definition = definition
-        @context = context
+        @params = params
+        @headers = headers
         @step = ::Riddler::Step.for definition, context
       end
 
+      def context
+        @context ||= generate_context
+      end
+
       def process
         step.to_hash
       end
-    end
 
+      private
+
+      def generate_context
+        director = ::Riddler::ContextDirector.new params: params,
+          headers: headers
+        director.context
+      end
+    end
   end
 end

data/lib/riddler/use_cases/show_content_definition.rb

@@ -0,0 +1,42 @@
+module Riddler
+  module UseCases
+    class ShowContentDefinition
+      attr_reader :content_definition_repo,
+        :content_definition_id, :context_director,
+        :content_definition, :step
+
+      def initialize content_definition_repo:, content_definition_id:, context_director:
+        @content_definition_repo = content_definition_repo
+        @content_definition_id = content_definition_id
+        @context_director = context_director
+
+        @content_definition = lookup_content_definition
+        @step = ::Riddler::Step.for content_definition.definition, context
+      end
+
+      def context
+        context_director.context
+      end
+
+      def process
+        step.to_hash
+      end
+
+      def excluded?
+        !step.include?
+      end
+
+      private
+
+      def lookup_content_definition
+        content_definition_repo.find_by id: content_definition_id
+      end
+
+      def generate_context
+        director = ::Riddler::ContextDirector.new params: params,
+          headers: headers
+        director.context
+      end
+    end
+  end
+end

data/lib/riddler/use_cases/show_slug.rb

@@ -0,0 +1,138 @@
+module Riddler
+  module UseCases
+    class ShowSlug
+      attr_reader :content_definition_repo, :slug_repo, :interaction_repo,
+        :interaction_class, :slug_name, :context_director, :slug, :interaction
+
+      def initialize content_definition_repo:, slug_repo:, interaction_repo:,
+        interaction_class:, slug_name:, params: {}, headers: {}
+
+        @content_definition_repo = content_definition_repo
+        @slug_repo = slug_repo
+        @interaction_repo = interaction_repo
+        @interaction_class = interaction_class
+        @context_director = ::Riddler::ContextDirector.new params: params, headers: headers
+        @slug_name = slug_name
+        @slug = lookup_slug
+      end
+
+      def exists?
+        !slug.nil?
+      end
+
+      def paused?
+        return true if slug.nil?
+        slug.status == "PAUSED"
+      end
+
+      def dismissed?
+        return false unless slug_defines_identity?
+        find_interaction
+        return false if @interaction.nil?
+        @interaction.status == "DISMISSED"
+      end
+
+      def completed?
+        return false unless slug_defines_identity?
+        find_interaction
+        return false if @interaction.nil?
+        @interaction.status == "COMPLETED"
+      end
+
+      def targeted?
+        slug_targeted?
+      end
+
+      def excluded?
+        definition_use_case.excluded?
+      end
+
+      def process
+        find_interaction || create_interaction
+        context.assign "interaction", interaction.to_hash
+
+        content_hash = definition_use_case.process.merge \
+          interaction_id: interaction.id,
+          dismiss_url: "/interactions/#{interaction.id}/dismiss"
+
+        interaction.content_type = content_hash[:content_type]
+        interaction.content_id = content_hash[:id]
+
+        interaction_repo.update interaction
+
+        content_hash
+      end
+
+      private
+
+      def find_interaction
+        return nil unless request_is_unique?
+
+        @interaction ||= interaction_repo.last_by slug_id: slug.id,
+          identity: identity
+      end
+
+      def create_interaction
+        @interaction = interaction_class.new \
+          slug_name: slug.name,
+          slug_id: slug.id,
+          status: "ACTIVE",
+          content_definition_id: slug.content_definition_id,
+          identifiers: context.ids
+
+        @interaction.identity = identity if request_is_unique?
+
+        interaction_repo.create interaction
+      end
+
+      def definition_use_case
+        @definition_use_case ||= ShowContentDefinition.new \
+          content_definition_repo: content_definition_repo,
+          content_definition_id: slug.content_definition_id,
+          context_director: context_director
+      end
+
+      def context
+        context_director.context
+      end
+
+      # Only has IDs extracted - context builders have not been processed
+      def simple_context
+        context_director.simple_context
+      end
+
+      def identity
+        @identity ||= simple_context.render slug.interaction_identity
+      end
+
+      def blank_interaction_identity
+        @blank_interaction_identity ||= ::Riddler::Context.new.render slug.interaction_identity
+      end
+
+      def request_is_unique?
+        slug_defines_identity? && !interaction_identity_is_blank?
+      end
+
+      def interaction_identity_is_blank?
+        identity == blank_interaction_identity
+      end
+
+      def slug_defines_identity?
+        !(slug.interaction_identity.nil? || slug.interaction_identity == "")
+      end
+
+      def lookup_slug
+        slug_repo.find_by name: slug_name
+      end
+
+      def slug_targeted?
+        return true unless slug_has_target_predicate?
+        Predicator.evaluate slug.target_predicate, context.to_liquid
+      end
+
+      def slug_has_target_predicate?
+        slug.target_predicate.to_s.strip != ""
+      end
+    end
+  end
+end