antispam 0.1.7 → 0.2.3

data/app/views/antispam/challenges/show.html.erb

@@ -1,19 +1,19 @@
-<p id="notice"><%= notice %></p>
-
-<p>
-  <strong>Question:</strong>
-  <%= @challenge.question %>
-</p>
-
-<p>
-  <strong>Answer:</strong>
-  <%= @challenge.answer %>
-</p>
-
-<p>
-  <strong>Code:</strong>
-  <%= @challenge.code %>
-</p>
-
-<%= link_to 'Edit', edit_challenge_path(@challenge) %> |
-<%= link_to 'Back', challenges_path %>
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Question:</strong>
+  <%= @challenge.question %>
+</p>
+
+<p>
+  <strong>Answer:</strong>
+  <%= @challenge.answer %>
+</p>
+
+<p>
+  <strong>Code:</strong>
+  <%= @challenge.code %>
+</p>
+
+<%= link_to 'Edit', edit_challenge_path(@challenge) %> |
+<%= link_to 'Back', challenges_path %>

data/app/views/antispam/clears/index.html.erb

@@ -1,32 +1,32 @@
-<p id="notice"><%= notice %></p>
-
-<h1>Clears</h1>
-
-<table>
-  <thead>
-    <tr>
-      <th>Ip</th>
-      <th>Result</th>
-      <th>Answer</th>
-      <th>Threat before</th>
-      <th>Threat after</th>
-      <th colspan="3"></th>
-    </tr>
-  </thead>
-
-  <tbody>
-    <% Antispam::Clear.all.order(created_at: :desc).limit(50).each do |clear| %>
-      <tr>
-        <td><%= clear.ip %></td>
-        <td><%= clear.result %></td>
-        <td><%= clear.answer %></td>
-        <td><%= clear.threat_before %></td>
-        <td><%= clear.threat_after %></td>
-        <td><%= time_ago_in_words clear.created_at %> ago</td>
-<!--        <td><%#= link_to 'Show', clear %></td>-->
-<!--        <td><%#= link_to 'Edit', edit_clear_path(clear) %></td>-->
-<!--        <td><%#= link_to 'Destroy', clear, method: :delete, data: { confirm: 'Are you sure?' } %></td>-->
-      </tr>
-    <% end %>
-  </tbody>
-</table>
+<p id="notice"><%= notice %></p>
+
+<h1>Clears</h1>
+
+<table>
+  <thead>
+    <tr>
+      <th>Ip</th>
+      <th>Result</th>
+      <th>Answer</th>
+      <th>Threat before</th>
+      <th>Threat after</th>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% Antispam::Clear.all.order(created_at: :desc).limit(50).each do |clear| %>
+      <tr>
+        <td><%= clear.ip %></td>
+        <td><%= clear.result %></td>
+        <td><%= clear.answer %></td>
+        <td><%= clear.threat_before %></td>
+        <td><%= clear.threat_after %></td>
+        <td><%= time_ago_in_words clear.created_at %> ago</td>
+<!--        <td><%#= link_to 'Show', clear %></td>-->
+<!--        <td><%#= link_to 'Edit', edit_clear_path(clear) %></td>-->
+<!--        <td><%#= link_to 'Destroy', clear, method: :delete, data: { confirm: 'Are you sure?' } %></td>-->
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/antispam/clears/show.html.erb

@@ -1,29 +1,29 @@
-<p id="notice"><%= notice %></p>
-
-<p>
-  <strong>Ip:</strong>
-  <%= @clear.ip %>
-</p>
-
-<p>
-  <strong>Result:</strong>
-  <%= @clear.result %>
-</p>
-
-<p>
-  <strong>Answer:</strong>
-  <%= @clear.answer %>
-</p>
-
-<p>
-  <strong>Threat before:</strong>
-  <%= @clear.threat_before %>
-</p>
-
-<p>
-  <strong>Threat after:</strong>
-  <%= @clear.threat_after %>
-</p>
-
-<%= link_to 'Edit', edit_clear_path(@clear) %> |
-<%= link_to 'Back', clears_path %>
+<p id="notice"><%= notice %></p>
+
+<p>
+  <strong>Ip:</strong>
+  <%= @clear.ip %>
+</p>
+
+<p>
+  <strong>Result:</strong>
+  <%= @clear.result %>
+</p>
+
+<p>
+  <strong>Answer:</strong>
+  <%= @clear.answer %>
+</p>
+
+<p>
+  <strong>Threat before:</strong>
+  <%= @clear.threat_before %>
+</p>
+
+<p>
+  <strong>Threat after:</strong>
+  <%= @clear.threat_after %>
+</p>
+
+<%= link_to 'Edit', edit_clear_path(@clear) %> |
+<%= link_to 'Back', clears_path %>

data/app/views/antispam/validate/index.html.erb

@@ -1,14 +1,16 @@
-<% @challenge = Antispam::Challenge.create %>
-<h1>Human Challenge</h1>
-
-<p>Please prove that you are human.</p>
-
-<img src="/antispam/challenges/<%= @challenge.id %>.jpg" width="200" height="40">
-
-<%= form_for @challenge do |f| %>
-  <%= f.hidden_field :id, value: @challenge.id %>
-  <%= f.text_field :answer, value: '' %>
-  <%= submit_tag "Submit" %>
-<% end %>
-
-<% flash.each do |type, msg| %><div><%= msg %></div><% end %>
+<% @challenge = Antispam::Challenge.create %>
+<div class="centerblock">
+<h1>Human Challenge</h1>
+
+<p>Please prove that you are human.</p>
+
+<img src="/antispam/challenges/<%= @challenge.id %>.jpg" width="200" height="40">
+
+<%= form_for @challenge do |f| %>
+  <%= f.hidden_field :id, value: @challenge.id %>
+  <%= f.text_field :answer, value: '' %>
+  <%= submit_tag "Submit" %>
+<% end %>
+
+<% flash.each do |type, msg| %><div><%= msg %></div><% end %>
+</div>

data/app/views/layouts/antispam/application.html.erb

@@ -1,15 +1,25 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Antispam</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-  <style>.row { width:100%;display: flex;} .cx { width: 50%; }</style>
-  <%#= stylesheet_link_tag    "antispam/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Antispam</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <style>
+  .row { width:100%;display: flex;}
+  .cx { width: 50%; }
+  .centerblock {
+    box-shadow: 1px 1px 7px #000;
+    max-width: 300px;
+    margin: 3em auto;
+    padding: 0.5em 2em 2em;
+    width: 100%;
+  }
+  </style>
+  <%#= stylesheet_link_tag    "antispam/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -1,7 +1,7 @@
-Antispam::Engine.routes.draw do
-  resources :clears
-  resources :blocks
-  resources :challenges
-  root to: 'ips#index'
-  get 'validate', to: 'validate#index'
-end
+Antispam::Engine.routes.draw do
+  resources :clears
+  resources :blocks
+  resources :challenges
+  root to: 'ips#index'
+  get 'validate', to: 'validate#index'
+end

data/db/migrate/20210130213708_create_antispam_ips.rb

@@ -1,12 +1,12 @@
-class CreateAntispamIps < ActiveRecord::Migration[6.1]
-  def change
-    create_table :antispam_ips do |t|
-      t.string :address
-      t.string :provider
-      t.integer :threat
-      t.datetime :expires_at
-
-      t.timestamps
-    end
-  end
-end
+class CreateAntispamIps < ActiveRecord::Migration[6.1]
+  def change
+    create_table :antispam_ips do |t|
+      t.string :address
+      t.string :provider
+      t.integer :threat
+      t.datetime :expires_at
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210130214835_create_antispam_challenges.rb

@@ -1,11 +1,11 @@
-class CreateAntispamChallenges < ActiveRecord::Migration[6.1]
-  def change
-    create_table :antispam_challenges do |t|
-      t.string :question
-      t.string :answer
-      t.string :code
-
-      t.timestamps
-    end
-  end
-end
+class CreateAntispamChallenges < ActiveRecord::Migration[6.1]
+  def change
+    create_table :antispam_challenges do |t|
+      t.string :question
+      t.string :answer
+      t.string :code
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210130234107_create_antispam_blocks.rb

@@ -1,12 +1,12 @@
-class CreateAntispamBlocks < ActiveRecord::Migration[6.1]
-  def change
-    create_table :antispam_blocks do |t|
-      t.string :ip
-      t.string :provider
-      t.string :controllername
-      t.string :actionname
-
-      t.timestamps
-    end
-  end
-end
+class CreateAntispamBlocks < ActiveRecord::Migration[6.1]
+  def change
+    create_table :antispam_blocks do |t|
+      t.string :ip
+      t.string :provider
+      t.string :controllername
+      t.string :actionname
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210130235537_create_antispam_clears.rb

@@ -1,13 +1,13 @@
-class CreateAntispamClears < ActiveRecord::Migration[6.1]
-  def change
-    create_table :antispam_clears do |t|
-      t.string :ip
-      t.string :result
-      t.string :answer
-      t.integer :threat_before
-      t.integer :threat_after
-
-      t.timestamps
-    end
-  end
-end
+class CreateAntispamClears < ActiveRecord::Migration[6.1]
+  def change
+    create_table :antispam_clears do |t|
+      t.string :ip
+      t.string :result
+      t.string :answer
+      t.integer :threat_before
+      t.integer :threat_after
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20210131165122_add_threat_to_antispam_blocks.rb

