osa 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ad6f3864c9196aff9026ad350f71c7904c27817dbd0217bf6008885830ac15
-  data.tar.gz: fe44a6e9d98590eb231c04c794327ca1132feaf9d13d556563fe900ec5bce190
+  metadata.gz: 1008becc098b639309f218c9f763e57d4d01f201b28fd105c478cd46534de913
+  data.tar.gz: 2c285065f454aeaa7fcc1f9dd6f72e92d3423dbe292d06ef36afba6a8db6f9eb
 SHA512:
-  metadata.gz: c9dfa0f4cf44acf3ca08654f670cdca47a7a9ae7c681dfea0b9b9ddb6acf064a9b88c98dd325e449e9efa23647fc663cb407a4ec19a1fdd4e86df1a556fe467e
-  data.tar.gz: 1f32dbf2f0cbf9373788100ca8f99579be14732cf86c91ce45c443d9ae67476d762eae81b7b9d3b5243b97011dd066df713f72dd8002ab53d32d9e27f145999f
+  metadata.gz: 4b53ba423fc0b0da3bc8f49188d34370cf49d12e968a13a436ffaa6c849dceddedcf10c7e2b833d7316dbc0045fe487c44891b6eb50b98fb63477f63b8542a0e
+  data.tar.gz: ba063539fe384116422310df5a0d3a14c324a0560674932dd39998951d433236fb929a86aae981895adff04a29d71d0780c8fc4a2a9d11fa817359ad56c10ff0

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
   DisabledByDefault: true
   Exclude:
     - '**/vendor/**/*'
+    - 'bin/**'
 
 Bundler/DuplicatedGem:
   Enabled: true

data/Gemfile

@@ -1,4 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+source 'https://rubygems.org'
 
 gemspec
 

data/Gemfile.lock

@@ -1,42 +1,56 @@
 PATH
   remote: .
   specs:
-    osa (0.1.0)
+    osa (0.2.1)
       activerecord (~> 6.0)
       faraday (~> 1.1)
+      mail (~> 2.7.1)
       public_suffix (~> 4.0)
+      sinatra (~> 2.1.0)
+      sinatra-contrib (~> 2.1.0)
       sqlite3 (~> 1.4)
       tty-prompt (~> 0.22)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activerecord (6.0.3.4)
-      activemodel (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-    activesupport (6.0.3.4)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.1)
-    concurrent-ruby (1.1.7)
-    faraday (1.1.0)
+    concurrent-ruby (1.1.8)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
-    i18n (1.8.5)
+    faraday-net_http (1.0.1)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.2)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.2)
+    minitest (5.14.3)
+    multi_json (1.15.0)
     multipart-post (2.1.1)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
     parallel (1.20.0)
     parser (2.7.2.0)
       ast (~> 2.4.1)
     pastel (0.8.0)
       tty-color (~> 0.5)
     public_suffix (4.0.6)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
     rainbow (3.0.0)
     regexp_parser (1.8.2)
     rexml (3.2.4)
@@ -55,24 +69,35 @@ GEM
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
+    ruby2_keywords (0.0.4)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    sinatra-contrib (2.1.0)
+      multi_json
+      mustermann (~> 1.0)
+      rack-protection (= 2.1.0)
+      sinatra (= 2.1.0)
+      tilt (~> 2.0)
     sqlite3 (1.4.2)
-    thread_safe (0.3.6)
+    tilt (2.0.10)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
-    tty-prompt (0.22.0)
+    tty-prompt (0.23.0)
       pastel (~> 0.8)
       tty-reader (~> 0.8)
-    tty-reader (0.8.0)
+    tty-reader (0.9.0)
       tty-cursor (~> 0.7)
       tty-screen (~> 0.8)
       wisper (~> 2.0)
     tty-screen (0.8.1)
