karaden-prg-ruby 1.1.0 → 1.2.1

data/lib/karaden/param/message/bulk/bulk_message_download_params.rb

@@ -0,0 +1,126 @@
+module Karaden
+  module Param
+    module Message
+      module Bulk
+        class BulkMessageDownloadParams < BulkMessageParams
+          attr_accessor :id, :directory_path, :max_retries, :retry_interval
+
+          DEFAULT_MAX_RETRIES = 2
+          MAX_MAX_RETRIES = 5
+          MIN_MAX_RETRIES = 1
+          DEFAULT_RETRY_INTERVAL = 20
+          MAX_RETRY_INTERVAL = 60
+          MIN_RETRY_INTERVAL = 10
+
+          def initialize()
+            @id = nil
+            @directory_path = nil
+            @max_retries = DEFAULT_MAX_RETRIES
+            @retry_interval = DEFAULT_RETRY_INTERVAL
+            super
+          end
+
+          def validate
+            errors = Karaden::Model::KaradenObject.new
+
+            messages = validate_id
+            errors.set_property('id', messages) unless messages.empty?
+
+            messages = validate_directory_path
+            errors.set_property('directory_path', messages) unless messages.empty?
+
+            messages = validate_max_retries
+            errors.set_property('max_retries', messages) unless messages.empty?
+
+            messages = validate_retry_interval
+            errors.set_property('retry_interval', messages) unless messages.empty?
+
+            unless errors.property_keys.filter { |key| !errors.property(key).nil? }.empty?
+              e = Karaden::Exception::InvalidParamsException.new
+              error = Karaden::Model::Error.new
+              error.set_property('object', Karaden::Model::Error::OBJECT_NAME)
+              error.set_property('errors', errors)
+              e.error = error
+              raise e
+            end
+
+            self
+          end
+
+          def self.new_builder
+            BulkMessageDownloadParamsBuilder.new
+          end
+
+          protected
+
+          def validate_id
+            messages = []
+            if @id.nil? || @id == ''
+              messages << 'idは必須です。'
+              messages << '文字列（UUID）を入力してください。'
+            end
+            messages
+          end
+
+          def validate_directory_path
+            messages = []
+            if @directory_path.nil? || @directory_path == ''
+              messages << 'directory_pathは必須です。'
+              messages << '文字列を入力してください。'
+            else
+              messages << '指定されたディレクトリパスが存在しません。' unless Dir.exist?(@directory_path)
+              messages << '指定されたパスはディレクトリではありません。' unless File.directory?(@directory_path)
+              messages << '指定されたディレクトリには読み取り権限がありません。' unless File.readable?(@directory_path)
+              messages << '指定されたディレクトリには書き込み権限がありません。' unless File.writable?(@directory_path)
+            end
+            messages
+          end
+
+          def validate_max_retries
+            messages = []
+            messages << "max_retriesには#{MIN_MAX_RETRIES}以上の整数を入力してください。" if @max_retries.nil? || !@max_retries.is_a?(Integer) || @max_retries < MIN_MAX_RETRIES
+            messages << "max_retriesには#{MAX_MAX_RETRIES}以下の整数を入力してください。" if @max_retries.nil? || !@max_retries.is_a?(Integer) || @max_retries > MAX_MAX_RETRIES
+            messages
+          end
+
+          def validate_retry_interval
+            messages = []
+            messages << "retry_intervalには#{MIN_RETRY_INTERVAL}以上の整数を入力してください。" if @retry_interval.nil? || !@retry_interval.is_a?(Integer) || @retry_interval < MIN_RETRY_INTERVAL
+            messages << "retry_intervalには#{MAX_RETRY_INTERVAL}以下の整数を入力してください。" if @retry_interval.nil? || !@retry_interval.is_a?(Integer) || @retry_interval > MAX_RETRY_INTERVAL
+            messages
+          end
+        end
+
+        class BulkMessageDownloadParamsBuilder
+          def initialize
+            @params = BulkMessageDownloadParams.new
+          end
+
+          def with_id(id)
+            @params.id = id
+            self
+          end
+
+          def with_directory_path(directory_path)
+            @params.directory_path = directory_path
+            self
+          end
+
+          def with_max_retries(max_retries)
+            @params.max_retries = max_retries
+            self
+          end
+
+          def with_retry_interval(retry_interval)
+            @params.retry_interval = retry_interval
+            self
+          end
+
+          def build
+            @params.clone
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karaden/param/message/bulk/bulk_message_list_message_params.rb

@@ -0,0 +1,72 @@
+module Karaden
+  module Param
+    module Message
+      module Bulk
+        class BulkMessageListMessageParams < BulkMessageParams
+          attr_accessor :id
+
+          def initialize()
+            @id = nil
+            super
+          end
+
+          def to_path
+            "#{CONTEXT_PATH}/#{@id}/messages"
+          end
+
+          def validate
+            errors = Karaden::Model::KaradenObject.new
+            has_error = false
+
+            messages = validate_id
+            unless messages.empty?
+              errors.set_property('id', messages)
+              has_error = true
+            end
+
+            if has_error
+              e = Karaden::Exception::InvalidParamsException.new
+              error = Karaden::Model::Error.new
+              error.set_property('object', Karaden::Model::Error::OBJECT_NAME)
+              error.set_property('errors', errors)
+              e.error = error
+              raise e
+            end
+
+            self
+          end
+
+          def self.new_builder
+            BulkMessageListMessageParamsBuilder.new
+          end
+
+          protected
+
+          def validate_id
+            messages = []
+            if @id.nil? || @id == ''
+              messages << 'idは必須です。'
+              messages << '文字列（UUID）を入力してください。'
+            end
+            messages
+          end
+        end
+
+        class BulkMessageListMessageParamsBuilder
+          def initialize
+            @params = BulkMessageListMessageParams.new
+          end
+
+          def with_id(id)
+            @params.id = id
+            self
+          end
+
+          def build
+            @params.clone
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karaden/param/message/bulk/bulk_message_params.rb

@@ -0,0 +1,15 @@
+module Karaden
+  module Param
+    module Message
+      module Bulk
+        class BulkMessageParams
+          CONTEXT_PATH = '/messages/bulks'.freeze
+
+          def validate()
+            self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karaden/param/message/bulk/bulk_message_show_params.rb

@@ -0,0 +1,72 @@
+module Karaden
+  module Param
+    module Message
+      module Bulk
+        class BulkMessageShowParams < BulkMessageParams
+          attr_accessor :id
+
+          def initialize()
+            @id = nil
+            super
+          end
+
+          def to_path
+            "#{CONTEXT_PATH}/#{@id}"
+          end
+
+          def validate
+            errors = Karaden::Model::KaradenObject.new
+            has_error = false
+
+            messages = validate_id
+            unless messages.empty?
+              errors.set_property('id', messages)
+              has_error = true
+            end
+
+            if has_error
+              e = Karaden::Exception::InvalidParamsException.new
+              error = Karaden::Model::Error.new
+              error.set_property('object', Karaden::Model::Error::OBJECT_NAME)
+              error.set_property('errors', errors)
+              e.error = error
+              raise e
+            end
+
+            self
+          end
+
+          def self.new_builder
+            BulkMessageShowParamsBuilder.new
+          end
+
+          protected
+
+          def validate_id
+            messages = []
+            if @id.nil? || @id == ''
+              messages << 'idは必須です。'
+              messages << '文字列（UUID）を入力してください。'
+            end
+            messages
+          end
+        end
+
+        class BulkMessageShowParamsBuilder
+          def initialize
+            @params = BulkMessageShowParams.new
+          end
+
+          def with_id(id)
+            @params.id = id
+            self
+          end
+
+          def build
+            @params.clone
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karaden/request_options.rb

@@ -27,33 +27,20 @@ module Karaden
 
     def validate
       errors = Karaden::Model::KaradenObject.new
-      has_error = false
 
       messages = validate_api_base
-      unless messages.empty?
-        errors.set_property('api_base', messages)
-        has_error = true
-      end
+      errors.set_property('api_base', messages) unless messages.empty?
 
       messages = validate_api_key
-      unless messages.empty?
-        errors.set_property('api_key', messages)
-        has_error = true
-      end
+      errors.set_property('api_key', messages) unless messages.empty?
 
       messages = validate_api_version
-      unless messages.empty?
-        errors.set_property('api_version', messages)
-        has_error = true
-      end
+      errors.set_property('api_version', messages) unless messages.empty?
 
       messages = validate_tenant_id
-      unless messages.empty?
-        errors.set_property('tenant_id', messages)
-        has_error = true
-      end
+      errors.set_property('tenant_id', messages) unless messages.empty?
 
-      if has_error
+      unless errors.property_keys.filter { |key| !errors.property(key).nil? }.empty?
         e = Karaden::Exception::InvalidRequestOptionsException.new
         error = Karaden::Model::Error.new
         error.set_property('object', Karaden::Model::Error::OBJECT_NAME)
@@ -140,10 +127,12 @@ module Karaden
 
     def with_connection_timeout(connection_timeout)
       @request_options.connection_timeout = connection_timeout
+      self
     end
 
     def with_read_timeout(read_timeout)
       @request_options.read_timeout = read_timeout
+      self
     end
 
     def build

data/lib/karaden/service/bulk_message_service.rb

@@ -0,0 +1,90 @@
+module Karaden
+  module Service
+    class BulkMessageService
+      REGEX_PATTERN = /filename="([^"]+)"/
+
+      def self.create(filename, request_options = nil)
+        raise Karaden::Exception::FileNotFoundException unless File.file?(filename)
+
+        bulk_file = Karaden::Model::BulkFile.create(request_options)
+
+        Karaden::Utility.put_signed_url(bulk_file.url, filename, 'text/csv', request_options)
+
+        params = Karaden::Param::Message::Bulk::BulkMessageCreateParams
+                   .new_builder
+                   .with_bulk_file_id(bulk_file.id)
+                   .build
+        Karaden::Model::BulkMessage.create(params, request_options)
+      end
+
+      def self.download(params, request_options = nil)
+        params.validate
+        show_params = Karaden::Param::Message::Bulk::BulkMessageShowParams.new_builder
+          .with_id(params.id)
+          .build
+        unless Karaden::Service::BulkMessageService.check_bulk_message_status(params.max_retries, params.retry_interval, show_params, request_options)
+          raise Exception::BulkMessageShowRetryLimitExceedException
+        end
+
+        list_message_params = Param::Message::Bulk::BulkMessageListMessageParams.new_builder
+          .with_id(params.id)
+          .build
+        download_url = Karaden::Service::BulkMessageService.get_download_url(params.max_retries, params.retry_interval, list_message_params, request_options)
+        raise Exception::BulkMessageListMessageRetryLimitExceedException if download_url.nil?
+
+        begin
+          Karaden::Service::BulkMessageService.get_contents(download_url, params.directory_path, request_options)
+        rescue StandardError
+          raise Exception::FileDownloadFailedException
+        end
+      end
+
+      def self.get_contents(download_url, directory_path, request_options = nil)
+        uri = URI.parse(download_url)
+        http = ::Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == 'https'
+        http.open_timeout, http.read_timeout = Karaden::Utility.get_timeout(request_options)
+        http.request_get(uri.request_uri) do |response|
+          match = response['content-disposition'].match(Karaden::Service::BulkMessageService::REGEX_PATTERN)
+          raise Exception::FileDownloadFailedException unless match
+
+          filename = File.join(File.realpath(directory_path), match[1])
+          File.open(filename, 'w') do |file|
+            response.read_body do |chunk|
+              file.write(chunk)
+            end
+          end
+        end
+        true
+      end
+
+      def self.check_bulk_message_status(retry_count, _retry_interval, params, request_options)
+        result = false
+        (0..retry_count).each do |_count|
+          # sleep retry_interval if count.positive?
+          bulk_message = Karaden::Model::BulkMessage.show(params, request_options)
+          raise Exception::BulkMessageCreateFailedException if bulk_message.status == Karaden::Model::BulkMessage::STATUS_ERROR
+
+          if bulk_message.status == Karaden::Model::BulkMessage::STATUS_DONE
+            result = true
+            break
+          end
+        end
+        result
+      end
+
+      def self.get_download_url(retry_count, _retry_interval, params, request_options)
+        result = nil
+        (0..retry_count).each do |_count|
+          # sleep retry_interval if count.positive?
+          output = Karaden::Model::BulkMessage.list_message(params, request_options)
+          unless output.nil?
+            result = output
+            break
+          end
+        end
+        result
+      end
+    end
+  end
+end

data/lib/karaden/utility.rb

@@ -3,8 +3,12 @@ module Karaden
     OBJECT_TYPES = {
       Karaden::Model::Error::OBJECT_NAME => Karaden::Model::Error,
       Karaden::Model::Collection::OBJECT_NAME => Karaden::Model::Collection,
-      Karaden::Model::Message::OBJECT_NAME => Karaden::Model::Message
+      Karaden::Model::Message::OBJECT_NAME => Karaden::Model::Message,
+      Karaden::Model::BulkFile::OBJECT_NAME => Karaden::Model::BulkFile,
+      Karaden::Model::BulkMessage::OBJECT_NAME => Karaden::Model::BulkMessage
     }.freeze
+    DEFAULT_CONNECTION_TIMEOUT = 10
+    DEFAULT_READ_TIMEOUT = 30
 
     def self.convert_to_karaden_object(contents, request_options)
       clazz = OBJECT_TYPES[contents['object']] || Karaden::Model::KaradenObject
@@ -31,5 +35,31 @@ module Karaden
         v.is_a?(Hash) ? convert_to_karaden_object(v, request_options) : v
       end
     end
+
+    def self.put_signed_url(signed_url, filename, content_type = 'application/octet-stream', request_options = nil)
+      uri = URI.parse(signed_url)
+      http = ::Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      http.open_timeout, http.read_timeout = get_timeout(request_options)
+
+      request = ::Net::HTTP::Put.new(uri.request_uri)
+      response = File.open(filename, 'rb') do |f|
+        request.body_stream = f
+        request['Content-Length'] = f.size
+        request['Content-Type'] = content_type
+
+        http.request(request)
+      end
+
+      raise Karaden::Exception::FileUploadFailedException unless response.code == '200'
+    rescue Karaden::Exception::FileUploadFailedException
+      raise
+    rescue StandardError
+      raise Karaden::Exception::FileUploadFailedException
+    end
+
+    def self.get_timeout(request_options = nil)
+      [request_options&.connection_timeout || DEFAULT_CONNECTION_TIMEOUT, request_options&.read_timeout || DEFAULT_READ_TIMEOUT]
+    end
   end
 end

data/lib/karaden.rb

@@ -10,7 +10,13 @@ require_relative 'karaden/config'
 require_relative 'karaden/request_options'
 require_relative 'karaden/exception/karaden_exception'
 require_relative 'karaden/exception/bad_request_exception'
+require_relative 'karaden/exception/bulk_message_create_failed_exception'
+require_relative 'karaden/exception/bulk_message_list_message_retry_limit_exceed_exception'
+require_relative 'karaden/exception/bulk_message_show_retry_limit_exceed_exception'
 require_relative 'karaden/exception/forbidden_exception'
+require_relative 'karaden/exception/file_download_failed_exception'
+require_relative 'karaden/exception/file_not_found_exception'
+require_relative 'karaden/exception/file_upload_failed_exception'
 require_relative 'karaden/exception/not_found_exception'
 require_relative 'karaden/exception/invalid_request_options_exception'
 require_relative 'karaden/exception/invalid_params_exception'
@@ -23,14 +29,23 @@ require_relative 'karaden/net/requestor_interface'
 require_relative 'karaden/net/requestor'
 require_relative 'karaden/net/response_interface'
 require_relative 'karaden/net/response'
+require_relative 'karaden/net/no_contents_response'
 require_relative 'karaden/model/karaden_object'
 require_relative 'karaden/model/requestable'
 require_relative 'karaden/model/message'
 require_relative 'karaden/model/error'
 require_relative 'karaden/model/collection'
+require_relative 'karaden/model/bulk_file'
+require_relative 'karaden/model/bulk_message'
 require_relative 'karaden/param/message/message_params'
 require_relative 'karaden/param/message/message_create_params'
 require_relative 'karaden/param/message/message_cancel_params'
 require_relative 'karaden/param/message/message_detail_params'
 require_relative 'karaden/param/message/message_list_params'
+require_relative 'karaden/param/message/bulk/bulk_message_params'
+require_relative 'karaden/param/message/bulk/bulk_message_create_params'
+require_relative 'karaden/param/message/bulk/bulk_message_download_params'
+require_relative 'karaden/param/message/bulk/bulk_message_list_message_params'
+require_relative 'karaden/param/message/bulk/bulk_message_show_params'
+require_relative 'karaden/service/bulk_message_service'
 require_relative 'karaden/utility'