@@ -1,5 +1,5 @@
-class AddThreatToAntispamBlocks < ActiveRecord::Migration[6.1]
-  def change
-    add_column :antispam_blocks, :threat, :integer
-  end
-end
+class AddThreatToAntispamBlocks < ActiveRecord::Migration[6.1]
+  def change
+    add_column :antispam_blocks, :threat, :integer
+  end
+end

data/lib/antispam/blacklists/httpbl.rb

@@ -1,48 +1,49 @@
-require 'resolv'
-module Antispam
-  module Blacklists
-    class Httpbl
-      def self.check(ip, key, verbose)
-        threat = 0
-        begin
-          old_result = get_old_result(ip)
-          if old_result
-            Rails.logger.info "Returning old result for #{ip}." if verbose
-            return get_old_result(ip)
-          end
-          check = ip.split('.').reverse.join('.')
-          host = key + '.' + check + ".dnsbl.httpbl.org"
-          address = Resolv::getaddress(host)
-          z,days,threat,iptype = address.split('.')
-          Rails.logger.info "Spam located: #{iptype} type at #{threat} threat. (#{ip} - #{address})" if verbose
-          threat = threat.to_i
-          # Create or update
-          if (threat > 30)
-            Rails.logger.info "Spamcheck: Very high, over 30!" if verbose
-          end
-        rescue Exception => e
-          case e
-          when Resolv::ResolvError #Not spam! This blacklist gives an error when there's no spam threat.
-            Rails.logger.info "Spamcheck: OK! Resolve error means the httpbl does not consider this spam." if verbose
-          when Interrupt #Something broke while trying to check blacklist.
-            Rails.logger.info "Spamcheck: Interrupt when trying to resolve http blacklist. Possible timeout?" if verbose
-          else # Time Out
-            Rails.logger.info "Spamcheck: There was an error, possibly a time out, when checking this IP." if verbose
-            Rails.logger.info e.to_s if verbose
-          end
-        end
-        update_old_result(ip, threat)
-        return threat
-      end
-      def self.get_old_result(ip)
-        result = Antispam::Ip.find_by(address: ip, provider: 'httpbl')
-        return nil if (result.nil? || result.expired?)
-        return result.threat
-      end
-      def self.update_old_result(ip, threat)
-        result = Antispam::Ip.find_or_create_by(address: ip, provider: 'httpbl')
-        result.update(threat: threat, expires_at: 24.hours.from_now)
-      end
-    end
-  end
-end
+require 'resolv'
+module Antispam
+  module Blacklists
+    class Httpbl
+      # Returns a threat-level number, or 0 if no threat / no result.
+      def self.check(ip, key, verbose)
+        threat = 0
+        begin
+          old_result = get_old_result(ip)
+          if old_result
+            Rails.logger.info "Returning old result for #{ip}." if verbose
+            return get_old_result(ip)
+          end
+          check = ip.split('.').reverse.join('.')
+          host = key + '.' + check + ".dnsbl.httpbl.org"
+          address = Resolv::getaddress(host)
+          z,days,threat,iptype = address.split('.')
+          Rails.logger.info "Spam located: #{iptype} type at #{threat} threat. (#{ip} - #{address})" if verbose
+          threat = threat.to_i
+          # Create or update
+          if (threat > 30)
+            Rails.logger.info "Spamcheck: Very high, over 30!" if verbose
+          end
+        rescue Exception => e
+          case e
+          when Resolv::ResolvError #Not spam! This blacklist gives an error when there's no spam threat.
+            Rails.logger.info "Spamcheck: OK! Resolve error means the httpbl does not consider this spam." if verbose
+          when Interrupt #Something broke while trying to check blacklist.
+            Rails.logger.info "Spamcheck: Interrupt when trying to resolve http blacklist. Possible timeout?" if verbose
+          else # Time Out
+            Rails.logger.info "Spamcheck: There was an error, possibly a time out, when checking this IP." if verbose
+            Rails.logger.info e.to_s if verbose
+          end
+        end
+        update_old_result(ip, threat)
+        return threat
+      end
+      def self.get_old_result(ip)
+        result = Antispam::Ip.find_by(address: ip, provider: 'httpbl')
+        return nil if (result.nil? || result.expired?)
+        return result.threat
+      end
+      def self.update_old_result(ip, threat)
+        result = Antispam::Ip.find_or_create_by(address: ip, provider: 'httpbl')
+        result.update(threat: threat, expires_at: 24.hours.from_now)
+      end
+    end
+  end
+end

data/lib/antispam/checker.rb

