User.cs

//-----------------------------------------------------------------------
// <copyright file="User.cs" company="TemporalCohesion.co.uk">
//     Copyright [2010] [Stuart Grassie]
//
//     Licensed under the Apache License, Version 2.0 (the "License");
//     you may not use this file except in compliance with the License.
//     You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
//     Unless required by applicable law or agreed to in writing, software
//     distributed under the License is distributed on an "AS IS" BASIS,
//     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//     See the License for the specific language governing permissions and
//     limitations under the License.
// </copyright>
//----------------------------------------------------------------------

namespace GitHubAPI.Models
{
    /// <summary>
    /// Represents a GitHub.com user account.
    /// </summary>
    public class User : UpdateableUser
    {
        /* public, authentication not required */
        public virtual int Id { get; set; }
        public virtual string Login { get; set; }
        public virtual int FollowingCount { get; set;}
        public virtual int FollowersCount { get; set;}
        public virtual int PublicGistCount { get; set;}
        public virtual int PublicRepoCount { get; set;}

        /*private, authentication required */
        public virtual int TotalPrivateRepoCount { get; set;}
        public virtual int Collaborators { get; set;}
        public virtual long DiskUsage { get; set;}
        public virtual int OwnedPrivateRepoCount { get; set;}
        public virtual int PrivateGistCount { get; set;}
        public virtual Plan Plan { get; set;}

        /// <summary>
        /// Determines whether the specified <see cref="TIssue:System.Object"/> is equal to the current <see cref="TIssue:System.Object"/>.
        /// </summary>
        /// <returns>
        /// true if the specified <see cref="TIssue:System.Object"/> is equal to the current <see cref="TIssue:System.Object"/>; otherwise, false.
        /// </returns>
        /// <param name="obj">The <see cref="TIssue:System.Object"/> to compare with the current <see cref="TIssue:System.Object"/>. 
        ///                 </param><exception cref="TIssue:System.NullReferenceException">The <paramref name="obj"/> parameter is null.
        ///                 </exception><filterpriority>2</filterpriority>
        public override bool Equals(object obj)
        {
            if(obj is User)
            {
                var compareTo = (User) obj;

                return compareTo.Id.Equals(Id) && compareTo.Name.Equals(Name) && compareTo.Email.Equals(Email);
            }

            return base.Equals(obj);
        }

        /// <summary>
        /// Serves as a hash function for a particular type. 
        /// </summary>
        /// <returns>
        /// A hash code for the current <see cref="TIssue:System.Object"/>.
        /// </returns>
        /// <filterpriority>2</filterpriority>
        public override int GetHashCode()
        {
            return Id.GetHashCode() + Login.GetHashCode();
        }

        /// <summary>
        /// Returns a <see cref="TIssue:System.String"/> that represents the current <see cref="TIssue:System.Object"/>.
        /// </summary>
        /// <returns>
        /// A <see cref="TIssue:System.String"/> that represents the current <see cref="TIssue:System.Object"/>.
        /// </returns>
        /// <filterpriority>2</filterpriority>
        public override string ToString()
        {
            return Name;
        }

    }
}