novu 0.1.0

data/lib/novu/api/subscribers.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+module Novu
+  class Api
+    # Module Novu::Api::Subscribers provides an API for managing subscribers in the Novu application.
+    #
+    # This module includes methods for creating, retrieving, updating, and deleting subscribers.
+    # It also includes methods for updating subscriber credentials, online status, preferences etc.
+    #
+    # For more information on the Novu API(https://api.novu.co/api#/Subscribers), see https://docs.novu.co/api/get-subscribers/.
+    module Subscribers
+      # Returns a list of subscribers, could paginated using the `page` query parameter
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] Number of page for the pagination. The page to fetch, defaults to 0.
+      #
+      # @return [Hash] The list of subscribers that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def subscribers(query = {})
+        get("/subscribers", query: query)
+      end
+
+      # Creates a subscriber entity, in the Novu platform.
+      # The subscriber will be later used to receive notifications, and access notification feeds.
+      # Communication credentials such as email, phone number, and 3 rd party credentials
+      # i.e slack tokens could be later associated to this entity.
+      #
+      # @bodyparams:
+      # @param `subscriberId` [String] The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems.
+      # @param `email` [String(optional)]
+      # @param `firstName` [String(optional)]
+      # @param `lastName` [String(optional)]
+      # @param `phone` [String(optional)]
+      # @param `avatar` [String(optional)] An http url to the profile image of your subscriber
+      # @param `locale` [String(optional)]
+      # @param `data` [Hash(optional)]
+      #
+      # @return [Hash] The hash of subscriber data is successfully returned.
+      # @return [number] status - The status code. Returns 201 if the susbscriber has been successfully created.
+      def create_subscriber(body)
+        post("/subscribers", body: body)
+      end
+
+      # Retrieves the subscriber with the given ID.
+      #
+      # @pathparams
+      # @param `subscribe_id` [String] The ID of the subscriber to retrieve.
+      #
+      # @return [Hash] The retrieved subscriber.
+      # @return [number] status
+      #  - Returns 200 if the subscriber with the subscriber_id provided exists in the database.
+      def subscriber(subscriber_id)
+        get("/subscribers/#{subscriber_id}")
+      end
+
+      # Used to update the subscriber entity with new information
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber to update.
+      #
+      # @bodyparams
+      # @param `email` [String(optional)]
+      # @param `firstName` [String(optional)]
+      # @param `lastName` [String(optional)]
+      # @param `phone` [String(optional)]
+      # @param `avatar` [String(optional)]
+      # @param `locale` [String(optional)]
+      # @param `data` [String(optional)]
+      #
+      # @return [Hash] The updated subscriber entity.
+      # @return [number] status
+      #  - Returns 200 if the subscriber with the subscriber_id provided has been updated correctly.
+      def update_subscriber(subscriber_id, body)
+        put("/subscribers/#{subscriber_id}", body: body)
+      end
+
+      # Deletes a subscriber entity from the Novu platform
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber to delete.
+      #
+      # @return [Hash] Hash of acknowledged and status.
+      # @return [number] status
+      #  - Returns 200 if the subscriber has been deleted correctly.
+      def delete_subscriber(subscriber_id)
+        delete("/subscribers/#{subscriber_id}")
+      end
+
+      # Update subscriber credentials from the Novu platform. Subscriber credentials associated to the delivery methods such as slack and push tokens.
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber to update credentials.
+      #
+      # @bodyparams:
+      # @param `providerId` [String] The provider identifier for the credentials
+      # @param `credentials` [Hash] Credentials payload for the specified provider
+      #
+      # @return [Hash] Hash of updated subscriber credentials entity
+      # @return [number] status
+      #  - Returns 200 if the subscriber credentials has been updated correctly.
+      def update_subscriber_credentials(subscriber_id, body)
+        put("/subscribers/#{subscriber_id}/credentials", body: body)
+      end
+
+      # Used to update the subscriber isOnline flag.
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber to update online status.
+      #
+      # @bodyparams:
+      # @param `isOnline` [Boolean]
+      #
+      # @return [Hash] The updated subscriber entity.
+      # @return [number] status
+      #  - Returns 200 if the subscriber online status has been updated correctly.
+      def update_subscriber_online_status(subscriber_id, body)
+        patch("/subscribers/#{subscriber_id}/online-status", body: body)
+      end
+
+      # Used to get the subscriber preference
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber.
+      #
+      # @return [Hash] Hash of template and preference.
+      # @return [number] status
+      #  - Returns 200 if the subscriber preference has been retrieved successfully.
+      def subscriber_preferences(subscriber_id)
+        get("/subscribers/#{subscriber_id}/preferences")
+      end
+
+      # Used to update the subscriber preference
+      #
+      # @pathparams:
+      # @param `subscriber_id` [String] The ID of the subscriber to update preference.
+      # @param `template_id` [String] The ID of the template to update preference.
+      #
+      # @bodyparams:
+      # @param `channel` [Hash(optional)] The subscriber preferences for every ChannelTypeEnum for the notification template assigned.
+      # @param `enabled` [Boolean(optional)] Sets if the notification template is fully enabled for all channels or not for the subscriber.
+      #
+      # @return [Hash] Hash of template and preference.
+      # @return [number] status
+      #  - Returns 200 if the subscriber preference has been updated correctly.
+      def update_subscriber_preference(subscriber_id, template_id, body)
+        patch("/subscribers/#{subscriber_id}/preferences/#{template_id}", body: body)
+      end
+
+      # Returns a notification feed for a particular subscriber
+      #
+      # @pathparams
+      # @param `subscriber_id` [String]
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] Number of page for the pagination.
+      # @param `feedIdentifier` [String]
+      # @param `seen` [Boolean(optional)]
+      #
+      # @return [Hash] List of notification feed of a subscriber that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def subscriber_notification_feed(subscriber_id, query = {})
+        get("/subscribers/#{subscriber_id}/notifications/feed", query: query)
+      end
+
+      # Returns the unseen notification count for subscribers feed
+      #
+      # @pathparams
+      # @param `subscriber_id` [String]
+      #
+      # @queryparams:
+      # @param `seen` [Boolean]
+      #
+      # @return [Hash] the unseen notification count
+      # @return [number] status
+      #  - Returns 200 if successful
+      def subscriber_unseen_notification_count(subscriber_id, query = {})
+        get("/subscribers/#{subscriber_id}/notifications/unseen", query: query)
+      end
+
+      # Mark a subscriber feed message as seen
+      #
+      # @pathparams
+      # @param `subscriber_id` [String]
+      #
+      # @bodyparams:
+      # @param `messageId` [Hash]
+      # @param `mark` [Hash]
+      #
+      # @return [Hash] the unseen notification count
+      # @return [number] status
+      #  - Returns 201 if successful
+      def mark_subscriber_feed_seen(subscriber_id, body)
+        post("/subscribers/#{subscriber_id}/messages/markAs", body: body)
+      end
+
+      # Mark message action as seen
+      #
+      # @pathparams
+      # @param `message_id` [String]
+      # @param `type` [String]
+      # @param `subscriber_id` [String]
+      #
+      # @return [Hash] the unseen notification count
+      # @return [number] status
+      #  - Returns 201 if successful
+      def mark_message_action_seen(subscriber_id, message_id, type)
+        post("/subscribers/#{subscriber_id}/messages/#{message_id}/actions/#{type}")
+      end
+    end
+  end
+end

