ruqqus 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c14af41785a17ac1c28bc3e89f778a1ce64571a2943e9ca44d4f5370c502de8
-  data.tar.gz: b7e33784b89a2df20e85ead8e7097ab53b48d3bf95311f9ef1555a04bc91a975
+  metadata.gz: 1274eade9799203bd720c94da255a81a0e0295da9e438519a687626c1db7f0b7
+  data.tar.gz: 96fe1b73d77d38004981f476ddca3acde81577755de6939f77c6c4ea65fdc693
 SHA512:
-  metadata.gz: a8557e744ce587f4d30c01b3ba954cec4eba4e5b3cd51ab408c202b4b3d6038f4db5e92f02d4667a7b289738d0efc5e578528535105877fb847c735eac162eb2
-  data.tar.gz: f421f465e5690496b21050950c6a177b01c7724b67752ae896aaf7ef500c972c0643bb88b82c0562285ed7bb4b9f82f8461e1677f2f212dbf25847e474e7649a
+  metadata.gz: da793dbcee6ae0cd28b6f5160f85a752804a44ceb00f295291209e2529a3ba39ed26300f43b8b9df95f4ce41b7c3c10b97f60550eed9b9ce5c27c50b4252a638
+  data.tar.gz: 92b77622dcaf2fa8129e013465a91186d1de731eb927bcd219fac8160c7afccceb2beecf4f509f7e3b9fe95c8b9431955d301566eeaa5608302a2331ce87743c

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 Documentation for library API changes.
 
