ad_space 0.1.0

data/app/serializers/v1/advertisement_serializer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module V1
+  class AdvertisementSerializer < ActiveModel::Serializer
+    attributes :uuid, :started_at, :ended_at, :slot, :ad_type, :visibility
+
+    attribute :scheme_url, if: -> { object.ad_type == :custom }
+    attribute :image_url, if: -> { object.ad_type == :custom }
+    attribute :dsp_type, if: -> { object.ad_type == :dsp }
+
+    attribute :splash_ui_type, if: -> { object.splash? }
+    attribute :splash_countdown, if: -> { object.splash? }
+
+    def slot
+      object.slot.uuid
+    end
+
+    def started_at
+      object.started_at.to_i
+    end
+
+    def ended_at
+      object.started_at.to_i
+    end
+
+    def image_url
+      object.cover_url(instance_options[:size])
+    end
+  end
+end

data/app/validators/url_or_custom_scheme_validator.rb

@@ -0,0 +1,20 @@
+class UrlOrCustomSchemeValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    unless valid_url?(value) || valid_custom_scheme?(value)
+      record.errors.add(attribute, "must be a valid URL or have the format 'xxx://xxxxx'")
+    end
+  end
+
+  private
+
+  def valid_url?(value)
+    uri = URI.parse(value)
+    uri.is_a?(URI::HTTP) || uri.is_a?(URI::HTTPS)
+  rescue URI::InvalidURIError
+    false
+  end
+
+  def valid_custom_scheme?(value)
+    value =~ /\A\w+:\/\/\w+\z/
+  end
+end

data/app/views/ad_space/advertisements/_advertisement.html.erb

@@ -0,0 +1,102 @@
+<%= turbo_frame_tag advertisement do %>
+  <div id="<%= dom_id advertisement %>">
+    <p>
+      <strong>Name:</strong>
+      <%= advertisement.name %>
+    </p>
+
+    <p>
+      <strong>Uuid:</strong>
+      <%= advertisement.uuid %>
+    </p>
+
+    <p>
+      <strong>Slot:</strong>
+      <%= advertisement.slot_id %>
+    </p>
+
+    <p>
+      <strong>Published at:</strong>
+      <%= advertisement.published_at %>
+    </p>
+
+    <p>
+      <strong>Archived at:</strong>
+      <%= advertisement.archived_at %>
+    </p>
+
+    <p>
+      <strong>Started at:</strong>
+      <%= advertisement.started_at %>
+    </p>
+
+    <p>
+      <strong>Ended at:</strong>
+      <%= advertisement.ended_at %>
+    </p>
+
+    <p>
+      <strong>Platform:</strong>
+      <%= advertisement.platform %>
+    </p>
+
+    <p>
+      <strong>Archived at:</strong>
+      <%= advertisement.archived_at %>
+    </p>
+
+    <p>
+      <strong>Weight:</strong>
+      <%= advertisement.weight %>
+    </p>
+
+    <p>
+      <strong>Remark:</strong>
+      <%= advertisement.remark %>
+    </p>
+
+    <p>
+      <strong>Pv count:</strong>
+      <%= advertisement.pv_count %>
+    </p>
+
+    <p>
+      <strong>Uv count:</strong>
+      <%= advertisement.uv_count %>
+    </p>
+
+    <p>
+      <strong>Click count:</strong>
+      <%= advertisement.click_count %>
+    </p>
+
+    <% if advertisement.cover_sm.attached? %>
+      <p>
+        <strong>Small Cover Image:</strong>
+        <%= image_tag advertisement.cover_sm.url, style: "max-width: 200px; height: auto;" %>
+      </p>
+    <% end %>
+
+    <% if advertisement.cover_base.attached? %>
+      <p>
+        <strong>Base Cover Image:</strong>
+        <%= image_tag advertisement.cover_base.url, style: "max-width: 200px; height: auto;" %>
+      </p>
+    <% end %>
+
+    <% if advertisement.cover_md.attached? %>
+      <p>
+        <strong>Medium Cover Image:</strong>
+        <%= image_tag advertisement.cover_md.url, style: "max-width: 200px; height: auto;" %>
+      </p>
+    <% end %>
+
+    <% if advertisement.cover_lg.attached? %>
+      <p>
+        <strong>Large Cover Image:</strong>
+        <%= image_tag advertisement.cover_lg.url, style: "max-width: 200px; height: auto;" %>
+      </p>
+    <% end %>
+  </div>
+
+<% end %>

