zanshin 1.0.1

data/lib/zanshin/client.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require 'configparser'
+require 'uri'
+require 'logger'
+
+require_relative 'request/zanshin_request'
+require_relative 'account'
+require_relative 'alerts'
+require_relative 'organization_followers'
+require_relative 'organization_following'
+require_relative 'organization_members'
+require_relative 'organization_scan_targets'
+require_relative 'organizations'
+require_relative 'summaries'
+
+module Zanshin
+  module SDK
+    # Zanshin SDK Client
+    class Client
+      include Zanshin::SDK::Account
+      include Zanshin::SDK::Alerts
+      include Zanshin::SDK::Organizations
+      include Zanshin::SDK::OrganizationFollowers
+      include Zanshin::SDK::OrganizationFollowing
+      include Zanshin::SDK::OrganizationMembers
+      include Zanshin::SDK::OrganizationScanTargets
+      include Zanshin::SDK::Summaries
+
+      # @overload api_key
+      #   Gets the current value of api_key
+      #   @return api_key
+      # @overload api_key=(value)
+      #   Sets the api_key
+      #   @param [value] the new api_key
+      attr_reader :api_key
+      # @overload api_url
+      #   Gets the current value of api_url
+      #   @return api_url
+      # @overload api_url=(value)
+      #   Sets the api_url
+      #   @param [value] the new api_url
+      attr_reader :api_url
+      # @overload user_agent
+      #   Gets the current value of user_agent
+      #   @return user_agent
+      # @overload user_agent=(value)
+      #   Sets the user_agent
+      #   @param [value] the new user_agent
+      attr_reader :user_agent
+      # @overload proxy_url
+      #   Gets the current value of proxy_url
+      #   @return proxy_url
+      # @overload proxy_url=(value)
+      #   Sets the proxy_url
+      #   @param [value] the new proxy_url
+      attr_reader :proxy_url
+
+      # @overload http
+      #   Gets the current value of http
+      #   @return http
+      # @overload http=(`:HTTPClient`)
+      #   Sets the http
+      #   @param [value] the new http
+      attr_accessor :http
+
+      # Initialize a new Zanshin SDK instance
+      # @overload initialize(profile, api_key, api_url, user_agent, proxy_url)
+      #   @param profile [String] Which configuration file section to use for settings
+      #   @param api_key [String] Optional override of the API key to use
+      #   @param api_url [String] Optional override of the base URL of the Zanshin API to use
+      #   @param user_agent [String] Optional addition of the user agent to use in requests performed
+      #   @param proxy_url [String] Optional URL indicating which proxy server to use
+      def initialize(profile: 'default',
+                     api_key: ENV.fetch('ZANSHIN_API_KEY', nil),
+                     api_url: ENV.fetch('ZANSHIN_API_URL', nil) || ZANSHIN_API,
+                     user_agent: ENV.fetch('ZANSHIN_USER_AGENT', nil),
+                     proxy_url: ENV.fetch('HTTP_PROXY', ENV.fetch('HTTPS_PROXY', nil)))
+        @logger = Logger.new($stdout)
+        @logger.level = Logger::WARN
+
+        config = get_config(profile)
+
+        @api_key = api_key || config['api_key'] || raise('No API key found')
+        @api_url = validate_url(api_url || config['api_url'])
+        @user_agent = add_sdk_agent(user_agent || config['user_agent'])
+        @proxy_url = validate_proxy(proxy_url || config['proxy_url'])
+
+        update_request
+        @logger.debug('Zanshin SDK Initialized')
+      end
+
+      def api_key=(value)
+        raise('API key cannot be nil') unless value
+
+        @api_key = value
+
+        update_request
+      end
+
+      def api_url=(value)
+        @api_url = validate_url(value)
+
+        update_request
+      end
+
+      def user_agent=(value)
+        @user_agent = add_sdk_agent(value)
+
+        update_request
+      end
+
+      def proxy_url=(value)
+        @proxy_url = validate_proxy(value)
+
+        update_request
+      end
+
+      private
+
+      attr_accessor :logger
+
+      # Internal method to read user configuration file
+      def get_config(profile)
+        parser = if File.exist?(File.expand_path(CONFIG_FILE))
+                   ConfigParser.new(CONFIG_FILE)
+                 else
+                   raise("Not found #{CONFIG_FILE}")
+                 end
+        raise "Profile #{profile} not found in #{CONFIG_FILE}" unless parser[profile]
+
+        parser[profile]
+      end
+
+      # Internal method to validate URL
+      def validate_url(url)
+        raise 'API URL cannot be nil' unless url
+
+        uri = URI(url)
+        if (uri.scheme != 'https') ||
+           !uri.host ||
+           (uri.password || uri.user) ||
+           !uri.port.between?(0, 65_535)
+          raise "Invalid API URL: #{url}"
+        end
+
+        url
+      end
+
+      # Internal method to validate proxy
+      def validate_proxy(proxy_url)
+        return nil unless proxy_url
+
+        proxy = URI(proxy_url)
+        if !(%w[http https].include? proxy.scheme) ||
+           !proxy.host ||
+           (proxy.user && !proxy.password) ||
+           !proxy.port.between?(0, 65_535)
+          raise "Invalid proxy URL: #{proxy_url}"
+        end
+
+        proxy_url
+      end
+
+      # Internal method to concatenate user-agent with SDK pattern
+      def add_sdk_agent(agent)
+        if agent.to_s.strip.empty?
+          "Zanshin Ruby SDK #{Zanshin::SDK::VERSION}"
+        else
+          "#{agent}/Zanshin Ruby SDK #{Zanshin::SDK::VERSION}"
+        end
+      end
+
+      # Internal method to create a new pre-configured Zanshin::SDK::Request::HTTPClient instance when one
+      #   of the relevant settings is changed (API key, API URL, user-agent or Proxy URL).
+      def update_request
+        @http = Zanshin::SDK::Request::HTTPClient.new(@api_key, @api_url, @user_agent, @proxy_url)
+      end
+
+      # Internal method to validate UUID
+      def validate_uuid(uuid)
+        uuid_regex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
+        raise "#{uuid} is not a valid UUID" unless uuid_regex.match?(uuid.to_s.downcase)
+
+        uuid
+      end
+    end
+  end
+end

data/lib/zanshin/organization_followers.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Zanshin
+  module SDK
+    # Zanshin SDK Organization Followers
+    module OrganizationFollowers
+      ###################################################
+      # Organization Follower
+      ###################################################
+
+      # Organization Followers Enumerator of an organization
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrganizationFollowers)
+      #
+      # @param organization_id [UUID] of the organization
+      #
+      # @return an Organization Followers Enumerator object
+      def iter_organization_followers(organization_id)
+        Enumerator.new do |yielder|
+          @http.request('GET', "/organizations/#{validate_uuid(organization_id)}/followers").each do |e|
+            yielder.yield e
+          end
+        end
+      end
+
+      # Organization Followers Enumerator of an organization
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrganizationFollowers)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param follower_id [UUID] of the follower
+      #
+      # @return a Boolean with result
+      def stop_organization_follower(organization_id, follower_id)
+        @http.request('DELETE',
+                      "/organizations/#{validate_uuid(organization_id)}/followers/#{validate_uuid(follower_id)}")
+      end
+
+      ###################################################
+      # Organization Follower Request
+      ###################################################
+
+      # Organization Followers Requests Enumerator of an organization
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrganizationFollowRequests)
+      #
+      # @param organization_id [UUID] of the organization
+      #
+      # @return an Organization Followers Requests Enumerator object
+      def iter_organization_follower_requests(organization_id)
+        Enumerator.new do |yielder|
+          @http.request('GET', "/organizations/#{validate_uuid(organization_id)}/followers/requests").each do |e|
+            yielder.yield e
+          end
+        end
+      end
+
+      # Create organization follower request
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/createOrganizationFollowRequests)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param token [UUID] of the follower request
+      #
+      # @return an Organization Followers Requests Enumerator object
+      def create_organization_follower_request(organization_id, token)
+        body = {
+          'token' => validate_uuid(token)
+        }
+        @http.request('POST', "/organizations/#{validate_uuid(organization_id)}/followers/requests", body)
+      end
+
+      # Get organization follower request
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrganizationFollowRequestsByToken)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param token [UUID] of the follower request
+      #
+      # @return an Object representing the organization follower
+      def get_organization_follower_request(organization_id, token)
+        @http.request('GET',
+                      "/organizations/#{validate_uuid(organization_id)}/followers/requests/#{validate_uuid(token)}")
+      end
+
+      # Delete organization follower request
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/deleteOrganizationFollowRequestsbyToken)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param token [UUID] of the follower request
+      #
+      # @return a Boolean with result
+      def delete_organization_follower_request(organization_id, token)
+        @http.request('DELETE',
+                      "/organizations/#{validate_uuid(organization_id)}/followers/requests/#{validate_uuid(token)}")
+      end
+    end
+  end
+end

