osa 0.1.0

data/lib/osa/scripts/scan_junk_folder.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'osa/util/constants'
+require 'public_suffix'
+require 'osa/util/db'
+require 'osa/util/context'
+
+context = OSA::Context.new
+
+continue = true
+
+while continue
+  mails = context.graph_client.mails(context.config.junk_folder_id)
+  continue = false
+  loop do
+    break if mails.nil?
+    mails['value'].each do |mail|
+      email_address = mail['sender']['emailAddress']['address']
+      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
+        puts "#{email_address} is blacklisted, reporting and deleting"
+      else
+        puts "Skipping mail from #{email_address}, its not blacklisted"
+        next
+      end
+
+      continue = true
+
+      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'])
+    end
+    mails = mails.next
+  end
+end

data/lib/osa/scripts/scan_report_folder.rb

@@ -0,0 +1,33 @@
+# 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

data/lib/osa/services/auth_service.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require 'osa/util/db'
+require 'uri'
+require 'tty-prompt'
+
+module OSA
+  class AuthService
+    def initialize(client)
+      @client = client
+    end
+
+    def refresh_token(config)
+      token = @client.refresh_token(config.refresh_token)
+      config.update!(refresh_token: token['refresh_token'])
+      token
+    end
+
+    def code_token(code, config)
+      token = @client.code_token(code)
+      config.update!(refresh_token: token['refresh_token'])
+      token
+    end
+
+    def self.login(config)
+      query = {
+        client_id: CLIENT_ID,
+        response_type: 'code',
+        redirect_uri: REDIRECT_URL,
+        response_mode: 'query',
+        scope: SCOPE,
+        state: ''
+      }
+
+      query_str = query.reduce('?') do |acc, val|
+        key, value = val
+        acc + "#{key}=#{URI.encode_www_form_component(value)}&"
+      end
+
+      base_uri = 'https://login.microsoftonline.com/consumers/oauth2/v2.0/authorize'
+
+      uri = "#{base_uri}#{query_str}"
+      puts "Open the following url in your browser and enter the authentication code displayed."
+      puts uri
+
+      prompt = TTY::Prompt.new
+      code = prompt.ask('Code:')
+
+      auth_client = MSAuthClient.new
+      auth_service = AuthService.new(auth_client)
+
+      auth_service.code_token(code, config)
+
+      puts 'login completed'
+    end
+  end
+end

data/lib/osa/services/setup_service.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+require 'osa/util/db'
+require 'osa/services/auth_service'
+require 'tty-prompt'
+require 'osa/util/context'
+
+module OSA
+  class SetupService
+    def setup!
+      Config.delete_all
+      config = Config.new
+      AuthService.login(config)
+
+      context = Context.new(config)
+      folders = context.graph_client.folders.all
+      choices = folders.map { |folder|
+        [folder['displayName'], folder['id']]
+      }.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
+    end
+  end
+end

data/lib/osa/util/constants.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OSA
+  CLIENT_ID = 'befa4a9e-5d16-4a48-9792-4bd1d125abe8'
+  REDIRECT_URL = 'https://storage.googleapis.com/outlook-spam-automator/login.html'
+  SCOPE = 'https://graph.microsoft.com/MailboxSettings.ReadWrite https://graph.microsoft.com/MailboxSettings.ReadWrite offline_access'
+end

data/lib/osa/util/context.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'osa/clients/ms_auth_client'
+require 'osa/services/auth_service'
+require 'osa/clients/ms_graph_client'
+
+module OSA
+  class Context
+    attr_reader :graph_client
+    attr_reader :auth_service
+    attr_reader :config
+
+    def initialize(config=nil)
+      @config = config || Config.first
+
+      if @config.nil?
+        $stderr.puts 'OSA not configured'
+        exit 1
+      end
+
+      auth_client = MSAuthClient.new
+      @auth_service = AuthService.new(auth_client)
+      token = auth_service.refresh_token(@config)
+
+      @graph_client = MSGraphClient.new(token['access_token'])
+    end
+  end
+end

