riddler 0.1.0 → 0.2.0

data/lib/riddler/drops/hash_drop.rb

@@ -0,0 +1,29 @@
+module Riddler
+  module Drops
+
+    class HashDrop < ::Liquid::Drop
+      attr_reader :hash
+
+      def initialize hash
+        @hash = Hash[ hash.map { |k,v| [k.to_s, v] } ]
+      end
+
+      def []= key, value
+        @hash[key.to_s] = value
+      end
+
+      def liquid_method_missing method
+        @hash[method]
+      end
+
+      def to_hash
+        hash
+      end
+
+      def method_missing method, *_args
+        liquid_method_missing method.to_s
+      end
+    end
+
+  end
+end

data/lib/riddler/element.rb

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

data/lib/riddler/elements/heading.rb

@@ -14,6 +14,5 @@ module Riddler
         super.merge text: text
       end
     end
-
   end
 end

data/lib/riddler/elements/image.rb

@@ -0,0 +1,21 @@
+module Riddler
+  module Elements
+    class Image < ::Riddler::Element
+      def self.type
+        "image"
+      end
+
+      def src
+        context.render definition["src"]
+      end
+
+      def alt
+        context.render definition["alt"]
+      end
+
+      def to_hash
+        super.merge alt: alt, src: src
+      end
+    end
+  end
+end

data/lib/riddler/elements/link.rb

@@ -0,0 +1,30 @@
+module Riddler
+  module Elements
+    class Link < ::Riddler::Element
+      def self.type
+        "link"
+      end
+
+      def href
+        @href ||= context.render definition["href"]
+      end
+
+      def link
+        return href if context.variable(:interaction).nil?
+        "/interactions/%s/redirect?element_id=%s&url=%s" % [
+          context.interaction.id,
+          definition["id"],
+          href
+        ]
+      end
+
+      def text
+        context.render definition["text"]
+      end
+
+      def to_hash
+        super.merge text: text, href: href, link: link
+      end
+    end
+  end
+end

data/lib/riddler/elements/text.rb

@@ -0,0 +1,17 @@
+module Riddler
+  module Elements
+    class Text < ::Riddler::Element
+      def self.type
+        "text"
+      end
+
+      def text
+        context.render definition["text"]
+      end
+
+      def to_hash
+        super.merge text: text
+      end
+    end
+  end
+end

data/lib/riddler/elements/variant.rb

@@ -0,0 +1,21 @@
+module Riddler
+  module Elements
+    class Varient < ::Riddler::Element
+      def self.type
+        "variant"
+      end
+
+      def to_hash
+        included_element.to_hash
+      end
+
+      def included_element
+        definition["elements"]
+          .map do |hash|
+            ::Riddler::Element.for hash, context
+          end
+          .detect(&:include?)
+      end
+    end
+  end
+end

data/lib/riddler/includeable.rb

@@ -0,0 +1,19 @@
+module Riddler
+  module Includeable
+    def include?
+      return true unless has_include_predicate?
+      Predicator.evaluate include_predicate, context.to_liquid
+    end
+
+    def include_predicate
+      definition["include_predicate"]
+    end
+
+    private
+
+    def has_include_predicate?
+      definition.key? "include_predicate" and
+        definition["include_predicate"].to_s.strip != ""
+    end
+  end
+end

data/lib/riddler/protobuf/content_definition.proto

