ruqqus 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb4087c263dae6ef0708a07d756733ea19f95e1e6f02983c658c9cfb40a2f475
-  data.tar.gz: d9d71b14897ec30ea1f5356916d1eb2cc432db02e7c007fb5f8efcea3a3f37fa
+  metadata.gz: aef052e6ba89775ce82f8d1474b12b74a0ec84260ae5abcb41b2c098e1befbf2
+  data.tar.gz: 79385f50df81574939d19746d8f36e9e66e075553ec980c5daa0d411cd27e60c
 SHA512:
-  metadata.gz: f5864e192920e53c59921cf9bdb7d2f2acaf261d77ed4c0d3184a7f601cf967cf87f358c4b396705b8366fcda6ed3d54a9a125b0f13e7e139d0ce3ff0f67535e
-  data.tar.gz: 73d7d5b8a4551a7bc83efd54b8be72107a010f4023dc9784396dddce8ceae4808049cc6fed37487b07e259b6efc41a1ff75d8184bf5ce28f18f8c261e2ffd0e4
+  metadata.gz: 2039cc29cfde59766c5d249c74b49c132b709db04553848d5e8915df242dc276f2b550289bc43b58b322987851e747feede7dbe7ee89ba5ef9f0e6c096afa546
+  data.tar.gz: d62ca8506d89f4c8e772fa24daf57c0dca3e6d90c57a473a82eb6b0e89c10ab564058c198c5fb75d038c573b8792945d51633e440857322b2d64f8dc6867386c

data/.gitignore

@@ -168,3 +168,4 @@ modules.xml
 
 # JSON file containing the token for test user during development
 /token.json
+/test.rb

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Documentation for library API changes.
 
+## Version 1.1.1
+
+* BUGFIX: Added acceptance of variable args to `Token#to_json`
+* BUGFIX: Fixed regex validator in `ruqqus-oauth` for the client ID
+* Separated the client ID/secret from the `Token` class, and placed within `Client` to now handle this logic
+
 ## Version 1.1.0
 
 * Implemented `Ruqqus::Token` class to handle OAuth2 authentication

data/README.md

@@ -67,7 +67,11 @@ code          = 'XXXXXX' # The generated code (or the one you obtained via tradi
 
 # You must implement a responsible way of storing this token for reuse.
 token = Ruqqus::Token.new(client_id, client_secret, code)
-client = Ruqqus::Client.new(token)
+client = Ruqqus::Client.new(client_id, client_secret, token)
+
+# Alternatively, you can create a new token and a client with a single call.
+# This will perform the "grant" action of the code while creating it automatically 
+client = Ruqqus::Client.new(client_id, client_secret, code)
 ```
 
 The token will automatically refresh itself as-needed, but you will need to handle storing its new value for repeated
@@ -75,12 +79,16 @@ uses. To facilitate this and make it easier, there is a callback that can be sub
 time the access key is updated.
 
 ```ruby
+# Load an existing token that has already been authorized
 token = Ruqqus::Token.load_json('./token.json')
-token.on_refresh do |t|
+
+# Create your client
+client = Ruqqus::Client.new(client_id, client_secret, token)
+
+# Set the callback block to automatically update the saved token when it refreshes
+client.token_refreshed do |t|
   t.save_json('./token.json')
 end
