bootpay 1.2.0 → 3.0.0

data/bootpay.gemspec

@@ -1,31 +1,34 @@
 # frozen_string_literal: true
-# lib = File.expand_path('../lib', __FILE__)
-# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require_relative "lib/bootpay/version"
+require_relative "lib/version"
 
 Gem::Specification.new do |spec|
   spec.name    = "bootpay"
   spec.version = Bootpay::VERSION
-  spec.authors = ["bootpay"]
-  spec.email   = ["bootpay.co.kr@gmail.com"]
-
-  spec.summary               = "Bootpay server side plugin for ruby"
-  spec.description           = "결제검증 및 취소 등의 기능 연동을 위한 bootpay ruby 플러그인 입니다."
-  spec.homepage              = "http://www.bootpay.co.kr"
-  spec.license               = "MIT"
-  spec.required_ruby_version = ">= 2.4.0"
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
+  spec.authors = ["gosomi"]
+  spec.email   = ["gosomi@bootpay.co.kr"]
+
+  spec.summary     = "Bootpay Ruby REST Client"
+  spec.description = "부트페이 공식 Ruby 서버사이드 모듈입니다. 결제조회, 취소, 빌링키 결제시 사용됩니다."
+  spec.license     = "MIT"
+  spec.homepage    = "https://www.bootpay.ai"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bootpay/backend-ruby/tree/2-x-development"
+  spec.metadata["changelog_uri"]   = "https://github.com/bootpay/backend-ruby/blob/2-x-development/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://developers.bootpay.ai"
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # ⚠️ 루트의 tests_*.rb / *.gem 도 제외한다 — 종전 규칙은 test/·spec/·features/ **디렉터리**만
+  #    걸러서 루트에 있던 tests_basic_auth_product_info.rb 가 gem 에 실려 나갔다.
+  #    그 파일에는 dev Commerce secret_key 가 하드코딩돼 있었다 (26-09-02).
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features)/}) ||
+        f.match(%r{\A(?:tests?_.*\.rb|.*\.gem)\z}) ||
+        f.match(%r{\A\.env})
+    end
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
@@ -34,7 +37,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "activesupport"
   spec.add_dependency "http"
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "addressable"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/bootpay/bootpay-rest-client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+require 'http'
+require_relative 'response'
+require_relative '../version'
+require_relative 'concern'
+
+module Bootpay
+  class RestClient
+    include Concern
+
+    attr_accessor :application_id, :private_key, :client_key, :secret_key, :use_client_key, :mode, :token, :api_version
+
+    API =
+      {
+        development: 'https://dev-api.bootpay.co.kr/v2',
+        stage:       'https://stage-api.bootpay.co.kr/v2',
+        production:  'https://api.bootpay.co.kr/v2'
+      }
+
+    SDK_VERSION = '5.3.0'
+
+    def initialize(application_id: nil, private_key: nil, client_key: nil, secret_key: nil, mode: 'production')
+      @application_id = application_id
+      @private_key    = private_key
+      @client_key     = client_key
+      @secret_key     = secret_key
+      @use_client_key = client_key.present?
+      @mode           = mode.presence || 'production'
+      @token          = nil
+      @api_version    = SDK_VERSION
+      raise ArgumentError, "개발환경 mode는 development, stage, production 중에서 선택이 가능합니다." if API[@mode.to_sym].blank?
+    end
+
+    # API URL을 변경
+    # Comment by GOSOMI
+    # @date: 2023-05-26
+    def set_api_url(url)
+      API[@mode.to_sym] = url
+    end
+
+    # API 버전을 설정한다
+    # Comment by Gosomi
+    # Date: 2022-07-29
+    def set_api_version(version)
+      raise ArgumentError, 'API Version은 4.0.0 이상만 설정이 가능합니다.' if version < '4.0.0'
+      @api_version = version
+    end
+  end
+end

data/lib/bootpay/concern/authenticate.rb

