novu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fc42d2af18f6aaf2fec816e562d11e87564ed50b2c553536c6a04acbf91fc57
+  data.tar.gz: efac155226cf82453269bf17f5a01ecbe202914eb4291329d044df7f4d3f6133
+SHA512:
+  metadata.gz: 3d97dbeb4725243fb3437208fcb825ea8fd5dcc927bbfc5b11a02dfb0f4eeb054f69a8018da3f1aba39538db92fdc450ccc65c2375ca76c3ed453a428e04fe10
+  data.tar.gz: c1a0e10ac3c364ade53a4d93e33e9046a37b6a9244e9d35a85f502c6df4c3c47d22e80a79c70a8625c6805ce0c3f62a98f761789a221ab4cdd1a90bacf54ee89

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-28
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at aman.saini@cogoport.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in novu.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :test do
+  gem 'rspec'
+  gem "webmock"
+end
+
+gem "rubocop", "~> 1.21"
+
+gem 'pry-debugger-jruby'

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    novu (0.1.0)
+      activesupport
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.7.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    ffi (1.15.5-java)
+    hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3-java)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.17.0)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.2-java)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      spoon (~> 0.0)
+    pry-debugger-jruby (2.1.1-java)
+      pry (>= 0.13, < 0.15)
+      ruby-debug-base (>= 0.10.4, < 0.12)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.46.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-debug-base (0.11.0-java)
+    ruby-progressbar (1.11.0)
+    spoon (0.0.6)
+      ffi
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  universal-java-17
+
+DEPENDENCIES
+  novu!
+  pry-debugger-jruby
+  rake (~> 13.0)
+  rspec
+  rubocop (~> 1.21)
+  webmock
+
+BUNDLED WITH
+   2.4.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Aman Saini
+
+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,156 @@
+# Novu ruby client library
+
+This is a Ruby client library for communicating with the [Novu API](https://api.novu.co/api).
+
+## Installation
+
+You can install the client library via RubyGems:
+
+```ruby
+gem install novu
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem 'novu'
+```
+
+Then run `bundle install`.
+
+## Usage
+
+To use the library, first initialize the client with your API token:
+
+```ruby
+require 'novu'
+
+client = Novu::Client.new('MY_API_TOKEN')
+```
+
+You can then call methods on the client to interact with the Novu API:
+
+```ruby
+client.notifications
+```
+
+## List of all methods
+
+The client methods map directly to the Novu API endpoints. Here's a list of all the available methods. Check [the API docs](https://docs.novu.co/api/overview) for list of available `methods`.
+
+### Changes
+
+- `changes(query = {})`
+- `count_changes()`
+- `apply_bulk_changes()`
+- `apply_change(change_id)`
+
+### Environments
+
+- `current_environment()`
+- `create_environment(body)`
+- `environments()`
+- `update_environment(environment_id, body)`
+- `api_keys()`
+- `regenerate_api_keys()`
+- `update_widget_settings(body)`
+
+### Events
+
+- `trigger_event(body)`
+- `trigger_bulk_event(body)`
+- `broadcast_event(body)`
+- `cancel_triggered_event(transaction_id)`
+
+### Execution Details
+
+- `execution_details(query = {})`
+
+### Feeds
+
+- `create_feed(body)`
+- `feeds()`
+- `delete_feed(feed_id)`
+
+### Inbound Parse
+
+- `validate_mx_record_setup_for_inbound_parse()`
+
+### Integrations
+
+- `integrations()`
+- `create_integration(body)`
+- `active_integrations()`
+- `webhook_provider_status(provider_id)`
+- `update_integration(integration_id, body)`
+- `delete_integration(integration_id)`
+- `channel_limit(channel_type)`
+- `in_app_status()`
+
+### Layouts
+
+- `create_layout(body) `
+- `layouts(query = {})`
+- `layout(layout_id)`
+- `delete_layout(layout_id)`
+- `update_layout(layout_id, body)`
+- `make_default_layout(layout_id)`
+
+### Messages
+
+- `messages(query = {})`
+- `delete_message(message_id)`
+
+### Notification Groups
+
+- `create_notification_group(body)`
+- `notification_groups()`
+
+### Notification Templates
+
+- `notification_templates(query = {})`
+- `create_notification_template(body)`
+- `update_notification_template(template_id, body)`
+- `delete_notification_template(template_id)`
+- `notification_template(template_id)`
+- `notification_template_blueprint(template_id)`
+- `create_notification_template_blueprint(template_id)`
+- `update_notification_template_status(template_id, body)`
+
+### Notification
+
+- `notifications(query = {})`
+- `notifications_stats()`
+- `notifications_graph_stats(query = {})`
+- `notification(notification_id)`
+
+### Subscribers
+
+- `subscribers(query = {}) `
+- `create_subscriber(body)`
+- `subscriber(subscriber_id)`
+- `update_subscriber(subscriber_id, body)`
+- `delete_subscriber(subscriber_id)`
+- `update_subscriber_credentials(subscriber_id, body)`
+- `update_subscriber_online_status(subscriber_id, body)`
+- `subscriber_preferences(subscriber_id)`
+- `update_subscriber_preference(subscriber_id, template_id, body)`
+- `subscriber_notification_feed(subscriber_id, query = {})`
+- `subscriber_unseen_notification_count(subscriber_id, query = {})`
+- `mark_subscriber_feed_seen(subscriber_id, body)`
+- `mark_message_action_seen(subscriber_id, message_id, type)`
+
+### Topics
+
+- `create_topic(body)`
+- `topics(query = {})`
+- `add_subscribers(topic_key, body)`
+- `remove_subscribers(topic_key, body)`
+- `topic(topic_key)`
+- `rename_topic(topic_key, body)`
+
+### For more information about these methods and their parameters, see the [API documentation](https://docs.novu.co/api/overview).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/novu/api/changes.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Novu
+  class Api
+    # Module Novu::Api::Changes provides an API for managing changes in the Novu application.
+    #
+    # This module includes methods for retrieving, count, and applying bulk changes.
+    #
+    # For more information on the Novu API(https://api.novu.co/api#/Changes), see https://docs.novu.co/api/get-changes/.
+    module Changes
+      # Returns a list of changes that can be paginated using the `page` query parameter
+      #
+      # @queryparams:
+      # @param `page` [Integer(optional)] Number of page for the pagination.
+      # @param `limit` [Integer(optional)]
+      # @param `promoted` [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 changes(query = {})
+        get("/changes", query: query)
+      end
+
+      # Returns changes count
+      #
+      # @return [Hash] changes count
+      # @return [number] status
+      #  - Returns 200 if successful
+      def count_changes
+        get("/changes/count")
+      end
+
+      # Apply Bulk Change
+      #
+      # @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")
+      end
+
+      # Apply change
+      #
+      # @pathparams:
+      # @param `change_id` [Integer] The ID of the change to update.
+      #
+      # @return [Hash] updated change.
+      # @return [number] status
+      #  - Returns 201 if the change with the change_id provided has been updated correctly.
+      def apply_change(change_id)
+        post("/changes/#{change_id}/apply")
+      end
+    end
+  end
+end

data/lib/novu/api/connection.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Novu
+  class Api
+    module Connection
+      def get(path, options = {})
+        request :get, path, options
+      end
+
+      def post(path, options = {})
+        request :post, path, options
+      end
+
+      def put(path, options = {})
+        request :put, path, options
+      end
+
+      def patch(path, options = {})
+        request :patch, path, options
+      end
+
+      def delete(path, options = {})
+        request :delete, path, options
+      end
+
+      private
+
+      def request(http_method, path, options)
+        response = self.class.send(http_method, path, options)
+      end
+    end
+  end
+end

data/lib/novu/api/environments.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Novu
+  class Api
+    # Module Novu::Api::Environments provides an API for managing environments in the Novu application.
+    #
+    # This module includes methods for creating, retrieving, and updating environments.
+    # It also includes methods for getting and regenerating the api keys also for updatation of widget settings .
+    #
+    # For more information on the Novu API(https://api.novu.co/api#/Environments), see https://docs.novu.co/api/get-current-environment/.
+    module Environments
+      # Retrieves the current environment
+      #
+      # @return [Hash] The retrieved environment.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def current_environment
+        get("/environments/me")
+      end
+
+      # Creates a new environment.
+      #
+      # @bodyparams:
+      # @param `name` [String]
+      # @param `parentId` [String(optional)]
+      #
+      # @return [Hash]  The created environment entity.
+      # @return [number] status - The status code. Returns 201 if the environment has been successfully created.
+      def create_environment(body)
+        post("/environments", body: body)
+      end
+
+      # Returns a list of environments
+      #
+      # @return [Hash] The list of environments.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def environments
+        get("/environments")
+      end
+
+      # Update the environment.
+      #
+      # @pathparams:
+      # @param `environment_id` [String] The ID of the environment to update.
+      #
+      # @bodyparams
+      # @param `name` [String(optional)]
+      # @param `identifier` [String(optional)]
+      # @param `parentId` [String(optional)]
+      # @param `dns` [Hash]
+      #
+      # @return [Hash] The updated environment.
+      # @return [number] status
+      #  - Returns 200 if the environment with the environment_id provided has been updated correctly.
+      def update_environment(environment_id, body)
+        put("/environments/#{environment_id}", body: body)
+      end
+
+      # Returns a list of api keys
+      #
+      # @return [Hash] The list of api keys.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def api_keys
+        get("/environments/api-keys")
+      end
+
+      # Return regenerated api keys
+      #
+      # @return [Hash] Api keys.
+      # @return [number] status
+      #  - Returns 200 if successful
+      def regenerate_api_keys
+        post("/environments/api-keys/regenerate")
+      end
+
+      # Update the widget settings.
+      #
+      # @bodyparams
+      # @param `notificationCenterEncryption` [Boolean]
+      #
+      # @return [Hash] The updated environment entity.
+      # @return [number] status
+      #  - Returns 200 if the environment entity updated.
+      def update_widget_settings(body)
+        put("/environments/widget/settings", body: body)
+      end
+    end
+  end
+end