novu 0.1.0 → 1.1.0

data/Rakefile

@@ -9,4 +9,5 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+# TODO: add rubocop back to default task once all offenses are corrected
+task default: %i[spec]

data/lib/novu/api/blueprints.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Novu
+  class Api
+    # Module Novu::Api::Blueprints provides an API for managing templated for notifications that are sent out in the Novu application.
+    #
+    # This module includes methods for retrieving blueprints by templateID and grouping blueprints by category.
+    #
+    # For more information on the Novu Blueprint API, see https://docs.novu.co/api/get-messages/.
+    module Blueprints
+      # Returns the details of a particular template
+      #
+      # @pathParams 
+      # @param `template_id` [String]
+      #
+      # @return [Hash] The list of properties that pertains to the template e.g. _id, name, description, active, draft, preferenceSettings, and many others.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def get_blueprint(template_id)
+        get("/blueprints/#{template_id}")
+      end
+
+      # Get V1blueprintsgroup by Category
+      def group_blueprints_by_category
+        get("/blueprints/group-by-category")
+      end
+    end
+  end
+end

data/lib/novu/api/changes.rb

@@ -33,11 +33,13 @@ module Novu
 
       # Apply Bulk Change
       #
+      # @bodyParams
+      # @param changeIds [Array] The list of environment IDs to apply changes to.
       # @return [Hash] updated change.
       # @return [number] status
       #  - Returns 201 if the bulk change has been updated correctly.
-      def apply_bulk_changes
-        post("/changes/bulk/apply")
+      def apply_bulk_changes(changeIds)
+        post("/changes/bulk/apply", body: changeIds)
       end
 
       # Apply change

data/lib/novu/api/connection.rb

@@ -3,6 +3,7 @@
 module Novu
   class Api
     module Connection
+
       def get(path, options = {})
         request :get, path, options
       end
@@ -25,8 +26,36 @@ module Novu
 
       private
 
+      # Send API Request
+      #
+      # It applies exponential backoff strategy (if enabled) for failed requests. 
+      # It also performs an idempotent request to safely retry requests without having duplication operations.
+      #
       def request(http_method, path, options)
+
+        if http_method.to_s == 'post' || http_method.to_s == 'patch'
+          self.class.default_options[:headers].merge!({ "Idempotency-Key" => "#{@idempotency_key.to_s.strip}"  }) 
+        end
+
         response = self.class.send(http_method, path, options)
+
+        if  ! [401, 403, 409, 500, 502, 503, 504].include?(response.code) && ! @enable_retry
+          response
+        elsif @enable_retry
+    
+          if @retry_attempts < @max_retries
+            @retry_attempts += 1
+
+            @backoff.intervals.each do |interval|
+              sleep(interval)
+              request(http_method, path, options)
+            end
+          else
+            raise StandardError, "Max retry attempts reached"
+          end
+        else
+          response
+        end
       end
     end
   end

data/lib/novu/api/integrations.rb

@@ -100,6 +100,17 @@ module Novu
       def in_app_status
         get("/integrations/in-app/status")
       end
+
+      # Set integration as primary
+      #
+      # @pathparams
+      # @param `integration_id` [String]
+      # 
+      # @return [number] status
+      #  - Returns 200 if successful
+      def set_integration_as_primary(integration_id)
+        post("/integrations/#{integration_id}/set-primary")
+      end
     end
   end
 end

