Merge branch 'staging' into 9th-anni-updates

Adds new tables for:
* Character skills
* Character charge attacks
* Character support skills
* Ability effects

Also adds flags on GridCharacter for whether an ability is enabled or disabled in full auto

README.md

@@ -1,24 +1,40 @@
-# README
+# hensei-api
 
-This README would normally document whatever steps are necessary to get the
+**hensei-api** is the backend for [granblue.team](https://app.granblue.team/), an app for saving and sharing teams for [Granblue Fantasy](https://game.granbluefantasy.jp).
-application up and running.
 
-Things you may want to cover:
+**Please note that these instructions are a work-in-progress!**
 
-* Ruby version
+### Installing Ruby
 
-* System dependencies
+You'll need to install ruby-3.0.0. We recommend using [RVM](https://rvm.io/) and creating a gemset to manage your Ruby installation. Before proceeding, install the GPG keys from the official RVM website.
 
-* Configuration
+```
+\curl -sSL https://get.rvm.io | bash -s stable
+rvm install ruby-3.0.0
+rvm use 3.0.0@granblue --create
+```
 
-* Database creation
+### Installing dependencies
 
-* Database initialization
+After cloning the repo, install the project dependencies with:
 
-* How to run the test suite
+```
+bundle install
+```
 
-* Services (job queues, cache servers, search engines, etc.)
+### Creating the database
 
-* Deployment instructions
+Once the dependencies have been installed, you'll need to create and seed the database. Seed data is provided but may not be up-to-date!
 
-* ...
+```
+rails db:create
+rails db:migrate
+rails db:seed
+```
+
+### Running the server
+
+Then, you can start the server with:
+```
+rails server
+```

app/blueprints/api/v1/character_blueprint.rb

@@ -20,22 +20,6 @@ module Api
         }
       end
 
-      field :hp do |w|
-        {
-          min_hp: w.min_hp,
-          max_hp: w.max_hp,
-          max_hp_flb: w.max_hp_flb
-        }
-      end
-
-      field :atk do |w|
-        {
-          min_atk: w.min_atk,
-          max_atk: w.max_atk,
-          max_atk_flb: w.max_atk_flb
-        }
-      end
-
       field :race do |w|
         [
           w.race1,
@@ -50,17 +34,28 @@ module Api
         ]
       end
 
-      field :data do |w|
+      field :stats do |w|
         {
-          base_da: w.base_da,
+          atk: {
-          base_ta: w.base_ta
+            min_atk: w.min_atk,
-        }
+            max_atk: w.max_atk,
-      end
+            max_atk_flb: w.max_atk_flb,
-
+            max_atk_ulb: w.max_atk_ulb
-      field :ougi_ratio do |w|
+          },
-        {
+          hp: {
-          ougi_ratio: w.ougi_ratio,
+            min_hp: w.min_hp,
-          ougi_ratio_flb: w.ougi_ratio_flb
+            max_hp: w.max_hp,
+            max_hp_flb: w.max_hp_flb,
+            max_hp_ulb: w.max_hp_ulb
+          },
+          data: {
+            base_da: w.base_da,
+            base_ta: w.base_ta
+          },
+          charge_attack: {
+            ougi_ratio: w.ougi_ratio,
+            ougi_ratio_flb: w.ougi_ratio_flb
+          }
         }
       end
     end

app/blueprints/api/v1/job_blueprint.rb

@@ -17,7 +17,7 @@ module Api
         ]
       end
 
-      fields :granblue_id, :row, :ml, :order, :accessory, :accessory_type
+      fields :granblue_id, :row, :master_level, :ultimate_mastery, :order, :accessory, :accessory_type
     end
   end
 end

app/blueprints/api/v1/party_blueprint.rb

@@ -52,6 +52,7 @@ module Api
       end
 
       view :jobs do
+        fields :master_level, :ultimate_mastery
         association :job,
                     blueprint: JobBlueprint
         include_view :job_skills

app/blueprints/api/v1/summon_blueprint.rb

@@ -10,7 +10,7 @@ module Api
         }
       end
 
-      fields :granblue_id, :element, :rarity, :max_level
+      fields :granblue_id, :element, :rarity
 
       field :uncap do |w|
         {
@@ -20,23 +20,23 @@ module Api
         }
       end
 
