osa 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22c6dd2dc64261089df031e75fee841e1416276244674dce617792aacbb12fca
-  data.tar.gz: f0442134bc13835edcbacea2aa594fdc95202e47beed2e71c29f5214bbae2335
+  metadata.gz: 257c4fb16627c69c705da1ca2c95fe5b120f7706cbbacec3cb5b54cec8aa4e97
+  data.tar.gz: 003041712c82eeb6d9e686de02a36372517dfda89c5d1b4ca58920efc1a06cfd
 SHA512:
-  metadata.gz: ca001d8b232f9bfa8bcfde6e75be2a6e1a7b2d025254e22af2feec25625d979e3bd10a88325cee888442b5686b22c7f93fd1866225d7bb6ca38e27e9c62e05af
-  data.tar.gz: 7d96e933b2c4b09d335f825c933ba01197399aea947e7ca2fca3f66a851c7f469f046fd37abbb59548c54fbb37835eef3684540172cf01bcf30489f2106e6208
+  metadata.gz: 904c9b9e2db9f64c0bdab038a3fce8cb5f294ed7c38f1a25ad50f4df769456880ac7e3a17df7dcf6a101f332c836f821edf7e992a07a6ce1ec4b6c1604862407
+  data.tar.gz: 8ee576b4dcb8c7e78742328fbc3921ac7f17a7d56b85bf2474feb251cdcc8d6a5deda969d2219a40815d8f14075d4fdae5fcd9c400abbcc1b0974ee8ba7eb782

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    osa (0.1.1)
+    osa (0.1.2)
       activerecord (~> 6.0)
       faraday (~> 1.1)
       public_suffix (~> 4.0)

data/README.md

@@ -4,17 +4,18 @@
 
 ### Basics
 
-OSA uses asks you to choose two folders one "junk" folder and one "report" folder. Even though you can choose any folder
-for both, it's recommend to choose the default junk folder as the junk folder and create a custom folder for as the report
-folder.
+OSA asks you to choose your junk folder on first configuration. After the folder is selected, the `scan-junk` command
+allows you to scan the folder to report and delete any unwanted spam. It's important to chose the actual junk folder
+so your Outlook spam filters does not get broken. However, OSA will work with any folder. The processing for each email
+uses the following rules:
 
-These two folders will be used the following way:
-- When the report folder is scanned, all emails are reported to [Spamcop](https://spamcop.net), deleted and the senders blacklisted.
-- When the junk folder is scanned, all emails from the blacklist are reported to [Spamcop](https://spamcop.net) and deleted.
+1. If the email is flagged, the email is reported to Spamcop, then deleted and the sender is blacklisted.
+2. If the email's sender is blacklisted, the email is reported to Spamcop, then deleted.
+3. Otherwise, the email is left untouched. 
 
-*OSA will not touch any folder beside these two.*
+*OSA will not touch any folder beside the folder you've chosen.*
 
-*It's the user's responsibility to move junk mails to the report folder to build up the blacklist.*
+*It's the user's responsibility to move junk mails to the junk folder and flag them to build up the blacklist.*
 
 ### The blacklist
 
@@ -58,12 +59,6 @@ osa setup
 
 Each time you run this command, your previous configuration will be erased, except for your blacklist.
 
-Process your report folder:
-
-```sh
-osa scan-report
-```
-
 Process your junk folder:
 
 ```sh

data/exe/osa

@@ -12,9 +12,7 @@ when 'login'
   OSA::AuthService.login(OSA::Config.first || OSA::Config.new)
 when 'scan-junk'
   require 'osa/scripts/scan_junk_folder'
-when 'scan-report'
-  require 'osa/scripts/scan_report_folder'
 else
-  $stderr.puts "Usage: #{File.basename($0)} [setup|login|scan-junk|scan-report]"
+  $stderr.puts "Usage: #{File.basename($0)} [setup|login|scan-junk]"
   exit 1
 end

data/lib/osa/clients/ms_graph_client.rb

@@ -33,11 +33,11 @@ module OSA
     end
 
     def folders
-      Paginated.new(@authenticated.get('/v1.0/me/mailFolders'), self)
+      Paginated.new(@authenticated.get('/v1.0/me/mailFolders'), @authenticated)
     end
 
     def mails(folder_id)
-      Paginated.new(@authenticated.get("/v1.0/me/mailFolders/#{folder_id}/messages"), self)
+      Paginated.new(@authenticated.get("/v1.0/me/mailFolders/#{folder_id}/messages"), @authenticated)
     end
 
     def raw_mail(mail_id)

data/lib/osa/scripts/scan_junk_folder.rb

@@ -18,8 +18,13 @@ while continue
       next if email_address.nil?
       domain = PublicSuffix.domain(email_address.split('@', 2)[1])
 
-      blacklisted = OSA::Blacklist.where(value: email_address).or(OSA::Blacklist.where(value: domain)).exists?
-      if blacklisted
+      flagged = mail['flag']['flagStatus'] == 'flagged'
+      blacklisted = nil
+      blacklisted = OSA::Blacklist.where(value: email_address).or(OSA::Blacklist.where(value: domain)).exists? unless flagged
+
+      if flagged
+        puts "Email from #{email_address} is flagged, reporting and deleting"
+      elsif blacklisted
         puts "#{email_address} is blacklisted, reporting and deleting"
       else
         puts "Skipping mail from #{email_address}, its not blacklisted"

data/lib/osa/services/setup_service.rb

@@ -18,10 +18,9 @@ module OSA
       }.to_h
       prompt = TTY::Prompt.new
       junk_folder_id = prompt.select('Select junk folder:', choices)
-      report_folder_id = prompt.select('Select report folder:', choices)
       spamcop_email = prompt.ask('Spamcop report email:') { |q| q.validate :email }
 
-      config.update! junk_folder_id: junk_folder_id, report_folder_id: report_folder_id, spamcop_report_email: spamcop_email
+      config.update! junk_folder_id: junk_folder_id, spamcop_report_email: spamcop_email
     end
   end
 end

data/lib/osa/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module OSA
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osa
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Moray Baruh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-28 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -110,7 +110,6 @@ files:
 - lib/osa/migrations/00003_create_config.rb
 - lib/osa/migrations/free-email-providers.txt
 - lib/osa/scripts/scan_junk_folder.rb
-- lib/osa/scripts/scan_report_folder.rb
 - lib/osa/services/auth_service.rb
 - lib/osa/services/setup_service.rb
 - lib/osa/util/constants.rb

data/lib/osa/scripts/scan_report_folder.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-require 'uri'
-require 'public_suffix'
-require 'osa/util/db'
-require 'osa/util/context'
-
-context = OSA::Context.new
-
-loop do
-  mails = context.graph_client.mails(context.config.report_folder_id)
-  break if mails['value'].empty?
-  mails['value'].each do |mail|
-    email_address = mail['sender']['emailAddress']['address']
-
-    puts "forwarding spam from #{email_address}"
-    context.graph_client.forward_mail_as_attachment(mail['id'], context.config.spamcop_report_email)
-    puts "deleting spam from #{email_address}"
-    context.graph_client.delete_mail(mail['id'])
-
-    next if email_address.nil?
-    domain = PublicSuffix.domain(email_address.split('@', 2)[1])
-
-    is_free_provider = OSA::EmailProvider.where(value: domain).exists?
-    if is_free_provider
-      puts "#{email_address} is using a free provider, blacklisting full address"
-      OSA::Blacklist.find_or_create_by(value: email_address).save!
-    else
-      puts "Adding #{domain} to blacklist"
-      OSA::Blacklist.find_or_create_by(value: domain).save!
-    end
-  end
-end