huawei-push-kit 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 185268eddeb26c9646757b6d12cd9b2bc2de5a976e59390340bd3be5432ed5cb
+  data.tar.gz: dac8f55a3d7358c866891a1dda6da67e404a55bb74f0a10b451929443d507b53
+SHA512:
+  metadata.gz: 7d27bc596705f0b4d09fc8d7669be3bb4d531ef37801b6dfd89b9abb4c5cded09db3f9e9799b97f6de1af1a0a064674466e62c5833278f2cd32b65d0bef052b4
+  data.tar.gz: 9c9d46ff974bc6dced5d9efc53f0a128814a6b881df7f9a83c664a7cd04a924a0a2b995eb390d0c285021c24fe3a097e2b1d2060241ed2f01d6c737d0ac7b7b6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) [2024] [Karim Marabet]
+
+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,60 @@
+# 📬 Huawei Push Kit Ruby Client
+
+Welcome to the unofficial Ruby client for Huawei Push Kit, designed to seamlessly integrate Huawei Push Kit capabilities into your Ruby applications.
+
+## 🌟 Features
+
+- Send notifications to devices using a simple Ruby interface.
+- Support for major features provided by the Huawei Push Kit API.
+
+## 🛠 Installation
+
+To start using this gem in your Ruby application, add this line to your Gemfile:
+
+```ruby
+gem 'huawei_push_kit'
+```
+Then execute:
+
+```ruby
+bundle install
+```
+
+Or install it yourself as:
+```ruby
+gem install huawei_push_kit
+```
+
+# ⚙ Configuration
+Before using the client, you need to configure your access keys obtained from the Huawei Developer Console and add it to the `.env` file.
+
+```
+HUAWEI_PUSH_KIT_CLIENT_ID=<HUAWEI_PUSH_KIT_CLIENT_ID>
+HUAWEI_PUSH_KIT_CLIENT_SECRET=<HUAWEI_PUSH_KIT_CLIENT_SECRET>
+```
+
+# 🚀 Usage
+
+```ruby
+device_token = "<huawei_device_token>"
+huawei_push_kit_client = HuaweiPushKit::Client.new
+
+# Send notification to a single Huawei device
+client.send_push_notification(device_token, "Title", "Message")
+
+# Subscribe to a topic
+huawei_push_kit_client.subscribe_to_topic("topic_name", device_token)
+
+# Show all topics
+huawei_push_kit_client.topic_list(device_token)
+
+# Send notification to a topic
+client.send_push_notification_to_topic(topic_name, "Title", "Message", "topic_name")
+
+# Unsubscribe from a topic
+huawei_push_kit_client.unsubscribe_from_topic("topic_name", device_token)
+
+```
+
+# 🔓 License
+This gem is available as open source under the terms of the MIT License. See the LICENSE file for more details.

data/lib/huawei_push_kit/api_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module HuaweiPushKit
+  class ApiResponse
+    def initialize(response)
+      @response = JSON.parse(response.body)
+    end
+
+    def successful?
+      response["code"] == "80000000"
+    end
+
+    def error
+      response["errors"]&.join(", ")
+    end
+
+    def body
+      JSON.parse(response.body)
+    end
+
+    private
+
+    attr_reader :response
+  end
+end

