ruqqus 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aef052e6ba89775ce82f8d1474b12b74a0ec84260ae5abcb41b2c098e1befbf2
-  data.tar.gz: 79385f50df81574939d19746d8f36e9e66e075553ec980c5daa0d411cd27e60c
+  metadata.gz: 4c14af41785a17ac1c28bc3e89f778a1ce64571a2943e9ca44d4f5370c502de8
+  data.tar.gz: b7e33784b89a2df20e85ead8e7097ab53b48d3bf95311f9ef1555a04bc91a975
 SHA512:
-  metadata.gz: 2039cc29cfde59766c5d249c74b49c132b709db04553848d5e8915df242dc276f2b550289bc43b58b322987851e747feede7dbe7ee89ba5ef9f0e6c096afa546
-  data.tar.gz: d62ca8506d89f4c8e772fa24daf57c0dca3e6d90c57a473a82eb6b0e89c10ab564058c198c5fb75d038c573b8792945d51633e440857322b2d64f8dc6867386c
+  metadata.gz: a8557e744ce587f4d30c01b3ba954cec4eba4e5b3cd51ab408c202b4b3d6038f4db5e92f02d4667a7b289738d0efc5e578528535105877fb847c735eac162eb2
+  data.tar.gz: f421f465e5690496b21050950c6a177b01c7724b67752ae896aaf7ef500c972c0643bb88b82c0562285ed7bb4b9f82f8461e1677f2f212dbf25847e474e7649a

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 Documentation for library API changes.
 
+## Version 1.1.2
+
+* Implemented enumerating comments of guilds and posts
+
 ## Version 1.1.1
 
 * BUGFIX: Added acceptance of variable args to `Token#to_json`

data/README.md

