discord-notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e41269eca4f21db07c035912dad45faad3c539e1
+  data.tar.gz: a21a0062df3506c83a23f5e5e896903bce6af3a1
+SHA512:
+  metadata.gz: 65b4a8566e174b2bf25a246a58c07c31f3590dea6cc88c5f60c34343286a6cc722abb429d519b3df30f95880b164b5887435fd2d6275bea33b5e9036d7c4eff7
+  data.tar.gz: e712272a5e281853adea41d595a255935759978daa3d9b2ff03d15dd7643bc5bd01828ca964710b25106fed7e49295009014c17c2a0da735a32b53a0ddc2d684

data/lib/discord_notifier.rb

@@ -0,0 +1,40 @@
+require 'json'
+require 'net/http'
+require_relative 'discord_notifier/embed'
+
+module Discord
+  Config = Struct.new(:url, :username, :avatar_url, :wait)
+
+  class Notifier
+    @@config = Config.new
+
+    def self.setup
+      yield @@config
+    end
+
+    def self.message(content, config = {})
+      params = @@config.to_h.merge(config).compact
+
+      case content
+      when String
+        params[:content] = content
+      when Embed
+        params[:embeds] = [content.data]
+      when Array
+        params[:embeds] = content.map { |embed| embed.data }
+      # when Attachment
+      else
+        raise ArgumentError, 'Unsupported content type'
+      end
+
+      uri = endpoint(params)
+      Net::HTTP.post(uri, params.to_json, "Content-Type": "application/json")
+    end
+
+    def self.endpoint(config)
+      uri = URI(config[:url])
+      uri.query = URI.encode_www_form(wait: true) if config[:wait]
+      return uri
+    end
+  end
+end

data/lib/discord_notifier/embed.rb

@@ -0,0 +1,87 @@
+module Discord
+  class Embed
+    attr_reader :data
+
+    def initialize(&block)
+      @data = {}
+      self.instance_exec(&block) if block_given?
+    end
+
+    def title(str)
+      raise ArgumentError, 'Title Embed data must be a String' unless str.is_a?(String)
+      @data[:title] = str
+    end
+
+    def description(str)
+      raise ArgumentError, 'Description Embed data must be a String' unless str.is_a?(String)
+      @data[:description] = str
+    end
+
+    def url(str)
+      raise ArgumentError, 'URL Embed data must be a String' unless str.is_a?(String)
+      @data[:url] = str
+    end
+
+    def timestamp(date)
+      raise ArgumentError, 'Timestamp Embed data must be a Date' unless date.is_a?(DateTime)
+      @data[:timestamp] = date
+    end
+
+    def color(val)
+      case val
+      when String
+        @data[:color] = val.delete('#').to_i(16)
+      when Integer
+        raise ArgumentError, 'Color must be 24 bit' if val >= 16_777_216
+        @data[:color] = val
+      else
+        raise ArgumentError, 'Color must be hex or 24 bit int'
+      end
+    end
+
+    def thumbnail(params)
+      raise ArgumentError, "Thumbnail Embed data must be a Hash" unless params.is_a?(Hash)
+
+      @data[:thumbnail] = params
+    end
+
+    def video(params)
+      raise ArgumentError, "Video Embed data must be a Hash" unless params.is_a?(Hash)
+
+      @data[:video] = params
+    end
+
+    def image(params)
+      raise ArgumentError, "Image Embed data must be a Hash" unless params.is_a?(Hash)
+
+      @data[:image] = params
+    end
+
+    def provider(params)
+      raise ArgumentError, "Provider Embed data must be a Hash" unless params.is_a?(Hash)
+
+      @data[:provider] = params
+    end
+
+    def author(params)
+      raise ArgumentError, "Author Embed data must be a Hash" unless params.is_a?(Hash)
+
+      @data[:author] = params
+    end
+
+    def footer(params)
+      raise ArgumentError, "Footer Embed data must be a Hash" unless params.is_a?(Hash)
+
+      @data[:footer] = params
+    end
+
+    def add_field(params)
+      raise ArgumentError, "Field Embed data must be a Hash" unless params.is_a?(Hash)
+
+      @data[:fields] ||= []
+      @data[:fields] << params
+    end
+
+    alias :field :add_field
+  end
+end

data/lib/discord_notifier/version.rb

@@ -0,0 +1,5 @@
+module Discord
+  class Notifier
+    VERSION = '0.1.0'.freeze
+  end
+end

data/test/discord/discord_notifier/embed_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+class Discord::EmbedTest < Minitest::Test
+  def test_that_it_has_a_data_hash
+    embed = Discord::Embed.new
+    assert embed.data.is_a? Hash
+  end
+
+  def test_embed_fields_exist
+    embed = Discord::Embed.new
+    fields = %w(title description url timestamp color footer image thumbnail
+                video provider author)
+
+    fields.each do |field|
+      assert embed.public_methods.include?(field.to_sym), "#{field} not found"
+    end
+
+    assert embed.public_methods.include? :add_field
+    assert embed.public_methods.include? :field
+  end
+
+  def test_multiple_fields
+    embed = Discord::Embed.new do
+      add_field name: "Field 1"
+      add_field name: "Field 2"
+      add_field name: "Field 3"
+    end
+
+    assert_equal embed.data[:fields].size, 3
+  end
+
+  def test_embed_field_argument_types
+    embed = Discord::Embed.new
+
+    assert_raises(ArgumentError) { embed.title({ value: 'Hash' }) }
+    embed.title 'String Value'
+
+    assert_raises(ArgumentError) { embed.description({ value: 'Hash' }) }
+    embed.description 'String Value'
+
+    assert_raises(ArgumentError) { embed.url({ value: 'Hash' }) }
+    embed.url 'String Value'
+
+    assert_raises(ArgumentError) { embed.thumbnail('String Value') }
+    embed.thumbnail value: 'Hash Value'
+
+    assert_raises(ArgumentError) { embed.video('String Value') }
+    embed.video value: 'Hash Value'
+
+    assert_raises(ArgumentError) { embed.image('String Value') }
+    embed.image value: 'Hash Value'
+
+    assert_raises(ArgumentError) { embed.provider('String Value') }
+    embed.provider value: 'Hash Value'
+
+    assert_raises(ArgumentError) { embed.author('String Value') }
+    embed.author value: 'Hash Value'
+
+    assert_raises(ArgumentError) { embed.footer('String Value') }
+    embed.footer value: 'Hash Value'
+
+    assert_raises(ArgumentError) { embed.field('String Value') }
+    embed.field value: 'Hash Value'
+
+    assert_raises(ArgumentError) { embed.color({ hex: 'value' }) }
+    assert_raises(ArgumentError) { embed.color(16_777_500) }
+    embed.color 0x008000
+    val = embed.data[:color]
+    embed.color '#008000'
+    assert_equal val, embed.data[:color]
+
+    assert_raises(ArgumentError) { embed.timestamp({ value: 'Hash' }) }
+    embed.timestamp DateTime.new(2001,2,3,4,5,6)
+  end
+end

data/test/discord/discord_notifier/version_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class Discord::NotifierTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil Discord::Notifier::VERSION
+  end
+end

data/test/discord/discord_notifier_test.rb

