autoluv 0.2.0

data/lib/autoluv.rb

@@ -0,0 +1,73 @@
+require "autoluv/version"
+require "autoluv/southwestclient"
+require "pony"
+
+require "dotenv"
+Dotenv.load("#{Dir.home}/.autoluv.env")
+
+module Autoluv
+  class Error < StandardError; end
+
+  PONY_OPTIONS = {
+    from: "#{ENV["LUV_FROM_EMAIL"]}",
+    via: :smtp,
+    via_options: {
+      address: "#{ENV["LUV_SMTP_SERVER"]}",
+      port: "#{ENV["LUV_PORT"]}",
+      user_name: "#{ENV["LUV_USER_NAME"]}",
+      password: "#{ENV["LUV_PASSWORD"]}",
+      authentication: :login,
+    },
+  }
+
+  LOG_DIR = File.expand_path("../logs/", __dir__)
+
+  def self.log(confirmation_number, first_name, last_name, message, exception)
+    log_path = "#{LOG_DIR}/#{first_name} #{last_name}"
+    FileUtils.mkdir_p(log_path) unless Dir.exist?(log_path)
+
+    logger = Logger.new("#{log_path}/#{confirmation_number}.log")
+
+    logger.error(message + "\n" + exception.backtrace.join("\n"))
+  end
+
+  def self.notify_user(success, confirmation_number, first_name, last_name, data = {})
+    subject = "#{first_name} #{last_name} (#{confirmation_number}): "
+    body = ""
+
+    if success
+      subject << "Succeeded at #{data[:metadata][:end_time]}. #{data[:metadata][:attempts]} attempt(s) in #{data[:metadata][:elapsed_time]} sec."
+      body = data[:boarding_positions]
+    else
+      subject << "Unsuccessful check-in."
+      body = data[:exception_message]
+      Autoluv::log(confirmation_number, first_name, last_name, body, data[:exception])
+    end
+
+    if data[:to].nil?
+      puts body
+    else
+      Autoluv::email(subject, body, data[:to], data[:bcc])
+    end
+  end
+
+  def self.email(subject, body, to, bcc = nil)
+    # only send an email if we have all the environmental variables set
+    return if PONY_OPTIONS.values.any? &:empty?
+
+    # if we're BCCing someone, swap the fields so they don't see your TO address.
+    # this is really for my personal use-case.
+    unless bcc.nil?
+      temp = bcc
+      to = bcc
+      bcc = temp
+    end
+
+    Pony.mail(PONY_OPTIONS.merge({
+      to: to,
+      bcc: bcc,
+      subject: subject,
+      body: body,
+    }))
+  end
+end

data/lib/autoluv/southwestclient.rb

