wayforpay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac203bf9298139ac2be3e1cef08eba76fed5bcb5
+  data.tar.gz: b979a161c53384bd04be7c0b6fa80e2671962d89
+SHA512:
+  metadata.gz: 5ddeae517f34a156ce8f9f7e9df02591270f4da7e889a194aeaf504e3bb872573f08ccb9aaabc16e1095c8ba0bcfefbaf54d0d17698a67e50aaef7eabd846040
+  data.tar.gz: b47f777278907c63dd370acf4880cbefbab53b325d6d71b01286dfd90f72f174915e80511ef199091be2739c1a0b9db108c6e19576a60558b0041f1fa929ef59

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/README.md

@@ -0,0 +1,25 @@
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'wayforpay'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wayforpay
+
+## Usage
+
+TODO: Write usage instructions
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/wayforpay.rb

@@ -0,0 +1,26 @@
+require_relative 'wayforpay/constants'
+require_relative 'wayforpay/encrypt_field'
+require_relative 'wayforpay/payments'
+require_relative 'wayforpay/request'
+require_relative 'wayforpay/util/configuration'
+
+module Wayforpay
+  extend SingleForwardable
+
+  def_delegators :configuration, :merchant_account,
+                 :merchant_domain_name, :encrypt_secret_key
+
+  # Pre-configure with merchant_account, merchant_domain_name
+  # and encrypt_secret_key.
+  def self.configure(&block)
+    yield configuration
+  end
+
+  private
+
+  ##
+  # Returns an existing or instantiates a new configuration object.
+  def self.configuration
+    @configuration ||= Util::Configuration.new
+  end
+end

data/lib/wayforpay/constants.rb

@@ -0,0 +1,42 @@
+module Wayforpay
+  module Constants
+    URL = URI.parse('https://api.wayforpay.com/api').freeze
+
+    HOLD_ENCRYPT_FIELDS = %i[merchantAccount merchantDomainName orderReference orderDate amount currency productName productCount productPrice].freeze
+    REFUND_ENCRYPT_FIELDS = %i[merchantAccount orderReference amount currency].freeze
+    SETTLE_ENCRYPT_FIELDS = %i[merchantAccount orderReference amount currency].freeze
+
+    HOLD_ATTRS = {
+      transactionType: 'CHARGE',
+      authorizationType: 'SimpleSignature',
+      merchantTransactionType: 'AUTH',
+      merchantTransactionSecureType: 'NON3DS',
+      apiVersion: 1
+    }.freeze
+
+    REFUND_ATTRS = {
+      transactionType: 'REFUND',
+      apiVersion: 1
+    }.freeze
+
+    SETTLE_ATTRS = {
+      transactionType: 'SETTLE',
+      apiVersion: 1
+    }.freeze
+
+    def self.hold_params
+      HOLD_ATTRS.merge(
+        merchantAccount: Wayforpay.merchant_account,
+        merchantDomainName: Wayforpay.merchant_domain_name,
+      )
+    end
+
+    def self.refund_params
+      REFUND_ATTRS.merge(merchantAccount: Wayforpay.merchant_account)
+    end
+
+    def self.settle_params
+      SETTLE_ATTRS.merge(merchantAccount: Wayforpay.merchant_account)
+    end
+  end
+end

data/lib/wayforpay/encrypt_field.rb

@@ -0,0 +1,23 @@
+require 'openssl'
+
+module Wayforpay
+  class EncryptField
+    attr_reader :keys, :attrs
+
+    def initialize(keys, attrs)
+      @keys, @attrs = keys, attrs
+    end
+
+    def self.call(keys, attrs = {})
+      new(keys, attrs).call
+    end
+
+    def call
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('md5'), Wayforpay.encrypt_secret_key, signature_string)
+    end
+
+    def signature_string
+      attrs.values_at(*keys).compact.join(';')
+    end
+  end
+end

data/lib/wayforpay/payments.rb