-      field :hp do |w|
+      field :stats do |w|
         {
-          min_hp: w.min_hp,
+          atk: {
-          max_hp: w.max_hp,
+            min_atk: w.min_atk,
-          max_hp_flb: w.max_hp_flb,
+            max_atk: w.max_atk,
-          max_hp_ulb: w.max_hp_ulb,
+            max_atk_flb: w.max_atk_flb,
-          max_hp_xlb: w.max_hp_xlb
+            max_atk_ulb: w.max_atk_ulb,
-        }
+            max_atk_xlb: w.max_atk_xlb
-      end
+          },
-
+          hp: {
-      field :atk do |w|
+            min_hp: w.min_hp,
-        {
+            max_hp: w.max_hp,
-          min_atk: w.min_atk,
+            max_hp_flb: w.max_hp_flb,
-          max_atk: w.max_atk,
+            max_hp_ulb: w.max_hp_ulb,
-          max_atk_flb: w.max_atk_flb,
+            max_hp_xlb: w.max_hp_xlb
-          max_atk_ulb: w.max_atk_ulb,
+          },
-          max_atk_xlb: w.max_atk_xlb
+          max_level: w.max_level,
         }
       end
     end

app/blueprints/api/v1/weapon_blueprint.rb

@@ -11,8 +11,21 @@ module Api
       end
 
       fields :granblue_id, :element, :proficiency,
-             :max_level, :max_skill_level, :limit, :rarity,
+             :limit, :rarity, :series
-             :series, :ax, :ax_type, :awakening
+
+      field :ax do |w|
+        {
+          has_ax: w.ax,
+          type: w.ax_type
+        }
+      end
+
+      field :awakening do |w|
+        {
+          has_awakening: w.awakening,
+          types: w.awakening_types
+        }
+      end
 
       field :uncap do |w|
         {
@@ -21,21 +34,22 @@ module Api
         }
       end
 
-      field :hp do |w|
+      field :stats do |w|
         {
-          min_hp: w.min_hp,
+          atk: {
-          max_hp: w.max_hp,
+            min_atk: w.min_atk,
-          max_hp_flb: w.max_hp_flb,
+            max_atk: w.max_atk,
-          max_hp_ulb: w.max_hp_ulb
+            max_atk_flb: w.max_atk_flb,
-        }
+            max_atk_ulb: w.max_atk_ulb
-      end
+          },
-
+          hp: {
-      field :atk do |w|
+            min_hp: w.min_hp,
-        {
+            max_hp: w.max_hp,
-          min_atk: w.min_atk,
+            max_hp_flb: w.max_hp_flb,
-          max_atk: w.max_atk,
+            max_hp_ulb: w.max_hp_ulb
-          max_atk_flb: w.max_atk_flb,
+          },
-          max_atk_ulb: w.max_atk_ulb
+          max_level: w.max_level,
+          max_skill_level: w.max_skill_level
         }
       end
     end

db/migrate/20230311065239_add_awakening_types_to_weapons.rb

@@ -0,0 +1,5 @@
+class AddAwakeningTypesToWeapons < ActiveRecord::Migration[7.0]
+  def change
+    add_column :weapons, :awakening_types, :integer, array: true, default: []
+  end
+end

db/migrate/20230311065249_add_ultimate_mastery_to_parties.rb

@@ -0,0 +1,9 @@
+class AddUltimateMasteryToParties < ActiveRecord::Migration[7.0]
+  def change
+    add_column :parties, :ultimate_mastery, :integer
+    rename_column :parties, :ml, :master_level
+    add_column :jobs, :ultimate_mastery, :boolean, default: false, null: false
+    rename_column :jobs, :ml, :master_level
+    change_column_null :jobs, :master_level, false
+  end
+end

db/migrate/20230311065331_create_books_table.rb

@@ -0,0 +1,13 @@
+class CreateBooksTable < ActiveRecord::Migration[7.0]
+  def change
+    def change
+      create_table :books, id: :uuid, default: -> { "gen_random_uuid()" } do |t|
+        t.string :name_en, null: false, unique: true
+        t.string :name_jp, null: false, unique: true
+        t.string :description_en, null: false, unique: true
+        t.string :description_jp, null: false, unique: true
+        t.string :granblue_id, null: false, unique: true
+      end
+    end
+  end
+end

db/migrate/20230311073805_create_effects.rb