@@ -41,7 +41,7 @@ To use the `ruqqus-oauth` helper to generate user tokens for desktop development
 
 Ruqqus enables 3rd-party client authorization using the [OAuth2 protocol](https://oauth.net/2/). Before it is possible
 to interact with the API, you will need to first [register an application](https://ruqqus.com/settings/apps), which can
-be supply you with an API key/secret pair. This key will allow you to authorize users and grant privileges with a an
+be supply you with an API key/secret pair. This key will allow you to authorize users and grant privileges with an
 assortment of scopes to fit your needs.
 
 ### Desktop Development

data/TODO.md

@@ -8,8 +8,6 @@ A scratch pad for things to do and ideas to look into
 * Update README with more examples
 * Create wiki on GitHub
 * Finish and cleanup and `ruqqus-oauth` app
-* Groups in documentation
-* Front page method?
 * Embed comment/posts API 
 
 # Missing API features

data/lib/ruqqus.rb

@@ -44,6 +44,40 @@ module Ruqqus
   class Error < StandardError
   end
 
+  ##
+  # @!attribute self.proxy [rw]
+  #   @return [URI?] the URI of the proxy server in use, or `nil` if none has been set.
+
+  ##
+  # Obtains a list of URIs of proxy servers that can be used to route network traffic through.
+  #
+  # @param anon [Symbol] anonymity filter for the servers to return, either `:transparent`, `:anonymous`, or `:elite`.
+  # @param country [String,Symbol] country filter for servers to return, an ISO-3166 two digit county code.
+  #
+  # @return [Array<URI>] an array of proxy URIs that match the input filters.
+  # @see https://www.nationsonline.org/oneworld/country_code_list.htm
+  def self.proxy_list(anon: :elite, country: nil)
+    raise(ArgumentError, 'invalid anonymity value') unless %i(transparent anonymous elite).include?(anon.to_sym)
+
+    url = "https://www.proxy-list.download/api/v1/get?type=https&anon=#{anon}"
+    url << "&country=#{country}" if country
+
+    RestClient.get(url) do |resp|
+      break if resp.code != 200
+      return resp.body.split.map { |proxy| URI.parse("https://#{proxy}") }
+    end
+    Array.new
+  end
+
+  def self.proxy
+    RestClient.proxy
+  end
+
+  def self.proxy=(uri)
+    raise(TypeError, "#{uri} is not a URI") if uri && !uri.is_a?(URI)
+    RestClient.proxy = uri
+  end
+
   ##
   # Helper function to automate uploading images to Imgur anonymously and returning the direct image link.
   #

data/lib/ruqqus/client.rb

@@ -146,10 +146,10 @@ module Ruqqus
     # @note This method is restricted to 6/minute, and will fail when that limit is exceeded.
     def comment_reply(body, comment)
       if comment.is_a?(Comment)
-        comment_submit(comment.full_name, comment.post_id, body)
+        comment_submit(comment.fullname, comment.post_id, body)
       else
         comment = self.comment(comment.to_s)
-        comment_submit(comment.full_name, comment.post_id, body)
+        comment_submit(comment.fullname, comment.post_id, body)
       end
     end
 
@@ -323,6 +323,54 @@ module Ruqqus
       self
     end
 
+    ##
+    # Enumerates through each comment in a guild, yielding each to a block.
+    #
+    # @param guild [Guild,String] a {Guild} instance, or the name of the guild to query.
+    # @yieldparam [Comment] yields a {Comment} to the block.
+    #
+    # @return [self]
+    # @raise [LocalJumpError] when a block is not supplied to the method.
+    def each_guild_comment(guild)
+      raise(LocalJumpError, 'block required') unless block_given?
+      name = guild.to_s
+      raise(ArgumentError, 'invalid guild name') unless Ruqqus::VALID_GUILD.match?(name)
+
+      page = 1
+      loop do
+        params = { page: page }
+        json = http_get("#{Routes::GUILD}#{name}/comments", headers(params: params))
+        break if json[:error]
+
+        json[:data].each { |hash| yield Comment.from_json(hash) }
+        break if json[:data].size < 25
+        page += 1
+      end
+
+      self
+    end
+
+    ##
+    # Enumerates through each comment in a guild, yielding each to a block.
+    #
+    # @param post [Post,String] a {Post} instance, or the unique ID of the post to query.
+    # @yieldparam [Comment] yields a {Comment} to the block.
+    #
+    # @return [self]
+    # @raise [LocalJumpError] when a block is not supplied to the method.
+    # @note This method is very inefficient, as it the underlying API does not yet implement it, therefore each comment
+    #   in the entire guild must be searched through.
+    def each_post_comment(post)
+      # TODO: This is extremely inefficient, but will have to do until it gets implemented in the API
+      raise(LocalJumpError, 'block required') unless block_given?
+      post = self.post(post) unless post.is_a?(Post)
+      each_guild_comment(post.guild_name) do |comment|
+        next unless comment.post_id == post.id
+        yield comment
+      end
+      self
+    end
+
     ##
     # Enumerates through every post on Ruqqus, yielding each post to a block.
     #

data/lib/ruqqus/token.rb

@@ -111,7 +111,7 @@ module Ruqqus
     ##
     # Loads the object from a JSON-formatted string.
     #
-    # @param json [String,Hash] a JSON string representing the object, or the parsed Hash of the JSON data.
+    # @param json [String,Hash] a JSON string representing the object, or the parsed Hash of the JSON (symbol keys).
     #
     # @return [Object] the loaded object.
     def self.from_json(payload)

data/lib/ruqqus/types/comment.rb

@@ -6,31 +6,37 @@ module Ruqqus
   class Comment < Submission
 
     ##
-    # @return [Integer] the level of "nesting" in the comment tree, starting at `1` when in direct reply to the post.
-    def level
-      @data[:level]
-    end
+    # @!attribute [r] level
+    #   @return [Integer] the level of "nesting" in the comment tree, starting at `1` when in direct reply to the post.
 
     ##
-    # @return [String] the unique ID of the parent for this comment.
-    def parent_id
-      @data[:parent]
-    end
+    # @!attribute parent_id
+    #   @return [String] the unique ID of the parent for this comment.
+
+    ##
+    # @!attribute [r] post_id
+    #   @return [String] the ID of the post this comment belongs to.
 
     ##
-    # @return [Boolean] `true` if {#parent_id} refers to a comment, otherwise `false` if a post.
+    # @return [Boolean] `true` if the comment's parent is comment, otherwise `false` if it is a post.
     def parent_comment?
       level > 1
     end
 
     ##
-    # @return [Boolean] `true` if {#parent_id} refers to a post, otherwise `false` if a comment.
+    # @return [Boolean] `true` if the comment's parent is post, otherwise `false` if it is a comment.
     def parent_post?
       level == 1
     end
 
-    ##
-    # @return [String] the ID of the post this comment belongs to.
+    def level
+      @data[:level]
+    end
+
+    def parent_id
+      @data[:parent]
+    end
+
     def post_id
       @data[:post]
     end

data/lib/ruqqus/types/guild.rb

@@ -5,28 +5,40 @@ module Ruqqus
   class Guild < ItemBase
 
     ##
-    # @return [String] the name of the guild.
-    def name
-      @data[:name]
-    end
+    # @!attribute [r] name
+    #   @return [String] the name of the guild.
 
     ##
-    # @return [Integer] the number of members subscribed to the guild.
-    def member_count
-      @data[:subscriber_count]&.to_i || 0
-    end
+    # @!attribute [r] member_count
+    #   @return [Integer] the number of members subscribed to the guild.
 
     ##
-    # @return [Integer] the number of guild masters who moderate this guild.
-    def gm_count
-      @data[:mods_count]&.to_i || 0
-    end
+    # @!attribute [r] fullname
+    #   @return [String] the full ID of the guild.
 
     ##
-    # @return [String] the full ID of the guild.
-    def full_name
-      @data[:fullname]
-    end
+    # @!attribute [r] guildmaster_count
+    #   @return [Integer] the number of guild masters who moderate this guild.
+
+    ##
+    # @!attribute [r] profile_url
+    #   @return [String] the URL for the profile image associated with the guild.
+
+    ##
+    # @!attribute [r] color
+    #   @return [String] the accent color used for the guild, in HTML format.
+
+    ##
+    # @!attribute [r] description
+    #   @return [String] the description of the guild.
+
+    ##
+    # @!attribute [r] description_html
+    #   @return [String] the description of the guild in HTML format.
+
+    ##
+    # @!attribute [r] banner_url
+    #   @return [String] the URL for the banner image associated with the guild.
 
     ##
     # @return [Boolean] `true` if the guild contains adult content and flagged as NSFW, otherwise `false`.
@@ -47,39 +59,45 @@ module Ruqqus
     end
 
     ##
-    # @return [String] the description of the guild.
-    def description
-      @data[:description]
+    # @return [String] the string representation of the object.
+    def to_s
+      @data[:name] || inspect
     end
 
-    ##
-    # @return [String] the description of the guild in HTML format.
-    def description_html
-      @data[:description_html]
+    def description
+      @data[:description]
     end
 
-    ##
-    # @return [String] the URL for the banner image associated with the guild.
     def banner_url
       @data[:banner_url]
     end
 
-    ##
-    # @return [String] the URL for the profile image associated with the guild.
+    def description_html
+      @data[:description_html]
+    end
+
     def profile_url
       @data[:profile_url]
     end
 
-    ##
-    # @return [String] the accent color used for the guild, in HTML format.
     def color
       @data[:color]
     end
 
-    ##
-    # @return [String] the string representation of the object.
-    def to_s
-      @data[:name] || inspect
+    def name
+      @data[:name]
+    end
+
+    def member_count
+      @data[:subscriber_count]&.to_i || 0
+    end
+
+    def guildmaster_count
+      @data[:mods_count]&.to_i || 0
+    end
+
+    def fullname
+      @data[:fullname]
     end
   end
 end

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

@@ -2,7 +2,7 @@ module Ruqqus
 
   ##
   # The Ruqqus gem version.
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.1.2'.freeze
 
   ##
   # Lulz

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruqqus
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - ForeverZer0
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client