tinkoff_client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4344b69212c472b9ce90383cd75a2b8014e6e0e1205e15d4202e738c05a61ebf
-  data.tar.gz: b2852d7c5005bf777b558acc7557f78786d775dc595d75def9fbd1453bae9e0e
+  metadata.gz: 8990bbf320ba8d5f805720fcf02f28e09c1df07a6c412be63bab21cfcc50917e
+  data.tar.gz: c1d6ee75bfb21c213623f835f9868c59f75ae7860234875c9dfc4fac80260b9b
 SHA512:
-  metadata.gz: 044f02dfb943017a8df46b1c343c865abf63b64edcf8a478811006acae4d92128003cb452b297765148de0c15bd93ba8cd49222ae0804349e0bcca8aae7aa3f6
-  data.tar.gz: 2b76a58b33b1ddf382d0c73b70999642775ca3349fbce0adf7d8295931c0d6004a4f040a8f9de0d4ff2608a965abe3549b4eaf15eeed72fc2430fedb4116d035
+  metadata.gz: dac0bb925a463fa4d2ebc180048d4ba899c4aa7940abfb32a7d6193147f27763a4e4a60b0c4ae37f14b9d17bf045647da6999642636f6fa95610f7de4ec91761
+  data.tar.gz: 451995438000e3e794806b7a1d88413843c6244155856194e40b4ae9fcf432d2e7f6755cb5d31ffa3f9f558348a779f5574f6d08956582bd7c1d880a9d729f71

data/lib/tinkoff_client/payment/encrypt_card_data.rb

@@ -6,10 +6,23 @@ require "base64"
 module TinkoffClient
   module Payment
     module EncryptCardData
+
+      # Метод реализует шифрование данных карты
+      #
+      # Используется в методе FinishAuthorize https://www.tinkoff.ru/kassa/develop/api/payments/finishAuthorize-request/
+      #
+      # Объект CardData собирается в виде списка «ключ=значение» (разделитель «;»), зашифровывается открытым ключом (X509 RSA 2048), получившееся бинарное значение кодируется в Base64. Открытый ключ генерируется Банком и выдается при регистрации терминала. 
+      #
+      # Все поля обязательны.
+      # @param [Number] PAN
+      # @param [Number] ExpDate
+      # @param [String] CardHolder
+      # @param [String] CVV
+      # @see finish_authorize
       def encrypt_data(keys)
         card = keys[:Card]
         concatenated = card.map { |k, v| [k, v].join("=") }.join(";")
-        public_key = OpenSSL::PKey::RSA.new TinkoffClient.configuration.payment_public_key
+        public_key = OpenSSL::PKey::RSA.new File.read(TinkoffClient.configuration.payment_public_key)
         card_data = Base64.encode64(public_key.public_encrypt(concatenated))
       end
     end

data/lib/tinkoff_client/payment/payment.rb

@@ -7,30 +7,331 @@ module TinkoffClient
   module Payment
     extend EncryptCardData
 
-    def self.init(keys)
+    # Метод создает платеж: продавец получает ссылку на платежную форму и должен перенаправить по ней покупателя
+    #
+    # Полный список параметров https://www.tinkoff.ru/kassa/develop/api/payments/init-request/
+    #
+    # @param [Number] Amount
+    # @param [String] OrderId
+    # @return [Hash]
+    #   *
+    #       {"Success"=>true,
+    #       "ErrorCode"=>"0",
+    #       "TerminalKey"=>"1111111111",
+    #       "Status"=>"NEW",
+    #       "PaymentId"=>"123456789",
+    #       "OrderId"=>"3331",
+    #       "Amount"=>1000,
+    #       "PaymentURL"=>"https://securepayments.tinkoff.ru/q2wER3t0"}
+    # @example
+    #  #Предположим, что у нас есть User, Product и Order
+    #
+    #  #User
+    #  {"id"=>1,
+    #  "email"=>"a@test.ru",
+    #  "phone"=>"+79031234567"}
+    #
+    #  #Product
+    #  {"id"=>22,
+    #  "name"=>"Наименование товара",
+    #  "price"=>1000,
+    #  "quantity"=>10}
+    #
+    #  #Order
+    #  {"id"=>5,
+    #  "user_id"=>1,
+    #  "product_id"=>22,
+    #  "paid"=>false,
+    #  "payment_id"=>nil}
+    #
+    #  #Простая реализация логики получения платежной ссылки
+    #  def create
+    #    order = order.find(params[:order_id]) #Объявляем наш order
+    #    product = order.product #Объявляем продукт
+    #    result = TinkoffClient::Payment.init(Amount: product.amount, OrderId: order.id) #Вызываем наш init метод
+    #    if result["Success"] #в случае, если Success (boolean) вернет true
+    #      order.update(:order_params)
+    #      redirect_to result["PaymentURL"] #Отправляем пользователя по ссылке на форму оплаты
+    #    end
+    #  end
+    # 
+    #  private
+    #  def order_params
+    #   params.transform_keys(&:underscore).permit(:payment_id)#Трансформируем ответ из Snake в Camel и пермитим его
+    #  end
+    # @see https://www.tinkoff.ru/kassa/develop/api/payments/init-request/
+    def self.init(keys)      
       Request.request(path: "Init", keys: keys)
     end
 
+    # Метод подтверждает платеж передачей реквизитов, а также списывает средства с карты покупателя при одностадийной оплате и блокирует указанную сумму при двухстадийной.
+    # Используется, если у площадки есть сертификация PCI DSS и собственная платежная форма.
+    #
+    # Полный список параметров https://www.tinkoff.ru/kassa/develop/api/payments/confirm-request/
+    #
+    # @param [Number] PaymentId
+    # @return [Hash]
+    #   *
+    #       {"Success"=>true,
+    #       "ErrorCode"=>"0",
+    #       "TerminalKey"=>"1111111111",
+    #       "Status"=>"CONFIRMED",
+    #       "PaymentId"=>"123456789",
+    #       "OrderId"=>"3331"}
+    # @example
+    #
+    #  #Order
+    #  {"id"=>5,
+    #  "user_id"=>1,
+    #  "product_id"=>22,
+    #  "paid"=>false,
+    #  "payment_id"=>"123456789"} #Payment id получен в методе init
+    #
+    #  def create
+    #    order = order.find(params[:order_id]) #Объявляем наш order
+    #    result = TinkoffClient::Payment.confirm(PaymentId: order.payment_id) #Вызываем наш confirm
+    #  end
+    # 
+    # @see https://www.tinkoff.ru/kassa/develop/api/payments/confirm-description/
+    # @see init
     def self.confirm(keys)
       Request.request(path: "Confirm", keys: keys)
     end
 
+
+    # Метод возвращает текущий статус платежа.
+    #
+    # Полный список параметров https://www.tinkoff.ru/kassa/develop/api/payments/getstate-description/
+    #
+    # @param [Number] PaymentId
+    # @return [Hash]
+    #   *
+    #  {
+    #   "Success"=>true,
+    #   "ErrorCode"=>"0",
+    #   "Message"=>"OK",
+    #   "TerminalKey"=>"TinkoffBankTest",
+    #   "Status"=>"CONFIRMED",
+    #   "PaymentId"=>"2304882",
+    #   "OrderId"=>"#419",
+    #   "Amount"=>1000
+    #   }
+    # @example
+    #
+    #  #Order
+    #  {"id"=>5,
+    #  "user_id"=>1,
+    #  "product_id"=>22,
+    #  "paid"=>false,
+    #  "payment_id"=>"123456789"} #Payment id получен в методе init
+    #
+    #  def create
+    #    order = order.find(params[:order_id]) #Объявляем наш order
+    #    result = TinkoffClient::Payment.get_state(PaymentId: order.payment_id) #Вызываем наш get_state
+    #  end
+    # 
+    # @see https://www.tinkoff.ru/kassa/develop/api/payments/getstate-description/
+    # @see init
     def self.get_state(keys)
       Request.request(path: "GetState", keys: keys)
     end
 
