ad_space 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a12f9c56d13a27770794f6a45cbcfeab74b967ac816f80c64c71dff93a2bca1e
+  data.tar.gz: 4c2a6883b683c9ea101b18761c441bbfa03840d42ed30b5503f5167463e1b3a4
+SHA512:
+  metadata.gz: 6f50e5b0cac4b17d987d2bc5e44dd2a685628cadeec7e280be3605f21e4bafc2020b8ce8d1d47e8af8d8e9cbe144c09a8c657c0dd1a5ce047fdec7b8a8e0d745
+  data.tar.gz: 30e0cb33ac32f287f6b8607d81c627736705ea177cdb0af138403cc63db09a1662bf6e9f7b56f09d601e894d1847616442bc12c7f4cb26a1d750635e7c7abaf1

data/Gemfile

@@ -0,0 +1,22 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in ad_space.gemspec.
+gemspec
+
+gem "puma"
+
+gem "sqlite3"
+
+gem "sprockets-rails"
+
+# Start debugger with binding.b [https://github.com/ruby/debug]
+gem "debug", ">= 1.0.0"
+
+gem 'jsbundling-rails'
+gem 'cssbundling-rails'
+gem 'stimulus-rails'
+
+group :development do
+  gem "pg"
+end

data/Gemfile.lock

