osa 0.1.0

data/Dockerfile

@@ -0,0 +1,5 @@
+FROM ruby:2.7.2
+
+ARG OSA_VERSION
+RUN gem install osa -v ${OSA_VERSION}
+ENTRYPOINT ["osa"]

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rubocop'
+gem 'rubocop-performance'

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    osa (0.1.0)
+      activerecord (~> 6.0)
+      faraday (~> 1.1)
+      public_suffix (~> 4.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)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    multipart-post (2.1.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)
+    rainbow (3.0.0)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rubocop (1.3.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.0)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.22.0)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.8.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)
+    unicode-display_width (1.7.0)
+    wisper (2.0.1)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  osa!
+  rubocop
+  rubocop-performance
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Moray Baruh
+
+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,79 @@
+# Outlook Spam Automator
+
+## Principle
+
+### 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.
+
+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.
+
+*OSA will not touch any folder beside these two.*
+
+*It's the user's responsibility to move junk mails to the report folder to build up the blacklist.*
+
+### The blacklist
+
+Blacklisting is performed using the main domain name of the sender, excluding subdomains. For example, an email sent from
+`spammer@spam.example.com`, will blacklist any sender from `example.com`, so `legit-person@not-spam.example.com` will also
+be blacklisted. However, to prevent millions of users to go blacklisted because of a single user's spam, OSA includes a
+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.
+
+## Installation
+
+You can install OSA from RubyGems:
+
+```sh
+gem install osa
+```
+
+Or use the Docker image:
+
+```sh
+docker pull moray95/osa:{version}
+```
+
+## Configuring the database
+
+OSA uses a simple sqlite database to store your configurations and blacklist. The database is configured by default at
+the current working directory. This means that after a first setup, if you run OSA from a different directory, you will
+start from a blank configuration and blacklist. If you need to run from different directories, you can specify the database
+file with the `DATABASE` environment variable.
+
+## Usage
+
+Setup your account and settings:
+
+The setup process will authenticate you with Outlook and ask you to select your folders. If you want to create
+a new folder, make sure you do it before you run the script.
+
+```sh
+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
+osa scan-junk
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/moray95/osa.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+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"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/osa

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+require 'osa/services/setup_service'
+require 'osa/services/auth_service'
+
+cmd = $ARGV.shift
+
+case cmd
+when 'setup'
+  OSA::SetupService.new.setup!
+when 'login'
+  OSA::AuthService.login(Config.first || 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]"
+  exit 1
+end

data/lib/osa.rb

@@ -0,0 +1 @@
+require "osa/version"

data/lib/osa/clients/http_client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module OSA
+  class HttpClient
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get(*args, **kwargs)
+      response = @connection.get(*args, **kwargs)
+      handle_response(response)
+    end
+
+    def post(*args, **kwargs)
+      response = @connection.post(*args, **kwargs)
+      handle_response(response)
+    end
+
+    def delete(*args, **kwargs)
+      response = @connection.delete(*args, **kwargs)
+      handle_response(response)
+    end
+
+    def patch(*args, **kwargs)
+      response = @connection.patch(*args, **kwargs)
+      handle_response(response)
+    end
+
+    private
+
+      def handle_response(response)
+        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')
+          JSON.parse(response.body)
+        else
+          response.body
+        end
+      end
+  end
+end

data/lib/osa/clients/ms_auth_client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'osa/clients/http_client'
+require 'faraday'
+require 'osa/util/constants'
+
+module OSA
+  class MSAuthClient < HttpClient
+    def initialize
+      connection = Faraday.new(
+        url: 'https://login.microsoft.com'
+      )
+      super connection
+    end
+
+    def code_token(code)
+      body = {
+        client_id: CLIENT_ID,
+        scope: SCOPE,
+        redirect_uri: REDIRECT_URL,
+        grant_type: :authorization_code,
+        code: code
+      }
+      post('/consumers/oauth2/v2.0/token', body, {})
+    end
+
+    def refresh_token(refresh_token)
+      body = {
+        client_id: CLIENT_ID,
+        scope: SCOPE,
+        refresh_token: refresh_token,
+        grant_type: :refresh_token
+      }
+      post('/consumers/oauth2/v2.0/token', body)
+    end
+  end
+end

data/lib/osa/clients/ms_graph_client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require 'faraday'
+require 'json'
+require 'base64'
+require 'osa/util/paginated'
+require 'osa/clients/http_client'
+
+module OSA
+  class MSGraphClient < HttpClient
+    def initialize(token)
+      connection = Faraday.new(
+        url: 'https://graph.microsoft.com',
+        headers: {
+          'authorization' => "Bearer #{token}"
+        }
+      )
+      super connection
+    end
+
+    def rules
+      get('/v1.0/me/mailFolders/inbox/messageRules')
+    end
+
+    def rule(id)
+      get("/v1.0/me/mailFolders/inbox/messageRules/#{id}")
+    end
+
+    def folders
+      Paginated.new(get('/v1.0/me/mailFolders'), self)
+    end
+
+    def mails(folder_id)
+      Paginated.new(get("/v1.0/me/mailFolders/#{folder_id}/messages"), self)
+    end
+
+    def raw_mail(mail_id)
+      get("/v1.0/me/messages/#{mail_id}/$value")
+    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 = {
+        toRecipients: [
+          {
+            emailAddress: {
+              address: to
+            }
+          }
+        ]
+      }
+      update_message(forward_message['id'], update)
+      send_message(forward_message['id'])
+    end
+
+    def create_forward_message(mail_id)
+      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')
+    end
+
+    def delete_mail(mail_id)
+      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')
+    end
+
+    def update_message(id, update)
+      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")
+    end
+  end
+end

data/lib/osa/migrations/00001_create_blacklists.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'active_record/migration'
+
+class CreateBlacklists < ActiveRecord::Migration[5.0]
+  def change
+    create_table :blacklists do |t|
+      t.text :value, unique: true
+    end
+  end
+end

data/lib/osa/migrations/00002_create_email_providers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'active_record/migration'
+
+class CreateEmailProviders < ActiveRecord::Migration[5.0]
+  def change
+    create_table :email_providers do |t|
+      t.text :value, unique: true
+    end
+
+    reversible do |dir|
+      file = "#{File.dirname(__FILE__)}/free-email-providers.txt"
+      dir.up do
+        File.open(file).each do |provider|
+          execute "insert into email_providers (value) values (\"#{provider.strip}\")"
+        end
+      end
+      dir.down do
+      end
+    end
+  end
+end