gitnotifier/ruby

Git Notifier 镜像文档

镜像概述

Git Notifier是一个Docker化的Sinatra应用，旨在为GitHub用户提供邮件通知服务，用于接收各类GitHub事件提醒。用户可通过GitHub OAuth注册，并自定义通知类型和频率（即时、每日或每周报告）。该镜像支持开发、CI和生产环境，使用统一的容器配置。

核心功能与特性

支持的GitHub事件

• 用户为您的仓库添加星标
• 用户复刻您的仓库
• 用户开始关注您
• 用户取消关注您
• 关注您的用户账号被删除

通知功能

• 通过OAuth集成GitHub账号
• 自定义通知类型选择
• 灵活的通知频率设置：
  • 即时（asap）
  • 每日报告
  • 每周报告

使用场景

• 开发者需要实时或定期了解GitHub仓库的互动情况（如星标、分支）
• 用户希望追踪关注者变化（新增关注、取消关注、关注者账号删除）
• 团队需要汇总GitHub活动报告，用于项目管理或统计分析

使用方法

环境准备

1. 复制配置文件模板：

   bash
   cp config/docker.env.example config/docker.env
   

2. 编辑config/docker.env文件，配置必要的环境变量（如GitHub OAuth密钥、邮件服务设置等）

启动服务

使用docker-compose启动所有依赖服务：

bash
docker-compose up  # 可添加-d参数后台运行

启动后，将运行以下服务：

• nginx（监听主机80端口）
• sidekiq（任务队列）
• puma（应用服务器）
• redis（数据存储）

手动触发通知检查

注册用户后，可手动触发通知检查或邮件发送：

bash
docker exec githubnotifier_sidekiq_1 bundle exec ruby /usr/src/app/scripts/job_enqueuer.rb

循环执行任务

项目根目录提供Dockerfile_enqueuer，可用于创建循环执行上述任务的容器。

部署

部署详情请参考：https://github.com/andreausu/gitnotifier-provisioning

测试

项目包含casperjs功能测试，本地可按以下方式运行：

未认证测试

bash
casperjs test test/casper/unauthenticated.js

已认证测试

bash
casperjs test test/casper/authenticated.js --cookie=rack.session-cookie的值

注册流程测试

bash
casperjs test test/casper/signup.js --username=github用户名 --password=github密码  # 确保Redis数据库为全新状态

注：目前测试主要确保基本功能未受代码提交影响，未来计划通过模拟GitHub API和Redis调用构建完整单元测试套件。

许可证

本项目采用MIT许可证发布，完整许可信息见：LICENSE

代码贡献

若需添加需讨论的功能，请先创建issue；其他情况可按以下流程贡献代码：

1. Fork项目（参考：http://help.github.com/fork-a-repo/%EF%BC%89
2. 创建功能分支（git checkout -b my_branch）
3. 推送更改到分支（git push origin my_branch）
4. 在GitHub发起Pull Request（参考：http://help.github.com/send-pull-requests/%EF%BC%89
5. 代码将经过审核，通过后合并

感谢您的贡献！