karaden-prg-ruby 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55dc4dfa3d7fbaf8bce1057372011dc4d62c8074b8676d1beb050547c764b40f
-  data.tar.gz: 8c2e7d56c9963f624351e2121f55b60c1068dbcb59a72401b7fbd4d6c0473a0a
+  metadata.gz: cfe820d3c3ca917f78dba55fb51e0b3d04bcc9e6e133bde0d18927aeb10ec72b
+  data.tar.gz: e88f8c518f8ac08582b5c4f8a946eb04eaf03b2ca82e5ee05ba923d502e4ab27
 SHA512:
-  metadata.gz: ce361f89f53f3bf912b2b1c41fbd66c71e54c89599db935234e724d267df4a1c4fc7972098168a1898a42116b399a93a23d9caa665b9d93ebc7b7c913d9770bd
-  data.tar.gz: abbe87ab88a28e5e0024bef5851d1a10e4e8af722d9526a3827d99cdde8826d5cf5fae989bad71b38a318f6eb655eed30f57d52eeb30cd67d9141f7fdc81d199
+  metadata.gz: 9bb1d1e16c9054c99f73f037551a2c474175997980bb1e4ec1868a51e889eb467b525a666d4355e4b4a543058754aa201b455b2eec7a487b4e46f007554b42bb
+  data.tar.gz: 0ebbe2c04fa715e0aec8a9d07fc4958e4f7915790f87a92d9ab59485764ec6e8a1c583a2d54ba5c7538baa6bbf9789925a98b522a391bbec6e872c566e66e2ff

data/README.md

@@ -40,5 +40,18 @@ request_options = Karaden::RequestOptions.new_builder
 .with_tenant_id('<テナントID>')
 .build
 
