fuck_facebook 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '059a4dd680f130343508367f8a4d661ea3de1ef4bd74fa6b700d9ddd323e41c4'
-  data.tar.gz: 68d9b31fcc64272a7c7df41764ffda58c4066af19fc7132346e7dcfc7ab0ceaa
+  metadata.gz: 24caa7bf76958d703667ca687fb2bc9cf4aa7b6ea2bc56db68e08a13ab74bc08
+  data.tar.gz: 540bdba30c7e8b0761fde58f30d87decfbd6593f137e2d293e5a8b292c1c180d
 SHA512:
-  metadata.gz: c09a4393cab84897c62bd0c980dd8e2a7315f94e34fa181bd2d0f43346c5ecfd9e9e04fd579e86095633cb8d79a93f908a004a67673dccda7c1751ff0f40e36c
-  data.tar.gz: d3f9ad82007908d96c2d3a96d85fb7436af46643bc4e7ca08341f7e93f458bbd9e41248c92caa06fbf817fd08b43d0e3fc8978bec62c0ada6e267d6dfee4b555
+  metadata.gz: fd41131b5187fe85b56adcb45d3d1f857d109bb925c0cf65012baf4aaf195d67317484593764a869eaf2b2ed18f336b98f47346031cfe000c1ced8cb1823afc7
+  data.tar.gz: 0c1873d36d15249e85311aabf4de4ed4517b0f378881a032e871b96a35d0c02db6113fe65f70980896633680df85efe70155d230d18e4c2824cf9d67e88dae7d

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.1)
+    fuck_facebook (0.2.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,48 @@
 # 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
+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

@@ -2,65 +2,27 @@
 
 require 'optparse'
 require 'mail'
-require 'pry'
 
 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
+
+begin
+  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)
+  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)
+end

data/lib/fuck_facebook/version.rb

@@ -1,3 +1,3 @@
 module FuckFacebook
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.4.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/authenticator.rb

@@ -19,7 +19,7 @@ class Authenticator
 
     accept_cookies
     submit_credentials
-    submit_2fa
+    submit_otp
     click_remember_password
   end
 
@@ -32,7 +32,7 @@ class Authenticator
 
   def click_remember_password
     driver.navigate.to('https://www.facebook.com/settings?tab=security')
-    driver.switch_to.frame(xpaths.element(:settings, :security_iframe))
+    driver.switch_to.frame(xpaths.wait_for_element(:settings, :security_iframe))
     xpaths.element(:settings, :save_login_information_edit_button).click
     xpaths.element(:settings, :save_login_information_button).click
   end
@@ -43,15 +43,20 @@ class Authenticator
     xpaths.element(:login_button).click
   end
 
-  def submit_2fa
-    return unless xpaths.element(:checkpoint, :prompt).text == 'Two-factor authentication required'
+  def submit_otp
+    return unless xpaths.element_exists?(:checkpoint, :otp_prompt)
 
     xpaths.element(:checkpoint, :otp_input).send_keys(user_input.get(:otp))
-    xpaths.element(:checkpoint, :otp_continue_button).click
-    xpaths.element(:checkpoint, :save_browser_continue_button).click
+    otp_button = xpaths.element(:checkpoint, :submit_button)
+    otp_button.click
+
+    save_browser_button = xpaths.element(:checkpoint, :submit_button)
+    save_browser_button.click
   end
 
   def accept_cookies
+    return unless xpaths.element_exists?(:accept_cookies_button)
+
     accept_cookies_button = xpaths.element(:accept_cookies_button)
     accept_cookies_button.click
   end

data/src/config.rb

@@ -1,9 +1,27 @@
 require 'yaml'
 
 class Config
-  CONFIG = YAML.load_file("#{ENV['HOME']}/.config/fuck-facebook/config.yaml", symbolize_names: true)
+  CONFIG_FILE_PATH = "#{ENV['HOME']}/.local/share/fuck-facebook/config.yaml".freeze
 
   def self.option(*path)
-    CONFIG.dig(*path)
+    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
+
+  def self.config
+    create_config_file_if_not_exists!
+
+    YAML.load_file(CONFIG_FILE_PATH)
+  end
+
+  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
 end

data/src/cookie_handler.rb

@@ -41,7 +41,7 @@ class CookieHandler
     saved_cookies = JSON.parse(File.read(cookies_filename), symbolize_names: true)
 
     saved_cookies.each do |saved_cookie|
-      saved_cookie[:expires] = Time.parse(saved_cookie[:expires])
+      saved_cookie[:expires] = Time.parse(saved_cookie[:expires]) unless saved_cookie[:expires].nil?
     end
 
     saved_cookies

data/src/error_reporter.rb

@@ -0,0 +1,6 @@
+class ErrorReporter
+  def self.report_error(sender_name, error)
+    Senders.by_name(sender_name).send_error(error)
+    raise error
+  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

@@ -18,10 +18,7 @@ class MessageHandler
   def messages
     visit_messages_page
 
-    xpaths.wait_for_element(:messages, :chats)
-
-    chats = xpaths.elements(:messages, :chats)
-
+    chats = xpaths.wait_for_elements(:messages, :chats)
     messages = messages_for_chats(chats)
 
     messages_after_last_message_time(messages)

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

data/src/senders/stdout.rb

@@ -5,5 +5,9 @@ module Senders
         puts message
       end
     end
+
+    def self.send_error(error)
+      puts error
+    end
   end
 end

data/src/storage.rb

@@ -29,7 +29,7 @@ class Storage
   def self.storage
     create_storage_file_if_not_exists!
 
-    YAML.load_file(STORAGE_FILE_PATH, symbolize_names: true)
+    YAML.load_file(STORAGE_FILE_PATH)
   end
 
   def self.create_storage_file_if_not_exists!

data/src/xpaths.rb

@@ -63,17 +63,24 @@ class Xpaths
     found_element
   end
 
+  def wait_for_elements(*path_elements)
+    wait_for_element(*path_elements)
+
+    elements(*path_elements)
+  end
+
   def for(*path_elements)
-    result = XPATHS.dig(*path_elements)
+    path_elements_strings = path_elements.map(&:to_s)
+    result = XPATHS.dig(*path_elements_strings)
 
-    raise 'Could not find xpath' if result.empty?
+    raise 'Could not find xpath' if result.nil? || result.empty?
 
     result
   end
 
   private_class_method def self.xpaths_from_file
     xpaths_file = File.join(File.dirname(__FILE__), '../xpaths.yaml')
-    YAML.load_file(xpaths_file, symbolize_names: true)
+    YAML.load_file(xpaths_file)
   end
 
   XPATHS = xpaths_from_file

data/xpaths.yaml

@@ -8,13 +8,12 @@ settings:
   save_login_information_button: '//div[text() = "Save your login information"]'
 link_to_profile: '//a[@href="/me/"]'
 checkpoint:
-  otp_input: '/html/body/div[1]/div[3]/div[1]/div/form/div/div[2]/div[3]/span/input'
-  otp_continue_button: '/html/body/div[1]/div[3]/div[1]/div/form/div/div[3]/div[1]/button'
+  otp_prompt: '//strong[text() = "Two-factor authentication required"]'
+  otp_input: '//*[@id="approvals_code"]'
   save_browser_radio_input: '/html/body/div[1]/div[3]/div[1]/div/form/div/div[2]/div[2]/div[1]/input'
-  save_browser_continue_button: '/html/body/div[1]/div[3]/div[1]/div/form/div/div[3]/div[1]/button'
-  prompt: '/html/body/div[1]/div[3]/div[1]/div/form/div/div[1]'
+  submit_button: '//*[@id="checkpointSubmitButton"]'
 messages:
-  chats: '/html/body/div[1]/div/div[1]/div/div[3]/div/div/div[1]/div[1]/div[1]/div/div/div/div[3]/div[1]/div[2]/div/child::*[@role = "row"]'
+  chats: './/*[@aria-label="Chats"]/child::*'
   title_relative: 'div[1]/div/a/div/div[2]/div[1]/div/div/div[1]/span/span/span/span'
   text_relative: 'div[1]/div/a/div/div[2]/div[1]/div/div/div[2]/span/span/div/span[1]/span'
   time_sent_ago_relative: 'div[1]/div/a/div/div[2]/div[1]/div/div/div[2]/span/span/div/span[3]'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fuck_facebook
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Keeyan Nejad
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-12-24 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