ruqqus 1.0.0 → 1.1.4

data/lib/ruqqus/types/post.rb

@@ -0,0 +1,70 @@
+
+module Ruqqus
+
+  ##
+  # Represents a post on Ruqqus.
+  class Post < Submission
+
+    ##
+    # @!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,RubyResolve
+      @author_title ||= @data[:author_title] ? Title.new(@data[:author_title]) : nil
+    end
+
+    def comment_count
+      @data[:comment_count]
+    end
+
+    def domain
+      @data[:domain]
+    end
+
+    def embed_url
+      @data[:embed_url]
+    end
+
+    def original_guild_name
+      @data[:original_guild_name]
+    end
+
+    def thumb_url
+      @data[:thumb_url]
+    end
+
+    def url
+      #noinspection RubyYardReturnMatch
+      @data[:url]&.empty? ? nil : @data[:url]
+    end
+  end
+end

data/lib/ruqqus/{submission.rb → types/submission.rb}

@@ -1,4 +1,3 @@
-require_relative 'item_base'
 
 module Ruqqus
 
@@ -8,64 +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 creator of the item, or `nil` if deleted account.
-    def author
-      #noinspection RubyYardReturnMatch
-      @author ||= author_name ? Ruqqus.user(author_name) : nil
-    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.
-    def body
-      @data[:body]
-    end
+    # @!attribute [r] body
+    #   @return [String] the text body of the item.
 
     ##
-    # @return [String] the text body of the item in HTML format.
-    def body_html
-      @data[:body_html]
-    end
+    # @!attribute [r] body_html
+    #   @return [String] the text body of the item in HTML format.
 
     ##
-    # @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] last_edit_utc
+    #   @return [Integer] the time of the last edit in seconds since the Unix epoch, or `0` if never edited.
 
     ##
-    # @return [Time] the time of the last edit.
-    def last_edit
-      Time.at(@data[:edited_utc])
-    end
+    # @!attribute [r] last_edit
+    #   @return [Time] the time of the last edit.
 
     ##
-    # @return [Boolean] `true` if post has been edited, otherwise `false`.
-    def edited?
-      @data[:edited_utc] != 0
-    end
+    # @!attribute [r] upvotes
+    #   @return [Integer] the number of upvotes this item has received.
 
     ##
-    # @return [Integer] the number of upvotes this item has received.
-    def upvotes
-      @data[:upvotes]
-    end
+    # @!attribute [r] downvotes
+    #   @return [Integer] the number of downvotes this item has received.
 
     ##
-    # @return [Integer] the number of downvotes this item has received.
-    def downvotes
-      @data[:downvotes]
-    end
+    # @!attribute [r] score
+    # @return [Integer] a score calculated by adding upvotes and subtracting downvotes.
 
     ##
-    # @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
 
     ##
@@ -99,32 +87,51 @@ module Ruqqus
     end
 
     ##
-    # @return [String] the full ID of this item.
-    def full_name
-      @data[:fullname]
+    # @return [String] the string representation of the object.
+    def to_s
+      @data[:id]
     end
 
-    ##
-    # @return [String] the name of the guild this item is contained within.
-    def guild_name
-      @data[:guild_name]
+    def author_name
+      @data[:author]
     end
 
-    ##
-    # @return [Guild?] the guild this item is contained within.
-    def guild
-      #noinspection RubyYardReturnMatch
-      @guild ||= guild_name ? Ruqqus.guild(guild_name) : nil
+    def body
+      @data[:body]
     end
 
-    ##
-    # @return [String] a unique ID associated with this item.
-    def id
-      @data[:id]
+    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
+
+    def guild_name
+      @data[:guild_name]
     end
 
-    ##
-    # @return [String] the name/title of this item.
     def title
       @data[:title]
     end

data/lib/ruqqus/types/user.rb

@@ -0,0 +1,118 @@
+
+module Ruqqus
+
+  ##
+  # Represents a Ruqqus user account.
+  class User < ItemBase
+
+    ##
+    # @!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
+
+    def post_count
+      @data[:post_count] || 0
+    end
+
+    def comment_rep
+      @data[:comment_rep] || 0
+    end
+
+    def post_rep
+      @data[:post_rep] || 0
+    end
+
+    def total_rep
+      comment_rep + post_rep
+    end
+
+    ##
+    # @return [String] the username of the account.
+    def username
+      @data[:username]
+    end
+
+    def badges
+      #noinspection RubyResolve
+      @badges ||= @data[:badges].map { |b| Badge.new(b) }
+    end
+
+    def title
+      #noinspection RubyYardReturnMatch,RubyResolve
+      @title ||= @data[:title] ? Title.new(@data[title]) : nil
+    end
+
+    def banner_url
+      @data[:banner_url]
+    end
+
+    def profile_url
+      @data[:profile_url]
+    end
+
+    def bio
+      @data[:bio]
+    end
+
+    def bio_html
+      @data[:bio_html]
+    end
+
+    def ban_reason
+      @data[:ban_reason]
+    end
+  end
+end

data/lib/ruqqus/version.rb

@@ -1,11 +1,15 @@
 module Ruqqus
 
   ##
-  # The Ruqqus gem version.
-  VERSION = '1.0.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.4'.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)

data/ruqqus.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.version       = Ruqqus::VERSION
   spec.authors       = ['ForeverZer0']
   spec.email         = ['efreed09@gmail.com']
-  spec.summary       = %q{A Ruby API implementation for Ruqqus, an open-source platform for online communities, free of censorship and moderator abuse by design.}
-  spec.description   = %q{A Ruby API implementation for Ruqqus, an open-source platform for online communities, free of censorship and moderator abuse by design. While platform is still in Beta at this time and the public API for it is still quite limited, this gem will be actively updated as it continues to grow and is developed.}
+  spec.summary       = %q{A Ruby API implementation for Ruqqus, an open-source platform for online communities}
+  spec.description   = %q{A Ruby API implementation for Ruqqus, an open-source platform for online communities, free of censorship and moderator abuse by design.}
   spec.homepage      = 'https://github.com/ForeverZer0/ruqqus'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
@@ -35,6 +35,10 @@ Gem::Specification.new do |spec|
   # Dependencies
   spec.add_runtime_dependency('rest-client', '~> 2.1')
 
+  spec.add_development_dependency('mechanize', '~> 2.7')
+  spec.add_development_dependency('tty-prompt', '~> 0.22')
   spec.add_development_dependency('rake', '~> 13.0')
   spec.add_development_dependency('yard', '~> 0.9')
+
+  spec.post_install_message = 'Please listen to this song I wrote. The song is called "Endless Summer".'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruqqus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.4
 platform: ruby
 authors:
 - ForeverZer0
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,12 +81,11 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: A Ruby API implementation for Ruqqus, an open-source platform for online
-  communities, free of censorship and moderator abuse by design. While platform is
-  still in Beta at this time and the public API for it is still quite limited, this
-  gem will be actively updated as it continues to grow and is developed.
+  communities, free of censorship and moderator abuse by design.
 email:
 - efreed09@gmail.com
-executables: []
+executables:
+- ruqqus-oauth
 extensions: []
 extra_rdoc_files: []
 files:
@@ -70,17 +97,23 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
+- exe/ruqqus-oauth
 - lib/ruqqus.rb
-- lib/ruqqus/badge.rb
-- lib/ruqqus/comment.rb
-- lib/ruqqus/guild.rb
-- lib/ruqqus/item_base.rb
-- lib/ruqqus/post.rb
-- lib/ruqqus/submission.rb
-- lib/ruqqus/title.rb
-- lib/ruqqus/user.rb
+- lib/ruqqus/client.rb
+- lib/ruqqus/routes.rb
+- lib/ruqqus/token.rb
+- lib/ruqqus/types.rb
+- lib/ruqqus/types/badge.rb
+- lib/ruqqus/types/comment.rb
+- lib/ruqqus/types/guild.rb
+- lib/ruqqus/types/item_base.rb
+- lib/ruqqus/types/post.rb
+- lib/ruqqus/types/submission.rb
+- lib/ruqqus/types/title.rb
+- lib/ruqqus/types/user.rb
 - lib/ruqqus/version.rb
 - ruqqus.gemspec
 homepage: https://github.com/ForeverZer0/ruqqus
@@ -93,7 +126,8 @@ metadata:
   changelog_uri: https://github.com/ForeverZer0/ruqqus/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/ruqqus
   bug_tracker_uri: https://github.com/ForeverZer0/ruqqus/issues
-post_install_message:
+post_install_message: Please listen to this song I wrote. The song is called "Endless
+  Summer".
 rdoc_options: []
 require_paths:
 - lib
@@ -112,5 +146,5 @@ rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A Ruby API implementation for Ruqqus, an open-source platform for online
-  communities, free of censorship and moderator abuse by design.
+  communities
 test_files: []