hovancik/BSDSec

BsdsecMailbox has no descriptive comment
Missing top-level documentation comment for `class BsdsecMailbox`.
Missing frozen string literal comment.
class BsdsecMailbox < ApplicationMailbox
Method has too many lines. [29/10]
Cyclomatic complexity for process is too high. [12/7]
Method `process` has 29 lines of code (exceeds 25 allowed). Consider refactoring.
BsdsecMailbox#process has approx 12 statements
Assignment Branch Condition size for process is too high. [<0, 25, 11> 27.31/17]
  def process
    case email_list_address
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when ENV.fetch("TEST_EMAIL")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("Test")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when "announce@openbsd.org"
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("OpenBSD")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when "freebsd-announce@freebsd.org"
BsdsecMailbox#process calls 'create_article("FreeBSD")' 5 times
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("FreeBSD")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when "announce@freebsd.org"
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("FreeBSD")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when "security-advisories@freebsd.org"
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("FreeBSD")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when "errata-notices@freebsd.org"
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("FreeBSD")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when "core@freebsd.org"
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("FreeBSD")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when "midnightbsd-security@midnightbsd.org"
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("MidnightBSD")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when "netbsd-announce@netbsd.org"
BsdsecMailbox#process calls 'create_article("NetBSD")' 2 times
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("NetBSD")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when "announce@netbsd.org"
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("NetBSD")
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    when "security-announce@lists.pfsense.org"
Prefer single-quoted strings when you don't need string interpolation or special symbols.
      create_article("pfSense")
    else
      Email.create(from: mail.from.first,
                   to: tos.join(', '),
                   cc: ccs.join(', '),
                   subject: mail.subject, body: mail.body)
    end
  end
 
  private
 
BsdsecMailbox#tag_list_to_hashtag doesn't depend on instance state (maybe move it to another class?)
  def tag_list_to_hashtag(tag_list)
BsdsecMailbox#tag_list_to_hashtag has the variable name 'i'
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    tag_list.split(",").map { |i| "##{i} " }.join
  end
 
Method has too many lines. [12/10]
Assignment Branch Condition size for create_article is too high. [<3, 18, 1> 18.28/17]
  def create_article(tag_list)
BsdsecMailbox#create_article calls 'mail.subject' 2 times
    article = Article.create(title: mail.subject, body: mail.body,
                             from: mail.from.first,
                             tag_list: tag_list.downcase)
    f_id = article.friendly_id
Use a guard clause (`return unless ENV.fetch("TWITTER", nil)`) instead of wrapping the code inside a conditional expression.
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    if ENV.fetch("TWITTER", nil)
      payload = {
        text: "#BSDSec #{mail.subject[0..100]}... \r\n" \
          "#{tag_list_to_hashtag(tag_list)} \r\n" \
          "https://bsdsec.net/articles/#{f_id}"
      }.to_json
      twitter_client.post('tweets', payload)
    end
  end
 
  def email_list_address
Prefer single-quoted strings when you don't need string interpolation or special symbols.
    acceptable_to = ["announce@freebsd.org", "errata-notices@freebsd.org",
Prefer single-quoted strings when you don't need string interpolation or special symbols.
                     "announce@openbsd.org", "freebsd-announce@freebsd.org",
Prefer single-quoted strings when you don't need string interpolation or special symbols.
                     "netbsd-announce@netbsd.org", "announce@netbsd.org",
Prefer single-quoted strings when you don't need string interpolation or special symbols.
                     "security-advisories@freebsd.org", "core@freebsd.org",
Prefer single-quoted strings when you don't need string interpolation or special symbols.
                     "midnightbsd-security@midnightbsd.org",
Prefer single-quoted strings when you don't need string interpolation or special symbols.
                     "security-announce@lists.pfsense.org", ENV.fetch("TEST_EMAIL")]
    (acceptable_to & tos + ccs).first
  end
 
  def tos
BsdsecMailbox#tos calls 'mail.to' 2 times
    if mail.to.present?
      mail.to.map(&:downcase)
    else
      []
    end
  end
 
  def ccs
BsdsecMailbox#ccs calls 'mail.cc' 2 times
    if mail.cc.present?
      mail.cc.map(&:downcase)
    else
      []
    end
  end
 
BsdsecMailbox#twitter_client doesn't depend on instance state (maybe move it to another class?)
  def twitter_client
    x_credentials = {
      api_key: ENV['TWITTER_CONSUMER_KEY'],
      api_key_secret: ENV['TWITTER_CONSUMER_SECRET'],
      access_token: ENV['TWITTER_ACCESS_TOKEN'],
      access_token_secret: ENV['TWITTER_ACCESS_SECRET']
    }
    X::Client.new(**x_credentials)
  end
end