ruqqus 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddc434cd09ab2ab6f3c4460bd6d309e4311af4c6349e5fba9cdb89cc257133ab
-  data.tar.gz: 47f92d628a870e88ef893dea295c86e4bfd9b770b7fafa23caf988ba8bd3c798
+  metadata.gz: 62b35161bf5278e264c66836f39a80de3492dcd627f7e1e9d701a5439af30649
+  data.tar.gz: 0cbc0628bcceebaac0770ed2c2fa5558d632ab3f02f5c7c9deb500f9552c3e4f
 SHA512:
-  metadata.gz: c01173a089510e8deb760dcab13144cfa5e5678ddfa5a2e136066c0de3d61cb192b30eadb461d28de588ba711c6ebe66d1c7b92fd83a8e2dff3694d51fb58611
-  data.tar.gz: 05ac950bf17799b45cfef60b3734f432c05906ab7caf8adf8b7e14898b53e46027284a671b9db32a70f45500382ff44dbec84e7b5fd12932ff76351e86d245ee
+  metadata.gz: da177c6d90e02598bb5438d79b3c0fca5219922a1bda1d20a67e458be8bebf078621c45bdbf557f84c278bfa2d668cee6002911512a98ce6dda8945383c97c72
+  data.tar.gz: 46f0839094cfd3e134df3719cc7bf189df295963f34a106c0540063af57d5dac887c7ca5c019e1afb7152c4d4051a025b1dbe12dd7f287ac4c316e9fe265bc18

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] "
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/CHANGELOG.md

@@ -10,6 +10,15 @@ Versioning system:
 * `MINOR` Indicates possible breaking API changes for existing code
 * `REVISION` Added functionality, bug-fixes, and other non-breaking alterations
 
+## Version 1.1.5
+
+* Added `Ruqqus::Clien#post_delete` method
+* Added `Ruqqus::Guild#guildmasters` attribute
+
+## Version 1.1.4
+
+* Improved the way refreshing works to do so within a certain threshold
+
 ## Version 1.1.3
 
 * Implemented browser-based confirmation process

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,51 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery  
+* Personal attacks  
+* Trolling or insulting/derogatory comments  
+* Public or private harassment  
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission  
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful. This will always involve a public and
+open discussion of the action beinng taken in full transparency.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at efreed09@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.  
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# How to contribute
+First of all, thank you for taking the time to contribute to this project. We've tried to make a stable project and try to fix bugs and add new features continuously. You can help us do more.
+
+## Getting started
+
+### Check out existing issues/pull requests
+
+If there is a bug or a feature that is not listed in the **issues** page or there is no one assigned to the issue, feel free to fix/add it! Although it's better to discuss it in the issue or create a new issue for it so there is no confilcting code.
+
+### Writing some code!
+
+Contributing to a project on Github is pretty straight forward. If this is you're first time, these are the steps you should take.
+
+- Fork this repo.
+
+And that's it! Read the code available and change the part you don't like! You're change should not break the existing code and should pass the tests.
+
+If you're adding a new functionality, start from the branch **master**. It would be a better practice to create a new branch and work in there.
+
+When you're done, submit a pull request and for one of the maintainers to check it out. We would let you know if there is any problem or any changes that should be considered.
+
+### Documentation
+
+This project enforces 100% documentation coverage, even on non-public methods that aren't part of the API surface. We use [YARD](https://www.rubydoc.info/gems/yard/file/docs/Tags.md) as our tool of choice for documentation. It is rather intuitive, but feel free to ask if you questions if unsure or are unfamiliar with it. Pull requests will not be merged unless documented, so please don't forget to include it!

data/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-<img src="https://raw.githubusercontent.com/ruqqus/ruqqus/master/ruqqus/assets/images/logo/ruqqus_text_logo.png" width="250"/>
+<img src="https://raw.githubusercontent.com/ForeverZer0/ruqqus/master/assets/ruqqus_text_logo.png" width="360"/>
 </p>
 
 <hr>
@@ -97,7 +97,10 @@ and where you store this information so that it is not compromised.
 
 ## Usage
 
