bootpay 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 022100bd6bd482b36005a017f48fcb688740eeaedf6379f056c0a34174b328b6
-  data.tar.gz: 1aee63779b76d0adaa96b6708ed8bbc6cdb5be379cc9824372901a6dc440abd9
+  metadata.gz: f93c2b7e68e637cf9ef3e6349179b7635bb513a749c1df031cc34385f8df6252
+  data.tar.gz: c71a38014a72b0d4dabc92ddf615d8267302722c79c7d202e42f34d273712f75
 SHA512:
-  metadata.gz: 5f3fdc48ca258c10d22c8d413b2dead5e2b31adb5e4ff03a40819f8325b6c6c84b83c7348379e29162cc1fba2b4a97e6f04253816027b501e7ca1c9392717c5e
-  data.tar.gz: fa9bcf0841dc97fc5106fed67d4c02a747c623421f18d09342d4a9b20f1de53c3d2ad4551f03ad6840f88576fe89b418eebae17a186ddf1c877d1767b3e715b8
+  metadata.gz: 1f8e2ecb7afb21f5d44ff93b7348d0706a3a48dbb797891365f67be3030078351bbb2495a431d72c0cf4597e9b730785607567ef56d04c6347719f3a2cd651a2
+  data.tar.gz: 15ca7fcd004f83855f90155eead0b97251677a0d5bfd58ead94d093e4eb4e1823298762fbffb1dc9e304cad7472f6a7a7e501af4f4afba4d6f0551f1e3182756

data/CHANGELOG.md

@@ -1,5 +1,17 @@
-## [Unreleased]
+## 1.0.4
 
-## [0.1.0] - 2021-08-30
+- cancel에 refund 형식 수정 
 
-- Initial release
+## 1.0.3 
+
+- BankCode 추가
+
+## 1.0.2
+- certificate data type application/json 으로 수정
+
+## 1.0.1
+- namespace 변경  
+
+## 1.0.0
+
+- 첫 배포 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 ehowlsla
+Copyright (c) 2021 bootpay
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,33 @@
-# Bootpay Ruby 플러그인 
 
-Bootpay Ruby 라이브러리는 Ruby 언어로 작성된 어플리케이션, 프레임워크 등에서 사용가능합니다.
+## Bootpay Ruby Server Side Library
+부트페이 공식 Ruby 라이브러리 입니다 (서버사이드 용)
 
-## Installation
+Ruby 언어로 작성된 어플리케이션, 프레임워크 등에서 사용가능합니다.
+
+* PG 결제창 연동은 클라이언트 라이브러리에서 수행됩니다. (Javascript, Android, iOS, React Native, Flutter 등)
+* 결제 검증 및 취소, 빌링키 발급, 본인인증 등의 수행은 서버사이드에서 진행됩니다. (Java, PHP, Python, Ruby, Node.js, Go, ASP.NET 등)
+
+
+## 기능   
+1. (부트페이 통신을 위한) 토큰 발급 요청   
+2. 결제 검증   
+3. 결제 취소 (전액 취소 / 부분 취소)
+4. 빌링키 발급
+   
+    4-1. 발급된 빌링키로 결제 승인 요청
+   
+    4-2. 발급된 빌링키로 결제 승인 예약 요청
+   
+    4-2-1. 발급된 빌링키로 결제 승인 예약 - 취소 요청
+   
+    4-3. 빌링키 삭제
+5. (부트페이 단독) 사용자 토큰 발급   
+6. (부트페이 단독) 결제 링크 생성   
+7. 서버 승인 요청   
+8. 본인 인증 결과 조회
+
+## Gem으로 설치하기 
 
-Gemfile 파일을 이용하여 설치하기  
 
 ```ruby
 gem 'bootpay'
@@ -20,25 +43,229 @@ Gemfile에 위 라인을 추가하고, 아래 라인으로 인스톨 합니다.
 
     $ gem install backend-ruby
 
-## Getting Started
+## 사용하기 
 
 ```ruby
-    # 결제 검증하기 
-    receipt_id = '612df0250d681b001de61de6'
 
