~vesto/huginn_venmo_agent

16b1ea0b0ee4cfc40ee970077753f82b6a48c3ef — Steve Gattuso 3 years ago 2ace519
add a README and license
2 files changed, 47 insertions(+), 2 deletions(-)

A LICENSE.txt
M README.md
A LICENSE.txt => LICENSE.txt +19 -0
@@ 0,0 1,19 @@
Copyright (c) 2021 Steve Gattuso

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

M README.md => README.md +28 -2
@@ 1,2 1,28 @@
# YNAB Agent
For sending transactions to YNAB from Huginn
# Venmo Agent
This gem implements agents for [Huginn](https://github.com/huginn/huginn) which provide an interface for interacting with the [unofficial Venmo API](https://github.com/mmohades/VenmoApiDocumentation):

* `ReadVenmoTimelineAgent` - Allows you to monitor your Venmo timeline for new transactions.
* `CreateVenmoTransactionAgent` - Allows you to request money from other users on Venmo.

## Installation
Like any other Huginn agent, you may install this agent by adding the following to your `.env` file:

```
ADDITIONAL_GEMS=huginn_venmo_agent
```

or, if you wish to stay on the bleeding edge:

```
ADDITIONAL_GEMS=huginn_sqlite3_agent(git:https://github.com/stevenleeg/huginn_venmo_agent.git)
```

Each of the agents provided by this gem require a Venmo access token. This part is a bit tricky, but I've included a Rake task that should hopefully make the process easier. After installing the gem, run the following command in the directory Huginn is installed in:

```
$ rake venmo:authenticate
```

You'll be prompted to enter your username, password and possibly a 2FA token in order to generate the access token that can be used with these agents. You'll likely want to store these in a credential that can be reused between multiple agents.

**NOTE:** Your Venmo access token is a very important credential that *must* be kept secret. If a malicious actor were to find this secret, they can do anything you can do with the actual Venmo app. *This includes sending money!* While there are some safeguards in place (ie daily transaction limits), you should be extra super duper careful to ensure this token does not get leaked out of your Huginn instance. I take no responsibility for any security issues that may arise from the usage of this Gem.