azericard 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b853dad3a4d492e17410701a6457644042ed291
+  data.tar.gz: 652bc4ab9636aca7f2c53fa2d2d1619957e56920
+SHA512:
+  metadata.gz: 032d8cd4eeed7999567457298f078cc965f85381794d07941ebbb65f097e020d79c7341002576d4acdeb9b67624e9cdfb2743d294b153a9853b8efad39e25b78
+  data.tar.gz: 6a99d497e3a53925fb3e85c6951a8d7641763326a0b4fb2cc6dad5b6b0542cc80af522e7867b88fbfa274ef3184c0b3a0448ea34a870f2b82b99ff2de86cbd73

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in azericard.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2013-2023 Nihad Abbasov <mail@narkoz.me>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,65 @@
+# Azericard
+
+Responsible for one of the most discussed and popular web projects of 2013,
+Nihad Abbasov returns to GitHub with a gem that could well follow in its
+footsteps - Azericard.
+
+## Installation
+
+```ruby
+gem 'azericard'
+# gem 'azericard', github: 'NARKOZ/azericard'
+```
+
+## Configuration
+
+```ruby
+Azericard.configure do |config|
+  config.endpoint       = Settings.azericard.endpoint
+  config.terminal       = Settings.azericard.terminal
+  config.secret_key     = Settings.azericard.secret_key
+
+  config.merchant_name  = Settings.azericard.merchant_name
+  config.merchant_email = Settings.azericard.merchant_email
+  config.merchant_url   = Settings.azericard.merchant_url
+  config.country_code   = Settings.azericard.country_code
+  config.gmt_offset     = Settings.azericard.gmt_offset
+end
+```
+
+## Usage
+
+```ruby
+# Payment authorization
+options = {
+  amount: @order.amount,
+  currency: @order.currency,
+  order: @order.number,
+  tr_type: 0,
+  desc: @order.description,
+  backref: azericard_callback_url
+}
+request_options = Azericard::Request.options_for_request(options)
+p_sign = Azericard::Request.generate_mac(request_options.text_to_sign)
+
+# Checkout transaction
+options = {
+  amount: @order.amount,
+  currency: @order.currency,
+  order: @order.number,
+  tr_type: 21,
+  rrn: @order.payment.rrn,
+  intref: @order.payment.intref
+}
+request_options = Azericard::Request.options_for_request(options)
+
+begin
+  Azericard::Request.process request_options
+rescue Azericard::Error => e
+  e.message
+end
+```
+
+## Copyright
+
+Copyright (c) 2013-2023 Nihad Abbasov

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/azericard.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'azericard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "azericard"
+  spec.version       = Azericard::VERSION
+  spec.authors       = ["Nihad Abbasov"]
+  spec.email         = ["mail@narkoz.me"]
+  spec.description   = "Provides an interface to AzeriCard online payment processing system"
+  spec.summary       = "A gem to provide a ruby interface for Azericard electronic payment system"
+  spec.homepage      = "https://github.com/narkoz/azericard"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'typhoeus'
+  spec.add_development_dependency 'rake'
+end

data/lib/azericard.rb

@@ -0,0 +1,17 @@
+require 'azericard/version'
+require 'azericard/configuration'
+require 'azericard/error'
+require 'azericard/request'
+require 'typhoeus'
+
+module Azericard
+  extend Configuration
+
+  AzericardOptions = Struct.new(
+    :nonce, :timestamp,
+    :amount, :currency, :order, :tr_type,
+    :desc, :backref,
+    :rrn, :intref,
+    :text_to_sign
+  ).freeze
+end

data/lib/azericard/configuration.rb

@@ -0,0 +1,26 @@
+module Azericard
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :endpoint, :terminal, :secret_key, :user_agent,
+      :merchant_name, :merchant_url, :merchant_email, :country_code, :gmt_offset
+    ].freeze
+    DEFAULT_USER_AGENT = "Azericard Ruby Gem #{Azericard::VERSION}".freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def reset
+      VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", nil)
+      end
+      self.user_agent = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/azericard/error.rb

@@ -0,0 +1,5 @@
+module Azericard
+  class Error < StandardError; end
+  class HTTPResponseError < Error; end
+  class AzericardResponseError < Error; end
+end

data/lib/azericard/request.rb

