appilix_notifications 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd27db8d08672883c506ed63f2a4558c1ba5e7a6cf6fad9ebd112b36de9f22b3
-  data.tar.gz: 2da58a031ee5afd246f7b5681e44e52274ba89c12152349774f1cee89ed82b01
+  metadata.gz: 993a291ad2f0f97f3de0cd8a6d6f86fcf1e059db62ad03a541bfdf20c2c2f7b5
+  data.tar.gz: acfc393b5e518aa54d0b1242bb002f2e3446157a82dffcc5e950e780c79d7b1d
 SHA512:
-  metadata.gz: d3f940395b95c525891064db8256681ba463eaf969d43727233e7836d4f334fced4ac9f405ee20a717a39b70b7ac1a523af5acb42c64d6221dfc310560f7c947
-  data.tar.gz: 9f227ddd7ba6817cb112fa05b295fbad1b49e9da7c000de4385e0aacfd534cc7def053951bcb9ec9d0ad0d88973c8d529deb6eeb0610715f5a4d9fe155052ec3
+  metadata.gz: 2f5d6d6a14ddcd7de2f784bd962b3544f0b0eb2da99c9ee58fa87d36d340c0c539b9e8579d6554ac37f64936a41f8ce0eb23959fb2eafc20da92d70b089d7638
+  data.tar.gz: 5fd69e72ab797f26954440566cac881a4014f68723cc65e7c0dbcf8b62babd27778d3ab9564b0f76e5460b5a18be5b382e5e815aab225baecf9de8fef412618a

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    appilix_notifications (0.1.0)
+    appilix_notifications (0.1.1)
+      json (~> 2.0)
+      net-http (>= 0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -11,6 +13,11 @@ GEM
     json (2.9.1)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
+    net-http (0.10.0)
+      net-protocol (>= 0.3.0)
+      uri (>= 0.11.1)
+    net-protocol (0.4.0)
+      timeout
     parallel (1.26.3)
     parser (3.3.7.0)
       ast (~> 2.4.1)
@@ -63,9 +70,11 @@ GEM
       rubocop-performance (~> 1.23.0)
     test-unit (3.6.7)
       power_assert
+    timeout (0.6.1)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
+    uri (1.1.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -30,8 +30,11 @@ response = AppilixNotifications.appilix_send_notifications(
   'your_api_key',
   'Your Notification Title',
   'Your Notification Body',
-  'optional_user_identity', # Optional
-  'https://example.com'     # Optional
+  'optional_user_identity', # Optional; use "user-1::user-2" for multiple users
+  'https://example.com',    # Optional
+  notification_image: 'https://example.com/banner.png', # Optional; Android only
+  secondary_app_key: 'your_ios_app_key',                # Optional
+  secondary_api_key: 'your_ios_api_key'                 # Optional
 )
 
 puts response
@@ -44,6 +47,11 @@ puts response
 - `body` (String): The body content of the notification.
 - `user_identity` (String, optional): The user identifier for the notification.
 - `open_link_url` (String, optional): A URL to open when the notification is clicked.
+- `notification_image` (String, optional keyword): A public image URL (Android only).
+- `secondary_app_key` (String, optional keyword): The app key for a second app, such as iOS.
+- `secondary_api_key` (String, optional keyword): The API key for the second app.
+
+Notifications are submitted as a `POST` form request to the current Appilix push notification endpoint.
 
 
 On success, the method returns a parsed JSON response:
@@ -77,7 +85,7 @@ If the server response contains invalid JSON, you will receive:
 
 ### Fetching Registered User Tokens
 
-To fetch registered user tokens, use the `appilix_get_registered_user` method. The `page` parameter is mandatory:
+To fetch registered user tokens, use the `appilix_get_registered_user` method:
 
 ```ruby
 require 'appilix_notifications'
@@ -85,7 +93,11 @@ require 'appilix_notifications'
 response = AppilixNotifications.appilix_get_registered_user(
   'your_app_key',
   'your_api_key',
-  1 # Page number
+  1, # Optional page number; defaults to 1
+  user_identity: 'optional_user_identity',
+  items_per_page: 50,
+  secondary_app_key: 'your_ios_app_key',
+  secondary_api_key: 'your_ios_api_key'
 )
 
 puts response
@@ -95,15 +107,27 @@ puts response
 
 - `app_key` (String): Your application's key from Appilix.
 - `api_key` (String): Your API key from Appilix.
-- `page` (Integer): The page number to fetch tokens from (mandatory).
+- `page` (Integer, optional): The page number, defaulting to `1`.
+- `user_identity` (String, optional keyword): Return tokens for a specific user.
+- `items_per_page` (Integer, optional keyword): Results per page, defaulting to `100`.
+- `secondary_app_key` (String, optional keyword): The app key for a second app.
+- `secondary_api_key` (String, optional keyword): The API key for the second app.
 
 
 On success, the method returns a parsed JSON response containing the tokens:
 
 ```json
 {
-  "tokens": ["token1", "token2", "token3"],
-  "status": "true"
+  "status": true,
+  "current_page": 1,
+  "has_next_page": false,
+  "tokens": [
+    {
+      "token": "fcm-device-token-string",
+      "user_identity": "user@example.com",
+      "modified_at": "2026-05-22 10:30:00"
+    }
+  ]
 }
 ```
 

data/appilix_notifications.gemspec

@@ -5,7 +5,7 @@
 Gem::Specification.new do |spec|
   spec.name = "appilix_notifications"
   #spec.version = AppilixNotifications::VERSION
-  spec.version = "0.1.1"
+  spec.version = "0.1.2"
   spec.authors = ["RoaaAlqaisi"]
   spec.email = ["rowaalqaisi@gmail.com"]
   spec.license = "NGPL"

data/lib/appilix_notifications/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppilixNotifications
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/appilix_notifications.rb

@@ -2,29 +2,34 @@
 
 require_relative "appilix_notifications/version"
 
-require 'net/http'
-require 'uri'
-require 'json'
+require "net/http"
+require "uri"
+require "json"
 
 module AppilixNotifications
   BASE_URL = "https://appilix.com/api"
   PUSH_NOTIFICATION_URL = "push-notification"
-  TOKEN_LIST_URL = "push_notification_token_list.php"
+  TOKEN_LIST_URL = "push-notification-token"
 
   module_function
 
-  def appilix_send_notifications(app_key, api_key, title, body, user_identity = nil, open_link_url = nil)
+  def appilix_send_notifications(app_key, api_key, title, body, user_identity = nil, open_link_url = nil,
+    notification_image: nil, secondary_app_key: nil, secondary_api_key: nil)
     uri = URI("#{BASE_URL}/#{PUSH_NOTIFICATION_URL}")
-    uri.query = URI.encode_www_form(
-      'app_key' => app_key,
-      'api_key' => api_key,
-      'notification_title' => title,
-      'notification_body' => body,
-      'user_identity' => user_identity,
-      'open_link_url' => open_link_url
+    form_data = compact_parameters(
+      "app_key" => app_key,
+      "api_key" => api_key,
+      "notification_title" => title,
+      "notification_body" => body,
+      "user_identity" => user_identity,
+      "open_link_url" => open_link_url,
+      "notification_image" => notification_image,
+      "secondary_app_key" => secondary_app_key,
+      "secondary_api_key" => secondary_api_key
     )
 
-    request = Net::HTTP::Get.new(uri)
+    request = Net::HTTP::Post.new(uri)
+    request.set_form_data(form_data)
 
     response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
       http.request(request)
@@ -33,15 +38,18 @@ module AppilixNotifications
     handle_response(response)
   end
 
-  def appilix_get_registered_user(app_key, api_key, page)
-    raise ArgumentError, "Page parameter is mandatory" unless page
-
+  def appilix_get_registered_user(app_key, api_key, page = 1, user_identity: nil, items_per_page: 100,
+    secondary_app_key: nil, secondary_api_key: nil)
     uri = URI("#{BASE_URL}/#{TOKEN_LIST_URL}")
-    uri.query = URI.encode_www_form(
-      'app_key' => app_key,
-      'api_key' => api_key,
-      'page' => page
-    )
+    uri.query = URI.encode_www_form(compact_parameters(
+      "app_key" => app_key,
+      "api_key" => api_key,
+      "page" => page,
+      "items_per_page" => items_per_page,
+      "user_identity" => user_identity,
+      "secondary_app_key" => secondary_app_key,
+      "secondary_api_key" => secondary_api_key
+    ))
 
     request = Net::HTTP::Get.new(uri)
 
@@ -57,10 +65,10 @@ module AppilixNotifications
     when Net::HTTPSuccess
       JSON.parse(response.body)
     else
-      { 'error' => response.message, 'code' => response.code, 'body' => parse_body_safe(response.body) }
+      {"error" => response.message, "code" => response.code, "body" => parse_body_safe(response.body)}
     end
   rescue JSON::ParserError
-    { 'error' => 'Invalid JSON response', 'body' => response.body }
+    {"error" => "Invalid JSON response", "body" => response.body}
   end
 
   def parse_body_safe(body)
@@ -68,4 +76,8 @@ module AppilixNotifications
   rescue JSON::ParserError
     body
   end
+
+  def compact_parameters(parameters)
+    parameters.reject { |_key, value| value.nil? }
+  end
 end

data/spec/appilix_notifications_spec.rb

@@ -1,35 +1,69 @@
-require_relative '../lib/appilix_notifications'
+require_relative "../lib/appilix_notifications"
 
 RSpec.describe AppilixNotifications do
-  app_key = "key1"
-  api_key = "apikey1"
+  let(:app_key) { "key1" }
+  let(:api_key) { "apikey1" }
+  let(:http) { instance_double(Net::HTTP) }
 
-  it 'sends a notification successfully using GET' do
-    allow(AppilixNotifications).to receive(:appilix_send_notifications)
-      .with(app_key, api_key, 'Hello', 'This is a test notification', nil, nil).and_return({ 'status' => 'true' })
+  before { allow(Net::HTTP).to receive(:start).and_yield(http) }
 
-    response = AppilixNotifications.appilix_send_notifications(
-      app_key, api_key, 'Hello', 'This is a test notification', nil, nil
+  def successful_response(body)
+    response = Net::HTTPOK.new("1.1", "200", "OK")
+    allow(response).to receive(:body).and_return(JSON.generate(body))
+    response
+  end
+
+  it "sends a notification using a POST form request" do
+    allow(http).to receive(:request).and_return(successful_response("status" => true))
+
+    response = described_class.appilix_send_notifications(
+      app_key, api_key, "Hello", "Notification body", "user@example.com", "https://example.com",
+      notification_image: "https://example.com/image.png",
+      secondary_app_key: "ios-key", secondary_api_key: "ios-api-key"
     )
 
-    expect(response).to be_a(Hash)
-    expect(response['status']).to eq('true')
+    expect(response).to eq("status" => true)
+    expect(http).to have_received(:request) do |request|
+      expect(request).to be_a(Net::HTTP::Post)
+      expect(request.uri.to_s).to eq("https://appilix.com/api/push-notification")
+      expect(URI.decode_www_form(request.body).to_h).to eq(
+        "app_key" => app_key, "api_key" => api_key,
+        "notification_title" => "Hello", "notification_body" => "Notification body",
+        "user_identity" => "user@example.com", "open_link_url" => "https://example.com",
+        "notification_image" => "https://example.com/image.png",
+        "secondary_app_key" => "ios-key", "secondary_api_key" => "ios-api-key"
+      )
+    end
   end
 
-  it 'fetches registered user tokens successfully with a valid page' do
-    allow(AppilixNotifications).to receive(:appilix_get_registered_user)
-      .with(app_key, api_key, 1).and_return({ 'tokens' => ['token1', 'token2'] })
+  it "fetches FCM tokens from the current endpoint with documented parameters" do
+    body = {"status" => true, "current_page" => 2, "has_next_page" => false, "tokens" => []}
+    allow(http).to receive(:request).and_return(successful_response(body))
 
-    response = AppilixNotifications.appilix_get_registered_user(app_key, api_key, 1)
+    response = described_class.appilix_get_registered_user(
+      app_key, api_key, 2, user_identity: "user@example.com", items_per_page: 50,
+      secondary_app_key: "ios-key", secondary_api_key: "ios-api-key"
+    )
 
-    expect(response).to be_a(Hash)
-    expect(response).to have_key('tokens')
-    puts response
+    expect(response).to eq(body)
+    expect(http).to have_received(:request) do |request|
+      expect(request).to be_a(Net::HTTP::Get)
+      expect(request.uri.path).to eq("/api/push-notification-token")
+      expect(URI.decode_www_form(request.uri.query).to_h).to eq(
+        "app_key" => app_key, "api_key" => api_key, "page" => "2", "items_per_page" => "50",
+        "user_identity" => "user@example.com", "secondary_app_key" => "ios-key",
+        "secondary_api_key" => "ios-api-key"
+      )
+    end
   end
 
-  it 'raises an error when page is missing for registered user tokens' do
-    expect {
-      AppilixNotifications.appilix_get_registered_user(app_key, api_key, nil)
-    }.to raise_error(ArgumentError, 'Page parameter is mandatory')
+  it "uses the API pagination defaults when token options are omitted" do
+    allow(http).to receive(:request).and_return(successful_response("status" => true, "tokens" => []))
+
+    described_class.appilix_get_registered_user(app_key, api_key)
+
+    expect(http).to have_received(:request) do |request|
+      expect(URI.decode_www_form(request.uri.query).to_h).to include("page" => "1", "items_per_page" => "100")
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: appilix_notifications
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - RoaaAlqaisi
 bindir: exe
 cert_chain: []
-date: 2025-01-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A Ruby gem to send notifications using the appilix API.
 test_files: []