@@ -0,0 +1,51 @@
+syntax = "proto3";
+
+package riddler.protobuf;
+
+import "google/protobuf/timestamp.proto";
+
+/*
+ContentDefinition is one of the outputs of the RiddlerAdmin app. After an admin
+user has created a piece of content - it must first be approved. Once approved
+it can then be published which will create the ContentDefinition in the remote
+Riddler service. ContentDefinitions CAN NOT be modified. When changes are needed - a
+new ContentDefinition (with a bumped version) will be created.
+*/
+message ContentDefinition {
+  string id = 1;
+  google.protobuf.Timestamp created_at = 2;
+
+  // Type of content: STEP
+  ContentType content_type = 3;
+
+  // ID of the content: st_12345
+  string content_id = 4;
+
+  // Version of the content. Starts at 1 and increments with each new definition
+  int32 version = 5;
+
+  // Title of the content: User Research Prompt
+  string title = 6;
+
+  // Description of the version: Adds updated images
+  string description = 7;
+
+  // Schema version of the definition
+  // The format and structure of a ContentDefinition may change over time
+  int32 definition_schema_version = 8;
+
+  /*
+  The opaque definition string generated by the admin tool (contains the
+  structure, predicates, liquid templates, ...). This is a snapshot of models
+  which belong to the admin tool.
+  */
+  oneof definition {
+    string definition_string = 9;
+  }
+}
+
+enum ContentType {
+  UNKNOWN_CONTENT_TYPE = 0;
+  STEP = 1;
+  ELEMENT = 2;
+}

data/lib/riddler/protobuf/content_definition_pb.rb

@@ -0,0 +1,33 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: riddler/protobuf/content_definition.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "riddler.protobuf.ContentDefinition" do
+    optional :id, :string, 1
+    optional :created_at, :message, 2, "google.protobuf.Timestamp"
+    optional :content_type, :enum, 3, "riddler.protobuf.ContentType"
+    optional :content_id, :string, 4
+    optional :version, :int32, 5
+    optional :title, :string, 6
+    optional :description, :string, 7
+    optional :definition_schema_version, :int32, 8
+    oneof :definition do
+      optional :definition_string, :string, 9
+    end
+  end
+  add_enum "riddler.protobuf.ContentType" do
+    value :UNKNOWN_CONTENT_TYPE, 0
+    value :STEP, 1
+    value :ELEMENT, 2
+  end
+end
+
+module Riddler
+  module Protobuf
+    ContentDefinition = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.ContentDefinition").msgclass
+    ContentType = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.ContentType").enummodule
+  end
+end

data/lib/riddler/protobuf/content_management.proto

@@ -0,0 +1,35 @@
+syntax = "proto3";
+
+package riddler.protobuf;
+
+import "riddler/protobuf/content_definition.proto";
+import "riddler/protobuf/slug.proto";
+
+message CreateContentDefinitionRequest {
+  ContentDefinition content_definition = 1;
+}
+message CreateContentDefinitionResponse {}
+
+message CreateSlugRequest {
+  Slug slug = 1;
+}
+message CreateSlugResponse {}
+
+message UpdateSlugRequest {
+  Slug slug = 1;
+}
+message UpdateSlugResponse {}
+
+message GetSlugStatsRequest {
+  Slug slug = 1;
+}
+message GetSlugStatsResponse {
+  repeated SlugStats slug_stats = 1;
+}
+
+service ContentManagement {
+  rpc CreateContentDefinition(CreateContentDefinitionRequest) returns (CreateContentDefinitionResponse) {}
+  rpc CreateSlug(CreateSlugRequest) returns (CreateSlugResponse) {}
+  rpc UpdateSlug(UpdateSlugRequest) returns (UpdateSlugResponse) {}
+  rpc GetSlugStats(GetSlugStatsRequest) returns (GetSlugStatsResponse) {}
+}

data/lib/riddler/protobuf/content_management_pb.rb

