actionwebpush 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51cb63d596feca886277a0250aafac6390f5e20d46e90a846a23ab92ab39656c
+  data.tar.gz: cc5610b7429e76b0976e80192ecac7d4dcca5522c6959919675ed4b05dd4baae
+SHA512:
+  metadata.gz: 8336fb0ccc3c877db99b20e36032535fe3c07cdb13f98d4129ad2dd64777801648271483189813fff7c917be92e47b4f788da6c1b6d1a216a7338943bf24e4a3
+  data.tar.gz: 98945510bf3e1f82fdd2e48115b9cd57edb0779257c273d0ac5ea24325513c6f408708812c9c385b402732fae32b3a4c6d3ca253ca6d0d2dfc5ba877af5fb7c4

data/.ruby-version

@@ -0,0 +1 @@
+3.4.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at keshavkk.musafir@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,256 @@
+# Contributing to ActionWebPush
+
+Thank you for your interest in contributing to ActionWebPush! This document provides guidelines and information for contributors.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Making Changes](#making-changes)
+- [Testing](#testing)
+- [Submitting Changes](#submitting-changes)
+- [Release Process](#release-process)
+
+## Code of Conduct
+
+This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## Getting Started
+
+1. Fork the repository on GitHub
+2. Clone your fork locally
+3. Set up the development environment
+4. Create a feature branch for your changes
+
+## Development Setup
+
+### Prerequisites
+
+- Ruby 2.6.0 or higher
+- Rails 6.0 or higher
+- Redis (for rate limiting tests)
+- Git
+
+### Setup
+
+```bash
+# Clone your fork
+git clone https://github.com/yourusername/actionwebpush.git
+cd actionwebpush
+
+# Install dependencies
+bundle install
+
+# Run tests to ensure everything works
+bundle exec rake test
+```
+
+### Development Dependencies
+
+The gem uses these development tools:
+- **Minitest** for testing
+- **SQLite3** for test database
+- **Resque** for background job testing
+- **WebMock** for HTTP mocking in tests
+
+## Making Changes
+
+### Branch Naming
+
+Use descriptive branch names:
+- `feature/add-batch-delivery`
+- `fix/rate-limiter-race-condition`
+- `docs/update-readme`
+
+### Code Style
+
+- Follow Ruby community standards
+- Use 2 spaces for indentation
+- Keep lines under 120 characters
+- Add comments for complex logic
+- Use descriptive variable and method names
+
+### Commit Messages
+
+Write clear, descriptive commit messages:
+```
+Add batch delivery optimization for large subscription lists
+
+- Implement batching logic in BatchDelivery class
+- Add configuration option for batch size
+- Include tests for batch processing
+- Update documentation with batch delivery examples
+
+Fixes #42
+```
+
+## Testing
+
+### Running Tests
+
+```bash
+# Run all tests
+bundle exec rake test
+
+# Run specific test file
+bundle exec ruby test/notification_test.rb
+
+# Run tests with coverage
+bundle exec rake test:coverage
+```
+
+### Test Structure
+
+- **Unit tests**: Test individual classes and methods
+- **Integration tests**: Test component interactions
+- **System tests**: Test end-to-end functionality
+
+### Writing Tests
+
+- Write tests for new features
+- Ensure edge cases are covered
+- Mock external dependencies (WebPush API calls)
+- Use descriptive test names
+
+Example:
+```ruby
+def test_notification_delivery_with_expired_subscription
+  # Test setup
+  # Test execution
+  # Assertions
+end
+```
+
+### Test Requirements
+
+- All new code must have tests
+- Maintain or improve test coverage
+- Tests must pass on Ruby 2.6+ and Rails 6.0+
+
+## Submitting Changes
+
+### Pull Request Process
+
+1. **Update documentation** if your changes affect the public API
+2. **Add tests** for new functionality
+3. **Update CHANGELOG.md** with your changes
+4. **Ensure all tests pass**
+5. **Create a pull request** with:
+   - Clear title and description
+   - Reference to related issues
+   - Screenshots/examples if applicable
+
+### Pull Request Template
+
+```markdown
+## Description
+Brief description of changes
+
+## Type of Change
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change
+- [ ] Documentation update
+
+## Testing
+- [ ] Tests added/updated
+- [ ] All tests pass
+- [ ] Manual testing completed
+
+## Checklist
+- [ ] Code follows project style guidelines
+- [ ] Self-review completed
+- [ ] Documentation updated
+- [ ] CHANGELOG.md updated
+```
+
+### Review Process
+
+- Maintainers will review your PR
+- Address feedback promptly
+- Be open to suggestions and changes
+- Once approved, your PR will be merged
+
+## Types of Contributions
+
+### Bug Reports
+
+When reporting bugs, include:
+- Ruby and Rails versions
+- Gem version
+- Steps to reproduce
+- Expected vs actual behavior
+- Error messages/stack traces
+
+### Feature Requests
+
+For new features:
+- Describe the use case
+- Explain why it's valuable
+- Consider backwards compatibility
+- Provide implementation ideas if possible
+
+### Documentation
+
+Documentation improvements are always welcome:
+- Fix typos and grammar
+- Add examples
+- Improve clarity
+- Translate content
+
+### Code Contributions
+
+Areas where contributions are especially welcome:
+- Performance optimizations
+- Additional delivery methods
+- Better error handling
+- Enhanced configuration options
+- More comprehensive tests
+
+## Release Process
+
+1. Update version in `lib/actionwebpush/version.rb`
+2. Update `CHANGELOG.md` with release notes
+3. Create git tag for version
+4. Build and push gem to RubyGems
+5. Create GitHub release with notes
+
+## Development Guidelines
+
+### Adding New Features
+
+1. **Discuss first**: Open an issue to discuss major features
+2. **Design consideration**: Consider impact on existing API
+3. **Documentation**: Update README and API docs
+4. **Tests**: Comprehensive test coverage required
+5. **Examples**: Add usage examples
+
+### Maintaining Backward Compatibility
+
+- Avoid breaking changes in minor versions
+- Deprecate features before removing them
+- Provide migration paths for breaking changes
+- Document any compatibility requirements
+
+### Performance Considerations
+
+- Profile performance-critical code
+- Consider memory usage in long-running processes
+- Test with realistic data volumes
+- Document performance characteristics
+
+## Getting Help
+
+- **Issues**: Use GitHub issues for bugs and feature requests
+- **Discussions**: Use GitHub discussions for questions
+- **Email**: Contact maintainers for security issues
+
+## Recognition
+
+Contributors will be:
+- Listed in the gem's credits
+- Mentioned in release notes for significant contributions
+- Invited to be maintainers for consistent, high-quality contributions
+
+Thank you for contributing to ActionWebPush! 🚀

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Keshav Kk
+
+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.