payler_api 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eafdccb9c2be29e781e93d0e2a3e728a4e025796
+  data.tar.gz: 6089bd306ef2017352e8d4fea8099b81ee034a1b
+SHA512:
+  metadata.gz: 1aa53dd3a697814951b0a57c0e5b4305f1527b64e5d2d4f640b86ce092ec9c670e64493df6432074a1bb1cdd8d0f22f452f468a4e256714f77b0bb866a48d5c7
+  data.tar.gz: 8ece9e3570efc7227b8c1608cf37fc7434a0867fe9724795a35dbb2085c396675822ebbde79f1a7cb7dc57f2d0d07f30227e958384da58b40870f14b4c1aa0a5

data/README.md

@@ -0,0 +1,41 @@
+# PaylerAPI
+---
+Simple ruby wrapper for [Payler Merchant API](http://payler.com/docs/acquiring_docs/)
+
+## Install
+
+      echo 'gem "payler_api"' >> Gemfile
+      # or
+      gem install payler_api
+
+## PaylerAPI setup
+
+      $ cat config/initializers/payler_api.rb:
+
+      PaylerAPI.configure do |config|
+        config.access_key = 'ACCESS_KEY'
+      end
+
+## PaylerAPI example usage:
+
+      response = PaylerAPI.pay amount: 10000,
+                               order_id: 'order_uniq_id',
+                               card_number: '5555555555555599',
+                               expired_year: '19',
+                               expired_month: '12',
+                               secure_code: '123'
+
+      response               # => return PaylerAPI::Response instanse
+      response.ok?           # => return true if request is successed and payment charged
+      response.success?      # => alias to :ok?
+
+      response.error?        # => return true if have errors
+      response.error_code    # => Payler error code
+      response.error_message # => Payler error message
+
+      response.data          # => all response data
+
+## Another examples
+
+      PaylerAPI.get_status order_id: 'some_uniq_order' # => return PaylerAPI::Response with order data
+      ...

data/lib/payler_api/request.rb

@@ -0,0 +1,39 @@
+require 'httparty'
+
+# class for request processing
+#
+module PaylerAPI
+  class Request
+    include HTTParty
+    attr_accessor :method, :params, :response
+
+    def initialize method, params
+      self.class.base_uri "https://#{config.host}.payler.com/mapi"
+      @method, @params = [method, params.merge(key: config.access_key)]
+      @params.merge!(password: config.password) if protected_method?
+    end
+
+    def process
+      self.response = Response.new \
+      self.class.post camel_case_url_path, query: params, headers: headers
+    end
+
+    def protected_method?
+      [:refund, :charge, :retrieve].include? method
+    end
+
+    private
+
+      def config; PaylerAPI.configuration; end
+
+      def headers
+        {'Content-Type' => 'application/x-www-form-urlencoded'}
+      end
+
+      def camel_case_url_path
+        '/'+method.to_s.split('_').collect(&:capitalize).join
+      end
+
+  end
+
+end

data/lib/payler_api/response.rb

@@ -0,0 +1,41 @@
+# class for response
+#
+module PaylerAPI
+  class Response
+    attr_reader :data
+
+    def initialize httparty_response
+      @data = httparty_response.parsed_response
+    #rescue
+      #@data = { 'error' => { 'code' => 0, 'message' => 'unknown' } }
+    end
+
+    def ok?
+      data['order_id'] && !error?
+    end
+    alias_method :success?, :ok?
+
+    def three_ds?
+      data['auth_type'] == 1
+    end
+
+    def error?
+      data.has_key? 'error'
+    end
+
+    def error_code
+      data['error']['code'] if error?
+    end
+
+    def duplicate_order_id?
+      error? && error_code == 3
+    end
+
+    def error_message
+      data['error']['message'] if error?
+    end
+    alias_method :message, :error_message
+
+  end
+
+end

data/lib/payler_api.rb

@@ -0,0 +1,31 @@
+require 'payler_api/response'
+require 'payler_api/request'
+
+module PaylerAPI
+  AvailableMethods = [:pay, :block, :charge, :refund, :retrieve, :get_status]
+
+  def self.method_missing(method, *arguments, &block)
+    return super unless AvailableMethods.include? method
+
+    PaylerAPI::Request.new(method, *arguments).process
+  end
+
+  # self.configure method
+  #   for setup :access_key
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      @configuration ||= Configuration.new
+      yield(@configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :access_key, :host, :password
+
+    def initialize
+      @access_key, @host, @password = ['']*3
+    end
+  end
+end

data/payler_api.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name          = 'payler_api'
+  s.version       = '0.0.4'
+  s.date          = '2016-01-26'
+  s.description   = 'Simple ruby wrapper for payler merchant api'
+  s.summary       = 'Payler Merchant API Wrapper'
+  s.homepage      = 'https://github.com/sletix/payler_api'
+  s.license       = 'MIT'
+  s.authors       = ['Oleg Artamonov']
+  s.email         = 'oleg@artamonov.ru'
+
+  s.files         = Dir['{lib/**/*,test/**/*}'] + %w(payler_api.gemspec README.md)
+  s.test_files    = Dir['test/*_spec.rb']
+
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'httparty', '~> 0.13'
+  s.add_development_dependency 'minitest', '~> 5.8'
+  s.add_development_dependency 'vcr', '~> 3.0'
+  s.add_development_dependency 'webmock', '~> 1.22'
+  s.add_development_dependency 'rake', '~> 10.4'
+end

data/test/cassettes/test_0001_should_blocks_the_specified_amount_card.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://host.payler.com/mapi/Block?amount=30000&card_number=5555555555555599&expired_month=12&expired_year=19&key=test-key&order_id=test_block_order_05&secure_code=123
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 25 Jan 2016 21:23:23 GMT
+      Content-Type:
+      - text/json; charset=utf-8
+      Content-Length:
+      - '80'
+      Connection:
+      - keep-alive
+      Content-Security-Policy:
+      - frame-ancestors 'none'
+      X-Frame-Options:
+      - deny
+      Strict-Transport-Security:
+      - max-age=31536000;
+    body:
+      encoding: UTF-8
+      string: "{\r\n  \"auth_type\": 0,\r\n  \"amount\": 30000,\r\n  \"order_id\":
+        \"test_block_order_05\"\r\n}"
+    http_version: 
+  recorded_at: Mon, 25 Jan 2016 21:23:23 GMT
+recorded_with: VCR 3.0.1

data/test/cassettes/test_0001_should_charge_blocked_order.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://host.payler.com/mapi/Charge?amount=30000&card_number=5555555555555599&expired_month=12&expired_year=19&key=test-key&order_id=test_block_order_05&password=123&secure_code=123
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 25 Jan 2016 21:23:24 GMT
+      Content-Type:
+      - text/json; charset=utf-8
+      Content-Length:
+      - '61'
+      Connection:
+      - keep-alive
+      Content-Security-Policy:
+      - frame-ancestors 'none'
+      X-Frame-Options:
+      - deny
+      Strict-Transport-Security:
+      - max-age=31536000;
+    body:
+      encoding: UTF-8
+      string: "{\r\n  \"amount\": 30000,\r\n  \"order_id\": \"test_block_order_05\"\r\n}"
+    http_version: 
+  recorded_at: Mon, 25 Jan 2016 21:23:24 GMT
+recorded_with: VCR 3.0.1

data/test/cassettes/test_0001_should_return_data_by_order_id.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://host.payler.com/mapi/GetStatus?key=test-key&order_id=test_pay_order_01
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 25 Jan 2016 14:10:43 GMT
+      Content-Type:
+      - text/json; charset=utf-8
+      Content-Length:
+      - '110'
+      Connection:
+      - keep-alive
+      Content-Security-Policy:
+      - frame-ancestors 'none'
+      X-Frame-Options:
+      - deny
+      Strict-Transport-Security:
+      - max-age=31536000;
+    body:
+      encoding: UTF-8
+      string: "{\r\n  \"status\": \"Charged\",\r\n  \"amount\": 30000,\r\n  \"payment_type\":
+        \"Card\",\r\n  \"order_id\": \"test_pay_order_01\"\r\n}"
+    http_version: 
+  recorded_at: Mon, 25 Jan 2016 14:10:43 GMT
+recorded_with: VCR 3.0.1

data/test/cassettes/test_0001_should_send_true_request.yml

@@ -0,0 +1,39 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://host.payler.com/mapi/Pay?amount=30000&card_number=5555555555555599&expired_month=12&expired_year=19&key=test-key&order_id=test_pay_order_01&secure_code=123
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 25 Jan 2016 14:09:19 GMT
+      Content-Type:
+      - text/json; charset=utf-8
+      Content-Length:
+      - '78'
+      Connection:
+      - keep-alive
+      Content-Security-Policy:
+      - frame-ancestors 'none'
+      X-Frame-Options:
+      - deny
+      Strict-Transport-Security:
+      - max-age=31536000;
+    body:
+      encoding: UTF-8
+      string: "{\r\n  \"auth_type\": 0,\r\n  \"amount\": 30000,\r\n  \"order_id\":
+        \"test_pay_order_01\"\r\n}"
+    http_version: 
+  recorded_at: Mon, 25 Jan 2016 14:09:19 GMT
+recorded_with: VCR 3.0.1

data/test/cassettes/test_0002_should_return_duplicate_order_id_error.yml

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://host.payler.com/mapi/Pay?amount=30000&card_number=5555555555555599&expired_month=12&expired_year=19&key=test-key&order_id=test_pay_order_01&secure_code=123
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 25 Jan 2016 14:19:21 GMT
+      Content-Type:
+      - text/json; charset=utf-8
+      Content-Length:
+      - '164'
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        ew0KICAiZXJyb3IiOiB7DQogICAgImNvZGUiOiAzLA0KICAgICJtZXNzYWdl
+        IjogItCg0LDQvdC10LUg0YHQvtC30LTQsNC9INC30LDQutCw0Lcg0YEg0YPQ
+        utCw0LfQsNC90L3Ri9C8INC40LTQtdC90YLQuNGE0LjQutCw0YLQvtGA0L7Q
+        vDogdGVzdF9wYXlfb3JkZXJfMDEiDQogIH0NCn0=
+    http_version: 
+  recorded_at: Mon, 25 Jan 2016 14:19:21 GMT
+recorded_with: VCR 3.0.1

data/test/cassettes/test_0002_should_return_error_by_wrong_order_id.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://host.payler.com/mapi/GetStatus?key=test-key&order_id=incorrect_order
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 500
+      message: Internal Server Error
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 25 Jan 2016 14:16:24 GMT
+      Content-Type:
+      - text/json; charset=utf-8
+      Content-Length:
+      - '156'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-store, no-cache
+      Pragma:
+      - no-cache
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        ew0KICAiZXJyb3IiOiB7DQogICAgImNvZGUiOiA5LA0KICAgICJtZXNzYWdl
+        IjogItCd0LUg0L3QsNC50LTQtdC9INC30LDQutCw0Lcg0YEg0YPQutCw0LfQ
+        sNC90L3Ri9C8INC40LTQtdC90YLQuNGE0LjQutCw0YLQvtGA0L7QvDogaW5j
+        b3JyZWN0X29yZGVyIg0KICB9DQp9
+    http_version: 
+  recorded_at: Mon, 25 Jan 2016 14:16:24 GMT
+recorded_with: VCR 3.0.1

data/test/helper.rb

@@ -0,0 +1,15 @@
+require 'minitest/autorun'
+require 'securerandom'
+require 'vcr'
+require 'payler_api'
+
+PaylerAPI.configure do |c|
+  c.access_key = 'test-key'
+  c.password   = '123'
+  c.host       = 'host'
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = "#{__dir__}/cassettes"
+  c.hook_into :webmock
+end

data/test/spec_payler_api.rb

@@ -0,0 +1,78 @@
+require "#{__dir__}/helper.rb"
+
+describe 'PaylerAPI' do
+  subject { PaylerAPI }
+  before  { VCR.insert_cassette name }
+  after   { VCR.eject_cassette }
+  let(:card_params) { { card_number: '5555555555555599',
+                        expired_year: '19',
+                        expired_month: '12',
+                        secure_code: '123' } }
+
+  describe '#pay' do
+    let :params do
+      card_params.merge order_id: 'test_pay_order_01',
+                        amount: '30000'
+    end
+
+    it 'should send true request' do
+      subject.pay(params).ok?.must_equal true
+    end
+
+    it 'should return duplicate order_id error' do
+      subject.pay(params).duplicate_order_id?.must_equal true
+    end
+  end
+
+  describe 'block-charge' do
+    let :params do
+      { order_id: 'test_block_order_05',
+        amount: '30000' }.merge(card_params)
+    end
+
+    describe '#block' do
+      it 'should blocks the specified amount card' do
+        subject.block(params).ok?.must_equal true
+      end
+    end
+
+    describe '#charge' do
+      it 'should charge blocked order' do
+        subject.charge(params).ok?.must_equal true
+      end
+    end
+
+    #describe '#refund' do
+      #it 'should refund order' do
+        #subject.charge(params).ok?.must_equal true
+      #end
+    #end
+  end
+
+
+  describe '#get_status' do
+    it 'should return data by order_id' do
+      resp = subject.get_status order_id: 'test_pay_order_01'
+      resp.ok?.must_equal true
+      resp.data["amount"].must_equal 30000
+    end
+
+    it 'should return error by wrong order_id' do
+      resp = subject.get_status order_id: 'incorrect_order'
+      resp.error?.must_equal true
+    end
+  end
+
+  # TODO:
+  #describe('#refund', '#retrieve)
+
+  describe '#configure' do
+    before { PaylerAPI.configure {|config| config.access_key = 'foo-bar' } }
+    after  { PaylerAPI.configuration.access_key = 'test-key' } #revert key
+
+    it 'should setup new access_key' do
+      PaylerAPI.configuration.access_key.must_equal 'foo-bar'
+    end
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: payler_api
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Oleg Artamonov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: Simple ruby wrapper for payler merchant api
+email: oleg@artamonov.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/payler_api.rb
+- lib/payler_api/request.rb
+- lib/payler_api/response.rb
+- payler_api.gemspec
+- test/cassettes/test_0001_should_blocks_the_specified_amount_card.yml
+- test/cassettes/test_0001_should_charge_blocked_order.yml
+- test/cassettes/test_0001_should_return_data_by_order_id.yml
+- test/cassettes/test_0001_should_send_true_request.yml
+- test/cassettes/test_0002_should_return_duplicate_order_id_error.yml
+- test/cassettes/test_0002_should_return_error_by_wrong_order_id.yml
+- test/helper.rb
+- test/spec_payler_api.rb
+homepage: https://github.com/sletix/payler_api
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Payler Merchant API Wrapper
+test_files: []