@@ -0,0 +1,43 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: riddler/protobuf/content_management.proto
+
+require 'google/protobuf'
+
+require 'riddler/protobuf/content_definition_pb'
+require 'riddler/protobuf/slug_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "riddler.protobuf.CreateContentDefinitionRequest" do
+    optional :content_definition, :message, 1, "riddler.protobuf.ContentDefinition"
+  end
+  add_message "riddler.protobuf.CreateContentDefinitionResponse" do
+  end
+  add_message "riddler.protobuf.CreateSlugRequest" do
+    optional :slug, :message, 1, "riddler.protobuf.Slug"
+  end
+  add_message "riddler.protobuf.CreateSlugResponse" do
+  end
+  add_message "riddler.protobuf.UpdateSlugRequest" do
+    optional :slug, :message, 1, "riddler.protobuf.Slug"
+  end
+  add_message "riddler.protobuf.UpdateSlugResponse" do
+  end
+  add_message "riddler.protobuf.GetSlugStatsRequest" do
+    optional :slug, :message, 1, "riddler.protobuf.Slug"
+  end
+  add_message "riddler.protobuf.GetSlugStatsResponse" do
+    repeated :slug_stats, :message, 1, "riddler.protobuf.SlugStats"
+  end
+end
+
+module Riddler
+  module Protobuf
+    CreateContentDefinitionRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.CreateContentDefinitionRequest").msgclass
+    CreateContentDefinitionResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.CreateContentDefinitionResponse").msgclass
+    CreateSlugRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.CreateSlugRequest").msgclass
+    CreateSlugResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.CreateSlugResponse").msgclass
+    UpdateSlugRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.UpdateSlugRequest").msgclass
+    UpdateSlugResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.UpdateSlugResponse").msgclass
+    GetSlugStatsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.GetSlugStatsRequest").msgclass
+    GetSlugStatsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("riddler.protobuf.GetSlugStatsResponse").msgclass
+  end
+end

data/lib/riddler/protobuf/content_management_services_pb.rb

@@ -0,0 +1,27 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: riddler/protobuf/content_management.proto for package 'riddler.protobuf'
+
+require 'grpc'
+require 'riddler/protobuf/content_management_pb'
+
+module Riddler
+  module Protobuf
+    module ContentManagement
+      class Service
+
+        include GRPC::GenericService
+
+        self.marshal_class_method = :encode
+        self.unmarshal_class_method = :decode
+        self.service_name = 'riddler.protobuf.ContentManagement'
+
+        rpc :CreateContentDefinition, CreateContentDefinitionRequest, CreateContentDefinitionResponse
+        rpc :CreateSlug, CreateSlugRequest, CreateSlugResponse
+        rpc :UpdateSlug, UpdateSlugRequest, UpdateSlugResponse
+        rpc :GetSlugStats, GetSlugStatsRequest, GetSlugStatsResponse
+      end
+
+      Stub = Service.rpc_stub_class
+    end
+  end
+end

data/lib/riddler/protobuf/slug.proto

@@ -0,0 +1,61 @@
+syntax = "proto3";
+
+package riddler.protobuf;
+
+import "google/protobuf/timestamp.proto";
+
+/*
+Slug is one of the outputs of the RiddlerAdmin app.
+It maps a URL slug to a specific ContentDefinition and allows for
+control of if it is available (status) as well as a targeting predicate.
+Changes to Slugs do NOT need to go through compliance approval (as they don't
+allow for modification of content).
+*/
+message Slug {
+  string id = 1;
+  google.protobuf.Timestamp created_at = 2;
+  google.protobuf.Timestamp updated_at = 3;
+
+  // The URL slug used to access content: user_research_prompt
+  string name = 4;
+
+  // LIVE or PAUSED
+  SlugStatus status = 5;
+
+  // ContentDefinition to be displayed
+  string content_definition_id = 6;
+
+  // Liquid template to define if an interaction should be reused
+  string interaction_identity = 7;
+
+  // Predicate to evaluate if the content should be shown
+  string target_predicate = 8;
+}
+
+enum SlugStatus {
+  UNKNOWN_SLUG_STATUS = 0;
+  LIVE = 1;
+  PAUSED = 2;
+}
+
+enum Interval {
+  UNKNOWN_INTERVAL = 0;
+  SECOND = 1;
+  MINUTE = 2;
+  HOUR = 3;
+  DAY = 4;
+  WEEK = 5;
+  MONTH = 6;
+  QUARTER = 7;
+  YEAR = 8;
+}
+
+message EventCount {
+  string event_name = 1;
+  int32 count = 2;
+}
+
+message SlugStats {
+  Interval interval = 1;
+  repeated EventCount event_counts = 2;
+}