data/lib/novu/api/organizations.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Novu
+	class Api
+		# Module Novu::Api::Organizations provides an API for managing Organization within your Novu account.
+		#
+		# This module includes methods for creating, retrieving, updating and deleting organization.
+		#
+		# For more information on the Novu API see https://api.novu.co/api#/Organizations, https://docs.novu.co/api-reference/organizations/create-organization.
+		module Organizations
+			# Create an organization
+      #
+      # @bodyparams:
+      # @param `logo` [String] - A valid image URL with one of the following extensions: jpg, jpeg, png, gif, svg.
+      # @param `name` [String] - A human-readable name of the organization.
+      #
+      # @return [Hash] data - The list of information with respect to the created organization.
+      # @return [number] status - The status code. Returns 200 if the organization has been successfully created.
+      def create_organization(body)
+        post("/organizations", body: body)
+      end
+
+      # Get all organizations
+      #
+      # @return [Hash] data - The list of organizations already created.
+      # @return [number] status - Returns 200 if successful
+      def organizations()
+        get("/organizations")
+      end
+
+      # Get details of the current organization
+      #
+      # @return [Hash] data - The details of the current organization.
+      # @return [number] status - Returns 200 if successful
+      def current_organization()
+        get("/organizations/me")
+      end
+
+      # Get all members of the current organization
+      #
+      # @return [Hash] data - The list of all members of the current organization.
+      # @return [number] status - Returns 200 if successful
+      def current_organization_members()
+        get("/organizations/members")
+      end
+
+      # Rename organization name
+      #
+      # @return [Hash] data - The list of updated details of the organization.
+      # @return [number] status - Returns 200 if successful
+      def rename_organization(body)
+        patch("/organizations", body: body)
+      end
+
+      # Update organization branding details
+      #
+      # @bodyparams:
+      # @param `logo` [String] - A valid image URL with one of the following extensions: jpg, jpeg, png, gif, svg.
+      # @param `color` [String] - The hexadecimal color style of the organization.
+      # @param `contentBackground` [String] - The hexadecimal content background style of the organization.
+      # @param `fontColor` [String] - The hexadecimal font color style of the organization.
+      # @param `fontFamily` [String(optional)] - The font family style of the organization.
+      #
+      # @return [Hash] data - The list of branding details of the organization.
+      # @return [number] status - Returns 200 if successful
+      def organization_branding(body)
+        put("/organizations/branding", body: body)
+      end
+
+      # Remove a member from organization
+      #
+      # @pathparams
+      # @param `member_id` [String]
+      #
+      # @return [number] status - The status code. Returns 200 if memeber was removed successfully by their id.
+      def delete_organization_member(member_id)
+        delete("/organizations/members/#{member_id}")
+      end
+		end
+	end
+end

data/lib/novu/api/subscribers.rb

@@ -45,7 +45,7 @@ module Novu
       # Retrieves the subscriber with the given ID.
       #
       # @pathparams
-      # @param `subscribe_id` [String] The ID of the subscriber to retrieve.
+      # @param `subscriber_id` [String] The ID of the subscriber to retrieve.
       #
       # @return [Hash] The retrieved subscriber.
       # @return [number] status
@@ -103,6 +103,19 @@ module Novu
         put("/subscribers/#{subscriber_id}/credentials", body: body)
       end
 
+      # Delete subscriber credentials by providerId
+      # Delete subscriber credentials such as slack and expo tokens.
+      #
+      # @pathParams:
+      # @param `subscriberId` [String] The ID of the subscriber to update credentials.
+      # @param `providerId` [String] The provider identifier for the credentials
+      #
+      # @return [number] status
+      #  - Returns 204 if the subscriber credentials has been deleted successfully.
+      def delete_subscriber_credentials(subscriberId, providerId)
+        delete("/subscribers/#{subscriberId}/credentials/#{providerId}")
+      end
+
       # Used to update the subscriber isOnline flag.
       #
       # @pathparams:
@@ -207,6 +220,81 @@ module Novu
       #  - Returns 201 if successful
       def mark_message_action_seen(subscriber_id, message_id, type)
         post("/subscribers/#{subscriber_id}/messages/#{message_id}/actions/#{type}")
