discordrb-webhooks 3.2.0.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b208128ffa00e95f740a4b3e57d633943e2c5982
-  data.tar.gz: b86a4055766282919b62ee7417f527c17befdd1c
+SHA256:
+  metadata.gz: 6d7d23650de6d0fc87de7502249ce43f9b7ae643a5b83672bb083399f6db8f24
+  data.tar.gz: a315a00e995b894befd2e06c6db5467eb0613003e14b504577f452fff63d6219
 SHA512:
-  metadata.gz: '09f60c087fcb4e1a5b432e4a9ca84a6398e9649e86635b4307dc9134d89cb4204978bfc7302780b4127ae6b45e26aa572d393d13cd71bbcdb4d96f94b5f917cb'
-  data.tar.gz: 1bf10b016e9a3bcc26c1502f99710d960dbf87c33df23fa452087dcf14aac10ebb1c74ab5a96778835034f5b0f64c5b2aafdf829eb9af841a0c34800333cade6
+  metadata.gz: 3b818ca44c09515634ba48d7a52473026ad659f1bcff8ca87ceeb78a2d6ef6fa16b2334083811feacaa5586efc5843a0c243547105f74f9bdc2791afbf7b7057
+  data.tar.gz: 24efb99480663061578d386c11e9aaffd141c9801851949766640e7b4714ae74f10a209d9bafe3e42504ae782d61d4cdb1f5fd3202da6c48eb0c766fc25534a0

data/lib/discordrb/webhooks/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'discordrb/webhooks/embeds'
 
 module Discordrb::Webhooks

data/lib/discordrb/webhooks/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rest-client'
 require 'json'
 

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,31 +20,29 @@ 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 [Integer, String, {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
@@ -50,36 +50,34 @@ module Discordrb::Webhooks
       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.
@@ -100,7 +98,7 @@ module Discordrb::Webhooks
     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
@@ -124,6 +122,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 +147,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 +167,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 +186,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 +217,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 = '3.2.0.1'.freeze
+    VERSION = '3.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discordrb-webhooks
 version: !ruby/object:Gem::Version
-  version: 3.2.0.1
+  version: 3.3.0
 platform: ruby
 authors:
 - meew0
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-29 00:00:00.000000000 Z
+date: 2018-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0.rc1
 description: A client for Discord's webhooks to fit alongside [discordrb](https://rubygems.org/gems/discordrb).
 email:
 - ''
@@ -56,9 +56,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Webhook client for discordrb
 test_files: []
-has_rdoc: