knockapi 0.6.1 → 1.1.0

data/lib/knockapi/errors.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Errors
+    class Error < StandardError
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
+    end
+
+    class ConversionError < Knockapi::Errors::Error
+    end
+
+    class APIError < Knockapi::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer, nil]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+        @url = url
+        @status = status
+        @body = body
+        @request = request
+        @response = response
+        super(message)
+      end
+    end
+
+    class APIConnectionError < Knockapi::Errors::APIError
+      # @!attribute status
+      #
+      #   @return [nil]
+
+      # @!attribute body
+      #
+      #   @return [nil]
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+        super
+      end
+    end
+
+    class APITimeoutError < Knockapi::Errors::APIConnectionError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [nil]
+      # @param body [nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+        super
+      end
+    end
+
+    class APIStatusError < Knockapi::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [self]
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+        kwargs = {
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message
+        }
+
+        case status
+        in 400
+          Knockapi::Errors::BadRequestError.new(**kwargs)
+        in 401
+          Knockapi::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          Knockapi::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          Knockapi::Errors::NotFoundError.new(**kwargs)
+        in 409
+          Knockapi::Errors::ConflictError.new(**kwargs)
+        in 422
+          Knockapi::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          Knockapi::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          Knockapi::Errors::InternalServerError.new(**kwargs)
+        else
+          Knockapi::Errors::APIStatusError.new(**kwargs)
+        end
+      end
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      def initialize(url:, status:, body:, request:, response:, message: nil)
+        message ||= {url: url.to_s, status: status, body: body}
+        super(
+          url: url,
+          status: status,
+          body: body,
+          request: request,
+          response: response,
+          message: message&.to_s
+        )
+      end
+    end
+
+    class BadRequestError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Knockapi::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
+  end
+end

data/lib/knockapi/file_part.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Knockapi
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case content
+      in Pathname
+        content.read(binmode: true)
+      in StringIO
+        content.string
+      in IO
+        content.read
+      in String
+        content
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content = content
+      @filename =
+        case content
+        in Pathname
+          filename.nil? ? content.basename.to_path : ::File.basename(filename)
+        else
+          filename.nil? ? nil : ::File.basename(filename)
+        end
+      @content_type = content_type
+    end
+  end
+end

data/lib/knockapi/internal/entries_cursor.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if entries_cursor.has_next?
+    #     entries_cursor = entries_cursor.next_page
+    #   end
+    #
+    # @example
+    #   entries_cursor.auto_paging_each do |user|
+    #     puts(user)
+    #   end
+    class EntriesCursor
+      include Knockapi::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :entries
+
+      # @return [PageInfo]
+      attr_accessor :page_info
+
+      # @return [Boolean]
+      def next_page?
+        !entries.to_a.empty? && !page_info&.after.to_s.empty?
+      end
+
+      # @raise [Knockapi::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Knockapi::Internal::Util.deep_merge(@req, {query: {after: page_info&.after}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.entries&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Knockapi::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {entries: Array => entries}
+          @entries = entries.map { Knockapi::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        case page_data
+        in {page_info: Hash | nil => page_info}
+          @page_info =
+            Knockapi::Internal::Type::Converter.coerce(Knockapi::Internal::EntriesCursor::PageInfo, page_info)
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Knockapi::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+
+      class PageInfo < Knockapi::Internal::Type::BaseModel
+        # @!attribute after
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!method initialize(after: nil)
+        #   @param after [String]
+      end
+    end
+  end
+end

data/lib/knockapi/internal/items_cursor.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if items_cursor.has_next?
+    #     items_cursor = items_cursor.next_page
+    #   end
+    #
+    # @example
+    #   items_cursor.auto_paging_each do |message|
+    #     puts(message)
+    #   end
+    class ItemsCursor
+      include Knockapi::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :items
+
+      # @return [PageInfo]
+      attr_accessor :page_info
+
+      # @return [Boolean]
+      def next_page?
+        !items.to_a.empty? && !page_info&.after.to_s.empty?
+      end
+
+      # @raise [Knockapi::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Knockapi::Internal::Util.deep_merge(@req, {query: {after: page_info&.after}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.items&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Knockapi::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {items: Array => items}
+          @items = items.map { Knockapi::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+        case page_data
+        in {page_info: Hash | nil => page_info}
+          @page_info =
+            Knockapi::Internal::Type::Converter.coerce(Knockapi::Internal::ItemsCursor::PageInfo, page_info)
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Knockapi::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+
+      class PageInfo < Knockapi::Internal::Type::BaseModel
+        # @!attribute after
+        #
+        #   @return [String, nil]
+        optional :after, String
+
+        # @!method initialize(after: nil)
+        #   @param after [String]
+      end
+    end
+  end
+end

data/lib/knockapi/internal/ms_teams_pagination.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if ms_teams_pagination.has_next?
+    #     ms_teams_pagination = ms_teams_pagination.next_page
+    #   end
+    #
+    # @example
+    #   ms_teams_pagination.auto_paging_each do |ms_team|
+    #     puts(ms_team)
+    #   end
+    class MsTeamsPagination
+      include Knockapi::Internal::Type::BasePage
+
+      # @return [String]
+      attr_accessor :skip_token
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :ms_teams_teams
+
+      # @return [Boolean]
+      def next_page?
+        !ms_teams_teams.to_a.empty? && !skip_token.to_s.empty?
+      end
+
+      # @raise [Knockapi::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Knockapi::Internal::Util.deep_merge(@req, {query: {"query_options.$skiptoken": skip_token}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.ms_teams_teams&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Knockapi::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        @skip_token = page_data[:skip_token]
+        case page_data
+        in {ms_teams_teams: Array => ms_teams_teams}
+          @ms_teams_teams = ms_teams_teams.map { Knockapi::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Knockapi::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} skip_token=#{skip_token.inspect}>"
+      end
+    end
+  end
+end

data/lib/knockapi/internal/slack_channels_cursor.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if slack_channels_cursor.has_next?
+    #     slack_channels_cursor = slack_channels_cursor.next_page
+    #   end
+    #
+    # @example
+    #   slack_channels_cursor.auto_paging_each do |slack|
+    #     puts(slack)
+    #   end
+    class SlackChannelsCursor
+      include Knockapi::Internal::Type::BasePage
+
+      # @return [String]
+      attr_accessor :next_cursor
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :slack_channels
+
+      # @return [Boolean]
+      def next_page?
+        !slack_channels.to_a.empty? && !next_cursor.to_s.empty?
+      end
+
+      # @raise [Knockapi::HTTP::Error]
+      # @return [self]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = Knockapi::Internal::Util.deep_merge(@req, {query: {"query_options.cursor": next_cursor}})
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.slack_channels&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [Knockapi::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        @next_cursor = page_data[:next_cursor]
+        case page_data
+        in {slack_channels: Array => slack_channels}
+          @slack_channels = slack_channels.map { Knockapi::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = Knockapi::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} next_cursor=#{next_cursor.inspect}>"
+      end
+    end
+  end
+end