bootpay 1.0.3 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7be9922ed3bc9c96baa0bd0fa2c4bc3808de03a1d1f60fbc80607a8bd8af6e9b
-  data.tar.gz: 8a30c213d19ebe55820aec6b9f1db984771dbad02d61fa8e8bc59af137b53fb1
+  metadata.gz: 67247bbea9fec88697e3e4ee68dc1798e0b0c3e3b8aa55099e3ea029b3b389a5
+  data.tar.gz: c376cf2c3dc1b85317b76e3f1f3b0c4d5fde2627458ebd724160f3649b8d1eb8
 SHA512:
-  metadata.gz: 9f5678fc5ac4854ea067a15d02770551584032f98ec96997564a46954804b9aad08c4f7f74ed36cc270a4ea86c598ea571820cc7c14126eb869adcfd4c0c1cd0
-  data.tar.gz: 3b14fec83f8f6979d5425919a5dc98f2157d925bb6c16639e8b715bdc3576be2e1f8d607a48b4ccf4097dab1097fdfe5da736f56e81c51a3b59af13af4a2bb9e
+  metadata.gz: f6eddf1d558f4e185538788703a5609bda99b36a9426e6ecb673a261a7eece95dadc6d9f420204583bdf68d6db1a85ff7df987a4d9eef58e5dacb64f54a2de41
+  data.tar.gz: 847f3b3631e76549006b851c5f9a0dbf7e51acc9b5130442293fb1ba4626ca37493c6f5e5b6fb8b6b55a8dfadbf77048fb49b2391eab825f530b6a0c84eb88b3

data/.gitignore

@@ -13,3 +13,4 @@
 *.idea
 *.iml
 Gemfile.lock
+*.gem

data/CHANGELOG.md

@@ -1,5 +1,23 @@
-## [Unreleased]
+### 1.0.6 
+- request_link api 에 주석 추가 
 
-## [0.1.0] - 2021-08-30
+### 1.0.5
+- model별 주석 추가, extra에 불필요한 파라미터 제거
 
-- Initial release
+### 1.0.4
+
+- cancel에 refund 형식 수정 
+
+### 1.0.3 
+
+- BankCode 추가
+
+### 1.0.2
+- certificate data type application/json 으로 수정
+
+### 1.0.1
+- namespace 변경  
+
+### 1.0.0
+
+- 첫 배포 

data/lib/bootpay/billing.rb

@@ -6,21 +6,32 @@ module Bootpay::Billing
     # Comment by ehowlsla
     # Date: 2021-08-30
     def get_billing_key(order_id: nil, pg: nil, item_name: nil, card_no: nil, card_pw: nil, expire_year: nil, expire_month: nil, identify_number: nil,
-                       user_info: {id: nil, username: nil, email: nil, phone: nil, gender: nil, area: nil, birth: nil},
-                       extra: {subscribeTestPayment: nil, raw_data: nil})
+                       user_info: { # 구매자 정보
+                         id: nil, #  개발사에서 관리하는 회원 고유 id
+                         username: nil, # 구매자 이름
+                         email: nil, # 구매자 email
+                         phone: nil, # 01012341234
+                         gender: nil, # 0:여자, 1:남자
+                         area: nil, # 서울|인천|대구|광주|부산|울산|경기|강원|충청북도|충북|충청남도|충남|전라북도|전북|전라남도|전남|경상북도|경북|경상남도|경남|제주|세종|대전 중 택 1
+                         birth: nil # 생일 901004
+                       },
+                       extra: { # 기타 설정
+                         subscribe_test_payment: nil, # subscribe_test_payment:100원 결제 후 결제가 되면 billing key를 발행, 결제가 실패하면 에러
+                         raw_data: nil # raw_data: PG 오류 코드 및 메세지까지 리턴
+                       })
       request(
         uri: 'request/card_rebill',
         payload:
           {
-            order_id:        order_id,
-            pg:              pg,
-            item_name:       item_name,
-            card_no:         card_no,
-            card_pw:         card_pw,
-            expire_year:     expire_year,
-            expire_month:    expire_month,
-            identify_number: identify_number,
-            user_info:       user_info,
+            order_id:        order_id, # 개발사에서 관리하는 고유 주문 번호
+            pg:              pg, # PG사의 Alias ex) danal, kcp, inicis 등
+            item_name:       item_name, # 상품명
+            card_no:         card_no, # 카드 일련번호
+            card_pw:         card_pw, # 카드 비밀번호 앞 2자리
+            expire_year:     expire_year, # 카드 유효기간 년
+            expire_month:    expire_month, # 카드 유효기간 월
+            identify_number: identify_number, # 주민등록번호 또는 사업자번호
+            user_info:       user_info, # 구매자 정보
             extra:           extra.values.any? {|v|v != nil} ? extra : nil
           }.compact
       )
@@ -40,9 +51,20 @@ module Bootpay::Billing
     # Comment by ehowlsla
     # Date: 2021-08-30
     def subscribe_billing(billing_key: nil, item_name: nil, price: 0, tax_free: 0, order_id: nil, quota: nil, interest: nil,
-                          user_info: {id: nil, username: nil, email: nil, phone: nil, gender: nil, area: nil, birth: nil},
+                          user_info: { # 구매자 정보
+                                       id: nil, #  개발사에서 관리하는 회원 고유 id
+                                       username: nil, # 구매자 이름
+                                       email: nil, # 구매자 email
+                                       phone: nil, # 01012341234
+                                       gender: nil, # 0:여자, 1:남자
+                                       area: nil, # 서울|인천|대구|광주|부산|울산|경기|강원|충청북도|충북|충청남도|충남|전라북도|전북|전라남도|전남|경상북도|경북|경상남도|경남|제주|세종|대전 중 택 1
+                                       birth: nil # 생일 901004
+                          },
                           feedback_url: nil, feedback_content_type: nil,
-                          extra: {subscribeTestPayment: nil, raw_data: nil})
+                          extra: { # 기타 설정
+                                   subscribe_test_payment: nil, # subscribe_test_payment:100원 결제 후 결제가 되면 billing key를 발행, 결제가 실패하면 에러
+                                   raw_data: nil # raw_data: PG 오류 코드 및 메세지까지 리턴
+                          })
       raise 'billing_key 값을 입력해주세요.' if billing_key.blank?
       raise 'item_name 값을 입력해주세요.' if item_name.blank?
       raise 'price 금액을 설정을 해주세요.' if price.blank?
@@ -50,17 +72,17 @@ module Bootpay::Billing
       request(
         uri: 'subscribe/billing',
         payload: {
-          billing_key:    billing_key,
-          item_name:      item_name,
-          price:          price,
-          tax_free:       tax_free,
-          order_id:       order_id,
-          quota:          quota,
-          interest:       interest,
+          billing_key:    billing_key, # 발급받은 빌링키
+          item_name:      item_name, # 결제할 상품명, 결제창에 노출됨
+          price:          price, # 결제할 상품금액
+          tax_free:       tax_free, # 면세 상품일 경우 해당만큼의 금액을 설정
+          order_id:       order_id, # 개발사에서 지정하는 고유주문번호
+          quota:          quota, # 5만원 이상 결제건에 적용하는 할부개월수. 0-일시불, 1은 지정시 에러 발생함, 2-2개월, 3-3개월... 12까지 지정가능
+          interest:       interest, # 웰컴페이먼츠 전용, 무이자여부를 보내는 파라미터가 있다
           user_info:      user_info.values.any? {|v|v != nil} ? user_info : nil,
-          feedback_url:   feedback_url,
-          feedback_content_type: feedback_content_type,
-          extra:          extra.values.any? {|v|v != nil} ? extra : nil
+          feedback_url:   feedback_url, # webhook 통지시 받으실 url 주소 (localhost 사용 불가)
+          feedback_content_type: feedback_content_type.presence || 'urlencoded', # webhook 통지시 받으실 데이터 타입 (json 또는 urlencoded, 기본값 urlencoded)
+          extra:          extra.values.any? {|v|v != nil} ? extra : nil # subscribe_test_payment:100원 결제 후 결제가 되면 billing key를 발행, 결제가 실패하면 에러, raw_data: PG 오류 코드 및 메세지까지 리턴
         }.compact,
       )
     end
@@ -72,7 +94,7 @@ module Bootpay::Billing
                           user_info: {id: nil, username: nil, email: nil, phone: nil, gender: nil, area: nil, birth: nil},
                           feedback_url: nil, feedback_content_type: nil,
                           extra: {subscribeTestPayment: 0, raw_data: 0},
-                          scheduler_type: nil, execute_at: nil)
+                          execute_at: nil)
       raise 'billing_key 값을 입력해주세요.' if billing_key.blank?
       raise 'item_name 값을 입력해주세요.' if item_name.blank?
       raise 'price 금액을 설정을 해주세요.' if price.blank?
@@ -80,19 +102,19 @@ module Bootpay::Billing
       request(
         uri: 'subscribe/billing/reserve',
         payload: {
-          billing_key:    billing_key,
-          item_name:      item_name,
-          price:          price,
-          tax_free:       tax_free,
-          order_id:       order_id,
-          quota:          quota,
-          interest:       interest,
+          billing_key:    billing_key, # 발급받은 빌링키
+          item_name:      item_name, # 결제할 상품명, 결제창에 노출됨
+          price:          price, # 결제할 상품금액
+          tax_free:       tax_free, # 면세 상품일 경우 해당만큼의 금액을 설정
+          order_id:       order_id, # 개발사에서 지정하는 고유주문번호
+          quota:          quota, # 5만원 이상 결제건에 적용하는 할부개월수. 0-일시불, 1은 지정시 에러 발생함, 2-2개월, 3-3개월... 12까지 지정가능
+          interest:       interest, # 웰컴페이먼츠 전용, 무이자여부를 보내는 파라미터가 있다
           user_info:      user_info.values.any? {|v|v != nil} ? user_info : nil,
-          feedback_url:   feedback_url,
-          feedback_content_type: feedback_content_type,
-          extra:          extra.values.any? {|v|v != nil} ? extra : nil,
-          scheduler_type: scheduler_type.presence || 'oneshot',
-          execute_at:     execute_at.presence || (Time.now + 10.seconds).to_i
+          feedback_url:   feedback_url,  # webhook 통지시 받으실 url 주소 (localhost 사용 불가)
+          feedback_content_type: feedback_content_type.presence || 'urlencoded', # webhook 통지시 받으실 데이터 타입 (json 또는 urlencoded, 기본값 urlencoded)
+          extra:          extra.values.any? {|v|v != nil} ? extra : nil, # subscribe_test_payment:100원 결제 후 결제가 되면 billing key를 발행, 결제가 실패하면 에러, raw_data: PG 오류 코드 및 메세지까지 리턴
+          scheduler_type: 'oneshot',
+          execute_at:     execute_at.presence || (Time.now + 10.seconds).to_i # 예약 실행시간, 미지정 시 10초뒤 실행
         }.compact,
         )
     end

data/lib/bootpay/cancel.rb

@@ -6,18 +6,22 @@ module Bootpay::Cancel
     # Comment by Gosomi
     # Date: 2021-05-21
     def cancel_payment(cancel_id: nil, receipt_id:, cancel_price: nil, cancel_tax_free: 0, cancel_username: '시스템', cancel_message: '결제취소',
-                       refund: { bank_account: nil, bank_username: nil, bank_code: nil })
+                       refund: { # (선택사항) 가상계좌 환불요청시, 전제조건으로 PG사와 CMS 특약이 체결되어 있을 경우에만 환불요청 가능, 기본적으로 가상계좌는 결제취소가 안됨
+                         account: nil, #  환불받을 계좌번호 - 675601***1234
+                         accountholder: nil, # 환불받을 계좌주 - 홍길동
+                         bankcode: nil # 은행 코드
+                       })
       request(
         uri: 'cancel',
         payload:
              {
-               cancel_id:       cancel_id.presence || SecureRandom.uuid,
-               receipt_id:      receipt_id,
-               price:           cancel_price,
-               tax_free:        cancel_tax_free,
-               name:            cancel_username,
-               reason:          cancel_message,
-               refund:          refund.values.any? {|v|v != nil} ? refund : nil
+               cancel_id:       cancel_id.presence || SecureRandom.uuid, # (선택사항) 부분취소 요청시 중복 요청을 방지하기 위한 고유값
+               receipt_id:      receipt_id, # 부트페이에서 발급한 영수증 id
+               price:           cancel_price, # (선택사항) 부분취소 요청시 금액을 지정, 미지정시 전액 취소 (부분취소가 가능한 PG사, 결제수단에 한해 적용됨)
+               tax_free:        cancel_tax_free, # 취소할 비과세 금액
+               name:            cancel_username, # 취소 요청자 이름
+               reason:          cancel_message, # 취소 요청 사유
+               refund:          refund.values.any? {|v|v != nil} ? refund : nil # (선택사항) 가상계좌 환불요청시, 전제조건으로 PG사와 CMS 특약이 체결되어 있을 경우에만 환불요청 가능, 기본적으로 가상계좌는 결제취소가 안됨
              }.compact
       )
     end

data/lib/bootpay/easy.rb

@@ -12,12 +12,12 @@ module Bootpay::Easy
       request(
         uri: 'request/user/token',
         payload: {
-          user_id: user_id,
-          email: email,
-          name: name,
-          gender: gender,
-          birth: birth,
-          phone: phone
+          user_id: user_id, # 개발사에서 관리하는 회원 고유 id
+          email: email, # 회원 email
+          name: name, # 회원명
+          gender: gender, # 0:여자, 1:남자
+          birth: birth, # 생일 901004
+          phone: phone # 01012341234
         }.compact
       )
     end

data/lib/bootpay/escrow.rb

@@ -3,7 +3,8 @@ module Bootpay::Escrow
 
   included do
 
-    # bootpay dev api
+
+    # @deprecated, 사용되지 않는 api
     # Comment by Gosomi
     # Date: 2020-06-18
     # @return [Hash]

data/lib/bootpay/link.rb

@@ -6,26 +6,53 @@ module Bootpay::Link
   extend ActiveSupport::Concern
 
   included do
+    # item 모델 설명
+    # {
+    #   item_name: '', # 상품명
+    #   qty: 1, # 수량
+    #   unique: '', # 상품 고유키
+    #   price: 1000, # 상품단가
+    #   cat1: '', # 카테고리 상
+    #   cat2: '', # 카테고리 중
+    #   cat3: '' # 카테고리 하
+    # }
     def request_link(pg: nil, method: nil, methods: nil, price: nil, order_id: nil, params: nil, tax_free: nil, name: nil,
-                     user_info: {id: nil, username: nil, email: nil, phone: nil, gender: nil, area: nil, birth: nil},
-                     items: nil, return_url: nil,
-                     extra: {escrow: nil, expire_month: nil, quota: nil, subscribe_test_payment: nil, disp_cash_result: nil, offer_period: nil, seller_name: nil, theme: nil, custom_background: nil, custom_font_color: nil })
+                     user_info: {
+                       id: nil, # 개발사에서 관리하는 회원 고유 id
+                       username: nil, # 구매자 이름
+                       email: nil, # 구매자 email
+                       phone: nil, # 01012341234
+                       gender: nil, # 0:여자, 1:남자
+                       area: nil, # 서울|인천|대구|광주|부산|울산|경기|강원|충청북도|충북|충청남도|충남|전라북도|전북|전라남도|전남|경상북도|경북|경상남도|경남|제주|세종|대전 중 택 1
+                       birth: nil # 생일 901004
+                     },
+                     items: nil, # item array
+                     extra: {
+                       escrow: nil, # 에스크로 연동 시 true, 기본값 false
+                       quota: nil, #List<int> 형태,  결제금액이 5만원 이상시 할부개월 허용범위를 설정할 수 있음, ex) "0,2,3" 지정시 - [0(일시불), 2개월, 3개월] 허용, 미설정시 PG사별 기본값 적용, 1 지정시 에러가 발생할 수 있음
+                       disp_cash_result: nil, # 현금영수증 노출할지 말지 (가상계좌 이용시)
+                       offer_period: nil, # 통합결제창, PG 정기결제창에서 표시되는 '월 자동결제'에 해당하는 문구를 지정한 값으로 변경, 지원하는 PG사만 적용 가능
+                       theme: nil, # 통합결제창 테마, [ red, purple(기본), custom ] 중 택 1
+                       custom_background: nil, # 통합결제창 배경색,  ex) "#00a086" theme가 custom 일 때 background 색상 지정 가능
+                       custom_font_color: nil # 통합결제창 글자색,  ex) "#ffffff" theme가 custom 일 때 font color 색상 지정 가능
+                     }
+    )
       request(
         uri: 'request/payment',
         payload:
           {
-            pg:               pg,
-            method:           method,
-            methods:          methods,
-            price:            price,
-            order_id:         order_id,
-            params:           params,
-            tax_free:         tax_free,
-            name:             name,
-            user_info:        user_info,
-            items:            items,
-            return_url:       return_url,
-            extra:            extra.values.any? {|v|v != nil} ? extra : nil
+            pg:               pg, # [PG 결제] 사용하고자 하는 PG사의 Alias를 입력. ex) danal, kcp, inicis등, 미 지정시 통합결제창이 오픈
+            method:           method, # card:카드, phone: 휴대폰, bank: 실시간 계좌이체, vbank: 가상계좌, auth: 본인인증, card_rebill: 정기결제, easy: 카카오,페이코,네이버페이 등의 간편결제, 미지정시 통합결제창 오픈
+            methods:          methods, # 통합결제시 사용할 method 배열 형태
+            price:            price, # 결제금액
+            order_id:         order_id, # 개발사에서 관리하는 고유결제번호
+            params:           params, # string 형태로 전달 할 값, 결제 후 똑같이 리턴해드림
+            tax_free:         tax_free, # 비과세 금액
+            name:             name, # 결제할 상품명
+            user_info:        user_info, # 구매자 정보
+            items:            items, #  상품정보
+            # return_url:       return_url, # 결제후 이동할 페이지 url, 아직 사용하지 않음
+            extra:            extra.values.any? {|v|v != nil} ? extra : nil # 기타 옵션
           }.compact
       )
     end

data/lib/bootpay/payment_resource.rb

@@ -1,4 +1,3 @@
-
 # bootpay dev api
 # Comment by Gosomi
 # Date: 2020-06-18
@@ -9,9 +8,23 @@ module Bootpay::PaymentResource
   included do
     def update_pg_resource(data)
       request(
-        uri: 'project/payment',
+        uri:     'project/payment',
         payload: data
       )
     end
+
+    #----------------------------------------------------------
+    # 새로운 웹훅을 실행한다
+    # Comment by Gosomi
+    # Date: 2021-12-21
+    #----------------------------------------------------------
+    def create_webhook(receipt_id)
+      request(
+        uri:     'webhook',
+        payload: {
+          receipt_id: receipt_id
+        }
+      )
+    end
   end
 end

data/lib/bootpay/version.rb

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
 module Bootpay
-  VERSION = "1.0.3"
+  VERSION  = "1.0.7"
   BANKCODE = {
-    "한국은행" => "001",
-    "기업은행" => "003",
-    "국민은행" => "004",
-    "외환은행" => "005",
-    "수협은행" => "007",
-    "농협은행" => "011",
-    "우리은행" => "020",
-    "SC은행" => "023",
-    "대구은행" => "031",
-    "부산은행" => "032",
-    "광주은행" => "034",
-    "경남은행" => "039",
-    "우체국" => "071",
+    "한국은행"    => "001",
+    "기업은행"    => "003",
+    "국민은행"    => "004",
+    "외환은행"    => "005",
+    "수협은행"    => "007",
+    "농협은행"    => "011",
+    "우리은행"    => "020",
+    "SC은행"    => "023",
+    "대구은행"    => "031",
+    "부산은행"    => "032",
+    "광주은행"    => "034",
+    "경남은행"    => "039",
+    "우체국"     => "071",
     "KEB하나은행" => "081",
-    "신한은행" => "088",
-    "케이뱅크" => "089",
-    "카카오뱅크" => "090",
+    "신한은행"    => "088",
+    "케이뱅크"    => "089",
+    "카카오뱅크"   => "090",
   }
 end
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootpay
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.7
 platform: ruby
 authors:
 - bootpay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,9 +56,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- bootpay-1.0.0.gem
-- bootpay-1.0.1.gem
-- bootpay-1.0.2.gem
 - bootpay.gemspec
 - lib/.DS_Store
 - lib/bootpay.rb
@@ -98,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.19
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Bootpay server side plugin for ruby