fuck_facebook 0.4.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24caa7bf76958d703667ca687fb2bc9cf4aa7b6ea2bc56db68e08a13ab74bc08
-  data.tar.gz: 540bdba30c7e8b0761fde58f30d87decfbd6593f137e2d293e5a8b292c1c180d
+  metadata.gz: acfe1137400e4f4cc8fc79f7d0222eb8617eb72032fade8f975da0c638967a7a
+  data.tar.gz: ef0b084adbf6017d96b008792efc158bde131df714bbc9382738394bcbf01462
 SHA512:
-  metadata.gz: fd41131b5187fe85b56adcb45d3d1f857d109bb925c0cf65012baf4aaf195d67317484593764a869eaf2b2ed18f336b98f47346031cfe000c1ced8cb1823afc7
-  data.tar.gz: 0c1873d36d15249e85311aabf4de4ed4517b0f378881a032e871b96a35d0c02db6113fe65f70980896633680df85efe70155d230d18e4c2824cf9d67e88dae7d
+  metadata.gz: bf839aa8b6b7b0803588021a3d444e6ef641240569a0ed72a98eed6a66f9a123498a8891c1c25218ea47bb005110d64861acb1a277b553f096ced32d40b50c1c
+  data.tar.gz: ad427fa1ae23c9abf1c2d78db1b547c7f4cc73ce0b12dbefc57c443a5ac2fd7812924c543fb60d1159fe5e421dc0442d6c0ef7fc8e846c6863c4687d3e36fe29

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

data/bin/fuck-facebook

@@ -12,11 +12,12 @@ 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 = FacebookConnection.new(headless: options[:headless])
   facebook_connection.cookie_handler.clear! if options[:clear_cookies]
   facebook_connection.login if options[:login]
   message_sender = MessageSender.new(options[:sender], facebook_connection)
@@ -24,5 +25,5 @@ begin
   message_sender.send_messages if options[:messages]
   facebook_connection.close
 rescue StandardError => e
-  ErrorReporter.report_error(options[:sender], 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.4.0'.freeze
+  VERSION = '0.5.2'.freeze
 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,28 @@ 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 nil
+      value
+    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

@@ -1,6 +1,44 @@
 class ErrorReporter
-  def self.report_error(sender_name, error)
-    Senders.by_name(sender_name).send_error(error)
+  def self.report_error(sender_name, error, facebook_connection: nil)
+    raise error unless report_error?
+
+    screenshot = include_screenshot?(facebook_connection) ? create_screenshot(facebook_connection) : nil
+
+    Senders.by_name(sender_name).send_error(error, screenshot: screenshot)
+
+    Storage.set(:last_error_reported_time, Time.now)
     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/senders/email.rb

@@ -11,12 +11,13 @@ module Senders
       end
     end
 
-    def self.send_error(error)
+    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

data/src/senders/stdout.rb

@@ -6,8 +6,13 @@ module Senders
       end
     end
 
-    def self.send_error(error)
+    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.4.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Keeyan Nejad
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 2021-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport