bootpay 1.2.0 → 3.0.0

data/lib/bootpay_store/concern/user.rb

@@ -0,0 +1,325 @@
+module BootpayStore::Concern::User
+  extend ActiveSupport::Concern
+
+  included do
+    # 회원 로그인 (V1 API)
+    # Comment by Codex
+    # @date: 2026-02-23
+    # @date: 26-08-14 uri 'user/login' → 'users/login' 로 정정.
+    #   v1 에는 단수 user/* 라우트가 없다(bin/rails routes 전수 확인). 로그인은 POST /v1/users/login (v1/users/login#create).
+    #   ⚠️ POST /v1/users/session 은 resource :session 이 만들어낸 라우트일 뿐 sessions_controller 에 create 액션이 없다.
+    #      라우트 존재만 보고 그리로 보내면 안 된다 — show(GET)/destroy(DELETE) 만 정의돼 있다.
+    #   ⚠️ 서버(LoginService)는 login_id·password 만 읽는다. corporate_type 은 전달돼도 무시된다.
+    #   /mall/user/login 은 스토어프론트 스코프라 서버사이드 SDK(base=/v1)와 무관하다.
+    def user_login(login_id:, password:, corporate_type: 0, idempotency_key: nil)
+      request(
+        uri:     'users/login',
+        method:  :post,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid
+        },
+        payload: {
+                   login_id:       login_id,
+                   password:       password,
+                   corporate_type: corporate_type
+                 }.compact
+      )
+    end
+
+    # 회원 세션 조회 (V1 Mall API)
+    # Comment by Codex
+    # @date: 2026-02-23
+    # @date: 26-08-14 uri 'user/session' → 'users/session' 로 정정 (GET /v1/users/session).
+    def user_session(user_jwt: nil, idempotency_key: nil)
+      request(
+        uri:     'users/session',
+        method:  :get,
+        headers: {
+                   'Idempotency-Key'  => idempotency_key.presence || SecureRandom.uuid,
+                   'Bootpay-User-JWT' => user_jwt
+                 }.compact
+      )
+    end
+
+    # 회원 로그아웃 (V1 Mall API)
+    # Comment by Codex
+    # @date: 2026-02-23
+    # @date: 26-08-14 uri 'user/session' → 'users/session' 로 정정 (DELETE /v1/users/session).
+    def user_logout(user_jwt:, idempotency_key: nil)
+      request(
+        uri:     'users/session',
+        method:  :delete,
+        headers: {
+          'Idempotency-Key'  => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-User-JWT' => user_jwt
+        }
+      )
+    end
+
+    # 회원가입 (V1 API) — 일반 회원가입용
+    # Comment by Codex
+    # @date: 2026-02-23
+    # @date: 26-08-14 uri 'user/join' → 'users/join' 로 정정 (POST /v1/users/join).
+    #   ⚠️ external_user_sign_in 과 같은 엔드포인트를 부른다. 중복이 아니라 용도가 다르다 —
+    #   이쪽은 password/corporate_type/group 을 쓰는 일반 회원가입, 저쪽은 uid/login_email/login_pw 를 쓰는 외부 uid 연동 가입이다.
+    #   서버가 파라미터 조합으로 분기하므로 둘 다 유지한다(26-08-14 사용자 결정). 매뉴얼 customer/register.md 는 external_user_sign_in 에 대응.
+    def user_join(login_id:, password:, name:, email: nil, phone: nil, nickname: nil, gender: nil, birth: nil, corporate_type: 0,
+                  group: nil, idempotency_key: nil)
+      request(
+        uri:     'users/join',
+        method:  :post,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid
+        },
+        payload: {
+                   login_id:       login_id,
+                   password:       password,
+                   name:           name,
+                   email:          email,
+                   phone:          phone,
+                   nickname:       nickname,
+                   gender:         gender,
+                   birth:          birth,
+                   corporate_type: corporate_type,
+                   group:          group
+                 }.compact
+      )
+    end
+
+    # 회원가입 중복 확인 (V1 API) — key 를 인자로 받는 일반형
+    # type: email-exist, id-exist, phone-exist, uid-exist, group-business-number-exist
+    # Comment by Codex
+    # @date: 2026-02-23
+    # @date: 26-08-14 uri 'user/join/#{type}' → 'users/join/#{type}' 로 정정 (GET /v1/users/join/:id).
+    #   ⚠️ email_exist·id_exist·phone_exist·uid_exist·group_business_number_exist 전용형 5종과 기능이 겹치지만 둘 다 유지한다(26-08-14 사용자 결정).
+    #   일반형은 서버에 새 key 가 생겨도 SDK 수정 없이 쓸 수 있고, 매뉴얼 customer/check-exist.md 가 key/value 형태를 안내하므로 이쪽에 대응한다.
+    def user_join_check(type:, pk:, idempotency_key: nil)
+      request(
+        uri:     "users/join/#{type}",
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid
+        },
+        params:  {
+          pk: pk
+        }
+      )
+    end
+
+    # UserId로 로그인을 시도한다
+    # Comment by GOSOMI
+    # @date: 2025-04-25
+    def login_by_user_id(user_id:, membership_type: 'member', corporate_type: 'individual', idempotency_key: nil)
+      request(
+        uri:     "users/login/token",
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        payload:
+                 {
+                   user_id:         user_id,
+                   membership_type: membership_type,
+                   corporate_type:  corporate_type
+                 }
+      )
+    end
+
+    # 회원 목록 정보를 가져온다
+    # Comment by GOSOMI
+    # @date: 2025-06-16
+    # @date: 26-08-26 회원등급 필터 키 정정. 서버(v1/users_controller#index)가 읽는 이름은
+    #   membership_type 인데 SDK 는 member_type 을 보내고 있어 등급 필터가 조용히 무시됐다
+    #   (에러 없이 전체 목록이 돌아온다). 기존 호출 호환을 위해 member_type 인자는 남기고 별칭으로 매핑한다.
+    def users(membership_type: nil, member_type: nil, keyword: nil, page: 1, limit: 20, idempotency_key: nil)
+      request(
+        uri:     'users',
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        params:
+                 {
+                   membership_type: membership_type.presence || member_type,
+                   keyword:         keyword,
+                   page:            page,
+                   limit:           limit
+                 }.compact
+      )
+    end
+
+    # 회원정보를 조회한다
+    # Comment by GOSOMI
+    # @date: 2025-06-16
+    def lookup_user(user_id:, idempotency_key: nil)
+      request(
+        uri:     "users/#{user_id}",
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+        }
+      )
+    end
+
+    # 회원가입
+    # Comment by GOSOMI
+    # @date: 2025-06-16
+    def external_user_sign_in(idempotency_key: nil, uid:, user_group_id: nil, is_group_admin: false,
+                              name:, phone:, email:, tel: nil, nickname: nil, comment: nil,
+                              gender: nil, birth: nil, individual_extension: nil, login_id:, login_email:,
+                              login_pw: nil, join_at: nil)
+      request(
+        uri:     'users/join',
+        method:  :post,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        payload:
+                 {
+                   uid:                  uid,
+                   user_group_id:        user_group_id,
+                   is_group_admin:       is_group_admin,
+                   name:                 name,
+                   phone:                phone,
+                   email:                email,
+                   tel:                  tel,
+                   nickname:             nickname,
+                   comment:              comment,
+                   gender:               gender,
+                   birth:                birth,
+                   individual_extension: individual_extension,
+                   login_id:             login_id,
+                   login_email:          login_email,
+                   login_pw:             login_pw,
+                   join_at:              join_at
+                 }.compact
+      )
+    end
+
+    # 회원 탈퇴
+    # Comment by GOSOMI
+    # @date: 2025-06-16
+    def withdraw(user_id:, idempotency_key: nil)
+      request(
+        uri:     "users/#{user_id}",
+        method:  :delete,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        }
+      )
+    end
+
+    # 이메일 중복검사
+    # Comment by GOSOMI
+    # @date: 2025-06-18
+    def email_exist(email:, idempotency_key: nil)
+      request(
+        uri:     'users/join/email-exist',
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        params:  { pk: email }
+      )
+    end
+
+    # ID 중복검사
+    # Comment by GOSOMI
+    # @date: 2025-06-18
+    def id_exist(id:, idempotency_key: nil)
+      request(
+        uri:     'users/join/id-exist',
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        params:  { pk: id }
+      )
+    end
+
+    # 전화번호 중복검사
+    # Comment by GOSOMI
+    # @date: 2025-06-18
+    def phone_exist(phone:, idempotency_key: nil)
+      request(
+        uri:     'users/join/phone-exist',
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        params:  { pk: phone }
+      )
+    end
+
+    # 그룹 사업자 번호 중복검사
+    # Comment by GOSOMI
+    # @date: 2025-06-18
+    def group_business_number_exist(business_number:, idempotency: nil)
+      request(
+        uri:     'users/join/group-business-number-exist',
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        params:  { pk: business_number }
+      )
+    end
+
+    # 외부 uid(ex_uid) 중복검사 (GET /v1/users/join/uid-exist)
+    # @comment_by Claude (alfred)
+    # @date: 26-08-14
+    # email/id/phone/group-business-number 전용형과 같은 패턴. 이걸로 *_exist 계열이 5종 완성된다.
+    def uid_exist(uid:, idempotency_key: nil)
+      request(
+        uri:     'users/join/uid-exist',
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        params:  { pk: uid }
+      )
+    end
+
+    # 회원 정보를 수정한다 (PUT /v1/users/:id)
+    # @comment_by Claude (alfred)
+    # @date: 26-08-14
+    # 컨트롤러 build_user_params 기준. 사업자 정보는 group: { company_name:, business_number:, registration_number: } 로 중첩 전달.
+    # 바뀐 값만 보내면 된다.
+    def user_update(user_id:, login_id: nil, login_pw: nil, name: nil, phone: nil, email: nil,
+                    tel: nil, nickname: nil, bank_username: nil, bank_account: nil, bank_code: nil,
+                    comment: nil, gender: nil, birth: nil, group: nil, idempotency_key: nil, **attrs)
+      request(
+        uri:     "users/#{user_id}",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        payload: {
+                   login_id:      login_id,
+                   login_pw:      login_pw,
+                   name:          name,
+                   phone:         phone,
+                   email:         email,
+                   tel:           tel,
+                   nickname:      nickname,
+                   bank_username: bank_username,
+                   bank_account:  bank_account,
+                   bank_code:     bank_code,
+                   comment:       comment,
+                   gender:        gender,
+                   birth:         birth,
+                   group:         group
+                 }.merge(attrs).compact
+      )
+    end
+  end
+end

