A framework for serverless ruby on top of cloud run and also a collection of services for the farsight service.
bin/local {{service}} {{command}}
bin/local mtgjson-import ls
bin/local mtgjson-import cat Gemfile
Runs an arbitrary command inside of a service.
bin/local-pry {{service}}
bin/local-pry mtgjson-import
Creates a pry session with the entire context of the service loaded.
A service (or sometimes called function) is a singular semi-isolated piece of code that does one job. It has access to the request, the response, the router, a client list, and a database. Using these pieces the service will do some operation.
For example, lets say we wanted a service that cleaned up old data. It would be called on a schedule (every 24h for example), it would pull all old records from the database, transform them to clean versions, and then store them in the database. Finally it would return status 200 (as a show that it completed successfully).
- Go to github.com/difference-engineers/farsight-functions
- Click the "Create new file" button
- Call it "DRAFT"
- Enter the name of your new service into the contents of the file (eg "initial-mtgjson-import")
- Name the branch after the service name (eg "initial-mtgjson-import")
- Click "Commit new file"
- Rename the pull request title to be named after the service name (eg "The mtgjson-import service")
- Detail a little bit of what you want this service to do
- Click the "Create pull request" button
- Click the "Gitpod" button
You'll know the process has worked because once gitpod has fully started your environment you should have a new commit on the pull request history (see: git log). That commit should remove the DRAFT file, add a line to the SERVICES file (with your service name), have created a directory based on the name of your service, and much more.
Sometimes a service will need a specific library that most services wont need. For example, lets say you have a service that turns CSV documents into excel documents. You'll want to add the library like this:
bin/local _base bundle add {{library}} --group={{service}}
bin/local _base bundle add xlsx-reader --group=csv-to-xlsx