-    tzinfo (1.2.8)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     wisper (2.0.1)
-    zeitwerk (2.4.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -83,4 +108,4 @@ DEPENDENCIES
   rubocop-performance
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

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
 
@@ -24,6 +25,13 @@ be blacklisted. However, to prevent millions of users to go blacklisted because
 list of free email providers (which includes domains like gmail.com, outlook.com among others). If the sender uses a free
 email provider, the full address is blacklisted.
 
+OSA also supports Domain Name System Blacklist. In fact it comes bundled with 3 DNSBL:
+1. [Spamcop Blocking List](https://www.spamcop.net/fom-serve/cache/297.html)
+2. [Spamhaus Block List](https://www.spamhaus.org/sbl)
+3. [Passive Spam Block List](https://psbl.org)
+
+You can remove these or add more blacklists, from the database, after you configure OSA.
+
 ## Installation
 
 You can install OSA from RubyGems:
@@ -58,18 +66,21 @@ osa setup
 
 Each time you run this command, your previous configuration will be erased, except for your blacklist.
 
-Process your report folder:
+Process your junk folder:
 
 ```sh
-osa scan-report
+osa scan-junk
 ```
 
-Process your junk folder:
+OSA also provides you a nice administration dashboard you. You can access the dashboard by running
 
 ```sh
-osa scan-junk
+osa dashboard
 ```
 
+You are now able to access the dashboard on `http://localhost:8080`. You can also change the port of the server by
+providing the `SERVER_PORT` environment variable.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/moray95/osa.

data/Rakefile

@@ -1,10 +1,11 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
-
-require "bundler/setup"
-require "osa"
+require 'bundler/setup'
+require 'osa'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +9,5 @@ require "osa"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/osa

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+#
+# This file was generated by Bundler.
+#
+# The application 'osa' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('../bundle', __FILE__)
+
+if File.file?(bundle_binstub)
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('osa', 'osa')

data/exe/osa

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 require 'osa/services/setup_service'
 require 'osa/services/auth_service'
 
@@ -8,12 +9,13 @@ case cmd
 when 'setup'
   OSA::SetupService.new.setup!
 when 'login'
-  OSA::AuthService.login(Config.first || Config.new)
+  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'
+when 'dashboard'
+  require 'osa/scripts/dashboard_server'
+  DashboardServer.start!
 else
-  $stderr.puts "Usage: #{File.basename($0)} [setup|login|scan-junk|scan-report]"
+  $stderr.puts "Usage: #{File.basename($0)} [setup|login|scan-junk|dashboard]"
   exit 1
 end

data/lib/osa.rb

@@ -1 +1,2 @@
-require "osa/version"
+# frozen_string_literal: true
+require 'osa/version'

data/lib/osa/clients/http_client.rb

@@ -15,6 +15,11 @@ module OSA
       handle_response(response)
     end
 
+    def put(*args, **kwargs)
+      response = @connection.put(*args, **kwargs)
+      handle_response(response)
+    end
+
     def delete(*args, **kwargs)
       response = @connection.delete(*args, **kwargs)
       handle_response(response)
@@ -31,7 +36,7 @@ module OSA
         if response.status > 299
           raise StandardError, "Request failed with status code: #{response.status}, body: #{response.body}"
         end
-        if response.headers['content-type'].include?('application/json')
+        if response.headers['content-type']&.include?('application/json')
           JSON.parse(response.body)
         else
           response.body

data/lib/osa/clients/ms_graph_client.rb

@@ -4,44 +4,60 @@ require 'json'
 require 'base64'
 require 'osa/util/paginated'
 require 'osa/clients/http_client'
+require 'active_support/core_ext/numeric/bytes'
+require 'active_support'
+require 'mail'
 
 module OSA
-  class MSGraphClient < HttpClient
+  class MSGraphClient
+    URL = 'https://graph.microsoft.com'
+
     def initialize(token)
-      connection = Faraday.new(
+      @authenticated = HttpClient.new(Faraday.new(
         url: 'https://graph.microsoft.com',
         headers: {
           'authorization' => "Bearer #{token}"
         }
-      )
-      super connection
+      ))
+
+      @unauthenticated = HttpClient.new(Faraday.new(
+        url: 'https://graph.microsoft.com'
+      ))
     end
 
     def rules
-      get('/v1.0/me/mailFolders/inbox/messageRules')
+      @authenticated.get('/v1.0/me/mailFolders/inbox/messageRules')
     end
 
     def rule(id)
-      get("/v1.0/me/mailFolders/inbox/messageRules/#{id}")
+      @authenticated.get("/v1.0/me/mailFolders/inbox/messageRules/#{id}")
     end
 
     def folders
-      Paginated.new(get('/v1.0/me/mailFolders'), self)
+      Paginated.new(@authenticated.get('/v1.0/me/mailFolders'), @authenticated)
     end
 
     def mails(folder_id)
-      Paginated.new(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)
-      get("/v1.0/me/messages/#{mail_id}/$value")
+      @authenticated.get("/v1.0/me/messages/#{mail_id}/$value")
+    end
+
+    def sender_ip(mail_id)
+      content = raw_mail(mail_id)
+      mail = Mail.new(content)
+      mail.header['x-sender-ip']
     end
 
     def forward_mail_as_attachment(mail_id, to)
       raw_mail = self.raw_mail(mail_id)
       forward_message = create_forward_message(mail_id)
-      add_email_attachment(forward_message['id'], raw_mail)
       update = {
+        body: {
+          content: ''
+        },
         toRecipients: [
           {
             emailAddress: {
@@ -51,36 +67,68 @@ module OSA
         ]
       }
       update_message(forward_message['id'], update)
+      add_email_attachment(forward_message['id'], 'email.eml', raw_mail)
       send_message(forward_message['id'])
     end
 
     def create_forward_message(mail_id)
-      post("/v1.0/me/messages/#{mail_id}/createForward")
+      @authenticated.post("/v1.0/me/messages/#{mail_id}/createForward")
     end
 
-    def add_email_attachment(mail_id, content)
-      body = {
-        "@odata.type": '#microsoft.graph.fileAttachment',
-        "contentBytes": Base64.encode64(content),
-        "name": 'email.eml'
-      }
-      post("/v1.0/me/messages/#{mail_id}/attachments", body.to_json, 'content-type': 'application/json')
+    def add_email_attachment(mail_id, name, content)
+      if content.length < 3.megabytes
+        add_small_email_attachment(mail_id, name, content)
+      else
+        add_large_email_attachment(mail_id, name, content)
+      end
     end
 
     def delete_mail(mail_id)
-      delete("/v1.0/me/messages/#{mail_id}")
+      @authenticated.delete("/v1.0/me/messages/#{mail_id}")
     end
 
     def update_rule(id, update)
-      patch("/v1.0/me/mailFolders/inbox/messageRules/#{id}", update.to_json, 'content-type' => 'application/json')
+      @authenticated.patch("/v1.0/me/mailFolders/inbox/messageRules/#{id}", update.to_json, 'content-type' => 'application/json')
     end
 
     def update_message(id, update)
-      patch("/v1.0/me/messages/#{id}", update.to_json, 'content-type': 'application/json')
+      @authenticated.patch("/v1.0/me/messages/#{id}", update.to_json, 'content-type': 'application/json')
     end
 
     def send_message(id)
-      post("/v1.0/me/messages/#{id}/send")
+      @authenticated.post("/v1.0/me/messages/#{id}/send")
     end
+
+    private
+      def add_small_email_attachment(mail_id, name, content)
+        body = {
+          "@odata.type": '#microsoft.graph.fileAttachment',
+          contentBytes: Base64.encode64(content),
+          name: name
+        }
+        @authenticated.post("/v1.0/me/messages/#{mail_id}/attachments", body.to_json, 'content-type': 'application/json')
+      end
+
+      def add_large_email_attachment(mail_id, name, content)
+        upload_session = create_upload_session(mail_id, name, content.length)
+        ranges = upload_session['nextExpectedRanges'].map do |range|
+          range.split('-').then { |start, finish| (start.to_i..finish&.to_i) }
+        end
+        ranges.each do |range|
+          current_content = content[range]
+          @unauthenticated.put(upload_session['uploadUrl'], current_content[range], 'Content-Range': "bytes #{range.begin}-#{(range.end || content.length) - 1}/#{content.length}")
+        end
+      end
+
+      def create_upload_session(mail_id, name, size)
+        body = {
+          AttachmentItem: {
+            attachmentType: :file,
+            name: name,
+            size: size
+          }
+        }
+        @authenticated.post("/v1.0/me/messages/#{mail_id}/attachments/createUploadSession", body.to_json, 'content-type': 'application/json')
+      end
   end
 end