qiwi-pay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c519d36dfabe76d9e0be3b19758e66575a73528be25c8ab497b5d5f08a0d9f3
+  data.tar.gz: 7ef5979eaf0f79a4b87299f375327279a14e5cd5c14ad6897c84bc82f7ad79f0
+SHA512:
+  metadata.gz: 6ce3d7ebdf28060e4cd6909aa38f8cc53e8a62e64e49df2025cd51efe75932d945af453e8fb8f5f51fc88f21a687f9ecadb18bf772bb34a27a22ec2558593e49
+  data.tar.gz: d4f4958767bad7d99f8553be4abd0fadd3afdfaee36e0114c690672b0197d458be29cb3d582d0f3401d580ac52fca83dcb93451a381cabe07338bfa4fe4b2346

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.1
+
+Style/AsciiComments:
+  Enabled: false
+
+Rails:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.5

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.5
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in qiwi-pay.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    qiwi-pay (0.1.0)
+      rest-client (>= 1.8.0, < 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    luhn (1.0.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  luhn (~> 1.0)
+  qiwi-pay!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 2)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018 Onlinetours.Ru
+
+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,296 @@
+[![Build Status](https://travis-ci.org/OnlinetoursGit/qiwi-pay.svg?branch=master)](https://travis-ci.org/OnlinetoursGit/qiwi-pay)
+[![Maintainability](https://api.codeclimate.com/v1/badges/eb4dda5c934aec79ef99/maintainability)](https://codeclimate.com/github/OnlinetoursGit/qiwi-pay/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/eb4dda5c934aec79ef99/test_coverage)](https://codeclimate.com/github/OnlinetoursGit/qiwi-pay/test_coverage)
+
+# QiwiPay
+
+QiwiPay WPF/API binding for Ruby.
+
+Provides support for payment operations using QiwiPay WPF and API services.
+
+See [Official QiwiPay documentation](https://developer.qiwi.com/ru/qiwipay) for detailed API description.
+
+## Table of contents
+
+  *  [Installation](#installation)
+  *  [Usage](#usage)
+      * [Prepare credentials object](#prepare-credentials-object)
+      * [Create cheque object](#create-cheque-object)
+      * [Perform payment operations using WPF](#perform-payment-operations-using-wpf)
+      * [Process QiwiPay confirmation callback](#process-qiwipay-confirmation-callback)
+      * [Perform payment operations using JSON API](#perform-payment-operations-using-json-api)
+  * [Development](#development)
+  * [Contributing](#contributing)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qiwi-pay'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qiwi-pay
+
+
+## Usage
+
+There are three types of interactions with QiwiPay service:
+
+1. Performing Web Payment Form requests
+2. Performing JSON API requests
+3. Handling callback confirmation requests
+
+### Prepare credentials object
+To perform any request you must provide your QiwiPay credentials. For doing that the `Credentials` object should be used.
+
+```ruby
+# Create credentials object
+# You can use PKCS#12 container
+p12 = OpenSSL::PKCS12.new(File.read('qiwi.p12'))
+
+crds = QiwiPay::Credentials.new secret: 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+                                p12: p12
+
+# ... or provide certificate and key objects explicitly
+crds = QiwiPay::Credentials.new secret: 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+                                cert: p12.certificate,
+                                key: p12.key
+
+# ... or load from separate files
+crds = QiwiPay::Credentials.new secret: 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+                                cert: 'my.crt',
+                                key: 'my.key'
+```
+
+### Create cheque object
+
+See [Cheque section of Official QiwiPay documentation](https://developer.qiwi.com/ru/qiwipay/index.html?json#cheque) for details.
+```ruby
+cheque = QiwiPay::Cheque.new seller_id:        12345678901,
+                             cheque_type:      QiwiPay::Cheque::Type::INFLOW,
+                             customer_contact: 'client@example.com',
+                             tax_system:       QiwiPay::Cheque::TaxMode::USN_DR,
+                             positions: [{
+                                quantity:    1,
+                                price:       10_000,
+                                tax:         QiwiPay::Cheque::VAT::NONE,
+                                description: 'Order #1234 payment'
+                             }]
+```
+
+### Perform payment operations using WPF
+Only two types of payment operations are available for now:
+* *sale* - single-step payment operation
+* *auth* - initiate multi-steps payment operation
+
+Operations are used in very similar way. Use `QiwiPay::Wpf::SaleOperation` class for *sale* operation and `QiwiPay::Wpf::AuthOperation` class for *auth* operation.
+
+See [WPF section of Official QiwiPay documentation](https://developer.qiwi.com/ru/qiwipay/index.html?json#qiwipay-wpf) for details.
+
+#### Create payment operation object
+```ruby
+op = QiwiPay::Wpf::SaleOperation.new crds,
+                                     merchant_site: 111_111,
+                                     currency: 643,
+                                     email: 'client@example.com',
+                                     country: 'RUS',
+                                     city: 'Moscow',
+                                     amount: 10_000,
+                                     order_id: 1234,
+                                     product_name: 'Flowers',
+                                     merchant_uid: 432101,
+                                     order_expire: Time.now + 3600,
+                                     callback_url: 'https://example.com/payment/callback'
+op.cheque = cheque
+```
+
+#### Build redirection URL for sale operation form
+```ruby
+op.url
+=> 'https://pay.qiwi.com/paypage/initial?opcode=1&merchant_site=111111&currency=643&amount=1000.00&order_id=1234&email=client@example.com&country=RUS&city=Moscow&product_name=%D0%9E%D0%BF%D0%BB%D0%B0%D1%82%D0%B0+%D1%82%D1%83%D1%80%D0%B0&merchant_uid=432101&callback_url=https%3A%2F%example.com%2Fpayment%2Fcallback&sign=...c4dbf...'
+```
+
+#### Build form params WPF sale operation
+This may be useful if you would like to construct redirection URL or invisible payment form by yourself.
+```ruby
+op.params
+=> {:method=>:get,
+ :url=>"https://pay.qiwi.com/paypage/initial",
+ :opcode=>"1",
+ :merchant_site=>"111111",
+ :currency=>"643",
+ :amount=>"1000.00",
+ :order_id=>"1234",
+ :email=>"client@example.com",
+ :country=>"RUS",
+ :city=>"Moscow",
+ :product_name=>"Flowers",
+ :merchant_uid=>"432101",
+ :callback_url=>"https://example.com/payment/callback",
+ :sign=>"...c4dbf..."}
+```
+
+### Process QiwiPay confirmation callback
+After payment operation has been finished you will receive a confirmation callback request from Qiwi service. Use the request's (`ActionDispatch::Request`, `Rack::Request` or whatever it is) parameters hash to build `QiwiPay::Confirmation` object.
+
+```ruby
+conf = QiwiPay::Confirmation.new crds, request.params
+```
+
+Now you have a seamless way to access confirmation data and perform some tests on it.
+
+```ruby
+# Check if ip address is a valid Qiwi server address
+conf.valid_server_ip? request.ip
+=> true
+
+# Check signature
+conf.valid_sign?
+=> true
+
+# Read confirmation data
+conf.txn_id
+=> 11728960050
+
+conf.order_id
+=> 1234
+
+conf.error_code
+=> 0
+
+conf.error_message
+=> "No error"
+
+conf.error?
+=> false
+
+conf.txn_status_message
+=> "Authorized"
+
+conf.txn_type_message
+=> "Purchase: auth"
+
+# Check if transaction was successful (valid signature and no error)
+conf.success?
+=> true
+
+# Get all confirmation data as a hash
+conf.to_h
+=> {:txn_id=>11728960050,
+ :txn_status=>2,
+ :txn_type=>1,
+ :txn_date=>"2018-05-03T15:55:18+00:00",
+ :error_code=>0,
+ :pan=>"510000******0082",
+ :amount=>"10000.00",
+ :currency=>643,
+ :auth_code=>nil,
+ :eci=>nil,
+ :card_name=>nil,
+ :card_bank=>nil,
+ :order_id=>1234,
+ :ip=>"196.54.55.20",
+ :email=>"client@example.com",
+ :country=>"RUS",
+ :city=>"Moscow",
+ :region=>nil,
+ :address=>nil,
+ :phone=>nil,
+ :cf1=>nil,
+ :cf2=>nil,
+ :cf3=>nil,
+ :cf4=>nil,
+ :cf5=>nil,
+ :product_name=>"Flowers",
+ :card_token=>nil,
+ :card_token_expire=>nil,
+ :sign=>"27A56431CD3A14BA34...8A",
+ :txn_status_message=>"Authorized",
+ :txn_type_message=>"Single-step purchase"}
+```
+
+### Perform payment operations using JSON API
+Following operations are available for now:
+
+* *capture* - `QiwiPay::Api::CaptureOperation` class
+* *refund* - `QiwiPay::Api::RefundOperation` class
+* *reversal* - `QiwiPay::Api::ReversalOperation` class
+* *status* - `QiwiPay::Api::StatusOperation` class
+
+#### Status operation
+##### Create and perform `status` operation object
+```ruby
+op = QiwiPay::Api::StatusOperation.new crds,
+                                       merchant_site: 111111,
+                                       txn_id: 11728960050,
+                                       order_id: 1234
+response = op.perform
+```
+
+Operations' `perform` methods return `QiwiPay::Api::Response` object. It allow you to get text messages for errors, codes and statuses. See [Transaction statuses section of Official QiwiPay documentation](https://developer.qiwi.com/ru/qiwipay/index.html?json#txn_status)
+
+##### Operation succeeded
+```ruby
+response.success?
+=> true
+response.error_code
+=> 0
+response.error_message
+=> "No errors"
+```
+
+##### Operation failed
+```ruby
+response.success?
+=> false
+response.http_code
+=> 200
+response.error_code
+=> 8021
+response.error_message
+=> "Merchant site not found"
+```
+
+#### Refund/reversal operation
+Both operations are performed in the same way, just use the right class.
+
+```ruby
+op = QiwiPay::Api::RefundOperation.new crds,
+                                       merchant_site: 111111,
+                                       txn_id: 11728960050,
+                                       amount: 500,
+                                       cheque: cheque
+response = op.perform
+=> #<QiwiPay::Api::Response http_code=200 error_code=8018 ...>
+response.success?
+=> false
+response.http_code
+=> 200
+response.error_code
+=> 8018
+response.error_message
+=> "Parsing error"
+response.to_h
+=> {:request_id => "01234567-89ab-cdef-0123-456789abcdef",
+ :error_message => "Parsing error",
+ :error_code => 8018,
+ :http_code => 200
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` or `rake console` or `rake c` 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/OnlinetoursGit/qiwi-pay.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :c => :console
+task :console do
+  sh 'bundle exec irb -r qiwi-pay'
+end