rbkmoney 0.0.1 → 0.1.1

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/README.md

@@ -1,6 +1,6 @@
-# Rbkmoney
+# RBK Money
 
-TODO: Write a gem description
+This gem helps to integrate RBK Money payments into Ruby on Rails applications.
 
 ## Installation
 
@@ -16,9 +16,59 @@ Or install it yourself as:
 
     $ gem install rbkmoney
 
+And finally install `rbkmoney.yml` configuration file:
+
+    $ rails g rbkmoney:install
+
 ## Usage
 
-TODO: Write usage instructions here
+1. Fill in your `config/rbkmoney.yml` file with data.
+  
+2. Create your RBK Money form as follows:
+
+        <%= rbkmoney_form_tag do %>
+          <%= rbkmoney_setup order_id: "<YOUR_ORDER_ID>",
+                             item_name: "<ITEM_NAME>",
+                             user_name: "<USER_NAME>",
+                             user_email: "<USER_EMAIL>",
+                             amount: 1,
+                             success_url: "<CUSTOM_SUCCESS_URL>",
+                             fail_url: "<CUSTOM_FAIL_URL>" %>   
+                           
+          <%= submit_tag %>
+        <% end %>
+
+3. Add payment processing to your controller, e.g.:
+    
+      
+        class PaymentsController
+          def process
+            def payment
+              notification = RBKMoney::Notification.new(params)
+              
+              if notification.acknowledge # check if payment is valid
+                if notification.accepted? # check if payment is accepted
+                  if notification.completed? # check if payment is completed
+                    order = Order.find(notification.order_id)
+                    if order # check if order exists
+                      if order.total == notification.amount # check payment amount
+                        ...
+                        head :ok and return
+                      end
+                    end
+                  end
+                end
+              end
+              
+              head :bad_request and return
+            end
+          end
+        end
+    
+4. Add route for your new action, e.g.: 
+
+        post 'payments/process' => 'payments#process'
+
 
 ## Contributing
 

data/lib/generators/rbkmoney/install_generator.rb

@@ -0,0 +1,14 @@
+module Rbkmoney
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc << "Description:\n    Copies configuration file to your application's config folder."
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_files
+        puts "Installing config:"
+        copy_file "config/rbkmoney.yml", "config/rbkmoney.yml"
+      end
+    end
+  end
+end

data/lib/generators/rbkmoney/templates/config/rbkmoney.yml

@@ -0,0 +1,23 @@
+development:
+  eshop_id: <YOUR_ESHOP_ID>
+  eshop_account: <YOUR_ESHOP_ACCOUNT>
+  currency: 'RUR'
+  success_url: <SUCCESS_URL>
+  fail_url: <FAIL_URL>
+  secret_key: <SECRET_KEY>
+
+test:
+  eshop_id: <YOUR_ESHOP_ID>
+  eshop_account: <YOUR_ESHOP_ACCOUNT>
+  currency: 'RUR'
+  success_url: <SUCCESS_URL>
+  fail_url: <FAIL_URL>
+  secret_key: <SECRET_KEY>
+
+production:
+  eshop_id: <YOUR_ESHOP_ID>
+  eshop_account: <YOUR_ESHOP_ACCOUNT>
+  currency: 'RUR'
+  success_url: <SUCCESS_URL>
+  fail_url: <FAIL_URL>
+  secret_key: <SECRET_KEY>

data/lib/rbkmoney.rb

@@ -17,23 +17,27 @@ module RBKMoney
   end
   
   def self.eshop_id
-    config['eshop_id'].to_i
+    self.config['eshop_id'].to_i rescue nil
   end
   
   def self.eshop_account
-    config['eshop_account']
+    self.config['eshop_account'] rescue nil
   end
   
   def self.currency
-    config['currency']
+    self.config['currency'] rescue nil
   end
   
   def self.success_url
-    config['success_url']
+    self.config['success_url'] rescue nil
   end
   
   def self.fail_url
-    config['fail_url']
+    self.config['fail_url'] rescue nil
+  end
+
+  def self.secret_key
+    self.config['secret_key'] rescue nil
   end
 
 end

data/lib/rbkmoney/helper.rb

@@ -0,0 +1,50 @@
+module RBKMoney
+  module Helpers
+    def rbkmoney_form_tag(url = RBKMoney::purchase_uri, options = {})
+      form_tag(url, options)
+    end
+
+    def rbkmoney_form_tag(url = RBKMoney::purchase_uri, options = {}, &block)
+      if block
+        form_tag(url, options, &block)
+      else
+        form_tag(url, options)
+      end
+    end
+    
+    def rbkmoney_setup(options = {})
+      params = {
+        eshop_id: RBKMoney::eshop_id,
+        currency: RBKMoney::currency,
+        success_url: RBKMoney::success_url,
+        fail_url: RBKMoney::fail_url,
+        locale: 'ru',
+        custom: []
+      }.reject{|k,v| v.nil?}.merge(options)
+      
+      form = []
+      form << tag(:input, :type => 'hidden', :name => 'eshopId',            :value => params[:eshop_id])
+      form << tag(:input, :type => 'hidden', :name => 'orderId',            :value => params[:order_id])
+      form << tag(:input, :type => 'hidden', :name => 'serviceName',        :value => params[:item_name])
+      form << tag(:input, :type => 'hidden', :name => 'recipientAmount',    :value => params[:amount])
+      form << tag(:input, :type => 'hidden', :name => 'recipientCurrency',  :value => params[:currency])
+      form << tag(:input, :type => 'hidden', :name => 'successUrl',         :value => params[:success_url])
+      form << tag(:input, :type => 'hidden', :name => 'failUrl',            :value => params[:fail_url])
+      form << tag(:input, :type => 'hidden', :name => 'requestedLanguage',  :value => params[:locale])
+      form << tag(:input, :type => 'hidden', :name => 'userName',           :value => params[:user_name])
+      form << tag(:input, :type => 'hidden', :name => 'user_email',          :value => params[:user_email])
+      
+      params[:custom].each_with_index do |value, i|
+        form << tag(:input, :type => 'hidden', :name => "userField_#{i}", :value => value)
+      end
+      
+      form.map(&:to_s).join("\n").html_safe
+    end
+  end
+
+  class Railtie < Rails::Railtie
+    initializer "rbkmoney.helpers" do
+      ActionView::Base.send :include, Helpers
+    end
+  end
+end

data/lib/rbkmoney/notification.rb

@@ -0,0 +1,94 @@
+module RBKMoney
+  class Notification
+    attr_accessor :params
+
+    def initialize(p)
+      @params = p
+    end
+
+    def accepted?
+      completed? or status == "3"
+    end
+
+    def completed?
+      status == "5"
+    end
+
+    def amount
+      recipient_amount.to_f
+    end
+    
+    def eshop_id
+      @params['eshopId']
+    end
+    
+    def payment_id
+      @params['paymentId']
+    end
+    
+    def order_id
+      @params['orderId']
+    end
+
+    def service_name
+      @params['serviceName']
+    end
+    
+    def eshop_account
+      @params['eshopAccount']
+    end
+    
+    def recipient_amount
+      @params['recipientAmount']
+    end
+    
+    def currency
+      @params['recipientCurrency']
+    end
+
+    def status
+      @params['paymentStatus']
+    end
+    
+    def user_name
+      @params['userName']
+    end
+    
+    def user_email
+      @params['userEmail']
+    end
+
+    def payment_data
+      @params['paymentData']
+    end
+
+    def received_at
+      Time.parse payment_data
+    end
+
+    def secret_key
+      RBKMoney::secret_key
+    end
+    
+    def received_hash
+      @params['hash']
+    end
+    
+    def user_fields
+      @params.select{ |p| p =~ /userField_[0-9]+/ }.map{ |k, v| v }
+    end
+    
+    def to_s
+      values = [:eshop_id, :order_id, :service_name, :recipient_amount, :currency, :status, :user_name, :user_email, :payment_data, :received_hash].map { |property| "#{property}: '#{self.send property}'" }.join(', ')
+      "<#{values}>"
+    end
+    
+    def generated_hash
+      Digest::MD5.hexdigest([eshop_id, order_id, service_name, eshop_account, recipient_amount, currency, status, user_name, user_email, payment_data, secret_key].join('::'))
+    end
+
+    def acknowledge      
+      received_hash == generated_hash
+    end
+  end
+end

data/lib/rbkmoney/version.rb

@@ -1,3 +1,3 @@
 module RBKMoney
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/rbkmoney.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = RBKMoney::VERSION
   gem.authors       = ["Maksim Gladkov"]
   gem.email         = ["maksim.gladkov@gmail.com"]
-  gem.description   = %q{This gem helps to integrate RBK Money payments into Ruby on Rails applications.}
+  gem.description   = %q{This gem helps to integrate RBK Money payments into Ruby on Rails applications}
   gem.summary       = %q{RBK Money wrapper gem for Ruby on Rails}
   gem.homepage      = ""
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbkmoney
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2014-02-26 00:00:00.000000000 Z
 dependencies: []
-description: This gem helps to integrate RBK Money payments into Ruby on Rails applications.
+description: This gem helps to integrate RBK Money payments into Ruby on Rails applications
 email:
 - maksim.gladkov@gmail.com
 executables: []
@@ -23,7 +23,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/rbkmoney/install_generator.rb
+- lib/generators/rbkmoney/templates/config/rbkmoney.yml
 - lib/rbkmoney.rb
+- lib/rbkmoney/helper.rb
+- lib/rbkmoney/notification.rb
 - lib/rbkmoney/version.rb
 - rbkmoney.gemspec
 homepage: ''
@@ -51,3 +55,4 @@ signing_key:
 specification_version: 3
 summary: RBK Money wrapper gem for Ruby on Rails
 test_files: []
+has_rdoc: