ruqqus 0.1.0 → 1.1.3

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/types/submission.rb

@@ -0,0 +1,139 @@
+
+module Ruqqus
+
+  ##
+  # @abstract
+  # Base class for {Post} and {Comment} types.
+  class Submission < ItemBase
+
+    ##
+    # @!attribute [r] title
+    #   @return [String] the name/title of this item.
+
+    ##
+    # @!attribute [r] author_name
+    #   @return [String?] the name of the creator of the item, or `nil` if deleted account.
+
+    ##
+    # @!attribute [r] body
+    #   @return [String] the text body of the item.
+
+    ##
+    # @!attribute [r] body_html
+    #   @return [String] the text body of the item in HTML format.
+
+    ##
+    # @!attribute [r] last_edit_utc
+    #   @return [Integer] the time of the last edit in seconds since the Unix epoch, or `0` if never edited.
+
+    ##
+    # @!attribute [r] last_edit
+    #   @return [Time] the time of the last edit.
+
+    ##
+    # @!attribute [r] upvotes
+    #   @return [Integer] the number of upvotes this item has received.
+
+    ##
+    # @!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.
+
+    ##
+    # @!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
+
+    ##
+    # @return [Boolean] `true` if item is adult content and flagged as NSFW, otherwise `false`.
+    def nsfw?
+      !!@data[:is_nsfw]
+    end
+
+    ##
+    # @return [Boolean] `true` if item is adult content and flagged as NSFL, otheriwse `false`.
+    def nsfl?
+      !!@data[:is_nsfl]
+    end
+
+    ##
+    # @return [Boolean] `true` if item has been archived, otherwise `false`.
+    def archived?
+      !!@data[:is_archived]
+    end
+
+    ##
+    # @return [Boolean] `true` if item has been deleted, otherwise `false`.
+    def deleted?
+      !!@data[:is_deleted]
+    end
+
+    ##
+    # @return [Boolean] `true` if item has been classified has offensive, otherwise `false`.
+    def offensive?
+      !!@data[:is_offensive]
+    end
+
+    ##
+    # @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
+
+    def guild_name
+      @data[:guild_name]
+    end
+
+    def title
+      @data[:title]
+    end
+  end
+end

data/lib/ruqqus/types/title.rb

@@ -0,0 +1,48 @@
+
+module Ruqqus
+
+  ##
+  # Describes a title associated with a username.
+  class Title
+
+    ##
+    # @!attribute [r] id
+    #   @return [Integer] a unique ID associated with this title.
+
+    ##
+    # @!attribute [r] text
+    #   @return [String] the text value of the title.
+
+    ##
+    # @!attribute [r] color
+    #   @return [String] the color used to display the title in HTML format.
+
+    ##
+    # @!attribute [r] kind
+    #   @return [Integer] an integer determining the "rank" of the title.
+
+    ##
+    # Creates a new instance of the {Title} class.
+    #
+    # @param data [Hash] the parsed JSON payload defining this instance.
+    def initialize(data)
+      @data = data || raise(ArgumentError, 'data cannot be nil')
+    end
+
+    def id
+      @data[:id]
+    end
+
+    def text
+      @data[:text]
+    end
+
+    def color
+      @data[:color]
+    end
+
+    def kind
+      @data[:kind]
+    end
+  end
+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,3 +1,16 @@
 module Ruqqus
-  VERSION = "0.1.0"
+
+  ##
+  # 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.3'.freeze
+
+  ##
+  # 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)
 end

data/ruqqus.gemspec

@@ -2,20 +2,24 @@ require_relative 'lib/ruqqus/version'
 
 Gem::Specification.new do |spec|
 
+  # Required specifications
   spec.name          = 'ruqqus'
   spec.version       = Ruqqus::VERSION
   spec.authors       = ['ForeverZer0']
   spec.email         = ['efreed09@gmail.com']
-
-  spec.summary       = %q{Base library for interacting with the ruqqus.com API.}
-  spec.description   = %q{Base library for interacting with the ruqqus.com API.}
+  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')
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/ForeverZer0/ruqqus'
-  spec.metadata['changelog_uri'] = 'https://github.com/ForeverZer0/ruqqus/CHANGELOG.md'
+  # Metadata
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri']      = spec.homepage
+  spec.metadata['source_code_uri']   = 'https://github.com/ForeverZer0/ruqqus'
+  spec.metadata['changelog_uri']     = 'https://github.com/ForeverZer0/ruqqus/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://www.rubydoc.info/gems/ruqqus'
+  spec.metadata['bug_tracker_uri']   = 'https://github.com/ForeverZer0/ruqqus/issues'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -23,9 +27,17 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
+  # Register executables (none yet...)
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency('nokogiri', '~> 1.10')
+  # 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('yard', '~> 0.9')
+
+  spec.post_install_message = 'Please listen to this song I wrote. The song is called "Endless Summer".'
 end

metadata

@@ -1,56 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: ruqqus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.3
 platform: ruby
 authors:
 - ForeverZer0
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
-description: Base library for interacting with the ruqqus.com API.
+        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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
 email:
 - efreed09@gmail.com
-executables: []
+executables:
+- ruqqus-oauth
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/console
 - bin/setup
+- exe/ruqqus-oauth
 - lib/ruqqus.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
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/ForeverZer0/ruqqus
   source_code_uri: https://github.com/ForeverZer0/ruqqus
   changelog_uri: https://github.com/ForeverZer0/ruqqus/CHANGELOG.md
-post_install_message:
+  documentation_uri: https://www.rubydoc.info/gems/ruqqus
+  bug_tracker_uri: https://github.com/ForeverZer0/ruqqus/issues
+post_install_message: Please listen to this song I wrote. The song is called "Endless
+  Summer".
 rdoc_options: []
 require_paths:
 - lib
@@ -68,5 +131,6 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: Base library for interacting with the ruqqus.com API.
+summary: A Ruby API implementation for Ruqqus, an open-source platform for online
+  communities
 test_files: []