data/lib/osa/util/db.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: ENV['DATABASE'] || "#{Dir.pwd}/osa.db"
+)
+root = "#{File.dirname(__FILE__ )}/../"
+ActiveRecord::MigrationContext.new("#{root}/migrations", ActiveRecord::SchemaMigration).migrate
+
+
+module OSA
+  class Blacklist < ActiveRecord::Base
+  end
+
+  class Config < ActiveRecord::Base
+    self.table_name = 'config'
+  end
+
+  class EmailProvider < ActiveRecord::Base
+  end
+end

data/lib/osa/util/paginated.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module OSA
+  class Paginated
+    def initialize(value, client)
+      @value = value
+      @client = client
+    end
+
+    def next
+      next_page = @value['@odata.nextLink']
+      return nil if next_page.nil?
+      Paginated.new(@client.get(next_page), @client)
+    end
+
+    def all
+      value = @value['value'].dup
+      next_page = self.next
+      until next_page.nil?
+        value += next_page['value']
+        next_page = next_page.next
+      end
+      value
+    end
+
+    private
+      def method_missing(symbol, *args)
+        @value.send(symbol, *args)
+      end
+  end
+end

data/lib/osa/version.rb

@@ -0,0 +1,3 @@
+module OSA
+  VERSION = "0.1.0"
+end

data/osa.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/osa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'osa'
+  spec.version       = OSA::VERSION
+  spec.authors       = ['Moray Baruh']
+  spec.email         = ['contact@moraybaruh.com']
+
+  spec.summary       = 'Outlook Spam Automator'
+  spec.description   = 'Get rid of spam on your Outlook account'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '~> 6.0'
+  spec.add_dependency 'faraday', '~> 1.1'
+  spec.add_dependency 'public_suffix', '~> 4.0'
+  spec.add_dependency 'sqlite3', '~> 1.4'
+  spec.add_dependency 'tty-prompt', '~> 0.22'
+end

data/release.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+set -eu
+
+VERSION=$(bundle exec ruby -e 'puts OSA::VERSION')
+echo -n "Releasing ${VERSION}. Continue? (Y/n) "
+read -r CONTINUE
+
+if [ "$CONTINUE" != "y" ] && [ "$CONTINUE" != "Y" ]
+then
+  echo "Aborting release." >&2
+  exit 1
+fi
+
+rake release
+echo "Waiting for gem to be available..."
+while ! (gem info -r osa --all | grep "${VERSION}")
+do
+  sleep 5
+done
+
+docker build . --build-arg "OSA_VERSION=${VERSION}" -t "moray95/osa:${VERSION}"
+docker push "moray95/osa:${VERSION}"

data/web/login.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Outlook Spam Automator Login</title>
+</head>
+<body>
+<div id="code"></div>
+</body>
+</html>
+<script>
+    const urlParams = new URLSearchParams(location.search);
+    document.getElementById("code").innerText = "code: " + urlParams.get('code');
+</script>

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: osa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Moray Baruh
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Get rid of spam on your Outlook account
+email:
+- contact@moraybaruh.com
+executables:
+- osa
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".gitignore"
+- ".rubocop.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/osa
+- lib/osa.rb
+- lib/osa/clients/http_client.rb
+- lib/osa/clients/ms_auth_client.rb
+- lib/osa/clients/ms_graph_client.rb
+- lib/osa/migrations/00001_create_blacklists.rb
+- lib/osa/migrations/00002_create_email_providers.rb
+- 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
+- lib/osa/util/context.rb
+- lib/osa/util/db.rb
+- lib/osa/util/paginated.rb
+- lib/osa/version.rb
+- osa.gemspec
+- release.sh
+- web/login.html
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Outlook Spam Automator
+test_files: []