{"id":36236645,"url":"https://github.com/jbox-web/redmine_pusher_notifications","last_synced_at":"2026-01-11T06:00:55.744Z","repository":{"id":17515163,"uuid":"20303118","full_name":"jbox-web/redmine_pusher_notifications","owner":"jbox-web","description":"A Redmine plugin which makes notifying your Redmine instance easy ;)","archived":true,"fork":false,"pushed_at":"2018-05-09T03:47:45.000Z","size":599,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":8,"default_branch":"devel","last_synced_at":"2025-03-13T07:01:58.212Z","etag":null,"topics":["notifications","pusher","rails","redmine","redmine-plugin","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jbox-web.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-05-29T18:02:08.000Z","updated_at":"2022-03-23T02:39:18.000Z","dependencies_parsed_at":"2022-08-04T19:30:32.645Z","dependency_job_id":null,"html_url":"https://github.com/jbox-web/redmine_pusher_notifications","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/jbox-web/redmine_pusher_notifications","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbox-web%2Fredmine_pusher_notifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbox-web%2Fredmine_pusher_notifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbox-web%2Fredmine_pusher_notifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbox-web%2Fredmine_pusher_notifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jbox-web","download_url":"https://codeload.github.com/jbox-web/redmine_pusher_notifications/tar.gz/refs/heads/devel","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbox-web%2Fredmine_pusher_notifications/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28293188,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T04:44:51.577Z","status":"ssl_error","status_checked_at":"2026-01-11T04:44:44.232Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["notifications","pusher","rails","redmine","redmine-plugin","ruby"],"created_at":"2026-01-11T06:00:49.157Z","updated_at":"2026-01-11T06:00:55.730Z","avatar_url":"https://github.com/jbox-web.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"## ![logo](https://raw.github.com/jbox-web/redmine_pusher_notifications/gh-pages/images/pusher_logo.png) Redmine Pusher Notifications Plugin\n\n[![GitHub license](https://img.shields.io/github/license/jbox-web/redmine_pusher_notifications.svg)](https://github.com/jbox-web/redmine_pusher_notifications/blob/devel/LICENSE)\n[![GitHub release](https://img.shields.io/github/release/jbox-web/redmine_pusher_notifications.svg)](https://github.com/jbox-web/redmine_pusher_notifications/releases/latest)\n[![Code Climate](https://codeclimate.com/github/jbox-web/redmine_pusher_notifications.png)](https://codeclimate.com/github/jbox-web/redmine_pusher_notifications)\n\n### A Redmine plugin which makes notifying your Redmine instance, easy ;)\n\nThis plugin is designed to integrate the [Pusher Notification System](http://pusher.com) in Redmine to display nice notifications in Growl style.\n\nIt aims to serve as a central point to store Pusher configuration.\n\nIt relies on the  [acts_as_notifiable_redmine](https://github.com/jbox-web/acts_as_notifiable_redmine) gem so plugins developpers can access to the DSL provided to register their own channels and events (see the doc below).\n\nThe [acts_as_notifiable_redmine](https://github.com/jbox-web/acts_as_notifiable_redmine) also provides a method to send **asynchronous** notifications via Pusher.\n\nIt also relies on [gritter](https://github.com/RobinBrouwer/gritter) gem to display notifications so plugins developpers also have access to its functionalities in their controllers like [```gflash```](https://github.com/RobinBrouwer/gritter#gflash) **synchronous** notifications ;).\n\nYou can take a look to the [```pusher```](https://github.com/jbox-web/redmine_pusher_notifications/blob/devel/app/controllers/pusher_controller.rb) controller which implements the both methods.\n\n![screenshot](https://raw.github.com/jbox-web/redmine_pusher_notifications/gh-pages/images/screenshot.png)\n\n## Requirements\n\n* Ruby 1.9.x or 2.0.x\n* a working [Redmine](http://www.redmine.org/) installation\n* a free account on [Pusher](http://pusher.com)\n* [acts_as_notifiable_redmine](https://github.com/jbox-web/acts_as_notifiable_redmine) gem\n* [gritter](https://github.com/RobinBrouwer/gritter) gem\n\n## Installation\n\n```sh\n## Before install the plugin, stop Redmine!\n\nroot$ su - redmine\nredmine$ cd REDMINE_ROOT/plugins\nredmine$ git clone https://github.com/jbox-web/redmine_bootstrap_kit.git\nredmine$ git clone https://github.com/jbox-web/redmine_pusher_notifications.git\nredmine$ cd redmine_pusher_notifications/\nredmine$ git checkout v1.0.2\nredmine$ cd REDMINE_ROOT\nredmine$ bundle install\n\n## After install the plugin, start Redmine!\n```\n\n## Configuration\n\nGo to the plugin settings page within Redmine interface to configure your Pusher account informations. That's all!\n\n## Usage\n\nIf you want to integrate Pusher async notifications in your plugin, or just Gitter with ```gflash``` you may need to register your own channels and events in your ```init.rb``` file : each channel can have many events. It may also have an optional ```target``` parameter which can be a string or a Proc.\n\n```ruby\n## This must be OUTSIDE of the Redmine::Plugin.register block\n\nActsAsNotifiableRedmine::Notifications.register_channel :channel_test do\n  target Proc.new { User.current.login }\n  event  :event1, :sticky =\u003e true\n  event  :event2, :sticky =\u003e false\n  event  :event3\nend\n\nActsAsNotifiableRedmine::Notifications.register_channel :broadcast do\n  target 'broadcast'\n  event  :event1, :sticky =\u003e true\n  event  :event2, :sticky =\u003e false\n  event  :event3\nend\n```\n\nThen to send notifications you have 2 options :\n* **asynchronous** notifications via Pusher\n* **synchronous** notifications sent by the controller\n\nFor **asynchronous** notifications :\n\n```ruby\nActsAsNotifiableRedmine::Notifications.send_notification([channel.token], event.name, {:title =\u003e 'Hello!', :message =\u003e 'This is a test message !'})\n```\n\n**Note :** The logic to determine wether or not to send a notification is let to the developer. You can easily do this with callbacks :\n\n```ruby\nclass Comment \u003c ActiveRecord::Base\n  has_many :watchers\n  after_create :send_notification\n\n  private\n\n    def send_notification\n      channels = []\n      watchers.each do |watcher|\n        token = '\u003cchannel_name\u003e-' + watcher.login\n        channels.push(token)\n      end\n      ActsAsNotifiableRedmine::Notifications.send_notification(channels, \u003cevent_name\u003e, {:title =\u003e 'Hello!', :message =\u003e 'This is a test message !'})\n    end\nend\n```\n\nFor **synchronous** notifications :\n\nIn a controller :\n\n```ruby\ndef test\n  data = {}\n  data[:message] = 'Hello!'\n  data[:sticky] = true\n  data[:image] = \"\u003cimg class=\\\"gritter-image\\\" src=\\\"/plugin_assets/redmine_pusher_notifications/images/ok.png\\\"\u003e\"\n  gflash :now, :success =\u003e { :value =\u003e data[:message], :sticky =\u003e data[:sticky], :image =\u003e data[:image] }\nend\n```\n\nIn a JS partial :\n\n```ruby\n$(document).ready(function() {\n  \u003c%= gflash :js =\u003e true %\u003e\n});\n```\n\nIn a HTML partial :\n\n```ruby\n\u003c%= link_to 'Test me!', test_path, :remote =\u003e true %\u003e\n```\n\nFor more details, take a look at [gritter](https://github.com/RobinBrouwer/gritter#gflash).\n\n## Contribute\n\nYou can contribute to this plugin in many ways such as :\n* Helping with documentation\n* Contributing code (features or bugfixes)\n* Reporting a bug\n* Submitting translations\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbox-web%2Fredmine_pusher_notifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjbox-web%2Fredmine_pusher_notifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbox-web%2Fredmine_pusher_notifications/lists"}