fuck_facebook 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd816f264c73ea38c4349c8110cade9787ae11f92de9b37ad8a1f6fbef9b2059
-  data.tar.gz: e2862a3aee723788f459ab7b84acf84ca2b3bda8ef6176e51a1018915cb350d7
+  metadata.gz: 4444d134e1ae1d10b948ae6432691f99c1c22498aea2f0530359b0c93a1df967
+  data.tar.gz: b276c6b4a680c546b2b34366b5e28cd1af620ef7800ae7f2964bbded6235eff8
 SHA512:
-  metadata.gz: aa5dfc850834b1ab4efd759eb853ac2bdc25c6a9cb739ee704b2e2182fc917fc43b85c504c75ad7394074f0549abd8e372906911a68da64ea0a4c78766d0d39b
-  data.tar.gz: 8ebea4e69e013d5c2f7f7345755c5ed39768bdbcd231587ae06c64e196e718d2f57293ea9714c84cf61008bc104d05c1dfd90df7548c8eade979d76a5391f129
+  metadata.gz: 2e9a2254136c1886d20e7f164bbf1cf9d06d1a6191ed7522df717db580b6eea1b48f9ab5c9caebb9b84c75bc24f8467e0c92b30d5bae5f1131a99b7a6bb93b94
+  data.tar.gz: 5b930019d90be80fb751a487c2b71b0021278dc1952fd2a61baac57b7e88a4bcfc33be612699193bd6caeeb1c43a5fb0b7a231fce555d41c32e6d69a6cb93185

data/.gitignore

@@ -11,3 +11,5 @@
 .rspec_status
 
 *.gem
+
+fuck_facebook_error*.png

data/.ruby-version

@@ -1 +1 @@
-3.0.1
+3.0.2

data/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Developer Guide
+
+## Pushing a new version of the gem
+
+**Note:** You must have been granted access to deploy new versions of the `fuck_facebook` gem
+
+* Bump the version in `lib/fuck_facebook/version.rb`
+* Build the gem with `gem build fuck_facebook.gemspec`
+* Push the gem with `gem push fuck_facebook-VERSION.gem` replacing `VERSION` with the new version number
+
+## Pushing a new version of the Docker image
+
+**Note:** You must have been granted access to deploy new versions of the `fuck_facebook` Docker image
+
+* Build the image:
+
+```
+docker build . -t keeyan/fuck_facebook:VERSION --build-arg version=VERSION
+```
+
+Replace `VERSION` with the version number
+
+* Push the image with `docker push keeyan/fuck_facebook:VERSION` replacing `VERSION` with the version number

data/Dockerfile