-    api = Bootpay::Api.new(
-      application_id: '5b8f6a4d396fa665fdc2b5ea',
-      private_key:    'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=',
+require 'bootpay'
+
+@api = Bootpay::Api.new(
+  application_id: '5b8f6a4d396fa665fdc2b5ea',
+  private_key:    'rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=',
+)
+response = @api.request_access_token
+if response.success?
+  puts  response.data.to_json
+end
+```
+함수 단위의 샘플 코드는 [이곳](https://github.com/bootpay/backend-ruby/tree/main/spec/bootpay)을 참조하세요.
+
+
+## 1. 토큰 발급 
+
+부트페이와 서버간 통신을 하기 위해서는 부트페이 서버로부터 토큰을 발급받아야 합니다.  
+발급된 토큰은 30분간 유효하며, 최초 발급일로부터 30분이 지날 경우 토큰 발급 함수를 재호출 해주셔야 합니다.
+```ruby 
+def get_token
+  response = @api.request_access_token
+  if response.success?
+    puts  response.data.to_json
+  end
+end
+```
+
+
+## 2. 결제 검증 
+결제창 및 정기결제에서 승인/취소된 결제건에 대하여 올바른 결제건인지 서버간 통신으로 결제검증을 합니다.
+```ruby  
+def verification
+  receipt_id = '612df0250d681b001de61de6'
+  if @api.request_access_token.success?
+    response = @api.verify(receipt_id)
+    puts  response.data.to_json
+  end
+end
+```
+
+
+## 3. 결제 취소 (전액 취소 / 부분 취소)
+price를 지정하지 않으면 전액취소 됩니다. 
+* 휴대폰 결제의 경우 이월될 경우 이통사 정책상 취소되지 않습니다
+* 정산받으실 금액보다 취소금액이 클 경우 PG사 정책상 취소되지 않을 수 있습니다. 이때 PG사에 문의하시면 되겠습니다.
+* 가상계좌의 경우 CMS 특약이 되어있지 않으면 취소되지 않습니다. 그러므로 결제 테스트시에는 가상계좌로 테스트 하지 않길 추천합니다. 
+
+부분취는 카드로 결제된 건만 가능하며, 일부 PG사만 지원합니다. 요청시 price에 금액을 지정하시면 되겠습니다. 
+* (지원가능 PG사: 이니시스, kcp, 다날, 페이레터, 나이스페이, 카카오페이, 페이코)
+
+간혹 개발사에서 실수로 여러번 부분취소를 보내서 여러번 취소되는 경우가 있기때문에, 부트페이에서는 부분취소 중복 요청을 막기 위해 cancel_id 라는 필드를 추가했습니다. cancel_id를 지정하시면, 해당 건에 대해 중복 요청방지가 가능합니다.  
+```ruby 
+def cancel
+  if @api.request_access_token.success?
+    response = @api.cancel_payment(
+      receipt_id:      "612df0250d681b001de61de6",
+      cancel_username:        'test',
+      cancel_message:         'test',
+      cancel_price:     1000, # 부분취소 요청시
+      refund: { # 가상계좌 환불 요청시, 단 CMS 특약이 되어있어야만 환불요청이 가능하다.
+        account: '675601010124', # 환불계좌
+        accountholder: '홍길동', # 환불계좌주
+        bankcode: Bootpay::BANKCODE["국민은행"] # 은행코드
+      }
     )
-    if api.request_access_token.success?
-      response = api.verify(receipt_id)
-      print  response.data.to_json
-    end
+    puts  response.data.to_json
+  end
+end
 ```
 
+## 4. 빌링키 발급 
+REST API 방식으로 고객으로부터 카드 정보를 전달하여, PG사에게 빌링키를 발급받을 수 있습니다. 
+발급받은 빌링키를 저장하고 있다가, 원하는 시점, 원하는 금액에 결제 승인 요청하여 좀 더 자유로운 결제시나리오에 적용이 가능합니다.
+* 비인증 정기결제(REST API) 방식을 지원하는 PG사만 사용 가능합니다. 
+```ruby 
+def get_billing_key
+  if @api.request_access_token.success?
+    response = @api.get_billing_key(
+      order_id:         '1234',
+      pg:               'nicepay',
+      item_name:        '테스트 결제',
+      card_no:          '', # 값 할당 필요
+      card_pw:          '', # 값 할당 필요
+      expire_year:      '', # 값 할당 필요
+      expire_month:     '', # 값 할당 필요
+      identify_number:  '' # 값 할당 필요
+    )
+    puts response.data.to_json
+  end
+end
+```
+
+## 4-1. 발급된 빌링키로 결제 승인 요청  
+발급된 빌링키로 원하는 시점에 원하는 금액으로 결제 승인 요청을 할 수 있습니다. 잔액이 부족하거나 도난 카드 등의 특별한 건이 아니면 PG사에서 결제를 바로 승인합니다.
+
+```ruby  
+def subscribe_billing
+  billing_key = '612deb53019943001fb52312'
+  if @api.request_access_token.success?
+    response = @api.subscribe_billing(
+      billing_key:    billing_key,
+      item_name:      '테스트 결제',
+      price:          1000,
+      tax_free:       1000,
+      order_id:       '1234'
+    )
+    puts response.data.to_json
+  end
+end
+```
+## 4-2. 발급된 빌링키로 결제 예약 요청
+원하는 시점에 4-1로 결제 승인 요청을 보내도 되지만, 빌링키 발급 이후에 바로 결제 예약 할 수 있습니다. (빌링키당 최대 5건)
+```ruby  
+def subscribe_reserve_billing
+  billing_key = '612deb53019943001fb52312'
+  if @api.request_access_token.success?
+    response = @api.subscribe_reserve_billing(
+      billing_key:    billing_key,
+      item_name:      '테스트 결제',
+      price:          1000,
+      tax_free:       1000,
+      order_id:       '1234',
+      execute_at: (Time.now + 10.seconds).to_i # 10초 뒤 결제
+    )
+    puts response.data.to_json
+  end
+end
+```
+## 4-2-1. 발급된 빌링키로 결제 예약 - 취소 요청 
+빌링키로 예약된 결제건을 취소합니다. 
+```ruby  
+def subscribe_reserve_cancel
+  reserve_id = '612deb53019943001fb52312'
+  if @api.request_access_token.success?
+    response = @api.subscribe_reserve_cancel(reserve_id)
+    puts response.data.to_json
+  end
+end
+```
+## 4-3. 빌링키 삭제 
+발급된 빌링키로 더 이상 사용되지 않도록, 삭제 요청합니다.
+```java 
+Bootpay bootpay = new Bootpay("5b8f6a4d396fa665fdc2b5ea", "rm6EYECr6aroQVG2ntW0A6LpWnkTgP4uQ3H18sDDUYw=");
+
+try {
+    ResDefault res = bootpay.destroyBillingKey("6100e7ea0d681b001fd4de69");
+    System.out.println(res.toJson());
+} catch (Exception e) {
+    e.printStackTrace();
+}
+```
+## 5. 사용자 토큰 발급 
+(부트페이 단독) 부트페이에서 제공하는 간편결제창, 생체인증 기반의 결제 사용을 위해서는 개발사에서 회원 고유번호를 관리해야하며, 해당 회원에 대한 사용자 토큰을 발급합니다.
+이 토큰값을 기반으로 클라이언트에서 결제요청 하시면 되겠습니다.
+```ruby  
+def destroy_billing_key
+  if @api.request_access_token.success?
+    billing_key = '612debc70d681b0039e6133d'
+    response = @api.destroy_billing_key(billing_key)
+    puts response.data.to_json
+  end
+end
+```
+## 6. 결제 링크 생성 
+(부트페이 단독) 요청 하시면 결제링크가 리턴되며, 해당 url을 고객에게 안내, 결제 유도하여 결제를 진행할 수 있습니다. 
+```ruby  
+def request_link
+  if @api.request_access_token.success?
+    response = @api.request_link(
+      pg:             'nicepay',
+      price:          1000,
+      tax_free:       1000,
+      order_id:       '1234',
+      name:           '결제테스트'
+    )
+    puts response.data.to_json
+  end
+end
+```
+
+## 7. 서버 승인 요청 
+결제승인 방식은 클라이언트 승인 방식과, 서버 승인 방식으로 총 2가지가 있습니다.
+
+클라이언트 승인 방식은 javascript나 native 등에서 confirm 함수에서 진행하는 일반적인 방법입니다만, 경우에 따라 서버 승인 방식이 필요할 수 있습니다.
+
+필요한 이유 
+1. 100% 안정적인 결제 후 고객 안내를 위해 - 클라이언트에서 PG결제 진행 후 승인 완료될 때 onDone이 수행되지 않아 (인터넷 환경 등), 결제 이후 고객에게 안내하지 못할 수 있습니다  
+2. 단일 트랜잭션의 개념이 필요할 경우 - 재고파악이 중요한 커머스를 운영할 경우 트랜잭션 개념이 필요할 수 있겠으며, 이를 위해서는 서버 승인을 사용해야 합니다. 
+
+```ruby  
+def submit
+  receipt_id = '612e09260d681b0021e61ab9'
+  if @api.request_access_token.success?
+    response = @api.server_submit(receipt_id)
+    puts response.data.to_json
+  end
+end
+```
+
+## 8. 본인 인증 결과 조회 
+다날 본인인증 후 결과값을 조회합니다. 
+다날 본인인증에서 통신사, 외국인여부, 전화번호 이 3가지 정보는 다날에 추가로 요청하셔야 받으실 수 있습니다.
+```ruby 
+def certificate
+  receipt_id = '612e09260d681b0021e61ab9'
+  if @api.request_access_token.success?
+    response = @api.certificate(receipt_id)
+    puts response.data.to_json
+  end
+end
+```
+
+## Example 프로젝트
+
+[적용한 샘플 프로젝트](https://github.com/bootpay/backend-ruby-example)을 참조해주세요
+
 ## Documentation
 
-[부트페이 개발매뉴얼](https://app.gitbook.com/@bootpay)을 참조해주세요
+[부트페이 개발매뉴얼](https://bootpay.gitbook.io/docs/)을 참조해주세요
 
 ## 기술문의
 
@@ -46,4 +273,4 @@ Gemfile에 위 라인을 추가하고, 아래 라인으로 인스톨 합니다.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+[MIT License](https://opensource.org/licenses/MIT).

data/lib/bootpay/bootpay.rb

@@ -0,0 +1,49 @@
+require 'active_support/all'
+require 'http'
+require_relative 'response'
+require_relative 'bootpay/billing'
+require_relative 'bootpay/cancel'
+require_relative 'bootpay/easy'
+require_relative 'bootpay/escrow'
+require_relative 'bootpay/link'
+require_relative 'bootpay/naverpay'
+require_relative 'bootpay/payment_resource'
+require_relative 'bootpay/reseller'
+require_relative 'bootpay/rest'
+require_relative 'bootpay/submit'
+require_relative 'bootpay/token'
+require_relative 'bootpay/verification'
+require_relative "bootpay/version"
+
+module Bootpay
+  class Api
+    include Billing
+    include Cancel
+    include Easy
+    include Escrow
+    include Link
+    include Naverpay
+    include PaymentResource
+    include Reseller
+    include Rest
+    include Submit
+    include Token
+    include Verification
+
+    API =
+      {
+        development: 'https://dev-api.bootpay.co.kr/',
+        stage:       'https://stage-api.bootpay.co.kr/',
+        production:  'https://api.bootpay.co.kr/'
+      }.freeze
+
+    def initialize(application_id:, private_key:, mode: 'production')
+    
+      @application_id = application_id
+      @private_key    = private_key
+      @mode           = mode.presence || 'production'
+      @token          = nil
+      raise ArgumentError, "개발환경 mode는 development, stage, production 중에서 선택이 가능합니다." if API[@mode.to_sym].blank?
+    end 
+  end
+end

data/lib/bootpay/cancel.rb

@@ -6,7 +6,7 @@ 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: { account: nil, accountholder: nil, bankcode: nil })
       request(
         uri: 'cancel',
         payload:

data/lib/bootpay/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootpay
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - bootpay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2021-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,11 +56,16 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bootpay-1.0.0.gem
+- bootpay-1.0.1.gem
+- bootpay-1.0.2.gem
+- bootpay-1.0.3.gem
 - bootpay.gemspec
 - lib/.DS_Store
-- lib/api.rb
+- lib/bootpay.rb
 - lib/bootpay/.DS_Store
 - lib/bootpay/billing.rb
+- lib/bootpay/bootpay.rb
 - lib/bootpay/cancel.rb
 - lib/bootpay/easy.rb
 - lib/bootpay/escrow.rb