fuck_facebook 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8034fd3f3afb91d27f11300b42e15e07c92808c473daec3459f82c14ab772ff6
-  data.tar.gz: f656f97d23da62a99d618ec197ddf8f3b9f3d8c818d71ed16d27cb35b8d25123
+  metadata.gz: 9f15615d0c24e530547c2a40e4509d434bc25578dde17737a5b8d8ef5fe2e68f
+  data.tar.gz: e3c8a9d379b9df92d0d986bfb1dba35846779d32d4cf1bbf16ae39d1f778fae4
 SHA512:
-  metadata.gz: afc81df11373573a7ce572a09574f7c5159f278f3173a924202b1f0f11cd913922f89caaac117901eca27c4634576180733050da46f839c2b714b40ce4d8b068
-  data.tar.gz: 97e1f728a14dd6f67af0985a2d382753579fd160c16866b85946e19d855d15ec2c8ed9ed24d921cdddde2c2064e76541a145abac090360bd2670bec57f15cf82
+  metadata.gz: cffa79b7c7b58717a8507ba129668db846b40e6682621527b7799665d4fa74a5032a27ef471da20659ee01cd57662e82d85f76aff5b01e43a547d638e0c70374
+  data.tar.gz: 4acc110f1bb5e7115b28a429594a5fc8459f402fcffe88391a7189687791d677e857117049227d656d977c00b5daac88b4bded2780b1044b81fdce8cc603f0e6

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+*.gem

data/.ruby-version

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

data/CHANGELOG.md

@@ -1,5 +1,4 @@
-## [Unreleased]
-
 ## [0.1.0] - 2021-07-15
 
+- Send unread messages to your email address
 - Initial release

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.0)
+    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,46 @@
 # 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
+```
+
+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,7 +2,6 @@
 
 require 'optparse'
 require 'mail'
-require 'pry'
 
 require_relative '../src/facebook_connection'
 require_relative '../src/config'

data/fuck_facebook.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   DESCRIPTION
   spec.homepage = 'https://gitlab.com/keeyan/fuck_facebook'
   spec.license = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.1')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0', '< 3.1')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 

data/lib/fuck_facebook/version.rb

@@ -1,3 +1,3 @@
 module FuckFacebook
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.3.0'.freeze
 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/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)
@@ -32,15 +29,29 @@ class MessageHandler
   def messages_for_chats(chats)
     chats.map do |chat|
       message_thread = MessageThread.new(title: xpaths.child_element(chat, :messages, :title_relative).text)
-      text = xpaths.child_element(chat, :messages, :text_relative).text
-      read = !xpaths.element_has_child?(chat, :messages, :mark_as_read_button_relative)
-      message_time_ago = xpaths.child_element(chat, :messages, :time_sent_ago_relative).text
-      timestamp = FbDuration.parse_to_time(message_time_ago)
 
-      Message.new(message_thread: message_thread, text: text, read: read, timestamp: timestamp)
+      Message.new(
+        message_thread: message_thread,
+        text: chat_text(chat),
+        read: chat_read?(chat),
+        timestamp: chat_timestamp(chat)
+      )
     end
   end
 
+  def chat_text(chat)
+    xpaths.child_element(chat, :messages, :text_relative).text
+  end
+
+  def chat_read?(chat)
+    !xpaths.element_has_child?(chat, :messages, :mark_as_read_button_relative)
+  end
+
+  def chat_timestamp(chat)
+    message_time_ago = xpaths.child_element(chat, :messages, :time_sent_ago_relative).text
+    FbDuration.parse_to_time(message_time_ago)
+  end
+
   def messages_after_last_message_time(messages)
     last_message_time = Storage.get(:last_message_time, default: Time.new(2004, 2, 4))
 

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.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Keeyan Nejad
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-12-23 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
@@ -125,14 +127,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.1
+      version: 2.7.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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