discordrb-webhooks 0.1.0 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e33e989ed634c58e7bec8ee4b270addbaf2afb1
-  data.tar.gz: d75947052d5ba2f4047622e65d3a83a829cfbc05
+SHA256:
+  metadata.gz: 44effaadc7c29e9e3e22abf7c4d01ba2a93495383de144e30816a41ed4c630b1
+  data.tar.gz: 6a5313cd404e6bf577cc2a34809ce5df22c17d1be58fcc65b0abb75cb99f1d1d
 SHA512:
-  metadata.gz: '0093a27a7257c39ebb0f27d756be7c682e58a2479d7ec6a7bdaca72a1d251d36794ec5b503cd4ddc1d738f5fa91ae2170aa69fd1c334a944eac73078e54e96f9'
-  data.tar.gz: 5781b554604a09ea88afb284c4cb522c16581ac4855974f71c54462a67ae89cce117f5c23c62ba2ba5bc0be3d1198e5ae346036b3b58e9207d7f50e06ee6540d
+  metadata.gz: 98da4d01dc7e8f50a3a6a7923a7eedd194f75fcdd1dd2256b076faff2813d2d919e9de0feefb79224ebb851aab0f75c305094cf4fd9354e4bf5eb73d0aadea71
+  data.tar.gz: 0a8a29adc73d9dd6c577c045a23f908a56925e44b6c90fccff84c9ae00a567318248b8ef19677c2f725f82ea910d56b5b083537ad0bdb0c1fb9df22b1e8dc69d

data/lib/discordrb/webhooks/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'discordrb/webhooks/embeds'
 
 module Discordrb::Webhooks
@@ -35,6 +37,7 @@ module Discordrb::Webhooks
     # @param file [File] A file to be sent.
     def file=(file)
       raise ArgumentError, 'Embeds and files are mutually exclusive!' unless @embeds.empty?
+
       @file = file
     end
 
@@ -42,6 +45,7 @@ module Discordrb::Webhooks
     # @param embed [Embed] The embed to add.
     def <<(embed)
       raise ArgumentError, 'Embeds and files are mutually exclusive!' if @file
+
       @embeds << embed
     end
 

data/lib/discordrb/webhooks/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rest-client'
 require 'json'
 
@@ -13,11 +15,7 @@ module Discordrb::Webhooks
     # @param token [String] The webhook's authorisation token. Will only be used
     #   if `url` is not set.
     def initialize(url: nil, id: nil, token: nil)
-      @url = if url
-               url
-             else
-               generate_url(id, token)
-             end
+      @url = url || generate_url(id, token)
     end
 
     # Executes the webhook this client points to with the given data.
@@ -66,7 +64,7 @@ module Discordrb::Webhooks
     end
 
     def generate_url(id, token)
-      "https://discordapp.com/api/v6/webhooks/#{id}/#{token}"
+      "https://discord.com/api/v6/webhooks/#{id}/#{token}"
     end
   end
 end

data/lib/discordrb/webhooks/embeds.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Discordrb::Webhooks
   # An embed is a multipart-style attachment to a webhook message that can have a variety of different purposes and
   # appearances.
@@ -8,7 +10,7 @@ module Discordrb::Webhooks
       @description = description
       @url = url
       @timestamp = timestamp
-      @colour = colour || color
+      self.colour = colour || color
       @footer = footer
       @image = image
       @thumbnail = thumbnail
@@ -18,68 +20,66 @@ module Discordrb::Webhooks
       @fields = fields
     end
 
-    # The title of this embed that will be displayed above everything else.
-    # @return [String]
+    # @return [String, nil] title of the embed that will be displayed above everything else.
     attr_accessor :title
 
-    # The description for this embed.
-    # @return [String]
+    # @return [String, nil] description for this embed
     attr_accessor :description
 
-    # The URL the title should point to.
-    # @return [String]
+    # @return [String, nil] URL the title should point to
     attr_accessor :url
 
-    # The timestamp for this embed. Will be displayed just below the title.
-    # @return [Time]
+    # @return [Time, nil] timestamp for this embed. Will be displayed just below the title.
     attr_accessor :timestamp
 
