https://github.com/picandocodigo/gems_historian
Experiment to save gem's download history
https://github.com/picandocodigo/gems_historian
Last synced: 4 months ago
JSON representation
Experiment to save gem's download history
- Host: GitHub
- URL: https://github.com/picandocodigo/gems_historian
- Owner: picandocodigo
- Created: 2020-04-15T22:12:01.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-25T15:16:29.000Z (about 5 years ago)
- Last Synced: 2025-01-10T04:19:32.505Z (6 months ago)
- Language: Ruby
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rubygems historian
App to save a group of gem's download history.
Copy the `.env` file and edit it to select the gems you want to follow and set up your data storage. You can choose between PostgreSQL and Elasticsearch. For PostgreSQL you need to provide the Database URl. For Elasticsearch you need to provide the Elasticsearch URL `[protocol]://[username]:[password]@[host]:[port]` or if you're using [Elastic Cloud](https://cloud.elastic.co/), provided the Cloud id and credentials:
```bash
$ cp .env{.sample,}
```
If you're using PostgreSQL, the database needs to be created first, then fill in the URL in the `.env` file. There's a rake task to create the necessary table if you're using PostgreSQL:
```bash
$ rake setup
```
The main rake task to update the gem downloads in your data storage is the following:
```bash
$ rake update_gems
```
Ideally you want to schedule this task to run once a day/week/month with cron or similar
## Deploying to Heroku
If you want to use Heroku and PostgreSQL, the app is going to get `ENV['DATABASE_URL']` automatically and connect to Postgres. You need to manually set up the Elasticsearch environment variables with `heroku config:set` or from Heroku's dashboard if you're using Elasticsearch. You also need to set the gems you want to track in the `GEMS` environment variable.
Once it's deployed, remember to run `heroku run rake setup` at least once if you're using PostgreSQL.
I am using [Heroku Scheduler](https://devcenter.heroku.com/articles/scheduler)) to run the data collection every night. Create a new job, choose your schedule and enter this as your Run Command:
```
$ rake update_gems
```