dbots 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a98618d6b8cd4b3f88e78ce4673abc7fbca9d420053dfb53f40c8b828829dee3
+  data.tar.gz: 6b87cbc42a0526618b07a73f28ecdcc283b1bcaea110e7eb1b55ba57a02a652b
+SHA512:
+  metadata.gz: fcf4b19edec97311b83524c05e398e976d5a427b7b73d46dce800455c18c389f93c906dc477bcf1d83d02761397740ecc9e8017d88e67aa0209b4111ae463875
+  data.tar.gz: 7c8fa35c66e8c996ebba1bf0104f5691b9b0bb9d2eae71feb2ee42efd89295112b818a0ef892e9c0167c6ea12252f5214e671d0919b02cd552e810aaa7ff4eac

data/lib/dbots.rb

@@ -0,0 +1,2 @@
+require 'dbots/poster'
+require 'dbots/lists/discordbotsgg'

data/lib/dbots/api.rb

@@ -0,0 +1,79 @@
+require 'dbots/err'
+require 'dbots/ver'
+require 'uri'
+require 'json'
+require 'rest-client'
+
+module DBots
+  # Main API functions
+  module API
+    module_function
+
+    def get(url, headers = {})
+      headers['User-Agent'] = user_agent
+      request(:get, url, headers)
+    end
+
+    def post(url, body, headers = {})
+      headers['User-Agent'] = user_agent
+      request(:post, url, body, headers)
+    end
+
+    def user_agent
+      "dbots (https://github.com/dbots-pkg/dbots.rb #{DBots::VERSION}) rest-client/#{RestClient::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
+    end
+
+    # Request an endpoint easily
+    def request(type, *attributes)
+      response = RestClient.send(type, *attributes)
+      Response.new(response, parse_json(response.body))
+    rescue RestClient::Unauthorized
+      raise DBots::Err::Unauthorized
+    rescue RestClient::InternalServerError
+      raise DBots::Err::ServerFail
+    end
+
+    # @!visibility private
+    def parse_json(raw)
+      JSON.parse(raw)
+    rescue JSON::ParserError
+      raw
+    end
+
+    # The nested response from rest-client
+    class Response
+      # @return [String] the HTTP response body.
+      attr_reader :body
+
+      # @return [Integer] HTTP status code.
+      attr_reader :code
+      alias_method :status, :code
+
+      # @return [Hash] a hash of the headers, beautified with symbols and underscores.
+      attr_reader :headers
+
+      # @return [Hash] cookie jar extracted from response headers.
+      attr_reader :cookies
+
+      # @return [Hash, nil] the parsed JSON of the response
+      attr_reader :json
+
+      # @return [RestClient::Response] the raw response given from rest-client
+      attr_reader :raw
+
+      # @!visibility private
+      def initialize(response, json = nil)
+        @raw = response
+        @code = response.code
+        @headers = response.headers
+        @cookies = response.cookies
+        @json = json
+      end
+
+      # @!visibility private
+      def inspect
+        "<DBots::API::Response #{@code} #{@raw.body_truncated(10).inspect}>"
+      end
+    end
+  end
+end

data/lib/dbots/data.rb

@@ -0,0 +1,65 @@
+require 'dbots/api'
+require 'dbots/err'
+require 'uri'
+
+# The main dbots module
+module DBots
+  # Represents a basic service.
+  class Service
+    BASE_URL = ''.freeze
+    AUTH_HEADER = 'Authorization'.freeze
+
+    # @return [String, nil] the token that will be used for the service
+    attr_accessor :token
+    alias_method :key, :token
+    alias_method :api_key, :token
+
+    # @param token [String] the token/key for the service.
+    def initialize(token = nil)
+      @token = token
+    end
+
+    def token?
+      @token != nil
+    end
+
+    # @!visibility private
+    def get(path, query = {}, headers = {})
+      DBots::API.get("#{self.class::BASE_URL}#{path}?#{URI.encode_www_form(query)}", headers)
+    end
+
+    # @!visibility private
+    def get_authed(path, query = {}, headers = {})
+      raise DBots::Err::RequiresToken unless token?
+
+      headers[self.class::AUTH_HEADER] = @token
+      DBots::API.get("#{self.class::BASE_URL}#{path}?#{URI.encode_www_form(query)}", headers)
+    end
+
+    # @!visibility private
+    def post_authed(path, body, query = {}, headers = {})
+      raise DBots::Err::RequiresToken unless token?
+
+      headers[self.class::AUTH_HEADER] = @token
+      DBots::API.post("#{self.class::BASE_URL}#{path}?#{URI.encode_www_form(query)}", body, headers)
+    end
+
+    # @!visibility private
+    def inspect
+      "<#{self.class.name} @token?=#{token?}>"
+    end
+  end
+
+  # Gets a service class based on a key
+  # @param key [String] the service key to get
+  # @returns [Service, nil]
+  def self.get_service(key)
+    services = DBots::Service.constants.select { |c| DBots::Service.const_get(c).is_a? Class }
+    services.each do |service|
+      service = DBots::Service.const_get(service)
+      return service if service::ALIASES.include?(key.to_s)
+    end
+
+    nil
+  end
+end