-    # @return [Integer] the colour of the bar to the side, in decimal form.
+    # @return [Integer, nil] the colour of the bar to the side, in decimal form
     attr_reader :colour
     alias_method :color, :colour
 
     # Sets the colour of the bar to the side of the embed to something new.
-    # @param value [Integer, String, {Integer, Integer, Integer}] The colour in decimal, hexadecimal, or R/G/B decimal
+    # @param value [String, Integer, {Integer, Integer, Integer}, #to_i, nil] The colour in decimal, hexadecimal, R/G/B decimal, or nil to clear the embeds colour
     #   form.
     def colour=(value)
-      if value.is_a? Integer
+      if value.nil?
+        @colour = nil
+      elsif value.is_a? Integer
         raise ArgumentError, 'Embed colour must be 24-bit!' if value >= 16_777_216
+
         @colour = value
       elsif value.is_a? String
         self.colour = value.delete('#').to_i(16)
       elsif value.is_a? Array
         raise ArgumentError, 'Colour tuple must have three values!' if value.length != 3
+
         self.colour = value[0] << 16 | value[1] << 8 | value[2]
+      else
+        self.colour = value.to_i
       end
     end
 
     alias_method :color=, :colour=
 
-    # The footer for this embed.
     # @example Add a footer to an embed
     #   embed.footer = Discordrb::Webhooks::EmbedFooter.new(text: 'Hello', icon_url: 'https://i.imgur.com/j69wMDu.jpg')
-    # @return [EmbedFooter]
+    # @return [EmbedFooter, nil] footer for this embed
     attr_accessor :footer
 
-    # The image for this embed.
     # @see EmbedImage
     # @example Add a image to an embed
     #   embed.image = Discordrb::Webhooks::EmbedImage.new(url: 'https://i.imgur.com/PcMltU7.jpg')
-    # @return [EmbedImage]
+    # @return [EmbedImage, nil] image for this embed
     attr_accessor :image
 
-    # The thumbnail for this embed.
     # @see EmbedThumbnail
     # @example Add a thumbnail to an embed
     #   embed.thumbnail = Discordrb::Webhooks::EmbedThumbnail.new(url: 'https://i.imgur.com/xTG3a1I.jpg')
-    # @return [EmbedThumbnail]
+    # @return [EmbedThumbnail, nil] thumbnail for this embed
     attr_accessor :thumbnail
 
-    # The author for this embed.
     # @see EmbedAuthor
     # @example Add a author to an embed
     #   embed.author = Discordrb::Webhooks::EmbedAuthor.new(name: 'meew0', url: 'https://github.com/meew0', icon_url: 'https://avatars2.githubusercontent.com/u/3662915?v=3&s=466')
-    # @return [EmbedAuthor]
+    # @return [EmbedAuthor, nil] author for this embed
     attr_accessor :author
 
     # Add a field object to this embed.
@@ -94,13 +94,13 @@ module Discordrb::Webhooks
     #   embed.add_field(name: 'A field', value: "The field's content")
     # @param name [String] The field's name
     # @param value [String] The field's value
-    # @param inline [true, false] Whether the field should be inlined
+    # @param inline [true, false] Whether the field should be inline
     def add_field(name: nil, value: nil, inline: nil)
       self << EmbedField.new(name: name, value: value, inline: inline)
     end
 
     # @return [Array<EmbedField>] the fields attached to this embed.
-    attr_reader :fields
+    attr_accessor :fields
 
     # @return [Hash] a hash representation of this embed, to be converted to JSON.
     def to_hash
@@ -108,14 +108,14 @@ module Discordrb::Webhooks
         title: @title,
         description: @description,
         url: @url,
-        timestamp: @timestamp && @timestamp.utc.iso8601,
+        timestamp: @timestamp&.utc&.iso8601,
         color: @colour,
-        footer: @footer && @footer.to_hash,
-        image: @image && @image.to_hash,
-        thumbnail: @thumbnail && @thumbnail.to_hash,
-        video: @video && @video.to_hash,
-        provider: @provider && @provider.to_hash,
-        author: @author && @author.to_hash,
+        footer: @footer&.to_hash,
+        image: @image&.to_hash,
+        thumbnail: @thumbnail&.to_hash,
+        video: @video&.to_hash,
+        provider: @provider&.to_hash,
+        author: @author&.to_hash,
         fields: @fields.map(&:to_hash)
       }
     end