data/lib/novu/api/topics.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Novu
+  class Api
+    # Module Novu::Api::Topics provides an API for managing topics in the Novu application.
+    #
+    # This module includes methods for creating and retrieving and updating topic.
+    # It also includes methods for subscriber addition and removal.
+    #
+    # For more information on the Novu API(https://api.novu.co/api#/Topics), see https://docs.novu.co/api/topic-creation/.
+    module Topics
+      # Create a topic
+      #
+      # @bodyparams:
+      # @param `key` [String] User defined custom key and provided by the user that will be an unique identifier for the Topic created.
+      # @param `name` [String] User defined custom name and provided by the user that will name the Topic created.
+      #
+      # @return [number] status - The status code. Returns 201 if the topic has been successfully created.
+      def create_topic(body)
+        post("/topics", body: body)
+      end
+
+      # Returns a list of topics that can be paginated using the `page` query parameter and
+      #  filtered by the topic key with the `key` query parameter
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] Number of page for the pagination.
+      # @param `pageSize` [Integer(optional)] Size of page for the pagination.
+      # @param `key` [String(optional)] Topic key.
+      #
+      # @return [Hash] The list of topics that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def topics(query = {})
+        get("/topics", query: query)
+      end
+
+      # Add subscribers to a topic by key
+      #
+      # @pathparams
+      # @param `topic_key` [String]
+
+      # @bodyparams:
+      # @param `subscribers` [Array] List of subscriber identifiers that will be associated to the topic
+      #
+      # @return [number] status - The status code. Returns 204 if successfully add subscribers to a topic by key.
+      def add_subscribers(topic_key, body)
+        post("/topics/#{topic_key}/subscribers", body: body)
+      end
+
+      # Remove subscribers from a topic
+      #
+      # @pathparams
+      # @param `topic_key` [String]
+
+      # @bodyparams:
+      # @param `subscribers` [Array] List of subscriber identifiers that will be removed to the topic
+      #
+      # @return [number] status - The status code. Returns 204 if successfully remove subscribers to a topic by key.
+      def remove_subscribers(topic_key, body)
+        post("/topics/#{topic_key}/subscribers/removal", body: body)
+      end
+
+      # Get a topic by its topic key
+      #
+      # @pathparams
+      # @param `topic_key` [String]
+      #
+      # @return [Hash] The retrieved topic.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def topic(topic_key)
+        get("/topics/#{topic_key}")
+      end
+
+      # Rename a topic by providing a new name
+      #
+      # @pathparams
+      # @param `topic_key` [String]
+      #
+      # @bodyparams:
+      # @param `name` [String] User defined custom name and provided by the user to rename the topic.
+      #
+      # @return [Hash] Updated topic enitiy.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def rename_topic(topic_key, body)
+        patch("/topics/#{topic_key}", body: body)
+      end
+    end
+  end
+end

data/lib/novu/client.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "novu/api/changes"
+require "novu/api/connection"
+require "novu/api/environments"
+require "novu/api/events"
+require "novu/api/execution_details"
+require "novu/api/feeds"
+require "novu/api/inbound_parse"
+require "novu/api/integrations"
+require "novu/api/layouts"
+require "novu/api/messages"
+require "novu/api/notification_groups"
+require "novu/api/notification_templates"
+require "novu/api/notification"
+require "novu/api/subscribers"
+require "novu/api/topics"
+
+module Novu
+  class Client
+    include HTTParty
+    include Novu::Api::Changes
+    include Novu::Api::Connection
+    include Novu::Api::Environments
+    include Novu::Api::Events
+    include Novu::Api::ExecutionDetails
+    include Novu::Api::Feeds
+    include Novu::Api::InboundParse
+    include Novu::Api::Integrations
+    include Novu::Api::Layouts
+    include Novu::Api::Messages
+    include Novu::Api::NotificationGroups
+    include Novu::Api::NotificationTemplates
+    include Novu::Api::Notification
+    include Novu::Api::Subscribers
+    include Novu::Api::Topics
+
+    base_uri "https://api.novu.co/v1"
+    format :json
+
+    def initialize(access_token = nil)
+      raise ArgumentError, "Api Key cannot be blank or nil" if access_token.blank?
+
+      @access_token = access_token.to_s.strip
+      self.class.default_options.merge!(headers: { "Authorization" => "ApiKey #{@access_token}" })
+    rescue ArgumentError => e
+      puts "Error initializing Novu client: #{e.message}"
+    end
+  end
+end

data/lib/novu/version.rb

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

data/lib/novu.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash"
+require "httparty"
+require_relative "novu/version"
+require_relative "novu/client"
+
+module Novu
+  # class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/novu.rbs

@@ -0,0 +1,4 @@
+module Novu
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: novu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aman Saini
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: httparty
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: activesupport
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client library for Novu API.
+email:
+- amansaini0003@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/novu.rb
+- lib/novu/api/changes.rb
+- lib/novu/api/connection.rb
+- lib/novu/api/environments.rb
+- lib/novu/api/events.rb
+- lib/novu/api/execution_details.rb
+- lib/novu/api/feeds.rb
+- lib/novu/api/inbound_parse.rb
+- lib/novu/api/integrations.rb
+- lib/novu/api/layouts.rb
+- lib/novu/api/messages.rb
+- lib/novu/api/notification.rb
+- lib/novu/api/notification_groups.rb
+- lib/novu/api/notification_templates.rb
+- lib/novu/api/subscribers.rb
+- lib/novu/api/topics.rb
+- lib/novu/client.rb
+- lib/novu/version.rb
+- sig/novu.rbs
+homepage: https://github.com/amansaini0003/ruby-novu
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amansaini0003/ruby-novu
+  source_code_uri: https://github.com/amansaini0003/ruby-novu
+  changelog_uri: https://github.com/amansaini0003/ruby-novu/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Client library for Novu API.
+test_files: []