@@ -0,0 +1,69 @@
+module Bootpay::Concern::Authenticate
+  extend ActiveSupport::Concern
+
+  included do
+    # 본인인증 데이터 가져오기
+    # Comment by Gosomi
+    # Date: 2021-12-08
+    def certificate(receipt_id)
+      request(
+        method: :get,
+        uri:    "certificate/#{receipt_id}"
+      )
+    end
+
+    # REST API로 본인인증 요청하기
+    # Comment by Gosomi
+    # Date: 2022-11-02
+    def request_authentication(pg:, method:, username:, identity_no:, carrier:, phone:, site_url:,
+                               authenticate_type: 'sms', order_name: '', authentication_id: '', extra: {}, user: {}, client_ip: nil)
+      request(
+        method: :post,
+        uri:    'request/authentication',
+        payload:
+                {
+                  pg:                pg,
+                  method:            method,
+                  username:          username,
+                  identity_no:       identity_no,
+                  carrier:           carrier,
+                  phone:             phone,
+                  site_url:          site_url,
+                  authenticate_type: authenticate_type,
+                  order_name:        order_name,
+                  authentication_id: authentication_id,
+                  extra:             extra,
+                  user:              user,
+                  client_ip:         client_ip
+                }.compact
+      )
+    end
+
+    # 본인인증 승인결과를 가져온다
+    # Comment by Gosomi
+    # Date: 2022-11-03
+    def confirm_authentication(receipt_id:, otp: nil)
+      request(
+        method:  :post,
+        uri:     'authenticate/confirm',
+        payload: {
+          receipt_id: receipt_id,
+          otp:        otp
+        }
+      )
+    end
+
+    # 다시 SMS/알람 보내기
+    # Comment by Gosomi
+    # Date: 2022-11-03
+    def realarm_authentication(receipt_id)
+      request(
+        method:  :post,
+        uri:     'authenticate/realarm',
+        payload: {
+          receipt_id: receipt_id
+        }
+      )
+    end
+  end
+end

data/lib/bootpay/concern/cash_receipt.rb

@@ -0,0 +1,83 @@
+module Bootpay::Concern::CashReceipt
+  extend ActiveSupport::Concern
+
+  included do
+    # 현금 영수증 발행 처리 하기
+    # Comment by Gosomi
+    # Date: 2021-12-15
+    def request_cash_receipt(pg: nil, order_name:, identity_no:, purchased_at:, cash_receipt_type:, price:, tax_free:, user: {},
+                             metadata: {}, extra: {}, order_id:)
+      request(
+        method:  :post,
+        uri:     'request/cash/receipt',
+        payload: {
+          pg:                pg,
+          order_name:        order_name,
+          identity_no:       identity_no,
+          purchased_at:      purchased_at,
+          cash_receipt_type: cash_receipt_type,
+          price:             price,
+          tax_free:          tax_free,
+          user:              user,
+          metadata:          metadata,
+          order_id:          order_id,
+          extra:             extra
+        }
+      )
+    end
+
+    # 현금영수증 발행 취소
+    # Comment by Gosomi
+    # Date: 2021-12-16
+    def cancel_cash_receipt(receipt_id:, cancel_username:, cancel_message:)
+      request(
+        method:  :delete,
+        uri:     "request/cash/receipt/#{receipt_id}",
+        headers: {
+          params: {
+            cancel_username: cancel_username,
+            cancel_message:  cancel_message
+          }
+        }
+      )
+    end
+
+    # 결제된 계좌이체/가상계좌 결제건중 누락된 현금영수증을 발행해주는 API
+    # Comment by Gosomi
+    # Date: 2022-07-21
+    def cash_receipt_publish_on_receipt(receipt_id:, username:, email:, phone:, identity_no:, currency: 'WON',
+                                        cash_receipt_type: '소득공제', pg: nil, test_production: false)
+      request(
+        method:  :post,
+        uri:     "request/receipt/cash/publish",
+        payload: {
+          pg:                pg,
+          receipt_id:        receipt_id,
+          username:          username,
+          email:             email,
+          phone:             phone,
+          identity_no:       identity_no,
+          currency:          currency,
+          cash_receipt_type: cash_receipt_type,
+          test_production:   test_production
+        }
+      )
+    end
+
+    # 결제에 포함된 현금영수증 취소
+    # Comment by Gosomi
+    # Date: 2022-07-21
+    def cash_receipt_cancel_on_receipt(receipt_id:, cancel_username:, cancel_message:)
+      request(
+        method:  :delete,
+        uri:     "request/receipt/cash/cancel/#{receipt_id}",
+        headers: {
+          params: {
+            cancel_username: cancel_username,
+            cancel_message:  cancel_message
+          }
+        }
+      )
+    end
+  end
+end

data/lib/bootpay/concern/easy.rb

@@ -0,0 +1,18 @@
+module Bootpay::Concern::Easy
+  extend ActiveSupport::Concern
+
+  included do
+    # 간편결제 subscribe
+    # Comment by Gosomi
+    # Date: 2022-02-11
+    def subscribe_on_easy(receipt_id:, billing_key:)
+      request(
+        uri:     'subscribe/easy',
+        payload: {
+          receipt_id:  receipt_id,
+          billing_key: billing_key
+        }
+      )
+    end
+  end
+end

data/lib/bootpay/concern/escrow.rb

@@ -0,0 +1,25 @@
+module Bootpay::Concern::Escrow
+  extend ActiveSupport::Concern
+
+  included do
+    # 배송시작 API
+    # Comment by Gosomi
+    # Date: 2021-12-14
+    def shipping_start(receipt_id:, tracking_number:, delivery_corp:, shipping_prepayment: true,
+                       shipping_day: 5, user: nil, company: {}, redirect_url: nil)
+      request(
+        method:  :put,
+        uri:     "escrow/shipping/start/#{receipt_id}",
+        payload: {
+          tracking_number:     tracking_number,
+          delivery_corp:       delivery_corp,
+          shipping_prepayment: shipping_prepayment,
+          shipping_day:        shipping_day,
+          user:                user,
+          company:             company,
+          redirect_url:        redirect_url
+        }
+      )
+    end
+  end
+end

data/lib/bootpay/concern/payment.rb

@@ -0,0 +1,126 @@
+module Bootpay::Concern::Payment
+  extend ActiveSupport::Concern
+
+  included do
+    # 결제 정보 가져오기
+    # Comment by Gosomi
+    # Date: 2021-12-08
+    def receipt_payment(receipt_id, lookup_user_data = false)
+      request(
+        method: :get,
+        uri:    "receipt/#{receipt_id}?lookup_user_data=#{lookup_user_data}",
+      )
+    end
+
+    # OrderId로 결제 정보 조회하기
+    # Comment by GOSOMI
+    # @date: 2024-01-27
+    def lookup_order_id(order_id)
+      request(
+        method: :get,
+        uri:    "lookup/order/#{order_id}",
+      )
+    end
+
+    # 결제 승인처리
+    # Comment by Gosomi
+    # Date: 2022-01-04
+    def confirm_payment(receipt_id)
+      request(
+        uri:     'confirm',
+        payload: {
+          receipt_id: receipt_id
+        }
+      )
+    end
+
+    # 결제 취소 요청
+    # Comment by Gosomi
+    # Date: 2021-05-21
+    def cancel_payment(cancel_id: nil, receipt_id:, cancel_price: nil, cancel_tax_free: nil, cancel_username: '시스템', cancel_message: '결제취소',
+                       cancel_requester: '관리자', refund: { bank_account: nil, bank_username: nil, bank_code: nil }, items: nil)
+      request(
+        uri: 'cancel',
+        payload:
+             {
+               cancel_id:        cancel_id.presence || SecureRandom.uuid,
+               receipt_id:       receipt_id,
+               cancel_price:     cancel_price,
+               cancel_tax_free:  cancel_tax_free,
+               cancel_username:  cancel_username,
+               cancel_message:   cancel_message,
+               cancel_requester: cancel_requester,
+               refund:           refund,
+               items:            items
+             }.compact
+      )
+    end
+
+    # REST API로 결제 요청하기
+    # Comment by Gosomi
+    # Date: 2023-03-28
+    def request_payment(platform_application_id: nil, pg:, method: nil, price:, tax_free: 0, order_name:, order_id:, user_token: nil, uuid: nil, sk: nil,
+                        ti: 0, tk: nil, items: [], extra: {}, user: {}, agent: nil, commission_keys: nil, wallet_id: nil, terms: [], widget_key: nil, widget_sandbox: false,
+                        redirect_url: nil)
+      rand_uuid = SecureRandom.uuid
+      request(
+        uri: 'request/payment',
+        payload:
+             {
+               platform_application_id: platform_application_id,
+               pg:                      pg,
+               method:                  method,
+               price:                   price,
+               tax_free:                tax_free,
+               order_name:              order_name,
+               order_id:                order_id,
+               user_token:              user_token,
+               wallet_id:               wallet_id,
+               commission_keys:         commission_keys,
+               terms:                   terms,
+               redirect_url:            redirect_url,
+               widget:                  widget_key.present? ? 1 : 0,
+               widget_key:              widget_key,
+               widget_sandbox:          widget_sandbox,
+               uuid:                    uuid.presence || rand_uuid,
+               sk:                      sk.presence || "#{rand_uuid}-#{Time.current.to_i}",
+               ti:                      ti,
+               tk:                      tk.presence || "#{rand_uuid}-#{Time.current.to_i}",
+               items:                   items,
+               extra:                   extra,
+               user:                    user,
+               __agent:                 agent,
+               ver:                     Bootpay::RestClient::SDK_VERSION,
+               sdk_version:             Bootpay::V2_VERSION
+             }
+      )
+    end
+
+    # 가상계좌 bulk 발급 요청
+    # Comment by GOSOMI
+    # @date: 2023-08-08
+    def request_virtual_account_bulk(pg:, order_id:, order_name:, currency: 'KRW', price:, tax_free: nil, bank_code:, bank_account:,
+                                     bank_username:, cash_receipt_type: nil, identity_no: nil, user: {}, metadata: {}, extra: {})
+      request(
+        uri: 'request/virtual-account/bulk',
+        payload:
+             {
+               pg:                pg,
+               order_id:          order_id,
+               order_name:        order_name,
+               currency:          currency,
+               price:             price,
+               tax_free:          tax_free,
+               bank_code:         bank_code,
+               bank_account:      bank_account,
+               bank_username:     bank_username,
+               cash_receipt_type: cash_receipt_type,
+               identity_no:       identity_no,
+               user:              user,
+               metadata:          metadata,
+               extra:             extra
+             }.compact
+      )
+    end
+  end
+end

data/lib/bootpay/concern/reseller.rb

@@ -0,0 +1,97 @@
+module Bootpay::Concern::Reseller
+  extend ActiveSupport::Concern
+
+  included do
+    # 가맹점 계정을 생성한다
+    # Comment by Gosomi
+    # Date: 2022-01-05
+    def create_seller(company_alias:, company_name:, email: nil, regist_no: nil, owner_name: nil,
+                      phone: nil, zip: nil, address1: nil, address2: nil, app_name: nil, primary_key:, resources: nil,
+                      send_email: false)
+      request(
+        uri:     'reseller/seller',
+        payload: {
+          company_alias: company_alias,
+          company_name:  company_name,
+          email:         email,
+          regist_no:     regist_no,
+          owner_name:    owner_name,
+          phone:         phone,
+          zip:           zip,
+          address1:      address1,
+          address2:      address2,
+          app_name:      app_name,
+          primary_key:   primary_key,
+          resources:     resources,
+          send_email:    send_email
+        }
+      )
+    end
+
+    # 가맹점 정보를 조회한다
+    # Comment by GOSOMI
+    # @date: 2024-07-09
+    def lookup_seller(provider_id)
+      request(
+        method: :get,
+        uri:    "reseller/seller/#{provider_id}",
+      )
+    end
+
+    # 테스트로 생성한 계정을 모두 삭제한다
+    # Comment by GOSOMI
+    # @date: 2023-10-11
+    def test_destroy_provider(provider_id)
+      request(
+        uri:    "reseller/test/seller/#{provider_id}",
+        method: :delete
+      )
+    end
+
+    # Resource 정보를 갱신한다
+    # Comment by GOSOMI
+    # @date: 2023-10-12
+    def update_seller_payment_resources(app_id:, resources:)
+      request(
+        uri:     "reseller/seller/app/resource/#{app_id}",
+        method:  :put,
+        payload: {
+          resources: resources
+        }
+      )
+    end
+
+    # 판매점의 프로젝트 생성하기
+    # Comment by Gosomi
+    # Date: 2022-01-05
+    def create_seller_app(provider_id:, name:, unit: 'KRW', real: '실물', desc: nil, timezone: 'Asia/Seoul')
+      request(
+        uri:     'reseller/seller/app',
+        payload: {
+          provider_id: provider_id,
+          name:        name,
+          unit:        unit,
+          real:        real,
+          desc:        desc,
+          timezone:    timezone
+        }
+      )
+    end
+
+    # 프로젝트/가맹점 초대하기
+    # Comment by Gosomi
+    # Date: 2022-01-13
+    def member_invite(email:, level:, app_id: nil, invite_type:, provider_id: nil)
+      request(
+        uri:     'reseller/invite',
+        payload: {
+          email:       email,
+          level:       level,
+          app_id:      app_id,
+          provider_id: provider_id,
+          invite_type: invite_type
+        }
+      )
+    end
+  end
+end