@@ -124,6 +124,12 @@ module Discordrb::Webhooks
   # An embed's footer will be displayed at the very bottom of an embed, together with the timestamp. An icon URL can be
   # set together with some text to be displayed.
   class EmbedFooter
+    # @return [String, nil] text to be displayed in the footer
+    attr_accessor :text
+
+    # @return [String, nil] URL to an icon to be showed alongside the text
+    attr_accessor :icon_url
+
     # Creates a new footer object.
     # @param text [String, nil] The text to be displayed in the footer.
     # @param icon_url [String, nil] The URL to an icon to be showed alongside the text.
@@ -143,6 +149,9 @@ module Discordrb::Webhooks
 
   # An embed's image will be displayed at the bottom, in large format. It will replace a footer icon URL if one is set.
   class EmbedImage
+    # @return [String, nil] URL of the image
+    attr_accessor :url
+
     # Creates a new image object.
     # @param url [String, nil] The URL of the image.
     def initialize(url: nil)
@@ -160,6 +169,9 @@ module Discordrb::Webhooks
   # An embed's thumbnail will be displayed at the right of the message, next to the description and fields. When clicked
   # it will point to the embed URL.
   class EmbedThumbnail
+    # @return [String, nil] URL of the thumbnail
+    attr_accessor :url
+
     # Creates a new thumbnail object.
     # @param url [String, nil] The URL of the thumbnail.
     def initialize(url: nil)
@@ -176,6 +188,15 @@ module Discordrb::Webhooks
 
   # An embed's author will be shown at the top to indicate who "authored" the particular event the webhook was sent for.
   class EmbedAuthor
+    # @return [String, nil] name of the author
+    attr_accessor :name
+
+    # @return [String, nil] URL the name should link to
+    attr_accessor :url
+
+    # @return [String, nil] URL of the icon to be displayed next to the author
+    attr_accessor :icon_url
+
     # Creates a new author object.
     # @param name [String, nil] The name of the author.
     # @param url [String, nil] The URL the name should link to.
@@ -198,11 +219,20 @@ module Discordrb::Webhooks
 
   # A field is a small block of text with a header that can be relatively freely layouted with other fields.
   class EmbedField
+    # @return [String, nil] name of the field, displayed in bold at the top of the field.
+    attr_accessor :name
+
+    # @return [String, nil] value of the field, displayed in normal text below the name.
+    attr_accessor :value
+
+    # @return [true, false] whether the field should be displayed inline with other fields.
+    attr_accessor :inline
+
     # Creates a new field object.
-    # @param name [String, nil] The name of the field, displayed in bold at the top.
+    # @param name [String, nil] The name of the field, displayed in bold at the top of the field.
     # @param value [String, nil] The value of the field, displayed in normal text below the name.
-    # @param inline [true, false] Whether the field should be displayed in-line with other fields.
-    def initialize(name: nil, value: nil, inline: nil)
+    # @param inline [true, false] Whether the field should be displayed inline with other fields.
+    def initialize(name: nil, value: nil, inline: false)
       @name = name
       @value = value
       @inline = inline

data/lib/discordrb/webhooks/version.rb

@@ -4,6 +4,6 @@
 module Discordrb
   module Webhooks
     # The current version of discordrb-webhooks.
-    VERSION = '0.1.0'.freeze
+    VERSION = '3.4.2'
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: discordrb-webhooks
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 3.4.2
 platform: ruby
 authors:
 - meew0
+- swarley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-29 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 description: A client for Discord's webhooks to fit alongside [discordrb](https://rubygems.org/gems/discordrb).
 email:
 - ''
@@ -36,7 +37,7 @@ files:
 - lib/discordrb/webhooks/client.rb
 - lib/discordrb/webhooks/embeds.rb
 - lib/discordrb/webhooks/version.rb
-homepage: https://github.com/meew0/discordrb
+homepage: https://github.com/shardlab/discordrb
 licenses:
 - MIT
 metadata: {}
@@ -48,17 +49,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Webhook client for discordrb
 test_files: []
-has_rdoc: