Enum.swift

//
//  Enum.swift
//  reddift
//
//  Created by sonson on 2015/05/12.
//  Copyright (c) 2015年 sonson. All rights reserved.
//

import Foundation

/**
The sort method for listing Comment object when using "/comments/[link_id]", "/api/morechildren".
*/
public enum CommentSort {
	case confidence
	case top
	case new
	case hot
	case controversial
	case old
	case random
	case qa
	
	/**
	Returns string to create a path of URL.
	*/
	public var path: String {
		switch self {
		case .confidence:
			return "/confidence"
		case .top:
			return "/top"
		case .new:
			return "/new"
		case .hot:
			return "/hot"
		case .controversial:
			return "/controversial"
		case .old:
			return "/old"
		case .random:
			return "/random"
		case .qa:
			return "/qa"
		}
	}
	
	/**
	Returns string to show titles.
	*/
	public var type: String {
		switch self {
		case .confidence:
			return "confidence"
		case .top:
			return "top"
		case .new:
			return "new"
		case .hot:
			return "hot"
		case .controversial:
			return "controversial"
		case .old:
			return "old"
		case .random:
			return "random"
		case .qa:
			return "qa"
		}
	}
    
    public var description: String {
        switch self {
        case .confidence:
            return "Sort by Confidence"
        case .top:
            return "Sort by Top"
        case .new:
            return "Sort by New"
        case .hot:
            return "Sort by Hot"
        case .controversial:
            return "Sort by Controversial"
        case .old:
            return "Sort by time?"
        case .random:
            return "Random"
        case .qa:
            return "Sort by Quality?"
        }
    }
}

/**
The type of filtering content by timeline.
*/
public enum TimeFilterWithin {
	/// Contents within an hour
	case hour
	/// Contents within a day
	case day
	/// Contents within a week
	case week
	/// Contents within a month
	case month
	/// Contents within a year
	case year
	/// All contents
	case all
    
    static let cases: [TimeFilterWithin] = [.hour, .day, .week, .month, .year, .all]
	
	/// String for URL parameter
	public var param: String {
		switch self {
		case .hour:
			return "hour"
		case .day:
			return "day"
		case .week:
			return "week"
		case .month:
			return "month"
		case .year:
			return "year"
		case .all:
			return "all"
		}
    }
    
    public var description: String {
        switch self {
        case .hour:
            return "Within an hour"
        case .day:
            return "Within a day"
        case .week:
            return "Within a week"
        case .month:
            return "Within a month"
        case .year:
            return "Within a year"
        case .all:
            return "All"
        }
    }
}

/**
The sort method for listing Link object, reddift original.
*/
public enum LinkSortType {
    case controversial
    case top
    case hot
    case new
    
    public var path: String {
        switch self {
        case .controversial:
            return "/controversial"
        case .top:
            return "/top"
        case .hot:
            return "/hot"
        case .new:
            return "/new"
        }
    }
    
    public var description: String {
        switch self {
        case .controversial:
            return "Sort by Controversial"
        case .top:
            return "Sort by Top"
        case .hot:
            return "Sort by Hot"
        case .new:
            return "Sort by New"
        }
    }
}

/**
The sort method for search Link object, "/r/[subreddit]/search" or "/search".
*/
public enum SearchSortBy {
	case relevance
	case new
	case hot
	case top
	case comments
	
	var path: String {
		switch self {
		case .relevance:
			return "relevance"
		case .new:
			return "new"
		case .hot:
			return "hot"
		case .top:
			return "top"
		case .comments:
			return "comments"
		}
	}
}

/**
The sort method for listing user's subreddit object, "/subreddits/mine/[where]".
*/
public enum SubredditsMineWhere {
	case contributor
	case moderator
	case subscriber
	
	public var path: String {
		switch self {
		case .contributor:
			return "/subreddits/mine/contributor"
		case .moderator:
			return "/subreddits/mine/moderator"
		case .subscriber:
			return "/subreddits/mine/subscriber"
		}
	}
}

/**
The sort method for listing user's subreddit object, "/subreddits/[where]".
*/
public enum SubredditsWhere {
	case popular
	case new
	case employee
	case gold
    case `default`
	
	public var path: String {
		switch self {
		case .popular:
			return "/subreddits/popular.json"
		case .new:
			return "/subreddits/new.json"
		case .employee:
			return "/subreddits/employee.json"
		case .gold:
            return "/subreddits/gold.json"
        case .default:
            return "/subreddits/default.json"
		}
	}
	
	public var title: String {
		switch self {
		case .popular:
			return "Popular"
		case .new:
			return "New"
		case .employee:
			return "Employee"
		case .gold:
            return "Gold"
        case .default:
            return "Default"
		}
	}
}

/**
The type of a message box.
*/
public enum MessageWhere {
	case inbox
	case unread
	case sent
	
	public var  path: String {
		switch self {
		case .inbox:
			return "/inbox"
		case .unread:
			return "/unread"
		case .sent:
			return "/sent"
		}
	}
	
	public var  description: String {
		switch self {
		case .inbox:
			return "inbox"
		case .unread:
			return "unread"
		case .sent:
			return "sent"
		}
	}
}

/**
The type of users' contents for "/user/username/where" method.
*/
public enum UserContent {
	case overview
	case submitted
	case comments
	case liked
	case disliked
	case hidden
	case saved
	case gilded
    
    static let cases: [UserContent] = [.overview, .submitted, .comments, .liked, .disliked, .hidden, .saved, .gilded]
	
	var path: String {
		switch self {
		case .overview:
			return "/overview"
		case .submitted:
			return "/submitted"
		case .comments:
			return "/comments"
		case .liked:
			return "/liked"
		case .disliked:
			return "/disliked"
		case .hidden:
			return "/hidden"
		case .saved:
			return "/saved"
		case .gilded:
			return "/glided"
		}
	}
}

/**
The type of ordering users' contents for "/user/username/where" method.
*/
public enum UserContentSortBy {
	case hot
	case new
	case top
	case controversial
    
    static let cases: [UserContentSortBy] = [.hot, .new, .top, .controversial]
    
	var param: String {
		switch self {
		case .hot:
			return "hot"
		case .new:
			return "new"
		case .top:
			return "top"
		case .controversial:
			return "controversial"
		}
	}
}

/**
The type of voting direction.
*/
public enum VoteDirection: Int {
	case up     =  1
	case none   =  0
	case down   = -1
}

/**
How a Thing is distinguished from other things.
*/
public enum DistinguishType {
    case none
    case moderator
    case admin
    case special
}