@@ -0,0 +1,240 @@
+PATH
+  remote: .
+  specs:
+    ad_space (0.1.0)
+      active_model_serializers
+      dotenv-rails
+      rails (>= 7.1.1)
+      turbo-rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.1)
+      actionpack (= 7.1.1)
+      activesupport (= 7.1.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.1)
+      actionpack (= 7.1.1)
+      activejob (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.1)
+      actionpack (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activesupport (= 7.1.1)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.1)
+      actionview (= 7.1.1)
+      activesupport (= 7.1.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.1)
+      actionpack (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.1)
+      activesupport (= 7.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    active_model_serializers (0.10.14)
+      actionpack (>= 4.1)
+      activemodel (>= 4.1)
+      case_transform (>= 0.2)
+      jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
+    activejob (7.1.1)
+      activesupport (= 7.1.1)
+      globalid (>= 0.3.6)
+    activemodel (7.1.1)
+      activesupport (= 7.1.1)
+    activerecord (7.1.1)
+      activemodel (= 7.1.1)
+      activesupport (= 7.1.1)
+      timeout (>= 0.4.0)
+    activestorage (7.1.1)
+      actionpack (= 7.1.1)
+      activejob (= 7.1.1)
+      activerecord (= 7.1.1)
+      activesupport (= 7.1.1)
+      marcel (~> 1.0)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
+    builder (3.2.4)
+    case_transform (0.2)
+      activesupport
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    cssbundling-rails (1.3.3)
+      railties (>= 6.0.0)
+    date (3.3.3)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    dotenv (2.8.1)
+    dotenv-rails (2.8.1)
+      dotenv (= 2.8.1)
+      railties (>= 3.2)
+    drb (2.1.1)
+      ruby2_keywords
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.8.3)
+      rdoc
+      reline (>= 0.3.8)
+    jsbundling-rails (1.2.1)
+      railties (>= 6.0.0)
+    jsonapi-renderer (0.2.2)
+    loofah (2.21.4)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
+    net-imap (0.4.2)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.4-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
+    pg (1.5.4)
+    psych (5.1.1.1)
+      stringio
+    puma (6.4.0)
+      nio4r (~> 2.0)
+    racc (1.7.1)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.1)
+      actioncable (= 7.1.1)
+      actionmailbox (= 7.1.1)
+      actionmailer (= 7.1.1)
+      actionpack (= 7.1.1)
+      actiontext (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activemodel (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      bundler (>= 1.15.0)
+      railties (= 7.1.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.1)
+      actionpack (= 7.1.1)
+      activesupport (= 7.1.1)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rake (13.0.6)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    reline (0.3.9)
+      io-console (~> 0.5)
+    ruby2_keywords (0.0.5)
+    sprockets (4.2.1)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.6.3-x86_64-darwin)
+    sqlite3 (1.6.3-x86_64-linux)
+    stimulus-rails (1.3.0)
+      railties (>= 6.0.0)
+    stringio (3.0.8)
+    thor (1.3.0)
+    timeout (0.4.0)
+    turbo-rails (1.5.0)
+      actionpack (>= 6.0.0)
+      activejob (>= 6.0.0)
+      railties (>= 6.0.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  ad_space!
+  cssbundling-rails
+  debug (>= 1.0.0)
+  jsbundling-rails
+  pg
+  puma
+  sprockets-rails
+  sqlite3
+  stimulus-rails
+
+BUNDLED WITH
+   2.4.13

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 42up
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# AdSpace
+
+## 使用前提
+- 数据库类型 postgresql
+- 开启了 active storage
+
+## 参数说明
+### weight
+排序按照权重值逆序排列，越大显示位置约考前
+
+### ad_type
+ad_type 分为 custom(自定义), dsp(三方SDK广告)
+
+#### custom
+自定义类型，当广告位custom，则下面字段可以生效：
+- cover_base
+- cover_sm
+- cover_md
+- cover_lg
+- scheme_url, 跳转路径
+- splash_ui_type, 开屏样式，half, full
+- splash_countdown 开屏倒计时
+- visibility 广告可见性 all, premium_member, regular_user
+
+#### dsp
+第三方SDK广告，则dsp_type生效，其返回值为如下：
+- gdt 广点通
+- jrtt 今日头条 穿山甲
+- google 谷歌 adsense
+
+dsp也可以展示在开屏中，所以下面2个参数也应该有效，视情况而定。
+- splash_ui_type, 开屏样式，half, full
+- splash_countdown 开屏倒计时
+
+
+## 接口
+#### 请求
+```sh
+GET ad_space/api/v1/ads
+```
+
+# TODO: 添加个header鉴权
+
+#### 参数
+- screen_width 屏幕宽度
+- screen_height 屏幕高度
+- platform 平台 ios、android
+- slot_ids 位置id，逗号分隔字符串
+- version_code 当前App版本号
+
+#### 返回
+```json
+[]
+```
+
+## 开发
+```
+yarn build:js --watch
+```
+
+## 发布
+```
+yarn prod:build:js
+rake release
+```
+
+## 安装
+
+```sh
+# Gemfile
+gem 'ad_space', path: '/path/to/ad_space'
+
+bundle install
+./bin/rails ad_space:install:migrations
+rails db:migrate
+
+mount AdSpace::Engine => "/ad_space"
+
+# - `User.admin?` 方法要存在
+# - 用户登录状态要存在 `session[:user_id]` 变量中
+# - 没有权限会直接返回到 main_app.root_path
+```
+
+## TODO
+- i18n-task i18n中文化
+- 预览广告功能，支持参数可以直接在手机端拉取自定广告，展示在特定的位置
+- 效果指标统计功能
+- 调整UI
+- 接口支持 缓存
+- toast 消息
+- https://simplecss.org/
+- tailwindcss

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/ad_space.gemspec

@@ -0,0 +1,25 @@
+require_relative "lib/ad_space/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "ad_space"
+  spec.version     = AdSpace::VERSION
+  spec.authors     = ["42up"]
+  spec.email       = ["foobar@v2up.com"]
+  spec.homepage    = "https://github.com/42up/ad_space.git"
+  spec.summary     = "AdSpace"
+  spec.description = "AdSpace"
+  spec.license     = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    Dir["{app,config,db,lib, public}/**/*", "MIT-LICENSE", "Rakefile", "README.md", "Gemfile", "Gemfile.lock", "ad_space.gemspec"]
+  end
+
+  spec.add_dependency "rails", ">= 7.1.1"
+  spec.add_dependency "active_model_serializers"
+  spec.add_dependency "turbo-rails"
+  spec.add_dependency "dotenv-rails"
+end