bootpay 1.2.0 → 3.0.0

data/lib/bootpay_store/concern/product.rb

@@ -0,0 +1,175 @@
+module BootpayStore::Concern::Product
+  extend ActiveSupport::Concern
+
+  included do
+    # 상품 목록을 조회한다 (V1 Mall API)
+    # Comment by Codex
+    # @date: 2026-02-23
+    # @date: 26-08-14 ⚠️ keyword 는 서버(v1/products_controller#index)가 읽지 않는다.
+    #   컨트롤러는 page/limit/category_id/ex_uid/sort 만 사용 — keyword 를 보내도 조용히 무시된다.
+    #   하위호환 때문에 인자는 남겨두되, 검색이 필요하면 서버 지원 추가가 선행되어야 한다.
+    # @date: 26-08-26 ex_uid 인자 추가. 컨트롤러가 params[:ex_uid] 를 읽는데 SDK 에 인자가 없어
+    #   외부 UID 로 상품을 찾을 수 없었다.
+    def products(page: 1, limit: 20, category_id: nil, ex_uid: nil, sort: nil, keyword: nil,
+                 user_jwt: nil, idempotency_key: nil)
+      request(
+        uri:     'products',
+        method:  :get,
+        headers: {
+                   'Idempotency-Key'  => idempotency_key.presence || SecureRandom.uuid,
+                   'Bootpay-User-JWT' => user_jwt
+                 }.compact,
+        params:  {
+                   page:        page,
+                   limit:       limit,
+                   category_id: category_id,
+                   ex_uid:      ex_uid,
+                   sort:        sort,
+                   keyword:     keyword
+                 }.compact
+      )
+    end
+
+    # 상품 상세를 조회한다 (V1 Mall API)
+    # Comment by Codex
+    # @date: 2026-02-23
+    def product_detail(product_id:, user_jwt: nil, idempotency_key: nil)
+      request(
+        uri:     "products/#{product_id}",
+        method:  :get,
+        headers: {
+                   'Idempotency-Key'  => idempotency_key.presence || SecureRandom.uuid,
+                   'Bootpay-User-JWT' => user_jwt
+                 }.compact
+      )
+    end
+
+    # 상품 정보를 가져온다
+    # Comment by GOSOMI
+    # @date: 2025-10-10
+    # @date: 26-08-14 product_detail 과 uri·동작이 같다(차이는 user_jwt 인자 유무).
+    #   중복이지만 기존 사용자가 있을 수 있어 제거하지 않는다 — 신규 코드는 product_detail 을 쓸 것.
+    # @date: 26-08-26 user_jwt 를 여기에도 추가했다. 매뉴얼이 GET /v1/products/:id 에 user_jwt 를
+    #   안내하는데 이 메서드만 헤더를 안 보내 회원 컨텍스트 조회가 안 됐다. 이제 product_detail 과 동작이 같다.
+    def lookup_product(product_id:, user_jwt: nil, idempotency_key: nil)
+      request(
+        uri:     "products/#{product_id}",
+        method:  :get,
+        headers: {
+          'Idempotency-Key'  => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-User-JWT' => user_jwt
+        }.compact
+      )
+    end
+
+    # 상품을 등록한다 (POST /v1/products)
+    # @comment_by Claude (alfred)
+    # @date: 26-08-14
+    # images 가 있으면 multipart, 없으면 JSON 으로 보낸다.
+    # 컨트롤러가 읽는 필드는 _product_params 참조 — 여기 명시하지 않은 값도 attrs 로 그대로 전달된다.
+    def product_create(name:, display_price: nil, desc: nil, content: nil, category_id: nil,
+                       type: nil, stock: nil, status_sale: nil, status_display: nil,
+                       use_subscription: nil, subscription_setting_id: nil,
+                       images: nil, save_by: nil, idempotency_key: nil, **attrs)
+      payload = {
+        name:                    name,
+        display_price:           display_price,
+        desc:                    desc,
+        content:                 content,
+        category_id:             category_id,
+        type:                    type,
+        stock:                   stock,
+        status_sale:             status_sale,
+        status_display:          status_display,
+        use_subscription:        use_subscription,
+        subscription_setting_id: subscription_setting_id,
+        save_by:                 save_by
+      }.merge(attrs).compact
+
+      headers = {
+        'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+        'Bootpay-Role'    => 'manager'
+      }
+
+      if images.present?
+        form = payload.each_with_object({}) { |(k, v), h| h[k.to_s] = multipart_value(v) }
+        Array(images).each_with_index { |image, i| form["images[#{i}]"] = multipart_file(image) }
+        post_multipart(uri: 'products', form: form, headers: headers)
+      else
+        request(uri: 'products', method: :post, headers: headers, payload: payload)
+      end
+    end
+
+    # 상품을 수정한다 (PUT /v1/products/:id)
+    # @comment_by Claude (alfred)
+    # @date: 26-08-14
+    # 바뀐 값만 보내면 된다. category_id 는 키 존재 여부로 '해제 의사'를 판별하므로 주의.
+    def product_update(product_id:, name: nil, display_price: nil, desc: nil, content: nil,
+                       category_id: nil, stock: nil, status_sale: nil, status_display: nil,
+                       save_by: nil, idempotency_key: nil, **attrs)
+      request(
+        uri:     "products/#{product_id}",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'manager'
+        },
+        payload: {
+                   name:           name,
+                   display_price:  display_price,
+                   desc:           desc,
+                   content:        content,
+                   category_id:    category_id,
+                   stock:          stock,
+                   status_sale:    status_sale,
+                   status_display: status_display,
+                   save_by:        save_by
+                 }.merge(attrs).compact
+      )
+    end
+
+    # 상품을 삭제한다 (DELETE /v1/products/:id)
+    # @comment_by Claude (alfred)
+    # @date: 26-08-14
+    def product_delete(product_id:, idempotency_key: nil)
+      request(
+        uri:     "products/#{product_id}",
+        method:  :delete,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'manager'
+        }
+      )
+    end
+
+    # 상품 판매/노출 상태를 변경한다 (PUT /v1/products/:id/status)
+    # @comment_by Claude (alfred)
+    # @date: 26-08-14
+    # 컨트롤러 _status_params 기준. 재고(stock)는 여기가 아니라 product_update 로 바꾼다.
+    def product_status(product_id:, status_sale: nil, status_display: nil, status_frozen: nil,
+                       status_review: nil, use_display_period: nil, display_start_at: nil, display_end_at: nil,
+                       use_sale_period: nil, sale_start_at: nil, sale_end_at: nil,
+                       idempotency_key: nil, **attrs)
+      request(
+        uri:     "products/#{product_id}/status",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'manager'
+        },
+        payload: {
+                   status_sale:        status_sale,
+                   status_display:     status_display,
+                   status_frozen:      status_frozen,
+                   status_review:      status_review,
+                   use_display_period: use_display_period,
+                   display_start_at:   display_start_at,
+                   display_end_at:     display_end_at,
+                   use_sale_period:    use_sale_period,
+                   sale_start_at:      sale_start_at,
+                   sale_end_at:        sale_end_at
+                 }.merge(attrs).compact
+      )
+    end
+  end
+end

data/lib/bootpay_store/concern/rest.rb

@@ -0,0 +1,128 @@
+module BootpayStore::Concern::Rest
+  extend ActiveSupport::Concern
+
+  included do
+    private
+
+    # HTTP Request 기본 Method
+    # Comment by Gosomi
+    # Date: 2021-05-21
+    def request(method: :post, uri:, payload: {}, headers: {}, params: nil)
+      response = HTTP.headers(
+        {
+          Authorization:       @token.present? ? "Bearer #{@token}" : "Basic #{basic_authentification}",
+          content_type:        'application/json',
+          accept:              'application/json',
+          bootpay_api_version: @api_version,
+          bootpay_sdk_version: Bootpay::V2_VERSION,
+          bootpay_sdk_type:    '300'
+        }.merge!(headers).compact
+      ).send(
+        method.to_sym,
+        [BootpayStore::RestClient::API[@mode.to_sym], uri].join('/'),
+        json:   payload,
+        params: params
+      )
+      BootpayStore::Response.new(
+        response.status.to_i == 200,
+        JSON.parse(response.body.to_s, symbolize_names: true)
+      )
+    rescue Exception => e
+      BootpayStore::Response.new(
+        false,
+        message:   "부트페이 API 서버와의 통신이 실패하였습니다. 오류 메세지: #{e.message}",
+        backtrace: e.backtrace.join("\n")
+      )
+    end
+
+    # JSON 이 아닌 본문(CSV 등)을 파싱하지 않고 그대로 받는다.
+    # @comment_by Claude (alfred)
+    # @date: 26-08-27
+    # ⚠️ 공용 request 는 응답을 무조건 JSON.parse 하므로, CSV 를 돌려주는 엔드포인트
+    #    (알림톡 템플릿 내보내기 format=csv)에서는 파싱 실패가 rescue 로 흘러
+    #    **"부트페이 API 서버와의 통신이 실패하였습니다"** 라는 틀린 메시지로 보고된다.
+    #    실제로는 성공한 요청이라 그대로 두면 원인을 못 찾는다. 그래서 원문 경로를 따로 둔다.
+    # 성공 시 data 는 { body: '<원문 문자열>', content_type: '...' } 다.
+    def request_raw(uri:, method: :get, params: nil, headers: {})
+      response = HTTP.headers(
+        {
+          Authorization:       @token.present? ? "Bearer #{@token}" : "Basic #{basic_authentification}",
+          accept:              '*/*',
+          bootpay_api_version: @api_version,
+          bootpay_sdk_version: Bootpay::V2_VERSION,
+          bootpay_sdk_type:    '300'
+        }.merge!(headers).compact
+      ).send(
+        method.to_sym,
+        [BootpayStore::RestClient::API[@mode.to_sym], uri].join('/'),
+        params: params
+      )
+      BootpayStore::Response.new(
+        response.status.to_i == 200,
+        body:         response.body.to_s,
+        content_type: response.headers['Content-Type'].to_s
+      )
+    rescue Exception => e
+      BootpayStore::Response.new(
+        false,
+        message:   "부트페이 API 서버와의 통신이 실패하였습니다. 오류 메세지: #{e.message}",
+        backtrace: e.backtrace.join("\n")
+      )
+    end
+
+    # multipart/form-data 전송 (파일 업로드용)
+    # @comment_by Claude (alfred)
+    # @date: 26-08-14
+    # ⚠️ content_type 을 명시하지 않는다. 명시하면 HTTP.rb 가 붙이는 boundary 가 사라져 본문이 깨진다.
+    #    (Node SDK 는 인터셉터가 Content-Type 을 덮어써 본문이 null 로 전송되는 버그가 있다 — 같은 함정)
+    # 기존 request 는 json: 고정이라 손대지 않고 별도 메서드로 둔다.
+    def post_multipart(uri:, form: {}, headers: {})
+      response = HTTP.headers(
+        {
+          Authorization:       @token.present? ? "Bearer #{@token}" : "Basic #{basic_authentification}",
+          accept:              'application/json',
+          bootpay_api_version: @api_version,
+          bootpay_sdk_version: Bootpay::V2_VERSION,
+          bootpay_sdk_type:    '300'
+        }.merge!(headers).compact
+      ).post(
+        [BootpayStore::RestClient::API[@mode.to_sym], uri].join('/'),
+        form: form
+      )
+      BootpayStore::Response.new(
+        response.status.to_i == 200,
+        JSON.parse(response.body.to_s, symbolize_names: true)
+      )
+    rescue Exception => e
+      BootpayStore::Response.new(
+        false,
+        message:   "부트페이 API 서버와의 통신이 실패하였습니다. 오류 메세지: #{e.message}",
+        backtrace: e.backtrace.join("\n")
+      )
+    end
+
+    # multipart form 값 정규화 — 파일은 FormData::File 로, 나머지는 문자열로.
+    # 파일은 경로(String)·IO·HTTP::FormData::File 셋 다 받는다.
+    # @comment_by Claude (alfred)
+    # @date: 26-08-14
+    def multipart_file(value)
+      return value if value.is_a?(HTTP::FormData::File)
+      HTTP::FormData::File.new(value)
+    end
+
+    def multipart_value(value)
+      case value
+      when Array, Hash then value.to_json
+      when TrueClass, FalseClass then value.to_s
+      else value.to_s
+      end
+    end
+
+    # basic authenticate 추가
+    # Comment by GOSOMI
+    # @date: 2026-02-20
+    def basic_authentification
+      Base64.strict_encode64("#{@client_key}:#{@secret_key}")
+    end
+  end
+end