data/app/views/ad_space/advertisements/_form.html.erb

@@ -0,0 +1,143 @@
+<%= form_with(model: advertisement, html: { "data-controller" => "hello", "data-hello-is-dsp-ad-value" => advertisement.ad_type.blank? ? true : advertisement.ad_type == "dsp", "data-hello-is-splash-value" => advertisement.slot.blank? ? false : advertisement.slot.splash? }) do |form| %>
+  <% if advertisement.errors.any? %>
+    <div style="color: red">
+      <h2><%= pluralize(advertisement.errors.count, "error") %> prohibited this advertisement from being saved:</h2>
+
+      <ul>
+        <% advertisement.errors.each do |error| %>
+          <li><%= error.full_message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div>
+    <%= form.label :platform, style: "display: block" %>
+    <%= form.select :platform, AdSpace::Advertisement.platforms.keys.map { |platform| [platform.capitalize, platform] } %>
+  </div>
+
+  <div>
+    <%= form.label :name, style: "display: block" %>
+    <%= form.text_field :name %>
+  </div>
+
+  <div>
+    <%= form.label :slot_id, "Slot", style: "display: block" %>
+    <%= form.select :slot_id, options_for_select(
+      AdSpace::Slot.all.map { |s| [s.name, s.id, data: { is_splash: s.splash? }] },
+      advertisement.slot_id,
+    ), {}, data: { hello_target: "slot", action: "hello#handleSlotChange" } %>
+    </div>
+
+  <div>
+    <%= form.label :visibility, style: "display: block" %>
+    <%= form.select :visibility, AdSpace::Advertisement.visibilities.keys.map { |key| [key.humanize, key] } %>
+  </div>
+
+  <div>
+    <%= form.label :target_version_codes, style: "display: block" %>
+    <%= form.text_field :target_version_codes, placeholder: "Enter version codes separated by commas", value: form.object.target_version_codes.blank? ? "" : form.object.target_version_codes.join(",") %>
+  </div>
+
+  <div>
+    <%= form.label :started_at, style: "display: block" %>
+    <%= form.datetime_field :started_at %>
+  </div>
+
+  <div>
+    <%= form.label :ended_at, style: "display: block" %>
+    <%= form.datetime_field :ended_at %>
+  </div>
+
+  <div>
+    <%= form.label :ad_type, style: "display: block" %>
+    <%= form.select :ad_type,
+      AdSpace::Advertisement.ad_types.keys.map { |key| [key.humanize, key] },
+      {},
+      data: { hello_target: "adType", action: "hello#handleAdTypeChnage" }
+    %>
+  </div>
+
+  <div>
+    <%= form.label :dsp_type, style: "display: block" %>
+    <%= form.select :dsp_type, AdSpace::Advertisement.dsp_types.keys.map { |key| [key.humanize, key] } %>
+  </div>
+
+  <div data-hello-target="schemeUrl">
+    <%= form.label :scheme_url, style: "display: block" %>
+    <%= form.text_field :scheme_url %>
+  </div>
+
+  <%# 默认兜底图 %>
+  <div data-hello-target="baseCover" data-controller="image-upload", data-image-upload-url-value=<%= remove_cover_advertisement_path(advertisement, size: "base")%>>
+    <%= form.label :cover_base, "Base Cover Image", style: "display: block" %>
+    <%= form.file_field :cover_base, data: {image_upload_target: "input"} %>
+    <% if advertisement.cover_base.attached? %>
+      <%= image_tag advertisement.cover_base.url, style: "max-width: 200px; height: auto;", data: {image_upload_target: "preview"} %>
+      <button type="button" data-image-upload-target="removeButton">移除图片</button>
+    <% else %>
+      <img data-image-upload-target="preview" style="max-width: 200px; height: auto;">
+      <button type="button" data-image-upload-target="removeButton" style="display: none;">移除图片</button>
+    <% end %>
+  </div>
+
+  <div data-hello-target="splashCountdown">
+    <%= form.label :splash_countdown, style: "display: block" %>
+    <%= form.number_field :splash_countdown, min: 0, step: 1, value: form.object.splash_countdown %>
+  </div>
+
+  <div data-hello-target="splashUiType">
+    <%= form.label :splash_ui_type, style: "display: block" %>
+    <%= form.select :splash_ui_type, AdSpace::Advertisement.splash_ui_types.keys.map { |key| [key.humanize, key] } %>
+  </div>
+
+  <div data-hello-target="smCover" data-controller="image-upload", data-image-upload-url-value=<%= remove_cover_advertisement_path(advertisement, size: "sm")%>>
+    <%= form.label :cover_sm, "Small Cover Image", style: "display: block" %>
+    <%= form.file_field :cover_sm, data: {image_upload_target: "input"} %>
+    <% if advertisement.cover_sm.attached? %>
+      <%= image_tag advertisement.cover_sm.url, style: "max-width: 200px; height: auto;", data: {image_upload_target: "preview"} %>
+      <button type="button" data-image-upload-target="removeButton">移除图片</button>
+    <% else %>
+      <img data-image-upload-target="preview" style="max-width: 200px; height: auto;">
+      <button type="button" data-image-upload-target="removeButton" style="display: none;">移除图片</button>
+    <% end %>
+  </div>
+
+  <div data-hello-target="mdCover" data-controller="image-upload", data-image-upload-url-value=<%= remove_cover_advertisement_path(advertisement, size: "md")%>>
+    <%= form.label :cover_md, "Medium Cover Image", style: "display: block" %>
+    <%= form.file_field :cover_md, data: {image_upload_target: "input"} %>
+    <% if advertisement.cover_md.attached? %>
+      <%= image_tag advertisement.cover_md.url, style: "max-width: 200px; height: auto;", data: {image_upload_target: "preview"} %>
+      <button type="button" data-image-upload-target="removeButton">移除图片</button>
+    <% else %>
+      <img data-image-upload-target="preview" style="max-width: 200px; height: auto;">
+      <button type="button" data-image-upload-target="removeButton" style="display: none;">移除图片</button>
+    <% end %>
+  </div>
+
+  <div data-hello-target="lgCover" data-controller="image-upload", data-image-upload-url-value=<%= remove_cover_advertisement_path(advertisement, size: "lg")%>>
+    <%= form.label :cover_lg, "Large Cover Image", style: "display: block" %>
+    <%= form.file_field :cover_lg, data: {image_upload_target: "input"} %>
+    <% if advertisement.cover_lg.attached? %>
+      <%= image_tag advertisement.cover_lg.url, style: "max-width: 200px; height: auto;", data: {image_upload_target: "preview"} %>
+      <button type="button" data-image-upload-target="removeButton">移除图片</button>
+    <% else %>
+      <img data-image-upload-target="preview" style="max-width: 200px; height: auto;">
+      <button type="button" data-image-upload-target="removeButton" style="display: none;">移除图片</button>
+    <% end %>
+  </div>
+
+  <div>
+    <%= form.label :weight, style: "display: block" %>
+    <%= form.number_field :weight %>
+  </div>
+
+  <div>
+    <%= form.label :remark, style: "display: block" %>
+    <%= form.text_area :remark %>
+  </div>
+
+  <div>
+    <%= form.submit %>
+  </div>
+<% end %>

data/app/views/ad_space/advertisements/edit.html.erb

@@ -0,0 +1,10 @@
+<h1>Editing advertisement</h1>
+
+<%= render "form", advertisement: @advertisement %>
+
+<br>
+
+<div>
+  <%= link_to "Show this advertisement", @advertisement %> |
+  <%= link_to "Back to advertisements", advertisements_path %>
+</div>

data/app/views/ad_space/advertisements/index.html.erb

@@ -0,0 +1,15 @@
+<p style="color: green"><%= notice %></p>
+
+<h1>Advertisements</h1>
+
+<div id="advertisements">
+  <% @advertisements.each do |advertisement| %>
+    <%= render advertisement %>
+    <p>
+      <%= link_to "Show this advertisement", advertisement %>
+    </p>
+
+  <% end %>
+</div>
+
+<%= link_to "New advertisement", new_advertisement_path %>

data/app/views/ad_space/advertisements/new.html.erb

@@ -0,0 +1,9 @@
+<h1>New advertisement</h1>
+
+<%= render "form", advertisement: @advertisement %>
+
+<br>
+
+<div>
+  <%= link_to "Back to advertisements", advertisements_path %>
+</div>

data/app/views/ad_space/advertisements/show.html.erb

@@ -0,0 +1,13 @@
+<p style="color: green"><%= notice %></p>
+
+<%= render @advertisement %>
+
+<div>
+  <%= link_to "Edit this advertisement", edit_advertisement_path(@advertisement) %> |
+  <%= link_to "Back to advertisements", advertisements_path %>
+  <%= button_to "#{@advertisement.published? ? 'Unpublish' : 'Publish'} this advertisement", publish_advertisement_path(@advertisement) %>
+  <%= button_to "#{@advertisement.archived? ? 'Unarchive' : 'Archive'}  this advertisement", archive_advertisement_path(@advertisement) %>
+
+  <br/>
+  <%= button_to "Destroy this advertisement", @advertisement, method: :delete %>
+</div>

data/app/views/ad_space/dashboard/index.html.erb

@@ -0,0 +1,7 @@
+<h1>📺 AdSpace</h1>
+<ul>
+    <li><%= link_to "广告", advertisements_path %></li>
+    <li><%= link_to "位置", slots_path %></li>
+    <li><%= link_to "Github", "https://github.com/42up/ad_space" %></li>
+    <li><%= link_to "Doc", "https://github.com/42up/ad_space/blob/main/README.md" %></li>
+</ul>

data/app/views/ad_space/slots/_form.html.erb

@@ -0,0 +1,44 @@
+<%= form_with(model: slot) do |form| %>
+  <% if slot.errors.any? %>
+    <div style="color: red">
+      <h2><%= pluralize(slot.errors.count, "error") %> prohibited this slot from being saved:</h2>
+
+      <ul>
+        <% slot.errors.each do |error| %>
+          <li><%= error.full_message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div>
+    <%= form.label :name, style: "display: block" %>
+    <%= form.text_field :name %>
+  </div>
+
+  <div>
+    <%= form.label :remark, style: "display: block" %>
+    <%= form.text_area :remark %>
+  </div>
+
+  <div data-controller="image-upload", data-image-upload-url-value=<%= remove_demo_slot_path(slot)%>>
+    <%= form.label :demo, "Demo", style: "display: block" %>
+    <%= form.file_field :demo, data: {image_upload_target: "input"} %>
+    <% if slot.demo.attached? %>
+      <%= image_tag slot.demo.url, style: "max-width: 200px; height: auto;", data: {image_upload_target: "preview"} %>
+      <button type="button" data-image-upload-target="removeButton">移除图片</button>
+    <% else %>
+      <img data-image-upload-target="preview" style="max-width: 200px; height: auto;">
+      <button type="button" data-image-upload-target="removeButton" style="display: none;">移除图片</button>
+    <% end %>
+  </div>
+
+  <div>
+    <%= form.label :is_splash, "Is Splash" %>
+    <%= form.check_box :is_splash, { checked: form.object.is_splash } %>
+  </div>
+
+  <div>
+    <%= form.submit %>
+  </div>
+<% end %>

data/app/views/ad_space/slots/_slot.html.erb

@@ -0,0 +1,30 @@
+<div id="<%= dom_id slot %>">
+  <p>
+    <strong>Name:</strong>
+    <%= slot.name %>
+  </p>
+
+  <p>
+    <strong>Uuid:</strong>
+    <%= slot.uuid %>
+  </p>
+
+  <p>
+    <strong>Remark:</strong>
+    <%= slot.remark %>
+  </p>
+
+  <p>
+    <strong>Is Splash:</strong>
+    <%= slot.is_splash %>
+  </p>
+
+  <% if slot.demo.attached? %>
+    <p>
+      <strong>Demo:</strong>
+      <%= image_tag slot.demo.url, style: "max-width: 200px; height: auto;" %>
+    </p>
+  <% end %>
+
+
+</div>

data/app/views/ad_space/slots/edit.html.erb

@@ -0,0 +1,10 @@
+<h1>Editing slot</h1>
+
+<%= render "form", slot: @slot %>
+
+<br>
+
+<div>
+  <%= link_to "Show this slot", @slot %> |
+  <%= link_to "Back to slots", slots_path %>
+</div>

data/app/views/ad_space/slots/index.html.erb

@@ -0,0 +1,14 @@
+<p style="color: green"><%= notice %></p>
+
+<h1>Slots</h1>
+
+<div id="slots">
+  <% @slots.each do |slot| %>
+    <%= render slot %>
+    <p>
+      <%= link_to "Show this slot", slot %>
+    </p>
+  <% end %>
+</div>
+
+<%= link_to "New slot", new_slot_path %>

data/app/views/ad_space/slots/new.html.erb

@@ -0,0 +1,9 @@
+<h1>New slot</h1>
+
+<%= render "form", slot: @slot %>
+
+<br>
+
+<div>
+  <%= link_to "Back to slots", slots_path %>
+</div>

data/app/views/ad_space/slots/show.html.erb

@@ -0,0 +1,10 @@
+<p style="color: green"><%= notice %></p>
+
+<%= render @slot %>
+
+<div>
+  <%= link_to "Edit this slot", edit_slot_path(@slot) %> |
+  <%= link_to "Back to slots", slots_path %>
+
+  <%= button_to "Destroy this slot", @slot, method: :delete %>
+</div>

data/app/views/layouts/ad_space/application.html.erb

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= breadcrumbs.map(&:name).reverse.append("📺 AdSpace").join(" | ") %></title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <% if AdSpace::PACKED %>
+    <%= javascript_include_tag "/ad_space-assets/application", "data-turbo-track": "reload", defer: true %>
+    <%= stylesheet_link_tag "/ad_space-assets/application", "data-turbo-track": "reload", defer: true %>
+  <% else %>
+    <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
+    <%= stylesheet_link_tag "ad_space/application", "data-turbo-track": "reload", defer: true %>
+  <% end %>
+</head>
+<body>
+
+<div>
+  当前用户:
+  <b style="color: blue;"><%= user_identifier(_current_user) %></b>
+</div>
+
+<nav>
+  <ol style="display: flex; gap: 0.25rem; align-items: center; font-size: 0.875rem; list-style-type: none;">
+    <% breadcrumbs.each do |crumb| %>
+      <li>
+        <% if crumb.link? %>
+          <%= link_to crumb.name, crumb.path, style: "color: #6b7280;" %>
+        <% else %>
+          <span style="color: #111827;"><%= crumb.name %></span>
+        <% end %>
+        <% unless crumb == breadcrumbs.last %>
+          <span style="color: #6b7280;"> / </span>
+        <% end %>
+      </li>
+    <% end %>
+  </ol>
+</nav>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,22 @@
+AdSpace::Engine.routes.draw do
+  resources :advertisements do
+    member do
+      post :publish
+      post :archive
+      delete 'remove_cover/:size', to: 'advertisements#remove_cover', as: :remove_cover
+    end
+  end
+  resources :slots do
+    member do
+      delete 'remove_demo', to: 'slots#remove_demo', as: :remove_demo
+    end
+  end
+
+  namespace :api do
+    namespace :v1 do
+      get :ads, to: "advertisements#index"
+    end
+  end
+
+  root "dashboard#index"
+end

