paysto-rails 1.0.1 → 1.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDZmN2Q3NWUxMmMwYzY0Njg0NzBkYzQxYTI5YmRkYTdmZjY3ZDUwZA==
+    NzRjM2IyMzliNGYwNjdhOGMyM2I1YmMyY2RhMzYwZDU0MzhjYWE5Yw==
   data.tar.gz: !binary |-
-    YjFhYzZiMjFlOWJkMDNmOGI5Zjk0MTk5YTU5MmY0MTUxNmUxOGQwNw==
+    MDZjZDZhMzQxMDZmMDUzZmQ2MDA4YmMzMTQ3ZjQwMGE5YmMxNTFmMg==
 SHA512:
   metadata.gz: !binary |-
-    ZGU3YTliYzMwMmZhNTIyMmI3YzEyNWFhNzBkZTdjNTA5YTAzMmNiZDgwNGUw
-    YjhhZTM0MTZjZWNlNWJiNmNlMTQwMTgzZGEzYTE4OTg4NDUyNGY3ODk3YjVj
-    MWNhZTM3YjVkY2NkNDVhMjJmZjRlODBkODU2ODg3MzI3Yjc5ZWI=
+    NmQwMmU0MDBhZWFjZDJiNjBiNTNmOTc4NzRhNDFkNjliZDRlNDRkM2RmNWM3
+    MzhmNWRlMjRhM2RiMDYyYWQyMzJmMmU5ZTc3NTA3YjcxOTQ1Yjc4YmVmMjdm
+    MTY0OWU5NDFmZWEwMTgzMmU1OTFkY2FmODAzOGZiZDkwNDZlOWQ=
   data.tar.gz: !binary |-
-    YjE4ZmI5NDY2MGNkNTBlYTY3NjBmOGQ1YjA2YzYwZWVhNDgyYjMzOGZhNDBl
-    MTQxOTJkMmMwNDliOWZkNmQ0NzU4YjY5ZmNhYjZlZDQwMzExMzgwZmMyMjMy
-    ODY4NDQxNzUzZjliZWQ5MjVkNWM3OWI1NTYyMTE1NTBjOTlkZDc=
+    OTA3NzQ3Zjk5MTFlMmRiOTcyMTAzNWRhZTVhZjM2MTBkNjMxYjE5MTVhYjAx
+    ZDVlZDY3MWJlNDE1NjA1NTI5M2FjOTI4MDM2ZDc1MmU3ZTlkOWU0ZGE1ZmFh
+    MGI1NGMzNGJlN2ExYTIwMzkxOTFlMDg3ZGYyMjY2Y2VkMzJiNzk=

data/README.md

@@ -2,10 +2,10 @@
 [![Gem Version](https://badge.fury.io/rb/paysto-rails.svg)](http://badge.fury.io/rb/paysto-rails)
 [![Code Climate](https://codeclimate.com/github/fbandrey/paysto-rails/badges/gpa.svg)](https://codeclimate.com/github/fbandrey/paysto-rails)
 [![Dependency Status](https://gemnasium.com/fbandrey/paysto-rails.svg)](https://gemnasium.com/fbandrey/paysto-rails)
+[![security](https://hakiri.io/github/fbandrey/paysto-rails/master.svg)](https://hakiri.io/github/fbandrey/paysto-rails/master)
+[![Inline docs](http://inch-ci.org/github/fbandrey/paysto-rails.png?branch=master)](http://inch-ci.org/github/fbandrey/paysto-rails)
 
-This is first implementation for passing payments through [Paysto](https://paysto.com) gateway.
-
-It works only with «[onlineMerchant](https://paysto.com/ru/products/onlineMerchant)», if you know what I mean. :)
+This is first implementation for passing payments through [Paysto](https://paysto.com) gateway. It works only with «[onlineMerchant](https://paysto.com/ru/products/onlineMerchant)».
 
 ## Installation
 
@@ -65,35 +65,33 @@ In the simple case only what you should to do:
 
 That's all.
 
-Now you may customize models as you want, associate it with users or anything else...
-
-For more information check [payment workflow](https://github.com/fbandrey/paysto-rails/wiki/Payment-workflow) wiki.
-
 ## Usage
 
-You have 3 models and 1 controller now if you did everything right before. Check models and extend them with logic and associations, which you need in your application.
+You have 3 models and 1 controller now if you did everything right before. Check models and extend them with logic or associations, which you need in your application.
 
-Controller by default [extended with concern](https://github.com/fbandrey/paysto-rails/blob/master/lib/paysto/controller.rb) and looks so:
+Controller by default [extended with concern](https://github.com/fbandrey/paysto-rails/blob/master/lib/paysto/controller.rb) and contains all necessary methods:
 ```
 class PaystoController < ApplicationController
   include Paysto::Controller
 end
 ```
-But you may override methods here as you want. For example, if I want to redirect user to "/payments" URL when payment is passed:
+But you may override methods as you want. For example, if you want to redirect user to custom URL when payment is passed:
 ```
 class PaystoController < ApplicationController
   include Paysto::Controller
   
   def success
     flash[:success] = I18n.t('paysto.success')
-    redirect_to custom_payments_path
+    redirect_to any_custom_payments_path
   end
 end
 ```
 
-Also you can customize [check](https://github.com/fbandrey/paysto-rails/blob/master/lib/paysto/controller.rb#L9) or [callback](https://github.com/fbandrey/paysto-rails/blob/master/lib/paysto/controller.rb#L18) methods using Paysto module as you want, but we don't recommend it, do it only if you know what's going on there.
+Also you can customize [check](https://github.com/fbandrey/paysto-rails/blob/master/lib/paysto/controller.rb#L9) or [callback](https://github.com/fbandrey/paysto-rails/blob/master/lib/paysto/controller.rb#L18) methods using Paysto module as you want, but do it only if you know what's going on there.
+
+Check [payment workflow](https://github.com/fbandrey/paysto-rails/wiki/Payment-workflow) wiki for more information.
 
-### Paysto methods
+#### Paysto methods
 
 ```Paysto.balance``` – current balance in Paysto.
 
@@ -109,7 +107,7 @@ Also you can customize [check](https://github.com/fbandrey/paysto-rails/blob/mas
 
 ```Paysto.md5_valid?(params)``` – check whether the MD5 sign is valid.
 
-```Paysto.pay_till``` – timestamp string in Paysto format.
+```Paysto.pay_till``` – timestamp string for payment expiration in Paysto format.
 
 ```Paysto.real_amount(amount)``` – real income amount without Paysto tax.
 

data/lib/generators/paysto/install_generator.rb

@@ -4,6 +4,7 @@ module Paysto
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('../../templates', __FILE__)
 
+    # Extend routes.rb with required routes.
     def add_paysto_routes
       paysto_route = <<-PAYSTO_ROUTES
 namespace :paysto do
@@ -14,18 +15,21 @@ PAYSTO_ROUTES
       route paysto_route
     end
 
+    # Copy general Paysto config.
     def copy_config
       template 'config/paysto.rb', 'config/initializers/paysto.rb'
     end
 
+    # Copy RU and EN locale files.
     def copy_locale
       template 'config/paysto.en.yml', 'config/locales/paysto.en.yml'
       template 'config/paysto.ru.yml', 'config/locales/paysto.ru.yml'
     end
 
+    # Copy default Paysto controller.
     def copy_controller
       template 'controllers/paysto_controller.rb', 'app/controllers/paysto_controller.rb'
     end
 
   end
-end
+end

data/lib/generators/paysto/models_generator.rb

@@ -6,6 +6,7 @@ module Paysto
     include Rails::Generators::Migration
     source_root File.expand_path('../../templates', __FILE__)
 
+    # Migration timestamp.
     def self.next_migration_number(dirname)
       if ActiveRecord::Base.timestamped_migrations
         Time.new.utc.strftime("%Y%m%d%H%M%S")
@@ -14,14 +15,16 @@ module Paysto
       end
     end
 
+    # Create migration with required tables.
     def create_migration_file
       migration_template 'migration.rb', 'db/migrate/create_paysto_tables.rb'
     end
 
+    # Render configured models.
     def copy_models
       template 'models/payment.rb',              "app/models/#{Paysto.payment_class_name.underscore}.rb"
       template 'models/invoice.rb',              "app/models/#{Paysto.invoice_class_name.underscore}.rb"
       template 'models/invoice_notification.rb', "app/models/#{Paysto.invoice_notification_class_name.underscore}.rb"
     end
   end
-end
+end

data/lib/generators/templates/config/paysto.rb

@@ -1,10 +1,11 @@
 Paysto.setup do |config|
 
-  # === Put your Paysto credentials here
+  # === Put your real Paysto credentials here.
   config.id          = 'SECRET-ID'
   config.secret      = 'SECRET-KEY'
   config.description = 'CUSTOM-DESCRIPTION-FOR-PAYMENTS'
 
+  # === Paysto URLs.
   config.urls = {
     payment:        'https://paysto.com/ru/pay',
     currencies:     'https://paysto.com/api/Common/Currency',
@@ -12,6 +13,7 @@ Paysto.setup do |config|
     payments_list:  'https://paysto.com/api/Payment/GetList'
   }
 
+  # === Paysto server IPs.
   config.ips = [
     '66.226.72.66',
     '66.226.74.225',
@@ -20,10 +22,16 @@ Paysto.setup do |config|
     '66.226.74.228'
   ]
 
-  # === Payments tax of your tariff plan in Paysto, default onlineMerchant "All inclusive" is 5%.
+  # === Payments tax of your tariff plan in Paysto. Default onlineMerchant "All inclusive" is 5%.
   config.tax = 0.05
 
-  # === Customize model names as you want before they are will be generated
+  # === Minimal Paysto tax for each payment. Default: 10.
+  config.min_tax = 10
+
+  # === Payments expiration. Default: 1.day.
+  config.expiration = 1.day
+
+  # === Customize model names as you want before they are will be generated.
   config.payment_class_name              = 'Payment'
   config.invoice_class_name              = 'Invoice'
   config.invoice_notification_class_name = 'InvoiceNotification'

data/lib/generators/templates/models/invoice.rb

@@ -8,18 +8,22 @@ class <%= Paysto.invoice_class_name %> < ActiveRecord::Base
 
   validates :amount, presence: true
 
+  # 'Success' code for different gateways.
   SUCCESS_STATES = {
     'paysto' => 'RES_PAID'
   }
 
+  # Create <%= Paysto.invoice_notification_class_name %> with details.
   def notify(params, gateway)
     self.<%= Paysto.invoice_notification_class_name.underscore.pluralize %>.create(pay_data: info_by_gateway(params, gateway))
   end
 
+  # Check whether the <%= Paysto.invoice_class_name.underscore %> is should be paid.
   def need_to_be_paid?(gateway, payment_status, amount)
     !paid? && (payment_status == SUCCESS_STATES[gateway.to_s]) && (self.amount.to_f == amount.to_f)
   end
 
+  # Create <%= Paysto.payment_class_name %> record.
   def create_<%= Paysto.payment_class_name.underscore %>(payment_method, gateway_code, real_amount = nil)
     self.<%= Paysto.payment_class_name.underscore %> = <%= Paysto.payment_class_name %>.new(amount: self.amount,
                          real_amount: real_amount,
@@ -32,12 +36,15 @@ class <%= Paysto.invoice_class_name %> < ActiveRecord::Base
     end
   end
 
+  # Whether the <%= Paysto.invoice_class_name.underscore %> is paid.
   def paid?
     !!paid_at
   end
 
   private
 
+  # Payment details string.
+  # You could extend this method for another gateways.
   def info_by_gateway(_params, _gateway)
     _keys = case _gateway
             when :paysto
@@ -51,4 +58,4 @@ class <%= Paysto.invoice_class_name %> < ActiveRecord::Base
     end.join(';')
   end
 
-end
+end

data/lib/paysto/base.rb

@@ -7,96 +7,115 @@ module Paysto
                   :urls,
                   :ips,
                   :tax,
+                  :min_tax,
+                  :expiration,
                   :payment_class_name,
                   :invoice_class_name,
                   :invoice_notification_class_name
 
   class << self
 
+    # Configuring module.
     def setup
       yield self
     end
 
+    # Payment class.
     def payment_class
       @@payment_class_name.constantize
     end
 
+    # Invoice class.
     def invoice_class
       @@invoice_class_name.constantize
     end
 
+    # InvoiceNotification class.
     def invoice_notification_class
       @@invoice_notification_class_name.constantize
     end
 
+    # List of available pay methods according to your tariff plan.
     def currencies
-      https_request_to Paysto.urls[:currencies], base_params
+      https_request_to @@urls[:currencies], base_params
     end
 
+    # Your current balance in Paysto.
     def balance
-      https_request_to Paysto.urls[:balance], base_params
+      https_request_to @@urls[:balance], base_params
     end
 
+    # Returns array of payments with details between dates.
+    # +from+  –  from date.
+    # +to+    –  to date.
     def get_payments(from, to)
-      p = { 'PAYSTO_SHOP_ID' => Paysto.id,
+      p = { 'PAYSTO_SHOP_ID' => @@id,
             'FROM'           => from.strftime('%Y%m%d%H%M'),
             'TO'             => to.strftime('%Y%m%d%H%M') }
       p.merge!('PAYSTO_MD5'  => generate_md5(p))
 
-      res = https_request_to(Paysto.urls[:payments_list], p)
+      res = https_request_to(@@urls[:payments_list], p)
       CSV.parse(res)
     end
 
+    # Returns payment type or 'common' by default.
+    # +invoice_id+  –  invoice ID of payment.
+    # +time+        –  estimated payment execution time.
     def get_payment_type(invoice_id, time = Time.zone.now)
-      _type = 'common'
       _payments = get_payments(time.utc - 30.minutes, time.utc + 5.minutes)
       if _payments.present?
         p = _payments.select{|_p| _p[2].eql?(invoice_id.to_s)}.first
         _type = p[7] if p
       end
-      _type
+      _type || 'common'
     end
 
+    # Check whether the invoice is valid.
     def invoice_valid?(invoice)
-      invoice && invoice.payment_id.blank? && invoice.paid_at.blank?
+      invoice && invoice.send("#{@@payment_class_name.underscore}_id").blank? && invoice.paid_at.blank?
     end
 
+    # Check whether the IP is permitted.
     def ip_valid?(ip)
-      Paysto.ips.include?(ip)
+      @@ips.include?(ip)
     end
 
+    # Check whether the MD5 sign is valid.
     def md5_valid?(p)
-      generate_md5(p.reject{|k,v| ['action', 'controller', 'PAYSTO_MD5'].include?(k)}) == p['PAYSTO_MD5']
+      except_keys = ['action', 'controller', 'PAYSTO_MD5']
+      generate_md5(p.reject{|k,v| except_keys.include?(k)}) == p['PAYSTO_MD5']
     end
 
+    # Timestamp string in Paysto format for payments expiration.
     def pay_till
-      (Time.zone.now + 1.day + 1.minute).utc.strftime('%Y%m%d%H%M')
+      (Time.zone.now + @@expiration).utc.strftime('%Y%m%d%H%M')
     end
 
+    # Real income value without Paysto tax for any amount which you want to calculate.
+    # +str+  –  amount string or numeric, does not matter.
     def real_amount(str)
       amount = str.to_f
-      _tax = amount * Paysto.tax
-      _tax = 10 if _tax < 10
+      _tax = amount * @@tax
+      _tax = @@min_tax if _tax < @@min_tax
       amount - _tax
     end
 
     private
 
+    # Generating MD5 sign according with received params.
     def generate_md5(p = {}, upcase = true)
       hash_str = p.to_a.sort_by{|pair| pair.first.downcase}.map{|pair| pair.join('=')}.join('&')
-      md5 = Digest::MD5.hexdigest("#{hash_str}&#{Paysto.secret}")
-      if upcase
-        md5.upcase
-      else
-        md5
-      end
+      md5 = Digest::MD5.hexdigest("#{hash_str}&#{@@secret}")
+      upcase ? md5.upcase : md5
     end
 
+    # Base set of params for requests.
     def base_params
-      p = { 'PAYSTO_SHOP_ID' => Paysto.id }
+      p = { 'PAYSTO_SHOP_ID' => @@id }
       p.merge!('PAYSTO_MD5'  => generate_md5(p))
     end
 
+    # Performing an HTTPS request.
     def https_request_to(url, params)
       uri = URI.parse(url)
       req = Net::HTTP::Post.new(uri.path)
@@ -110,4 +129,4 @@ module Paysto
     end
 
   end
-end
+end

data/lib/paysto/controller.rb

@@ -3,9 +3,12 @@ module Paysto
     extend ActiveSupport::Concern
 
     included do
+      # Some callbacks does not requires verifications.
       skip_before_filter :verify_authenticity_token, only: [:callback, :check]
     end
 
+    # First step of payment workflow: Invoice, IP and MD5 verification.
+    # Render invoice ID if everything right or anything else if not.
     def check
       invoice = Paysto.invoice_class.find_by_id(params['PAYSTO_INVOICE_ID'])
       if Paysto.invoice_valid?(invoice) && Paysto.ip_valid?(request.remote_ip) && Paysto.md5_valid?(params)
@@ -15,6 +18,8 @@ module Paysto
       end
     end
 
+    # Second step of payment workflow: Payment creation.
+    # Render invoice ID if everything right or anything else if not.
     def callback
       invoice = Paysto.invoice_class.find_by_id(params['PAYSTO_INVOICE_ID'])
       if invoice && invoice.need_to_be_paid?(:paysto, params['PAYSTO_REQUEST_MODE'], params['PAYSTO_SUM']) && Paysto.ip_valid?(request.remote_ip) && Paysto.md5_valid?(params)
@@ -26,15 +31,17 @@ module Paysto
       end
     end
 
+    # Success callback.
     def success
       flash[:success] = I18n.t('paysto.success')
       redirect_to root_path
     end
 
+    # Fail callback.
     def fail
       flash[:alert] = I18n.t('paysto.fail')
       redirect_to root_path
     end
 
   end
-end
+end

data/lib/paysto/version.rb

@@ -1,3 +1,3 @@
 module Paysto
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paysto-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Andrey Baiburin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler