portmone 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22c67a332abd19218c0bbb9da2cbd51656e1f94e
+  data.tar.gz: db22c1a1914b670f641369c4754259af5a8b297b
+SHA512:
+  metadata.gz: 91bb922cbcdb68f136707e5a125b8dd7c3428de9f580f022f3b20f9be1f841a5cb1a80fa69ee90a997328cfd93c65fc7332d2a57b0520e565db42bcecd532eeb
+  data.tar.gz: 6e6952470a8fb6b6c861106224bd770143d30540f6c8627185006bbe81bacbfbd92aec7191147c5bb2ab52f3716995a9125ae0f8c3b26b9aef4646cfb7128678

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    portmone (0.0.1)
+      activesupport
+      faraday (~> 0.9)
+      money (~> 6.0)
+      multi_xml (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.3.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.7)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    money (6.10.0)
+      i18n (>= 0.6.4, < 1.0)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    parallel (1.12.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.11.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.0)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    vcr (2.9.3)
+    webmock (3.1.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  minitest (~> 5.0)
+  portmone!
+  pry (~> 0.10)
+  rake (~> 10.0)
+  rubocop (~> 0.51)
+  simplecov (~> 0.14)
+  vcr (~> 2.9)
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   1.14.6

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.warning = false
+end
+
+task default: :test

data/lib/portmone/client.rb

@@ -0,0 +1,122 @@
+module Portmone
+  class Error < StandardError; end
+
+  class Client
+    BASE_URL = 'https://www.portmone.com.ua/gateway/'.freeze
+
+    def initialize(payee_id:,
+                   login:,
+                   password:,
+                   locale:,
+                   currency:,
+                   timezone: 'Europe/Kiev',
+                   logger: nil)
+      @payee_id = payee_id
+      @login = login
+      @password = password
+      @locale = locale
+      @currency = currency
+      @timezone = timezone
+      @logger = logger
+    end
+
+    def generate_url(shop_order_number:, amount:, description:, success_url:, failure_url:, authorize_only: true)
+
+      send_request(
+        response_class: Portmone::Responses::GenerateURL,
+        method: nil,
+        shop_order_number: shop_order_number,
+        bill_amount: format_amount(amount),
+        bill_currency: @currency,
+        description: description,
+        success_url: success_url,
+        failure_url: failure_url,
+        encoding: 'utf-8',
+        preauth_flag: authorize_only ? 'Y' : 'N'
+      )
+    end
+
+    def order_status(shop_order_number)
+      generic_report(shop_order_number: shop_order_number)
+    end
+
+    def void(order_id)
+      generic_preauth_update(order_id: order_id, action: 'reject')
+    end
+
+    def charge(order_id, amount)
+      generic_preauth_update(order_id: order_id, action: 'set_paid', amount: amount)
+    end
+
+    def refund(order_id, amount:)
+      send_signed_request(
+        response_class: Portmone::Responses::RefundOrderStatus,
+        method: 'return',
+        shop_bill_id: order_id,
+        return_amount: format_amount(amount),
+      )
+    end
+
+  private
+
+    # может возвращать как отдельный заказ по id, так и все заказы с опр. статусом или в опр. временном диапазоне
+    def generic_report(shop_order_number: nil, status: nil, start_date: nil, end_date: nil)
+      send_signed_request(
+        response_class: Portmone::Responses::OrderStatus,
+        method: 'result',
+        shop_order_number: shop_order_number,
+        status: status,
+        start_date: start_date,
+        end_date: end_date,
+      )
+    end
+
+    def generic_preauth_update(order_id:, action:, amount: nil)
+      attrs = {
+        method: 'preauth',
+        response_class: Portmone::Responses::OrderStatus,
+        shop_bill_id: order_id,
+        action: action,
+      }
+      attrs[:postauth_amount] = format_amount(amount) if amount
+      send_signed_request(attrs)
+    end
+
+    def format_date(date)
+      date.strftime("%d.%m.%Y")
+    end
+
+    def format_amount(amount)
+      raise "Wrong currency! (got #{amount.currency}, expected #{@currency})" unless amount.currency == @currency
+
+      amount.to_f
+    end
+
+    def send_signed_request(**data)
+      send_request(data.merge(
+        login: @login,
+        password: @password,
+      ))
+    end
+
+    def send_request(**data)
+      response_class = data.delete(:response_class)
+      response = http_client.post(BASE_URL) do |req|
+        req.body = data.merge(
+          payee_id: @payee_id,
+          lang: @locale,
+        ).delete_if { |_, v| v.nil? }
+      end
+
+      response_class.new(response, currency: @currency, timezone: @timezone)
+    end
+
+    def http_client
+      @http_client ||= Faraday.new do |builder|
+        builder.request :url_encoded
+        builder.response :logger, @logger, bodies: true if @logger
+        builder.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/portmone/responses/base_response.rb

@@ -0,0 +1,15 @@
+class Portmone::Responses::BaseResponse
+  attr_reader :response
+  attr_reader :xml_data
+
+  def initialize(faraday_response, currency:, timezone:)
+    @response = faraday_response
+    @xml_data = MultiXml.parse(@response.body)
+    @currency = currency
+    @timezone = timezone
+  end
+
+  def http_status
+    response.status
+  end
+end

data/lib/portmone/responses/generate_url.rb

@@ -0,0 +1,9 @@
+class Portmone::Responses::GenerateURL < Portmone::Responses::BaseResponse
+  def success?
+    location.present? && http_status == 302
+  end
+
+  def location
+    response.headers['location']
+  end
+end

data/lib/portmone/responses/order_status.rb

@@ -0,0 +1,77 @@
+class Portmone::Responses::OrderStatus < Portmone::Responses::BaseResponse
+  #
+  # статусы:
+  # CREATED - клиент перешел на страницу 3Ds
+  # PREAUTH - деньги успешно заблокированы на счету
+  # PAYED - деньги списаны
+  # REJECTED - платеж не удалось провести или отмена авторизации
+  # RETURN - успешный возврат
+  #
+ 
+  %i(bill_date
+     pay_time
+     pay_order_time
+     order_id
+     shop_order_number
+     description
+     auth_code
+     status
+     error_code
+     error_message).each do |key|
+
+    define_method(key) do
+      order.send key
+    end
+  end
+
+  def amount
+    transactions.select(&:paid?)
+                .map { |t| t.bill_amount }
+                .inject(:+) || transactions.first.bill_amount
+  end
+
+  def reversed_amount
+    transactions.select(&:reversed?)
+                .map { |t| t.bill_amount }
+                .inject(:+) || 0
+  end
+
+  def actual_amount
+    amount + reversed_amount
+  end
+
+  # статусы "оплачено" и "авторизовано"
+  def paid?
+    transactions.any?(&:paid?)
+  end
+
+  def reversed?
+    transactions.any?(&:reversed?)
+  end
+
+  def success?
+    order.present? && error_code == '0'
+  end
+
+  def transactions
+    @transactions ||= begin
+      data.map do |h|
+        Portmone::Transaction.new(h.merge(timezone: @timezone, currency: @currency))
+      end
+    end
+  end
+
+  def order
+    @order ||= begin
+      data.any? && Portmone::Transaction.new(data.first.merge(data.last).merge(timezone: @timezone, currency: @currency))
+    end
+  end
+
+private
+
+  def data
+    data = @xml_data.dig('portmoneresult', 'orders', 'order') || @xml_data.dig('portmoneresult', 'order') || {}
+    data = [data] unless data.is_a?(Array) # cannot use Array() on Hash
+    data
+  end
+end

data/lib/portmone/transaction.rb

@@ -0,0 +1,53 @@
+module Portmone
+  class Transaction
+    attr_reader :data
+
+    def initialize(data)
+      raise Error, "Wrong data: Hash expected, got #{data.inspect}" unless data.is_a?(Hash)
+
+      @timezone = data.delete(:timezone)
+      @currency = data.delete(:currency)
+      @data = data
+    end
+
+    def bill_date
+      Date.parse(data['bill_date'])
+    end
+
+    def pay_time
+      ActiveSupport::TimeZone[@timezone].parse(data['pay_date'])
+    end
+
+    def pay_order_time
+      ActiveSupport::TimeZone[@timezone].parse(data['pay_order_date']) rescue nil
+    end
+
+    def bill_amount
+      Money.from_amount(data['bill_amount'].to_f, @currency)
+    end
+
+    def order_id
+      data.dig('shop_bill_id')
+    end
+
+    def paid?
+      status == 'PAYED' || status == 'PREAUTH'
+    end
+
+    def reversed?
+      status == 'RETURN'
+    end
+
+    %i(shop_order_number
+       description
+       auth_code
+       status
+       error_code
+       error_message).each do |key|
+
+      define_method(key) do
+        data.dig(key.to_s)
+      end
+    end
+  end
+end

data/lib/portmone/version.rb

@@ -0,0 +1,3 @@
+module Portmone
+  VERSION = '0.0.1'
+end

data/lib/portmone.rb

@@ -0,0 +1,16 @@
+module Portmone
+  module Responses
+  end
+end
+require 'active_support/time'
+require 'faraday'
+require 'money'
+require 'multi_xml'
+require 'logger'
+require 'portmone/version'
+require 'portmone/transaction'
+require 'portmone/responses/base_response'
+require 'portmone/responses/generate_url'
+require 'portmone/responses/order_status'
+require 'portmone/responses/refund_order_status'
+require 'portmone/client'

data/portmone.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'portmone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'portmone'
+  spec.version       = Portmone::VERSION
+  spec.authors       = ['Alexander Sviridov']
+  spec.email         = ['alexander.sviridiv@gmail.com']
+
+  spec.summary       = 'Ruby wrapper for Portmone payment system API'
+  spec.description   = 'Ruby wrapper for Portmone payment system API'
+  spec.homepage      = 'https://github.com/busfor/portmone'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'money', '~> 6.0'
+  spec.add_dependency 'multi_xml', '~> 0.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.51'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: portmone
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Sviridov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby wrapper for Portmone payment system API
+email:
+- alexander.sviridiv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- lib/portmone.rb
+- lib/portmone/client.rb
+- lib/portmone/responses/base_response.rb
+- lib/portmone/responses/generate_url.rb
+- lib/portmone/responses/order_status.rb
+- lib/portmone/transaction.rb
+- lib/portmone/version.rb
+- portmone.gemspec
+homepage: https://github.com/busfor/portmone
+licenses:
+- MIT
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Portmone payment system API
+test_files: []