-See the [documentation](https://www.rubydoc.info/gems/ruqqus) for a complete API reference (100% coverage).
+For in-depth documentation and instructions on how to get started, please see the following resources:
+
+* [API Documentation](https://www.rubydoc.info/gems/ruqqus) - Complete documentation of the entire API (100% coverage)
+* [Wiki](https://github.com/ForeverZer0/ruqqus/wiki) - Public wiki with more in-depth explanation, code samples, best practices, etc.
 
 ### Features
 

data/lib/ruqqus/client.rb

@@ -52,6 +52,7 @@ module Ruqqus
       @client_secret = client_secret || raise(ArgumentError, 'client secret cannot be nil')
 
       @token = token.is_a?(Token) ? token : Token.new(client_id, client_secret, token.to_s)
+      @token.refresh(client_id, client_secret)
       @session = nil
     end
 
@@ -173,6 +174,18 @@ module Ruqqus
       http_post(url).empty? rescue false
     end
 
+    ##
+    # Deletes an existing post.
+    #
+    # @param post [Comment,String] a {Post} instance, or the unique ID of the post to delete.
+    #
+    # @return [Boolean] `true` if deletion completed without error, otherwise `false`.
+    def post_delete(post)
+      id = post.is_a?(Post) ? post.id : post.sub(/^t3_/, '')
+      url = "#{Routes::API_BASE}/delete_post/#{id}"
+      http_post(url).empty? rescue false
+    end
+
     # @!endgroup Commenting
 
     # @!group Posting
@@ -563,7 +576,7 @@ module Ruqqus
     # @api private
     # Checks if token is expired, and refreshes if so, calling the {#token_refreshed} block as if defined.
     def refresh_token
-      return unless @token.expired?
+      return unless @token.need_refresh?
       @token.refresh(@client_id, @client_secret)
       @refreshed&.call(@token)
     end

data/lib/ruqqus/token.rb

@@ -4,6 +4,10 @@ module Ruqqus
   # Represents a Ruqqus [OAuth2](https://oauth.net/2/) access token.
   class Token
 
+    ##
+    # The minimum number of seconds that can remain before the token refreshes itself.
+    REFRESH_THRESHOLD = 60
+
     ##
     # @!attribute [r] access_token
     #   @return [String] the access token value.
@@ -74,6 +78,7 @@ module Ruqqus
       data = JSON.parse(resp.body, symbolize_names: true)
       raise(Ruqqus::Error, 'failed to refresh authentication token') unless resp.code == 200 || data[:oauth_error]
       @data.merge!(data)
+      sleep(1) # TODO: Test. Get internment 401 error when token needs refreshed
     end
 
     ##
@@ -82,6 +87,12 @@ module Ruqqus
       expires <= Time.now
     end
 
+    ##
+    # @return [Boolean] `true` if remaining lifetime is within the {REFRESH_THRESHOLD}, otherwise `false`.
+    def need_refresh?
+      (expires - Time.now) < REFRESH_THRESHOLD
+    end
+
     ##
     # @return [String] the object as a JSON-formatted string.
     def to_json(*_unused_)

data/lib/ruqqus/types/guild.rb

@@ -40,6 +40,10 @@ module Ruqqus
     # @!attribute [r] banner_url
     #   @return [String] the URL for the banner image associated with the guild.
 
+    ##
+    # @!attribute [r] guildmasters
+    #   @return [Array<User>] an array of {User} instances of the moderators for this guild.
+
     ##
     # @return [Boolean] `true` if the guild contains adult content and flagged as NSFW, otherwise `false`.
     def nsfw?
@@ -99,5 +103,10 @@ module Ruqqus
     def fullname
       @data[:fullname]
     end
+
+    def guildmasters
+      return Array.new unless @data[:guildmasters]
+      @data[:guildmasters].map { |gm| User.from_json(gm) }
+    end
   end
 end

data/lib/ruqqus/version.rb

@@ -6,7 +6,7 @@ module Ruqqus
   #   * `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
+  VERSION = '1.1.5'.freeze
 
   ##
   # Please listen to this song I wrote. The song is called "Endless Summer".

data/ruqqus.gemspec

@@ -40,5 +40,5 @@ Gem::Specification.new do |spec|
   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".'
+  spec.post_install_message = "Please listen to this song I wrote. The song is called \"Endless Summer\".\r\n"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruqqus
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - ForeverZer0
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -89,15 +89,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - TODO.md
+- assets/ruby-ruqqus.png
+- assets/ruqqus_text_logo.png
 - bin/console
 - bin/setup
 - exe/ruqqus-oauth
@@ -126,8 +132,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: Please listen to this song I wrote. The song is called "Endless
-  Summer".
+post_install_message: "Please listen to this song I wrote. The song is called \"Endless
+  Summer\".\r\n"
 rdoc_options: []
 require_paths:
 - lib