data/db/migrate/20231026152912_create_ad_space_slots.rb

@@ -0,0 +1,11 @@
+class CreateAdSpaceSlots < ActiveRecord::Migration[7.1]
+  def change
+    create_table :ad_space_slots do |t|
+      t.string :name
+      t.string :uuid
+      t.text :remark
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20231026160758_create_ad_space_advertisements.rb

@@ -0,0 +1,25 @@
+class CreateAdSpaceAdvertisements < ActiveRecord::Migration[7.1]
+  def change
+    create_table :ad_space_advertisements do |t|
+      t.string :name
+      t.string :uuid
+      t.belongs_to :slot, foreign_key: { to_table: :ad_space_slots }, null: false
+      t.datetime :published_at
+      t.datetime :started_at
+      t.datetime :ended_at
+      t.integer :platform
+      t.datetime :archived_at
+      t.integer :weight, default: 0
+      t.text :remark
+      t.integer :pv_count, default: 0
+      t.integer :uv_count, default: 0
+      t.integer :click_count, default: 0
+
+      t.timestamps
+    end
+
+    add_index :ad_space_advertisements, :platform
+    add_index :ad_space_advertisements, :published_at
+    add_index :ad_space_advertisements, [:started_at, :ended_at]
+  end
+end

data/db/migrate/20231027070536_add_scheme_url_to_ad_space_advertisements.rb

@@ -0,0 +1,10 @@
+class AddSchemeUrlToAdSpaceAdvertisements < ActiveRecord::Migration[7.1]
+  def change
+    add_column :ad_space_advertisements, :ad_type, :integer
+    add_column :ad_space_advertisements, :visibility, :integer
+    add_column :ad_space_advertisements, :scheme_url, :string
+    add_column :ad_space_advertisements, :splash_ui_type, :integer
+    add_column :ad_space_advertisements, :splash_countdown, :integer, default: 5
+    add_column :ad_space_advertisements, :dsp_type, :integer
+  end
+end

data/db/migrate/20231027083935_add_target_version_code_to_ad_space_advertisements.rb

@@ -0,0 +1,6 @@
+class AddTargetVersionCodeToAdSpaceAdvertisements < ActiveRecord::Migration[7.1]
+  def change
+    add_column :ad_space_advertisements, :target_version_codes, :bigint, array: true, default: [0]
+    add_index :ad_space_advertisements, :target_version_codes, using: :gin
+  end
+end

data/db/migrate/20231027115707_add_is_splash_to_ad_space_slots.rb

@@ -0,0 +1,5 @@
+class AddIsSplashToAdSpaceSlots < ActiveRecord::Migration[7.1]
+  def change
+    add_column :ad_space_slots, :is_splash, :boolean, default: false
+  end
+end

data/lib/ad_space/app.rb

@@ -0,0 +1,16 @@
+module AdSpace
+  class App
+    class << self
+      def init(request:)
+        # Set the current host for ActiveStorage
+        begin
+          if defined?(ActiveStorage::Current)
+            ActiveStorage::Current.url_options = {protocol: request.protocol, host: request.host, port: request.port}
+          end
+        rescue => exception
+          Rails.logger.debug "[AdSpace] Failed to set ActiveStorage::Current.url_options, #{exception.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/ad_space/configuration.rb

@@ -0,0 +1,32 @@
+module AdSpace
+  class Configuration
+    attr_writer :app_name
+    attr_writer :root_path
+    attr_accessor :current_user
+
+    def initialize
+      @root_path = "/ad_space"
+      @app_name = ::Rails.application.class.to_s.split("::").first.underscore.humanize(keep_id_suffix: true)
+    end
+
+    def current_user_method(&block)
+      @current_user = block if block.present?
+    end
+
+    def current_user_method=(method)
+      @current_user = method if method.present?
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+end