+      end
+
+			# Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
+      # The bulk API is limited to 500 subscribers per request.
+      #
+      # @bodyparams:
+      # @param `subscribers` [Array[subscriber]]
+      #     @subscriber : subscriber structure
+      #     @param `firstName` [Stringoptional)] The first name of the subscriber.
+      #     @param `lastName` [Stringoptional)] The last name of the subscriber.
+      #     @param `email` [Stringoptional)] The email of the subscriber.
+      #     @param `data` [Hash(optional)] The data object is used to pass additional custom information that could be used to identify the subscriber.
+      #     @param `phone` [Hash(optional)] This phone of the subscriber.
+      #     @param `locale` [String(optional)] The location of the subscriber.
+      #     @param `subscriberId` [String] A unique identifier for the subscriber, usually correlates to the id the user in your systems.
+      #     @param `avatar` [String(optional)] An http url to the profile image of your subscriber
+			#
+      # @return data [Hash]
+      #   - updated [Array] - If the subscriber was updated
+      #   - created [Array] - Array of objects for the subsribers ID created
+      #   - failed [Array] - In case of an error, this field will contain the error message
+      #   
+      # @return [number] status - The status code. Returns 201 if the subscribers were created successfully.
+			def bulk_create_subscribers(body)
+        post("/subscribers/bulk", body: body.to_json, headers: {'Content-Type': 'application/json'})
+			end
+      # Marks all the subscriber messages as read, unread, seen or unseen.
+      # 
+      # @pathparams
+      # @param `subscriber_id` [String]
+      # 
+      # @bodyParams:
+      # @param `markAs` [String] The type of action to perform either read, unread, seen or unseen.
+      # @param `feedIdentifier` [String|Array(Optional)]  The feed id (or array) to mark messages of a particular feed.
+      #
+      # @return [number] status
+      #  - Returns 201 if successful
+      def mark_all_subscriber_messages(subscriber_id, body)
+        post("/subscribers/#{subscriber_id}/messages/mark-all", body: body)
+      end
+
+      # Handle providers OAUTH redirect
+      #
+      # @pathparams:
+      # @param `subscriberId` [String]
+      # @param `providerId` [String]
+      #
+      # @queryparams:
+      # @param `code` [String]
+      # @param `hmacHash` [String]
+      # @param `environmentId` [String]
+      # @param `integrationIdentifier` [String]
+      #
+      # @return [Hash] The list of changes that match the criteria of the query params are successfully returned.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def provider_oauth_redirect(subscriberId, providerId, query = {})
+        get("/subscribers/#{subscriberId}/credentials/#{providerId}/oauth/callback", query: query)
+      end
+
+      # Handle chat OAUTH
+      #
+      # @pathparams:
+      # @param `subscriberId` [String]
+      # @param `providerId` [String]
+      #
+      # @queryparams:
+      # @param `hmacHash` [String]
+      # @param `environmentId` [String]
+      # @param `integrationIdentifier` [String]
+      #
+      # @return [number] status
+      #  - Returns 200 if successful
+      def chat_oauth(subscriberId, providerId, query = {})
+        get("/subscribers/#{subscriberId}/credentials/#{providerId}/oauth", query: query)
       end
     end
   end

data/lib/novu/api/tenants.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Novu
+  class Api
+    # Module Novu::Api::Tenants provides an API for managing tenants in the Novu application.
+    #
+    # This module includes methods for creating, retrieving, updating and deleting tenant.
+    #
+    # For more information on the tenants feature (https://docs.novu.co/tenants/introduction), 
+    # for API documentation see https://docs.novu.co/api-reference/tenants/get-tenants.
+    module Tenants
+      # Create a tenant
+      #
+      # @bodyparams:
+      # @param `identifier` [String] - A unique value, and can be used later when pointing to this tenant during trigger calls.
+      # @param `name` [String] - A human-readable name of the tenant.
+      # @param `data` [Hash] - A custom data object that can store information about the tenant. 
+      #
+      # @return [Hash] data - The list of information with respect to the created tenant are successfully returned.
+      # @return [number] status - The status code. Returns 200 if the tenant has been successfully created.
+      def create_tenant(body)
+        post("/tenants", body: body)
+      end
+
+      # Returns a list of tenant that can be paginated using the `page` query parameter and
+      #  set the number of tenants to be with the `limit` query parameter
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] - Number of page for the pagination.
+      # @param `limit` [Integer(optional)] - Size of page for the pagination.
+      #
+      # @return [Hash] data - The list of tenants that match the criteria of the query params are successfully returned.
+      # @return [Boolean] hasMore - To specify if the list have more items to fetch
+      # @return [number] page - The current page of the paginated response
+      # @return [number] pageSize - The number of size of each page
+      # @return [number] status
+      #  - Returns 200 if successful
+      def tenants(query = {})
+        get("/tenants", query: query)
+      end
+
+      # Get a tenant by the tenant identifier
+      #
+      # @pathparams
+      # @param `identifier` [String]
+      #
+      # @return [Hash] data -The retrieved topic.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def tenant(identifier)
+        get("/tenants/#{identifier}")
+      end
+
+      # Update a tenant
+      #
+      # @pathparams
+      # @param `identifier` [String]
+      #
+      # @bodyparams:
+      # @param `identifier` [String] - A unique value, and can be used later when pointing to this tenant during trigger calls.
+      # @param `name` [String] - A human-readable name of the tenant.
+      # @param `data` [Hash] - A custom data object that can store information about the tenant. This data can be later accessed inside workflows.
+      #
+      # @return [Hash] data - The list of information with respect to the created tenant are successfully returned.
+      # @return [number] status - The status code. Returns 200 if the tenant has been successfully created.
+      def update_tenant(identifier, body)
+        patch("/tenants/#{identifier}", body: body)
+      end
+
+      # Using a previously create identifier during the tenant ceation, will cancel any active or pending workflows.
+      # This is useful to cancel active digests, delays etc...
+      #
+      # @pathparams:
+      # @param `identifier` [String] - identifier of the tenant
+      #
+      # @return [number] status - The status code. Returns 200 if the event has been successfully cancelled.
+      def delete_tenant(identifier)
+        delete("/tenants/#{identifier}")
+      end
+    end
+  end
+end

data/lib/novu/api/topics.rb

@@ -61,6 +61,18 @@ module Novu
         post("/topics/#{topic_key}/subscribers/removal", body: body)
       end
 
+      # Check topic subsriber
+      # Check if a subscriber belongs to a certain topic
+      #
+      # @pathparams
+      # @param `topic_key` [String]
+      # @param `externalSubscriberId` [String] The id of the subscriber created on `/subscribers` endpoint
+      #
+      # @return [number] status - The status code. Returns 200 if subscriber was added to the topic.
+      def subscriber_topic(topic_key, externalSubscriberId)
+        get("/topics/#{topic_key}/subscribers/#{externalSubscriberId}")
+      end
+
       # Get a topic by its topic key
       #
       # @pathparams
@@ -87,6 +99,17 @@ module Novu
       def rename_topic(topic_key, body)
         patch("/topics/#{topic_key}", body: body)
       end
+
+      # Delete topic
+      # Delete a topic by its topic key if it has no subscribers
+      #
+      # @pathparams
+      # @param `topic_key` [String]
+      #
+      # @return [number] status - The status code. Returns 204 if successfully deleted topic.
+      def delete_topic(topic_key)
+        delete("/topics/#{topic_key}")
+      end
     end
   end
 end

data/lib/novu/client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "novu/api/blueprints"
 require "novu/api/changes"
 require "novu/api/connection"
 require "novu/api/environments"
@@ -13,12 +14,15 @@ require "novu/api/messages"
 require "novu/api/notification_groups"
 require "novu/api/notification_templates"
 require "novu/api/notification"
+require "novu/api/organizations"
 require "novu/api/subscribers"
+require "novu/api/tenants"
 require "novu/api/topics"
 
 module Novu
   class Client
     include HTTParty
+    include Novu::Api::Blueprints
     include Novu::Api::Changes
     include Novu::Api::Connection
     include Novu::Api::Environments
@@ -32,19 +36,56 @@ module Novu
     include Novu::Api::NotificationGroups
     include Novu::Api::NotificationTemplates
     include Novu::Api::Notification
+    include Novu::Api::Organizations
     include Novu::Api::Subscribers
+    include Novu::Api::Tenants
     include Novu::Api::Topics
 
     base_uri "https://api.novu.co/v1"
     format :json
 