+Versioning system:
+
+`MAJOR.MINOR.REVISION`
+
+* `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
+
+* Implemented browser-based confirmation process
+* Implemented capturing confirmation code from `localhost`  OAuth redirects
+* Fixed bug in querying guild/username availability
+
 ## Version 1.1.2
 
 * Implemented enumerating comments of guilds and posts

data/lib/ruqqus.rb

@@ -1,5 +1,9 @@
-require 'rest-client'
+require 'base64'
 require 'json'
+require 'rbconfig'
+require 'rest-client'
+require 'securerandom'
+require 'socket'
 
 require_relative 'ruqqus/token'
 require_relative 'ruqqus/routes'
@@ -49,12 +53,14 @@ module Ruqqus
   #   @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.
+  # Obtains a list of URIs of free 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.
+  # @note These proxies are free, keep that in mind. They are refreshed frequently, can go down unexpectedly, be slow,
+  #   and other manners of inconvenience that can be expected with free services.
   # @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)
@@ -83,7 +89,7 @@ module Ruqqus
   #
   # @param client_id [String] an Imgur client ID
   # @param image_path [String] the path to an image file.
-  # @params opts [Hash] the options hash.
+  # @param opts [Hash] the options hash.
   # @option opts [String] :title a title to set on the Imgur post
   # @option opts [String] :description a description to set on the Imgur post
   #
@@ -111,7 +117,14 @@ module Ruqqus
   #
   # @return [Boolean] `true` is name is available, otherwise `false` if it has been reserved or is in use.
   def self.guild_available?(guild_name)
-    available?(guild_name, VALID_GUILD, "#{Routes::GUILD_AVAILABLE}#{name}")
+    begin
+      response = RestClient.get("#{Routes::GUILD_AVAILABLE}#{guild_name}")
+      json = JSON.parse(response.body, symbolize_names: true)
+      return json[:available]
+    rescue
+      puts 'err'
+      return false
+    end
   end
 
   ##
@@ -121,22 +134,145 @@ module Ruqqus
   #
   # @return [Boolean] `true` is name is available, otherwise `false` if it has been reserved or is in use.
   def self.username_available?(username)
-    available?(username, VALID_USERNAME, "#{Routes::USERNAME_AVAILABLE}#{name}")
+    begin
+      response = RestClient.get("#{Routes::USERNAME_AVAILABLE}#{username}")
+      json = JSON.parse(response.body)
+      return json[username]
+    rescue
+      return false
+    end
+  end
+
+  ##
+  # Generates a URL for the user to navigate to that will allow them to authorize an application.
+  #
+  # @param client_id [String] the unique ID of the approved client to authorize.
+  # @param redirect [String] the redirect URL where the client sends the OAuth authorization code.
+  # @param scopes [Array<Symbol>] a collection of values indicating the permissions the application is requesting from
+  #   the user. See {Ruqqus::Client::SCOPES} for valid values.
+  # @param permanent [Boolean] `true` if authorization should persist until user explicitly revokes it,
+  #   otherwise `false`.
+  # @param csrf [String] a token to authenticate and prevent a cross-site request forgery (CSRF) attack, or `nil` if
+  #   you do not plan to validate the presence of the cookie in the redirection.
+  #
+  # @see https://ruqqus.com/settings/apps
+  # @see https://owasp.org/www-community/attacks/csrf
+  def self.authorize_url(client_id, redirect, scopes, permanent = true, csrf = nil)
+
+    raise(ArgumentError, 'invalid redirect URI') unless URI.regexp =~ redirect
+    raise(ArgumentError, 'scopes cannot be empty') unless scopes && !scopes.empty?
+
+    scopes = scopes.map(&:to_sym)
+    raise(ArgumentError, "invalid scopes specified") unless scopes.all? { |s| Client::SCOPES.include?(s) }
+    if scopes.any? { |s| [:create, :update, :guildmaster].include?(s) } && !scopes.include?(:identity)
+      # Add identity permission if missing, which is obviously required for a few other permissions
+      scopes << :identity
+    end
+
+    url = 'https://ruqqus.com/oauth/authorize'
+    url << "?client_id=#{client_id || raise(ArgumentError, 'client ID cannot be nil')}"
+    url << "&redirect_uri=#{redirect}"
+    url << "&scope=#{scopes.join(',')}"
+    url << "&state=#{csrf || Base64.encode64(SecureRandom.uuid).chomp}"
+    url << "&permanent=#{permanent}"
+    url
   end
 
-  private
 
   ##
-  # Checks if the specified guild or user name is available to be created.
+  # Opens a URL in the system's default web browser, using the appropriate command for the host platform.
   #
-  # @param name [String] the name of a guild or username to query.
-  # @param regex [Regex] a validation regex for the name.
-  # @param route [String] the API endpoint to invoke.
+  # @param [String] the URL to open.
   #
-  # @return [Boolean] `true` is name is available, otherwise `false` if it has been reserved or is in use.
-  def self.available?(name, regex, route)
-    return false unless name && regex.match?(name)
-    json = JSON.parse(RestClient.get(route))
-    !!json[name]
+  # @return [void]
+  def self.open_browser(url)
+
+    cmd = case RbConfig::CONFIG['host_os']
+    when /mswin|mingw|cygwin/ then "start \"\"#{url}\"\""
+    when /darwin/ then "open '#{url}'"
+    when /linux|bsd/ then "xdg-open '#{url}'"
+    else raise(Ruqqus::Error, 'unable to determine how to open URL for current platform')
+    end
+
+    system(cmd)
+  end
+
+  ##
+  # If using a `localhost` address for your application's OAuth redirect, this method can be used to open a socket and
+  # listen for a request, returning the authorization code once it arrives.
+  #
+  # @param port [Integer] the port to listen on.
+  # @param timeout [Numeric] sets the number of seconds to wait before cancelling and returning `nil`.
+  #
+  # @return [String?] the authorization code, `nil` if an error occurred.
+  # @note This method is blocking, and will *not* return until a connection is made and data is received on the
+  #   specified port, or the timeout is reached.
+  def self.wait_for_code(port, timeout = 30)
+
+    thread = Thread.new do
+      sleep(timeout)
+      TCPSocket.open('localhost', port) { |s| s.puts }
+    end
+
+    params = {}
+    TCPServer.open('localhost', port) do |server|
+
+      session = server.accept
+      request = session.gets
+      match = /^GET [\/?]+(.*) HTTP.*/.match(request)
+
+      Thread.kill(thread)
+      return nil unless match
+
+      $1.split('&').each do |str|
+        key, value = str.split('=')
+        next unless key && value
+        params[key.to_sym] = value
+      end
+
+      session.puts "HTTP/1.1 200\r\n"
+      session.puts "Content-Type: text/html\r\n"
+      session.puts "\r\n"
+      session.puts create_response(!!params[:code])
+
+      session.close
+    end
+
+    params[:code]
+  end
+
+  private
+
+  ##
+  # @return [String] a generic confirmation page to display in the user's browser after confirming application access.
+  def self.create_response(success)
+    args = success ? ['#339966', 'Authorization Confirmed'] : ['#ff0000', 'Authorization Failed']
+    format ='<h1 style="text-align: center;"><span style="color: %s;"><strong>%s</strong></span></h1>'
+    message = sprintf(format, *args)
+    <<-EOS
+<html>
+<head>
+    <style>
+    .center {
+      margin: 0;
+      position: absolute;
+      top: 50%;
+      left: 50%;
+      -ms-transform: translate(-50%, -50%);
+      transform: translate(-50%, -50%);
+    }
+  </style>
+</head>
+<body>
+<div class="center">
+    <div><img src="https://raw.githubusercontent.com/ruqqus/ruqqus/master/ruqqus/assets/images/logo/ruqqus_text_logo.png" alt="" width="365" height="92" /></div>
+    <p style="text-align: center;">&nbsp;</p>
+    #{message}
+    <p style="text-align: center;">&nbsp;&nbsp;</p>
+    <p style="text-align: center;"><span style="color: #808080;">You can safely close the tab/browser and return to the application.</span></p>
+</div>
+</body>
+</html>
+    EOS
   end
 end

data/lib/ruqqus/client.rb

@@ -62,7 +62,7 @@ module Ruqqus
     #
     # @return [User] the requested {User}.
     #
-    # @raise [ArgumentError] when `username` is `nil` or value does match the {VALID_USERNAME} regular expression.
+    # @raise [ArgumentError] when `username` is `nil` or value does match the {Ruqqus::VALID_USERNAME} regular expression.
     # @raise [Error] thrown when user account does not exist.
     def user(username)
       raise(ArgumentError, 'username cannot be nil') unless username
@@ -77,7 +77,7 @@ module Ruqqus
     #
     # @return [Guild] the requested {Guild}.
     #
-    # @raise [ArgumentError] when `guild_name` is `nil` or value does match the {VALID_GUILD} regular expression.
+    # @raise [ArgumentError] when `guild_name` is `nil` or value does match the {Ruqqus::VALID_GUILD} regular expression.
     # @raise [Error] thrown when guild does not exist.
     def guild(guild_name)
       raise(ArgumentError, 'guild_name cannot be nil') unless guild_name
@@ -92,7 +92,7 @@ module Ruqqus
     #
     # @return [Post] the requested {Post}.
     #
-    # @raise [ArgumentError] when `post_id` is `nil` or value does match the {VALID_POST} regular expression.
+    # @raise [ArgumentError] when `post_id` is `nil` or value does match the {Ruqqus::VALID_POST} regular expression.
     # @raise [Error] thrown when a post with the specified ID does not exist.
     def post(post_id)
       raise(ArgumentError, 'post_id cannot be nil') unless post_id
@@ -107,7 +107,7 @@ module Ruqqus
     #
     # @return [Comment] the requested {Comment}.
     #
-    # @raise [ArgumentError] when `comment_id` is `nil` or value does match the {VALID_POST} regular expression.
+    # @raise [ArgumentError] when `comment_id` is `nil` or value does match the {Ruqqus::VALID_POST} regular expression.
     # @raise [Error] when a comment with the specified ID does not exist.
     def comment(comment_id)
       raise(ArgumentError, 'comment_id cannot be nil') unless comment_id

data/lib/ruqqus/version.rb

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

@@ -36,7 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('rest-client', '~> 2.1')
 
   spec.add_development_dependency('mechanize', '~> 2.7')
-  spec.add_development_dependency('rake', '~> 13.0')
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruqqus
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - ForeverZer0
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-07 00:00:00.000000000 Z
+date: 2020-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
@@ -126,7 +112,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