bootpay-backend-ruby 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 955385f1140fc3523ac4db41237c8d72bdfdcfefd4a26289280070cbd73f75f0
+  data.tar.gz: b509c9c00b861c904e7b5ba3bf779213d1f73c2b6e67ec0b3985e20c0395087e
+SHA512:
+  metadata.gz: 84cd62e3488892623d4a8151f05b4ae82bdf252ae1e52c2d1c9c1595f99bdc5dc77bb604908e67d2809af1d6dee123ef2f0f9eff5f8a00e456c7138ddeed788a
+  data.tar.gz: 0622ca14d4ca976d7815a777c79868b81791b7ac06a9927bfb0a1639587cae579edc0a19fa87ed3bd0b02ec83081b64005666f5b7032c638dfa2595401d483a0

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.idea
+*.iml
+Gemfile.lock
+/spec/bootpay/request_rest_billing_key_spec.rb
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+### 2.0.0 
+- v1 -> v2 update 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at gosomi@udid.co.kr. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bootpay-rest-client.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 gosomi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,319 @@
+# Bootpay Ruby Server Side Library
+
+부트페이 공식 Ruby 라이브러리 입니다 (서버사이드 용)
+
+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-3. 발급된 빌링키로 결제 예약 요청
+   4-4. 발급된 빌링키로 결제 예약 - 취소 요청
+   4-5. 빌링키 삭제
+   4-6. 해당 결제건의 빌링키 조회 (빌링)
+5. (생체인증, 비밀번호 결제를 위한) 구매자 토큰 발급
+6. 서버 승인 요청
+7. 본인 인증 결과 조회
+
+## Gem으로 설치하기
+
+
+```ruby
+gem 'bootpay-backend-ruby'
+```
+
+Gemfile에 위 라인을 추가하고, 아래 라인으로 인스톨 합니다.
+```ruby
+$ bundle install
+```
+
+
+또는 아래 문장을 통해 바로 설치할 수 있습니다:
+```ruby
+$ gem install bootpay-backend-ruby
+```
+
+## 사용하기
+
+```ruby
+
+require 'bootpay-backend-ruby'
+
+@api = Bootpay::RestClient.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/2-x-development/spec/bootpay)을 참조하세요.
+
+
+## 1. (부트페이 통신을 위한) 토큰 발급
+
+부트페이와 서버간 통신을 하기 위해서는 부트페이 서버로부터 토큰을 발급받아야 합니다.  
+발급된 토큰은 30분간 유효하며, 최초 발급일로부터 30분이 지날 경우 토큰 발급 함수를 재호출 해주셔야 합니다.
+```ruby 
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+)
+    
+api.request_access_token.success?
+```
+
+
+## 2. 결제 단건 조회
+   결제창 및 정기결제에서 승인/취소된 결제건에 대하여 올바른 결제건인지 서버간 통신으로 결제검증을 합니다.
+```ruby  
+api = Bootpay::RestClient.new(
+      application_id: '59bfc738e13f337dbd6ca48a',
+      private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+)
+
+if api.request_access_token.success?
+   response = api.receipt_payment(
+     "62a818cf1fc19203154a8f2e"
+   )
+   puts response.data.to_json
+end
+```
+
+
+## 3. 결제 취소 (전액 취소 / 부분 취소)
+price를 지정하지 않으면 전액취소 됩니다.
+* 휴대폰 결제의 경우 이월될 경우 이통사 정책상 취소되지 않습니다
+* 정산받으실 금액보다 취소금액이 클 경우 PG사 정책상 취소되지 않을 수 있습니다. 이때 PG사에 문의하시면 되겠습니다.
+* 가상계좌의 경우 CMS 특약이 되어있지 않으면 취소되지 않습니다. 그러므로 결제 테스트시에는 가상계좌로 테스트 하지 않길 추천합니다.
+
+부분취는 카드로 결제된 건만 가능하며, 일부 PG사만 지원합니다. 요청시 price에 금액을 지정하시면 되겠습니다.
+* (지원가능 PG사: 이니시스, kcp, 다날, 페이레터, 나이스페이, 카카오페이, 페이코)
+
+간혹 개발사에서 실수로 여러번 부분취소를 보내서 여러번 취소되는 경우가 있기때문에, 부트페이에서는 부분취소 중복 요청을 막기 위해 cancel_id 라는 필드를 추가했습니다. cancel_id를 지정하시면, 해당 건에 대해 중복 요청방지가 가능합니다.
+```ruby 
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+)
+if api.request_access_token.success?
+  response = api.cancel_payment(
+    receipt_id:      "624a56111fc19202e4746df2",
+    cancel_price:    1000,
+    cancel_username: 'test_user',
+    cancel_message:  'test_message',
+  )
+  puts response.data.to_json
+end
+```
+
+## 4-1. 빌링키 발급
+REST API 방식으로 고객으로부터 카드 정보를 전달하여, PG사에게 빌링키를 발급받을 수 있습니다.
+발급받은 빌링키를 저장하고 있다가, 원하는 시점, 원하는 금액에 결제 승인 요청하여 좀 더 자유로운 결제시나리오에 적용이 가능합니다.
+* 비인증 정기결제(REST API) 방식을 지원하는 PG사만 사용 가능합니다.
+```ruby 
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+)
+
+if api.request_access_token.success?
+ response = @api.request_subscribe_billing_key(
+   subscription_id:         '1234',
+   pg:               'nicepay',
+   order_name:        '테스트 결제',
+   card_no:          '', # 값 할당 필요, 카드번호 
+   card_pw:          '', # 값 할당 필요, 카드 비밀번호 2자리 
+   card_expire_year:      '', # 값 할당 필요, 카드 유효기간 연도 2자리 
+   card_expire_month:     '', # 값 할당 필요, 카드 유효기간 월 2자리 
+   card_identity_no:  '' # 값 할당 필요, 카드 소유주 생년월일 
+ )
+ puts response.data.to_json
+end
+ 
+```
+
+## 4-2. 발급된 빌링키로 결제 승인 요청
+발급된 빌링키로 원하는 시점에 원하는 금액으로 결제 승인 요청을 할 수 있습니다. 잔액이 부족하거나 도난 카드 등의 특별한 건이 아니면 PG사에서 결제를 바로 승인합니다.
+
+```ruby  
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+)
+if api.request_access_token.success?
+  response = api.request_subscribe_card_payment(
+    billing_key: '6295cd1d1fc19202e4e319b0',
+    order_name:   '테스트결제',
+    price:       1000,
+    card_quota:  '00',
+    order_id:    Time.current.to_i,
+    user: {
+      phone: '01000000000',
+      username: '홍길동',
+      email: 'test@bootpay.co.kr'
+    }
+  )
+  puts response.data.to_json
+end
+```
+## 4-3. 발급된 빌링키로 결제 예약 요청
+원하는 시점에 4-1로 결제 승인 요청을 보내도 되지만, 빌링키 발급 이후에 바로 결제 예약 할 수 있습니다. (빌링키당 최대 5건)
+```ruby  
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+) 
+if api.request_access_token.success?
+  response = api.subscribe_payment_reserve( 
+    billing_key:        '628c0d0d1fc19202e5ef2866',
+    order_name:         '테스트결제',
+    price:              1000,
+    order_id:           Time.current.to_i,
+    user:               {
+      phone:    '01000000000',
+      username: '홍길동',
+      email:    'test@bootpay.co.kr'
+    },
+    reserve_execute_at: (Time.current + 30.seconds).iso8601
+  )
+  print response.data.to_json
+end
+```
+##  4-4. 발급된 빌링키로 결제 예약 - 취소 요청
+빌링키로 예약된 결제건을 취소합니다.
+```ruby  
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+)
+if api.request_access_token.success?
+  response = api.subscribe_payment_reserve(
+    billing_key:        '623028630e019e036fe98478',
+    order_name:         '테스트결제',
+    price:              1000,
+    order_id:           Time.current.to_i,
+    user:               {
+      phone:    '01000000000',
+      username: '홍길동',
+      email:    'test@bootpay.co.kr'
+    },
+    reserve_execute_at: (Time.current + 5.seconds).iso8601
+  )
+  puts response.data.to_json
+  if response.success?
+    puts "cancel reserve_id: #{response.data[:reserve_id]}"
+    cancel = api.cancel_subscribe_reserve(response.data[:reserve_id])
+    puts cancel.data.to_json
+  end
+end
+```
+## 4-5. 빌링키 삭제
+발급된 빌링키로 더 이상 사용되지 않도록, 삭제 요청합니다.
+```ruby 
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+)
+if api.request_access_token.success?
+  response = api.destroy_billing_key(
+    '6257bafb1fc19202e47471f7:'
+  )
+  print response.data.to_json
+end
+```
+
+## 4-6. 해당 결제건의 빌링키 조회 (빌링)
+```java 
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+)
+if api.request_access_token.success?
+  response = api.lookup_subscribe_billing_key(
+    "624e4f7c1fc19202e4746f91"
+  )
+  print response.data.to_json
+end
+```
+
+## 5. (생체인증, 비밀번호 결제를 위한) 구매자 토큰 발급
+(부트페이 단독) 부트페이에서 제공하는 간편결제창, 생체인증 기반의 결제 사용을 위해서는 개발사에서 회원 고유번호를 관리해야하며, 해당 회원에 대한 사용자 토큰을 발급합니다.
+이 토큰값을 기반으로 클라이언트에서 결제요청 하시면 되겠습니다.
+```ruby  
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0=' 
+ )
+if api.request_access_token.success?
+  response = api.request_user_token(
+    user_id: 'gosomi1',
+    phone: '01012345678'
+  )
+  print response.data.to_json
+end
+``` 
+
+## 6. 서버 승인 요청
+결제승인 방식은 클라이언트 승인 방식과, 서버 승인 방식으로 총 2가지가 있습니다.
+
+클라이언트 승인 방식은 javascript나 native 등에서 confirm 함수에서 진행하는 일반적인 방법입니다만, 경우에 따라 서버 승인 방식이 필요할 수 있습니다.
+
+필요한 이유
+1. 100% 안정적인 결제 후 고객 안내를 위해 - 클라이언트에서 PG결제 진행 후 승인 완료될 때 onDone이 수행되지 않아 (인터넷 환경 등), 결제 이후 고객에게 안내하지 못할 수 있습니다
+2. 단일 트랜잭션의 개념이 필요할 경우 - 재고파악이 중요한 커머스를 운영할 경우 트랜잭션 개념이 필요할 수 있겠으며, 이를 위해서는 서버 승인을 사용해야 합니다.
+
+```ruby  
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+)
+if api.request_access_token.success?
+  response = api.confirm_payment(
+    "61d3d41b1fc19202e483320b"
+  )
+  print response.data.to_json
+end
+```
+
+## 7. 본인 인증 결과 조회
+다날 본인인증 후 결과값을 조회합니다.
+다날 본인인증에서 통신사, 외국인여부, 전화번호 이 3가지 정보는 다날에 추가로 요청하셔야 받으실 수 있습니다.
+```ruby 
+api = Bootpay::RestClient.new(
+   application_id: '59bfc738e13f337dbd6ca48a',
+   private_key:    'pDc0NwlkEX3aSaHTp/PPL/i8vn5E/CqRChgyEp/gHD0='
+)
+if api.request_access_token.success?
+  response = api.certificate(
+    "624d2e531fc19202e4746f40"
+  )
+  print response.data.to_json
+end
+```
+
+## Example 프로젝트
+
+[적용한 샘플 프로젝트](https://github.com/bootpay/backend-ruby-example)을 참조해주세요
+
+## Documentation
+
+[부트페이 개발매뉴얼](https://docs.bootpay.co.kr/next/)을 참조해주세요
+
+## 기술문의
+
+[부트페이 홈페이지](https://www.bootpay.co.kr) 우측 하단 채팅을 통해 기술문의 주세요!
+
+## License
+
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bootpay/rest/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bootpay-backend-ruby.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/bootpay/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "bootpay-backend-ruby"
+  spec.version = Bootpay::V2_VERSION
+  spec.authors = ["gosomi"]
+  spec.email   = ["gosomi@bootpay.co.kr"]
+
+  spec.summary     = "Bootpay Ruby REST Client"
+  spec.description = "Bootpay REST API / Search One Receipt or Cancel Payment, Subscription Payment on REST API."
+  spec.license     = "MIT"
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activesupport"
+  spec.add_dependency "http"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/bootpay/concern/authenticate.rb

@@ -0,0 +1,15 @@
+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
+  end
+end

data/lib/bootpay/concern/cash_receipt.rb

@@ -0,0 +1,45 @@
+module Bootpay::Concern::CashReceipt
+  extend ActiveSupport::Concern
+
+  included do
+    # 현금 영수증 발행 처리 하기
+    # Comment by Gosomi
+    # Date: 2021-12-15
+    def request_cash_receipt(pg:, 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
+  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,24 @@
+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: {})
+      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
+        }
+      )
+    end
+  end
+end

data/lib/bootpay/concern/payment.rb

@@ -0,0 +1,48 @@
+module Bootpay::Concern::Payment
+  extend ActiveSupport::Concern
+
+  included do
+    # 결제 정보 가져오기
+    # Comment by Gosomi
+    # Date: 2021-12-08
+    def receipt_payment(receipt_id)
+      request(
+        method: :get,
+        uri:    "receipt/#{receipt_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: '결제취소',
+                       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,
+               refund:          refund,
+               items:           items
+             }.compact
+      )
+    end
+  end
+end

data/lib/bootpay/concern/reseller.rb

@@ -0,0 +1,59 @@
+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)
+      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
+        }
+      )
+    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,34 @@
+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: {})
+      response = HTTP.headers(
+        {
+          Authorization: "Bearer #{@token}",
+          content_type:  'application/json',
+          accept:        'application/json'
+        }.merge!(headers).compact
+      ).send(
+        method.to_sym,
+        [Bootpay::RestClient::API[@mode.to_sym], uri].join('/'),
+        json: payload
+      )
+      Bootpay::Response.new(
+        response.status.success?,
+        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
+  end
+end

data/lib/bootpay/concern/sdk.rb

@@ -0,0 +1,36 @@
+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
+  end
+end

data/lib/bootpay/concern/subscription.rb

@@ -0,0 +1,115 @@
+module Bootpay::Concern::Subscription
+  extend ActiveSupport::Concern
+
+  included do
+    # 헤당 결제건의 빌링키 가져오기
+    # Comment by Gosomi
+    # Date: 2021-11-01
+    def lookup_subscribe_billing_key(receipt_id)
+      request(
+        method: :get,
+        uri:    "subscribe/billing_key/#{receipt_id}"
+      )
+    end
+
+    # 빌링키로 결제 요청하기
+    # Comment by Gosomi
+    # Date: 2021-11-02
+    def request_subscribe_card_payment(billing_key:, order_name:, price:, tax_free: 0, card_quota: '00',
+                                       card_interest: nil, order_id:, items: [], user: {}, extra: {})
+      request(
+        uri:     'subscribe/payment',
+        payload: {
+          billing_key:   billing_key,
+          order_name:    order_name,
+          price:         price,
+          tax_free:      tax_free,
+          card_quota:    card_quota,
+          card_interest: card_interest,
+          order_id:      order_id,
+          items:         items,
+          user:          user,
+          extra:         extra
+        }
+      )
+    end
+
+    # 자동결제 예약
+    # Comment by Gosomi
+    # Date: 2022-04-21
+    def subscribe_payment_reserve(billing_key:, reserve_execute_at:, order_name:, price:, tax_free: 0, items: nil, order_id:,
+                                  metadata: {}, user: nil, feedback_url: nil, content_type: nil)
+      request(
+        uri:     'subscribe/payment/reserve',
+        payload: {
+          billing_key:        billing_key,
+          reserve_execute_at: reserve_execute_at,
+          order_name:         order_name,
+          order_id:           order_id,
+          metadata:           metadata,
+          price:              price,
+          tax_free:           tax_free,
+          items:              items,
+          user:               user,
+          feedback_url:       feedback_url,
+          content_type:       content_type
+        }
+      )
+    end
+
+    # 자동결제 예약 취소
+    # Comment by Gosomi
+    # Date: 2022-04-21
+    def cancel_subscribe_reserve(reserve_id)
+      request(
+        method: :delete,
+        uri:    "subscribe/payment/reserve/#{reserve_id}"
+      )
+    end
+
+    # 빌링키를 강제로 만료한다
+    # Comment by Gosomi
+    # Date: 2021-11-04
+    def destroy_billing_key(billing_key)
+      request(
+        method: :delete,
+        uri:    "subscribe/billing_key/#{billing_key}"
+      )
+    end
+
+    # 빌링키 발급받기
+    # Comment by Gosomi
+    # Date: 2021-11-04
+    def request_subscribe_billing_key(pg:, order_name:, price: nil, tax_free: nil, subscription_id:, card_no:, card_pw:,
+                                      card_identity_no:, card_expire_year:, card_expire_month:, extra: {}, user: {}, metadata: {})
+      request(
+        uri:     'request/subscribe',
+        payload: {
+          pg:                pg,
+          order_name:        order_name,
+          subscription_id:   subscription_id,
+          price:             price,
+          tax_free:          tax_free,
+          card_no:           card_no,
+          card_pw:           card_pw,
+          card_identity_no:  card_identity_no,
+          card_expire_year:  card_expire_year,
+          card_expire_month: card_expire_month,
+          extra:             extra,
+          user:              user,
+          metadata:          metadata
+        }
+      )
+    end
+
+    # 정기결제를 계속해서 진행한다
+    # Comment by Gosomi
+    # Date: 2022-01-18
+    def request_subscribe_on_continue(receipt_id)
+      request(
+        method: :put,
+        uri:    "request/subscribe/#{receipt_id}"
+      )
+    end
+  end
+end

data/lib/bootpay/concern/token.rb

@@ -0,0 +1,20 @@
+module Bootpay::Concern::Token
+  extend ActiveSupport::Concern
+
+  included do
+    # Access Token을 요청한다
+    # Comment by Gosomi
+    # Date: 2021-05-21
+    def request_access_token
+      response = request(
+        uri:     'request/token',
+        payload: {
+          application_id: @application_id,
+          private_key:    @private_key
+        }
+      )
+      @token   = response.data[:access_token] if response.success?
+      response
+    end
+  end
+end

data/lib/bootpay/concern/user_token.rb

@@ -0,0 +1,23 @@
+module Bootpay::Concern::UserToken
+  extend ActiveSupport::Concern
+
+  included do
+    # User Token 정보를 가져온다
+    # Comment by Gosomi
+    # Date: 2022-02-03
+    def request_user_token(user_id:, email: nil, username: nil, gender: -1, birth: nil, phone: nil)
+      request(
+        method:  :post,
+        uri:     'request/user/token',
+        payload: {
+          user_id:  user_id,
+          email:    email,
+          username: username,
+          gender:   gender,
+          birth:    birth,
+          phone:    phone
+        }
+      )
+    end
+  end
+end

data/lib/bootpay/concern/webhook.rb

@@ -0,0 +1,18 @@
+module Bootpay::Concern::Webhook
+  extend ActiveSupport::Concern
+
+  included do
+    # Access Token을 요청한다
+    # Comment by Gosomi
+    # Date: 2021-05-21
+    def request_webhook(receipt_id:, webhook_url:)
+      request(
+        uri:     'request/webhook',
+        payload: {
+          receipt_id:  receipt_id,
+          webhook_url: webhook_url
+        }
+      )
+    end
+  end
+end

data/lib/bootpay/concern.rb

@@ -0,0 +1,29 @@
+module Bootpay
+  module Concern
+    require_relative 'concern/authenticate'
+    require_relative 'concern/cash_receipt'
+    require_relative 'concern/easy'
+    require_relative 'concern/escrow'
+    require_relative 'concern/payment'
+    require_relative 'concern/reseller'
+    require_relative 'concern/rest'
+    require_relative 'concern/sdk'
+    require_relative 'concern/subscription'
+    require_relative 'concern/token'
+    require_relative 'concern/user_token'
+    require_relative 'concern/webhook'
+
+    include Authenticate
+    include CashReceipt
+    include Easy
+    include Escrow
+    include Payment
+    include Reseller
+    include Rest
+    include Sdk
+    include Subscription
+    include Token
+    include UserToken
+    include Webhook
+  end
+end

data/lib/bootpay/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Bootpay
+  V2_VERSION = "2.0.0"
+end

data/lib/bootpay-backend-ruby.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+require 'http'
+require_relative 'response'
+require_relative 'bootpay/version'
+require_relative 'bootpay/concern'
+
+module Bootpay
+  class RestClient
+    include Concern
+
+    API =
+      {
+        development: 'https://dev-api.bootpay.co.kr/v2',
+        stage:       'https://stage-api.bootpay.co.kr/v2',
+        production:  'https://api.bootpay.co.kr/v2'
+      }.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/response.rb

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: bootpay-backend-ruby
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- gosomi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bootpay REST API / Search One Receipt or Cancel Payment, Subscription
+  Payment on REST API.
+email:
+- gosomi@bootpay.co.kr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bootpay-backend-ruby.gemspec
+- lib/bootpay-backend-ruby.rb
+- lib/bootpay/concern.rb
+- lib/bootpay/concern/authenticate.rb
+- lib/bootpay/concern/cash_receipt.rb
+- lib/bootpay/concern/easy.rb
+- lib/bootpay/concern/escrow.rb
+- lib/bootpay/concern/payment.rb
+- lib/bootpay/concern/reseller.rb
+- lib/bootpay/concern/rest.rb
+- lib/bootpay/concern/sdk.rb
+- lib/bootpay/concern/subscription.rb
+- lib/bootpay/concern/token.rb
+- lib/bootpay/concern/user_token.rb
+- lib/bootpay/concern/webhook.rb
+- lib/bootpay/version.rb
+- lib/response.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Bootpay Ruby REST Client
+test_files: []