discorb 0.0.1

data/lib/discorb.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# A new wrapper for the Discorb API.
+#
+# @author sevenc-nanashi
+module Discorb
+  # @!visibility private
+  # @!macro [new] async
+  #   @note This is an asynchronous method, it will return a `Async::Task` object. Use `Async::Task#wait` to get the result.
+  #
+  # @!macro [new] client_cache
+  #   @note This method returns an object from client cache. it will return `nil` if the object is not in cache.
+  #   @return [nil] The object wasn't cached.
+  #
+  # @!macro members_intent
+  #   @note You must enable `GUILD_MEMBERS` intent to use this method.
+  #
+  # @!macro edit
+  #   @note The arguments of this method are defaultly set to `:unset`. Specify value to set the value, if not don't specify or specify `:unset`.
+  #
+  # @!macro http
+  #   @note This method calls HTTP request.
+  #   @raise [Discorb::HTTPError] HTTP request failed.
+  #
+  def macro
+    # NOTE: this method is only for YARD.
+    puts 'Wow, You found the easter egg!\n\n'
+    red = "\e[31m"
+    reset = "\e[m"
+    puts <<~"EASTEREGG"
+               | .               #{red}   |     #{reset}
+             __|                 #{red}   |__   #{reset}
+            /  | |  __   __  _   #{red} _ |  \\  #{reset}
+           (   | | (__  /   / \\ #{red}|/  |   ) #{reset}
+            \\__| |  __) \\__ \\_/ #{red}|   |__/  #{reset}
+
+                 https://github.com/discorb-lib/discorb
+         EASTEREGG
+  end
+end
+
+require_order = %w[common flag dictionary error internet intents emoji_table modules] +
+                %w[user member guild emoji channel embed message] +
+                %w[application audit_logs color components event extension] +
+                %w[file guild_template image integration interaction invite log permission] +
+                %w[presence reaction role sticker utils voice_state webhook] +
+                %w[gateway_requests gateway] +
+                %w[asset client extend]
+require_order.each do |name|
+  require_relative "discorb/#{name}.rb"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: discorb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sevenc-nanashi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-28 00:00:00.000000000 Z
+dependencies: []
+description: "# discorb\n[![rubydoc](https://img.shields.io/badge/Document-rubydoc.info-blue.svg)](https://rubydoc.info/gems/discorb)\n[![Gem](https://img.shields.io/gem/dt/discorb?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/discorb)\n[![Gem](https://img.shields.io/gem/v/discorb?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/discorb)
+  \ \n\ndiscorb is a Discord API wrapper for Ruby.\n\n## Installation\n\nAdd this
+  line to your application's Gemfile:\n\n```ruby\ngem 'discorb'\n```\n\nAnd then execute:\n\n
+  \   $ bundle install\n\nOr install it yourself as:\n\n    $ gem install discorb\n\n##
+  Usage\n\n### Simple ping-pong\n\n```ruby\nrequire \"discorb\"\n\nclient = Discorb::Client.new\n\nclient.once
+  :ready do\n  puts \"Logged in as #{client.user}\"\nend\n\nclient.on :message do
+  |_task, message|\n  next if message.author.bot?\n  next unless message.content ==
+  \"ping\"\n\n  message.channel.post(\"Pong!\")\nend\n\nclient.run(ENV[\"DISCORD_BOT_TOKEN\"])\n```\n\n##
+  Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/sevenc-nanashi/discorb.\n\n##
+  License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n"
+email:
+- sevenc-nanashi@sevenbot.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".yardopts"
+- Changelog.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- discorb.gemspec
+- docs/Examples.md
+- docs/events.md
+- docs/voice_events.md
+- examples/components/authorization_button.rb
+- examples/components/select_menu.rb
+- examples/extension/main.rb
+- examples/extension/message_expander.rb
+- examples/simple/eval.rb
+- examples/simple/ping_pong.rb
+- examples/simple/rolepanel.rb
+- examples/simple/wait_for_message.rb
+- lib/discorb.rb
+- lib/discorb/application.rb
+- lib/discorb/asset.rb
+- lib/discorb/audit_logs.rb
+- lib/discorb/channel.rb
+- lib/discorb/client.rb
+- lib/discorb/color.rb
+- lib/discorb/common.rb
+- lib/discorb/components.rb
+- lib/discorb/dictionary.rb
+- lib/discorb/embed.rb
+- lib/discorb/emoji.rb
+- lib/discorb/emoji_table.rb
+- lib/discorb/error.rb
+- lib/discorb/event.rb
+- lib/discorb/extend.rb
+- lib/discorb/extension.rb
+- lib/discorb/file.rb
+- lib/discorb/flag.rb
+- lib/discorb/gateway.rb
+- lib/discorb/gateway_requests.rb
+- lib/discorb/guild.rb
+- lib/discorb/guild_template.rb
+- lib/discorb/image.rb
+- lib/discorb/integration.rb
+- lib/discorb/intents.rb
+- lib/discorb/interaction.rb
+- lib/discorb/internet.rb
+- lib/discorb/invite.rb
+- lib/discorb/log.rb
+- lib/discorb/member.rb
+- lib/discorb/message.rb
+- lib/discorb/modules.rb
+- lib/discorb/permission.rb
+- lib/discorb/presence.rb
+- lib/discorb/reaction.rb
+- lib/discorb/role.rb
+- lib/discorb/sticker.rb
+- lib/discorb/user.rb
+- lib/discorb/utils.rb
+- lib/discorb/voice_state.rb
+- lib/discorb/webhook.rb
+homepage: https://github.com/sevenc-nanashi/discorb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/sevenc-nanashi/discorb
+  source_code_uri: https://github.com/sevenc-nanashi/discorb
+  changelog_uri: https://github.com/sevenc-nanashi/discorb/blob/main/Changelog.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: discorb is a Discord API wrapper for Ruby.
+test_files: []