# A representer for Accounts

module OpenStax
  module Accounts
    module Api
      module V1
        class AccountRepresenter < Roar::Decorator
          # This representer is used to communicate with Accounts
          # and so must allow read/write on all properties
          # Do not use it in create/update APIs!

          # This representer can be used directly or subclassed for an object that delegates
          # openstax_uid, username, first_name, last_name, full_name, title, faculty_status,
          # role, school_type, school_location and salesforce_contact_id to an account

          include Roar::JSON

          property :openstax_uid,
                   as: :id,
                   type: Integer,
                   schema_info: {
                     description: "The account's unique ID number",
                     required: true
                   }

          property :username,
                   type: String,
                   schema_info: {
                     description: "The account's unique username (case insensitive)",
                     required: true
                   }

          property :is_administrator,
                    type: :boolean,
                    schema_info: {
                      description: 'Whether or not this user is an administrator on Accounts'
                    }

          property :first_name,
                   type: String,
                   schema_info: {
                     description: "The user's first name"
                   }

          property :last_name,
                   type: String,
                   schema_info: {
                     description: "The user's last name"
                   }

          property :full_name,
                   type: String,
                   schema_info: {
                     description: "The user's full name"
                   }

          property :title,
                   type: String,
                   schema_info: {
                     description: "The user's title"
                   }

          property :salesforce_contact_id,
                   type: String,
                   schema_info: {
                     description: "The user's salesforce contact id"
                   }

          property :faculty_status,
                   type: String,
                   schema_info: {
                     description: "One of #{
                       OpenStax::Accounts::Account.faculty_statuses.keys.map(&:to_s).inspect
                     }"
                   }

          property :role,
                   as: :self_reported_role,
                   type: String,
                   schema_info: {
                      description: "The user's uncorroborated role, one of [#{
                        OpenStax::Accounts::Account.roles.keys.map(&:to_s).join(', ')
                      }]",
                      required: true
                   }

          property :school_type,
                   type: String,
                   schema_info: {
                     description: "One of #{
                       OpenStax::Accounts::Account.school_types.keys.map(&:to_s).inspect
                     }"
                   }

          property :school_location,
                   type: String,
                   schema_info: {
                     description: "One of #{
                       OpenStax::Accounts::Account.school_locations.keys.map(&:to_s).inspect
                     }"
                   }

          property :uuid,
                   type: String,
                   schema_info: {
                     description: 'The UUID as set by Accounts'
                   }

          property :support_identifier,
                   type: String,
                   schema_info: {
                     description: 'The support_identifier as set by Accounts'
                   }

          property :is_test,
                   type: :boolean,
                   schema_info: {
                     description: 'Whether or not this is a test account'
                   }

          property :is_kip,
                   type: :boolean,
                   schema_info: {
                     description: 'Whether or not this is a Key Institutional Partner account'
                   }

          property :grant_tutor_access,
                   type: :boolean,
                   schema_info: {
                     description: 'Whether or not the account should be granted Tutor access'
                   }
        end
      end
    end
  end
end