ruqqus 1.1.0 → 1.1.5

data/lib/ruqqus/types/item_base.rb

@@ -6,6 +6,22 @@ module Ruqqus
   # Base class for all all major API types.
   class ItemBase
 
+    ##
+    # @!attribute [r] permalink
+    #   @return [String] a relative link to this item.
+
+    ##
+    # @!attribute [r] created_utc
+    #   @return [Integer] the time the item was created, in seconds since the Unix epoch.
+
+    ##
+    # @!attribute [r] created
+    #   @return [Time] the time the item was created.
+
+    ##
+    # @!attribute [r] id
+    #   @return [String] a unique ID for this item.
+
     ##
     # @return [Boolean] `true` if item has been banned, otherwise `false`.
     def banned?
@@ -13,31 +29,23 @@ module Ruqqus
     end
 
     ##
-    # @return [Integer] the time the item was created, in seconds since the Unix epoch.
+    # @return [Boolean] `true` if this object is equal to another, otherwise `false`.
+    def ==(other)
+      self.class == other.class && id == other.id
+    end
+
     def created_utc
       @data[:created_utc]
     end
 
-    ##
-    # @return [Time] the time the item was created.
     def created
       Time.at(created_utc)
     end
 
-    ##
-    # @return [String] a unique ID for this item.
     def id
       @data[:id]
     end
 
-    ##
-    # @return [Boolean] `true` if this object is equal to another, otherwise `false`.
-    def ==(other)
-      self.class == other.class && id == other.id
-    end
-
-    ##
-    # @return [String] a relative link to this item.
     def permalink
       @data[:permalink]
     end

data/lib/ruqqus/types/post.rb

@@ -6,44 +6,62 @@ module Ruqqus
   class Post < Submission
 
     ##
-    # @return [Title?] the title assigned to the author, or `nil` if none is defined.
+    # @!attribute [r] thumb_url
+    #   @return [String?] the URL of the post's thumbnail image, or `nil` if none exists.
+
+    ##
+    # @!attribute [r] url
+    #   @return [String?] the URL the post links to, or `nil` if none is specified.
+
+    ##
+    # @!attribute [r] author_title
+    #   @return [Title?] the title assigned to the author, or `nil` if none is defined.
+
+    ##
+    # @!attribute [r] comment_count
+    #   @return [Integer] the number of comments made on the post.
+
+    ##
+    # @!attribute [r] domain
+    #   @return [String] the domain name for link posts, otherwise a short descriptor of the post type.
+
+    ##
+    # @!attribute [r] embed_url
+    #   @return [String] the embed URL for the post.
+
+    ##
+    # @!attribute [r] original_guild_name
+    #   @return [String] the name of the guild this post was originally posted in.
+
+    # @@!attribute [r] title
+    #   @return [String] the post title.
+
+
     def author_title
-      #noinspection RubyYardReturnMatch
+      #noinspection RubyYardReturnMatch,RubyResolve
       @author_title ||= @data[:author_title] ? Title.new(@data[:author_title]) : nil
     end
 
-    ##
-    # @return [Integer] the number of comments made on the post.
     def comment_count
       @data[:comment_count]
     end
 
-    ##
-    # @return [String] the domain name for link posts, otherwise a short descriptor of the post type.
     def domain
       @data[:domain]
     end
 
-    ##
-    # @return [String] the embed URL for the post.
     def embed_url
       @data[:embed_url]
     end
 
-    ##
-    # @return [String] the name of the guild this post was originally posted in.
     def original_guild_name
       @data[:original_guild_name]
     end
 
-    ##
-    # @return [String?] the URL of the post's thumbnail image, or `nil` if none exists.
     def thumb_url
       @data[:thumb_url]
     end
 
-    ##
-    # @return [String?] the URL the post links to, or `nil` if none is specified.
     def url
       #noinspection RubyYardReturnMatch
       @data[:url]&.empty? ? nil : @data[:url]

data/lib/ruqqus/types/submission.rb

@@ -7,57 +7,53 @@ module Ruqqus
   class Submission < ItemBase
 
     ##
-    # @return [String?] the name of the creator of the item, or `nil` if deleted account.
-    def author_name
-      @data[:author]
-    end
+    # @!attribute [r] title
+    #   @return [String] the name/title of this item.
 
     ##
-    # @return [String] the text body of the item.
-    def body
-      @data[:body]
-    end
+    # @!attribute [r] author_name
+    #   @return [String?] the name of the creator of the item, or `nil` if deleted account.
 
     ##
-    # @return [String] the text body of the item in HTML format.
-    def body_html
-      @data[:body_html]
-    end
+    # @!attribute [r] body
+    #   @return [String] the text body of the item.
 
     ##
-    # @return [Integer] the time of the last edit in seconds since the Unix epoch, or `0` if never edited.
-    def last_edit_utc
-      @data[:edited_utc]
-    end
+    # @!attribute [r] body_html
+    #   @return [String] the text body of the item in HTML format.
 
     ##
-    # @return [Time] the time of the last edit.
-    def last_edit
-      Time.at(@data[:edited_utc])
-    end
+    # @!attribute [r] last_edit_utc
+    #   @return [Integer] the time of the last edit in seconds since the Unix epoch, or `0` if never edited.
 
     ##
-    # @return [Boolean] `true` if post has been edited, otherwise `false`.
-    def edited?
-      @data[:edited_utc] != 0
-    end
+    # @!attribute [r] last_edit
+    #   @return [Time] the time of the last edit.
 
     ##
-    # @return [Integer] the number of upvotes this item has received.
-    def upvotes
-      @data[:upvotes]
-    end
+    # @!attribute [r] upvotes
+    #   @return [Integer] the number of upvotes this item has received.
 
     ##
-    # @return [Integer] the number of downvotes this item has received.
-    def downvotes
-      @data[:downvotes]
-    end
+    # @!attribute [r] downvotes
+    #   @return [Integer] the number of downvotes this item has received.
 
     ##
+    # @!attribute [r] score
     # @return [Integer] a score calculated by adding upvotes and subtracting downvotes.
-    def score
-      @data[:score]
+
+    ##
+    # @!attribute [r] fullname
+    #   @return [String] the full ID of this item.
+
+    ##
+    # @!attribute [r] guild_name
+    #   @return [String] the name of the guild this item is contained within.
+
+    ##
+    # @return [Boolean] `true` if post has been edited, otherwise `false`.
+    def edited?
+      @data[:edited_utc] != 0
     end
 
     ##
@@ -91,27 +87,53 @@ module Ruqqus
     end
 
     ##
-    # @return [String] the full ID of this item.
-    def full_name
+    # @return [String] the string representation of the object.
+    def to_s
+      @data[:id]
+    end
+
+    def author_name
+      @data[:author]
+    end
+
+    def body
+      @data[:body]
+    end
+
+    def body_html
+      @data[:body_html]
+    end
+
+    def last_edit_utc
+      @data[:edited_utc]
+    end
+
+    def last_edit
+      Time.at(@data[:edited_utc])
+    end
+
+    def upvotes
+      @data[:upvotes]
+    end
+
+    def downvotes
+      @data[:downvotes]
+    end
+
+    def score
+      @data[:score]
+    end
+
+    def fullname
       @data[:fullname]
     end
 
-    ##
-    # @return [String] the name of the guild this item is contained within.
     def guild_name
       @data[:guild_name]
     end
 
-    ##
-    # @return [String] the name/title of this item.
     def title
       @data[:title]
     end
-
-    ##
-    # @return [String] the string representation of the object.
-    def to_s
-      @data[:id]
-    end
   end
 end

data/lib/ruqqus/types/user.rb

@@ -6,31 +6,75 @@ module Ruqqus
   class User < ItemBase
 
     ##