data/lib/bootpay/concern/rest.rb

@@ -0,0 +1,56 @@
+module Bootpay::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:       authotization_header,
+          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,
+        [Bootpay::RestClient::API[@mode.to_sym], uri].join('/'),
+        json:   payload,
+        params: params
+      )
+      Bootpay::Response.new(
+        response.status.to_i == 200,
+        JSON.parse(response.body.to_s, symbolize_names: true)
+      )
+    rescue Exception => e
+      Bootpay::Response.new(
+        false,
+        message:   "부트페이 API 서버와의 통신이 실패하였습니다. 오류 메세지: #{e.message}",
+        backtrace: e.backtrace.join("\n")
+      )
+    end
+
+    # Authorize Header
+    # Comment by GOSOMI
+    # @date: 2026-03-11
+    def authotization_header
+      if @use_client_key
+        "Basic #{basic_authentification}"
+      else
+        "Bearer #{@token}" if @token.present?
+      end
+    end
+
+    # basic_authentification
+    # Comment by GOSOMI
+    # @date: 2026-03-11
+    def basic_authentification
+      @token = Base64.strict_encode64("#{@client_key}:#{@secret_key}")
+    end
+  end
+end

data/lib/bootpay/concern/sdk.rb

@@ -0,0 +1,52 @@
+module Bootpay::Concern::Sdk
+  extend ActiveSupport::Concern
+
+  included do
+    # 현재 등록된 지갑 정보를 가져온다
+    # Comment by Gosomi
+    # Date: 2022-02-21
+    def wallets(user_token)
+      request(
+        method:  :get,
+        uri:     "sdk/easy/wallet",
+        headers: {
+          'Bootpay-User-Token': user_token
+        }
+      )
+    end
+
+    # Biometric Authenticate
+    # Comment by Gosomi
+    # Date: 2022-02-21
+    def regist_biometric_authenticate(os:, token:, user_token:, uuid:)
+      request(
+        method:  :post,
+        uri:     'sdk/easy/biometric',
+        headers: {
+          'Bootpay-User-Token':  user_token,
+          'Bootpay-Device-UUID': uuid
+        },
+        payload: {
+          os:    os,
+          token: token
+        }
+      )
+    end
+
+    # Validate Password Token
+    # Comment by GOSOMI
+    # @date: 2025-12-24
+    def validate_password_token(token:, user_token:)
+      request(
+        method:  :post,
+        uri:     'sdk/password-token',
+        headers: {
+          'Bootpay-User-Token': user_token
+        },
+        payload: {
+          token: token
+        }
+      )
+    end
+  end
+end

data/lib/bootpay/concern/seller.rb

@@ -0,0 +1,15 @@
+module Bootpay::Concern::Seller
+  extend ActiveSupport::Concern
+
+  included do
+    # 현재 사용가능한 결제수단 목록 보기
+    # Comment by Gosomi
+    # Date: 2022-08-19
+    def lookup_payment_methods
+      request(
+        uri:    'seller/payment/method',
+        method: :get
+      )
+    end
+  end
+end

data/lib/bootpay/concern/service.rb

@@ -0,0 +1,15 @@
+module Bootpay::Concern::Service
+  extend ActiveSupport::Concern
+
+  included do
+    # 등록된 Wallet 정보를 가져온다
+    # Comment by GOSOMI
+    # @date: 2024-06-27
+    def lookup_service_wallets
+      request(
+        uri:    'seller/service/wallet',
+        method: :get
+      )
+    end
+  end
+end