+    # Метод отменяет платеж.
+    #
+    # Полный список параметров https://www.tinkoff.ru/kassa/develop/api/payments/cancel-description/
+    #
+    # @param [Number] PaymentId
+    # @return [Hash]
+    #   *
+    #  {
+    #   "Success"=>true,
+    #   "ErrorCode"=>"0",
+    #   "Message"=>"OK",
+    #   "TerminalKey"=>"TinkoffBankTest",
+    #   "Status"=>"REFUNDED",
+    #   "PaymentId"=>"2304882",
+    #   "OrderId"=>"#419",
+    #   "Amount"=>1000
+    #   }
+    # @example
+    #
+    #  #Order
+    #  {"id"=>5,
+    #  "user_id"=>1,
+    #  "product_id"=>22,
+    #  "paid"=>false,
+    #  "payment_id"=>"123456789"} #Payment id получен в методе init
+    #
+    #  def create
+    #    order = order.find(params[:order_id]) #Объявляем наш order
+    #    result = TinkoffClient::Payment.cancel(PaymentId: order.payment_id) #Вызываем наш cancel
+    #  end
+    # 
+    # @see https://www.tinkoff.ru/kassa/develop/api/payments/cancel-description/
+    # @see init
     def self.cancel(keys)
       Request.request(path: "Cancel", keys: keys)
     end
 
+    # Метод возвращает статус заказа.
+    #
+    # Полный список параметров https://www.tinkoff.ru/kassa/develop/api/payments/checkorder-description/
+    #
+    # @param [Number] OrderId
+    # @return [Hash]
+    #   *
+    #  {
+    #   "Success": true,
+    #   "ErrorCode": "0",
+    #   "Message": "OK",
+    #   "OrderId": "21057",
+    #   "TerminalKey": "TinkoffBankTest",
+    #   "Payments": [
+    #    {
+    #        "Status": "REJECTED",
+    #        "PaymentId": 10063,
+    #        "Rrn": 1234567,
+    #        "Amount": 555,
+    #        "Success": false,
+    #        "ErrorCode": "1051",
+    #        "Message": "Недостаточно средств на карте"
+    #    },
+    #    {
+    #        "Status": "AUTH_FAIL",
+    #        "PaymentId": 1005563,
+    #        "Rrn": 1234567,
+    #        "Amount": 555,
+    #        "Success": false,
+    #        "ErrorCode": "76",
+    #        "Message": "Операция по иностранной карте недоступна."
+    #    },
+    #    {
+    #        "Status": "NEW",
+    #        "PaymentId": 100553363,
+    #        "Rrn": 1234567,
+    #        "Amount": 555,
+    #        "Success": true,
+    #        "ErrorCode": "0",
+    #        "Message": "ok"
+    #    }
+    #   ]
+    #  }
+    # @example
+    #
+    #  #Order
+    #  {"id"=>5,
+    #  "user_id"=>1,
+    #  "product_id"=>22,
+    #  "paid"=>false,
+    #  "payment_id"=>"123456789"}
+    #
+    #  def create
+    #    order = order.find(params[:order_id]) #Объявляем наш order
+    #    result = TinkoffClient::Payment.check_order(OrderId: order.id) #Вызываем наш check_order
+    #  end
+    # 
+    # @see https://www.tinkoff.ru/kassa/develop/api/payments/checkorder-description/
+    # @see init
     def self.check_order(keys)
       Request.request(path: "CheckOrder", keys: keys)
     end
 
+    # Метод позволяет отправить закрывающий чек в кассу.
+    # Условия работы метода:
+    # Закрывающий чек может быть отправлен если платежная сессия по первому чеку находится в статусе CONFIRMED.
+    # В платежной сессии был передан объект Receipt.
+    # В объекте Receipt был передан хотя бы один объект Receipt.Items.PaymentMethod = "full_prepayment" или "prepayment" или "advance"
+    #
+    # Полный список параметров https://www.tinkoff.ru/kassa/develop/api/payments/SendClosingReceipt-description/
+    #
+    # @param [Number] PaymentId
+    # @param [Hash] Receipt
+    # @param [Hash] Items
+    # @return [Hash]
+    #   *
+    #  {
+    #   "Success"=>true,
+    #   "ErrorCode"=>"0",
+    #   "Message"=>"null",
+    #   }
+    # @example
+    #
+    #  #User
+    #  {"id"=>1,
+    #  "email"=>"a@test.ru",
+    #  "phone"=>"+79031234567"}
+    #
+    #  #Product
+    #  {"id"=>22,
+    #  "name"=>"Наименование товара",
+    #  "price"=>1000,
+    #  "quantity"=>10}
+    #
+    #  #Order
+    #  {"id"=>5,
+    #  "user_id"=>1,
+    #  "product_id"=>22,
+    #  "paid"=>false,
+    #  "payment_id"=>"123456789"} #Payment id получен в методе init
+    #
+    #  def create
+    #    order = order.find(params[:order_id]) #Объявляем наш order
+    #    params = { 
+    #      PaymentId: order.payment_id,
+    #      Receipt: { Email: order.user.email, Taxation: "osn",
+    #      Items: [{ Name: order.product.title, Quantity: "1",
+    #      Amount: order.product.price, Price: order.product.price,
+    #      Tax: "vat20", PaymentMethod: "full_payment",
+    #      PaymentObject: "lottery_prize" }] } 
+    #    }
+    #    result = TinkoffClient::Payment.send_closing_receipt(params) #Вызываем наш send_closing_receipt
+    #  end
+    # 
+    # @see https://www.tinkoff.ru/kassa/develop/api/payments/SendClosingReceipt-description/
+    # @see init
     def self.send_closing_receipt(keys)
       Request.request(path: "SendClosingReceipt", keys: keys)
     end
 
+    # Метод подтверждает платеж передачей реквизитов, а также списывает средства с карты покупателя при одностадийной оплате и блокирует указанную сумму при двухстадийной.
+    #
+    # Используется, если у площадки есть сертификация PCI DSS и собственная платежная форма.
+    #
+    # Полный список параметров https://www.tinkoff.ru/kassa/develop/api/payments/finish-authorize/
+    #
+    # @param [Number] PaymentId
+    # @param [Hash] Card
+    # @param [Number] PAN (Card)
+    # @param [Number] ExpDate (Card)
+    # @param [String] CardHolder (Card)
+    # @param [CVV] CardHolder (Card)
+    # @return [Hash]
+    #   *
+    #  {
+    #   "Success"=>true,
+    #   "ErrorCode"=>"0",
+    #   "Message"=>"null",
+    #   }
+    # @example
+    #
+    #  #Order
+    #  {"id"=>5,
+    #  "user_id"=>1,
+    #  "product_id"=>22,
+    #  "paid"=>false,
+    #  "payment_id"=>"123456789"} #Payment id получен в методе init
+    #
+    #  def create
+    #    order = order.find(params[:order_id]) #Объявляем наш order
+    #    params = { 
+    #      PaymentId: order.payment_id,
+    #      Card: { PAN: 5545454545454545, ExpDate: 4545, CardHolder: "IVAN PETROV", CVV: "111"}
+    #    }
+    #    result = TinkoffClient::Payment.finish_authorize(params) #Вызываем наш finish_authorize
+    #  end
+    # 
+    # @see https://www.tinkoff.ru/kassa/develop/api/payments/finish-authorize/
+    # @see encrypt_data
     def self.finish_authorize(keys)
       card_data = encrypt_data(keys)
       keys[:CardData] = card_data

data/lib/tinkoff_client/payout/request.rb

@@ -29,6 +29,7 @@ module TinkoffClient
           X509SerialNumber: data[:x509_serial_number],
           **keys,
         }
+
       end
     end
   end

data/lib/tinkoff_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TinkoffClient
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tinkoff_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - netsky_prod
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec