fuck_facebook 0.3.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f15615d0c24e530547c2a40e4509d434bc25578dde17737a5b8d8ef5fe2e68f
-  data.tar.gz: e3c8a9d379b9df92d0d986bfb1dba35846779d32d4cf1bbf16ae39d1f778fae4
+  metadata.gz: 26fe62245cbbcf826c49ee9f89fa3d889ebbb27a662c6076777a17ab181b8715
+  data.tar.gz: 59ddf6a1f3450188862019d37e7e75cab558c4948b3be3a1e08997318a108505
 SHA512:
-  metadata.gz: cffa79b7c7b58717a8507ba129668db846b40e6682621527b7799665d4fa74a5032a27ef471da20659ee01cd57662e82d85f76aff5b01e43a547d638e0c70374
-  data.tar.gz: 4acc110f1bb5e7115b28a429594a5fc8459f402fcffe88391a7189687791d677e857117049227d656d977c00b5daac88b4bded2780b1044b81fdce8cc603f0e6
+  metadata.gz: b51a6b441c836d9073bbb7312238beee8f902e48b16a87d4e84723db31f661e31a2adb180792e8c0c51020373b43ed67b6afbc4736bd522391a5cbe1cf8890f3
+  data.tar.gz: 7d11525734de217266e14b3b49adb8b177adfe8b9d50a20bcb19aea3929029c701fc9bac9188a1a5b223f828fb4a4a57e642b45de074b10abd5b5c01ddb9ea85

data/.gitignore

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fuck_facebook (0.2.1)
+    fuck_facebook (0.5.1)
       activesupport (~> 6.1)
       highline (~> 2.0)
       mail (~> 2.7)

data/README.md

@@ -26,6 +26,9 @@ This way if you have emails going out for new messages, you won't get notified f
 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
@@ -36,6 +39,8 @@ smtp:
   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

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.3.0'.freeze
+  VERSION = '0.5.1'.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,15 +3,16 @@ 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, type: 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
 
-  private
+    value = config.dig(*path_strings)
+    value = ENV[env_var] if ENV[env_var]
+    value = default if value.nil?
+
+    cast_value_to_type(value, type)
+  end
 
   def self.config
     create_config_file_if_not_exists!
@@ -19,9 +20,26 @@ 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)
   end
+
+  private_class_method def self.cast_value_to_type(value, type)
+    case type
+    when :boolean
+      cast_value_to_boolean(value)
+    when :float
+      value.to_f
+    end
+  end
+
+  private_class_method def self.cast_value_to_boolean(value)
+    if [true, false].include?(value)
+      value
+    elsif value.is_a?(String)
+      value == 'true'
+    end
+  end
 end

data/src/error_reporter.rb

@@ -0,0 +1,44 @@
+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)
+    include_screenshot_config = Config.option(
+      :errors,
+      :include_screenshot,
+      default: false,
+      type: :boolean
+    )
+
+    include_screenshot_config && 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,
+      type: :float
+    )
+
+    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/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.3.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Keeyan Nejad
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2021-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,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