@@ -0,0 +1,15 @@
+FROM ruby:3.0.2-bullseye
+
+RUN apt-get update && apt-get install -y chromium-driver
+
+RUN useradd --create-home --shell /bin/bash fuckfacebook
+
+USER fuckfacebook
+WORKDIR /home/fuckfacebook
+
+RUN mkdir -p /home/fuckfacebook/.local/share/fuck-facebook
+VOLUME /home/fuckfacebook/.local/share/fuck-facebook
+
+ARG version
+COPY fuck_facebook-$version.gem .
+RUN gem install fuck_facebook-$version.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fuck_facebook (0.1.2)
+    fuck_facebook (0.4.1)
       activesupport (~> 6.1)
       highline (~> 2.0)
       mail (~> 2.7)
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
+    activesupport (6.1.4.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -21,13 +21,13 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
     highline (2.0.3)
-    i18n (1.8.10)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     method_source (1.0.0)
-    mini_mime (1.1.0)
-    minitest (5.14.4)
+    mini_mime (1.1.2)
+    minitest (5.15.0)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
@@ -56,7 +56,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -67,4 +67,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   2.2.15
+   2.2.22

data/README.md

@@ -1,3 +1,51 @@
 # Fuck Facebook
 
 A collection of tools to help you use Facebook when you don't want to
+
+## Usage
+
+Run `fuck-facebook --help` to get a list of options and explanations.
+
+To get all unread messages (that haven't already been reported) run these commands:
+
+```
+fuck-facebook --login
+```
+
+You only need to login once
+
+```
+fuck-facebook --unread-messages
+```
+
+This will only show you unread messages that have been received since the last time you checked.
+This way if you have emails going out for new messages, you won't get notified for the same message each time.
+
+## Config
+
+Here's a complete config file along with an explanation of each option:
+
+```yaml
+errors:
+  min_minutes_between_reports: 0 # Only report error if one has not occured in the past X minutes
+  include_screenshot: false # Generates a screenshot with the error report
+smtp:
+  from_email: sender@example.com
+  to_email: receiver@example.com
+  address: smtp.example.com
+  port: 587
+  user_name: some_user_name
+  password: 123456
+  authentication: plain
+```
+
+Place this file in `~/.local/share/fuck-facebook/config.yaml`
+
+These options can be passed as environment variables, by:
+* Joining the keys with `_`
+* Capitalizing the entire string
+* Prefixing the key with `FF_`
+
+For example the `smtp` `from_email` will become `FF_SMTP_FROM_EMAIL`
+
+Environment variables take precedent over the config file.

data/bin/fuck-facebook

@@ -7,59 +7,23 @@ require_relative '../src/facebook_connection'
 require_relative '../src/config'
 require_relative '../src/initializers/mail_initializer'
 require_relative '../src/senders'
-
-options = {
-  headless: true,
-  clear_cookies: false,
-  unread_messages: false,
-  messages: false,
-  sender: 'stdout'
-}
-
-OptionParser.new do |opts|
-  opts.banner = 'Usage: fuck-facebook.rb [options]'
-
-  opts.on('-h', '--[no-]headless', 'Run in a headless browser') do |v|
-    options[:headless] = v
-  end
-
-  opts.on('--clear-cookies') do |v|
-    options[:clear_cookies] = v
-  end
-
-  opts.on('--unread-messages') do |v|
-    options[:unread_messages] = v
-  end
-
-  opts.on('--messages') do |v|
-    options[:messages] = v
-  end
-
-  opts.on('--login') do |v|
-    options[:login] = v
-  end
-
-  opts.on('--sender=SENDER') do |sender|
-    options[:sender] = sender
-  end
-end.parse!
-
-facebook_connection = FacebookConnection.new(headless: options[:headless])
-
-facebook_connection.cookie_handler.clear! if options[:clear_cookies]
-
-facebook_connection.login if options[:login]
-
-messages =
-  if options[:unread_messages]
-    facebook_connection.message_handler.unread
-  elsif options[:messages]
-    facebook_connection.message_handler.messages
-  else
-    []
-  end
-
-sender = Senders.by_name(options[:sender])
-sender.send_messages(messages)
-
-facebook_connection.close
+require_relative '../src/args_parser'
+require_relative '../src/message_sender'
+require_relative '../src/error_reporter'
+
+options = ArgsParser.parse_args
+facebook_connection = nil
+
+begin
+  facebook_connection = FacebookConnection.new(headless: options[:headless])
+  raise 'Error triggered by --simulate-error flag' if options[:simulate_error]
+
+  facebook_connection.cookie_handler.clear! if options[:clear_cookies]
+  facebook_connection.login if options[:login]
+  message_sender = MessageSender.new(options[:sender], facebook_connection)
+  message_sender.send_unread_messages if options[:unread_messages]
+  message_sender.send_messages if options[:messages]
+  facebook_connection.close
+rescue StandardError => e
+  ErrorReporter.report_error(options[:sender], e, facebook_connection: facebook_connection)
+end

data/lib/fuck_facebook/version.rb

@@ -1,3 +1,3 @@
 module FuckFacebook
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/src/args_parser.rb

@@ -0,0 +1,82 @@
+class ArgsParser
+  DEFAULT_OPTIONS = {
+    headless: true,
+    clear_cookies: false,
+    unread_messages: false,
+    messages: false,
+    sender: 'stdout',
+    simulate_error: false
+  }.freeze
+
+  AVAILABLE_OPTIONS = [
+    {
+      short: '-h',
+      long: '--[no-]headless',
+      message: 'Run in a headless browser',
+      option: :headless
+    },
+    {
+      short: nil,
+      long: '--clear-cookies',
+      message: 'Clears all cookies',
+      option: :clear_cookies
+    },
+    {
+      short: nil,
+      long: '--unread-messages',
+      message: 'Outputs all unread messages sent since the last check',
+      option: :unread_messages
+    },
+    {
+      short: nil,
+      long: '--messages',
+      message: 'Outputs all messages sent since the last check',
+      option: :messages
+    },
+    {
+      short: nil,
+      long: '--login',
+      message: 'Prompts for details to login to Facebook account',
+      option: :login
+    },
+    {
+      short: nil,
+      long: '--sender=SENDER',
+      message: 'Send results to either stdout or email',
+      option: :sender
+    },
+    {
+      short: nil,
+      long: '--simulate-error',
+      message: 'Simulates an error so you can see how it will be outputted',
+      option: :simulate_error
+    }
+  ].freeze
+
+  def self.parse_args
+    passed_options = DEFAULT_OPTIONS.dup
+
+    OptionParser.new do |opts|
+      generate_banner(opts)
+
+      AVAILABLE_OPTIONS.each do |available_option|
+        parser_for_available_option(opts, available_option, passed_options)
+      end
+    end.parse!
+
+    passed_options
+  end
+
+  private_class_method def self.generate_banner(opts)
+    opts.banner = 'Usage: fuck-facebook.rb [options]'
+  end
+
+  private_class_method def self.parser_for_available_option(opts, available_option, passed_options)
+    args = [available_option[:long], available_option[:message]]
+    args = [available_option[:short]] + args if available_option[:short]
+
+    opts.on(*args) do |v|
+      passed_options[available_option[:option]] = v
+    end
+  end
+end

data/src/config.rb

@@ -3,12 +3,17 @@ require 'yaml'
 class Config
   CONFIG_FILE_PATH = "#{ENV['HOME']}/.local/share/fuck-facebook/config.yaml".freeze
 
-  def self.option(*path)
+  def self.option(*path, default: nil)
+    env_var = "FF_#{path.join('_').upcase}"
+    return ENV[env_var] if ENV[env_var]
+
     path_strings = path.map(&:to_s)
-    config.dig(*path_strings)
-  end
+    value = config.dig(*path_strings)
 
-  private
+    return value if value
+
+    default
+  end
 
   def self.config
     create_config_file_if_not_exists!
@@ -16,7 +21,7 @@ class Config
     YAML.load_file(CONFIG_FILE_PATH)
   end
 
-  def self.create_config_file_if_not_exists!
+  private_class_method def self.create_config_file_if_not_exists!
     dirname = File.dirname(CONFIG_FILE_PATH)
     FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
     File.write(CONFIG_FILE_PATH, '{}') unless File.exist?(CONFIG_FILE_PATH)

data/src/error_reporter.rb

@@ -0,0 +1,32 @@
+class ErrorReporter
+  def self.report_error(sender_name, error, facebook_connection: nil)
+    raise error unless report_error?
+
+    Storage.set(:last_error_reported_time, Time.now)
+
+    screenshot = include_screenshot?(facebook_connection) ? create_screenshot(facebook_connection) : nil
+
+    Senders.by_name(sender_name).send_error(error, screenshot: screenshot)
+    raise error
+  end
+
+  private_class_method def self.include_screenshot?(facebook_connection)
+    Config.option(:errors, :include_screenshot) && facebook_connection.present?
+  end
+
+  private_class_method def self.create_screenshot(facebook_connection)
+    facebook_connection.driver.screenshot_as(:png)
+  rescue StandardError
+    nil
+  end
+
+  private_class_method def self.report_error?
+    min_minutes_between_reports = Config.option(:errors, :min_minutes_between_reports, default: 0)
+
+    last_error_reported_time = Storage.get(:last_error_reported_time, default: Time.new(2000))
+
+    next_report_time = last_error_reported_time + min_minutes_between_reports.minutes
+
+    Time.now > next_report_time
+  end
+end

data/src/facebook_connection.rb

@@ -31,6 +31,8 @@ class FacebookConnection
 
     options = Selenium::WebDriver::Chrome::Options.new
     options.add_argument('--disable-notifications')
+    options.add_argument('--no-sandbox')
+    options.add_argument('--disable-dev-shm-usage')
     options.add_argument('--headless') if headless
     options.add_option('detach', true) unless headless
 

data/src/message_handler.rb

@@ -53,13 +53,12 @@ class MessageHandler
   end
 
   def messages_after_last_message_time(messages)
-    last_message_time = Storage.get(:last_message_time, default: Time.new(2004, 2, 4))
+    last_message_check_time = Storage.get(:last_message_check_time, default: Time.new(2004, 2, 4))
+    last_check_time_with_buffer = last_message_check_time - 5.minutes
 
-    messages_to_return = messages.select { _1.timestamp > last_message_time }
+    messages_to_return = messages.select { _1.timestamp > last_check_time_with_buffer }
 
-    last_message_time = messages.map(&:timestamp).max
-
-    Storage.set(:last_message_time, last_message_time)
+    Storage.set(:last_message_check_time, Time.now)
 
     messages_to_return
   end

data/src/message_sender.rb

@@ -0,0 +1,25 @@
+class MessageSender
+  attr_accessor :sender_name, :facebook_connection
+
+  def initialize(sender_name, facebook_connection)
+    @sender_name = sender_name
+    @facebook_connection = facebook_connection
+  end
+
+  def send_unread_messages
+    messages = facebook_connection.message_handler.unread
+    send_array_of_messages(messages)
+  end
+
+  def send_messages
+    messages = facebook_connection.message_handler.messages
+    send_array_of_messages(messages)
+  end
+
+  private
+
+  def send_array_of_messages(messages)
+    sender = Senders.by_name(sender_name)
+    sender.send_messages(messages)
+  end
+end

data/src/senders/email.rb

@@ -10,5 +10,15 @@ module Senders
         end
       end
     end
+
+    def self.send_error(error, screenshot: nil)
+      Mail.deliver do
+        from Config.option(:smtp, :from_email)
+        to Config.option(:smtp, :to_email)
+        subject 'Error occurred during Fuck Facebook command'
+        body error.full_message(highlight: false)
+        add_file filename: 'error_screenshot.png', content: screenshot if screenshot
+      end
+    end
   end
 end

data/src/senders/stdout.rb

@@ -5,5 +5,14 @@ module Senders
         puts message
       end
     end
+
+    def self.send_error(error, screenshot: nil)
+      puts error
+      return if screenshot.nil?
+
+      filename = "fuck_facebook_error_#{Time.now.iso8601}.png"
+      File.write(filename, screenshot)
+      puts "Screenshot of error page saved as #{filename}"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fuck_facebook
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Keeyan Nejad
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-13 00:00:00.000000000 Z
+date: 2021-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -81,6 +81,8 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
+- CONTRIBUTING.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -92,13 +94,16 @@ files:
 - fuck_facebook.gemspec
 - lib/fuck_facebook.rb
 - lib/fuck_facebook/version.rb
+- src/args_parser.rb
 - src/authenticator.rb
 - src/config.rb
 - src/cookie_handler.rb
+- src/error_reporter.rb
 - src/facebook_connection.rb
 - src/fb_duration.rb
 - src/initializers/mail_initializer.rb
 - src/message_handler.rb
+- src/message_sender.rb
 - src/models/message.rb
 - src/models/message_thread.rb
 - src/models/user.rb
@@ -135,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A collection of tools to help you use Facebook when you don't want to