https://github.com/joenas/huginn_github_notifications_agent

Huginn agent to fetch Github notifications
https://github.com/joenas/huginn_github_notifications_agent

huginn huginn-agent

Last synced: about 2 months ago
JSON representation

Huginn agent to fetch Github notifications

• Host: GitHub
• URL: https://github.com/joenas/huginn_github_notifications_agent
• Owner: joenas
• License: mit
• Created: 2017-08-14T11:39:01.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-10-05T05:50:39.000Z (about 3 years ago)
• Last Synced: 2024-04-25T10:22:10.147Z (8 months ago)
• Topics: huginn, huginn-agent
• Language: Ruby
• Size: 32.2 KB
• Stars: 4
• Watchers: 4
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# GithubNotificationsAgent

Huginn agent to fetch Github notifications

## Installation

Add this string to your Huginn's .env `ADDITIONAL_GEMS` configuration:

```ruby

huginn_github_notifications_agent

# when only using this agent gem it should look like hits:

ADDITIONAL_GEMS=huginn_github_notifications_agent

# if you want to use the latest, non-released code (master) add this instead:

ADDITIONAL_GEMS=huginn_github_notifications_agent(github: joenas/huginn_github_notifications_agent)

```

And then execute:

    $ bundle

## Usage

The GithubNotificationsAgent fetches your notifications from Github.

You need to create a [personal access token](https://github.com/settings/tokens) to use this, only the `notifications` scope is necessary.

To emit all new notifications as a single event, change `events` to `single`. The event key will be `notifications`.

To fetch all (unread) notifications, change `last_modified` to `false`. Default behaviour is to only fetch notifications that are updated since last run.

More options might be added for the [API](https://developer.github.com/v3/activity/notifications/#list-your-notifications).

This agent also adds two more fields to `subject` in the response, `url_web` and `repo_name`. These are for convenience, if you want to link to the updated resource for example.

```json

"subject": {

  "url_web": "https://github.com/joenas/huginn_github_notifications/pull/1234",

  "repo_name": "joenas/huginn_github_notifications"

}

```

## Development

Running `rake` will clone and set up Huginn in `spec/huginn` to run the specs of the Gem in Huginn as if they would be build-in Agents. The desired Huginn repository and branch can be modified in the `Rakefile`:

```ruby

HuginnAgent.load_tasks(branch: '', remote: 'https://github.com//huginn.git')

```

Make sure to delete the `spec/huginn` directory and re-run `rake` after changing the `remote` to update the Huginn source code.

After the setup is done `rake spec` will only run the tests, without cloning the Huginn source again.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

1. Fork it ( https://github.com/joenas/huginn_github_notifications_agent/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request