feat: add webhooks

Author: null8626

Gemfile

@@ -5,5 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in topgg.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-gem "ostruct", "~> 0.6"
+gem "rack"
+gem "rake"
+gem "ostruct"
+gem "cgi"

Gemfile.lock

@@ -2,25 +2,26 @@ PATH
   remote: .
   specs:
     topgg (2.0.0)
+      rack (~> 3.0.9.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    cgi (0.5.0)
     ostruct (0.6.1)
-    power_assert (2.0.5)
+    rack (3.0.9.1)
     rake (13.0.6)
-    test-unit (3.6.8)
-      power_assert
 
 PLATFORMS
   x64-mingw-ucrt
   x86_64-linux
 
 DEPENDENCIES
-  ostruct (~> 0.6)
-  rake (~> 13.0)
-  test-unit (~> 3.1, >= 3.1.8)
+  cgi (~> 0.5.0)
+  ostruct
+  rack
+  rake
   topgg!
 
 BUNDLED WITH
-   2.6.7
+   2.6.9

README.md

@@ -123,4 +123,38 @@ widget_url = Dbl::Widget.owner(:discord_bot, "574652751745777665")
 
 ```rb
 widget_url = Dbl::Widget.social(:discord_bot, "574652751745777665")
+```
+
+### Webhooks
+
+#### Being notified whenever someone voted for your bot
+
+##### Ruby on Rails
+
+In your `config/application.rb`:
+
+```rb
+module WebhookApi
+  class Application < Rails::Application
+    # ...
+
+    config.middleware.use Dbl::Webhook,
+    type: Dbl::Webhook::VOTE,
+    path: "/votes",
+    auth: ENV["MY_TOPGG_WEBHOOK_SECRET"] do |vote|
+      Rails.logger.info "A user with the ID of #{vote.voter_id} has voted us on Top.gg!"
+    end
+  end
+end
+```
+
+##### Sinatra
+
+```rb
+use Dbl::Webhook,
+type: Dbl::Webhook::VOTE,
+path: "/votes",
+auth: ENV["MY_TOPGG_WEBHOOK_SECRET"] do |vote|
+  puts "A user with the ID of #{vote.voter_id} has voted us on Top.gg!"
+end
 ```

lib/lib.rb lib/topgg.rblib/lib.rb renamed to lib/topgg.rb

@@ -3,12 +3,13 @@
 require "base64"
 require "json"
 
-require_relative "topgg/utils/request"
 require_relative "topgg/bot"
 require_relative "topgg/botSearch"
 require_relative "topgg/user"
 require_relative "topgg/stats"
+require_relative "topgg/vote"
 require_relative "topgg/votes"
+require_relative "topgg/webhooks"
 require_relative "topgg/widget"
 
 # Class Topgg

lib/topgg/bot.rb

@@ -1,4 +1,4 @@
-require "Date"
+require "date"
 
 module Dbl
   # The Bot class spreads the json parsed hash into different methods
@@ -8,13 +8,14 @@ class Bot
     def initialize(obj)
       @obj = obj
     end
+
     # Returns raw hash of the parsed json object
     # @return [Hash]
     attr_reader :obj
 
     alias raw obj
-
     alias data obj
+
     # Returns error message if there's an error, otherwise nil
     # @return [String]
     def error

lib/topgg/botSearch.rb

@@ -7,12 +7,12 @@ class BotSearch
     def initialize(obj)
       @obj = obj
     end
+
     # Get raw hash response
     # @return [Hash]
     attr_reader :obj
 
     alias raw obj
-
     alias data obj
 
     # The Total number of results

lib/topgg/stats.rb

@@ -7,12 +7,13 @@ def initialize(obj)
       @obj = obj
     end
 
-    # Returns raw Hash of the response
+    # Get raw hash response
+    # @return [Hash]
     attr_reader :obj
 
     alias raw obj
-
     alias data obj
+    
     # Returns the server Count of the bot
     # @return [Integer]
     def server_count

lib/topgg/user.rb

@@ -8,11 +8,13 @@ def initialize(obj)
       @obj = obj
     end
 
+    # Get raw hash response
+    # @return [Hash]
     attr_reader :obj
 
     alias raw obj
-
     alias data obj
+    
     # Check for errors, if any
     def error
       @obj["error"]

lib/topgg/vote.rb

@@ -0,0 +1,46 @@
+module Dbl
+  class Vote
+    def initialize(obj)
+      @obj = obj
+    end
+
+    # Returns raw hash of the parsed json object
+    # @return [Hash]
+    attr_reader :obj
+
+    alias raw obj
+    alias data obj
+
+    # Returns the ID of the Discord bot/server that received a vote.
+    # @return [String]
+    def receiver_id
+      !@obj["bot"].nil? ? @obj["guild"] : @obj["bot"]
+    end
+
+    # Returns the ID of the Top.gg user who voted.
+    # @return [String]
+    def voter_id
+      @obj["user"]
+    end
+
+    # Returns whether this vote is just a test done from the page settings.
+    # @return [Boolean]
+    def is_test
+      @obj["type"] == "test"
+    end
+
+    # Returns whether the weekend multiplier is active, where a single vote counts as two.
+    # @return [Boolean]
+    def is_weekend
+      @obj["isWeekend"] == true
+    end
+
+    # Returns query strings found on the vote page.
+    # @return [Hash<String, String>]
+    def query
+      return nil if @obj["query"].nil?
+
+      CGI.parse(@obj["query"]).transform_values(&:first)
+    end
+  end
+end

lib/topgg/webhooks.rb

@@ -0,0 +1,45 @@
+require "rack"
+require "cgi"
+
+require_relative "vote"
+
+module Dbl
+  class Webhook
+    VOTE = ->(json) { Vote.new(json) }
+
+    def initialize(app, type:, path:, auth:, &callback)
+      raise ArgumentError, "A callback must be provided" unless callback
+      raise ArgumentError, "A type must be provided" unless type.respond_to?(:call)
+      
+      @app = app
+      @deserializer = type
+      @path = path
+      @auth = auth
+      @callback = callback
+    end
+  
+    def call(env)
+      req = Rack::Request.new(env)
+  
+      if req.post? && req.path.start_with?(@path)
+        if req.get_header('HTTP_AUTHORIZATION') != @auth
+          return [401, { 'Content-Type' => 'text/plain' }, ['Unauthorized']]
+        end
+  
+        body = req.body.read
+
+        begin
+          data = JSON.parse(body)
+          
+          @callback.call(@deserializer.call(data)) if data
+          
+          return [204, { 'Content-Type' => 'text/plain' }, ['']]
+        rescue JSON::ParserError
+          return [400, { 'Content-Type' => 'text/plain' }, ['Bad request']]
+        end
+      end
+  
+      @app.call(env)
+    end
+  end
+end