-
-client = Ruqqus::Client.new(token)
 ```
 
 The token obtains sensitive material, and due to the security issues of storing it in plain text, this functionality is
@@ -89,7 +97,7 @@ 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.
+See the [documentation](https://www.rubydoc.info/gems/ruqqus) for a complete API reference (100% coverage).
 
 ### Features
 

data/exe/ruqqus-oauth

@@ -41,11 +41,11 @@ class RuqqusOAuth
   end
 
   def ask_client_id(prompt)
-    prompt.ask('Client ID: ') { |q| q.validate(/^[A-Fa-f0-9]+$/, "Invalid client ID") }
+    prompt.ask('Client ID: ') { |q| q.validate(/^[A-Za-z0-9_-]+$/, "Invalid client ID") }
   end
 
   def ask_client_secret(prompt)
-    prompt.ask('Client Secret: ') { |q| q.validate(/^[A-Fa-f0-9]+$/, "Invalid client secret") }
+    prompt.ask('Client Secret: ') { |q| q.validate(/^[A-Za-z0-9_-]+$/, "Invalid client secret") }
   end
 
   def ask_client_redirect(prompt)

data/lib/ruqqus/client.rb

@@ -9,7 +9,7 @@ module Ruqqus
 
     ##
     # The user-agent the client identified itself as.
-    USER_AGENT = "ruqqus-ruby/#{Ruqqus::VERSION} (efreed09@gmail.com)".freeze
+    USER_AGENT = "ruqqus-ruby/#{Ruqqus::VERSION}".freeze
 
     ##
     # A collection of valid scopes that can be authorized.
@@ -20,22 +20,39 @@ module Ruqqus
     DEFAULT_HEADERS = { 'User-Agent': USER_AGENT, 'Accept': 'application/json', 'Content-Type': 'application/json' }.freeze
 
     ##
-    # @return [Token] the OAuth2 token that grants the client authentication.
-    attr_reader :token
+    # @!attribute [rw] token
+    #   @return [Token] the OAuth2 token that grants the client authentication.
 
     ##
     # @!attribute [r] identity
     #   @return [User] the authenticated user this client is performing actions as.
 
     ##
-    # Creates a new instance of the {Client} class.
-    #
-    # @param token [Token] a valid access token to authorize the client.
-    def initialize(token)
-      @token = token || raise(ArgumentError, 'token cannot be nil')
+    # @overload initialize(client_id, client_secret, token)
+    #   Creates a new instance of the {Client} class with an existing token for authorization.
+    #   @param client_id [String] the client ID of your of your application, issued after registration on Ruqqus.
+    #   @param client_secret [String] the client secret of your of your application, issued after registration on Ruqqus.
+    #   @param token [Token] a valid access token that has previously been granted access for the client.
+    #
+    # @overload initialize(client_id, client_secret, code)
+    #   Creates a new instance of the {Client} class with an existing token for authorization.
+    #   @param client_id [String] the client ID of your of your application, issued after registration on Ruqqus.
+    #   @param client_secret [String] the client secret of your of your application, issued after registration on Ruqqus.
+    #   @param code [String] a the code from the Oauth2 redirect to create a new {Token} and grant access to it.
+    def initialize(client_id, client_secret, token)
+      @client_id = client_id || raise(ArgumentError, 'client ID cannot be nil')
+      @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)
       @session = nil
     end
 
+    attr_reader :token
+
+    def token=(token)
+      @token = token || raise(ArgumentError, 'token cannot be nil')
+    end
+
     # @!group Object Querying
 
     ##
@@ -358,10 +375,25 @@ module Ruqqus
 
     # @!endgroup Object Enumeration
 
+    ##
+    # @return [User] the authenticated user this client is performing actions as.
     def identity
       @me ||= User.from_json(http_get(Routes::IDENTITY))
     end
 
+    ##
+    # @overload token_refreshed(&block)
+    #   Sets a callback to be invoked when the token is refreshed, and a new access token is assigned.
+    #   @yieldparam token [Token] yields the newly refreshed {Token} to the block.
+    #
+    # @overload token_refreshed
+    #   When called without a block, clears any callback that was previously assigned.
+    #
+    # @return [void]
+    def token_refreshed(&block)
+      @refreshed = block_given? ? block : nil
+    end
+
     private
 
     ##
@@ -444,7 +476,7 @@ module Ruqqus
     # @return [Hash] the response deserialized into a JSON hash.
     # @see http_post
     def http_get(uri, header = nil)
-      @token.refresh if @token && @token.expired?
+      refresh_token
       header ||= headers
       response = RestClient.get(uri.chomp('/'), header)
       @session = response.cookies['session_ruqqus'] if response.cookies['session_ruqqus']
@@ -463,12 +495,21 @@ module Ruqqus
     # @return [Hash] the response deserialized into a JSON hash.
     # @see http_get
     def http_post(uri, params = {}, header = nil)
-      @token.refresh if @token && @token.expired?
+      refresh_token
       header ||= headers
       response = RestClient.post(uri.chomp('/'), params, header)
       @session = response.cookies['session_ruqqus'] if response.cookies['session_ruqqus']
       raise(Ruqqus::Error, 'HTTP request failed') if response.code < 200 || response.code >= 300
       JSON.parse(response, symbolize_names: response.body)
     end
+
+    ##
+    # @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?
+      @token.refresh(@client_id, @client_secret)
+      @refreshed&.call(@token)
+    end
   end
 end

data/lib/ruqqus/token.rb

@@ -37,15 +37,11 @@ module Ruqqus
       headers = { 'User-Agent': Client::USER_AGENT, 'Accept': 'application/json', 'Content-Type': 'application/json' }
       params = { code: code, client_id: client_id, client_secret: client_secret, grant_type: 'code', permanent: persist }
       resp = RestClient.post('https://ruqqus.com/oauth/grant', params, headers )
-
-      @client_id = client_id
-      @client_secret = client_secret
       @data = JSON.parse(resp.body, symbolize_names: true)
 
       raise(Ruqqus::Error, 'failed to grant access for token') if @data[:oauth_error]
     end
 
-
     def access_token
       @data[:access_token]
     end
@@ -70,32 +66,14 @@ module Ruqqus
     # Refreshes the access token and resets its time of expiration.
     #
     # @return [void]
-    def refresh
+    def refresh(client_id, client_secret)
       headers = { 'User-Agent': Client::USER_AGENT, Authorization: "Bearer #{access_token}" }
-      params = { client_id: @client_id, client_secret: @client_secret, refresh_token: refresh_token, grant_type: 'refresh' }
+      params = { client_id: client_id, client_secret: client_secret, refresh_token: refresh_token, grant_type: 'refresh' }
       resp = RestClient.post('https://ruqqus.com/oauth/grant', params, headers )
 
       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)
-      @refreshed&.call(self)
-    end
-
-    ##
-    # Sets a callback block that will be invoked when the token is refresh. This can be used to automate saving the
-    # token after its gets updated.
-    #
-    # @yieldparam token [Token] yields the token to the block.
-    #
-    # @return [self]
-    #
-    # @example Auto-save updated token
-    #   token = Token.load_json('./token.json')
-    #   token.on_refresh { |t| t.save_json('./token.json') }
-    def on_refresh(&block)
-      raise(LocalJumpError, "block required") unless block_given?
-      @refreshed = block
-      self
     end
 
     ##
@@ -106,8 +84,8 @@ module Ruqqus
 
     ##
     # @return [String] the object as a JSON-formatted string.
-    def to_json
-      { client_id: @client_id, client_secret: @client_secret, data: @data }.to_json
+    def to_json(*_unused_)
+      @data.to_json
     end
 
     ##
@@ -133,15 +111,13 @@ module Ruqqus
     ##
     # Loads the object from a JSON-formatted string.
     #
-    # @param json [String] a JSON string representing the object.
+    # @param json [String,Hash] a JSON string representing the object, or the parsed Hash of the JSON data.
     #
     # @return [Object] the loaded object.
     def self.from_json(payload)
-      data = JSON.parse(payload, symbolize_names: true)
+      data = payload.is_a?(Hash) ? payload: JSON.parse(payload, symbolize_names: true)
       token = allocate
-      token.instance_variable_set(:@client_id, data[:client_id])
-      token.instance_variable_set(:@client_secret, data[:client_secret])
-      token.instance_variable_set(:@data, data[:data])
+      token.instance_variable_set(:@data, data)
       token
     end
   end

data/lib/ruqqus/version.rb

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

data/ruqqus.gemspec

@@ -7,7 +7,7 @@ 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.}
+  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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruqqus
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - ForeverZer0
@@ -145,5 +145,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.
+  communities
 test_files: []