data/lib/bootpay_store/concern/store.rb

@@ -0,0 +1,31 @@
+module BootpayStore::Concern::Store
+  extend ActiveSupport::Concern
+
+  included do
+    # 가맹점 기본 정보를 조회한다 (/v1/store)
+    # Comment by Codex
+    # @date: 2026-02-23
+    def get_store(idempotency_key: nil)
+      request(
+        uri:     'store',
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid
+        }
+      )
+    end
+
+    # 가맹점 상세 정보를 조회한다 (/v1/store/detail)
+    # Comment by Codex
+    # @date: 2026-02-23
+    def get_store_detail(idempotency_key: nil)
+      request(
+        uri:     'store/detail',
+        method:  :get,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid
+        }
+      )
+    end
+  end
+end

data/lib/bootpay_store/concern/supervisor.rb

@@ -0,0 +1,211 @@
+module BootpayStore::Concern::Supervisor
+  extend ActiveSupport::Concern
+
+  included do
+    # 주문 취소
+    # Comment by GOSOMI
+    # @date: 2025-04-04
+    # param force: 결제취소 실패시 주문을 강제로 취소 상태로 변경
+    def supervisor_request_order_cancel(idempotency_key: nil, cancel_id: nil, order_number:, cancel_products: nil, cancel_price: nil,
+                                        cancel_tax_free_price: 0, cancel_requester: '시스템', cancel_message: '요청취소', cancel_immediately: false,
+                                        cancel_order_subscription_bills: nil, force: false)
+      request(
+        uri:     'order/cancel',
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'supervisor'
+        },
+        payload:
+                 {
+                   order_number:              order_number,
+                   request_cancel_parameters: {
+                                                cancel_id:                       cancel_id,
+                                                cancel_products:                 cancel_products,
+                                                cancel_order_subscription_bills: cancel_order_subscription_bills,
+                                                cancel_price:                    cancel_price,
+                                                cancel_tax_free_price:           cancel_tax_free_price,
+                                                cancel_requester:                cancel_requester,
+                                                cancel_message:                  cancel_message,
+                                                cancel_immediately:              cancel_immediately,
+                                                force:                           force
+                                              }.compact
+                 }.compact
+      )
+    end
+
+    # bill 주문 취소
+    # 전체취소 하거나, 부분취소할 수 있다.
+    # 부분취소는 상품으로하거나 금액으로 할 수 있는데, 상품으로 취소되면 배송비 등이 자동 계산되지만, 금액으로 취소는 환불개념이라 자동계산 되지 않는다.
+    # Comment by ehowlsla
+    # @date: 2025-04-04
+    def supervisor_request_order_subscription_bill_cancel(idempotency_key: nil, cancel_id: nil, order_subscription_bill_id:, cancel_products: [], cancel_price: nil,
+                                                          cancel_tax_free_price: nil, cancel_requester: '시스템', cancel_message: '요청취소', cancel_immediately: false)
+
+      request(
+        uri:     'order_subscriptions/bill/cancel',
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'supervisor'
+        },
+        payload:
+                 {
+                   order_subscription_bill_id: order_subscription_bill_id,
+                   cancel_id:                  cancel_id,
+                   cancel_products:            cancel_products,
+                   cancel_price:               cancel_price,
+                   cancel_tax_free_price:      cancel_tax_free_price,
+                   cancel_requester:           cancel_requester,
+                   cancel_message:             cancel_message,
+                   cancel_immediately:         cancel_immediately
+                 }.compact
+      )
+
+    end
+
+    # 구독 단건 관리자 승인
+    # 관리자 승인일 경우 bill 생성 후 (선불이면) 결제를 진행해야함
+    # Comment by ehowlsla
+    # @date: 2025-11-19
+    def supervisor_request_order_subscription_approve(idempotency_key: nil, order_subscription_id:, reason: nil)
+      request(
+        uri:     "order_subscriptions/#{order_subscription_id}/approve",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'supervisor'
+        },
+        payload:
+                 {
+                   reason: reason
+                 }.compact
+      )
+    end
+
+    # 구독 단건 승인 거절
+    # 요청된 구독건에 대해 거절 처리
+    # 만약 생성된 bill 이 있다면 함께 취소 처리
+    # Comment by ehowlsla
+    # @date: 2025-11-9
+    def supervisor_request_order_subscription_reject(idempotency_key: nil, order_subscription_id:, reason: nil)
+      request(
+        uri:     "order_subscriptions/#{order_subscription_id}/reject",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'supervisor'
+        },
+        payload:
+                 {
+                   reason: reason
+                 }.compact
+      )
+    end
+
+    # 구독 해지 실행
+    # Comment by GOSOMI
+    # @date: 2026-01-21
+    def supervisor_request_order_subscription_terminate(idempotency_key: nil, order_subscription_id:, reason: nil,
+                                                        termination_fee: nil, last_bill_refund_price: nil, final_fee: nil,
+                                                        service_end_at: nil, cancel_date: nil)
+      request(
+        uri:     "order_subscriptions/#{order_subscription_id}/terminate",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'supervisor'
+        },
+        payload:
+                 {
+                   reason:                 reason,
+                   termination_fee:        termination_fee,
+                   last_bill_refund_price: last_bill_refund_price,
+                   final_fee:              final_fee,
+                   service_end_at:         service_end_at,
+                   cancel_date:            cancel_date
+                 }.compact
+      )
+    end
+
+    # 구독 멈춤
+    # Comment by GOSOMI
+    # @date: 2026-01-22
+    def supervisor_request_order_subscription_pause(idempotency_key: nil, order_subscription_id:, reason: nil,
+                                                    paused_at:, expected_resume_at: nil)
+      request(
+        uri:     "order_subscriptions/#{order_subscription_id}/pause",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'supervisor'
+        },
+        payload:
+                 {
+                   reason:             reason,
+                   paused_at:          paused_at,
+                   expected_resume_at: expected_resume_at
+                 }.compact
+      )
+    end
+
+    # 구독 재개
+    # Comment by GOSOMI
+    # @date: 2026-01-22
+    def supervisor_request_order_subscription_resume(idempotency_key: nil, order_subscription_id:, reason: nil)
+      request(
+        uri:     "order_subscriptions/#{order_subscription_id}/resume",
+        method:  :put,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'supervisor'
+        },
+        payload:
+                 {
+                   reason: reason
+                 }.compact
+      )
+    end
+
+    # 수시결제(온디맨드) charge_key 즉시 결제
+    # charge_key는 body로만 전송한다 (URL/query 금지 — 액세스 로그 노출 방지)
+    # Comment by GOSOMI
+    # @date: 2026-07-23
+    def supervisor_request_order_subscription_charge(idempotency_key: nil, charge_key:, price:,
+                                                     tax_free_price: nil, user: nil, metadata: nil)
+      request(
+        uri:     'order_subscriptions/charge',
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'supervisor'
+        },
+        payload:
+                 {
+                   charge_key:     charge_key,
+                   price:          price,
+                   tax_free_price: tax_free_price,
+                   user:           user,
+                   metadata:       metadata
+                 }.compact
+      )
+    end
+
+    # 수시결제(온디맨드) charge_key 해지
+    # 해지 이후 해당 키로의 재결제는 불가능하다
+    # Comment by GOSOMI
+    # @date: 2026-07-23
+    def supervisor_request_order_subscription_charge_revoke(idempotency_key: nil, charge_key:, user: nil)
+      request(
+        uri:     'order_subscriptions/charge',
+        method:  :delete,
+        headers: {
+          'Idempotency-Key' => idempotency_key.presence || SecureRandom.uuid,
+          'Bootpay-Role'    => 'supervisor'
+        },
+        payload:
+                 {
+                   charge_key: charge_key,
+                   user:       user
+                 }.compact
+      )
+    end
+  end
+end

data/lib/bootpay_store/concern/token.rb

@@ -0,0 +1,24 @@
+module BootpayStore::Concern::Token
+  extend ActiveSupport::Concern
+
+  included do
+    # Access Token을 요청한다
+    # Comment by Gosomi
+    # Date: 2021-05-21
+    # @deprecated
+    def request_access_token
+      response = request(
+        uri:     'request/token',
+        headers: {
+          Authorization: "Basic #{Base64.strict_encode64("#{@client_key}:#{@secret_key}")}"
+        }
+      )
+      @token   = response.data[:access_token] if response.success?
+      response
+    end
+
+    def set_token(token)
+      @token = token
+    end
+  end
+end