data/lib/zanshin/organization_following.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Zanshin
+  module SDK
+    # Zanshin SDK Organization Following
+    module OrganizationFollowing
+      ###################################################
+      # Organization Following
+      ###################################################
+
+      # Organization Following Enumerator of an organization
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrganizationFollowing)
+      #
+      # @param organization_id [UUID] of the organization
+      #
+      # @return an Organization Following Enumerator object
+      def iter_organization_following(organization_id)
+        Enumerator.new do |yielder|
+          @http.request('GET', "/organizations/#{validate_uuid(organization_id)}/following").each do |e|
+            yielder.yield e
+          end
+        end
+      end
+
+      # Organization Followers Enumerator of an organization
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/removeOrganizationFollowingById)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param following_id [UUID] of the follower
+      #
+      # @return a Boolean with result
+      def stop_organization_following(organization_id, following_id)
+        @http.request('DELETE',
+                      "/organizations/#{validate_uuid(organization_id)}/following/#{validate_uuid(following_id)}")
+      end
+
+      ###################################################
+      # Organization Following Request
+      ###################################################
+
+      # Organization Following Requests Enumerator of an organization
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrganizationFollowingRequests)
+      #
+      # @param organization_id [UUID] of the organization
+      #
+      # @return an Organization Following Requests Enumerator object
+      def iter_organization_following_requests(organization_id)
+        Enumerator.new do |yielder|
+          @http.request('GET', "/organizations/#{validate_uuid(organization_id)}/following/requests").each do |e|
+            yielder.yield e
+          end
+        end
+      end
+
+      # Returns a request received by an organization to follow another
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrganizationFollowingRequestByToken)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param following_id [UUID] of the follower request
+      #
+      # @return an Object representing the organization following request
+      def get_organization_following_request(organization_id, following_id)
+        @http.request(
+          'GET',
+          "/organizations/#{validate_uuid(organization_id)}/following/requests/#{validate_uuid(following_id)}"
+        )
+      end
+
+      # Accepts a request to follow another organization
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/acceptOrganizationFollowingRequestByToken)
+      #
+      # @param organization_id [UUID] of the organization who was invited to follow another
+      # @param following_id [UUID] of the organization who is going to be followed
+      #
+      # @return an Object describing the newly established following relationship
+      def accept_organization_following_request(organization_id, following_id)
+        @http.request(
+          'POST',
+          "/organizations/#{validate_uuid(organization_id)}/following/requests/#{validate_uuid(following_id)}/accept"
+        )
+      end
+
+      # Declines a request to follow another organization
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/declineOrganizationFollowingRequestByToken)
+      #
+      # @param organization_id [UUID] of the organization who was invited to follow another
+      # @param following_id [UUID] of the organization who is going to be followed
+      #
+      # @return an Object describing the newly established following relationship
+      def decline_organization_following_request(organization_id, following_id)
+        @http.request(
+          'POST',
+          "/organizations/#{validate_uuid(organization_id)}/following/requests/#{validate_uuid(following_id)}/decline"
+        )
+      end
+    end
+  end
+end

