teleflow 2.0.0

data/lib/teleflow/api/tenants.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Tenants provides an API for managing tenants in the Teleflow application.
+    #
+    # This module includes methods for creating, retrieving, updating and deleting tenant.
+    #
+    # For more information on the tenants feature (https://docs.teleflow.khulnasoft.com/tenants/introduction), 
+    # for API documentation see https://docs.teleflow.khulnasoft.com/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/teleflow/api/topics.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Teleflow
+  class Api
+    # Module Teleflow::Api::Topics provides an API for managing topics in the Teleflow 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 Teleflow API(https://api-teleflow.khulnasoft.com/api#/Topics), see https://docs.teleflow.khulnasoft.com/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
+
+      # 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
+      # @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
+
+      # 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/teleflow/client.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "teleflow/api/blueprints"
+require "teleflow/api/changes"
+require "teleflow/api/connection"
+require "teleflow/api/environments"
+require "teleflow/api/events"
+require "teleflow/api/execution_details"
+require "teleflow/api/feeds"
+require "teleflow/api/inbound_parse"
+require "teleflow/api/integrations"
+require "teleflow/api/layouts"
+require "teleflow/api/messages"
+require "teleflow/api/notification_groups"
+require "teleflow/api/notification_templates"
+require "teleflow/api/notification"
+require "teleflow/api/organizations"
+require "teleflow/api/subscribers"
+require "teleflow/api/tenants"
+require "teleflow/api/topics"
+require_relative "version"
+
+module Teleflow
+  class Client
+    include HTTParty
+    include Teleflow::Api::Blueprints
+    include Teleflow::Api::Changes
+    include Teleflow::Api::Connection
+    include Teleflow::Api::Environments
+    include Teleflow::Api::Events
+    include Teleflow::Api::ExecutionDetails
+    include Teleflow::Api::Feeds
+    include Teleflow::Api::InboundParse
+    include Teleflow::Api::Integrations
+    include Teleflow::Api::Layouts
+    include Teleflow::Api::Messages
+    include Teleflow::Api::NotificationGroups
+    include Teleflow::Api::NotificationTemplates
+    include Teleflow::Api::Notification
+    include Teleflow::Api::Organizations
+    include Teleflow::Api::Subscribers
+    include Teleflow::Api::Tenants
+    include Teleflow::Api::Topics
+
+    format :json
+
+    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: {}, backend_url: "https://api-teleflow.khulnasoft.com/v1")
+      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.base_uri(backend_url)
+
+      self.class.default_options.merge!(headers: { 
+					"Authorization" => "ApiKey #{@access_token}",
+					"User-Agent" => "teleflow/ruby/#{Teleflow::VERSION}" 
+				}
+			)
+
+      # 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 Teleflow 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/teleflow/version.rb

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

data/lib/teleflow.rb

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

data/sig/teleflow.rbs

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

data/techstack.md

@@ -0,0 +1,125 @@
+<!--
+&lt;--- Readme.md Snippet without images Start ---&gt;
+## Tech Stack
+nxpkg/teleflow-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
+nxpkg/teleflow-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") [nxpkg/teleflow-ruby](https://github.com/nxpkg/teleflow-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)

data/techstack.yml

