ovh-http2sms 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cab24237194aeab0d46e5b7d5bde5679ddca4018ec7f61c47e4bb01e58c7971
-  data.tar.gz: 15ee708e4911827648e2f3f221029b510c2eedf694fd7e4bac34dcd9add7b8ba
+  metadata.gz: 379778cdfb0ec7db8c02be8d631383b38dbb2ed134146ad519161b71e53f7fe5
+  data.tar.gz: d98a196b6193e12001b82a3ca671ab675baabaff8557e8f9d0cd5f6e03930a93
 SHA512:
-  metadata.gz: 232378bd0d9f850989b6c608b1c90b0c1399870f920fb2faf5aaad288b92025b1e099d4bf0a73c903f7245c647c465be6b933dbcf12e7b07a054356db01cce75
-  data.tar.gz: ad6bc71528908dd2ebf9985efa2d6f7d3d720811f1d52624ab9f50311b23df43f2296d949e1110115be1f7e52cf4b0dc972a8ceb81adeca6598d150a2f786f17
+  metadata.gz: 72e97574d9d71b27ca7757811cf448977064edd4f5aa92e9d994e39f951f098e1e7ab0dd0158841e8cc0af4f435c8d77f870ef71dc9624bc31650c44df14eb82
+  data.tar.gz: 70181b9b726da29c98914681f75e037328b9bb7d2094b76b7698d11eaf97f498a0d2aef84037ce67eaac41432e078aa6b117b0f5e97879af518372a158dcd985

data/CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.1] - 2025-01-29
+
+### Added
+
+- Request lifecycle callbacks for monitoring and metrics:
+  - `before_request`: called before each API request with filtered params
+  - `after_request`: called after each request with response
+  - `on_success`: called on successful SMS delivery
+  - `on_failure`: called on failed delivery
+- Dependabot configuration for automated dependency updates
+- Community contribution files:
+  - `CONTRIBUTING.md` with development guidelines
+  - Pull request template
+  - Issue templates for bugs and feature requests
+- `SenderNotFoundError` exception for status 241
+- `ResponseParseError` exception for malformed responses
+
+### Changed
+
+- Improved error handling with more specific exception types
+
 ## [0.1.0] - 2025-01-28
 
 ### Added
@@ -46,5 +67,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Faraday >= 1.0, < 3.0
 - gsm_encoder ~> 0.1.7
 
-[Unreleased]: https://github.com/fkiene/ovh-http2sms/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/fkiene/ovh-http2sms/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/fkiene/ovh-http2sms/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/fkiene/ovh-http2sms/releases/tag/v0.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,90 @@
+# Contributing to OVH HTTP2SMS
+
+Thank you for your interest in contributing! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork locally
+3. Set up the development environment:
+
+```bash
+# With Docker (recommended)
+docker compose run --rm dev
+
+# Without Docker
+bin/setup
+```
+
+## Development Workflow
+
+### Running Tests
+
+```bash
+# With Docker
+docker compose run --rm test
+
+# Without Docker
+bundle exec rspec
+```
+
+### Running Linter
+
+```bash
+# With Docker
+docker compose run --rm lint
+
+# Without Docker
+bundle exec rubocop
+```
+
+### Code Coverage
+
+Tests must maintain 95% minimum code coverage. Coverage reports are generated in the `coverage/` directory.
+
+## Pull Request Process
+
+1. Create a feature branch from `main`:
+   ```bash
+   git checkout -b feature/my-feature
+   ```
+
+2. Make your changes following the code style guidelines
+
+3. Write tests for new functionality
+
+4. Ensure all tests pass and linting is clean:
+   ```bash
+   docker compose run --rm test
+   docker compose run --rm lint
+   ```
+
+5. Commit using [Conventional Commits](https://www.conventionalcommits.org/):
+   - `feat:` for new features
+   - `fix:` for bug fixes
+   - `docs:` for documentation
+   - `test:` for tests
+   - `chore:` for maintenance
+
+6. Push and create a Pull Request
+
+## Code Style
+
+- Follow the existing code patterns
+- Use `frozen_string_literal: true` in all Ruby files
+- Add YARD documentation for public methods
+- Keep methods small and focused
+
+## Reporting Issues
+
+When reporting issues, please include:
+
+- Ruby version
+- Gem version
+- Steps to reproduce
+- Expected vs actual behavior
+- Error messages and stack traces
+
+## Questions?
+
+Open an issue for questions or discussions about the project.

data/README.md

@@ -125,6 +125,36 @@ Ovh::Http2sms.configure do |config|
 end
 ```
 
+### Callbacks
+
+Register callbacks for monitoring, logging, or metrics collection:
+
+```ruby
+Ovh::Http2sms.configure do |config|
+  # Called before each request (params have password filtered)
+  config.before_request do |params|
+    Rails.logger.info("Sending SMS to #{params[:to]}")
+  end
+
+  # Called after each request
+  config.after_request do |response|
+    StatsD.histogram("sms.duration", response_time)
+  end
+
+  # Called on successful delivery
+  config.on_success do |response|
+    StatsD.increment("sms.success")
+    StatsD.gauge("sms.credits", response.credits_remaining)
+  end
+
+  # Called on failed delivery
+  config.on_failure do |response|
+    StatsD.increment("sms.failure", tags: ["error:#{response.error_type}"])
+    Sentry.capture_message("SMS delivery failed: #{response.error_message}")
+  end
+end
+```
+
 ## Usage Examples
 
 ### Basic Send

data/lib/ovh/http2sms/client.rb

@@ -185,12 +185,20 @@ module Ovh
 
       def execute_request(query_params, content_type)
         log_request(query_params)
+        run_before_request_callbacks(query_params)
 
         response = make_http_request(query_params)
         parsed_response = parse_response(response, content_type)
 
         log_response(parsed_response)
-        handle_error_response(parsed_response) if parsed_response.failure?
+        run_after_request_callbacks(parsed_response)
+
+        if parsed_response.failure?
+          run_on_failure_callbacks(parsed_response)
+          handle_error_response(parsed_response)
+        else
+          run_on_success_callbacks(parsed_response)
+        end
 
         parsed_response
       rescue Faraday::Error => e
@@ -248,6 +256,24 @@ module Ovh
           "[OVH HTTP2SMS] Response: status=#{response.status} success=#{response.success?}"
         )
       end
+
+      def run_before_request_callbacks(params)
+        safe_params = params.dup
+        safe_params[:password] = "[FILTERED]"
+        @config.before_request_callbacks.each { |callback| callback.call(safe_params) }
+      end
+
+      def run_after_request_callbacks(response)
+        @config.after_request_callbacks.each { |callback| callback.call(response) }
+      end
+
+      def run_on_success_callbacks(response)
+        @config.on_success_callbacks.each { |callback| callback.call(response) }
+      end
+
+      def run_on_failure_callbacks(response)
+        @config.on_failure_callbacks.each { |callback| callback.call(response) }
+      end
     end
   end
 end

data/lib/ovh/http2sms/configuration.rb

@@ -46,6 +46,18 @@ module Ovh
       # @return [String] API endpoint URL
       attr_accessor :api_endpoint
 
+      # @return [Array<Proc>] Callbacks executed before each request
+      attr_reader :before_request_callbacks
+
+      # @return [Array<Proc>] Callbacks executed after each request
+      attr_reader :after_request_callbacks
+
+      # @return [Array<Proc>] Callbacks executed on successful delivery
+      attr_reader :on_success_callbacks
+
+      # @return [Array<Proc>] Callbacks executed on failed delivery
+      attr_reader :on_failure_callbacks
+
       # Environment variable prefix
       ENV_PREFIX = "OVH_SMS_"
 
@@ -62,6 +74,15 @@ module Ovh
         reset!
       end
 
+      # Ensure callbacks are properly duplicated
+      def initialize_dup(other)
+        super
+        @before_request_callbacks = other.before_request_callbacks.dup
+        @after_request_callbacks = other.after_request_callbacks.dup
+        @on_success_callbacks = other.on_success_callbacks.dup
+        @on_failure_callbacks = other.on_failure_callbacks.dup
+      end
+
       # Reset configuration to defaults and environment variables
       #
       # @return [void]
@@ -78,10 +99,69 @@ module Ovh
         self.default_sender = nil
         self.logger = nil
 
+        # Reset callbacks
+        @before_request_callbacks = []
+        @after_request_callbacks = []
+        @on_success_callbacks = []
+        @on_failure_callbacks = []
+
         # Load from environment variables
         load_from_env
       end
 
+      # Register a callback to be executed before each request
+      #
+      # @yield [Hash] The request parameters (with password filtered)
+      # @return [void]
+      #
+      # @example Log all requests
+      #   config.before_request do |params|
+      #     Rails.logger.info("Sending SMS to #{params[:to]}")
+      #   end
+      def before_request(&block)
+        @before_request_callbacks << block if block_given?
+      end
+
+      # Register a callback to be executed after each request
+      #
+      # @yield [Response] The parsed response object
+      # @return [void]
+      #
+      # @example Track metrics
+      #   config.after_request do |response|
+      #     StatsD.increment("sms.sent", tags: ["status:#{response.status}"])
+      #   end
+      def after_request(&block)
+        @after_request_callbacks << block if block_given?
+      end
+
+      # Register a callback to be executed on successful delivery
+      #
+      # @yield [Response] The successful response object
+      # @return [void]
+      #
+      # @example Track success
+      #   config.on_success do |response|
+      #     StatsD.increment("sms.success")
+      #     StatsD.gauge("sms.credits", response.credits_remaining)
+      #   end
+      def on_success(&block)
+        @on_success_callbacks << block if block_given?
+      end
+
+      # Register a callback to be executed on failed delivery
+      #
+      # @yield [Response] The failed response object
+      # @return [void]
+      #
+      # @example Track failures
+      #   config.on_failure do |response|
+      #     StatsD.increment("sms.failure", tags: ["error:#{response.error_type}"])
+      #   end
+      def on_failure(&block)
+        @on_failure_callbacks << block if block_given?
+      end
+
       # Check if the configuration is valid for making API requests
       #
       # @return [Boolean] true if required fields are present

data/lib/ovh/http2sms/version.rb

@@ -2,6 +2,6 @@
 
 module Ovh
   module Http2sms
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ovh-http2sms
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - François Kiene
@@ -153,6 +153,7 @@ files:
 - ".dockerignore"
 - ".env.example"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Dockerfile
 - Gemfile
 - LICENSE.txt