@@ -0,0 +1,32 @@
+class CreateEffects < ActiveRecord::Migration[7.0]
+  def change
+    create_table :effects, id: :uuid, default: -> { "gen_random_uuid()" } do |t|
+      t.string :name_en, null: false
+      t.string :name_jp, null: false
+
+      t.string :description_en, null: false
+      t.string :description_jp, null: false
+
+      t.integer :accuracy_value
+      t.string :accuracy_suffix
+      t.string :accuracy_comparator
+
+      t.jsonb :strength, array: true
+      # {
+      #   "min": integer,
+      #   "max": integer,
+      #   "value": integer,
+      #   "suffix": string
+      # }
+
+      t.integer :healing_cap
+
+      t.boolean :duration_indefinite, default: false, null: false
+      t.integer :duration_value
+      t.string :duration_unit
+
+      t.string :notes_en
+      t.string :notes_jp
+    end
+  end
+end

db/migrate/20230311073806_create_character_skills.rb

@@ -0,0 +1,25 @@
+class CreateCharacterSkills < ActiveRecord::Migration[7.0]
+  def change
+    create_table :character_skills, id: :uuid, default: -> { "gen_random_uuid()" } do |t|
+      t.references :character, type: :uuid
+
+      t.string :name_en, unique: true, null: false
+      t.string :name_jp, unique: true, null: false
+
+      t.string :description_en, unique: true, null: false
+      t.string :description_jp, unique: true, null: false
+
+      t.integer :type, null: false
+      t.integer :position, null: false
+
+      t.string :form
+      t.integer :cooldown, default: 0, null: false
+      t.integer :lockout, default: 0, null: false
+      t.integer :duration, array: true
+      t.boolean :recast, default: false, null: false
+      t.integer :obtained_at, default: 1, null: false
+
+      t.uuid :effects, array: true
+    end
+  end
+end

db/migrate/20230311073807_create_character_charge_attacks.rb

@@ -0,0 +1,18 @@
+class CreateCharacterChargeAttacks < ActiveRecord::Migration[7.0]
+  def change
+    create_table :character_charge_attacks, id: :uuid, default: -> { "gen_random_uuid()" } do |t|
+      t.references :character, type: :uuid
+
+      t.string :name_en, unique: true, null: false
+      t.string :name_jp, unique: true, null: false
+
+      t.string :description_en, unique: true, null: false
+      t.string :description_jp, unique: true, null: false
+
+      t.integer :order, null: false
+      t.string :form
+
+      t.uuid :effects, array: true
+    end
+  end
+end

db/migrate/20230311073808_create_character_support_skills.rb

@@ -0,0 +1,21 @@
+class CreateCharacterSupportSkills < ActiveRecord::Migration[7.0]
+  def change
+    create_table :character_support_skills, id: :uuid, default: -> { "gen_random_uuid()" } do |t|
+      t.references :character, type: :uuid
+
+      t.string :name_en, unique: true, null: false
+      t.string :name_jp, unique: true, null: false
+
+      t.string :description_en, unique: true, null: false
+      t.string :description_jp, unique: true, null: false
+
+      t.integer :position, null: false
+      t.integer :obtained_at
+
+      t.boolean :emp, default: false, null: false
+      t.boolean :transcendence, default: false, null: false
+
+      t.uuid :effects, array: true
+    end
+  end
+end

db/migrate/20230311073814_add_full_auto_toggles_to_grid_character.rb

@@ -0,0 +1,10 @@
+class AddFullAutoTogglesToGridCharacter < ActiveRecord::Migration[7.0]
+  def change
+    change_table(:grid_characters) do |t|
+      t.boolean :skill0_enabled, null: false, default: true
+      t.boolean :skill1_enabled, null: false, default: true
+      t.boolean :skill2_enabled, null: false, default: true
+      t.boolean :skill3_enabled, null: false, default: true
+    end
+  end
+end

db/migrate/20230311092318_add_quick_summon_to_grid_summons.rb

@@ -0,0 +1,5 @@
+class AddQuickSummonToGridSummons < ActiveRecord::Migration[7.0]
+  def change
+    add_column :grid_summons, :quick_summon, :boolean, default: false, null: false
+  end
+end

db/migrate/20230311092753_add_nicknames_to_characters.rb

@@ -0,0 +1,6 @@
+class AddNicknamesToCharacters < ActiveRecord::Migration[7.0]
+  def change
+    add_column :characters, :nicknames_en, :string, array: true, default: [], null: false
+    add_column :characters, :nicknames_jp, :string, array: true, default: [], null: false
+  end
+end

db/migrate/20230311092803_add_nicknames_to_weapons.rb

@@ -0,0 +1,6 @@
+class AddNicknamesToWeapons < ActiveRecord::Migration[7.0]
+  def change
+    add_column :weapons, :nicknames_en, :string, array: true, default: [], null: false
+    add_column :weapons, :nicknames_jp, :string, array: true, default: [], null: false
+  end
+end

db/migrate/20230311092812_add_nicknames_to_summons.rb

@@ -0,0 +1,6 @@
+class AddNicknamesToSummons < ActiveRecord::Migration[7.0]
+  def change
+    add_column :summons, :nicknames_en, :string, array: true, default: [], null: false
+    add_column :summons, :nicknames_jp, :string, array: true, default: [], null: false
+  end
+end

db/migrate/20230315091753_add_granblue_id_to_weapon_keys.rb

@@ -0,0 +1,4 @@
+class AddGranblueIdToWeaponKeys < ActiveRecord::Migration[7.0]
+  def change
+  end
+end

db/schema.rb

@@ -10,19 +10,62 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2023_01_31_084343) do
+ActiveRecord::Schema[7.0].define(version: 2023_03_11_092812) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "btree_gin"
   enable_extension "pg_trgm"
   enable_extension "pgcrypto"
   enable_extension "plpgsql"
-  enable_extension "timescaledb"
 
   create_table "app_updates", primary_key: "updated_at", id: :datetime, force: :cascade do |t|
     t.string "update_type", null: false
     t.string "version"
   end
 
+  create_table "character_charge_attacks", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
+    t.uuid "character_id"
+    t.string "name_en", null: false
+    t.string "name_jp", null: false
+    t.string "description_en", null: false
+    t.string "description_jp", null: false
+    t.integer "order", null: false
+    t.string "form"
+    t.uuid "effects", array: true
+    t.index ["character_id"], name: "index_character_charge_attacks_on_character_id"
+  end
+
+  create_table "character_skills", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
+    t.uuid "character_id"
+    t.string "name_en", null: false
+    t.string "name_jp", null: false
+    t.string "description_en", null: false
+    t.string "description_jp", null: false
+    t.integer "type", null: false
+    t.integer "position", null: false
+    t.string "form"
+    t.integer "cooldown", default: 0, null: false
+    t.integer "lockout", default: 0, null: false
+    t.integer "duration", array: true
+    t.boolean "recast", default: false, null: false
+    t.integer "obtained_at", default: 1, null: false
+    t.uuid "effects", array: true
+    t.index ["character_id"], name: "index_character_skills_on_character_id"
+  end
+
+  create_table "character_support_skills", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
+    t.uuid "character_id"
+    t.string "name_en", null: false
+    t.string "name_jp", null: false
+    t.string "description_en", null: false
+    t.string "description_jp", null: false
+    t.integer "position", null: false
+    t.integer "obtained_at"
+    t.boolean "emp", default: false, null: false
+    t.boolean "transcendence", default: false, null: false
+    t.uuid "effects", array: true
+    t.index ["character_id"], name: "index_character_support_skills_on_character_id"
+  end
+
   create_table "characters", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
     t.string "name_en"
     t.string "name_jp"
@@ -50,9 +93,28 @@ ActiveRecord::Schema[7.0].define(version: 2023_01_31_084343) do
     t.integer "max_hp_ulb"
     t.integer "max_atk_ulb"
     t.integer "character_id", default: [], null: false, array: true
+    t.string "nicknames_en", default: [], null: false, array: true
+    t.string "nicknames_jp", default: [], null: false, array: true
     t.index ["name_en"], name: "index_characters_on_name_en", opclass: :gin_trgm_ops, using: :gin
   end
 
+  create_table "effects", id: :uuid, default: -> { "gen_random_uuid()" }, force: :cascade do |t|
+    t.string "name_en", null: false
+    t.string "name_jp", null: false
+    t.string "description_en", null: false
+    t.string "description_jp", null: false
+    t.integer "accuracy_value"
+    t.string "accuracy_suffix"
+    t.string "accuracy_comparator"
+    t.jsonb "strength", array: true
+    t.integer "healing_cap"
+    t.boolean "duration_indefinite", default: false, null: false
+    t.integer "duration_value"
+    t.string "duration_unit"
+    t.string "notes_en"
+    t.string "notes_jp"
+  end
+  
   create_table "data_migrations", primary_key: "version", id: :string, force: :cascade do |t|
   end
 
