unitpay 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30615f1d644e3b6abafaccadef5ae3e1ccd9c23e
-  data.tar.gz: e2b1c7945292348d190860ade3265e4419765281
+  metadata.gz: 6b2151fbaa10bcb948b81ed8a60251191f76072a
+  data.tar.gz: 343b94025ae0549e871b8c898c774fc2b44deba8
 SHA512:
-  metadata.gz: 05fef55f7da174ec1cc2b728724598867a90de330503079ae226a6fd7571eb657115129107718d1e49d74711409166fe7519c68491c07ff56657adbc0b2af659
-  data.tar.gz: da7a4f62f1a6d3b4253bc232d053413d62c145a0f3b069fa2ee14dde711c576acc638d6dfbe337d4f2b2c115e6d144f9a5d04fa1437f0e10aac590e7fa9d984a
+  metadata.gz: b7428b3732a1a5758e980ef6d5289545862293127849a06bd1d2263b498db0093bf7ec2ba63899a2258b953c87f3615385bc41d5622a77daed0cfb78d9c56b7f
+  data.tar.gz: a52d8aec1065f3f6ae18deb8a5db4423198959d08c8a5a16a71e9664714d989a6802b01804c98104f974d47d8bd8adac6014315a4b0c1d28714026f4a5ed9b97

data/README.md

@@ -11,10 +11,9 @@ Gem для подключения к платежному шлюзу [unitpay](h
 
 - [Установка](#installation)
 - [Подключение](#setup)
-- [Использование](#usage)
-    - [Получение ссылки для оплаты](#payment_url)
-    - [Модуль для обработки запросов от unitpay (для RubyOnRails)](#rails)
-    - [Подключение виджета для карт оплаты](#widget)
+- [Получение ссылки для оплаты](#payment_url)
+- [Использование в  Rails](#rails)
+- [Подключение виджета для карт оплаты](#widget)
 
 ##<a name="installation"></a> Установка
 
@@ -54,10 +53,7 @@ Unitpay::Service.new('unitpay_public_key', 'unitpay_secret_key', use_sign, curre
 3. Необходимо изменить `example.com` на адрес вашего приложения.
 4. Необходимо изменить `example.com` на адрес вашего приложения.
 
-
-##<a name="usage"></a> Использование
-
-###<a name="payment_url"></a> Получение ссылки для оплаты
+##<a name="payment_url"></a> Получение ссылки для оплаты
 
 Чтобы получить ссылку для оплаты, необходимо использовать метод `payment_url`, в который нужно передать следующие параметры:
 
@@ -74,9 +70,9 @@ service.payment_url(sum, account, desc)
 # => 'https://unitpay.ru/pay/public_key?sum=100&account=1&desc=description...'
 ```
 
-###<a name="rails"></a> Модуль для обработки запросов от unitpay (для RubyOnRails)
+##<a name="rails"></a> Использование в  Rails
 
-Добавьте роуты для **unitpay** (`config/routes.rb`)
+Добавьте роуты для получения запросов от **unitpay** (`config/routes.rb`)
 
 ```ruby
 scope :unitpay do
@@ -91,6 +87,7 @@ end
 ```ruby
 class UnitpayController < ApplicationController
   include Unitpay::Controller
+  skip_before_filter :verify_authenticity_token
  
   def success
     # вызывается при отправке шлюзом пользователя на Success URL.
@@ -104,6 +101,8 @@ class UnitpayController < ApplicationController
     # (во время принятия платежа возникла ошибка)
   end
 
+  private
+
   def pay
     # вызывается при оповещении магазина об
     # успешной оплате пользователем заказа и после проверки сигнатуры.
@@ -115,13 +114,12 @@ class UnitpayController < ApplicationController
   
   def error
     # вызывается при оповещении магазина об ошибке при оплате заказа.
+    # При отсутствии логики обработки ошибок на стороне приложения оставить метод пустым.
     #
     # ВНИМАНИЕ: правильный ответ будет сгенерирован автоматически (не нужно использовать render\redirect_to)!
-    # order = Order.find(params[:params][:account])
-    # order.error!
+    # puts params[errorMessage]
+    # => Текст ошибки, присланный unitpay
   end
- 
-  private
 
   def service
     # ВНИМАНИЕ: обязательный метод! Используется при проверке сигнатуры.
@@ -130,17 +128,39 @@ class UnitpayController < ApplicationController
 end
 ```
 
-###<a name="widget"></a> Подключение виджета для карт оплаты
+[Описание параметров, передаваемых при запросе.
+](http://help.unitpay.ru/article/35-confirmation-payment)
+
+### Исключения при обработке запросов
+
+Важно понимать, что до вызова метода `pay` происходит проверка только сигнатуры.
+Прочие проверки на соответствие платежа правилам логики приложения остаются на вашей совести (например, эквивалентность суммы оплаты и суммы заказа).
+Для удобства обработки таких ситуаций существует зарезервированное исключение `Unitpay::Controller::RuntimeException`. В этом случае в ответе будет передан текст вашей ошибки.
+
+Пример:
+
+```ruby
+def pay
+  order = Order.find(params[:params][:account])
+  if order.total_cost == params[:params][:sum]
+    order.payed!
+  else
+    raise Unitpay::Controller::RuntimeException.new('Неверная сумма оплаты')
+  end
+end
+```
+
+##<a name="widget"></a> Подключение виджета для карт оплаты
 
 Рассмотрим один из способов реализации случая, когда необходимо показать виджет оплаты после заполнения пользователем формы заказа.
 
-1. Подключите на странице внешний скрипт:
+- Подключите на странице внешний скрипт:
 
 ```html
 <script src="https://widget.unitpay.ru/unitpay.js"></script>
 ```
 
-2. Добавьте обработчик формы заказа
+- Добавьте обработчик формы заказа:
 
 **unitpay.js.coffe**
 ```coffee
@@ -177,7 +197,7 @@ $ ->
 
 ```
 
-3. Измените контроллер так, чтобы он отдавал необходимый `json` ответ
+- Измените контроллер так, чтобы он отдавал необходимый `json` ответ:
 
 **orders_controller.rb**
 ```ruby
@@ -203,6 +223,7 @@ class OrdersController < ApplicationController
     # используйте strong params
   end
 end
+```
 
 ## Contributing
 

data/lib/unitpay/controller.rb

@@ -3,9 +3,10 @@ module Unitpay
     # Skip RequestForgeryProtection
     # skip_before_filter :verify_authenticity_token
 
-    class ServiceNotImplementedError < StandardError; end
-    class PayNotImplementedError < StandardError; end
-    class ErrorNotImplementedError < StandardError; end
+    class ServiceNotImplemented < StandardError; end
+    class PayMethodNotImplemented < StandardError; end
+    class ErrorMethodNotImplemented < StandardError; end
+    class RuntimeException < StandardError; end
 
     def notify
       if service.valid_notify_sign?(params[:params])
@@ -14,6 +15,8 @@ module Unitpay
       else
         fail_request
       end
+    rescue RuntimeException => e
+      fail_request(e.message)
     end
 
     def success
@@ -27,7 +30,7 @@ module Unitpay
     private
 
     def service
-      raise ServiceNotImplementedError
+      raise ServiceNotImplemented
     end
 
     def check
@@ -35,19 +38,19 @@ module Unitpay
     end
 
     def pay
-      raise PayNotImplementedError
+      raise PayMethodNotImplemented
     end
 
     def error
-      raise ErrorNotImplementedError
+      raise ErrorMethodNotImplemented
     end
 
     def success_request
       render json: { result: { message: 'Запрос успешно обработан' } }
     end
 
-    def fail_request
-      render json: { error: { message: 'Неверная сигнатура' } }
+    def fail_request(message = 'Неверная сигнатура')
+      render json: { error: { message: message } }
     end
   end
 end

data/lib/unitpay/version.rb

@@ -1,3 +1,3 @@
 module Unitpay
-  VERSION = '0.1'
+  VERSION = '0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unitpay
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - ssnikolay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-03 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler