forked from OpenNeo/impress
Emi Matchu
dc44b4dbb3
Okay right, the wardrobe-2020 app treats `state` as a bit of an override thing, and `pose` is the main canonical field for how a pet looks. We were missing a few pieces here: 1. After loading a pet, we weren't including the `pose` field in the initial query string for the wardrobe URL, but we _were_ including the `state` field, so the outfit would get set up with a conflicting pet state ID vs pose. 2. When saving an outfit, we weren't taking the `state` field into account at all. This could cause the saved outfit to not quite match how it actually looked in-app, because the default pet state for that species/color/pose trio could be different; and regardless, the outfit state would come back with `appearanceId` set to `null`, which wouldn't match the local outfit state, which would trigger an infinite loop. Here, we complete the round-trip of the `state` field, from pet loading to outfit saving to the outfit data that comes back after saving!
165 lines
5.3 KiB
Ruby
165 lines
5.3 KiB
Ruby
require 'rocketamf_extensions/remote_gateway'
|
|
require 'ostruct'
|
|
|
|
class Pet < ApplicationRecord
|
|
NEOPETS_URL_ORIGIN = ENV['NEOPETS_URL_ORIGIN'] || 'https://www.neopets.com'
|
|
GATEWAY_URL = NEOPETS_URL_ORIGIN + '/amfphp/gateway.php'
|
|
PET_VIEWER = RocketAMFExtensions::RemoteGateway.new(GATEWAY_URL).
|
|
service('CustomPetService').action('getViewerData')
|
|
PET_NOT_FOUND_REMOTE_ERROR = 'PHP: Unable to retrieve records from the database.'
|
|
WARDROBE_PATH = '/wardrobe'
|
|
|
|
belongs_to :pet_type
|
|
|
|
attr_reader :items, :pet_state, :alt_style
|
|
|
|
scope :with_pet_type_color_ids, ->(color_ids) {
|
|
joins(:pet_type).where(PetType.arel_table[:id].in(color_ids))
|
|
}
|
|
|
|
def load!(options={})
|
|
options[:locale] ||= I18n.default_locale
|
|
I18n.with_locale(options.delete(:locale)) do
|
|
use_viewer_data(
|
|
self.class.fetch_viewer_data(name, options.delete(:timeout)),
|
|
options,
|
|
)
|
|
end
|
|
true
|
|
end
|
|
|
|
def use_viewer_data(viewer_data, options={})
|
|
options[:item_scope] ||= Item.all
|
|
|
|
pet_data = viewer_data[:custom_pet]
|
|
|
|
raise UnexpectedDataFormat unless pet_data[:species_id]
|
|
raise UnexpectedDataFormat unless pet_data[:color_id]
|
|
raise UnexpectedDataFormat unless pet_data[:body_id]
|
|
|
|
has_alt_style = pet_data[:alt_style].present?
|
|
|
|
self.pet_type = PetType.find_or_initialize_by(
|
|
species_id: pet_data[:species_id].to_i,
|
|
color_id: pet_data[:color_id].to_i
|
|
)
|
|
self.pet_type.origin_pet = self
|
|
|
|
# With an alt style, `body_id` in the biology data refers to the body ID of
|
|
# the *alt* style, not the usual pet type. (We have `original_biology` for
|
|
# *some* of the pet type's situation, but not it's body ID!)
|
|
#
|
|
# So, in the alt style case, don't update `body_id` - but if this is our
|
|
# first time seeing this pet type and it doesn't *have* a `body_id` yet,
|
|
# let's not be creating it without one. We'll need to model it without the
|
|
# alt style first. (I don't bother with a clear error message though 😅)
|
|
self.pet_type.body_id = pet_data[:body_id] unless has_alt_style
|
|
if self.pet_type.body_id.nil?
|
|
raise UnexpectedDataFormat,
|
|
"can't process alt style on first occurrence of pet type"
|
|
end
|
|
|
|
pet_state_biology = has_alt_style ? pet_data[:original_biology] :
|
|
pet_data[:biology_by_zone]
|
|
raise UnexpectedDataFormat if pet_state_biology.empty?
|
|
pet_state_biology[0] = nil # remove effects if present
|
|
@pet_state = self.pet_type.add_pet_state_from_biology! pet_state_biology
|
|
|
|
if has_alt_style
|
|
raise UnexpectedDataFormat unless pet_data[:alt_color]
|
|
raise UnexpectedDataFormat if pet_data[:biology_by_zone].empty?
|
|
|
|
@alt_style = AltStyle.find_or_initialize_by(id: pet_data[:alt_style].to_i)
|
|
@alt_style.assign_attributes(
|
|
color_id: pet_data[:alt_color].to_i,
|
|
species_id: pet_data[:species_id].to_i,
|
|
body_id: pet_data[:body_id].to_i,
|
|
biology: pet_data[:biology_by_zone],
|
|
)
|
|
end
|
|
|
|
@items = Item.collection_from_pet_type_and_registries(self.pet_type,
|
|
viewer_data[:object_info_registry], viewer_data[:object_asset_registry],
|
|
options[:item_scope])
|
|
end
|
|
|
|
def wardrobe_query
|
|
{
|
|
name: self.name,
|
|
color: self.pet_type.color.id,
|
|
species: self.pet_type.species.id,
|
|
pose: self.pet_state.pose,
|
|
state: self.pet_state.id,
|
|
objects: self.items.map(&:id),
|
|
}.to_query
|
|
end
|
|
|
|
def contributables
|
|
contributables = [pet_type, @pet_state, @alt_style].filter(&:present?)
|
|
items.each do |item|
|
|
contributables << item
|
|
contributables += item.pending_swf_assets
|
|
end
|
|
contributables
|
|
end
|
|
|
|
before_validation do
|
|
pet_type.save!
|
|
if @pet_state
|
|
@pet_state.save!
|
|
@pet_state.handle_assets!
|
|
end
|
|
|
|
if @items
|
|
@items.each do |item|
|
|
item.save! if item.changed?
|
|
item.handle_assets!
|
|
end
|
|
end
|
|
|
|
if @alt_style
|
|
@alt_style.save!
|
|
end
|
|
end
|
|
|
|
def self.load(name, options={})
|
|
pet = Pet.find_or_initialize_by(name: name)
|
|
pet.load!(options)
|
|
pet
|
|
end
|
|
|
|
def self.from_viewer_data(viewer_data, options={})
|
|
pet = Pet.find_or_initialize_by(name: viewer_data[:custom_pet][:name])
|
|
pet.use_viewer_data(viewer_data, options)
|
|
pet
|
|
end
|
|
|
|
# NOTE: Ideally pet requests shouldn't take this long, but Neopets can be
|
|
# slow sometimes! Since we're on the Falcon server, long timeouts shouldn't
|
|
# slow down the rest of the request queue, like it used to be in the past.
|
|
def self.fetch_viewer_data(name, timeout=10, locale=nil)
|
|
locale ||= I18n.default_locale
|
|
begin
|
|
neopets_language_code = I18n.compatible_neopets_language_code_for(locale)
|
|
envelope = PET_VIEWER.request([name, 0]).post(
|
|
:timeout => timeout,
|
|
:headers => {
|
|
'Cookie' => "lang=#{neopets_language_code}"
|
|
}
|
|
)
|
|
rescue RocketAMFExtensions::RemoteGateway::AMFError => e
|
|
if e.message == PET_NOT_FOUND_REMOTE_ERROR
|
|
raise PetNotFound, "Pet #{name.inspect} does not exist"
|
|
end
|
|
raise DownloadError, e.message
|
|
rescue RocketAMFExtensions::RemoteGateway::ConnectionError => e
|
|
raise DownloadError, e.message, e.backtrace
|
|
end
|
|
HashWithIndifferentAccess.new(envelope.messages[0].data.body)
|
|
end
|
|
|
|
class PetNotFound < RuntimeError;end
|
|
class DownloadError < RuntimeError;end
|
|
class UnexpectedDataFormat < RuntimeError;end
|
|
end
|
|
|