@@ -1,20 +1,31 @@
-module Antispam
-  module Checker
-    # Checks content for spam
-    # check(options, spamcheck_providers)
-    # Usage: check({content: "No spam here"}, {defendium: 'MY_API_KEY'}})
-    def self.check(options = {}, spamcheck_providers = {defendium: 'YOUR_KEY'})
-      Rails.logger.info "Content was nil for spamcheck." if options[:content].nil? && options[:verbose]
-      return if options[:content].nil?
-      Rails.logger.info "Spamcheckers should be a hash" if (!(options[:spamcheck_providers].is_a? Hash)) && options[:verbose]
-      results = []
-      spamcheck_providers.each do |spamchecker_name, spamchecker_api_key|
-        if spamchecker_name == :defendium
-          results.append Antispam::Spamcheckers::Defendium.check(options[:content], spamchecker_api_key, options[:verbose])
-        end
-      end
-      result = Antispam::SpamcheckResult.new(results)
-      return result
-    end
-  end
+module Antispam
+  module Checker
+    # Checks content for spam
+    # check(options)
+    # Usage: check({content: "No spam here", providers: { defendium: 'MY_API_KEY'}})
+    def self.check(options = {})
+      # Default provider. 'YOUR_KEY' works temporarily, giving a warning but also giving results
+      # eventually add something to tell users to add their own keys
+      # or choose their preferred provider, when more provider options are added.
+      options[:providers] ||= {defendium: 'YOUR_KEY'}
+      Rails.logger.info "Content was nil for spamcheck." if options[:content].nil? && options[:verbose]
+      return if options[:content].nil?
+      Rails.logger.info "Spamcheckers should be a hash" if (!(options[:providers].is_a? Hash)) && options[:verbose]
+      results = []
+      options[:providers].each do |spamchecker_name, spamchecker_api_key|
+        results.append spamchecker(spamchecker_name).check(options[:content], spamchecker_api_key, options[:verbose])
+        # if spamchecker_name == :defendium
+        #   results.append Antispam::Spamcheckers::Defendium.check(options[:content], spamchecker_api_key, options[:verbose])
+        # end
+      end
+      result = Antispam::SpamcheckResult.new(results)
+      return result
+    end
+    def self.spamchecker(provider)
+      class_name = provider.to_s.camelize
+      raise Antispam::NoSuchSpamcheckerError unless Antispam::Spamcheckers.const_defined? class_name
+      Antispam::Spamcheckers.const_get class_name
+    end
+  end
+  class NoSuchSpamcheckerError < StandardError; end
 end

data/lib/antispam/engine.rb

@@ -1,5 +1,5 @@
-module Antispam
-  class Engine < ::Rails::Engine
-    isolate_namespace Antispam
-  end
-end
+module Antispam
+  class Engine < ::Rails::Engine
+    isolate_namespace Antispam
+  end
+end

data/lib/antispam/results.rb

@@ -1,10 +1,18 @@
-module Antispam
-  class SpamcheckResult
-    def initialize(results)
-      @results = results
-    end
-    def is_spam?
-      @results.select{|x| x > 0}.present?
-    end
-  end
-end
+module Antispam
+  class SpamcheckResult
+    def initialize(results)
+      @results = results
+    end
+    def is_spam?
+      @results.select{|x| x > 0}.present?
+    end
+  end
+  class BlacklistResult
+    def initialize(results)
+      @results = results
+    end
+    def is_bad?
+      @results.select{|x| x > 30}.present?
+    end
+  end
+end

data/lib/antispam/spamcheckers/defendium.rb

@@ -1,29 +1,30 @@
-#require 'resolv'
-module Antispam
-  module Spamcheckers
-    class Defendium
-      def self.check(content, key, verbose)
-        # nethttp2.rb
-        require 'uri'
-        require 'net/http'
-
-        uri = URI('https://api.defendium.com/check')
-        params = { secret_key: key, content: content }
-        uri.query = URI.encode_www_form(params)
-
-        res = Net::HTTP.get_response(uri)
-        if res.is_a?(Net::HTTPSuccess)
-          result = res.body.to_json
-          if result["warnings"]
-            Rails.logger.info result["warnings"]
-          end
-          if result["result"]
-            return 1
-          else
-            return 0
-          end
-        end
-      end
-    end
-  end
+#require 'resolv'
+module Antispam
+  module Spamcheckers
+    class Defendium
+      # Returns a boolean, 1 for spam, 0 for not spam.
+      def self.check(content, key, verbose)
+        # nethttp2.rb
+        require 'uri'
+        require 'net/http'
+
+        uri = URI('https://api.defendium.com/check')
+        params = { secret_key: key, content: content }
+        uri.query = URI.encode_www_form(params)
+
+        res = Net::HTTP.get_response(uri)
+        if res.is_a?(Net::HTTPSuccess)
+          result = res.body.to_json
+          if result["warnings"]
+            Rails.logger.info result["warnings"]
+          end
+          if result["result"]
+            return 1
+          else
+            return 0
+          end
+        end
+      end
+    end
+  end
 end