@@ -80,6 +142,10 @@ ActiveRecord::Schema[7.0].define(version: 2023_01_31_084343) do
     t.jsonb "ring4", default: {"modifier"=>nil, "strength"=>nil}, null: false
     t.jsonb "earring", default: {"modifier"=>nil, "strength"=>nil}, null: false
     t.jsonb "awakening", default: {"type"=>1, "level"=>1}, null: false
+    t.boolean "skill0_enabled", default: true, null: false
+    t.boolean "skill1_enabled", default: true, null: false
+    t.boolean "skill2_enabled", default: true, null: false
+    t.boolean "skill3_enabled", default: true, null: false
     t.index ["character_id"], name: "index_grid_characters_on_character_id"
     t.index ["party_id"], name: "index_grid_characters_on_party_id"
   end
@@ -94,6 +160,7 @@ ActiveRecord::Schema[7.0].define(version: 2023_01_31_084343) do
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
     t.integer "transcendence_step", default: 0, null: false
+    t.boolean "quick_summon", default: false, null: false
     t.index ["party_id"], name: "index_grid_summons_on_party_id"
     t.index ["summon_id"], name: "index_grid_summons_on_summon_id"
   end
@@ -154,12 +221,13 @@ ActiveRecord::Schema[7.0].define(version: 2023_01_31_084343) do
     t.integer "proficiency1"
     t.integer "proficiency2"
     t.string "row"
-    t.boolean "ml", default: false
+    t.boolean "master_level", default: false, null: false
     t.integer "order"
     t.uuid "base_job_id"
     t.string "granblue_id"
     t.boolean "accessory", default: false
     t.integer "accessory_type", default: 0
+    t.boolean "ultimate_mastery", default: false, null: false
     t.index ["base_job_id"], name: "index_jobs_on_base_job_id"
   end
 
@@ -213,7 +281,7 @@ ActiveRecord::Schema[7.0].define(version: 2023_01_31_084343) do
     t.integer "element"
     t.integer "weapons_count"
     t.uuid "job_id"
-    t.integer "ml"
+    t.integer "master_level"
     t.uuid "skill1_id"
     t.uuid "skill2_id"
     t.uuid "skill3_id"
@@ -231,6 +299,7 @@ ActiveRecord::Schema[7.0].define(version: 2023_01_31_084343) do
     t.integer "summons_count"
     t.string "edit_key"
     t.uuid "local_id"
+    t.integer "ultimate_mastery"
     t.index ["accessory_id"], name: "index_parties_on_accessory_id"
     t.index ["job_id"], name: "index_parties_on_job_id"
     t.index ["skill0_id"], name: "index_parties_on_skill0_id"
@@ -273,6 +342,8 @@ ActiveRecord::Schema[7.0].define(version: 2023_01_31_084343) do
     t.boolean "xlb", default: false, null: false
     t.integer "max_atk_xlb"
     t.integer "max_hp_xlb"
+    t.string "nicknames_en", default: [], null: false, array: true
+    t.string "nicknames_jp", default: [], null: false, array: true
     t.index ["name_en"], name: "index_summons_on_name_en", opclass: :gin_trgm_ops, using: :gin
   end
 
@@ -326,6 +397,9 @@ ActiveRecord::Schema[7.0].define(version: 2023_01_31_084343) do
     t.boolean "awakening", default: true, null: false
     t.boolean "limit", default: false, null: false
     t.boolean "ax", default: false, null: false
+    t.integer "awakening_types", default: [], array: true
+    t.string "nicknames_en", default: [], null: false, array: true
+    t.string "nicknames_jp", default: [], null: false, array: true
     t.index ["name_en"], name: "index_weapons_on_name_en", opclass: :gin_trgm_ops, using: :gin
   end
 

lib/tasks/download_images.rake

@@ -106,7 +106,7 @@ namespace :granblue do
 
     puts "Summon #{id}"
     sizes.each do |size|
-      path = "#{Rails.root}/download/character-#{size}"
+      path = "#{Rails.root}/download/summon-#{size}"
       download_images(url[size.to_sym], size, path)
     end
   end