data/lib/zanshin/organization_members.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module Zanshin
+  module SDK
+    # Zanshin SDK Organization Members
+    module OrganizationMembers
+      ###################################################
+      # Organization Member
+      ###################################################
+
+      # Organization Members Enumerator of the users which are members of an organization
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrganizationMembers)
+      #
+      # @param organization_id [UUID] of the organization
+      #
+      # @return an Organization Members Enumerator object
+      def iter_organization_members(organization_id)
+        Enumerator.new do |yielder|
+          @http.request('GET', "/organizations/#{validate_uuid(organization_id)}/members").each do |e|
+            yielder.yield e
+          end
+        end
+      end
+
+      # Get details on a user's organization membership
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrganizationMemberById)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param member_id [UUID] of the member
+      #
+      # @return a Object representing the organization member
+      def get_organization_member(organization_id, member_id)
+        @http.request('GET',
+                      "/organizations/#{validate_uuid(organization_id)}/members/#{validate_uuid(member_id)}")
+      end
+
+      # Update organization member
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/editOrganizationMembersById)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param member_id [UUID] of the member
+      # @param roles ['ADMIN'] of the member
+      #
+      # @return a Object representing the organization member
+      def update_organization_member(organization_id, member_id, roles = nil)
+        body = {
+          'roles' => [roles].compact
+        }
+        @http.request('PUT',
+                      "/organizations/#{validate_uuid(organization_id)}/members/#{validate_uuid(member_id)}",
+                      body)
+      end
+
+      # Delete organization member
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/removeOrganizationMemberById)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param member_id [UUID] of the member
+      #
+      # @return a Boolean with result
+      def delete_organization_member(organization_id, member_id)
+        @http.request('DELETE',
+                      "/organizations/#{validate_uuid(organization_id)}/members/#{validate_uuid(member_id)}")
+      end
+
+      # Reset organization member MFA
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/resetOrganizationMemberMfaById)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param member_id [UUID] of the member
+      #
+      # @return a Boolean with result
+      def reset_organization_member_mfa(organization_id, member_id)
+        @http.request(
+          'POST',
+          "/organizations/#{validate_uuid(organization_id)}/members/#{validate_uuid(member_id)}/mfa/reset"
+        )
+      end
+
+      # Reset organization member Password
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/resetOrganizationMemberPasswordById)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param member_id [UUID] of the member
+      #
+      # @return a Boolean with result
+      def reset_organization_member_password(organization_id, member_id)
+        @http.request(
+          'POST',
+          "/organizations/#{validate_uuid(organization_id)}/members/#{validate_uuid(member_id)}/password/reset"
+        )
+      end
+
+      ###################################################
+      # Organization Member Invite
+      ###################################################
+
+      # Organization Members Invites Enumerator of an organization
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrgamizationInvites)
+      #
+      # @param organization_id [UUID] of the organization
+      #
+      # @return an Organization Members Invites Enumerator object
+      def iter_organization_members_invites(organization_id)
+        Enumerator.new do |yielder|
+          @http.request('GET', "/organizations/#{validate_uuid(organization_id)}/invites").each do |e|
+            yielder.yield e
+          end
+        end
+      end
+
+      # Create organization member invite
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/createOrgamizationInvite)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param email [String] of the new member
+      # @param roles ['ADMIN'] of the new member
+      #
+      # @return a Object representing the organization member invite
+      def create_organization_members_invite(organization_id, email, roles = nil)
+        body = {
+          'email' => email,
+          'roles' => [roles].compact
+        }
+        @http.request('POST',
+                      "/organizations/#{validate_uuid(organization_id)}/invites",
+                      body)
+      end
+
+      # Get organization member invite
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/getOrganizationInviteByEmail)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param email [String] of the invited member
+      #
+      # @return a Object representing the organization member invite
+      def get_organization_member_invite(organization_id, email)
+        @http.request('GET',
+                      "/organizations/#{validate_uuid(organization_id)}/invites/#{email}")
+      end
+
+      # Delete organization member invite
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/deleteOrganizationInviteByEmail)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param email [String] of the invited member
+      #
+      # @return a Boolean with result
+      def delete_organization_member_invite(organization_id, email)
+        @http.request('DELETE',
+                      "/organizations/#{validate_uuid(organization_id)}/invites/#{email}")
+      end
+
+      # Resend organization member invitation
+      # [#reference](https://api.zanshin.tenchisecurity.com/#operation/resendOrganizationInviteByEmail)
+      #
+      # @param organization_id [UUID] of the organization
+      # @param email [String] of the invited member
+      #
+      # @return a Boolean with result
+      def resend_organization_member_invite(organization_id, email)
+        @http.request('POST',
+                      "/organizations/#{validate_uuid(organization_id)}/invites/#{email}/resend")
+      end
+    end
+  end
+end