@@ -0,0 +1,23 @@
+module Wayforpay
+  module Payments
+    # required attrs: orderReference, amount, currency, orderDate,
+    # productName[], productPrice[], productCount[],
+    # (card + expMonth + expYear + cardCvv + cardHolder) or recToken
+    def self.hold(attrs = {})
+      request_params = Constants.hold_params.merge(attrs)
+      Wayforpay::Request.(Constants::HOLD_ENCRYPT_FIELDS, request_params)
+    end
+
+    # required attrs: orderReference, amount, currency, comment
+    def self.refund(attrs = {})
+      request_params = Constants.refund_params.merge(attrs)
+      Wayforpay::Request.(Constants::REFUND_ENCRYPT_FIELDS, request_params)
+    end
+
+    # required attrs: orderReference, amount, currency
+    def self.settle(attrs = {})
+      request_params = Constants.settle_params.merge(attrs)
+      Wayforpay::Request.(Constants::SETTLE_ENCRYPT_FIELDS, request_params)
+    end
+  end
+end

data/lib/wayforpay/request.rb

@@ -0,0 +1,11 @@
+require 'json'
+require 'net/http'
+
+module Wayforpay
+  class Request
+    def self.call(encrypted_fields, request_attrs)
+      request_attrs[:merchantSignature] = EncryptField.(encrypted_fields, request_attrs)
+      Net::HTTP.post(Constants::URL, request_attrs.to_json)
+    end
+  end
+end

data/lib/wayforpay/util/configuration.rb

@@ -0,0 +1,19 @@
+module Wayforpay
+  module Util
+    class Configuration
+      attr_accessor :merchant_account, :merchant_domain_name, :encrypt_secret_key
+
+      def merchant_account=(value)
+        @merchant_account = value
+      end
+
+      def merchant_domain_name=(value)
+        @merchant_domain_name = value
+      end
+
+      def encrypt_secret_key=(value)
+        @encrypt_secret_key = value
+      end
+    end
+  end
+end

data/lib/wayforpay/version.rb

@@ -0,0 +1,3 @@
+module Wayforpay
+  VERSION = '0.1.0'.freeze
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler.setup
+
+require 'wayforpay'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    WebMock.disable_net_connect!
+  end
+
+  config.after(:suite) do
+    WebMock.allow_net_connect!
+  end
+end

data/spec/wayforpay/encrypt_field_spec.rb

@@ -0,0 +1,152 @@
+describe Wayforpay::EncryptField do
+  before do
+    Wayforpay.configure do |config|
+      config.merchant_account = 'merchantAccount'
+      config.merchant_domain_name = 'merchantDomainName'
+      config.encrypt_secret_key = 'secretKey'
+    end
+  end
+
+  describe '.initialize' do
+    let(:keys) { [:amount] }
+    let(:attrs) { { amount: 123, currency: 'UAH' } }
+
+    subject { described_class.new(keys, attrs) }
+
+    it { expect(subject.keys).to eq keys }
+    it { expect(subject.attrs).to eq attrs }
+  end
+
+  describe '.call' do
+    let(:keys) { [:amount] }
+    let(:attrs) { { amount: 1 } }
+    let(:encrypt_field) { described_class.new(keys, attrs) }
+
+    it "receives 'new' method for Wayforpay::EncryptField" do
+      expect(described_class).to receive(:new).with(keys, attrs)
+        .and_return(encrypt_field).once
+      described_class.call(keys, attrs)
+    end
+
+    it "receives 'call' method for any instance of Wayforpay::EncryptField" do
+      expect_any_instance_of(described_class).to receive(:call).once
+      described_class.call(keys, attrs)
+    end
+  end
+
+  describe '#call' do
+    subject { described_class.new(keys, attrs).call }
+
+    context 'in case params are HOLD_ENCRYPT_FIELDS and HOLD_ATTRS' do
+      let(:keys) { Wayforpay::Constants::HOLD_ENCRYPT_FIELDS }
+      let(:attrs) do
+        Wayforpay::Constants.hold_params.merge({
+          orderReference: 'new_order',
+          amount: 1,
+          currency: 'UAH',
+          orderDate: 1514214411,
+          productName: ['TRIP'],
+          productPrice: [123],
+          productCount: [1],
+          recToken: 'recToken'
+        })
+      end
+
+      it { is_expected.to eq '69306842abfb5424508a96674aa7bbaf' }
+    end
+
+    context 'in case params are REFUND_ENCRYPT_FIELDS and REFUND_ATTRS' do
+      let(:keys) { Wayforpay::Constants::REFUND_ENCRYPT_FIELDS }
+      let(:attrs) do
+        Wayforpay::Constants.refund_params.merge({
+          orderReference: 'new_order',
+          amount: 2,
+          currency: 'UAH',
+          comment: 'Cancellation of a trip'
+        })
+      end
+
+      it { is_expected.to eq '41b79af1557e7e84531e2e015f412ce1' }
+    end
+
+    context 'in case params are SETTLE_ENCRYPT_FIELDS and SETTLE_ATTRS' do
+      let(:keys) { Wayforpay::Constants::SETTLE_ENCRYPT_FIELDS }
+      let(:attrs) do
+        Wayforpay::Constants.settle_params.merge({
+          orderReference: 'new_order',
+          amount: 3,
+          currency: 'UAH'
+        })
+      end
+
+      it { is_expected.to eq 'ba9a61da321d53b6a94dadeabf24eccf' }
+    end
+  end
+
+  describe '#signature_string' do
+    subject { described_class.new(keys, attrs).signature_string }
+
+    context 'in case params are HOLD_ENCRYPT_FIELDS and HOLD_ATTRS' do
+      let(:keys) { Wayforpay::Constants::HOLD_ENCRYPT_FIELDS }
+      let(:attrs) do
+        Wayforpay::Constants.hold_params.merge({
+          orderReference: 'new_order',
+          amount: 1,
+          currency: 'UAH',
+          orderDate: 1514214411,
+          productName: ['TRIP'],
+          productPrice: [123, 987],
+          productCount: [2],
+          recToken: 'recToken'
+        })
+      end
+
+      it { is_expected.to eq 'merchantAccount;merchantDomainName;new_order;1514214411;1;UAH;TRIP;2;123;987' }
+
+      context 'in case any required fields are missing' do
+        before { attrs.delete(:orderDate) }
+
+        it { is_expected.to eq 'merchantAccount;merchantDomainName;new_order;1;UAH;TRIP;2;123;987' }
+      end
+    end
+
+    context 'in case params are REFUND_ENCRYPT_FIELDS and REFUND_ATTRS' do
+      let(:keys) { Wayforpay::Constants::REFUND_ENCRYPT_FIELDS }
+      let(:attrs) do
+        Wayforpay::Constants.refund_params.merge({
+          orderReference: 'new_order',
+          amount: 2,
+          currency: 'UAH',
+          comment: 'Cancellation of a trip'
+        })
+      end
+
+      it { is_expected.to eq 'merchantAccount;new_order;2;UAH' }
+
+      context 'in case any required fields are missing' do
+        before { attrs.delete(:amount) }
+
+        it { is_expected.to eq 'merchantAccount;new_order;UAH' }
+      end
+    end
+
+    context 'in case params are SETTLE_ENCRYPT_FIELDS and SETTLE_ATTRS' do
+      let(:keys) { Wayforpay::Constants::SETTLE_ENCRYPT_FIELDS }
+      let(:attrs) do
+        Wayforpay::Constants.settle_params.merge({
+          orderReference: 'new_order',
+          amount: 3,
+          currency: 'UAH'
+        })
+      end
+
+      it { is_expected.to eq 'merchantAccount;new_order;3;UAH' }
+
+      context 'in case any required fields are missing' do
+        before { attrs.delete(:orderReference) }
+
+        it { is_expected.to eq 'merchantAccount;3;UAH' }
+      end
+    end
+  end
+end

data/spec/wayforpay/payments_spec.rb

@@ -0,0 +1,67 @@
+describe Wayforpay::Payments do
+  context '.hold' do
+    let(:attrs) do
+      {
+        orderReference: 'new_order',
+        amount: 123,
+        currency: 'UAH',
+        orderDate: 1514214411,
+        productName: ['TRIP'],
+        productPrice: [123],
+        productCount: [1],
+        recToken: 'recToken'
+      }
+    end
+    let(:request_params) do
+      Wayforpay::Constants.hold_params.merge(attrs)
+    end
+    let(:encrypt_fields) { Wayforpay::Constants::HOLD_ENCRYPT_FIELDS }
+
+    it "receives 'call' method for Wayforpay::Request" do
+      expect(Wayforpay::Request).to receive(:call)
+        .with(encrypt_fields, request_params).once
+      described_class.hold(attrs)
+    end
+  end
+
+  context '.refund' do
+    let(:attrs) do
+      {
+        orderReference: 'new_order',
+        amount: 123,
+        currency: 'UAH',
+        comment: 'Cancellation of a trip'
+      }
+    end
+    let(:request_params) do
+      Wayforpay::Constants.refund_params.merge(attrs)
+    end
+    let(:encrypt_fields) { Wayforpay::Constants::REFUND_ENCRYPT_FIELDS }
+
+    it "receives 'call' method for Wayforpay::Request" do
+      expect(Wayforpay::Request).to receive(:call)
+        .with(encrypt_fields, request_params).once
+      described_class.refund(attrs)
+    end
+  end
+
+  context '.settle' do
+    let(:attrs) do
+      {
+        orderReference: 'new_order',
+        amount: 123,
+        currency: 'UAH',
+      }
+    end
+    let(:request_params) do
+      Wayforpay::Constants.settle_params.merge(attrs)
+    end
+    let(:encrypt_fields) { Wayforpay::Constants::SETTLE_ENCRYPT_FIELDS }
+
+    it "receives 'call' method for Wayforpay::Request" do
+      expect(Wayforpay::Request).to receive(:call)
+        .with(encrypt_fields, request_params).once
+      described_class.settle(attrs)
+    end
+  end
+end

data/spec/wayforpay/request_spec.rb

@@ -0,0 +1,78 @@
+describe Wayforpay::Request do
+  before do
+    Wayforpay.configure do |config|
+      config.merchant_account = 'merchantAccount'
+      config.merchant_domain_name = 'merchantDomainName'
+      config.encrypt_secret_key = 'secretKey'
+    end
+  end
+
+  let(:url) { Wayforpay::Constants::URL }
+
+  context '.call' do
+    let(:merchant_signature) { Wayforpay::EncryptField.(encrypt_fields, request_attrs) }
+    let(:encrypted_attrs) { request_attrs.merge(merchantSignature: merchant_signature) }
+
+    subject { described_class.call(encrypt_fields, request_attrs) }
+
+    context "hold params" do
+      let(:attrs) do
+        {
+          orderReference: 'new_order',
+          amount: 123,
+          currency: 'UAH',
+          orderDate: 1514214411,
+          productName: ['TRIP'],
+          productPrice: [123],
+          productCount: [1],
+          recToken: 'recToken'
+        }
+      end
+      let(:encrypt_fields) { Wayforpay::Constants::HOLD_ENCRYPT_FIELDS }
+      let(:request_attrs) { Wayforpay::Constants.hold_params.merge(attrs) }
+
+      it "receives 'post' method for Net::HTTP" do
+        expect(Net::HTTP).to receive(:post)
+          .with(url, encrypted_attrs.to_json).once
+        subject
+      end
+    end
+
+    context "refund params" do
+      let(:attrs) do
+        {
+          orderReference: 'new_order',
+          amount: 123,
+          currency: 'UAH',
+          comment: 'Cancellation of a trip'
+        }
+      end
+      let(:encrypt_fields) { Wayforpay::Constants::REFUND_ENCRYPT_FIELDS }
+      let(:request_attrs) { Wayforpay::Constants.refund_params.merge(attrs) }
+
+      it "receives 'post' method for Net::HTTP" do
+        expect(Net::HTTP).to receive(:post)
+          .with(url, encrypted_attrs.to_json).once
+        subject
+      end
+    end
+
+    context "settle params" do
+      let(:attrs) do
+        {
+          orderReference: 'new_order',
+          amount: 123,
+          currency: 'UAH',
+        }
+      end
+      let(:encrypt_fields) { Wayforpay::Constants::SETTLE_ENCRYPT_FIELDS }
+      let(:request_attrs) { Wayforpay::Constants.settle_params.merge(attrs) }
+
+      it "receives 'post' method for Net::HTTP" do
+        expect(Net::HTTP).to receive(:post)
+          .with(url, encrypted_attrs.to_json).once
+        subject
+      end
+    end
+  end
+end

data/spec/wayforpay/util/configuration_spec.rb

@@ -0,0 +1,16 @@
+describe Wayforpay::Util::Configuration do
+  let(:config) { described_class.new }
+  let(:merchant_account) { 'merchantAccount' }
+  let(:merchant_domain_name) { 'merchantDomainName' }
+  let(:encrypt_secret_key) { 'secretKey' }
+
+  before do
+    config.merchant_account = merchant_account
+    config.merchant_domain_name = merchant_domain_name
+    config.encrypt_secret_key = encrypt_secret_key
+  end
+
+  it { expect(config.merchant_account).to eq(merchant_account) }
+  it { expect(config.merchant_domain_name).to eq(merchant_domain_name) }
+  it { expect(config.encrypt_secret_key).to eq(encrypt_secret_key) }
+end

data/spec/wayforpay_spec.rb

@@ -0,0 +1,25 @@
+describe Wayforpay do
+  subject { described_class }
+
+  describe '.configure' do
+    let(:merchant_account) { 'merchantAccount' }
+    let(:merchant_domain_name) { 'merchantDomainName' }
+    let(:encrypt_secret_key) { 'secretKey' }
+
+    before do
+      subject.configure do |config|
+        config.merchant_account = merchant_account
+        config.merchant_domain_name = merchant_domain_name
+        config.encrypt_secret_key = encrypt_secret_key
+      end
+    end
+
+    after do
+      subject.instance_variable_set('@configuration', nil)
+    end
+
+    it { expect(subject.merchant_account).to eq(merchant_account) }
+    it { expect(subject.merchant_domain_name).to eq(merchant_domain_name) }
+    it { expect(subject.encrypt_secret_key).to eq(encrypt_secret_key) }
+  end
+end

data/wayforpay.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/wayforpay/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'wayforpay'
+  s.version       = Wayforpay::VERSION
+  s.authors       = ['Serhii Savenko','Yaroslav Tupitskyi']
+  s.email         = ['yarik@active-bridge.com']
+  s.homepage      = 'https://github.com/activebridge/wayforpay'
+  s.summary       = %q{Wayforpay API}
+  s.description   = %q{Wayforpay API}
+  s.platform      = Gem::Platform::RUBY
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_path  = 'lib'
+
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_dependency 'builder', '>= 2.1.2'
+
+  {
+    'rake'    => '~> 0.8.7',
+    'rspec'   => '~> 2.12',
+    'webmock' => '~> 1.6.2'
+  }.each { |l, v| s. add_development_dependency l, v }
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: wayforpay
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Serhii Savenko
+- Yaroslav Tupitskyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+description: Wayforpay API
+email:
+- yarik@active-bridge.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- lib/wayforpay.rb
+- lib/wayforpay/constants.rb
+- lib/wayforpay/encrypt_field.rb
+- lib/wayforpay/payments.rb
+- lib/wayforpay/request.rb
+- lib/wayforpay/util/configuration.rb
+- lib/wayforpay/version.rb
+- spec/spec_helper.rb
+- spec/wayforpay/encrypt_field_spec.rb
+- spec/wayforpay/payments_spec.rb
+- spec/wayforpay/request_spec.rb
+- spec/wayforpay/util/configuration_spec.rb
+- spec/wayforpay_spec.rb
+- wayforpay.gemspec
+homepage: https://github.com/activebridge/wayforpay
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Wayforpay API
+test_files:
+- spec/spec_helper.rb
+- spec/wayforpay/encrypt_field_spec.rb
+- spec/wayforpay/payments_spec.rb
+- spec/wayforpay/request_spec.rb
+- spec/wayforpay/util/configuration_spec.rb
+- spec/wayforpay_spec.rb