https://github.com/mmenanno/lunchmoney
An API client library of the LunchMoney API
https://github.com/mmenanno/lunchmoney
api-client gem lunchmoney ruby ruby-gem
Last synced: about 1 year ago
JSON representation
An API client library of the LunchMoney API
- Host: GitHub
- URL: https://github.com/mmenanno/lunchmoney
- Owner: mmenanno
- License: mit
- Created: 2021-07-13T02:50:16.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T21:56:30.000Z (about 1 year ago)
- Last Synced: 2025-04-11T04:08:06.222Z (about 1 year ago)
- Topics: api-client, gem, lunchmoney, ruby, ruby-gem
- Language: Ruby
- Homepage: https://mmenanno.github.io/lunchmoney/
- Size: 6.94 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-lunchmoney - lunchmoney: An API client library of the LunchMoney API - This gem is a API client library of the LunchMoney APIg. - (by Michael Menanno). (Client SDKs and Language Specific API Wrappers / For the [V1 API](https://lunchmoney.app))
README
# lunchmoney
[](https://badge.fury.io/rb/lunchmoney)
[](https://github.com/mmenanno/lunchmoney/actions/workflows/ci.yml)
[](https://github.com/mmenanno/lunchmoney/actions/workflows/build_and_publish_yard_docs.yml)
[](https://codeclimate.com/github/mmenanno/lunchmoney/maintainability)
[](https://codeclimate.com/github/mmenanno/lunchmoney/test_coverage)
This gem is a API client library of the [LunchMoney API](https://lunchmoney.dev/) for the wonderful [LunchMoney](http://lunchmoney.app/) web app for personal finance & budgeting.
Documentation is still a work in process, but you can find the yard docs for this gem [here](https://mmenanno.github.io/lunchmoney/) as well as some write ups of the basics below. An example of every call is listed on the [Api class in the yard docs](https://mmenanno.github.io/lunchmoney/LunchMoney/Api.html).
## Usage
### Installation
Add this line to your application's `Gemfile`:
```Ruby
gem "lunchmoney"
```
### Set your lunchmoney token
There are a few ways you can set your API token. You can set it manually using a configure block:
```Ruby
LunchMoney.configure do |config|
config.api_key = "your_api_key"
end
```
The config will also _automatically_ pull in the token if set via environment variable named `LUNCHMONEY_TOKEN`
You can also override the config and set your LunchMoney token for a specific API instance via kwarg:
```Ruby
LunchMoney::Api.new(api_key: "your_api_key")
```
### Using the API
It is intended that all calls typically go through a `LunchMoney::Api` instannce. This class delegates methods to their
relvant classes behind the scenes. Create an instance of the api, then call the endpoint you need:
```Ruby
api = LunchMoney::Api.new
api.categories
```
When the api returns an error a `LunchMoney::Errors` object will be returned. You can check the errors that occured via
`.messages` on the instance. This will return an array of errors.
```Ruby
api = LunchMoney::Api.new
response = api.categories
response.class
=> LunchMoney::Errors
response.messages
=> ["Some error returned by the API"]
```
The instance itself has been set up to act like an array, delegating a lot of common array getter methods directly to
messages for you. This enables things like:
```Ruby
api = LunchMoney::Api.new
response = api.categories
response.class
=> LunchMoney::Errors
response.first
=> "Some error returned by the API"
response.empty?
=> false
response[0]
=> "Some error returned by the API"
```
## Contributing to this repo
Feel free to contribute and submit PRs to improve this gem
## Releasing a new gem version
1. Bump the `VERSION` constant in `lib/lunchmoney/version.rb`
2. Run `bundle install`
3. Commit and push up the change in a PR
4. Merge the PR
5. Create a new tag and release with the name version as v0.0.0
6. A Github action will kick off and publish the new gem version