@@ -0,0 +1,112 @@
+module Azericard
+  module Request
+    # @param [Azericard::AzericardOptions] request_options
+    # @return [true]
+    # @raise [Azericard::HTTPResponseError]
+    # @raise [Azericard::AzericardResponseError]
+    def self.process(request_options)
+      p_sign = generate_mac(request_options.text_to_sign)
+
+      request = Typhoeus::Request.new(
+        Azericard.endpoint,
+        method: :post,
+        followlocation: true,
+        ssl_verifypeer: false,
+        ssl_verifyhost: 2,
+        cainfo: 'a.cer',
+        body: {
+          "AMOUNT"    => request_options.amount,
+          "CURRENCY"  => request_options.currency,
+          "ORDER"     => request_options.order,
+          "RRN"       => request_options.rrn,
+          "INT_REF"   => request_options.intref,
+          "TERMINAL"  => Azericard.terminal,
+          "TRTYPE"    => request_options.tr_type,
+          "TIMESTAMP" => request_options.timestamp,
+          "NONCE"     => request_options.nonce,
+          "P_SIGN"    => p_sign
+        }
+      )
+
+      response = request.run
+
+      if response.success?
+        if response.body == '0'
+          true
+        else
+          raise AzericardResponseError, "Azericard responded with: #{response.body[0..4]}"
+        end
+      else
+        raise HTTPResponseError, "Azericard request failed: #{response.code}"
+      end
+    end
+
+    # @param [Hash] options
+    # @return [Azericard::AzericardOptions]
+    def self.options_for_request(options={})
+      nonce      = SecureRandom.hex(8)
+      timestamp  = Time.now.utc.strftime('%Y%m%d%H%M%S')
+      merch_name = Azericard.merchant_name
+      merch_url  = Azericard.merchant_url
+      terminal   = Azericard.terminal.to_s
+      email      = Azericard.merchant_email
+      country    = Azericard.country_code
+      merch_gmt  = Azericard.gmt_offset
+
+      desc = backref = rrn = intref = nil
+
+      # Order total amount in float format with decimal point separator
+      amount = options.fetch(:amount).to_f.to_s
+
+      # Order currency: 3-character currency code
+      currency = options.fetch(:currency)
+
+      # Merchant order ID
+      order = options.fetch(:order).to_s
+
+      # Operation type
+      #
+      # 0 - auth
+      # 21 - checkout
+      # 24 - reversal
+      tr_type = options.fetch(:tr_type).to_s
+
+      if tr_type == '0'
+        # Order description
+        desc = options.fetch(:desc).to_s
+
+        # Merchant URL for posting authorization result
+        backref = options.fetch(:backref)
+
+        text_to_sign = "#{amount.size}#{amount}#{currency.size}#{currency}#{order.size}#{order}" \
+          "#{desc.size}#{desc}#{merch_name.size}#{merch_name}#{merch_url.size}#{merch_url}-" \
+          "#{terminal.size}#{terminal}#{email.size}#{email}#{tr_type.size}#{tr_type}#{country.size}#{country}" \
+          "#{merch_gmt.size}#{merch_gmt}#{timestamp.size}#{timestamp}#{nonce.size}#{nonce}#{backref.size}#{backref}"
+      elsif tr_type == '21' || tr_type == '24'
+        # Merchant bank's retrieval reference number
+        rrn = options.fetch(:rrn).to_s
+
+        # E-Commerce gateway internal reference number
+        intref = options.fetch(:intref)
+
+        text_to_sign = "#{order.size}#{order}#{amount.size}#{amount}#{currency.size}#{currency}" \
+          "#{rrn.size}#{rrn}#{intref.size}#{intref}#{tr_type.size}#{tr_type}#{terminal.size}#{terminal}" \
+          "#{timestamp.size}#{timestamp}#{nonce.size}#{nonce}"
+      end
+
+      AzericardOptions.new(nonce, timestamp, amount, currency, order, tr_type, desc, backref, rrn, intref, text_to_sign)
+    rescue KeyError => e
+      e.message
+    end
+
+    # Generates MAC – Message Authentication Code
+    def self.generate_mac(text_to_sign)
+      OpenSSL::HMAC.hexdigest('sha1', hex2bin(Azericard.secret_key), text_to_sign)
+    end
+
+    # Decodes a hexadecimally encoded binary string
+    def self.hex2bin(str)
+      str.scan(/../).map { |x| x.to_i(16).chr }.join
+    end
+  end
+end

data/lib/azericard/version.rb

@@ -0,0 +1,3 @@
+module Azericard
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: azericard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nihad Abbasov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Provides an interface to AzeriCard online payment processing system
+email:
+- mail@narkoz.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- azericard.gemspec
+- lib/azericard.rb
+- lib/azericard/configuration.rb
+- lib/azericard/error.rb
+- lib/azericard/request.rb
+- lib/azericard/version.rb
+homepage: https://github.com/narkoz/azericard
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.7
+signing_key: 
+specification_version: 4
+summary: A gem to provide a ruby interface for Azericard electronic payment system
+test_files: []