discord-notifier 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e41269eca4f21db07c035912dad45faad3c539e1
-  data.tar.gz: a21a0062df3506c83a23f5e5e896903bce6af3a1
+  metadata.gz: 7b3fbe0ad1ca1e827db62d6a6f607b072980026d
+  data.tar.gz: 055e7d9f3efe5851775a2daece7100a90ade56a5
 SHA512:
-  metadata.gz: 65b4a8566e174b2bf25a246a58c07c31f3590dea6cc88c5f60c34343286a6cc722abb429d519b3df30f95880b164b5887435fd2d6275bea33b5e9036d7c4eff7
-  data.tar.gz: e712272a5e281853adea41d595a255935759978daa3d9b2ff03d15dd7643bc5bd01828ca964710b25106fed7e49295009014c17c2a0da735a32b53a0ddc2d684
+  metadata.gz: dabdedca9c9e8969da6ee244e2f3b27fc47e156d201c9a5350cb380090edc3cc781c01e656cfa169dbf08982c8f469227a7131f7d13b15ec1c80426ada4000f7
+  data.tar.gz: b67f80ecb556bf27d1a28c8ea84cc407a65a5bb438f11adeead927d15758e792b12e7d8b10baedc1b1ef150c33ca382362f744a84589a27f646676d7c5bf1dc3

data/lib/discord_notifier.rb

@@ -1,11 +1,17 @@
 require 'json'
 require 'net/http'
+require 'net/https'
 require_relative 'discord_notifier/embed'
+require_relative 'discord_notifier/form_data'
+require_relative 'discord_notifier/backports/hash'
+require_relative 'discord_notifier/backports/http'
 
 module Discord
+  using Backports
+
   Config = Struct.new(:url, :username, :avatar_url, :wait)
 
-  class Notifier
+  module Notifier
     @@config = Config.new
 
     def self.setup
@@ -13,22 +19,48 @@ module Discord
     end
 
     def self.message(content, config = {})
-      params = @@config.to_h.merge(config).compact
+      params = payload(content, config)
+
+      if params[:file]
+        send_form(params)
+      else
+        send_request(params)
+      end
+    end
+
+    def self.payload(content, config)
+      payload = @@config.to_h.merge(config)
 
       case content
       when String
-        params[:content] = content
+        payload[:content] = content
       when Embed
-        params[:embeds] = [content.data]
+        payload[:embeds] = [content.data]
       when Array
-        params[:embeds] = content.map { |embed| embed.data }
-      # when Attachment
+        payload[:embeds] = content.map { |embed| embed.data }
+      when File
+        payload[:file] = content
       else
         raise ArgumentError, 'Unsupported content type'
       end
 
+      payload.compact
+    end
+
+    def self.send_request(params)
+      Net::HTTP.post endpoint(params),
+                     params.to_json,
+                     'Content-Type': 'application/json'
+    end
+
+    def self.send_form(params)
       uri = endpoint(params)
-      Net::HTTP.post(uri, params.to_json, "Content-Type": "application/json")
+
+      req = Discord.form_data_request(uri, params)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.request(req)
     end
 
     def self.endpoint(config)

data/lib/discord_notifier/backports/hash.rb

@@ -0,0 +1,11 @@
+module Discord
+  module Backports
+    unless Hash.instance_methods(false).include?(:compact)
+      refine Hash do
+        def compact
+          select { |_, value| !value.nil? }
+        end
+      end
+    end
+  end
+end

data/lib/discord_notifier/backports/http.rb

