riddler_admin 0.1.0 → 0.2.0

data/app/helpers/riddler_admin/application_helper.rb

@@ -1,4 +1,23 @@
 module RiddlerAdmin
   module ApplicationHelper
+    def page_title
+      [
+        ::RiddlerAdmin.config.main_app_name,
+        ::RiddlerAdmin.config.app_name
+      ].compact.join " - "
+    end
+
+    def brand_link
+      if ::RiddlerAdmin.config.main_app_name.present?
+        link_to ::RiddlerAdmin.config.main_app_name, main_app.root_path, class: "navbar-brand"
+      else
+        link_to ::RiddlerAdmin.config.app_name, riddler_admin.root_path, class: "navbar-brand"
+      end
+    end
+
+    def additional_javascript_includes
+      return if ::RiddlerAdmin.config.javascript_includes.blank?
+      javascript_include_tag *::RiddlerAdmin.config.javascript_includes
+    end
   end
 end

data/app/helpers/riddler_admin/preview_contexts_helper.rb

@@ -0,0 +1,4 @@
+module RiddlerAdmin
+  module PreviewContextsHelper
+  end
+end

data/app/helpers/riddler_admin/publish_requests_helper.rb

@@ -0,0 +1,4 @@
+module RiddlerAdmin
+  module PublishRequestsHelper
+  end
+end

data/app/models/riddler_admin/application_record.rb

@@ -1,4 +1,4 @@
-require "ksuid"
+require "ulid"
 
 module RiddlerAdmin
   class ApplicationRecord < ActiveRecord::Base
@@ -9,15 +9,15 @@ module RiddlerAdmin
     private
 
     def id_length
-      return 21 unless self.class.const_defined? :ID_LENGTH
+      return 16 unless self.class.const_defined? :ID_LENGTH
       self.class.const_get :ID_LENGTH
     end
 
     def generate_id
       return if id.present?
       model_key = self.class.const_get :MODEL_KEY
-      ksuid = KSUID.new.to_s
-      id_string = ksuid[0..(5+id_length)]
+      ulid = ULID.generate
+      id_string = ulid[0..(9+id_length)]
       self.id = [model_key, id_string].join "_"
     end
   end

data/app/models/riddler_admin/content_definition.rb

@@ -0,0 +1,87 @@
+require "riddler/protobuf/content_definition_pb"
+require "riddler/protobuf/content_management_services_pb"
+
+module RiddlerAdmin
+  class ContentDefinition < ::RiddlerAdmin::ApplicationRecord
+    MODEL_KEY = "cdef".freeze
+    ID_LENGTH = 5 # 916_132_832 per second
+
+    DEFINITION_SCHEMA_VERSION = 1
+
+    # The Step or Element being defined
+    belongs_to :content, polymorphic: true
+
+    # The PublishRequest that created this
+    belongs_to :publish_request
+
+    validates :definition, presence: true
+
+    validates_uniqueness_of :version, scope: [:content_type, :content_id]
+
+    before_validation :add_fields
+
+    def description
+      publish_request.title
+    end
+
+    def title
+      "#{content.title} v#{version} - #{description}"
+    end
+
+    def to_proto
+      ::Riddler::Protobuf::ContentDefinition.new \
+        id: id,
+        created_at: created_at_proto,
+        content_type: content.content_type.upcase.to_sym,
+        content_id: content.id,
+        title: content.title,
+        description: description,
+        version: version,
+        definition_schema_version: DEFINITION_SCHEMA_VERSION,
+        definition_string: definition.to_json
+    end
+
+    def publish_to_remote
+      content_management_grpc.create_content_definition create_request_proto
+    end
+
+    private
+
+    def created_at_proto
+      ::Google::Protobuf::Timestamp.new seconds: created_at.to_i,
+        nanos: created_at.nsec
+    end
+
+    def create_request_proto
+      ::Riddler::Protobuf::CreateContentDefinitionRequest.new \
+        content_definition: self.to_proto
+    end
+
+    def content_management_grpc
+      ::Riddler::Protobuf::ContentManagement::Stub.new \
+        ::RiddlerAdmin.configuration.riddler_grpc_address,
+        :this_channel_is_insecure
+    end
+
+    def add_fields
+      return if self.persisted? || content.blank?
+
+      self.definition_schema_version = DEFINITION_SCHEMA_VERSION
+      self.version = next_version
+      self.definition = generate_definition self.version
+    end
+
+    def next_version
+      previous_max = self.class.where(content: content).maximum(:version) || 0
+      previous_max + 1
+    end
+
+    def generate_definition version
+      generated_definition = content.definition_hash.merge({
+        "definition_id" => id,
+        "definition_schema_version" => DEFINITION_SCHEMA_VERSION,
+        "version" => version
+      })
+    end
+  end
+end

data/app/models/riddler_admin/element.rb

@@ -1,28 +1,41 @@
 module RiddlerAdmin
-  class Element < ApplicationRecord
+  class Element < ::RiddlerAdmin::ApplicationRecord
     MODEL_KEY = "el".freeze
     ID_LENGTH = 6 # 56_800_235_584 per second
 
+    after_initialize :set_defaults
+
     belongs_to :container, polymorphic: true, validate: true
 
     acts_as_list scope: [:container_type, :container_id]
 
+    validates_presence_of :name
+
+    # Alphanumeric and underscore only - no whitespace.
+    # We might consider doing lowercase only for snake casing.
+    validates_format_of :name, with: /\A[a-z][a-zA-Z0-9_]*\z/, message: "cannot start with a capital letter or a number."
+    validates_uniqueness_of :name, scope: [:container_type, :container_id], unless: :is_variant?
+
+    validates :include_predicate, parseable_predicate: true
+
     def self.available_classes
-      [ Elements::Heading, Elements::Copy ]
+      [
+        Elements::Heading,
+        Elements::Image,
+        Elements::Link,
+        Elements::Text,
+        Elements::Variant
+      ]
     end
 
     def self.default_class
-      Elements::Copy
+      Elements::Text
     end
 
     def self.short_name
       name.demodulize
     end
 
-    def self.to_partial_path
-      "#{name.underscore}/class"
-    end
-
     def to_partial_path detail=nil
       [self.class.name.underscore, detail].compact.join "/"
     end
@@ -36,20 +49,49 @@ module RiddlerAdmin
       type.demodulize.underscore
     end
 
+    def content_type
+      "element"
+    end
+
+    def content_id
+      id
+    end
+
     def definition_hash options=nil
       options ||= {}
-      serializable_hash options.merge(serializable_hash_options)
+      hash = serializable_hash options.merge(serializable_hash_options)
+      hash["type"] = object
+      hash.delete "include_predicate" if hash["include_predicate"].blank?
+      hash
     end
 
     def serializable_hash_options
       {
-        methods: :object,
+        methods: [:content_type],
         except: excluded_attrs
       }
     end
 
     def excluded_attrs
-      [:created_at, :updated_at, :container_type, :container_id, :position, :name]
+      [:created_at, :updated_at, :container_type, :container_id, :position, :url, :text]
+    end
+
+    def step
+      if container.kind_of? ::RiddlerAdmin::Step
+        container
+      else
+        container.step
+      end
+    end
+
+    private
+
+    def is_variant?
+      container.kind_of? ::RiddlerAdmin::Elements::Variant
+    end
+
+    def set_defaults
+      self.name = short_name.underscore if name.blank?
     end
   end
 end

data/app/models/riddler_admin/elements/heading.rb

@@ -6,6 +6,12 @@ module RiddlerAdmin
       def self.model_name
         Element.model_name
       end
+
+      def definition_hash options=nil
+        hash = super
+        hash["text"] = text
+        hash
+      end
     end
   end
 end

data/app/models/riddler_admin/elements/image.rb

@@ -0,0 +1,18 @@
+module RiddlerAdmin
+  module Elements
+    class Image < Element
+      validates_presence_of :url
+
+      def self.model_name
+        Element.model_name
+      end
+
+      def definition_hash options=nil
+        hash = super
+        hash["src"] = url
+        hash["alt"] = text
+        hash
+      end
+    end
+  end
+end

data/app/models/riddler_admin/elements/link.rb

@@ -0,0 +1,18 @@
+module RiddlerAdmin
+  module Elements
+    class Link < Element
+      validates_presence_of :url
+
+      def self.model_name
+        Element.model_name
+      end
+
+      def definition_hash options=nil
+        hash = super
+        hash["href"] = url
+        hash["text"] = text
+        hash
+      end
+    end
+  end
+end

data/app/models/riddler_admin/elements/{copy.rb → text.rb}

@@ -1,11 +1,17 @@
 module RiddlerAdmin
   module Elements
-    class Copy < Element
+    class Text < Element
       validates_presence_of :text
 
       def self.model_name
         Element.model_name
       end
+
+      def definition_hash options=nil
+        hash = super
+        hash["text"] = text
+        hash
+      end
     end
   end
 end

data/app/models/riddler_admin/elements/variant.rb

@@ -0,0 +1,19 @@
+module RiddlerAdmin
+  module Elements
+    class Variant < Element
+      has_many :elements, -> { order position: :asc },
+        dependent: :destroy,
+        as: :container
+
+      def self.model_name
+        Element.model_name
+      end
+
+      def definition_hash options=nil
+        hash = super
+        hash["elements"] = elements.map { |e| e.definition_hash }
+        hash
+      end
+    end
+  end
+end

data/app/models/riddler_admin/preview_context.rb

@@ -0,0 +1,83 @@
+module RiddlerAdmin
+  class PreviewContext < ::RiddlerAdmin::ApplicationRecord
+    MODEL_KEY = "pctx".freeze
+    ID_LENGTH = 5 # 916_132_832 per second
+
+    validates :title, presence: true, uniqueness: true
+
+    def self.convert_headers input_headers
+      original_headers = input_headers.to_h.
+        select{|k,v| k.starts_with? "HTTP_"}.
+        map{|k,v| [k.downcase.gsub(/^http_/, ""), v] }
+
+      Hash[original_headers]
+    end
+
+    def data
+      yaml_string = yaml
+
+      if ::RiddlerAdmin.configuration.encrypt_preview_contexts? &&
+        encrypted_yaml.present?
+
+        yaml_string = decrypt encrypted_yaml
+      end
+
+      return {} if yaml_string.to_s.strip == ""
+      YAML.safe_load yaml_string
+    end
+
+    def refresh_data input_headers: {}
+      use_case_headers = merge_headers input_headers
+
+      use_case = ::Riddler::UseCases::PreviewContext.new \
+        params: params_hash,
+        headers: use_case_headers
+
+      hash = use_case.process
+      update_data hash
+    end
+
+    def params_hash
+      params_array = (params || "").split("\n").map do |line|
+        line.split(":").map &:strip
+      end
+      Hash[params_array]
+    end
+
+    def headers_hash
+      headers_array = (headers || "").split("\n").map do |line|
+        key, val = *line.split(":").map(&:strip)
+        [key.downcase.gsub(/[^0-9a-z]/i, "_"), val]
+      end
+      Hash[headers_array]
+    end
+
+    def merge_headers input_headers
+      request_headers = self.class.convert_headers input_headers
+      request_headers.merge headers_hash
+    end
+
+    def update_data hash
+      yaml = hash.to_yaml
+
+      if ::RiddlerAdmin.configuration.encrypt_preview_contexts?
+        encrypted_yaml = encrypt yaml
+        update_attribute :encrypted_yaml, encrypted_yaml
+      else
+        update_attribute :yaml, yaml
+      end
+    end
+
+    private
+
+    def encrypt plaintext
+      ::RiddlerAdmin.encrypt plaintext,
+        key: ::RiddlerAdmin.configuration.preview_context_transit_key
+    end
+
+    def decrypt ciphertext
+      ::RiddlerAdmin.decrypt ciphertext,
+        key: ::RiddlerAdmin.configuration.preview_context_transit_key
+    end
+  end
+end

data/app/models/riddler_admin/publish_request.rb

@@ -0,0 +1,57 @@
+module RiddlerAdmin
+  class PublishRequest < ::RiddlerAdmin::ApplicationRecord
+    MODEL_KEY = "pr".freeze
+    ID_LENGTH = 5 # 916_132_832 per second
+
+    # The Step or Element being published
+    belongs_to :content, polymorphic: true
+
+    # The ContentDefinition created as a result of this request
+    has_one :content_definition
+
+    validates :title, presence: true
+
+    after_initialize :set_defaults
+
+    scope :unapproved, -> { where "approved_at is null" }
+
+    def approve riddler_user = nil, approved_at = Time.now.utc
+      attrs = {status: "approved", approved_at: approved_at}
+      if riddler_user.present?
+        attrs[:approved_by_name] = ::RiddlerAdmin.config.user_name_block.call riddler_user
+        attrs[:approved_by_id] = riddler_user.public_send ::RiddlerAdmin.config.user_id_method
+      end
+
+      update_attributes attrs
+    end
+
+    def approved?
+      approved_at.present?
+    end
+
+    def publish published_at = Time.now.utc
+      raise "ERROR: Attempt to publish an unapproved definition" unless approved?
+      create_content_definition! content: content
+      content_definition.publish_to_remote
+
+      update_attributes published_at: published_at,
+        status: "published"
+    end
+
+    def published?
+      published_at.present?
+    end
+
+    private
+
+    def set_defaults
+      return if title.present? || content.blank?
+
+      if content.published?
+        self.title = "Update #{content.title}"
+      else
+        self.title = "Create #{content.title}"
+      end
+    end
+  end
+end