Skip to content

Latest commit

 

History

History
173 lines (117 loc) · 7.9 KB

README.md

File metadata and controls

173 lines (117 loc) · 7.9 KB
Raw

eBay Watchlist as iCalendar (Azure Function)

This Azure Function creates an iCalendar that contains the auction expiration date/time of the items in your eBay Watchlist, as events. You can subscribe to this iCalendar from your favorite calendaring program and have calendar entries created on every watchlist item auction ending, so you can e.g. set alarms accordingly.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Cloud deployment for notes on how to deploy the project on Azure.

Prerequisites

In order for this service to work you will need:

  1. A valid Azure subscription
  2. An eBay developer account

You will also need the following software installed in your dev enviroment:

  1. Python 3.x
  2. Azure CLI
  3. Azure Function Core Tools
  4. Node.js (required for Azure Functions Core Tools)

Installing

eBay API access

To use eBay’s APIs, you need to register with the eBay developer program and create a unique title for your application, using this form.

Generate a unique set of keys (a keyset) that will serve as your application’s credentials:

  • App ID/Client ID: This uniquely identifies your application.

  • Dev ID: This uniquely identifies your developer account.

  • Cert ID/Secret: This is a client secret (like a password for your App ID), which should be kept confidential.

eBay supports two environments:

  • Production: This is the eBay website, where eBay members buy and sell items.
  • Sandbox: This is a test version of the eBay website, where developers can simulate buying and selling items

Generate a separate keyset for each environment, using this form. The App IDs (Client IDs) will be different. The Dev ID will be shared. Your keyset will be stored here in your eBay developer account.

After you generate your keyset, use the User Tokens option next to your App ID to learn more about tokens and how to create them. For APIs like the Trading API, used in this application, I recommend that you use OAuth; but eBay's older Auth 'n' Auth process is also still available.

You should copy and save your Production enviroment keys locally in the credentials.sh file, for use in this application, as follows:

EBAY_APPID=<App ID>
EBAY_DEVID=<Dev ID>
EBAY_CERTID=<Cert ID>
EBAY_TOKEN=<User Token>

These credentials will be privatly uploaded to Azure as App settings by the bootstrap.sh script.

Python enviroment

It is stongly advised to create a local Python virtual environment and install all required Python modules there:

$ python -m venv .venv

Activate the virtual environment by runing the activate script inside the .venv/Scripts/ directory.

Install locally all required modules as follows:

$ pip install -r requirement.txt

Deploying

First you will need to set the values of the following variables in definitions.sh file:

rgName=<Resource Group Name>
storageName=<Storage Account Name>
functionAppName=<FunctionApp Name>
location=<Location>

Note: rgName and storageName should be unique across your Azure subscription. functionAppName should be unique across Azure(!). location should be an Azure Location preferably be as close as possible to your physical location.

Local deployment

Before running this function localy for the first time, you will need to execute the bootstrap.sh script:

$ ./bootstrap.sh

This script will:

  • create an Resource Group where all resources required for this function will belong
  • create a Storage Account, required by the Azure Functions framework
  • create the Azure Function App
  • securely upload to Azure all eBay credentials as App settings
  • will fetch these app settings locally so that can be used for local function execution.

After bootstraping, the Azure Function can be executed locally (always within your Python virtual environment) as follows:

$ func host start

Hosting environment: Production
Content root path: \ebay-watchlist-calendar
Now listening on: http://0.0.0.0:7071
[15/1/2020 9:10:12 πμ] Application started. Press Ctrl+C to shut down.
 INFO: Received WorkerInitRequest, request ID <removed>

Http Functions:
[15/1/2020 9:10:12 πμ]  INFO: Received FunctionLoadRequest, request ID: <removed>, function ID: <removed>
        watchlist: [GET,POST] http://localhost:7071/api/watchlist

While the Azure Function is running locally, you can send an HTTP request towards the URL above (http://localhost:7071/api/watchlist) in order to retrieve your eBay Watchlist in iCalendar format:

$ wget -4  http://localhost:7071/api/watchlist
--2020-01-15 11:17:37--  http://localhost:7071/api/watchlist
Resolving localhost (localhost)... 127.0.0.1
Connecting to localhost (localhost)|127.0.0.1|:7071... connected.
HTTP request sent, awaiting response... 200 OK
Length: unspecified [text/calendar]
Saving to: ‘watchlist’

watchlist                               [ <=>                                                                      ]  11.60K  --.-KB/s    in 0s

2020-01-15 11:17:40 (35.2 MB/s) - ‘watchlist’ saved [11882]

$ file watchlist
watchlist: vCalendar calendar file

Cloud deployment

In order to publish to Azure, execute the deploy.sh script:

$ ./deploy.sh
Creating archive for current directory...
Performing remote build for functions project.
Deleting the old .python_packages directory
Uploading 15,32 MB [##############################################################################]
Remote build in progress, please wait...

Deployment successful.
Remote build succeeded!
Syncing triggers...
Functions in ebaywatchlistfunc:
    watchlist - [httpTrigger]
        Invoke url: https://ebaywatchlistfunc.azurewebsites.net/api/watchlist?code=<unique_code>

After succesfull deployment you can send HTTPS request towards the Invoke url above in order to retrieve your eBay Watchlist in iCalendar format. You can use this Invoke url to subscribe to this iCalendar in your favorite calendaring platform, e.g. Google Calendar or Outlook.

Built With

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details