-    def initialize(access_token = nil)
+    attr_accessor :enable_retry, :max_retries, :initial_delay, :max_delay, :idempotency_key
+
+    # @param `access_token` [String]
+    # @param `idempotency_key` [String]
+    # @param `enable_retry` [Boolean]
+    # @param `retry_config` [Hash]
+    #           - max_retries [Integer]
+    #           - initial_delay [Integer]
+    #           - max_delay [Integer]
+    def initialize(access_token: nil, idempotency_key: nil, enable_retry: false, retry_config: {} )
       raise ArgumentError, "Api Key cannot be blank or nil" if access_token.blank?
 
+      @idempotency_key = idempotency_key.blank? ? UUID.new.generate : idempotency_key
+
+      @enable_retry = enable_retry
       @access_token = access_token.to_s.strip
+      @retry_attempts = 0
+
+      retry_config = defaults_retry_config.merge(retry_config)
+      @max_retries = retry_config[:max_retries]
+      @initial_delay = retry_config[:initial_delay]
+      @max_delay = retry_config[:max_delay]
+
       self.class.default_options.merge!(headers: { "Authorization" => "ApiKey #{@access_token}" })
+
+      # Configure the exponential backoff - specifying initial and maximal delays, default is 4s and 60s respectively
+      if @enable_retry
+        @retry_config = retry_config
+        @backoff = ExponentialBackoff.new(@initial_delay, @max_delay)
+      end
     rescue ArgumentError => e
       puts "Error initializing Novu client: #{e.message}"
     end
+
+    private 
+
+    # @retun [Hash]
+    #   - max_retries [Integer]
+    #   - initial_delay [Integer]
+    #   - max_delay [Integer]
+    def defaults_retry_config
+      { max_retries: 1, initial_delay: 4, max_delay: 60 }
+    end
   end
 end

data/lib/novu/version.rb

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

data/lib/novu.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require "active_support/core_ext/hash"
+require "exponential_backoff"
 require "httparty"
 require_relative "novu/version"
 require_relative "novu/client"
+require "uuid"
 
 module Novu
   # class Error < StandardError; end

data/techstack.md

@@ -0,0 +1,125 @@
+<!--
+&lt;--- Readme.md Snippet without images Start ---&gt;
+## Tech Stack
+novuhq/novu-ruby is built on the following main stack:
+
+- [Ruby](https://www.ruby-lang.org) – Languages
+- [RSpec](https://rspec.info/) – Testing Frameworks
+- [RuboCop](http://batsov.com/rubocop/) – Code Review
+- [Shell](https://en.wikipedia.org/wiki/Shell_script) – Shells
+- [GitHub Actions](https://github.com/features/actions) – Continuous Integration
+
+Full tech stack [here](/techstack.md)
+
+&lt;--- Readme.md Snippet without images End ---&gt;
+
+&lt;--- Readme.md Snippet with images Start ---&gt;
+## Tech Stack
+novuhq/novu-ruby is built on the following main stack:
+
+- <img width='25' height='25' src='https://img.stackshare.io/service/989/ruby.png' alt='Ruby'/> [Ruby](https://www.ruby-lang.org) – Languages
+- <img width='25' height='25' src='https://img.stackshare.io/service/2539/logo.png' alt='RSpec'/> [RSpec](https://rspec.info/) – Testing Frameworks
+- <img width='25' height='25' src='https://img.stackshare.io/service/2643/rubocop.png' alt='RuboCop'/> [RuboCop](http://batsov.com/rubocop/) – Code Review
+- <img width='25' height='25' src='https://img.stackshare.io/service/4631/default_c2062d40130562bdc836c13dbca02d318205a962.png' alt='Shell'/> [Shell](https://en.wikipedia.org/wiki/Shell_script) – Shells
+- <img width='25' height='25' src='https://img.stackshare.io/service/11563/actions.png' alt='GitHub Actions'/> [GitHub Actions](https://github.com/features/actions) – Continuous Integration
+
+Full tech stack [here](/techstack.md)
+
+&lt;--- Readme.md Snippet with images End ---&gt;
+-->
+<div align="center">
+
+# Tech Stack File
+![](https://img.stackshare.io/repo.svg "repo") [novuhq/novu-ruby](https://github.com/novuhq/novu-ruby)![](https://img.stackshare.io/public_badge.svg "public")
+<br/><br/>
+|11<br/>Tools used|01/05/24 <br/>Report generated|
+|------|------|
+</div>
+
+## <img src='https://img.stackshare.io/languages.svg'/> Languages (1)
+<table><tr>
+  <td align='center'>
+  <img width='36' height='36' src='https://img.stackshare.io/service/989/ruby.png' alt='Ruby'>
+  <br>
+  <sub><a href="https://www.ruby-lang.org">Ruby</a></sub>
+  <br>
+  <sub></sub>
+</td>
+
+</tr>
+</table>
+
+## <img src='https://img.stackshare.io/devops.svg'/> DevOps (5)
+<table><tr>
+  <td align='center'>
+  <img width='36' height='36' src='https://img.stackshare.io/service/1046/git.png' alt='Git'>
+  <br>
+  <sub><a href="http://git-scm.com/">Git</a></sub>
+  <br>
+  <sub></sub>
+</td>
+
+<td align='center'>
+  <img width='36' height='36' src='https://img.stackshare.io/service/11563/actions.png' alt='GitHub Actions'>
+  <br>
+  <sub><a href="https://github.com/features/actions">GitHub Actions</a></sub>
+  <br>
+  <sub></sub>
+</td>
+
+<td align='center'>
+  <img width='36' height='36' src='https://img.stackshare.io/service/2539/logo.png' alt='RSpec'>
+  <br>
+  <sub><a href="https://rspec.info/">RSpec</a></sub>
+  <br>
+  <sub>v3.12.0</sub>
+</td>
+
+<td align='center'>
+  <img width='36' height='36' src='https://img.stackshare.io/service/2643/rubocop.png' alt='RuboCop'>
+  <br>
+  <sub><a href="http://batsov.com/rubocop/">RuboCop</a></sub>
+  <br>
+  <sub>v1.46.0</sub>
+</td>
+
+<td align='center'>
+  <img width='36' height='36' src='https://img.stackshare.io/service/12795/5jL6-BA5_400x400.jpeg' alt='RubyGems'>
+  <br>
+  <sub><a href="https://rubygems.org/">RubyGems</a></sub>
+  <br>
+  <sub></sub>
+</td>
+
+</tr>
+</table>
+
+## Other (1)
+<table><tr>
+  <td align='center'>
+  <img width='36' height='36' src='https://img.stackshare.io/service/4631/default_c2062d40130562bdc836c13dbca02d318205a962.png' alt='Shell'>
+  <br>
+  <sub><a href="https://en.wikipedia.org/wiki/Shell_script">Shell</a></sub>
+  <br>
+  <sub></sub>
+</td>
+
+</tr>
+</table>
+
+
+## <img src='https://img.stackshare.io/group.svg' /> Open source packages (4)</h2>
+
+## <img width='24' height='24' src='https://img.stackshare.io/service/12795/5jL6-BA5_400x400.jpeg'/> RubyGems (4)
+
+|NAME|VERSION|LAST UPDATED|LAST UPDATED BY|LICENSE|VULNERABILITIES|
+|:------|:------|:------|:------|:------|:------|
+|[activesupport](https://rubygems.org/activesupport)|v6.1.7|10/12/23|unicodeveloper |MIT|N/A|
+|[httparty](https://rubygems.org/httparty)|v0.21.0|10/12/23|unicodeveloper |MIT|N/A|
+|[rake](https://rubygems.org/rake)|v13.0.6|02/28/23|Aman Saini |MIT|N/A|
+|[webmock](https://rubygems.org/webmock)|v3.18.1|03/10/23|Aman Saini |MIT|N/A|
+
+<br/>
+<div align='center'>
+
+Generated via [Stack File](https://github.com/marketplace/stack-file)