bank_gateway_saman 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f9d330650a5d8e565bd23bace6fcb4676318999401cf1979c9538f6c7ede722
+  data.tar.gz: 77b6be29455d19fca08b02f9df935b6041b0a859fc316ded723d2af8784d6940
+SHA512:
+  metadata.gz: a545e5e4e84896b6be9a021885b595bdcb39cf285cb3d94a5da35dcb289de09c6f0437c3583412338486c06e19288db687d6e582ef97ddd720d98ef96b629d57
+  data.tar.gz: c369ee1f9ba760b6291c6f0b6af97d1096ebc06b9709718c4db523ecd6cf8798c2af37f6fae3bb1c1e11033da76555d7ebfb10fc6dd54541c1faffd9bec013f5

data/README.md

@@ -0,0 +1,112 @@
+# Saman
+
+[Coverage Report](http://amirhosein.zlf.gitlab.io/bank_gateway_saman/)
+
+This gem will help you to handle all required requests for using Saman gateway using ruby
+
+## Install
+### Using in ruby
+- Add `saman` gem to your Gemfile
+
+`gem 'saman'`
+
+- Run bundle install
+
+`bundle install`
+
+### Using in Rails
+- Add `saman` gem to your Gemfile
+
+`gem 'saman'`
+
+- Run bundle install
+
+`bundle install`
+
+- Create the initializer for it
+
+`bundle exec rails g saman:install`
+
+### How to use it?
+
+#### Configurations
+
+For `rails` applications it will generate an `initializer` file called `saman.rb` which you could set all the required configurations. 
+
+If you are using this gem in a `ruby`
+script, you should set the configurations like below before calling any methods.
+
+```
+Saman.configure do |config|
+  # config.username = config_hash[:username]
+  # config.password = config_hash[:password]
+
+  # config.proxy = config_hash[:proxy]
+  # e.g. config.proxy = 'http://localhost:8080/'
+
+  # config.terminal_id_default = config_hash[:terminal_id_default]
+
+  # a terminal id which support multi account
+  # config.terminal_id_with_wage = config_hash[:terminal_id_with_wage]
+
+  # a termianl id which is needed for you wage account
+  # config.terminal_id_wage_only = config_hash[:terminal_id_wage_only]
+
+  # config.retry_count = config_hash[:retry_count]
+  # config.authorize_wsdl = config_hash[:authorize_wsdl]
+  # config.authorize_address = config_hash[:authorize_address]
+  # config.verify_wsdl = config_hash[:verify_wsdl]
+end
+
+```
+
+#### Is gateway ready?
+You can check if the Saman gateway is ready or not, this method always return a `boolean` value
+
+`Saman.up?`
+
+#### How get a token from gateway?
+The `authorize` method get a token for you from bank and it returns a response like below
+`Saman.authorize(params)`
+```
+{
+  method: 'POST',
+  fields: {
+    Token: 'generated_token'
+  },
+  url: 'http://sample.com/'
+}
+```
+This means you should submit a from by `POST` request to `http://sample.com/` with a field named `Token` and value of `generated_token`
+
+The required params for generating a token are like below
+```
+{
+  "amount": 3000,
+  "order_id": 128,
+  "customer": {
+    "mobile_number": "09128987989"
+  },
+  "split_amount": {
+    "amount": 1500,
+    "wage": 1500
+  },
+  "redirect_url": "http://localhost"
+}
+```
+NOTE: if you do not want to use `split_amount` feature, just pass the `amount` and ignore that.
+
+
+#### How verify a payment?
+
+For verifying a payment, you just need to pass the parameters which were sending to you from gateway like below and this method returns a boolean after calling verify.
+
+`Saman.verify(posted_params)`
+
+### Development
+if you want to change the gem, you could easily clone it and do whatever you want
+
+After your changes always run `specs` and `rubocop` to make sure about the code quality
+
+- `rspec spec`
+- `rubocop --format html > rubocop.html`

data/lib/generators/saman/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+module Saman
+  module Generators
+    # Install generator class for saman gem using in rails
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'Creates Saman initializer for your application'
+
+      def copy_initializer
+        template 'saman_initializer.rb', 'config/initializers/saman.rb'
+      end
+    end
+  end
+end

data/lib/generators/saman/templates/saman_initializer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Saman.configure do |config|
+  # You can read config from a file
+  # config_hash = Rails.application.config_for(:saman)
+  # config.username = config_hash[:username]
+  # config.password = config_hash[:password]
+
+  # config.proxy = config_hash[:proxy]
+  # e.g. config.proxy = 'http://localhost:8080/'
+
+  # config.terminal_id_default = config_hash[:terminal_id_default]
+
+  # a terminal id which support multi account
+  # config.terminal_id_with_wage = config_hash[:terminal_id_with_wage]
+
+  # a termianl id which is needed for you wage account
+  # config.terminal_id_wage_only = config_hash[:terminal_id_wage_only]
+
+  # config.retry_count = config_hash[:retry_count]
+  # config.authorize_wsdl = config_hash[:authorize_wsdl]
+  # config.authorize_address = config_hash[:authorize_address]
+  # config.verify_wsdl = config_hash[:verify_wsdl]
+
+  # or you can set all the configs from environment variables
+  # like ENV['saman_username']
+end

data/lib/saman.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'saman/authorize'
+require_relative 'saman/verify'
+require_relative 'saman/health_check'
+require_relative 'saman/configuration'
+require_relative 'generators/saman/install_generator'
+
+require 'savon'
+require 'yaml'
+require 'rest-client'
+require 'json'
+
+# Saman gateway module to handle requests
+module Saman
+  attr_accessor :config
+
+  def self.authorize(params)
+    Saman::Client.new.authorize(params)
+  end
+
+  def self.verify(params)
+    Saman::Client.new.verify(params)
+  end
+
+  def self.up?
+    Saman::Client.new.health_check
+  end
+end

data/lib/saman/authorize.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# Saman module for gateway communications
+module Saman
+  # extend Client class to handle authorize method
+  class Client
+    def authorize(params)
+      config = Saman.configuration
+      request_parameters = create_authorize_parameters(params)
+      response = send_rest_requests(
+        config.authorize_address,
+        request_parameters,
+        config.retry_count
+      )
+      raise response[:error] unless response.is_a? RestClient::Response
+      authorize_result(response)
+    end
+
+    private
+
+    def authorize_result(response)
+      token = parse_authorize_result(response)
+      {
+        method: 'POST',
+        fields: {
+          Token: token
+        },
+        url: Saman.configuration.authorize_address
+      }
+    end
+
+    def create_authorize_parameters(params)
+      {
+        Action: 'Token',
+        Amount: calculate_the_amount(params),
+        Wage: calculate_the_wage(params),
+        TerminalId: get_terminal_id(params),
+        ResNum: params[:order_id],
+        RedirectUrl: params[:redirect_url],
+        CellNumber: params[:customer][:mobile_number]
+      }
+    end
+
+    def get_terminal_id(params)
+      case params[:split_amount]&.count
+      when nil
+        Saman.configuration.terminal_id_default
+      when 1
+        return Saman.configuration.terminal_id_wage_only if \
+                                              params[:split_amount].key?(:wage)
+        Saman.configuration.terminal_id_default
+      else
+        Saman.configuration.terminal_id_with_wage
+      end
+    end
+
+    def calculate_the_wage(params)
+      return 0 unless multiple_accounts?(params)
+      return 0 if params[:split_amount].count == 1
+
+      params[:split_amount][:wage] || 0
+    end
+
+    def calculate_the_amount(params)
+      return params[:amount] unless multiple_accounts?(params)
+      return params[:amount] if params[:split_amount].count == 1
+
+      params[:split_amount][:amount] || 0
+    end
+
+    def multiple_accounts?(params)
+      params[:split_amount]&.count&.positive?
+    end
+
+    def parse_authorize_result(response)
+      token_result = JSON.parse(response.body)
+      token = token_result['token'] if token_result['status'].to_i == 1
+      raise "Code ##{token_result['errorCode']}, #{token_result['errorDesc']}" \
+        if token.nil?
+
+      token
+    end
+
+    def send_rest_requests(url, parameters, retry_to)
+      RestClient.proxy = Saman.configuration.proxy unless \
+        Saman.configuration.proxy.blank?
+      return RestClient.post(url, parameters.to_json, content_type: :json)
+    rescue RestClient::Exceptions::OpenTimeout => exception
+      retry if (retry_to -= 1).positive?
+      return { error: 'Saman is not available right now,
+                                            calling web service got time out' }
+    rescue StandardError => exception
+      retry if (retry_to -= 1).positive?
+      return { error: exception.message }
+    end
+  end
+end

data/lib/saman/configuration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Saman module for gateway communications
+module Saman
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  # configure class
+  class Configuration
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :proxy
+    attr_accessor :terminal_id_default
+    attr_accessor :terminal_id_with_wage
+    attr_accessor :terminal_id_wage_only
+    attr_writer :retry_count
+    attr_writer :authorize_wsdl
+    attr_writer :authorize_address
+    attr_writer :verify_wsdl
+
+    def authorize_address
+      @authorize_address || 'https://sep.shaparak.ir/MobilePG/MobilePayment'
+    end
+
+    def verify_wsdl
+      @verify_wsdl || 'https://verify.sep.ir/payments/referencepayment.asmx?wsdl'
+    end
+
+    def authorize_wsdl
+      @authorize_wsdl || 'https://sep.shaparak.ir/payments/initpayment.asmx?wsdl'
+    end
+
+    def retry_count
+      @retry_count || 3
+    end
+  end
+end

data/lib/saman/health_check.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Saman
+  # Client class to handle requests
+  class Client
+    def health_check
+      authorize_up? && verify_up?
+    end
+
+    def verify_up?
+      verify_client = Savon.client(wsdl: Saman.configuration.verify_wsdl)
+      expected_operations_for_verify = %i[
+        verify_transaction
+        verify_transaction1
+      ]
+
+      (expected_operations_for_verify - verify_client.operations).empty?
+    rescue StandardError
+      return false
+    end
+
+    def authorize_up?
+      authorize_client = Savon.client(wsdl: Saman.configuration.authorize_wsdl)
+      expected_operations_for_authorize = %i[
+        request_token
+        request_multi_settle_type_token
+      ]
+
+      (expected_operations_for_authorize - authorize_client.operations).empty?
+    rescue StandardError
+      return false
+    end
+  end
+end

data/lib/saman/verify.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Saman module for gateway communications
+module Saman
+  # extend Client class to handle verify method
+  class Client
+    def verify(params)
+      return false unless params[:State] == 'OK'
+      verify_the_payment(params)
+    end
+
+    private
+
+    def verify_the_payment(params)
+      savon_client = create_savon_client_for_verify
+      request_parameters = {
+        String_1: params[:RefNum],
+        String_2: params[:TerminalId]
+      }
+      response = send_verify_request(savon_client, request_parameters)
+      raise response[:error] if response.to_hash.include? :error
+      last_response = response.body[:verify_transaction_response][:result].to_i
+      last_response.positive?
+    end
+
+    def create_savon_client_for_verify
+      config = Saman.configuration
+      options = {
+        wsdl: config.verify_wsdl,
+        convert_request_keys_to: :none
+      }
+      options['proxy'] = config.proxy unless config.proxy.blank?
+
+      Savon.client(options)
+    end
+
+    def send_verify_request(client, parameters, retry_to = 3)
+      client.call(:verify_transaction, message: parameters)
+    rescue StandardError => exception
+      retry if (retry_to -= 1).positive?
+      return { error: exception.message }
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: bank_gateway_saman
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Amirhosein Zolfaghari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Help you to handle all requests to saman payment gateway
+email: amirhosein@zolfaghari.me
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/generators/saman/install_generator.rb
+- lib/generators/saman/templates/saman_initializer.rb
+- lib/saman.rb
+- lib/saman/authorize.rb
+- lib/saman/configuration.rb
+- lib/saman/health_check.rb
+- lib/saman/verify.rb
+homepage: https://gitlab.com/amirhosein.zlf/bank_gateway_saman
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Help you to communicate better with saman payment gateway
+test_files: []