@@ -0,0 +1,215 @@
+require 'test_helper'
+require 'net/http'
+require 'json'
+
+class Discord::NotifierTest < Minitest::Test
+  def teardown
+    Discord::Notifier.setup do |config|
+      config.url = nil
+      config.username = nil
+      config.avatar_url = nil
+      config.wait = nil
+    end
+  end
+
+  def test_configuration
+    Discord::Notifier.setup do |config|
+      config.url = 'http://test.com'
+      config.username = 'Gem Test'
+      config.avatar_url = 'http://avatar.com/discord.png'
+    end
+
+    expected_config = Discord::Config.new 'http://test.com',
+                                          'Gem Test',
+                                          'http://avatar.com/discord.png',
+                                          nil
+
+    Discord::Notifier.setup do |config|
+      assert_equal expected_config, config
+    end
+  end
+
+  def test_string_message
+    expected_payload = {
+      url: 'http://test.com',
+      username: 'Gem Test',
+      avatar_url: 'http://avatar.com/discord.png',
+      content: 'String Message'
+    }.to_json
+
+    @mock = Minitest::Mock.new
+    @mock.expect(:post, true, [JSON.parse(expected_payload)])
+
+    Discord::Notifier.setup do |config|
+      config.url = 'http://test.com'
+      config.username = 'Gem Test'
+      config.avatar_url = 'http://avatar.com/discord.png'
+    end
+
+    Net::HTTP.stub :post, ->(uri, params, headers) {
+      @mock.post JSON.parse(params)
+    } do
+      Discord::Notifier.message "String Message"
+    end
+
+    @mock.verify
+  end
+
+  def test_embed_message
+    expected_payload = {
+      url: 'http://test.com',
+      username: 'Gem Test',
+      avatar_url: 'http://avatar.com/discord.png',
+      embeds: [{
+        title: 'Embed Message Test',
+        description: 'Sending an embed through Discord Notifier',
+        url: 'http://github.com/ianmitchell/discord_notifier',
+        color: 0x008000,
+        thumbnail: {
+          url: 'http://avatar.com/discord.png'
+        },
+        author: {
+          name: 'Ian Mitchell',
+          url: 'http://ianmitchell.io'
+        },
+        footer: {
+          text: 'Mini MiniTest Test'
+        },
+        fields: [
+          {
+            name: 'Content',
+            value: 'This is a content section'
+          },
+          {
+            name: 'Subsection',
+            value: 'This is a content subsection'
+          }
+        ]
+      }]
+    }.to_json
+
+    @mock = Minitest::Mock.new
+    @mock.expect(:post, true, [JSON.parse(expected_payload)])
+
+    Discord::Notifier.setup do |config|
+      config.url = 'http://test.com'
+      config.username = 'Gem Test'
+      config.avatar_url = 'http://avatar.com/discord.png'
+    end
+
+    Net::HTTP.stub :post, ->(uri, params, headers) {
+      @mock.post JSON.parse(params)
+    } do
+      embed = Discord::Embed.new do
+        title 'Embed Message Test'
+        description 'Sending an embed through Discord Notifier'
+        url 'http://github.com/ianmitchell/discord_notifier'
+        color 0x008000
+        thumbnail url: 'http://avatar.com/discord.png'
+        author name: 'Ian Mitchell',
+               url: 'http://ianmitchell.io'
+        footer text: 'Mini MiniTest Test'
+        add_field name: 'Content', value: 'This is a content section'
+        add_field name: 'Subsection', value: 'This is a content subsection'
+      end
+
+      Discord::Notifier.message embed
+    end
+
+    @mock.verify
+  end
+
+  def test_custom_config_message
+    @custom_config = {
+      url: 'http://custom.com',
+      username: 'Gem Config Test',
+      avatar_url: 'http://avatar.com/slack.png',
+      wait: true
+    }
+
+    expected_payload = {
+      content: 'String Message'
+    }.merge(@custom_config).to_json
+
+    @mock = Minitest::Mock.new
+    @mock.expect(:post, true, [JSON.parse(expected_payload)])
+
+    Discord::Notifier.setup do |config|
+      config.url = 'http://test.com'
+      config.username = 'Gem Test'
+      config.avatar_url = 'http://avatar.com/discord.png'
+      config.wait = true
+    end
+
+    Net::HTTP.stub :post, ->(uri, params, headers) {
+      @mock.post JSON.parse(params)
+    } do
+      Discord::Notifier.message "String Message", @custom_config
+    end
+
+    @mock.verify
+  end
+
+  def test_multiple_embeds
+    expected_payload = {
+      url: 'http://test.com',
+      username: 'Gem Test',
+      avatar_url: 'http://avatar.com/discord.png',
+      embeds: [
+        {
+          title: 'Embed Message Test',
+          description: 'Sending an embed through Discord Notifier',
+          url: 'http://github.com/ianmitchell/discord_notifier',
+        },
+        {
+          title: 'Second Embed Message Test',
+          description: 'Sending an embed through Discord Notifier',
+          url: 'http://github.com/ianmitchell/discord_notifier',
+        }
+      ]
+    }.to_json
+
+    @mock = Minitest::Mock.new
+    @mock.expect(:post, true, [JSON.parse(expected_payload)])
+
+    Discord::Notifier.setup do |config|
+      config.url = 'http://test.com'
+      config.username = 'Gem Test'
+      config.avatar_url = 'http://avatar.com/discord.png'
+    end
+
+    Net::HTTP.stub :post, ->(uri, params, headers) {
+      @mock.post JSON.parse(params)
+    } do
+      embed_one = Discord::Embed.new do
+        title 'Embed Message Test'
+        description 'Sending an embed through Discord Notifier'
+        url 'http://github.com/ianmitchell/discord_notifier'
+      end
+
+      embed_two = Discord::Embed.new do
+        title 'Second Embed Message Test'
+        description 'Sending an embed through Discord Notifier'
+        url 'http://github.com/ianmitchell/discord_notifier'
+      end
+
+      Discord::Notifier.message [embed_one, embed_two]
+    end
+
+    @mock.verify
+  end
+
+  def test_incorrect_message_type
+    assert_raises ArgumentError do
+      Discord::Notifier.message 42
+    end
+  end
+
+  def test_endpoint
+    endpoint = Discord::Notifier.endpoint(url: 'http://test.com')
+    assert endpoint.eql? URI('http://test.com')
+
+    endpoint = Discord::Notifier.endpoint(url: 'http://test.com', wait: true)
+    assert endpoint.eql? URI('http://test.com?wait=true')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'discord_notifier'
+require 'discord_notifier/version'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: discord-notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ian Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- ian.mitchel1@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/discord_notifier.rb
+- lib/discord_notifier/embed.rb
+- lib/discord_notifier/version.rb
+- test/discord/discord_notifier/embed_test.rb
+- test/discord/discord_notifier/version_test.rb
+- test/discord/discord_notifier_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ianmitchell/discord-notifier
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A minimal wrapper for posting Discord Webhooks and Embeds
+test_files:
+- test/discord/discord_notifier/embed_test.rb
+- test/discord/discord_notifier/version_test.rb
+- test/discord/discord_notifier_test.rb
+- test/test_helper.rb