alertus-ruby-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30effb2e64c3fed5a76343906b72aab694c3e9b9a056245be6263c0821a56fd5
+  data.tar.gz: d24218de91683fcb5e2e2281f6dce08d67f57de17de5f35b6c111a254376687b
+SHA512:
+  metadata.gz: 0a1ea77ac9fa9b1cb92b097c726fe43af916ced4c2b1bb46ee4450b2fa522ae7ce1cda14fe2b3e57fc3b2e8864680f0fc572f9bb8ed82cc35afdaffbc31a9bb0
+  data.tar.gz: c37f9c71a249db1412ba2f574c8510e9f9da498ee5b6519a97c6047d5bbf9aff35a32552b16bd56b2c77e2ae22cc1b615fac085947adf85da1e6c94abd75e00c

data/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+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,179 @@
+# Alertus Ruby SDK
+
+[![Gem Version](https://badge.fury.io/rb/alertus-ruby-sdk.svg)](https://badge.fury.io/rb/alertus-ruby-sdk)
+[![Build Status](https://github.com/alertus/alertus-ruby-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/alertus/alertus-ruby-sdk/actions)
+[![Maintainability](https://api.codeclimate.com/v1/badges/.../maintainability)](https://codeclimate.com/github/alertus/alertus-ruby-sdk/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/.../coverage)](https://codeclimate.com/github/alertus/alertus-ruby-sdk/test_coverage)
+
+Official Ruby client for the Alertus notification platform. Send push notifications to Android and iOS devices with Firebase Cloud Messaging (FCM) through a simple, idiomatic Ruby API.
+
+## Features
+
+- 🚀 Simple and intuitive Ruby API
+- 🔒 Secure API key authentication
+- 📱 Multi-platform push notifications (Android, iOS)
+- 📊 Detailed delivery reports and error handling
+- 🛠️ Customizable notification payloads
+- ⚡ Thread-safe with connection pooling
+- 🧪 Comprehensive test coverage with RSpec
+- 📦 Minimal dependencies
+
+## Requirements
+
+- Ruby 2.7 or higher
+- Valid Alertus API key from the [Alertus Console](https://console.alertus.cloud)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alertus-ruby-sdk'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install alertus-ruby-sdk
+```
+
+## Quick Start
+
+1. Get your API key from the [Alertus Console](https://console.alertus.cloud)
+2. Initialize the client with your API key
+3. Create and send notifications
+
+```ruby
+require 'alertus'
+
+# Initialize client with default options
+client = Alertus::Client.new(ENV['ALERTUS_API_KEY'])
+
+# Or configure with custom options
+client = Alertus::Client.new(ENV['ALERTUS_API_KEY'],
+  base_url: 'https://api.alertus.cloud',
+  timeout: 30,
+  logger: Logger.new(STDOUT),
+  user_agent: 'my-app/1.0'
+)
+
+# Create a notification message
+message = Alertus::Message.new(
+  title: 'Hello from Alertus!',
+  body: 'This is a test notification',
+  tokens: ['device-token-1', 'device-token-2'],
+  data: { key1: 'value1', key2: 42 },
+  priority: 'high',
+  time_to_live: 86_400,  # 1 day in seconds
+  collapse_key: 'test-notification'
+)
+
+# Send the notification
+begin
+  response = client.notifications.send(message)
+  
+  if response.success?
+    puts "Notification sent! ID: #{response.id}"
+  else
+    puts "Failed to send notification: #{response.errors}"
+  end
+rescue Alertus::Error => e
+  puts "Error: #{e.message}"
+end
+```
+
+## Advanced Usage
+
+### Sending to Topics
+
+```ruby
+message = Alertus::Message.new(
+  title: 'Breaking News',
+  body: 'A new update is available!',
+  topic: 'news'
+)
+```
+
+### Conditional Messaging
+
+```ruby
+message = Alertus::Message.new(
+  title: 'Special Offer',
+  body: 'Check out our new features!',
+  condition: "'sports' in topics && 'breaking' in topics"
+)
+```
+
+### Error Handling
+
+The SDK raises specific exceptions for different error scenarios:
+
+```ruby
+begin
+  response = client.notifications.send(message)
+rescue Alertus::AuthenticationError => e
+  puts "Authentication failed: #{e.message}"
+rescue Alertus::ValidationError => e
+  puts "Invalid request: #{e.message}"
+  puts "Validation errors: #{e.errors}"
+rescue Alertus::ServerError => e
+  puts "Server error: #{e.message}"
+  puts "Retry after: #{e.retry_after} seconds" if e.retry_after
+rescue Alertus::Error => e
+  puts "Unexpected error: #{e.message}"
+end
+```
+
+## Configuration
+
+### Client Options
+
+| Option | Type | Description | Default |
+|--------|------|-------------|---------|
+| `base_url` | String | Base URL for the API | `https://api.alertus.cloud` |
+| `timeout` | Integer | Request timeout in seconds | `30` |
+| `logger` | Logger | Logger instance for debugging | `nil` |
+| `user_agent` | String | Custom User-Agent header | `alertus-ruby-sdk/{version}` |
+
+### Environment Variables
+
+The SDK can be configured using environment variables:
+
+```bash
+export ALERTUS_API_KEY='your-api-key'
+export ALERTUS_API_URL='https://api.alertus.cloud'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alertus/alertus-ruby-sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/alertus/alertus-ruby-sdk/blob/main/CODE_OF_CONDUCT.md).
+
+1. Fork it (https://github.com/alertus/alertus-ruby-sdk/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Alertus Ruby SDK project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alertus/alertus-ruby-sdk/blob/main/CODE_OF_CONDUCT.md).
+
+## Support
+
+For support, please contact support@alertus.cloud or open an issue in our [GitHub repository](https://github.com/alertus/alertus-ruby-sdk/issues).

data/lib/alertus/client.rb

@@ -0,0 +1,29 @@
+module Alertus
+  class Client
+    DEFAULT_BASE_URL = 'https://api.alertus.cloud'
+
+    attr_reader :messaging
+
+    def initialize(access_token, logs: false, base_url: DEFAULT_BASE_URL, max_retries: 3)
+      raise AccessTokenError if access_token.nil? || access_token.strip.empty?
+
+      headers = {
+        'X-API-Key' => access_token,
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      @http = HttpClient.new(base_url: base_url, headers: headers, max_retries: max_retries)
+      @messaging = Messaging.new(@http)
+    end
+
+    def self.make(access_token = ENV['ALERTUS_API_KEY'], base_url: DEFAULT_BASE_URL)
+      new(access_token, base_url: base_url)
+    end
+
+    def notifications
+      @messaging
+    end
+  end
+end
+

data/lib/alertus/errors.rb

@@ -0,0 +1,7 @@
+module Alertus
+  class Error < StandardError; end
+  class AccessTokenError < Error; end
+  class UnauthorizedError < Error; end
+  class ForbiddenError < Error; end
+end
+

data/lib/alertus/http_client.rb

@@ -0,0 +1,53 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Alertus
+  class HttpClient
+    def initialize(base_url:, headers: {}, timeout: 30, max_retries: 3)
+      @base_url = base_url
+      @headers = headers
+      @timeout = timeout
+      @max_retries = max_retries
+    end
+
+    def post(path, body: {})
+      request(:post, path, body: body)
+    end
+
+    private
+
+    def request(method, path, body: nil)
+      uri = URI.join(@base_url, path)
+
+      attempt = 0
+      begin
+        attempt += 1
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == 'https'
+        http.read_timeout = @timeout
+        http.open_timeout = @timeout
+
+        req = case method
+              when :post then Net::HTTP::Post.new(uri)
+              when :get then Net::HTTP::Get.new(uri)
+              else raise ArgumentError, 'Unsupported method'
+              end
+
+        @headers.each { |k, v| req[k] = v }
+        if body
+          req['Content-Type'] ||= 'application/json'
+          req.body = JSON.generate(body)
+        end
+
+        res = http.request(req)
+        OpenStruct.new(code: res.code.to_i, body: res.body)
+      rescue IOError, SystemCallError, Timeout::Error => e
+        raise e if attempt > @max_retries
+        sleep(0.5 * attempt)
+        retry
+      end
+    end
+  end
+end
+

data/lib/alertus/message.rb

@@ -0,0 +1,22 @@
+module Alertus
+  class Message
+    attr_accessor :title, :body, :tokens, :data
+
+    def initialize(title:, body: '', tokens: [], data: nil)
+      @title = title
+      @body = body
+      @tokens = tokens
+      @data = data
+    end
+
+    def to_h
+      {
+        title: @title,
+        body: @body,
+        tokens: @tokens,
+        data: @data
+      }
+    end
+  end
+end
+

data/lib/alertus/messaging.rb

@@ -0,0 +1,21 @@
+module Alertus
+  class Messaging
+    def initialize(http)
+      @http = http
+    end
+
+    def send(message)
+      res = @http.post('/api/v1/notifications/send', body: message.to_h)
+
+      case res.code
+      when 401
+        raise UnauthorizedError
+      when 403
+        raise ForbiddenError
+      else
+        ValidationResponse.from_json(res.body)
+      end
+    end
+  end
+end
+

data/lib/alertus/validation_response.rb

@@ -0,0 +1,20 @@
+require 'json'
+
+module Alertus
+  class ValidationResponse
+    attr_reader :valid, :errors
+
+    def initialize(valid:, errors: {})
+      @valid = !!valid
+      @errors = errors || {}
+    end
+
+    def self.from_json(json_str)
+      data = JSON.parse(json_str)
+      new(valid: data['valid'], errors: data['errors'] || {})
+    rescue JSON::ParserError
+      new(valid: false, errors: { 'response' => ['invalid json'] })
+    end
+  end
+end
+

data/lib/alertus/version.rb

@@ -0,0 +1,4 @@
+module Alertus
+  VERSION = '0.1.0'
+end
+

data/lib/alertus.rb

@@ -0,0 +1,17 @@
+require_relative 'alertus/version'
+require_relative 'alertus/errors'
+require_relative 'alertus/http_client'
+require_relative 'alertus/message'
+require_relative 'alertus/validation_response'
+require_relative 'alertus/messaging'
+require_relative 'alertus/client'
+
+module Alertus
+  DEFAULT_BASE_URL = 'https://api.alertus.cloud'
+
+  def self.send_notification(message, api_key = ENV['ALERTUS_API_KEY'])
+    client = Client.make(api_key)
+    client.notifications.send(message)
+  end
+end
+

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: alertus-ruby-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alertus
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: Simple Ruby client for sending notifications via Alertus Cloud API.
+email:
+- opensource@alertus.cloud
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/alertus.rb
+- lib/alertus/client.rb
+- lib/alertus/errors.rb
+- lib/alertus/http_client.rb
+- lib/alertus/message.rb
+- lib/alertus/messaging.rb
+- lib/alertus/validation_response.rb
+- lib/alertus/version.rb
+homepage: https://github.com/alertus/alertus-ruby-sdk
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/alertus/alertus-ruby-sdk
+  changelog_uri: https://github.com/alertus/alertus-ruby-sdk/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Alertus Cloud Ruby SDK
+test_files: []