-    # @return [Integer] the number of comments the user has created.
+    # @!attribute [r] comment_count
+    #   @return [Integer] the number of comments the user has created.
+
+    ##
+    # @!attribute [r] post_count
+    #   @return [Integer] the number of posts the user has created.
+
+    ##
+    # @!attribute [r] comment_rep
+    #   @return [Integer] the amount of rep the user has earned from comments.
+
+    ##
+    # @!attribute [r] post_rep
+    #   @return [Integer] the amount of rep the user has earned from posts.
+
+    ##
+    # @!attribute [r] total_rep
+    #   @return [Integer] the total amount of rep the user has earned from comments and posts.
+
+    ##
+    # @!attribute [r] badges
+    #   @return [Array<Badge>] an array of badges associated with this account.
+
+    ##
+    # @!attribute [r] title
+    #   @return [Title?] the title the user has associated with their account, or `nil` if none is assigned.
+
+    ##
+    # @!attribute [r] banner_url
+    #   @return [String] the URL for the banner image associated with the account.
+
+    ##
+    # @!attribute [r] profile_url
+    #   @return [String] the URL for the profile image associated with the account.
+
+    ##
+    # @!attribute [r] bio
+    #   @return [String] A brief statement/biography the user has associated with their account.
+
+    ##
+    # @!attribute [r] bio_html
+    #   @return [String] a brief statement/biography the user has associated with their account in HTML format.
+
+    ##
+    # @!attribute [r] ban_reason
+    #   @return [String?] the reason the user was banned if they were, otherwise `nil`.
+
+    ##
+    # @return [String] the string representation of the object.
+    def to_s
+      @data[:username] || inspect
+    end
+
     def comment_count
       @data[:comment_count] || 0
     end
 
-    ##
-    # @return [Integer] the number of posts the user has created.
     def post_count
       @data[:post_count] || 0
     end
 
-    ##
-    # @return [Integer] the amount of rep the user has earned from comments.
     def comment_rep
       @data[:comment_rep] || 0
     end
 
-    ##
-    # @return [Integer] the amount of rep the user has earned from posts.
     def post_rep
       @data[:post_rep] || 0
     end
 
-    ##
-    # @return [Integer] the total amount of rep the user has earned from comments and posts.
     def total_rep
       comment_rep + post_rep
     end
@@ -41,53 +85,34 @@ module Ruqqus
       @data[:username]
     end
 
-    ##
-    # @return [Array<Badge>] an array of badges associated with this account.
     def badges
+      #noinspection RubyResolve
       @badges ||= @data[:badges].map { |b| Badge.new(b) }
     end
 
-    ##
-    # @return [Title?] the title the user has associated with their account, or `nil` if none is assigned.
     def title
-      #noinspection RubyYardReturnMatch
+      #noinspection RubyYardReturnMatch,RubyResolve
       @title ||= @data[:title] ? Title.new(@data[title]) : nil
     end
 
-    ##
-    # @return [String] the URL for the banner image associated with the account.
     def banner_url
       @data[:banner_url]
     end
 
-    ##
-    # @return [String] the URL for the profile image associated with the account.
     def profile_url
       @data[:profile_url]
     end
 
-    ##
-    # @return [String] A brief statement/biography the user has associated with their account.
     def bio
       @data[:bio]
     end
 
-    ##
-    # @return [String] a brief statement/biography the user has associated with their account in HTML format.
     def bio_html
       @data[:bio_html]
     end
 
-    ##
-    # @return [String?] the reason the user was banned if they were, otherwise `nil`.
     def ban_reason
       @data[:ban_reason]
     end
-
-    ##
-    # @return [String] the string representation of the object.
-    def to_s
-      @data[:username] || inspect
-    end
   end
 end

data/lib/ruqqus/version.rb

@@ -1,11 +1,15 @@
 module Ruqqus
 
   ##
-  # The Ruqqus gem version.
-  VERSION = '1.1.0'.freeze
+  # The Ruqqus gem version. Version changes implement the following versioning system:
+  #
+  #   * `MAJOR` Corresponds to the native Ruqqus API major version
+  #   * `MINOR` Indicates possible breaking API changes for existing code
+  #   * `REVISION` Added functionality, bug-fixes, and other non-breaking alterations
+  VERSION = '1.1.5'.freeze
 
   ##
-  # Lulz
+  # Please listen to this song I wrote. The song is called "Endless Summer".
   ENDLESS_SUMMER = 'https://youtu.be/o_LskiXQ73c'.freeze
 
   private_constant(:ENDLESS_SUMMER)