munawaba 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0bf83751032de6ab765beb58bbf460458aa1ed40c741f1e7d3b374b34f3fc40c
+  data.tar.gz: b3424f9e8bb2aeda96b2025a327c444c7274ba10e7dbb219afa361033740da68
+SHA512:
+  metadata.gz: fba5128fdd913315d4da643992d692b2d92fde81e82a5cad213fddd60cc634a9f803b420210a150aafb601d6b7fcb251c7f9ba51815f6b6b83ca0aeb9885e79f
+  data.tar.gz: f9d7ba2beb432dce59a61c6100260daae71ff10633d7a548affec37200fe0a818783865e918ea83a1c7494c8817b39ef79f09ea899dd4f7fd4d0564ce84f7a7e

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.1.0
+
+Initial release.
+
+- People, ordered rotations, local-time handoffs, and whole-shift overrides.
+- Change previews with cross-schedule conflict warnings.
+- Agenda and month calendars showing current and upcoming coverage.
+- Slack reminders and assignment notifications, with delivery history and retries.
+- Activity history with optional actor attribution.
+- Light and dark dashboard themes.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MilkStraw AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,160 @@
+<p align="center">
+  <img src="docs/logo.png" alt="Munawaba logo" width="160">
+</p>
+
+<h1 align="center">Munawaba</h1>
+
+<p align="center">
+  <a href="LICENSE.txt"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
+  <a href="#requirements"><img src="https://img.shields.io/badge/ruby-%3E%3D%203.4-blue" alt="Ruby >= 3.4"></a>
+  <a href="#requirements"><img src="https://img.shields.io/badge/rails-8.1-red" alt="Rails 8.1"></a>
+  <a href="#requirements"><img src="https://img.shields.io/badge/postgresql-%3E%3D%2015-336791" alt="PostgreSQL >= 15"></a>
+</p>
+
+<p align="center">
+  <strong>On-call rotations inside your Rails application.</strong>
+</p>
+
+Munawaba helps your team share on-call duty. Build a rotation, see who's on call, and cover a teammate's shift when plans change. Connect Slack to announce handoffs and assignment changes.
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Dashboard](#dashboard)
+- [Background Jobs](#background-jobs)
+- [Scope](#scope)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Requirements
+
+- Ruby 3.4+
+- Rails 8.1
+- PostgreSQL 15+
+
+See the [compatibility matrix](CONTRIBUTING.md#compatibility-and-ci) for tested combinations.
+
+## Installation
+
+Add Munawaba to your host application's Gemfile:
+
+```ruby
+gem "munawaba"
+```
+
+```sh
+bundle install
+bin/rails generate munawaba:install
+```
+
+The generator creates an initializer and copies the migrations. For an existing installation, follow [upgrading](docs/usage.md#upgrading).
+
+Mount the dashboard:
+
+```ruby
+# config/routes.rb
+mount Munawaba::Engine => "/on-call"
+```
+
+Configure access using your application's authentication and authorization. This example uses `authenticate_user!` and `current_user`:
+
+```ruby
+# config/initializers/munawaba.rb
+Munawaba.configure do |config|
+  config.authenticate = ->(controller) do
+    controller.send(:authenticate_user!)
+    controller.current_user.present?
+  end
+  config.authorize = ->(controller, _action, _record) { controller.current_user.admin? }
+  config.actor = ->(controller) do
+    user = controller.current_user
+    { type: "User", id: user.id.to_s, name: user.name }
+  end
+  config.application_base_url = "https://example.com/on-call"
+  config.notifications_enabled = false
+end
+```
+
+Access is denied until both callbacks are configured to return `true`. The optional `actor` callback identifies who made each change in Activity. See [access](docs/usage.md#access) and [configuration](docs/usage.md#configuration) for the full reference.
+
+```sh
+bin/rails db:migrate
+```
+
+The migration enables `btree_gist` automatically for shift overlap checks. If it is missing and your database restricts extension creation, ask your database administrator to enable it first.
+
+Follow [Slack setup](docs/usage.md#slack-notifications) to enable notifications and send your first test message.
+
+## Dashboard
+
+Open `/on-call` in your host application after installation. The dashboard provides:
+
+- People and ordered rotations with one-week, two-week, or calendar-month schedules.
+- Current coverage, upcoming handoffs, and agenda or month calendars.
+- Previews before activation, rotation changes, and whole-shift overrides, including cross-schedule conflict warnings.
+- Activity history and per-schedule Slack settings and delivery history.
+
+### Overview
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/overview-dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="docs/screenshots/overview-light.png">
+  <img src="docs/screenshots/overview-dark.png" alt="Munawaba overview showing current coverage and upcoming handoffs">
+</picture>
+
+### Calendar
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/calendar-dark.png">
+  <source media="(prefers-color-scheme: light)" srcset="docs/screenshots/calendar-light.png">
+  <img src="docs/screenshots/calendar-dark.png" alt="Munawaba month calendar showing scheduled on-call coverage">
+</picture>
+
+See [using the dashboard](docs/usage.md#dashboard) for roster changes, previews, and calendars.
+
+## Background Jobs
+
+Schedule these two jobs using your host's Active Job adapter and recurring scheduler. All jobs use `job_queue_name`.
+
+| Frequency    | Job                               | Work                                                                                              |
+| ------------ | --------------------------------- | ------------------------------------------------------------------------------------------------- |
+| Every minute | `Munawaba::MaintenanceJob`        | Apply scheduled starts and pauses, recover interrupted deliveries, and dispatch due notifications |
+| Daily        | `Munawaba::MaintainProjectionJob` | Refresh future timings and extend scheduled coverage                                              |
+
+With [GoodJob](https://github.com/bensheldon/good_job#cron-style-repeatingrecurring-jobs), add these entries to your cron configuration:
+
+```ruby
+# config/initializers/good_job.rb
+Rails.application.configure do
+  config.good_job.cron = {
+    munawaba_maintenance: { cron: "* * * * *", class: "Munawaba::MaintenanceJob" },
+    munawaba_projection: { cron: "0 0 * * *", class: "Munawaba::MaintainProjectionJob" }
+  }
+end
+```
+
+Start the worker with cron enabled:
+
+```sh
+bundle exec good_job start --enable-cron
+```
+
+See [maintenance](docs/usage.md#maintenance) for troubleshooting and timezone-data updates.
+
+## Scope
+
+Munawaba manages on-call schedules for one workspace. Overrides cover a whole shift, and conflicts between schedules appear as warnings for you to review.
+
+## Documentation
+
+[Usage and reference](docs/usage.md) covers scheduling, access, configuration, Slack delivery, and maintenance. See the [changelog](CHANGELOG.md) for releases.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the local demo, development setup, and test commands. Report security issues as described in [SECURITY.md](SECURITY.md).
+
+## License
+
+[MIT License](LICENSE.txt).

data/SECURITY.md

@@ -0,0 +1,15 @@
+# Security
+
+## Reporting a vulnerability
+
+Report vulnerabilities privately to [the maintainer](mailto:aliosm1997@gmail.com). Include the affected version, impact, and a minimal reproduction. Omit webhook URLs, encryption keys, and session data.
+
+## Access and credentials
+
+Configure authentication and authorization before mounting the dashboard for your team. The [access reference](docs/usage.md#access) describes the capabilities, including actions that affect several schedules. Controller callbacks govern dashboard requests; call `Munawaba::Commands` from trusted application code.
+
+For Slack encryption and delivery troubleshooting, see [Slack notifications](docs/usage.md#slack-notifications).
+
+## Checks
+
+See [contributor security checks](CONTRIBUTING.md#security-checks) for static analysis and dependency auditing.

data/app/assets/munawaba/INTER-LICENSE.txt

@@ -0,0 +1,92 @@
+Copyright (c) 2016 The Inter Project Authors (https://github.com/rsms/inter)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION AND CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

data/app/assets/munawaba/JETBRAINS-MONO-LICENSE.txt

@@ -0,0 +1,93 @@
+Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.