data/lib/dbots/err.rb

@@ -0,0 +1,28 @@
+module DBots
+  # Custom errors raised in various places
+  module Err
+    # Raised when an API key is invalid or incorrect.
+    class Unauthorized < RuntimeError
+      # The default message for the error
+      def message
+        'Invalid API key!'
+      end
+    end
+
+    # Raised when an authorized endpoint does not have a token
+    class RequiresToken < RuntimeError
+      # The default message for the error
+      def message
+        'This endpoint requires a token.'
+      end
+    end
+
+    # Raised when a server error occurs
+    class ServerFail < RuntimeError
+      # The default message for the error
+      def message
+        'Internal server error!'
+      end
+    end
+  end
+end

data/lib/dbots/lists/discordbotsgg.rb

@@ -0,0 +1,29 @@
+require 'dbots/data'
+
+module DBots
+  class Service
+    # Represents the Discord Bots service.
+    # @see https://discord.bots.gg/docs
+    class DiscordBotsGG < Service
+      BASE_URL = 'https://discord.bots.gg/api/v1'.freeze
+      ALIASES = ['discordbotsgg', 'discord.bots.gg', 'botsgg', 'bots.gg', 'dbots'].freeze
+
+      # Gets the bot listed on this service.
+      # @Param id [String, Integer, #resolve_id] the bot's ID
+      # @Param sanitied [true, false] whether to sanitize descriptions
+      # @return [RestClient::Response]
+      def get_bot(id, sanitied = false)
+        id = id.respond_to?(:resolve_id) ? id.resolve_id.to_s : id.to_s
+        get_authed("/bots/#{id}", { sanitied: sanitied })
+      end
+
+      # Gets a list of bots on this service.
+      # @Param query [Hash] the query string that will be used in the request
+      # @return [RestClient::Response]
+      def get_bots(query = {})
+        id = id.respond_to?(:resolve_id) ? id.resolve_id.to_s : id.to_s
+        get_authed("/bots/#{id}", query)
+      end
+    end
+  end
+end

data/lib/dbots/poster.rb

@@ -0,0 +1,23 @@
+module DBots
+  # A class that posts server count to listing site(s).
+  class Poster
+    # @return [Hash] the API keys that the poster is using
+    attr_accessor :api_keys
+    alias_method :tokens, :api_keys
+    alias_method :keys, :api_keys
+
+    # @return [String] the client ID used for posting to a service
+    attr_accessor :client_id
+
+    # @param [String, Integer, #resolve_id] the client ID used for posting to a service
+    def initialize(client_id, api_keys: {})
+      @client_id = client_id.respond_to?(:resolve_id) ? client_id.resolve_id.to_s : client_id.to_s
+      @api_keys = api_keys
+    end
+
+    # @!visibility private
+    def inspect
+      "<#{self.class.name} @client_id=#{@client_id}>"
+    end
+  end
+end

data/lib/dbots/ver.rb

@@ -0,0 +1,3 @@
+module DBots
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: dbots
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Snazzah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A stats poster and API wrapper for all botlists.
+email: suggesttosnazzy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dbots.rb
+- lib/dbots/api.rb
+- lib/dbots/data.rb
+- lib/dbots/err.rb
+- lib/dbots/lists/discordbotsgg.rb
+- lib/dbots/poster.rb
+- lib/dbots/ver.rb
+homepage: https://github.com/dbots-pkg/dbots.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Stats poster & API wrapper for botlists.
+test_files: []