@@ -0,0 +1,16 @@
+require 'net/http'
+
+module Discord
+  module Backports
+    unless Net::HTTP.methods.include?(:post)
+      refine Net::HTTP.singleton_class do
+        def post(url, data, header = nil)
+          start(url.hostname, url.port,
+                :use_ssl => url.scheme == 'https' ) {|http|
+            http.post(url.path, data, header)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/discord_notifier/form_data.rb

@@ -0,0 +1,35 @@
+require 'net/http'
+
+module Discord
+  BOUNDARY = "DiscordNotifier"
+
+  def self.form_data_request(uri, params)
+    req = Net::HTTP::Post.new(uri)
+    req.add_field "Content-Type", "multipart/form-data; boundary=#{BOUNDARY}"
+    req.body = Discord.multipart_form_data(params)
+    return req
+  end
+
+  def self.multipart_form_data(config)
+    file = config[:file]
+    filename = File.basename(file.path)
+    file_contents = File.read(file)
+    payload = config.select {|k, v| k != :file}
+
+    form = <<~eos
+      --#{BOUNDARY}
+      Content-Disposition: form-data; name="file"; filename="#{filename}"
+
+      #{file_contents}
+
+      --#{BOUNDARY}
+      Content-Disposition: form-data; name="payload_json"
+
+      #{payload.to_json}
+
+      --#{BOUNDARY}--
+    eos
+
+    form.encode crlf_newline: true
+  end
+end

data/lib/discord_notifier/version.rb

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

data/test/discord/discord_notifier/embed_test.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'date'
 
 class Discord::EmbedTest < Minitest::Test
   def test_that_it_has_a_data_hash

data/test/discord/discord_notifier/form_data_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class Discord::FormDataTest < Minitest::Test
+  def expected_form_body
+    Dir.chdir(File.dirname(__FILE__))
+    File.read('../../form_body.txt')
+  end
+
+  def test_that_boundary_is_defined
+    refute_nil Discord::BOUNDARY
+  end
+
+  def test_form_data_request_has_correct_header
+    params = {
+      url: 'http://test.com',
+      username: 'Gem Test',
+      avatar_url: 'http://avatar.com/discord.png',
+      file: test_attachment
+    }
+
+    request = Discord.form_data_request(URI('http://test.com'), params)
+    assert_equal 'multipart/form-data', request.content_type
+  end
+
+  def test_multipart_form_data_has_correct_format
+    expected_body = expected_form_body
+    params = {
+      url: 'http://test.com',
+      username: 'Gem Test',
+      avatar_url: 'http://avatar.com/discord.png',
+      file: test_attachment
+    }
+
+    body = Discord.multipart_form_data(params)
+    assert_equal expected_body, body
+  end
+end

data/test/discord/discord_notifier_test.rb

@@ -3,6 +3,14 @@ require 'net/http'
 require 'json'
 
 class Discord::NotifierTest < Minitest::Test
+  def setup
+    Discord::Notifier.setup do |config|
+      config.url = 'http://test.com'
+      config.username = 'Gem Test'
+      config.avatar_url = 'http://avatar.com/discord.png'
+    end
+  end
+
   def teardown
     Discord::Notifier.setup do |config|
       config.url = nil
@@ -13,12 +21,6 @@ class Discord::NotifierTest < Minitest::Test
   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',
@@ -29,34 +31,44 @@ class Discord::NotifierTest < Minitest::Test
     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
+  def test_has_message
+    assert Discord::Notifier.methods.include? :message
+  end
 
-    @mock = Minitest::Mock.new
-    @mock.expect(:post, true, [JSON.parse(expected_payload)])
+  def test_message_responds_to_correct_format
+    form_params = nil
+    request_params = nil
+    file = test_attachment
 
-    Discord::Notifier.setup do |config|
-      config.url = 'http://test.com'
-      config.username = 'Gem Test'
-      config.avatar_url = 'http://avatar.com/discord.png'
+    Discord::Notifier.stub :send_form, ->(args) { form_params = args } do
+      Discord::Notifier.message file
     end
 
-    Net::HTTP.stub :post, ->(uri, params, headers) {
-      @mock.post JSON.parse(params)
-    } do
+    assert form_params
+
+    Discord::Notifier.stub :send_request, ->(args) { request_params = args } do
       Discord::Notifier.message "String Message"
     end
 
-    @mock.verify
+    assert request_params
+  end
+
+  def test_string_message
+    actual_params = nil
+    expected_params = {
+      url: 'http://test.com',
+      username: 'Gem Test',
+      avatar_url: 'http://avatar.com/discord.png',
+      content: 'String Message'
+    }
+
+    actual_params = Discord::Notifier.payload "String Message", {}
+    assert_equal expected_params, actual_params
   end
 
   def test_embed_message
-    expected_payload = {
+    actual_params = nil
+    expected_params = {
       url: 'http://test.com',
       username: 'Gem Test',
       avatar_url: 'http://avatar.com/discord.png',
@@ -86,72 +98,44 @@ class Discord::NotifierTest < Minitest::Test
           }
         ]
       }]
