unitpay 0.0.4 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acfaaf225e410fc5732ed5d3385fd98adcf506ed
-  data.tar.gz: 16755b706b4e6e6401d83d48dca515c5ee6901b8
+  metadata.gz: 30615f1d644e3b6abafaccadef5ae3e1ccd9c23e
+  data.tar.gz: e2b1c7945292348d190860ade3265e4419765281
 SHA512:
-  metadata.gz: cd50c6d01f2670b9a5883eb8dff649c5f2e404a7b7a980d5a62a65f4f4720217ec30504b2581966c916a0112eba75ecdcb518b66fcd933f096849acf68622415
-  data.tar.gz: 59973bf3b76a38f870726714a766a546eb00cd7a38cd715ac18faf7615799f7bfca2c6f5816709599efccb69eb6377558752327365ce3040ca4f2722f4c429c0
+  metadata.gz: 05fef55f7da174ec1cc2b728724598867a90de330503079ae226a6fd7571eb657115129107718d1e49d74711409166fe7519c68491c07ff56657adbc0b2af659
+  data.tar.gz: da7a4f62f1a6d3b4253bc232d053413d62c145a0f3b069fa2ee14dde711c576acc638d6dfbe337d4f2b2c115e6d144f9a5d04fa1437f0e10aac590e7fa9d984a

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
   - 2.1.0
+  - 2.2
+script:
+  - CODECLIMATE_REPO_TOKEN=ae069f427c5dbd2edc0474f3aace9b12e4d29cae801a1a9a93b22b74b20c7b45 bundle exec rspec

data/README.md

@@ -1,38 +1,212 @@
+[![Gem Version](https://badge.fury.io/rb/unitpay.svg)](https://badge.fury.io/rb/unitpay)
+[![Build Status](https://travis-ci.org/ssnikolay/unitpay.svg?branch=master)](https://travis-ci.org/ssnikolay/unitpay)
+[![Code Climate](https://codeclimate.com/github/ssnikolay/unitpay.svg)](https://codeclimate.com/github/ssnikolay/unitpay)
+[![Test Coverage](https://codeclimate.com/github/ssnikolay/unitpay/badges/coverage.svg)](https://codeclimate.com/github/ssnikolay/unitpay/coverage)
+
 # Unitpay
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/unitpay`. To experiment with that code, run `bin/console` for an interactive prompt.
+Gem для подключения к платежному шлюзу [unitpay](http://unitpay.ru).
+
+[Документация к шлюзу](http://help.unitpay.ru/)
 
-TODO: Delete this and the text above, and describe your gem
+- [Установка](#installation)
+- [Подключение](#setup)
+- [Использование](#usage)
+    - [Получение ссылки для оплаты](#payment_url)
+    - [Модуль для обработки запросов от unitpay (для RubyOnRails)](#rails)
+    - [Подключение виджета для карт оплаты](#widget)
 
-## Installation
+##<a name="installation"></a> Установка
 
-Add this line to your application's Gemfile:
+Добавьте эти строки в Gemfile вашего приложения:
 
 ```ruby
 gem 'unitpay'
 ```
 
-And then execute:
+И выполните:
 
     $ bundle
 
-Or install it yourself as:
+Или установите напрямую:
 
     $ gem install unitpay
 
-## Usage
+##<a name="setup"></a> Подключение
+Чтобы получить доступ к сервисному классу, достаточно проинициализировать его с `public` и `secret` ключами.
+
+```ruby
+Unitpay::Service.new('unitpay_public_key', 'unitpay_secret_key')
+```
+
+По умолчанию курс валюты выставлен в `RUB`, а использование сигнатуры в `true`.
+Переопределить их можно и при инициализации.
+```ruby
+use_sign, currency = false, 'RUB'
+Unitpay::Service.new('unitpay_public_key', 'unitpay_secret_key', use_sign, currency)
+```
+Чтобы включить проверку сигнатуры со стороны `unitpay`, необходимо нажать на "замочек" в настройках вашего партнера.
+
+![Settings](https://raw.github.com/ssnikolay/unitpay/master/unitpay.jpg)
+
+1. Включение проверки сигнатуры.
+2. `Secret key` для инициализации `Unitpay::Service`.
+3. Необходимо изменить `example.com` на адрес вашего приложения.
+4. Необходимо изменить `example.com` на адрес вашего приложения.
+
+
+##<a name="usage"></a> Использование
+
+###<a name="payment_url"></a> Получение ссылки для оплаты
+
+Чтобы получить ссылку для оплаты, необходимо использовать метод `payment_url`, в который нужно передать следующие параметры:
+
+ Название           | Описание
+--------------------|:-----------------------------------------
+`sum`               | Цена, которую необходимо оплатить пользователю
+`account`           | Внутренний идентификатор платежа (или заказа), однозначно определяющий его в магазине.
+`desc`              | Описание платежа, отображающееся пользователю на стороне шлюза.
+
+```ruby
+sum, account, desc = 100, 1, 'description'
+service = Unitpay::Service.new('unitpay_public_key', 'unitpay_secret_key')
+service.payment_url(sum, account, desc)
+# => 'https://unitpay.ru/pay/public_key?sum=100&account=1&desc=description...'
+```
+
+###<a name="rails"></a> Модуль для обработки запросов от unitpay (для RubyOnRails)
+
+Добавьте роуты для **unitpay** (`config/routes.rb`)
 
-TODO: Write usage instructions here
+```ruby
+scope :unitpay do
+  get :success, to: 'unitpay#success'
+  get :fail, to: 'unitpay#fail'
+  get :notify, to: 'unitpay#notify'
+end
+```
+
+Создайте `app/controllers/unitpay_controller.rb` со следующим кодом:
+
+```ruby
+class UnitpayController < ApplicationController
+  include Unitpay::Controller
+ 
+  def success
+    # вызывается при отправке шлюзом пользователя на Success URL.
+    #
+    # ВНИМАНИЕ: является незащищенным действием!
+    # Для выполнения действий после успешной оплаты используйте pay
+  end
+  
+  def fail
+    # вызывается при отправке шлюзом пользователя на Fail URL.
+    # (во время принятия платежа возникла ошибка)
+  end
+
+  def pay
+    # вызывается при оповещении магазина об
+    # успешной оплате пользователем заказа и после проверки сигнатуры.
+    #
+    # ВНИМАНИЕ: правильный ответ будет сгенерирован автоматически (не нужно использовать render\redirect_to)!
+    # order = Order.find(params[:params][:account])
+    # order.payed!
+  end
+  
+  def error
+    # вызывается при оповещении магазина об ошибке при оплате заказа.
+    #
+    # ВНИМАНИЕ: правильный ответ будет сгенерирован автоматически (не нужно использовать render\redirect_to)!
+    # order = Order.find(params[:params][:account])
+    # order.error!
+  end
+ 
+  private
+
+  def service
+    # ВНИМАНИЕ: обязательный метод! Используется при проверке сигнатуры.
+    Unitpay::Service.new('unitpay_public_key', 'unitpay_secret_key')
+  end
+end
+```
 
-## Development
+###<a name="widget"></a> Подключение виджета для карт оплаты
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+Рассмотрим один из способов реализации случая, когда необходимо показать виджет оплаты после заполнения пользователем формы заказа.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+1. Подключите на странице внешний скрипт:
+
+```html
+<script src="https://widget.unitpay.ru/unitpay.js"></script>
+```
+
+2. Добавьте обработчик формы заказа
+
+**unitpay.js.coffe**
+```coffee
+class Unitpay
+  bindEvents: ->
+    @handleAfterSubmitForm()
+
+  handleAfterSubmitForm: ->
+    $('#id-your-form').submit (e) ->
+      e.preventDefault()
+      tryUnitpay() # при сабмите формы пытаемся получить параметры для виджета
+
+  tryUnitpay = ->
+    $.ajax({
+      type: 'POST',
+      dataType: 'json'
+      url: '/orders' # любой другой путь сохранения\создания вашего платежа (заказа). Не забудьте добавить его в routes.rb
+      data: $('#id-your-form').serialize(),
+      success: (data) ->
+        payment = new UnitPay()
+        payment.createWidget(data)
+        payment.success ->
+          console.log('Unitpay: успешный платеж')
+        payment.error ->
+          # ошибка платежного шлюза (например, пользователь не завершил оплату)
+          console.log('Unitpay: ошибка платежа')
+      error: ->
+        # ошибка при сохранении заказа (например, ошибки валидации)
+        console.log('Ошибка сохранения\создания платежа (заказа)')
+    })
+$ ->
+  unitpay = new Unitpay
+  unitpay.bindEvents()
+
+```
+
+3. Измените контроллер так, чтобы он отдавал необходимый `json` ответ
+
+**orders_controller.rb**
+```ruby
+class OrdersController < ApplicationController
+  def create
+    order = Order.new(permitted_params)
+    if order.save
+      render json: unitpay_service.params_for_widget(order.total_cost, order.id, order.description)
+    else
+      render json: order.errors, status: :unprocessable_entity
+    end
+  end
+  
+  private
+  
+  def unitpay_service
+    # Внимание: не храните ключи в открытом виде в репозитории.
+    # используйте  конфигурационные файлы (https://github.com/binarylogic/settingslogic) 
+    Unitpay::Service.new('public_key', 'secret_key')
+  end
+  
+  def permitted_params
+    # используйте strong params
+  end
+end
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/unitpay/fork )
+1. Fork it ( https://github.com/ssnikolay/unitpay/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/unitpay/version.rb

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

data/unitpay.gemspec

@@ -19,10 +19,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.0'
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unitpay
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: '0.1'
 platform: ruby
 authors:
 - ssnikolay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-02 00:00:00.000000000 Z
+date: 2016-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem для подключения к платежной системе unitpay.ru
 email:
 - ssnikolay@gmail.com
@@ -102,6 +116,7 @@ files:
 - lib/unitpay/service.rb
 - lib/unitpay/version.rb
 - unitpay.gemspec
+- unitpay.jpg
 homepage: https://github.com/ssnikolay/unitpay
 licenses:
 - MIT