nexus_seed 0.2.24 → 0.2.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ff72dd41aa6c341c7cebc19a667959db38293f3e2ace20bcb06c848bf7c7f16
-  data.tar.gz: 06f3a7c8538d4ae779c70781be7f04a45e6da3273014dd46fd377cbe3ee7c85d
+  metadata.gz: 350d4fe16dc0c385fc0cede423479292443443cc4ec9df4d6a3ac7883b61d419
+  data.tar.gz: 44603e03bd10d0409a42656a6cb0a18b3a50a28a7924a4c6da17a96fee877e9c
 SHA512:
-  metadata.gz: 5f2a5f346350499d658724e5c22b9814358e9934e38b288798cf3331286d926c2d4e363ba39e5fb43b1d0a25553ab13a57ced7e4645117d25573c3d33e65a88b
-  data.tar.gz: 841f6fd9e586d440b3f67c582a86ceca90abb4983223589dc5ab16fe936408172a1b1d59a615977b9aa52d3f6419fbd48e5c95ec4fc167e35486091248adeef9
+  metadata.gz: a6504211d65dadb4fb960a7537374eb1fac78d1d359e33560eca4951f0191cd47d8ac7ec9dcca980a1b79e61728e9b41ea704357376f186bac9d777f52f9a518
+  data.tar.gz: 6e62cbbcf712396ab18e6ea3f9fb8fcd5a12b7ecd739d10b55e3acd5f2b5e6b59bc0932a4ac8b4533785001b9f2a08a2ed10a853cb0cd38cdbf88c2bc09b30dc

data/.rubocop.yml

@@ -8,4 +8,8 @@ Style/ConditionalAssignment:
 Style/GlobalVars:
   Enabled: false
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - 'examples/*'

data/SEED_BUILDER.md

@@ -14,9 +14,6 @@ game = NexusSeed::Builder.build(:game,
 NexusSeed::Builder.build(:forum, { id: ENV['FORUM_COLLECTIONS_ID'] }, { find_by_params: :id })
 ```
 
-`NexusSeed::Base.transaction` wraps the existing AR transaction and provides some QOL methods such as destroying
-previously generated seeds and generating seed reports.
-
 `NexusSeed::Builder.build(:collection_schema)` can be viewed as something
 mimicking `FactoryBot.create(:collection_schema)`. There are a few key differences, however:
 

data/examples/nexus-api-seeds.rb

@@ -0,0 +1,272 @@
+# see https://gitlab.nexdev.uk/pub/nexus_seed/-/wikis/Builder-examples for step by step explanation
+
+NexusSeed::Builder.build(:collection_schema)
+NexusSeed::Builder.build(:category)
+
+game = NexusSeed::Builder.build(:game,
+                                game_genre: NexusSeed::Builder.build(:game_genre, name: 'Some Game Genre'),
+                                name: 'Some Random Game'
+)
+
+NexusSeed::Builder.build(:forum, { id: ENV['FORUM_COLLECTIONS_ID'] }, { find_by_params: :id })
+
+moderation_reasons = [
+  {
+    reason: "Content used without permission",
+    resolution: "Please remove the infringing content or provide evidence of permission."
+  },
+  {
+    reason: "Inappropriate page content",
+    resolution: "Please make the necessary changes to this page as outlined in the notes."
+  },
+  {
+    reason: "Improper use of bundled assets",
+    resolution: "Please remove the assets you're bundling with your collection."
+  },
+  {
+    reason: "External link(s) to malicious/disreputable source(s)",
+    resolution: "Please remove any links to such sites/sources."
+  },
+  {
+    reason: "Collections Guidelines violation",
+    resolution: "Please follow the instructions provided in the notes section."
+  },
+  {
+    reason: "Under review",
+    resolution: "Your content is being reviewed by our team and has been made temporarily unavailable in the meantime."
+  },
+  {
+    reason: "DMCA investigation",
+    resolution: "Please check your inbox/email for a message from staff for details."
+  }
+]
+
+moderation_reasons.each do |moderation_reason|
+  NexusSeed::Builder.build(:moderation_reason, moderation_reason)
+end
+
+# todo START: add into seed rake later
+
+users = [
+  User.find_by_name!('superadminuser'),
+  User.find_by_name!('adminuser'),
+  User.find_by_name!('freeuser1'),
+]
+
+mod_files = []
+
+def attach_mods_to_revision(mod_files, revision)
+  mod_files.each do |mod_file|
+    NexusSeed::Builder.build(:collection_revision_mod,
+                             mod_file: mod_file,
+                             mod: mod_file.mod,
+                             game: mod_file.game,
+                             collection_revision: revision
+    )
+  end
+end
+
+users.each_with_index do |user, index|
+  10.times do |t|
+    col = NexusSeed::Builder.build(:collection, slug: "slug#{index}#{t}", user: user, game: game)
+    rev = NexusSeed::Builder.build(:collection_revision, collection: col, revision_status: :draft)
+
+    NexusSeed::Builder.build(:collection_image, image_type: :tile, collection: col, user: user)
+
+    # create lots of mods
+    31.times do |i|
+      mod_file = NexusSeed::Builder.build(:legacy_mod_file,
+                                          name: "Mod File Name #{i} #{t}",
+                                          game: game,
+                                          mod: NexusSeed::Builder.build(:legacy_mod,
+                                                                        game: game,
+                                                                        user: User.all.offset(i).first,
+                                                                        mod_category: ModCategory.last,
+                                                                        name: "Mod Name #{i} #{t}"
+                                          )
+      )
+
+      NexusSeed::Builder.build(:collection_revision_mod,
+                               mod_file: mod_file,
+                               mod: mod_file.mod,
+                               game: mod_file.game,
+                               collection_revision: rev
+      )
+
+      mod_files << mod_file
+    end
+
+    17.times do |i|
+      NexusSeed::Builder.build(:external_resource, collection_revision: rev, name: "External Resource #{t} #{i}")
+    end
+
+    game_version = NexusSeed::Builder.build(:game_version, game: game, reference: "1.#{t}.0")
+
+    unless rev.published?
+      rev.game_versions << game_version
+      rev.save!
+    end
+
+    changelog_description = "
+### New Features
+- When opening SSH, FTP, SFTP or SMB links, you’ll now see the option to allow all future URLs from just that same
+domain instead of the whole wide world. A little more secure for us, a little more peace of mind for you.
+
+### Bug Fixes
+- Certain versions of the app were not correctly changing availability to “Away” after 10 minutes of inactivity. While
+this has been fixed, we’d like to remind you that you can use your Custom Status to let your teammates know your
+whereabouts beyond simply Active or Away. Examples include: walking the dog, catching up after PTO, taking a mental
+break, or tweeting nice things to the Slack social media team.
+
+### Security Guidance
+This release includes security improvements. Updating is recommended.
+"
+
+    NexusSeed::Builder.build(:collection_changelog, collection_revision: rev, description: changelog_description )
+
+    # create collection images using specific hashes that should exist on b2
+    [
+      '575d0c50-58e2-4e1c-b3ed-2e709de53356',
+      '958da9be-2e2f-4b7e-a709-77715c558ad6',
+      '02ed768a-67a4-4f3e-95f4-7ce8fffe19e5',
+      'd39fe07a-4f5e-41ca-a878-711206dbc165',
+      '3f19ba7c-3b09-4d8d-9b9c-9dec1f53de57',
+      '501cba43-73e7-47d4-943f-1e042bf3a55c',
+    ].each_with_index do |uuid, index|
+      NexusSeed::Builder.build(:collection_image, {
+        id: uuid,
+        collection: col,
+        collection_revision_id: rev.id,
+        user: col.user,
+        title: "collection image #{index + 1} title",
+        alt_text: "collection image #{index + 1} alt text",
+        position: index + 1,
+      }, {find_by_params: :id})
+    end
+
+    rev.reload.published! unless rev.published?
+    col.reload.listed! unless col.listed?
+  end
+end
+
+# Collection with one draft revision
+col = NexusSeed::Builder.build(:collection, name: 'Draft 1', slug: 'draft01', user: users[0], game: game)
+rev = NexusSeed::Builder.build(:collection_revision, collection: col, revision_status: :draft)
+
+attach_mods_to_revision(mod_files, rev)
+
+# Collection with one published revision and one draft revision
+col = NexusSeed::Builder.build(:collection, name: 'Draft 2', slug: "draft02", user: users[0], game: game)
+rev1 = NexusSeed::Builder.build(:collection_revision, collection: col, revision_status: :draft)
+
+NexusSeed::Builder.build(:collection_image, image_type: :tile, collection: col, user: users[0])
+
+attach_mods_to_revision(mod_files, rev1)
+
+rev1.published! unless rev1.published?
+col.listed! unless col.listed?
+
+rev2 = NexusSeed::Builder.build(:collection_revision, collection: col, revision_status: :draft)
+
+attach_mods_to_revision(mod_files, rev2)
+
+# create tags
+5.times do |i|
+  tag_cat = NexusSeed::Builder.build(:tag_category, name: "Tag Category #{i}")
+
+  3.times do |t|
+    NexusSeed::Builder.build(:tag,
+                             name: "Normal Tag #{t} #{i}",
+                             tag_category_id: tag_cat.id
+    )
+  end
+
+  2.times do |t|
+    NexusSeed::Builder.build(:tag,
+                             name: "Global Normal Tag #{t} #{i}",
+                             global: true,
+                             tag_category_id: tag_cat.id
+    )
+  end
+
+  2.times do |t|
+    NexusSeed::Builder.build(:tag,
+                             name: "Adult Tag #{t} #{i}",
+                             adult: true,
+                             tag_category_id: tag_cat.id
+    )
+  end
+end
+
+Tag.all.each do |tag|
+  NexusSeed::Builder.build(:tag_game,
+                           tag_id: tag.id,
+                           game_id: game.id,
+                           ) unless tag.global?
+end
+
+# create dl history entries
+dls = {}
+
+# collection downloaded 24 hours ago
+collection_dl_24h_ago = Collection.find_by_slug('slug00')
+
+dls[collection_dl_24h_ago.game.id.to_s] = [] if dls[collection_dl_24h_ago.game.id.to_s].nil?
+collection_dl_24h_ago.collection_revisions.each do |r|
+  # randomize the dl times for easier distinction
+  dls[collection_dl_24h_ago.game.id.to_s] << (Time.now - 24.hours).to_i << r.id <<
+    collection_dl_24h_ago.id
+end
+
+# collection downloaded 1 hour ago
+collection_dl_1h_ago = Collection.find_by_slug('slug01')
+
+dls[collection_dl_1h_ago.game.id.to_s] = [] if dls[collection_dl_1h_ago.game.id.to_s].nil?
+collection_dl_1h_ago.collection_revisions.each do |r|
+  # randomize the dl times for easier distinction
+  dls[collection_dl_1h_ago.game.id.to_s] << (Time.now - 1.hour).to_i << r.id <<
+    collection_dl_1h_ago.id
+end
+
+free_user = User.find_by(name: 'freeuser5')
+
+dls.each do |k, v|
+  key = 'cl_' + 8515309.to_s
+  # Set object in Redis
+  $DL_HISTORY_REDIS.hset(key, k.to_s, v.pack('LLL*'))
+end
+
+if free_user.present?
+  dls.each do |k, v|
+    key = 'cl_' + free_user.id.to_s
+    # Set object in Redis
+    $DL_HISTORY_REDIS.hset(key, k.to_s, v.pack('LLL*'))
+  end
+end
+
+# Ensure modCount can be calculated
+CollectionRevision.find_each do |revision|
+  CollectionRevision.reset_counters(revision.id, :collection_revision_mods)
+  CollectionRevision.reset_counters(revision.id, :external_resources)
+rescue => error
+  p("Error seeding reset_counts: #{error.message}")
+end
+
+# Collection with one published revision and one draft revision
+bug_col = NexusSeed::Builder.build(:collection, name: 'Draft 2', slug: "draft02", user: users[0], game: game)
+rev1 = NexusSeed::Builder.build(:collection_revision, collection: bug_col, revision_status: :draft)
+
+NexusSeed::Builder.build(:collection_image, image_type: :tile, collection: bug_col, user: users[0])
+
+attach_mods_to_revision(mod_files, rev1)
+
+rev1.published! unless rev1.published?
+bug_col.listed! unless bug_col.listed?
+
+# Collection bug reports
+50.times do |_i|
+  bug_report = NexusSeed::Builder.build(:bug_report, title: "Bug Report #{_i}", reporter: free_user)
+  NexusSeed::Builder.build(:collection_bug_report, collection: bug_col, bug_report: bug_report)
+end
+
+Collection.import

data/examples/user-service-seed-task.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# this task should be placed to lib/tasks. See SEED_BUILDER.md for documentation
+
+require 'nexus_seed'
+
+namespace :seed_common do
+  desc 'Common users seeds'
+  task :run, [:retry_limit, :sleep_interval] => [:environment] do |_task, opts|
+    include NexusSeed
+    task_options(opts)
+
+    # Common seed contains user creation which must be done in order, to avoid concurrent PK duplicates
+    # due to our usage of static IDs for some seed data.
+    def seed
+      seed_adult_content_hidden
+      seed_tos_users
+      seed_mod_authors
+    end
+
+    run
+  end
+
+  # Users with adult content hidden.
+  def seed_adult_content_hidden
+    (1..5).each do |i|
+      user = NexusSeed::Builder.build(:user, name: "hideadultcontent#{i}")
+      encrypted_password = User.new.send(:password_digest, 'Password1234')
+
+      NexusSeed::Builder.build(:members_preference, mid: user.member_id, adult: 0)
+      NexusSeed::Builder.build(:user_password,
+                               user_id: user.member_id,
+                               encrypted_password: encrypted_password)
+    end
+  end
+
+  # Users with no ToS signed.
+  def seed_tos_users
+    unsigned_tos_users = []
+    (1..5).each do |i|
+      user = NexusSeed::Builder.build(:user, name: "notosuser#{i}")
+      encrypted_password = User.new.send(:password_digest, 'Password1234')
+
+      NexusSeed::Builder.build(:user_password,
+                               user_id: user.member_id,
+                               encrypted_password: encrypted_password)
+
+      unsigned_tos_users << user.member_id
+    end
+
+    # we have to delete the ToS agreements after creating the user as they are automatically generated in after_create
+    # in the user model
+    TosAgreement.where(user_id: unsigned_tos_users).destroy_all
+  end
+
+  # Mod author accounts known to be used by seeds in other components.
+  def seed_mod_authors
+    # freeuser1 will be located in API seeds by name, their specific ID does not matter.
+    NexusSeed::Builder.build(:user, name: 'freeuser1')
+
+    # IDs are not typically set in seeds, but these user IDs must match data seeded in the api and wallet components.
+    mod_author_starting_id = 40100200
+    mod_author_seed_quantity = 5
+    (1..mod_author_seed_quantity).each do |i|
+      NexusSeed::Builder.build(:user, name: "modauthor#{i}", member_id: mod_author_starting_id + (i - 1))
+    end
+  end
+end

data/lib/nexus_seed/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module NexusSeed
-  # Leave this as 0.2.24 in order for CI process to replace with the tagged version.
-  VERSION = '0.2.24'
+  # Leave this as 0.2.26 in order for CI process to replace with the tagged version.
+  VERSION = '0.2.26'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexus_seed
 version: !ruby/object:Gem::Version
-  version: 0.2.24
+  version: 0.2.26
 platform: ruby
 authors:
 - Johnathon Harris
@@ -36,6 +36,8 @@ files:
 - Gemfile
 - README.md
 - SEED_BUILDER.md
+- examples/nexus-api-seeds.rb
+- examples/user-service-seed-task.rb
 - lib/nexus_seed.rb
 - lib/nexus_seed/builder.rb
 - lib/nexus_seed/builder/base.rb