spamcaster 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1887d7219a11466d1b181bca48bf9e7a7f8894766de4342cb817bafe21df0c14
+  data.tar.gz: f439ba559478c67e0104e6e75dddb8332a9dbd69ae8b9363872ec08d55099b55
+SHA512:
+  metadata.gz: 42e4bd8e59ac11db89d71dac6fc53663d68114cd149606205cd373e1815f3c0b3108a9d06ac7e1e4b7d4c1aae7a884dd3c2cbdfb7aa11e9f80d286a60f885720
+  data.tar.gz: 68ca3ffb33454a736e44d5a8cd565d60e5299fcb35774adff33379d895c2b088487892ace284f2ce3d24cf31fc365130e06727e0d059aacf4acf9cf715d59bda

data/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT No Attribution
+
+Copyright © 2023 Dube Software
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+A [Sinatra](https://sinatrarb.com/)-based web endpoint that accepts JSON payloads and fires off Slack notifications upon detection of spam. 

data/bin/spamcaster

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/spamcaster/notifier'
+require_relative '../lib/spamcaster/request'
+require 'json'
+require 'sinatra'
+require 'sinatra/namespace'
+
+class SpamcasterApp < Sinatra::Application
+  namespace '/api/v1' do
+    get '/' do
+      message = "{message: This is the API index. " +
+      "To check a JSON payload for spam, POST it to the '/api/v1/spamcheck' path.}"
+      
+      JSON.generate message.strip
+    end
+    
+    post '/spamcheck' do
+      body    = JSON.parse request.body.read
+      request = SpamCaster::Request.new body
+      case request.spam?
+      when true
+        notification = SpamCaster::Notifier.notify(:slack, request.email_address)
+        message      = "{message: #{notification}}"
+        JSON.generate message
+      else
+        JSON.generate '{message: "No spam was detected :)"}'
+      end
+    end
+  end
+end
+
+SpamcasterApp.run!

data/lib/spamcaster/notifier.rb

@@ -0,0 +1,43 @@
+require 'httpx'
+require 'json'
+
+module SpamCaster
+  class Notifier
+    # N.B: The Webhook URL would NOT live here in a production application
+    SLACK_WEBHOOK_URL = 'https://hooks.slack.com/services/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'
+    
+    def self.notify(type, recipient)
+      send(type, recipient)
+    end
+    
+    private
+      
+      def self.send(type, recipient)
+        case type
+        when :email
+          email recipient
+        when :slack
+          slack recipient
+        end
+      end
+      
+      def self.slack_json_payload(recipient)
+        {:json =>
+          {
+            "text" => "A spam payload for the email address #{recipient} was detected."
+          }
+        }
+      end
+      
+      def self.email(recipient)
+        "Email notification sent to #{recipient}!"
+      end
+      
+      def self.slack(recipient)
+        HTTPX.post(SLACK_WEBHOOK_URL, :json => slack_json_payload(recipient)[:json])
+        "Slack notification for #{recipient} sent to Spamcaster's Slack channel!"
+      end
+      
+      # Etc. Define methods to send other notification types e.g. SMS here
+  end
+end

data/lib/spamcaster/request.rb

@@ -0,0 +1,44 @@
+module SpamCaster
+  class Request
+    attr_reader :email_address, :payload, :spam
+  
+    PAYLOAD_TYPE_CODES = {
+      spam_notificiation: 512,
+      hard_bounce: 1
+    }
+  
+    PAYLOAD_TYPES = {
+      512 => "SpamNotification",
+      1   => "HardBounce"
+    }
+    
+    def initialize(body)
+      @body = body
+      @spam = false
+      check_spam
+      set_email_address
+    end
+  
+    def spam?
+      @spam
+    end
+    
+    def to_s
+      @body
+    end
+    
+    private
+      
+      def check_spam
+        spam_type_code        = PAYLOAD_TYPE_CODES[:spam_notificiation]
+        spam_type             = PAYLOAD_TYPES[spam_type_code]
+        received_payload_type = @body["Type"]
+        
+        @spam                 = (received_payload_type == spam_type)
+      end
+  
+      def set_email_address
+        @email_address = @body["Email"]
+      end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: spamcaster
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Lloyd Dube
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-09 00:00:00.000000000 Z
+dependencies: []
+description: "A [Sinatra](https://sinatrarb.com/)-based web endpoint that accepts
+  JSON payloads and fires off Slack notifications upon detection of spam. \n"
+email: zebra05+spamcaster@gmail.com
+executables:
+- spamcaster
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/spamcaster
+- lib/spamcaster/notifier.rb
+- lib/spamcaster/request.rb
+homepage: https://github.com/dubesoftware/spamcaster
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.7
+signing_key:
+specification_version: 4
+summary: A Sinatra-based web endpoint that accepts JSON payloads and fires off Slack
+  notifications upon detection of spam.
+test_files: []