autoluv 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fa9c3673d12aa12e12b72694adf279ad740f61766722994a4b2841089db4dee
-  data.tar.gz: 95c3e70497b34a07facbbda0ae72f2107cf8e43849158022fddc1a4252b09438
+  metadata.gz: 6041a300159cacdee0647a8d80cdc02455a9d3b75c05fa3a0425083635975f41
+  data.tar.gz: 31f5f4315884761e5943c7f89fe741b985c7f3eb75adab347c693fd1913ef445
 SHA512:
-  metadata.gz: 3eb77985fedabc42a7180c42e703e6685c15de245fbdf01d761f2d5ba72e4115c447b2eba6955c5c0a4305c9703e77056facf58daf94d0728c09cb1bb4af8e76
-  data.tar.gz: df23cb0ac4b2eaeb5a1747f53eed6118556572e667e143be0b2334c8832741a7c22a36fa34ca74b679958503176d1c3c1d3248d8b45192153519858d0989aa69
+  metadata.gz: 1e7b8092eb200f0fd8a4db123707fecb6115b325f110bac8b0fbb093e53ece3172c969201faf59fd0ad784b97ed54ba33d39779b577db9f5908d413e057c1035
+  data.tar.gz: e4ed6cf0e6149f4acffbcb4b435829d47ac1031f70f35d0b891b3f2658635082879e9ab6d38114322b9454693f5ac0b5d3a3e23d7df94739178038d0f5f6c401

data/.gitignore