data/lib/huawei_push_kit/client.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+module HuaweiPushKit
+  class Client
+    PUSH_API_URI = "https://push-api.cloud.huawei.com"
+    OAUTH_URI = "https://oauth-login.cloud.huawei.com"
+    CONTENT_JSON = "application/json"
+    CONTENT_URL_ENCODED = "application/x-www-form-urlencoded"
+
+    def initialize(client_id = ENV.fetch("HUAWEI_PUSH_KIT_CLIENT_ID"), client_secret = ENV.fetch("HUAWEI_PUSH_KIT_CLIENT_SECRET"))
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+
+    def send_push_notification(device_token, title, body, type = nil, badge = nil, post_id = nil, comment_id = nil,
+      chat_id = nil, avatar = nil)
+      response = push_api_connection.post("/v1/#{client_id}/messages:send") do |req|
+        req.body = build_notification_body(device_token, title, body, type, badge, post_id, comment_id, chat_id, avatar)
+      end
+
+      ApiResponse.new(response)
+    end
+
+    def send_push_notification_to_topic(topic_name, title, body, type = nil, badge = nil, post_id = nil,
+      comment_id = nil, chat_id = nil, avatar = nil)
+      response = push_api_connection.post("/v1/#{client_id}/messages:send") do |req|
+        req.body = build_topic_notification_body(topic_name, title, body, type, badge, post_id, comment_id, chat_id,
+          avatar)
+      end
+
+      ApiResponse.new(response)
+    end
+
+    def subscribe_to_topic(topic_name, device_tokens)
+      response = push_api_connection.post("/v1/#{client_id}/topic:subscribe") do |req|
+        req.body = { topic: topic_name, tokenArray: Array(device_tokens) }.to_json
+      end
+
+      ApiResponse.new(response)
+    end
+
+    def unsubscribe_from_topic(topic_name, device_tokens)
+      response = push_api_connection.post("/v1/#{client_id}/topic:unsubscribe") do |req|
+        req.body = { topic: topic_name, tokenArray: Array(device_tokens) }.to_json
+      end
+
+      ApiResponse.new(response)
+    end
+
+    def topic_list(device_token)
+      response = push_api_connection.post("/v1/#{client_id}/topic:list") do |req|
+        req.body = { token: device_token }.to_json
+      end
+
+      ApiResponse.new(response)
+    end
+
+    private
+
+    attr_reader :client_id, :client_secret
+
+    def build_topic_notification_body(topic_name, title, text, type = nil, badge = nil, post_id = nil,
+      comment_id = nil, chat_id = nil, avatar = nil)
+      {
+        validate_only: false,
+        message: {
+          data: {
+                  title:,
+                  message: text,
+                  type:,
+                  badge:,
+                  post_id:,
+                  comment_id:,
+                  chat_id:,
+                  avatar:
+                }.to_json,
+          topic: topic_name
+        }
+      }.to_json
+    end
+
+    def build_notification_body(device_token, title, text, type = nil, badge = nil, post_id = nil, comment_id = nil,
+      chat_id = nil, avatar = nil)
+      {
+        validate_only: false,
+        message: {
+          data: {
+                  title:,
+                  message: text,
+                  type:,
+                  badge:,
+                  post_id:,
+                  comment_id:,
+                  chat_id:,
+                  avatar:
+                }.to_json,
+          token: [
+            device_token
+          ]
+        }
+      }.to_json
+    end
+
+    def access_token
+      response = oauth_connection.post("/oauth2/v3/token") do |req|
+        req.body = URI.encode_www_form({
+          grant_type: "client_credentials",
+          client_id:,
+          client_secret:
+        })
+      end
+
+      JSON.parse(response.body)["access_token"]
+    end
+
+    def push_api_connection
+      Faraday.new(PUSH_API_URI) do |faraday|
+        setup_connection(faraday, CONTENT_JSON, "Bearer #{access_token}")
+      end
+    end
+
+    def oauth_connection
+      Faraday.new(OAUTH_URI) do |faraday|
+        setup_connection(faraday, CONTENT_URL_ENCODED)
+      end
+    end
+
+    def setup_connection(faraday, content_type, authorization = nil)
+      faraday.headers["Content-Type"] = content_type
+      faraday.headers["Authorization"] = authorization if authorization
+      faraday.response :raise_error
+      faraday.adapter Faraday.default_adapter
+    end
+  end
+end

data/lib/huawei_push_kit.rb

@@ -0,0 +1,2 @@
+require_relative 'huawei_push_kit/client'
+require_relative 'huawei_push_kit/api_response'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: huawei-push-kit
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Karim Marabet
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Huawei Push Kit Client for Ruby
+email: newrabgo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/huawei_push_kit.rb
+- lib/huawei_push_kit/api_response.rb
+- lib/huawei_push_kit/client.rb
+homepage: https://github.com/mrabets/huawei-push-kit
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Huawei Push Kit Client for Ruby
+test_files: []