-    }.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
+    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
 
-    @mock.verify
+    actual_params = Discord::Notifier.payload embed, {}
+    assert_equal expected_params, actual_params
   end
 
   def test_custom_config_message
-    @custom_config = {
+    custom_config = {
       url: 'http://custom.com',
       username: 'Gem Config Test',
       avatar_url: 'http://avatar.com/slack.png',
       wait: true
     }
-
-    expected_payload = {
+    actual_params = nil
+    expected_params = {
       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
+    }.merge(custom_config)
 
-    @mock.verify
+    actual_params = Discord::Notifier.payload "String Message", custom_config
+    assert_equal expected_params, actual_params
   end
 
   def test_multiple_embeds
-    expected_payload = {
+    actual_params = nil
+    expected_params = {
       url: 'http://test.com',
       username: 'Gem Test',
       avatar_url: 'http://avatar.com/discord.png',
@@ -167,36 +151,36 @@ class Discord::NotifierTest < Minitest::Test
           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'
+    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
 
-    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]
+    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
 
-    @mock.verify
+    actual_params = Discord::Notifier.payload [embed_one, embed_two], {}
+    assert_equal expected_params, actual_params
+  end
+
+  def test_file_attachment
+    file = test_attachment
+    actual_params = nil
+    expected_params = {
+      url: 'http://test.com',
+      username: 'Gem Test',
+      avatar_url: 'http://avatar.com/discord.png',
+      file: file
+    }
+
+    actual_params = Discord::Notifier.payload file, {}
+    assert_equal expected_params, actual_params
   end
 
   def test_incorrect_message_type
@@ -206,10 +190,10 @@ class Discord::NotifierTest < Minitest::Test
   end
 
   def test_endpoint
-    endpoint = Discord::Notifier.endpoint(url: 'http://test.com')
+    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)
+    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

@@ -1,5 +1,26 @@
+require 'net/http'
+
+# Since refinements don't work with `respond_to` which
+# Minitest uses when it stubs methods, we need to monkey
+# patch Net::HTTP here for our tests.
+unless Net::HTTP.methods.include?(:post)
+  class Net::HTTP
+    def self.post(url, data, header = nil)
+      start(url.hostname, url.port,
+            :use_ssl => url.scheme == 'https' ) {|http|
+        http.post(url.path, data, header)
+      }
+    end
+  end
+end
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'discord_notifier'
 require 'discord_notifier/version'
 
 require 'minitest/autorun'
+
+def test_attachment
+  Dir.chdir(File.dirname(__FILE__))
+  File.open('test_attachment.txt')
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discord-notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ian Mitchell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,9 +60,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/discord_notifier.rb
+- lib/discord_notifier/backports/hash.rb
+- lib/discord_notifier/backports/http.rb
 - lib/discord_notifier/embed.rb
+- lib/discord_notifier/form_data.rb
 - lib/discord_notifier/version.rb
 - test/discord/discord_notifier/embed_test.rb
+- test/discord/discord_notifier/form_data_test.rb
 - test/discord/discord_notifier/version_test.rb
 - test/discord/discord_notifier_test.rb
 - test/test_helper.rb
@@ -78,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -92,6 +96,7 @@ 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/form_data_test.rb
 - test/discord/discord_notifier/version_test.rb
 - test/discord/discord_notifier_test.rb
 - test/test_helper.rb