@@ -2,3 +2,4 @@
 /*.gem
 /logs/
 /pkg/
+/Gemfile.lock

data/Gemfile

@@ -1,3 +1,5 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "rake", "~> 13.0"

data/README.md

@@ -2,41 +2,69 @@
 
 Automatically check in to Southwest flights using this easy-to-use gem. It'll also email you the results so you know ASAP whether a check in was successful. Seconds count when you're fighting for that window or aisle seat!
 
+## Requirements
+
+* A *nix-based server that will be on when you need to check in
+* Ruby 2.3 or higher
+* The `at` command
+
+Tested and working on an Ubuntu 20.04 server (hosted by DigitalOcean).
+
 ## Installation
 
+### Get Southwest Headers
+
+The Southwest API now requires some randomly generated headers to check in. Because these headers change at a set interval, they need to be constantly refreshed for any check-in script (like this one) to work. To get these headers, please follow the instructions here:
+
+https://github.com/byalextran/southwest-headers
+
+Once a cron job has been scheduled, do these steps:
+
+**Step 1:** Create the file `.autoluv.env` in your user's home directory.
+
+    nano ~/.autoluv.env
+
+**Step 2:** Copy/paste the following into the text editor.
+
+    LUV_HEADERS_FILE  = /PATH/TO/southwest_headers.json
+
+**Step 3:** Update the path (and filename if changed from the default) to the correct path of the headers file.
+
+**Step 4:** Hit `Ctrl+O` to save the file and then `Ctrl+X` to exit the text editor.
+
+### Install Gem
+
     gem install autoluv
 
 ## Usage
 
-### Schedule a Check In
+### Schedule a Check-In
 
     autoluv schedule ABCDEF John Doe
 
-Both departing and returning flights (if applicable) will be scheduled. After scheduling, there's no need to keep the terminal window open or active. The check in will happen behind the scenes at the appropriate time.
-
-**Note:** If a name includes a space, wrap it in double quotes (e.g. "John Doe")
+Both departing and returning flights (if applicable) will be scheduled for all passengers tied to the confirmation number. After scheduling, there's no need to keep the terminal window open or active. The check in will happen behind the scenes at the appropriate time.
 
-### Schedule a Check In With Email Notification
+**Note:** If a first or last name includes a space, wrap it in double quotes (e.g. "Mary Kate")
 
-Follow the instructions below for configuring email notifications.
+### Schedule a Check-In With Email Notification
 
-    autoluv schedule ABCDEF John Doe john.doe@email.com
+Before using this command, follow the instructions below to configure the required settings.
 
-A second email address can be passed in as well and get the results BCCed to it.
+    autoluv schedule ABCDEF John Doe john.doe@email.com optional@bcc.com
 
-    autoluv schedule ABCDEF John Doe john.doe@email.com second.email@bcc.com
+The second email address is optional and will be BCCed the results.
 
 ### Check In Immediately
 
-    autoluv checkin ABCDEF Jane Doe
+    autoluv checkin ABCDEF John Doe
 
 ## Configure Email Notifications
 
-This is optional, however, highly recommended. Especially if a scheduled check in fails, you'll get notified and can manually check in. Every second counts!
+This is optional, however, highly recommended. Especially if a scheduled check-in fails, you'll get notified and can manually check in. Every second counts!
 
-On a successful check in, the email will share boarding positions for each passenger.
+Boarding positions are shown for each passenger when a check-in succeeds.
 
-**Step 1:** Create the file `.autoluv.env` in your user's home directory.
+**Step 1:** Open/create the file `.autoluv.env` in your user's home directory.
 
     nano ~/.autoluv.env
 
@@ -52,17 +80,25 @@ LUV_PORT        = 587
 
 **Step 3:** Replace the values with the appropriate SMTP settings for your email provider. `LUV_FROM_EMAIL` should be the email address associated with `LUV_USER_NAME`.
 
-If your email account has two-factor authentication enabled, be sure to use an app-specific password above (and *not* your account password).
+If your email account has two-factor authentication enabled, be sure to use an app-specific password and *not* your account password.
 
 **Step 4:** Hit `Ctrl+O` to save the file and then `Ctrl+X` to exit the text editor.
 
+### Test Email Notifications
+
+To verify your SMTP settings, schedule a check-in with invalid information and a valid email address.
+
+    autoluv schedule AAAAAA Fake Name valid@email.com
+
+If everything is set up correctly, you'll get an email notifying you of an unsuccessful check-in.
+
 ### Get Text Instead of Email Notifications
 
 [Use this Zap](https://zapier.com/apps/email/integrations/sms/9241/get-sms-alerts-for-new-email-messages) to get a custom Zapier email address that forwards emails as text messages. It's handy for people like me who don't have email notifications enabled on their phone or computer and want check-in results ASAP.
 
 ## Manage Check-Ins
 
-`autoluv` uses the `at` command behind the scenes to check in at a specific time. Use the related `atq` and `atrm` commands to manage them.
+`autoluv` uses the `at` command behind the scenes to check in at a specific time. Use the related `atq` and `atrm` commands to manage check-ins.
 
 ### View Scheduled Check-Ins
 Make note of the first column's number.
@@ -92,6 +128,3 @@ Bug reports and pull requests are welcome.
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-# TODO: try getting it working on macos.
-# TODO: does scheduling pass two-word names to checkin properly?

data/autoluv.gemspec

@@ -12,9 +12,12 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.add_runtime_dependency "rest-client", "~> 2.1.0"
-  spec.add_runtime_dependency "pony", "~> 1.13.0"
-  spec.add_runtime_dependency "dotenv", "~> 2.7.0"
-  spec.add_runtime_dependency "tzinfo", "~> 0.3.0"
+  spec.add_runtime_dependency "pony", "~> 1.13.1"
+  spec.add_runtime_dependency "dotenv", "~> 2.7.6"
+  spec.add_runtime_dependency "tzinfo", "~> 2.0.2"
+  spec.add_runtime_dependency "json", "~> 2.3.1"
+  spec.add_runtime_dependency "fileutils", "~> 1.4.1"
+  spec.add_runtime_dependency "logger", "~> 1.4.2"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/bin/autoluv

@@ -10,6 +10,10 @@ to = ARGV[4]
 bcc = ARGV[5]
 
 begin
+  unless File.exist?(ENV["LUV_HEADERS_FILE"].to_s)
+    abort "Please create a valid Southwest header file before continuing. Learn more: https://github.com/byalextran/southwest-headers"
+  end
+
   case command.downcase
   when "schedule"
     Autoluv::SouthwestClient.schedule(confirmation_number, first_name, last_name, to, bcc)

data/lib/autoluv/southwestclient.rb

@@ -6,8 +6,6 @@ require "shellwords"
 
 module Autoluv
   class SouthwestClient
-    @confirmation_number = @first_name = @last_name = @options = nil
-
     # minimum required headers for all API calls
     DEFAULT_HEADERS = {
       "Content-Type": "application/json",
@@ -47,7 +45,7 @@ module Autoluv
         begin
           attempt = x + 1
           post_data = self.check_in_post_data(confirmation_number, first_name, last_name)
-          check_in = RestClient.post("#{CHECK_IN_URL}", post_data.to_json, self.headers)
+          check_in = RestClient.post("#{CHECK_IN_URL}", post_data.to_json, JSON.parse(File.read(ENV["LUV_HEADERS_FILE"])))
           break
         rescue RestClient::ExceptionWithResponse => ewr
           sleep(1)

data/lib/autoluv/version.rb

@@ -1,3 +1,3 @@
 module Autoluv
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

data/lib/autoluv.rb

@@ -1,8 +1,10 @@
 require "autoluv/version"
 require "autoluv/southwestclient"
 require "pony"
-
+require "logger"
+require "fileutils"
 require "dotenv"
+
 Dotenv.load("#{Dir.home}/.autoluv.env")
 
 module Autoluv
@@ -55,11 +57,15 @@ module Autoluv
     # only send an email if we have all the environmental variables set
     return if PONY_OPTIONS.values.any? &:empty?
 
-    Pony.mail(PONY_OPTIONS.merge({
-      to: to,
-      bcc: bcc,
-      subject: subject,
-      body: body,
-    }))
+    begin
+      Pony.mail(PONY_OPTIONS.merge({
+        to: to,
+        bcc: bcc,
+        subject: subject,
+        body: body,
+      }))
+    rescue => e
+      puts e.message
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoluv
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Alex Tran
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2021-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -30,42 +30,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.13.1
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.7.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.7.6
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
 description:
 email:
 - hello@alextran.org
@@ -74,10 +116,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env"
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -108,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Easy-to-use gem to check in to Southwest flights automatically. Also supports

data/.env

@@ -1,6 +0,0 @@
-TO_EMAIL = hello@alextran.org
-FROM_EMAIL = autoluv@outlook.com
-SMTP_SERVER = smtp.office365.com
-PORT = 587
-USER_NAME = autoluv@outlook.com
-PASSWORD = cislmkwowwntafuw

data/Gemfile.lock

@@ -1,45 +0,0 @@
-PATH
-  remote: .
-  specs:
-    autoluv (0.1.0)
-      dotenv (~> 2.7.0)
-      pony (~> 1.13.0)
-      rest-client (~> 2.1.0)
-      tzinfo (~> 0.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    dotenv (2.7.6)
-    http-accept (1.7.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
-    mini_mime (1.0.2)
-    netrc (0.11.0)
-    pony (1.13.1)
-      mail (>= 2.0)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    tzinfo (0.3.57)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  autoluv!
-
-BUNDLED WITH
-   2.1.4