Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 3.83 KB

README.md

File metadata and controls

101 lines (71 loc) · 3.83 KB
Raw

publix-coupon-clipper

Build Status npm latest version

Publix is a grocery chain that operates throughout the Southeastern United States. This script uses Puppeteer to automatically clip digital coupons which can then be applied to your purchases in store if you provide your phone number at checkout.

🚨🚨🚨

I am not affiliated with Publix and offer no warranty for the use of this code.

🚨🚨🚨

Command-line Usage

npx publix-coupon-clipper [email] [password]

If you do not provide your Publix.com email address and password the script will check the PUBLIX_EMAIL and PUBLIX_PASSWORD environment variables. If either of these are missing, you will be prompted for the value to use.

Avoiding the Large Chromium Download

When running npx publix-coupon-clipper the Puppeteer library will download Chromium each time (a >130Mb download as of writing).

To avoid this you can set the PUPPETEER_DOWNLOAD_PATH environment variable to reuse the same download each time. For example:

PUPPETEER_DOWNLOAD_PATH=/tmp/.publix-coupon-clipper-chromium npx publix-coupon-clipper

Alternatively you can set the PUPPETEER_SKIP_CHROMIUM_DOWNLOAD environment variable to 1 and PUPPETEER_EXECUTABLE_PATH to your existing Chrome install (eg. on macOS '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome').

See the Puppeteer documentation on environment variables for more, but also note that they only guarantee support for their bundled Chromium version.

Package Usage

publix-coupon-clipper can also be installed from NPM and used in your own Node.js script.

const { clipCoupons } = require("publix-coupon-clipper");

(async () => {
  const couponCount = await clipCoupons({
    publixEmail: "[email protected]",
    publixPassword: "letmein",
  });

  console.log(`Coupons clipped: ${couponCount}`);
})();

You can optionally provide your own Puppeteer browser instance to use:

const { clipCoupons } = require("publix-coupon-clipper");
const puppeteer = require("puppeteer");

(async () => {
  const browser = await puppeteer.launch({
    headless: false,
  });

  await clipCoupons({
    publixEmail: "[email protected]",
    publixPassword: "letmein",
    browser,
  });

  // Don’t forget to dispose of your browser!
  await browser.close();
})();

An EventEmitter called events is also exported which provides info messages that are useful for logging progress:

const { clipCoupons, events } = require("publix-coupon-clipper");

(async () => {
  events.on("info", (message) => console.log(new Date(), message));

  await clipCoupons({
    publixEmail: "[email protected]",
    publixPassword: "letmein",
  });
})();

// 2019-07-29T02:52:34.830Z 'Setting up page'
// 2019-07-29T02:52:34.931Z 'Logging in to Publix.com'
// 2019-07-29T02:52:38.807Z 'Logged in successfully'
// 2019-07-29T02:52:38.807Z 'Clipping coupons'
// 2019-07-29T02:52:42.322Z 'Clipping coupon #1'
// 2019-07-29T02:52:43.458Z 'Clipping coupon #2'
// 2019-07-29T02:52:44.587Z 'Clipping coupon #3'
// …
// 2019-07-29T02:52:52.827Z  Clipped 10 coupon(s), failed to clip 0