karaden-prg-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d01480f01a3a32c963b785e91ca2dbf1006e9dcf49236b7dfdf33be218f6055a
+  data.tar.gz: f2e3b9a107ba053c3b391ce3ff8fe5f293df3e64787782e132f3e8a571dea731
+SHA512:
+  metadata.gz: 13aaef2a09da0451eac30a1e85a07d29189ae8a89e90b86aba81b5269ff532b7f9c7962403123651392ed9c553fe6a3f064e7360fe0d2090d41a3779e23e2b0f
+  data.tar.gz: 72719971714d91c5fa20f7a23ff3804d399acea35a7c9eacb37a0550969853f2b968a7336b3762868212e8038ad7ddcb4863428997fe346dbd9d4c9595259658

data/.devcontainer/devcontainer.json

@@ -0,0 +1,45 @@
+// 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",
+	"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"
+}

data/.devcontainer/docker/ruby/Dockerfile

@@ -0,0 +1,30 @@
+FROM mcr.microsoft.com/devcontainers/ruby:0-3-bullseye
+
+ARG USERNAME=${USERNAME}
+ARG USER_UID=${USER_UID}
+ARG USER_GID=${USER_GID}
+ARG TIME_ZONE=${TIME_ZONE}
+ARG LOCALE=${LOCALE}
+
+ENV LANG=${LOCALE}
+ENV LANGUAGE=${LANGUAGE}
+ENV TZ=${TIME_ZONE}
+
+RUN apt-get update \
+  && 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
+
+RUN ln -snf /usr/share/zoneinfo/${TIME_ZONE} /etc/localtime \
+  && echo ${TIME_ZONE} > /etc/timezone 
+
+USER ${USER_UID}
+
+RUN curl https://get.volta.sh | bash
+
+RUN echo -n "\n\
+LANG="${LANG}"\n\
+LANGUAGE="${LANGUAGE}"\n\
+LC_ALL="${LOCALE}"\n\
+" >> ~/.bashrc

data/.devcontainer/docker-compose.yml

@@ -0,0 +1,16 @@
+version: "3.5"
+
+services:
+  ruby:
+    build:
+      context: ./docker/ruby
+      args:
+        USERNAME: ${USERNAME-vscode}
+        USER_UID: ${USER_UID-1000}
+        USER_GID: ${USER_GID-1000}
+        TIME_ZONE: ${TIME_ZONE-UTC}
+        LOCALE: ${LOCALE-C}
+    tty: true
+    volumes:
+      - ../:/var/task
+    working_dir: /var/task

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/DefWithParentheses:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false
+Style/TrivialAccessors:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/ClassLength:
+  Max: 150
+Layout/IndentationWidth:
+  Width: 2
+Layout/LineLength:
+  Max: 200
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+Metrics/AbcSize:
+  Max: 30
+Metrics/MethodLength:
+  Max: 30
+RaiseArgs:
+  EnforcedStyle: compact

data/.vscode/launch.json

@@ -0,0 +1,32 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "rdbg",
+      "name": "Debug current file with rdbg",
+      "request": "launch",
+      "script": "${file}",
+      "args": [],
+      "askParameters": true,
+      "cwd": "${workspaceFolder}"
+    },
+    {
+      "type": "rdbg",
+      "name": "Debug current test with rdbg",
+      "request": "launch",
+      "command": "rspec",
+      "script": "${file}",
+      "args": [],
+      "askParameters": false,
+      "cwd": "${workspaceFolder}"
+    },
+    {
+      "type": "rdbg",
+      "name": "Attach with rdbg",
+      "request": "attach"
+    }
+  ]
+}

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in karaden.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 NTTCom Online Marketing Solutions Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Karaden Rubyライブラリ
+Karaden Rubyライブラリは、Rubyで書かれたアプリケーションからKaraden APIへ簡単にアクセスするための手段を提供します。<br />
+それにはAPIレスポンスから動的に初期化するAPIリソースの一連のクラス定義が含まれているため、Karaden APIの幅広いバージョンと互換性があります。
+## インストール方法
+パッケージを変更しないならば、このソースコードは必要ありません。
+### Gemfile
+Gemfileに下記の依存を追加します。
+```ruby
+gem 'karaden-prg-ruby'
+```
+
+## 使い方
+このライブラリを使用するには、Karadenでテナントを作成し、プロジェクト毎に発行できるトークンを発行する必要があります。<br />
+作成したテナントID（テナントIDはテナント選択画面で表示されています）は、`Karaden::Config.tenant_id`に、発行したトークンは`Karaden::Config.api_key`にそれぞれ設定します。
+```ruby
+require 'karaden'
+
+Karaden::Config.api_key = '<トークン>'
+Karaden::Config.tenant_id = '<テナントID>'
+
+params = Karaden::Param::Message::MessageCreateParams.new_builder
+.with_service_id(1)
+.with_to('09012345678')
+.with_body('本文')
+.build
+
+Karaden::Model::Message.create(params)
+```
+### リクエスト毎の設定
+同一のプロセスで複数のキーを使用する必要がある場合、リクエスト毎にキーやテナントIDを設定することができます。
+```ruby
+require 'karaden'
+
+params = Karaden::Param::Message::MessageDetailParams.new_builder
+.with_id('<メッセージID>')
+.build
+
+request_options = Karaden::RequestOptions.new_builder
+.with_api_key('<トークン>')
+.with_tenant_id('<テナントID>')
+.build
+
+Karaden::Model::Message.detail(params, request_options);
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/karaden/config.rb

@@ -0,0 +1,78 @@
+module Karaden
+  class Config
+    VERSION = '1.0.0'.freeze
+    DEFAULT_API_BASE = 'https://prg.karaden.jp/api'.freeze
+    DEFALUT_API_VERSION = '2023-01-01'.freeze
+
+    @@http_client = nil
+    @@logger = nil
+    @@formatter = nil
+    @@api_version = DEFALUT_API_VERSION
+    @@api_key = nil
+    @@tenant_id = nil
+    @@user_agent = nil
+    @@api_base = DEFAULT_API_BASE
+
+    def self.api_base
+      @@api_base
+    end
+
+    def self.api_base=(val)
+      @@api_base = val
+    end
+
+    def self.api_key
+      @@api_key
+    end
+
+    def self.api_key=(val)
+      @@api_key = val
+    end
+
+    def self.api_version
+      @@api_version
+    end
+
+    def self.api_version=(val)
+      @@api_version = val
+    end
+
+    def self.tenant_id
+      @@tenant_id
+    end
+
+    def self.tenant_id=(val)
+      @@tenant_id = val
+    end
+
+    def self.user_agent
+      @@user_agent
+    end
+
+    def self.user_agent=(val)
+      @@user_agent = val
+    end
+
+    def self.reset
+      @@api_base = DEFAULT_API_BASE
+      @@api_key = nil
+      @@api_version = DEFALUT_API_VERSION
+      @@tenant_id = nil
+      @@user_agent = nil
+      @@http_client = nil
+      @@logger = nil
+      @@formatter = nil
+    end
+
+    def self.as_request_options
+      RequestOptions
+      .new_builder
+      .with_api_version(@@api_version)
+      .with_api_key(@@api_key)
+      .with_tenant_id(@@tenant_id)
+      .with_user_agent(@@user_agent)
+      .with_api_base(@@api_base)
+      .build
+    end
+  end
+end

data/lib/karaden/exception/bad_request_exception.rb

@@ -0,0 +1,10 @@
+module Karaden
+  module Exception
+    class BadRequestException < KaradenException
+      STATUS_CODE = 400
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/exception/forbidden_exception.rb

@@ -0,0 +1,10 @@
+module Karaden
+  module Exception
+    class ForbiddenException < KaradenException
+      STATUS_CODE = 403
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/exception/invalid_params_exception.rb

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

data/lib/karaden/exception/invalid_request_options_exception.rb

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

data/lib/karaden/exception/karaden_exception.rb

@@ -0,0 +1,15 @@
+module Karaden
+  module Exception
+    class KaradenException < StandardError
+      attr_accessor :code, :headers, :body, :error
+
+      def initialize(message = nil)
+        @code = nil
+        @headers = {}
+        @body = ''
+        @error = nil
+        super(message)
+      end
+    end
+  end
+end

data/lib/karaden/exception/not_found_exception.rb

@@ -0,0 +1,10 @@
+module Karaden
+  module Exception
+    class NotFoundException < KaradenException
+      STATUS_CODE = 404
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/exception/too_many_requests_exception.rb

@@ -0,0 +1,10 @@
+module Karaden
+  module Exception
+    class TooManyRequestsException < KaradenException
+      STATUS_CODE = 429
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/exception/unauthorized_exception.rb

@@ -0,0 +1,10 @@
+module Karaden
+  module Exception
+    class UnauthorizedException < KaradenException
+      STATUS_CODE = 401
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/exception/unexpected_value_exception.rb

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

data/lib/karaden/exception/unknown_error_exception.rb

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

data/lib/karaden/exception/unprocessable_entity_exception.rb

@@ -0,0 +1,10 @@
+module Karaden
+  module Exception
+    class UnprocessableEntityException < KaradenException
+      STATUS_CODE = 422
+      def initialize(message = nil)
+        super
+      end
+    end
+  end
+end

data/lib/karaden/model/collection.rb

@@ -0,0 +1,15 @@
+module Karaden
+  module Model
+    class Collection < KaradenObject
+      OBJECT_NAME = 'list'.freeze
+
+      def data()
+        property('data')
+      end
+
+      def more?()
+        property('has_more')
+      end
+    end
+  end
+end

data/lib/karaden/model/error.rb

@@ -0,0 +1,19 @@
+module Karaden
+  module Model
+    class Error < KaradenObject
+      OBJECT_NAME = 'error'.freeze
+
+      def code()
+        property('code')
+      end
+
+      def message()
+        property('message')
+      end
+
+      def errors()
+        property('errors')
+      end
+    end
+  end
+end

data/lib/karaden/model/karaden_object.rb

@@ -0,0 +1,31 @@
+module Karaden
+  module Model
+    class KaradenObject
+      def initialize(id = nil, request_options = nil)
+        @properties = {}
+        @request_options = request_options
+        set_property('id', id)
+      end
+
+      def id()
+        property('id')
+      end
+
+      def object()
+        property('object')
+      end
+
+      def set_property(key, value)
+        @properties[key] = value
+      end
+
+      def property_keys()
+        @properties.keys
+      end
+
+      def property(key)
+        @properties[key]
+      end
+    end
+  end
+end

data/lib/karaden/model/message.rb

@@ -0,0 +1,130 @@
+module Karaden
+  module Model
+    class Message < Requestable
+      OBJECT_NAME = 'message'.freeze
+
+      def service_id()
+        property('service_id')
+      end
+
+      def billing_address_id()
+        property('billing_address_id')
+      end
+
+      def to()
+        property('to')
+      end
+
+      def body()
+        property('body')
+      end
+
+      def tags()
+        property('tags')
+      end
+
+      def shorten?()
+        property('is_shorten')
+      end
+
+      def result()
+        property('result')
+      end
+
+      def status()
+        property('status')
+      end
+
+      def sent_result()
+        property('sent_result')
+      end
+
+      def carrier()
+        property('carrier')
+      end
+
+      def scheduled_at()
+        scheduled_at = property('scheduled_at')
+        begin
+          Time.parse(scheduled_at)
+        rescue StandardError
+          nil
+        end
+      end
+
+      def limited_at()
+        limited_at = property('limited_at')
+        begin
+          Time.parse(limited_at)
+        rescue StandardError
+          nil
+        end
+      end
+
+      def sent_at()
+        sent_at = property('sent_at')
+        begin
+          Time.parse(sent_at)
+        rescue StandardError
+          nil
+        end
+      end
+
+      def received_at()
+        received_at = property('received_at')
+        begin
+          Time.parse(received_at)
+        rescue StandardError
+          nil
+        end
+      end
+
+      def charged_at()
+        charged_at = property('charged_at')
+        begin
+          Time.parse(charged_at)
+        rescue StandardError
+          nil
+        end
+      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.list(params, request_options = nil)
+        params.validate
+        request('GET', params.to_path, nil, params.to_params, nil, request_options)
+      end
+
+      def self.detail(params, request_options = nil)
+        params.validate
+        request('GET', params.to_path, nil, nil, nil, request_options)
+      end
+
+      def self.cancel(params, request_options = nil)
+        params.validate
+        request('POST', params.to_path, nil, nil, nil, request_options)
+      end
+    end
+  end
+end

data/lib/karaden/model/requestable.rb

@@ -0,0 +1,22 @@
+module Karaden
+  module Model
+    class Requestable < KaradenObject
+      def self.requestor
+        @@requestor
+      end
+
+      def self.requestor=(val)
+        @@requestor = val
+      end
+
+      def self.request(method, path, content_type = nil, params = nil, data = nil, request_options = nil)
+        response = @@requestor.send(method, path, content_type, params, data, request_options)
+        raise response.error if response.error?
+
+        response.object
+      end
+    end
+  end
+end
+
+Karaden::Model::Requestable.requestor = Karaden::Net::Requestor.new