karaden-prg-ruby 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ffd0accbb63a2bda3b6275e836415138b90a7c585ccc33ec9928699c69ddaac
-  data.tar.gz: be9870652cadd3be803410e11e0345a7472765b28b6bd2e82e7f0c1ad8169a63
+  metadata.gz: 7b6eadc4a71ffb028555269758d495cbbd55d64acbf1dd56c866b6d526bad89d
+  data.tar.gz: c792f6b657fd7df4debafc7d100f55078c10f93a5886f56f03e843611e244343
 SHA512:
-  metadata.gz: 1d6a54565616e250d833d8000fc4380304975586f9bdd6e588168a1ddb3f476ba30a2acb91434498986e7b04f766fd72b77286db5f2187606bc0a169bf341b92
-  data.tar.gz: 40a0f8501895aa4a908166703e9cf9346f159b44c98387fde5d38f5b76328fc0d784fbb196f48980f1a75e898c800622300688ddd12abc9098397984384fcbf4
+  metadata.gz: ffa33a4af4af490f9a9f29d5020f1fe22dcd4cff19a469b07303e18ec7fa6d879f7e0ce17a4b8bfb4510adf2823c704962460506c08d2bee63ec609f3bb481ee
+  data.tar.gz: 248a813af69630da1243dc2b11989ecce62eff9cdbf5c1ead7552f23cce911fbd5f4eb4d26282f226298643c503e6d5f30d99e91c1e97a3027cd93db8afd5bdd

data/.devcontainer/devcontainer.json

@@ -1,45 +1,38 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the
 // README at: https://github.com/devcontainers/templates/tree/main/src/ruby
 {
-	"name": "ruby-sdk",
-	// Sets the run context to one level up instead of the .devcontainer folder.
-	"dockerComposeFile": [
-		"docker-compose.yml"
-	],
-  "service": "ruby",
+    "name": "ruby-sdk",
+    // Sets the run context to one level up instead of the .devcontainer folder.
+    "dockerComposeFile": [
+        "docker-compose.yml"
+    ],
+    "service": "ruby",
 	"workspaceFolder": "/var/task",
-	"settings": {
-		"editor.detectIndentation": false,
-		"editor.tabSize": 2,
-		"ruby.lint": {
-			"rubocop": true
-		},
-		"ruby.useLanguageServer": true,
-		"ruby.intellisense": "rubyLocate"
-	},
-	"extensions": [
-		"misogi.ruby-rubocop",
-		"humao.rest-client",
-		"koichisasada.vscode-rdbg",
-		"rebornix.ruby"
-	],
-	// "name": "Ruby",
-	// // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	// "image": "mcr.microsoft.com/devcontainers/ruby:0-3-bullseye",
-	"features": {
-		"ghcr.io/devcontainers/features/ruby:1": {
-			//"version": "latest",
-			"version": "3.0"
-		}
-	}
-	// Features to add to the dev container. More info: https://containers.dev/features.
-	// "features": {},
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
-	// Use 'postCreateCommand' to run commands after the container is created.
-	// "postCreateCommand": "ruby --version",
-	// Configure tool-specific properties.
-	// "customizations": {},
-	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-	// "remoteUser": "root"
+    "customizations": {	
+        "vscode": {
+            "settings": {
+                "[ruby]": {
+                    "editor.defaultFormatter": "Shopify.ruby-lsp",
+                    "editor.formatOnSave": true,
+                    "editor.tabSize": 2,
+                    "editor.insertSpaces": true,
+                    "editor.semanticHighlighting.enabled": true,
+                    "editor.formatOnType": true
+                }
+            },
+            "extensions": [
+                "Shopify.ruby-extensions-pack",
+                "humao.rest-client"
+            ]
+        }
+    },
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    //"forwardPorts": [8080]
+
+    // Use 'postCreateCommand' to run commands after the container is created.
+    // "postCreateCommand": "sudo chmod a+x \"$(pwd)\" && sudo rm -rf /var/www/html && sudo ln -s \"$(pwd)\" /var/www/html"
+    "initializeCommand": "cd .devcontainer && sh lifecycle/initialize-command.sh",
+
+    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+    "remoteUser": "nttcoms"
 }

data/.devcontainer/docker/ruby/Dockerfile

@@ -1,17 +1,19 @@
-FROM mcr.microsoft.com/devcontainers/ruby:0-3-bullseye
+FROM ruby:3.0.6
 
-ARG USERNAME=${USERNAME}
-ARG USER_UID=${USER_UID}
-ARG USER_GID=${USER_GID}
-ARG TIME_ZONE=${TIME_ZONE}
-ARG LOCALE=${LOCALE}
+ARG USERNAME
+ARG USER_UID
+ARG USER_GID
+ARG TIME_ZONE
+ARG LOCALE
+ARG WORKING_DIR
 
 ENV LANG=${LOCALE}
-ENV LANGUAGE=${LANGUAGE}
 ENV TZ=${TIME_ZONE}
 
 RUN apt-get update \
-  && apt-get install -y locales \
+  && apt-get install -y sudo git
+
+RUN apt-get install -y locales \
   && locale-gen ja_JP.UTF-8 \
   && localedef -f UTF-8 -i ja_JP ja_JP.UTF-8 \
   && update-locale LANG=ja_JP.UTF-8
@@ -19,12 +21,19 @@ RUN apt-get update \
 RUN ln -snf /usr/share/zoneinfo/${TIME_ZONE} /etc/localtime \
   && echo ${TIME_ZONE} > /etc/timezone 
 
+RUN /usr/sbin/groupadd --gid ${USER_GID} ${USERNAME} \
+  && /usr/sbin/useradd -s /bin/bash --uid ${USER_UID} --gid ${USER_GID} -m ${USERNAME} \
+  && echo ${USERNAME} ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/${USERNAME} \
+  && chmod 0440 /etc/sudoers.d/${USERNAME}
+
 USER ${USER_UID}
 
 RUN curl https://get.volta.sh | bash
 
-RUN echo -n "\n\
-LANG="${LANG}"\n\
-LANGUAGE="${LANGUAGE}"\n\
-LC_ALL="${LOCALE}"\n\
+RUN /bin/echo -e "\n\
+LANG=\"${LANG}\"\n\
+LC_ALL=\"${LOCALE}\"\n\
 " >> ~/.bashrc
+
+RUN sudo rm -rf /var/task \
+  && sudo ln -s ${WORKING_DIR} /var/task

data/.devcontainer/docker-compose.yml

@@ -10,7 +10,8 @@ services:
         USER_GID: ${USER_GID-1000}
         TIME_ZONE: ${TIME_ZONE-UTC}
         LOCALE: ${LOCALE-C}
+        WORKING_DIR: ${WORKING_DIR}
     tty: true
     volumes:
-      - ../:/var/task
-    working_dir: /var/task
+      - ../:${WORKING_DIR}
+    working_dir: ${WORKING_DIR}

data/.devcontainer/lifecycle/initialize-command.sh

@@ -0,0 +1,6 @@
+#!/bin/bash -eu
+
+echo "USERNAME=${USER}\n\
+LOCALE=ja_JP.UTF-8\n\
+TIME_ZONE=Asia/Tokyo\n\
+WORKING_DIR=$(realpath `pwd`/..)" > .env

data/.rubocop.yml

@@ -1,3 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+Style/StringLiterals:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 Style/Documentation:

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 NTTCom Online Marketing Solutions Corporation
+Copyright (c) NTT DOCOMO BUSINESS X, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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.1.0'.freeze
+    VERSION = '1.2.1'.freeze
     DEFAULT_API_BASE = 'https://prg.karaden.jp/api'.freeze
-    DEFALUT_API_VERSION = '2023-12-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/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 = {
@@ -11,7 +11,7 @@ module Karaden
           'Karaden-Client-User-Agent': build_client_user_agent,
           'Karaden-Version' => options.api_version,
           'Content-Type': content_type,
-          'Authorization': build_authorization(options),
+          'Authorization': build_authorization(options)
         }
 
         uri = URI.parse(build_http_url(path, params, options))
@@ -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,78 @@
+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