@@ -0,0 +1,152 @@
+repo_name: nxpkg/teleflow-ruby
+report_id: 64174126c2978ebffd866b5b5a64f248
+version: 0.1
+repo_type: Public
+timestamp: '2024-01-05T09:22:44+00:00'
+requested_by: sumitsaurabh927
+provider: github
+branch: main
+detected_tools_count: 11
+tools:
+- name: Ruby
+  description: A dynamic, interpreted, open source programming language with a focus
+    on simplicity and productivity
+  website_url: https://www.ruby-lang.org
+  open_source: true
+  hosted_saas: false
+  category: Languages & Frameworks
+  sub_category: Languages
+  image_url: https://img.stackshare.io/service/989/ruby.png
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby
+  detection_source: Repo Metadata
+- name: Git
+  description: Fast, scalable, distributed revision control system
+  website_url: http://git-scm.com/
+  open_source: true
+  hosted_saas: false
+  category: Build, Test, Deploy
+  sub_category: Version Control System
+  image_url: https://img.stackshare.io/service/1046/git.png
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby
+  detection_source: Repo Metadata
+- name: GitHub Actions
+  description: Automate your workflow from idea to production
+  website_url: https://github.com/features/actions
+  open_source: false
+  hosted_saas: true
+  category: Build, Test, Deploy
+  sub_category: Continuous Integration
+  image_url: https://img.stackshare.io/service/11563/actions.png
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby/blob/main/.github/workflows/release.yml
+  detection_source: ".github/workflows/release.yml"
+  last_updated_by: Kolawole Ezekiel
+  last_updated_on: 2023-10-09 13:30:34.000000000 Z
+- name: RSpec
+  description: Behaviour Driven Development for Ruby
+  website_url: https://rspec.info/
+  version: 3.12.0
+  license: MIT
+  open_source: true
+  hosted_saas: false
+  category: Build, Test, Deploy
+  sub_category: Testing Frameworks
+  image_url: https://img.stackshare.io/service/2539/logo.png
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby/blob/main/Gemfile.lock
+  detection_source: Gemfile
+  last_updated_by: Aman Saini
+  last_updated_on: 2023-02-28 06:58:36.000000000 Z
+- name: RuboCop
+  description: A Ruby static code analyzer, based on the community Ruby style guide
+  website_url: http://batsov.com/rubocop/
+  version: 1.46.0
+  license: MIT
+  open_source: true
+  hosted_saas: false
+  category: Build, Test, Deploy
+  sub_category: Code Review
+  image_url: https://img.stackshare.io/service/2643/rubocop.png
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby/blob/main/Gemfile.lock
+  detection_source: Gemfile
+  last_updated_by: Aman Saini
+  last_updated_on: 2023-02-28 06:58:36.000000000 Z
+- name: RubyGems
+  description: Easily download, install, and use ruby software packages on your system
+  website_url: https://rubygems.org/
+  open_source: false
+  hosted_saas: false
+  category: Build, Test, Deploy
+  sub_category: Package Managers
+  image_url: https://img.stackshare.io/service/12795/5jL6-BA5_400x400.jpeg
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby/blob/main/teleflow.gemspec
+  detection_source: teleflow.gemspec
+  last_updated_by: Aman Saini
+  last_updated_on: 2023-02-28 06:58:36.000000000 Z
+- name: Shell
+  description: A shell is a text-based terminal, used for manipulating programs and
+    files. Shell scripts typically manage program execution.
+  website_url: https://en.wikipedia.org/wiki/Shell_script
+  open_source: false
+  hosted_saas: false
+  category: Languages & Frameworks
+  sub_category: Languages
+  image_url: https://img.stackshare.io/service/4631/default_c2062d40130562bdc836c13dbca02d318205a962.png
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby
+  detection_source: Repo Metadata
+- name: activesupport
+  description: A toolkit of support libraries and Ruby core extensions extracted from
+    the Rails framework
+  package_url: https://rubygems.org/activesupport
+  version: 6.1.7
+  license: MIT
+  open_source: true
+  hosted_saas: false
+  category: Libraries
+  sub_category: RubyGems Packages
+  image_url: https://img.stackshare.io/package/18817/default_b17f14dbef6c1275120b34d9ec2eff5942499bd5.png
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby/blob/main/Gemfile.lock
+  detection_source: teleflow.gemspec
+  last_updated_by: unicodeveloper
+  last_updated_on: 2023-10-12 04:34:34.000000000 Z
+- name: httparty
+  description: Makes http fun! Also
+  package_url: https://rubygems.org/httparty
+  version: 0.21.0
+  license: MIT
+  open_source: true
+  hosted_saas: false
+  category: Libraries
+  sub_category: RubyGems Packages
+  image_url: https://img.stackshare.io/package/18832/default_8c2fa81d8b8e48c679685199823ce30d598d3e87.png
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby/blob/main/Gemfile.lock
+  detection_source: teleflow.gemspec
+  last_updated_by: unicodeveloper
+  last_updated_on: 2023-10-12 04:34:34.000000000 Z
+- name: rake
+  description: Rake is a Make-like program implemented in Ruby
+  package_url: https://rubygems.org/rake
+  version: 13.0.6
+  license: MIT
+  open_source: true
+  hosted_saas: false
+  category: Libraries
+  sub_category: RubyGems Packages
+  image_url: https://img.stackshare.io/package/18812/default_f582e4648f4682adb72d2b201218cda7f8e894ac.png
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby/blob/main/Gemfile.lock
+  detection_source: Gemfile
+  last_updated_by: Aman Saini
+  last_updated_on: 2023-02-28 06:58:36.000000000 Z
+- name: webmock
+  description: WebMock allows stubbing HTTP requests and setting expectations on HTTP
+    requests
+  package_url: https://rubygems.org/webmock
+  version: 3.18.1
+  license: MIT
+  open_source: true
+  hosted_saas: false
+  category: Libraries
+  sub_category: RubyGems Packages
+  image_url: https://img.stackshare.io/package/18824/default_6564ae059af6c4ea7065fd2329370c7a05341cf8.png
+  detection_source_url: https://github.com/nxpkg/teleflow-ruby/blob/main/Gemfile.lock
+  detection_source: Gemfile
+  last_updated_by: Aman Saini
+  last_updated_on: 2023-03-10 06:01:34.000000000 Z