puppet-purchase is a bot that automates the process of purchasing an item from a few of the major online retailers. In attempt to combat scalping, I've created puppet-purchase bot and am making it publicly available with you all. Not perfect, but has helped me. Please share && contribute.
These are scripts that automate the user flow of purchasing an item.
That flow of purchasing an item varies a bit from website to website, but in general it is as follows:
- Navigate to site
- Sign-in to the account
- Navigate to item listing page
- If no is stock available: Switches store and refresh page until it finds available stock.
- Adds item to cart
- Checks-out cart
To run these scripts, setting up an online account with one of the retailers is required. To ensure the scripts execute with no errors, be sure to plug in your account information. Each bot uses the .env.userInfo file located in scripts/< bot >/userInfo/.env.userInfo to define user specific information.
All payment information should be setup by using your web browser, logging into the account, and adding a payment option. Not in the scripts.
Avoid checking in personal account information to this repo / branches if you decide to contribute by adding env.userInfo gitignore
Or even better, by creating a new a env. file and pointing to it in scripts/< bot >/myInfo.js
To run these script use node.js in order to install the required node modules. Navigate to the project directory and install npm.
npm iBecause of the way that the environment variables are defined, a version of WSL will need to be installed on your machine if running on windows machine. Alternatively, and perhaps an easier method for some, installing Git and running the program using Git Bash
Once npm finishes installing all the required node modules, the scripts are ready to go! Try filling out the necessary account info in scripts/< bot >/userInfo/.env.userInfo, then running one of the bots to see it in action.
npm run target-botA full list of available scripts can be found in package.json. We recommend running one of the bot-test to ensure everything is working properly.
Running one of the bot-tests is the best way of making sure that the program is properly installed and running correctly. The bot-tests DO NOT perform the last step - clicking the 'place order' button. Bot-tests are also a great way of making sure that your account has all the required information for a speedy checkout.
When running the bot-tests, test-user information will need to be added as environment variables instead of being added to env.userInfo file. This is the list of all test-user variable
export TEST_USER_EMAIL= \
TEST_USER_PASSW= \
TEST_USER_INBOX_PASSW= \
TEST_USER_PHONE= \
TEST_USER_LOC= \
TEST_USER_CVV= \
TEST_USER_LISTING_URL= \Use 'export' if you're on Linux or 'SET' if you're on Windows.
Some environment variables are not required for all of the bot-test, such as TEST_USER_INBOX_PASSW && TEST_USER_LOC. Look inside the env.userInfo file that pertains to the specific bot inorder to know what variables the program is expecting.
We find it easier to export all of the variables, and just change the TEST_USER_LISTING_URL variable depending on what bot-tests is we expect to run.
Alternatively, you can run the program inside a docker container. Use the Dockerfile provided to make a docker image and then run it inside a docker container.
docker build -t puppet-purchase .
docker run -p 5901:5901 -d puppet-purchaseUse VNC Viewer to look inside the container and view the process. By default it is running on port 5901. Feel free to change the default port by editing the -p flag and the Dockerfile
# Inside Dockerfile, add this
EXPOSE [new_port_number]default password: puppeteer
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.