@@ -0,0 +1,128 @@
+require "rest-client"
+require "securerandom"
+require "json"
+require "tzinfo"
+
+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",
+      "X-API-Key": "l7xx0a43088fe6254712b10787646d1b298e",
+      "X-Channel-ID": "MWEB", # required now for viewing a reservation
+    }
+
+    CHECK_IN_URL = "https://mobile.southwest.com/api/mobile-air-operations/v1/mobile-air-operations/page/check-in"
+    RESERVATION_URL = "https://mobile.southwest.com/api/mobile-air-booking/v1/mobile-air-booking/page/view-reservation"
+
+    TIME_ZONES_PATH = File.expand_path("../../data/airport_time_zones.json", __dir__)
+
+    def self.schedule(confirmation_number, first_name, last_name, to = nil, bcc = nil)
+      flights = self.departing_flights(confirmation_number, first_name, last_name)
+
+      flights.each_with_index do |flight, x|
+        check_in_time = self.check_in_time(flight)
+
+        puts "Scheduling flight departing #{flight[:airport_code]} at #{flight[:departure_time]} on #{flight[:departure_date]}."
+
+        command = "echo 'autoluv checkin #{confirmation_number} #{first_name} #{last_name} #{to} #{bcc}' | at #{check_in_time.strftime('%I:%M %p %m/%d/%y')}"
+        `#{command}`
+
+        puts unless x == flights.size - 1
+      end
+    end
+
+    def self.check_in(confirmation_number, first_name, last_name, to = nil, bcc = nil)
+      check_in = attempt = nil
+
+      # try checking in multiple times in case the our server time is out of sync with Southwest's.
+      num_attempts = 10
+
+      start_time = Time.now
+
+      num_attempts.times do |x|
+        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)
+          break
+        rescue RestClient::ExceptionWithResponse => ewr
+          sleep(1)
+          next unless x == num_attempts - 1
+
+          raise
+        end
+      end
+
+      end_time = Time.now
+      boarding_positions = ""
+
+      check_in_json = JSON.parse(check_in)
+      flights = check_in_json["checkInConfirmationPage"]["flights"]
+
+      # make the output more user friendly
+      flights.each_with_index do |flight, x|
+        boarding_positions << flight["originAirportCode"] << "\n"
+
+        flight["passengers"].each do |passenger|
+          boarding_positions << "- #{passenger["name"]} (#{passenger["boardingGroup"]}#{passenger["boardingPosition"]})" << "\n"
+        end
+
+        boarding_positions << "\n" unless x == flights.size - 1
+      end
+
+      metadata = {
+        end_time: end_time.strftime("%I:%M.%L"),
+        elapsed_time: (end_time - start_time).round(2),
+        attempts: attempt,
+      }
+
+      Autoluv::notify_user(true, confirmation_number, first_name, last_name, { to: to, bcc: bcc, boarding_positions: boarding_positions, metadata: metadata })
+    end
+
+    private
+    def self.headers
+      # required now for all API calls
+      DEFAULT_HEADERS.merge({ "X-User-Experience-ID": SecureRandom.uuid })
+    end
+
+    def self.departing_flights(confirmation_number, first_name, last_name)
+      reservation = RestClient.get("#{RESERVATION_URL}/#{confirmation_number}?first-name=#{first_name}&last-name=#{last_name}", self.headers)
+      reservation_json = JSON.parse(reservation)
+
+      airport_time_zones = JSON.parse(File.read(TIME_ZONES_PATH))
+
+      departing_flights = reservation_json["viewReservationViewPage"]["bounds"].map do |bound|
+        airport_code = bound["departureAirport"]["code"]
+
+        {
+          airport_code: airport_code,
+          departure_date: bound["departureDate"],
+          departure_time: bound["departureTime"],
+          time_zone: airport_time_zones[airport_code],
+        }
+      end
+    end
+
+    def self.check_in_post_data(confirmation_number, first_name, last_name)
+      check_in = RestClient.get("#{CHECK_IN_URL}/#{confirmation_number}?first-name=#{first_name}&last-name=#{last_name}", self.headers)
+      check_in_json = JSON.parse(check_in)
+      check_in_json["checkInViewReservationPage"]["_links"]["checkIn"]["body"]
+    end
+
+    def self.check_in_time(flight)
+      tz_abbreviation = TZInfo::Timezone.get(flight[:time_zone]).current_period.offset.abbreviation.to_s
+
+      # 2020-09-21 13:15 CDT
+      departure_time = Time.parse("#{flight[:departure_date]} #{flight[:departure_time]} #{tz_abbreviation}")
+
+      # subtract a day (in seconds) to know when we can check in
+      check_in_time = departure_time - (24 * 60 * 60)
+
+      # compensate for our server time zone
+      check_in_time -= (departure_time.utc_offset - Time.now.utc_offset)
+    end
+  end
+end

data/lib/autoluv/version.rb

@@ -0,0 +1,3 @@
+module Autoluv
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: autoluv
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alex Tran
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description:
+email:
+- hello@alextran.org
+executables:
+- autoluv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- autoluv.gemspec
+- bin/autoluv
+- bin/console
+- bin/setup
+- data/airport_time_zones.json
+- lib/autoluv.rb
+- lib/autoluv/southwestclient.rb
+- lib/autoluv/version.rb
+homepage: https://github.com/byalextran/southwest-checkin
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Easy-to-use gem to check in to Southwest flights automatically. Also supports
+  sending email notifications.
+test_files: []