data/lib/bootpay_store/concern/user_group.rb

@@ -0,0 +1,221 @@
+module BootpayStore::Concern::UserGroup
+  extend ActiveSupport::Concern
+
+  included do
+    # 등록된 User Group 정보를 가져온다
+    # Comment by GOSOMI
+    # @date: 2025-06-18
+    def user_groups(keyword: nil, page: 1, limit: 20, corporate_type: 2, idempotency_key: nil)
+      request(
+        uri:     'user-groups',
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        params:
+                 {
+                   keyword:        keyword,
+                   page:           page,
+                   limit:          limit,
+                   corporate_type: corporate_type
+                 }.compact
+      )
+    end
+
+    # user group 정보를 가져온다
+    # Comment by GOSOMI
+    # @date: 2025-06-18
+    def lookup_user_group(user_group_id:, idempotency_key: nil)
+      request(
+        uri:     "user-groups/#{user_group_id}",
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        }
+      )
+    end
+
+    # 새로운 User Group을 생성한다
+    # Comment by GOSOMI
+    # @date: 2025-06-18
+    def create_user_group(uid: nil, phone: nil, email: nil, address: nil, address_detail: nil, zipcode: nil,
+                          corporate_type: nil, bank: nil, bank_code: nil, company_name: nil, business_number: nil,
+                          registration_number: nil, business_type: nil, business_category: nil, ceo_name: nil, auth_company: nil,
+                          manager_name: nil, manager_phone: nil, manager_email: nil, pccc: nil, use_subscription_aggregate_transaction: nil,
+                          subscription_month_day: nil, subscription_week_day: nil, purchase_limit: nil, subscribed_limit: nil,
+                          limit_message: nil, idempotency_key: nil)
+      request(
+        uri:     'user-groups',
+        method:  :post,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        payload:
+                 {
+                   uid:                                    uid,
+                   phone:                                  phone,
+                   email:                                  email,
+                   address:                                address,
+                   address_detail:                         address_detail,
+                   corporate_type:                         corporate_type,
+                   bank:                                   bank,
+                   bank_code:                              bank_code,
+                   zipcode:                                zipcode,
+                   company_name:                           company_name,
+                   business_number:                        business_number,
+                   registration_number:                    registration_number,
+                   business_type:                          business_type,
+                   business_category:                      business_category,
+                   ceo_name:                               ceo_name,
+                   auth_company:                           auth_company,
+                   manager_name:                           manager_name,
+                   manager_phone:                          manager_phone,
+                   manager_email:                          manager_email,
+                   pccc:                                   pccc,
+                   use_subscription_aggregate_transaction: use_subscription_aggregate_transaction,
+                   subscription_month_day:                 subscription_month_day,
+                   subscription_week_day:                  subscription_week_day,
+                   purchase_limit:                         purchase_limit,
+                   subscribed_limit:                       subscribed_limit,
+                   limit_message:                          limit_message
+                 }.compact
+      )
+    end
+
+    # UserGroup 정보를 갱신한다
+    # Comment by GOSOMI
+    # @date: 2025-06-18
+    def update_user_group(user_group_id:, phone: nil, email: nil, address: nil, address_detail: nil, zipcode: nil,
+                          corporate_type: nil, bank: nil, bank_code: nil, company_name: nil, business_number: nil,
+                          registration_number: nil, business_type: nil, business_category: nil, ceo_name: nil, auth_company: nil,
+                          manager_name: nil, manager_phone: nil, manager_email: nil, pccc: nil, use_subscription_aggregate_transaction: nil,
+                          subscription_month_day: nil, subscription_week_day: nil, purchase_limit: nil, subscribed_limit: nil,
+                          limit_message: nil, idempotency_key: nil)
+      request(
+        uri:     "user-groups/#{user_group_id}",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        },
+        payload:
+                 {
+                   phone:                                  phone,
+                   email:                                  email,
+                   address:                                address,
+                   address_detail:                         address_detail,
+                   corporate_type:                         corporate_type,
+                   bank:                                   bank,
+                   bank_code:                              bank_code,
+                   zipcode:                                zipcode,
+                   company_name:                           company_name,
+                   business_number:                        business_number,
+                   registration_number:                    registration_number,
+                   business_type:                          business_type,
+                   business_category:                      business_category,
+                   ceo_name:                               ceo_name,
+                   auth_company:                           auth_company,
+                   manager_name:                           manager_name,
+                   manager_phone:                          manager_phone,
+                   manager_email:                          manager_email,
+                   pccc:                                   pccc,
+                   use_subscription_aggregate_transaction: use_subscription_aggregate_transaction,
+                   subscription_month_day:                 subscription_month_day,
+                   subscription_week_day:                  subscription_week_day,
+                   purchase_limit:                         purchase_limit,
+                   subscribed_limit:                       subscribed_limit,
+                   limit_message:                          limit_message
+                 }.compact
+      )
+    end
+
+    # UserGroup 정보를 삭제한다
+    # Comment by GOSOMI
+    # @date: 2025-06-19
+    def delete_user_group(user_group_id:, idempotency_key: nil)
+      request(
+        uri:     "user-groups/#{user_group_id}",
+        method:  :delete,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'user'
+        }
+      )
+    end
+
+    # 사용자 그룹에 사용자를 추가한다
+    def add_user_to_group(user_group_id:, user_id:, idempotency_key: nil)
+      request(
+        uri:     "user-groups/#{user_group_id}/user",
+        method:  :post,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'manager'
+        },
+        payload: { user_id: user_id }
+      )
+    end
+
+    # 사용자 그룹에서 사용자를 제거한다
+    def delete_user_from_group(user_group_id:, user_id:, idempotency_key: nil)
+      request(
+        uri:     "user-groups/#{user_group_id}/user/#{user_id}",
+        method:  :delete,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'manager'
+        }
+      )
+    end
+
+    # 그룹 구매한도를 설정한다 (PUT /v1/user-groups/:id/limit)
+    # @comment_by Claude (alfred)
+    # @date: 26-08-14
+    # ⚠️ update_user_group 으로는 한도가 절대 반영되지 않는다.
+    #    user_groups_controller#update 가 use_limit/limit_message/limit_month_purchase/limit_week_purchase 를
+    #    params.except! 로 명시적으로 제거하기 때문 — 한도는 이 전용 라우트로만 바뀐다.
+    # 서버 scope: manager:limit
+    def user_group_limit(user_group_id:, use_limit: nil, limit_month_purchase: nil,
+                         limit_week_purchase: nil, limit_message: nil, idempotency_key: nil)
+      request(
+        uri:     "user-groups/#{user_group_id}/limit",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'manager'
+        },
+        payload: {
+                   use_limit:            use_limit,
+                   limit_month_purchase: limit_month_purchase,
+                   limit_week_purchase:  limit_week_purchase,
+                   limit_message:        limit_message
+                 }.compact
+      )
+    end
+
+    # 그룹 구독 합산청구(정산주기) 설정을 변경한다 (PUT /v1/user-groups/:id/aggregate-transaction)
+    # @comment_by Claude (alfred)
+    # @date: 26-08-14
+    # update_user_group 에도 같은 이름의 인자가 있지만 서버는 이 전용 라우트에서만 처리한다.
+    def user_group_aggregate_transaction(user_group_id:, use_subscription_aggregate_transaction: nil,
+                                         subscription_month_day: nil, subscription_week_day: nil,
+                                         idempotency_key: nil)
+      request(
+        uri:     "user-groups/#{user_group_id}/aggregate-transaction",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'manager'
+        },
+        payload: {
+                   use_subscription_aggregate_transaction: use_subscription_aggregate_transaction,
+                   subscription_month_day:                 subscription_month_day,
+                   subscription_week_day:                  subscription_week_day
+                 }.compact
+      )
+    end
+  end
+end

data/lib/bootpay_store/concern/webhook.rb

@@ -0,0 +1,17 @@
+module BootpayStore::Concern::Webhook
+  extend ActiveSupport::Concern
+
+  included do
+    # 테스트 웹훅을 발송한다 (POST /v1/test-webhooks)
+    # @comment_by Claude (alfred)
+    # @date: 26-03-05
+    def send_test_webhook(header_content_type: nil)
+      request(
+        uri:     'webhook/test',
+        payload: {
+          header_content_type: header_content_type
+        }.compact
+      )
+    end
+  end
+end

data/lib/bootpay_store/concern.rb

@@ -0,0 +1,45 @@
+module BootpayStore
+  module Concern
+    require_relative 'concern/alimtalk_message'
+    require_relative 'concern/alimtalk_official'
+    require_relative 'concern/alimtalk_optout'
+    require_relative 'concern/alimtalk_send'
+    require_relative 'concern/alimtalk_sender'
+    require_relative 'concern/alimtalk_template'
+    require_relative 'concern/alimtalk_webhook'
+    require_relative 'concern/invoice'
+    require_relative 'concern/mall_setting'
+    require_relative 'concern/order'
+    require_relative 'concern/order_subscription'
+    require_relative 'concern/payment'
+    require_relative 'concern/product'
+    require_relative 'concern/rest'
+    require_relative 'concern/supervisor'
+    require_relative 'concern/token'
+    require_relative 'concern/user'
+    require_relative 'concern/user_group'
+    require_relative 'concern/store'
+    require_relative 'concern/webhook'
+
+    include AlimtalkMessage
+    include AlimtalkOfficial
+    include AlimtalkOptout
+    include AlimtalkSend
+    include AlimtalkSender
+    include AlimtalkTemplate
+    include AlimtalkWebhook
+    include Invoice
+    include MallSetting
+    include Order
+    include OrderSubscription
+    include Payment
+    include Product
+    include Rest
+    include Supervisor
+    include Token
+    include User
+    include UserGroup
+    include Store
+    include Webhook
+  end
+end

data/lib/bootpay_store/response.rb

@@ -0,0 +1,14 @@
+module BootpayStore
+  class Response
+    attr_reader :data
+
+    def initialize(success = true, data = {})
+      @success = success
+      @data    = data
+    end
+
+    def success?
+      @success
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Bootpay
+  VERSION = "3.0.0"
+
+  # 구 이름(`bootpay-backend-ruby`) 시절 gemspec·코드가 참조하던 상수.
+  # 값이 갈리지 않도록 VERSION 을 그대로 가리킨다.
+  V2_VERSION = VERSION
+end