-Karaden::Model::Message.detail(params, request_options);
+Karaden::Model::Message.detail(params, request_options)
+```
+### タイムアウトについて
+通信をするファイルサイズや実行環境の通信速度によってはHTTP通信時にタイムアウトが発生する可能性があります。<br />
+何度も同じような現象が起こる際は、ファイルサイズの調整もしくは`RequestOptions`からタイムアウトの時間を増やして、再度実行してください。<br />
+```ruby
+request_options = Karaden::RequestOptions.new_builder
+.with_api_key('<トークン>')
+.with_tenant_id('<テナントID>')
+.with_connection_timeout(<秒>)
+.with_read_timeout(<秒>)
+.build
+
+bulk_message = Karaden::Service::BulkMessageService.create('<ファイルパス>', request_options)
 ```

data/lib/karaden/config.rb

@@ -1,8 +1,8 @@
 module Karaden
   class Config
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.2.0'.freeze
     DEFAULT_API_BASE = 'https://prg.karaden.jp/api'.freeze
-    DEFALUT_API_VERSION = '2023-01-01'.freeze
+    DEFALUT_API_VERSION = '2024-03-01'.freeze
 
     @@http_client = nil
     @@logger = nil

data/lib/karaden/exception/bulk_message_create_failed_exception.rb

@@ -0,0 +1,9 @@
+module Karaden
+  module Exception
+    class BulkMessageCreateFailedException < KaradenException
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/exception/bulk_message_list_message_retry_limit_exceed_exception.rb

@@ -0,0 +1,9 @@
+module Karaden
+  module Exception
+    class BulkMessageListMessageRetryLimitExceedException < KaradenException
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/exception/bulk_message_show_retry_limit_exceed_exception.rb

@@ -0,0 +1,9 @@
+module Karaden
+  module Exception
+    class BulkMessageShowRetryLimitExceedException < KaradenException
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/exception/file_download_failed_exception.rb

@@ -0,0 +1,9 @@
+module Karaden
+  module Exception
+    class FileDownloadFailedException < KaradenException
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/exception/file_not_found_exception.rb

@@ -0,0 +1,9 @@
+module Karaden
+  module Exception
+    class FileNotFoundException < KaradenException
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/exception/file_upload_failed_exception.rb

@@ -0,0 +1,9 @@
+module Karaden
+  module Exception
+    class FileUploadFailedException < KaradenException
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/model/bulk_file.rb

@@ -0,0 +1,34 @@
+module Karaden
+  module Model
+    class BulkFile < Requestable
+      OBJECT_NAME = 'bulk_file'.freeze
+
+      def url()
+        property('url')
+      end
+
+      def created_at()
+        created_at = property('created_at')
+        begin
+          Time.parse(created_at)
+        rescue StandardError
+          nil
+        end
+      end
+
+      def expires_at()
+        expires_at = property('expires_at')
+        begin
+          Time.parse(expires_at)
+        rescue StandardError
+          nil
+        end
+      end
+
+      def self.create(request_options = nil)
+        path = "#{Karaden::Param::Message::Bulk::BulkMessageParams::CONTEXT_PATH}/files"
+        request('POST', path, nil, nil, nil, request_options)
+      end
+    end
+  end
+end

data/lib/karaden/model/bulk_message.rb

@@ -0,0 +1,53 @@
+module Karaden
+  module Model
+    class BulkMessage < Requestable
+      OBJECT_NAME = 'bulk_message'.freeze
+      STATUS_DONE = 'done'.freeze
+      STATUS_WAITING = 'waiting'.freeze
+      STATUS_PROCESSING = 'processing'.freeze
+      STATUS_ERROR = 'error'.freeze
+
+      def status()
+        property('status')
+      end
+
+      def error()
+        property('error')
+      end
+
+      def created_at()
+        created_at = property('created_at')
+        begin
+          Time.parse(created_at)
+        rescue StandardError
+          nil
+        end
+      end
+
+      def updated_at()
+        updated_at = property('updated_at')
+        begin
+          Time.parse(updated_at)
+        rescue StandardError
+          nil
+        end
+      end
+
+      def self.create(params, request_options = nil)
+        params.validate
+        request('POST', params.to_path, 'application/x-www-form-urlencoded', nil, params.to_data, request_options)
+      end
+
+      def self.show(params, request_options = nil)
+        params.validate
+        request('GET', params.to_path, nil, nil, nil, request_options)
+      end
+
+      def self.list_message(params, request_options = nil)
+        params.validate
+        response = request_and_return_response_interface('GET', params.to_path, nil, nil, nil, request_options)
+        response.status_code == 302 ? response.headers['location'] : nil
+      end
+    end
+  end
+end

data/lib/karaden/model/message.rb

@@ -27,6 +27,10 @@ module Karaden
         property('is_shorten')
       end
 
+      def shorten_clicked?()
+        property('is_shorten_clicked')
+      end
+
       def result()
         property('result')
       end

data/lib/karaden/model/requestable.rb

@@ -15,6 +15,13 @@ module Karaden
 
         response.object
       end
+
+      def self.request_and_return_response_interface(method, path, content_type = nil, params = nil, data = nil, request_options = nil)
+        response = @@requestor.send(method, path, content_type, params, data, request_options, true)
+        raise response.error if response.error?
+
+        response
+      end
     end
   end
 end

data/lib/karaden/net/no_contents_response.rb

@@ -0,0 +1,80 @@
+module Karaden
+  module Net
+    class NoContentsResponse < ResponseInterface
+      ERRORS = {
+        Karaden::Exception::BadRequestException::STATUS_CODE => Karaden::Exception::BadRequestException,
+        Karaden::Exception::UnauthorizedException::STATUS_CODE => Karaden::Exception::UnauthorizedException,
+        Karaden::Exception::NotFoundException::STATUS_CODE => Karaden::Exception::NotFoundException,
+        Karaden::Exception::ForbiddenException::STATUS_CODE => Karaden::Exception::ForbiddenException,
+        Karaden::Exception::UnprocessableEntityException::STATUS_CODE => Karaden::Exception::UnprocessableEntityException,
+        Karaden::Exception::TooManyRequestsException::STATUS_CODE => Karaden::Exception::TooManyRequestsException
+      }.freeze
+
+      def initialize(response, request_options)
+        @error = nil
+        @status_code = nil
+        @headers = nil
+        super()
+        interpret(response, request_options)
+      end
+
+      def error()
+        @error
+      end
+
+      def object()
+        raise NotImplementedError
+      end
+
+      def status_code()
+        @status_code
+      end
+
+      def headers()
+        @headers
+      end
+
+      def error?()
+        !@error.nil?
+      end
+
+      protected
+
+      def handle_error(code, headers, body, error)
+        clazz = ERRORS[code]
+        object = if clazz
+                   clazz.new
+                 else
+                   UnknownErrorException.new
+                 end
+        object.headers = headers
+        object.body = body
+        object.error = error
+        object
+      end
+
+      def interpret(response, request_options)
+        @status_code = response.code.to_i
+        @headers = response.response.response.each_header.to_h
+        if @status_code >= 400
+          body = response.body
+          contents = JSON.parse(response.body)
+          object = Karaden::Utility.convert_to_karaden_object(contents, request_options)
+          @error = if object.is_a?(Karaden::Model::Error)
+                     handle_error(code, @headers, body, object)
+                   else
+                     Karaden::Exception::UnexpectedValueException.new
+                   end
+          @error.code = @status_code
+          @error.headers = @headers
+          @error.body = body
+        end
+      rescue StandardError => _e
+        @error = Karaden::Exception::UnexpectedValueException.new
+        @error.code = @status_code
+        @error.headers = @headers
+        @error.body = body
+      end
+    end
+  end
+end

data/lib/karaden/net/requestor.rb

@@ -3,7 +3,7 @@ module Karaden
     class Requestor < RequestorInterface
       DEFAULT_USER_AGENT = 'Karaden/Ruby/'.freeze
 
-      def send(method, path, content_type = nil, params = nil, data = nil, request_options = nil)
+      def send(method, path, content_type = nil, params = nil, data = nil, request_options = nil, is_no_contents = false)
         request_options = Karaden::RequestOptions.new if request_options.nil?
         options = Karaden::Config.as_request_options.merge(request_options).validate
         headers = {
@@ -23,7 +23,7 @@ module Karaden
         data = URI.encode_www_form(data) unless data.nil?
         response = http.send_request(method, uri.request_uri, data, headers)
 
-        Karaden::Net::Response.new(response, options)
+        !is_no_contents ? Karaden::Net::Response.new(response, options) : Karaden::Net::NoContentsResponse.new(response, options)
       end
 
       protected

data/lib/karaden/net/requestor_interface.rb

@@ -1,7 +1,7 @@
 module Karaden
   module Net
     class RequestorInterface
-      def send(method, path, content_type = nil, params = nil, data = nil, request_options = nil)
+      def send(method, path, content_type = nil, params = nil, data = nil, request_options = nil, is_no_contents = false)
         raise NotImplementedError
       end
     end

data/lib/karaden/net/response.rb

@@ -25,6 +25,14 @@ module Karaden
         @object
       end
 
+      def status_code()
+        raise NotImplementedError
+      end
+
+      def headers()
+        raise NotImplementedError
+      end
+
       def error?()
         !@error.nil?
       end

data/lib/karaden/net/response_interface.rb

@@ -9,6 +9,14 @@ module Karaden
         raise NotImplementedError
       end
 
+      def status_code()
+        raise NotImplementedError
+      end
+
+      def headers()
+        raise NotImplementedError
+      end
+
       def error?()
         raise NotImplementedError
       end

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

@@ -0,0 +1,79 @@
+module Karaden
+  module Param
+    module Message
+      module Bulk
+        class BulkMessageCreateParams < BulkMessageParams
+          attr_accessor :bulk_file_id
+
+          def initialize()
+            @bulk_file_id = nil
+            super
+          end
+
+          def to_path
+            CONTEXT_PATH
+          end
+
+          def to_data
+            {
+              bulk_file_id: @bulk_file_id
+            }.reject { |_, value| value.nil? }
+          end
+
+          def validate
+            errors = Karaden::Model::KaradenObject.new
+            has_error = false
+
+            messages = validate_bulk_file_id
+            unless messages.empty?
+              errors.set_property('bulk_file_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
+            BulkMessageCreateParamsBuilder.new
+          end
+
+          protected
+
+          def validate_bulk_file_id
+            messages = []
+            if @bulk_file_id.nil? || @bulk_file_id == ''
+              messages << 'bulk_file_idは必須です。'
+              messages << '文字列（UUID）を入力してください。'
+            end
+            messages
+          end
+        end
+
+        class BulkMessageCreateParamsBuilder
+          def initialize
+            @params = BulkMessageCreateParams.new
+          end
+
+          def with_bulk_file_id(bulk_file_id)
+            @params.bulk_file_id = bulk_file_id
+            self
+          end
+
+          def build
+            @params.clone
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,139 @@
+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
+            has_error = false
+
+            messages = validate_id
+            unless messages.empty?
+              errors.set_property('id', messages)
+              has_error = true
+            end
+
+            messages = validate_directory_path
+            unless messages.empty?
+              errors.set_property('directory_path', messages)
+              has_error = true
+            end
+
+            messages = validate_max_retries
+            unless messages.empty?
+              errors.set_property('max_retries', messages)
+              has_error = true
+            end
+
+            messages = validate_retry_interval
+            unless messages.empty?
+              errors.set_property('retry_interval', 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
+            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